@uniformdev/canvas-contentful 19.35.2 → 19.35.3-alpha.82

package/dist/index.d.mts

@@ -0,0 +1,140 @@
+import { ContentfulClientApi, Sys } from 'contentful';
+import { ComponentParameterEnhancerFunction, EnhancerContext, ComponentParameter, ComponentInstance, LimitPolicy, ComponentParameterEnhancer } from '@uniformdev/canvas';
+
+interface AddClientArgs {
+    /**
+     * The Contentful source public ID that this client maps to in the composition data.
+     * This is used to enable multiple Contentful spaces/environments as data sources.
+     * If unspecified, the client will be the default source that is used when no source public ID
+     * is in the data, or the source ID is 'default'.
+     */
+    source?: string;
+    /** The Contentful client instance to use when fetching published data */
+    client: ContentfulClientApi;
+    /**
+     * The Contentful client instance to use when fetching preview data.
+     * If the preview client is not passed, it defaults to the client.
+     */
+    previewClient?: ContentfulClientApi;
+}
+declare class ContentfulClientList {
+    private _clients;
+    constructor(clients?: AddClientArgs[] | AddClientArgs);
+    addClient({ source, client, previewClient }: AddClientArgs): void;
+    getClient({ source, isPreviewClient, }: {
+        source?: string;
+        isPreviewClient?: boolean;
+    }): ContentfulClientApi | undefined;
+}
+
+/** The default shape of the Contentful entry. Note that this can change if the query is altered. */
+type ContentfulEntryResult<TFields> = {
+    /**
+     * The shape of the `fields` that the Contentful REST API is expected to return for this entry
+     * https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/entries/entry
+     *
+     * These should line up with the fields in your content model(s) that are allowed for this component.
+     */
+    fields: TFields;
+    /** System fields returned by the Contentful API. If you modify the query parameters to fetch more than fields, you may get more sys data than this. */
+    sys: Partial<Pick<Sys, 'id' | 'type'>>;
+};
+
+type EnhancerValue = ContentfulEntryResult<unknown> | ContentfulEntryResult<unknown>[] | null;
+declare const contentfulRichTextToHtmlEnhancer: ComponentParameterEnhancerFunction<EnhancerValue>;
+
+type EntrySelectorParameterValue = {
+    entryId: string;
+    source?: string;
+} | string | null | undefined;
+type CreateContentfulQueryOptions<TContext extends EnhancerContext = EnhancerContext> = {
+    /** Canvas parameter name being queried for. Not defined if using batching. */
+    parameterName?: string;
+    /** Canvas parameter value being fetched. Not defined if using batching. */
+    parameter?: ComponentParameter<EntrySelectorParameterValue>;
+    /** Component containing the parameter being fetched. Not defined if using batching. */
+    component?: ComponentInstance;
+    /** The default Contentful query expression (select fields + include 1 layer of references) */
+    defaultQuery: any;
+    /** The enhancer context provided to the enhance() function */
+    context: TContext;
+};
+/** The default shape of the result value of the Contentful enhancer. Note that this can change if the query is altered. */
+type ContentfulEnhancerResult<TFields> = ContentfulEntryResult<TFields> | null;
+type CreateContentfulEnhancerOptions = {
+    /** Either a list of Contentful clients for use with multi-space/environment-enabled Canvas projects.
+     * Or a single Contentful client for use with legacy Canvas data.*/
+    client: ContentfulClientApi | ContentfulClientList;
+    /** @deprecated Contentful client instance to use for fetching preview content.
+     * This client is _only_ relevant when the `client` property is a single Contentful client intended for use with
+     * legacy Canvas data. Conversely, if you use a `ContentfulClientList` for the `client` property, any value for `previewClient`
+     * will be ignored. To avoid deprecated use, you should switch to using a `ContentfulClientList` for the `client` property. */
+    previewClient?: ContentfulClientApi;
+    /** Creates the Contentful client's query params for specific parameters. See https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters */
+    createQuery?: (options: CreateContentfulQueryOptions) => any | undefined;
+    useBatching?: boolean;
+    limitPolicy?: LimitPolicy;
+};
+declare const CANVAS_CONTENTFUL_PARAMETER_TYPES: readonly string[];
+declare function createContentfulEnhancer({ client, previewClient, createQuery, useBatching, limitPolicy, }: CreateContentfulEnhancerOptions): ComponentParameterEnhancer<EntrySelectorParameterValue, ContentfulEnhancerResult<unknown>>;
+
+type ContentfulMultiEntryParameterValue = {
+    entries: string[];
+    source: string;
+} | null | undefined;
+type CreateContentfulMultiEntryQueryOptions<TContext extends EnhancerContext = EnhancerContext> = {
+    /** Canvas parameter name being queried for */
+    parameterName: string;
+    /** Canvas parameter value being fetched */
+    parameter: ComponentParameter<ContentfulMultiEntryParameterValue>;
+    /** Component containing the parameter being fetched */
+    component: ComponentInstance;
+    /** The default Contentful query expression (select fields + include 1 layer of references) */
+    defaultQuery: any;
+    /** The enhancer context provided to the enhance() function */
+    context: TContext;
+};
+/** The default shape of the result value of the Contentful Multi Entry enhancer. Note that this can change if the query is altered. */
+type ContentfulMultiEntryEnhancerResult<TFields> = ContentfulEntryResult<TFields>[] | null;
+type CreateContentfulMultiEntryEnhancerOptions = {
+    /** Either a list of Contentful clients for use with multi-space/environment-enabled Canvas projects. */
+    clients: ContentfulClientList;
+    /** Creates the Contentful client's query params for specific parameters. See https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters */
+    createQuery?: (options: CreateContentfulMultiEntryQueryOptions) => any | undefined;
+    limitPolicy?: LimitPolicy;
+};
+declare const CANVAS_CONTENTFUL_MULTI_PARAMETER_TYPES: readonly string[];
+declare function createContentfulMultiEnhancer({ clients, createQuery, limitPolicy, }: CreateContentfulMultiEntryEnhancerOptions): ComponentParameterEnhancer<ContentfulMultiEntryParameterValue, ContentfulMultiEntryEnhancerResult<unknown>>;
+
+declare const CANVAS_CONTENTFUL_QUERY_PARAMETER_TYPES: readonly string[];
+type ContentfulQueryParameterValue = {
+    source: string;
+    contentType: string;
+    count: number;
+    sortBy?: string;
+    sortOrder?: 'asc' | 'desc';
+} | null | undefined;
+/** The default shape of the result value of the Contentful Query enhancer. Note that this can change if the query is altered. */
+type ContentfulQueryEnhancerResult<TFields> = ContentfulEntryResult<TFields>[] | null;
+type CreateContentfulQueryApiQueryOptions<TContext extends EnhancerContext = EnhancerContext> = {
+    /** Canvas parameter name being queried for */
+    parameterName: string;
+    /** Canvas parameter value being fetched */
+    parameter: ComponentParameter<ContentfulQueryParameterValue>;
+    /** Component containing the parameter being fetched */
+    component: ComponentInstance;
+    /** The default Contentful query expression (select fields + include 1 layer of references) */
+    defaultQuery: any;
+    /** The enhancer context provided to the enhance() function */
+    context: TContext;
+};
+type CreateContentfulQueryEnhancerOptions = {
+    /** Either a list of Contentful clients for use with multi-space/environment-enabled Canvas projects. */
+    clients: ContentfulClientList;
+    /** Creates the Contentful client's query params for specific parameters. See https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters */
+    createQuery?: (options: CreateContentfulQueryApiQueryOptions) => any | undefined;
+    limitPolicy?: LimitPolicy;
+};
+declare function createContentfulQueryEnhancer({ clients, createQuery, limitPolicy, }: CreateContentfulQueryEnhancerOptions): ComponentParameterEnhancer<ContentfulQueryParameterValue, ContentfulQueryEnhancerResult<unknown>>;
+
+export { AddClientArgs, CANVAS_CONTENTFUL_MULTI_PARAMETER_TYPES, CANVAS_CONTENTFUL_PARAMETER_TYPES, CANVAS_CONTENTFUL_QUERY_PARAMETER_TYPES, ContentfulClientList, ContentfulEnhancerResult, ContentfulMultiEntryEnhancerResult, ContentfulMultiEntryParameterValue, ContentfulQueryEnhancerResult, ContentfulQueryParameterValue, CreateContentfulEnhancerOptions, CreateContentfulMultiEntryEnhancerOptions, CreateContentfulMultiEntryQueryOptions, CreateContentfulQueryApiQueryOptions, CreateContentfulQueryEnhancerOptions, CreateContentfulQueryOptions, EntrySelectorParameterValue, contentfulRichTextToHtmlEnhancer, createContentfulEnhancer, createContentfulMultiEnhancer, createContentfulQueryEnhancer };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/canvas-contentful",
-  "version": "19.35.2",
+  "version": "19.35.3-alpha.82+4bc341093",
   "description": "Contentful data enhancers for Uniform Canvas",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -24,7 +24,7 @@
     "document": "api-extractor run --local"
   },
   "dependencies": {
-    "@uniformdev/canvas": "19.35.2"
+    "@uniformdev/canvas": "19.35.3-alpha.82+4bc341093"
   },
   "peerDependencies": {
     "@contentful/rich-text-html-renderer": ">= 14",
@@ -40,5 +40,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "64d3270175087c87cfaa29a283aa4a7b0a98fd2c"
+  "gitHead": "4bc341093bc946900df2646fe53eca4bcddc693c"
 }