
Security News
Deno 2.2 Improves Dependency Management and Expands Node.js Compatibility
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
@buildinams/contentful-rest
Advanced tools
Contentful REST API
import { ContentfulFetcher } from "@buildinams/contentful-rest";
export const cfClient = new ContentfulFetcher();
Install this package with npm
.
npm i @buildinams/contentful-rest
import {
ContentfulFetcher,
ContentfulAdaptor,
} from "@buildinams/contentful-rest";
const Adaptor = new ContentfulAdaptor({});
export const cfClient = new ContentfulFetcher({
config: { spaceId, accessToken, previewToken, environment },
adaptor: Adaptor,
isPreview: IS_DEVELOPMENT,
});
const fetchData = async (args: DataTypeArgs) => {
const data = await cfClient.getEntries({ query, options });
};
import { createClient } from "@buildinams/contentful-rest";
export const cfClient = new ContentfulFetcher({
config: { spaceId, accessToken, previewToken, environment },
adaptor: Adaptor,
isPreview: IS_DEVELOPMENT,
});
Create client creates a helper function that is able to send GraphQL queries to your Contentful space. The expected arguments are;
import { ContentfulAdaptor } from "@buildinams/contentful-rest";
const Adaptor = new ContentfulAdaptor({
fieldAdaptors: {
Asset: assetAdaptor,
},
contentAdaptors: {
BlockMedia: blockMediaAdaptor,
},
pageAdaptors: {
Homepage: homepageAdaptor,
},
});
This generates a JavaScript class that gives you the option to adapt the data. Expected arguments;
{ __typename: {key} }
it will run the adaptor with the matching {key}
.pageLayout
to contain all data but when referenced in a cta
we don't want the page adaptor.The concept of adaptors are generics that modifiy certain data by content type (__typename
). Often these can follow the structure below;
const blockMediaAdaptor = (data: ContentfulQueryResponse) => {
return {
type: data.file.fileType,
src: data.src,
ratio: data.height / data.width,
};
};
export type BlockMedia = ReturnType<typeof blockMediaAdaptor>;
Within your application you can then use the BlockMedia
type to link back to the type of data you expect to receive.
import { getIndicatorProps } from "@buildinams/contentful-rest/getIndicatorProps";
<h1 {...getIndicatorProps({ entryId: entry.sys.id, fieldId: "title" })}>
{entry.title}
</h1>;
A small helper function to get indicator mode in Contentful preview mode. Expected arugments;
entry.sys.id
Found an issue? Want a new feature? Get involved! Please contribute using our guideline here.
FAQs
Contentful REST API
We found that @buildinams/contentful-rest demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.