@uniformdev/canvas-contentful 11.0.1-alpha.100

package/LICENSE.txt

@@ -0,0 +1,2 @@
+© 2021 Uniform Systems, Inc. All Rights Reserved.
+See details of Uniform Systems, Inc. Master Subscription Agreement here: https://uniform.dev/eula

package/README.md

@@ -0,0 +1,3 @@
+Contentful data enhancers for Uniform Canvas
+
+part of the [Uniform Platform](https://uniform.app). See our [documentation](https://docs.uniform.app) for more details.

package/dist/cjs/contentfulRichTextToHtmlEnhancer.d.ts

@@ -0,0 +1,3 @@
+import { ComponentParameterEnhancerFunction } from '@uniformdev/canvas';
+import { ContentfulEnhancerResult } from './createContentfulEnhancer';
+export declare const contentfulRichTextToHtmlEnhancer: ComponentParameterEnhancerFunction<ContentfulEnhancerResult<unknown>>;

package/dist/cjs/contentfulRichTextToHtmlEnhancer.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.contentfulRichTextToHtmlEnhancer=void 0;var rich_text_html_renderer_1=require("@contentful/rich-text-html-renderer"),contentfulRichTextToHtmlEnhancer=function(e){var n=e.parameter;return"object"!=typeof(null===(e=n.value)||void 0===e?void 0:e.fields)||Object.entries(null!==(e=null===(e=n.value)||void 0===e?void 0:e.fields)&&void 0!==e?e:{}).forEach(function(e){var t=e[0],e=e[1];"object"==typeof e&&"nodeType"in e&&"document"===e.nodeType&&(n.value.fields[t]=(0,rich_text_html_renderer_1.documentToHtmlString)(e))}),n.value};exports.contentfulRichTextToHtmlEnhancer=contentfulRichTextToHtmlEnhancer;

package/dist/cjs/createContentfulEnhancer.d.ts

@@ -0,0 +1,36 @@
+import { ComponentParameterEnhancer, ComponentInstance, ComponentParameter, LimitPolicy, EnhancerContext } from '@uniformdev/canvas';
+import { ContentfulClientApi, Sys } from 'contentful';
+export declare 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;
+    /** 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. */
+export declare type ContentfulEnhancerResult<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'>>;
+} | null;
+export declare type CreateContentfulEnhancerOptions = {
+    client: ContentfulClientApi;
+    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;
+};
+export declare const CANVAS_CONTENTFUL_PARAMETER_TYPES: readonly string[];
+export declare function createContentfulEnhancer({ client, previewClient, createQuery, useBatching, limitPolicy, }: CreateContentfulEnhancerOptions): ComponentParameterEnhancer<string, ContentfulEnhancerResult<unknown>>;

package/dist/cjs/createContentfulEnhancer.js

@@ -0,0 +1 @@
+"use strict";var __assign=this&&this.__assign||function(){return(__assign=Object.assign||function(e){for(var t,r=1,n=arguments.length;r<n;r++)for(var a in t=arguments[r])Object.prototype.hasOwnProperty.call(t,a)&&(e[a]=t[a]);return e}).apply(this,arguments)},__awaiter=this&&this.__awaiter||function(e,i,u,c){return new(u=u||Promise)(function(r,t){function n(e){try{o(c.next(e))}catch(e){t(e)}}function a(e){try{o(c.throw(e))}catch(e){t(e)}}function o(e){var t;e.done?r(e.value):((t=e.value)instanceof u?t:new u(function(e){e(t)})).then(n,a)}o((c=c.apply(e,i||[])).next())})},__generator=this&&this.__generator||function(r,n){var a,o,i,u={label:0,sent:function(){if(1&i[0])throw i[1];return i[1]},trys:[],ops:[]},e={next:t(0),throw:t(1),return:t(2)};return"function"==typeof Symbol&&(e[Symbol.iterator]=function(){return this}),e;function t(t){return function(e){return function(t){if(a)throw new TypeError("Generator is already executing.");for(;u;)try{if(a=1,o&&(i=2&t[0]?o.return:t[0]?o.throw||((i=o.return)&&i.call(o),0):o.next)&&!(i=i.call(o,t[1])).done)return i;switch(o=0,(t=i?[2&t[0],i.value]:t)[0]){case 0:case 1:i=t;break;case 4:return u.label++,{value:t[1],done:!1};case 5:u.label++,o=t[1],t=[0];continue;case 7:t=u.ops.pop(),u.trys.pop();continue;default:if(!(i=0<(i=u.trys).length&&i[i.length-1])&&(6===t[0]||2===t[0])){u=0;continue}if(3===t[0]&&(!i||t[1]>i[0]&&t[1]<i[3])){u.label=t[1];break}if(6===t[0]&&u.label<i[1]){u.label=i[1],i=t;break}if(i&&u.label<i[2]){u.label=i[2],u.ops.push(t);break}i[2]&&u.ops.pop(),u.trys.pop();continue}t=n.call(r,u)}catch(e){t=[6,e],o=0}finally{a=i=0}if(5&t[0])throw t[1];return{value:t[0]?t[1]:void 0,done:!0}}([t,e])}}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.createContentfulEnhancer=exports.CANVAS_CONTENTFUL_PARAMETER_TYPES=void 0;var canvas_1=require("@uniformdev/canvas"),defaultQuery={select:"fields",include:1};function createContentfulEnhancer(e){var t=this,l=e.client,r=e.previewClient,s=void 0===r?l:r,f=e.createQuery,r=e.useBatching,e=e.limitPolicy||(0,canvas_1.createLimitPolicy)({throttle:{limit:55,interval:1e3}});return r?(0,canvas_1.createBatchEnhancer)({handleBatch:function(u){return __awaiter(t,void 0,void 0,function(){var t,r,n,a,o,i;return __generator(this,function(e){switch(e.label){case 0:t=u[0].args.context.preview?s:l,r=null!==(i=null==f?void 0:f({defaultQuery:__assign({},defaultQuery),context:u[0].args.context}))&&void 0!==i?i:defaultQuery,e.label=1;case 1:e.trys.push([1,6,,7]),n=new canvas_1.UniqueBatchEntries(u,function(e){return e.parameter.value}),a=Object.keys(n.groups),console.time("fetch entries"),e.label=2;case 2:return e.trys.push([2,,4,5]),[4,t.getEntries(__assign({"sys.id[in]":a.join(","),limit:a.length},r))];case 3:return e.sent().items.forEach(function(e){n.resolveKey(e.sys.id,e)}),n.resolveRemaining(null),[3,5];case 4:return console.timeEnd("fetch entries"),[7];case 5:return[3,7];case 6:return i=e.sent(),i=getErrorMessageFromContentfulError(i),o=new Error("Failed loading Contentful entries batch ("+u.length+") "+i),u.forEach(function(e){return e.reject(o)}),[3,7];case 7:return[2]}})})},shouldQueue:function(e){return parameterIsContentfulEntrySelector(e.parameter)},limitPolicy:e}):{enhanceOne:function(e){var a,o=e.parameter,i=e.parameterName,u=e.component,c=e.context;return __awaiter(this,void 0,void 0,function(){var t,r,n;return __generator(this,function(e){switch(e.label){case 0:if(!parameterIsContentfulEntrySelector(o))return[3,5];if(!o.value)return[2,null];t=c.preview?s:l,r=null!==(a=null==f?void 0:f({parameter:o,parameterName:i,component:u,defaultQuery:__assign({},defaultQuery),context:c}))&&void 0!==a?a:defaultQuery,e.label=1;case 1:return e.trys.push([1,3,4,5]),console.time("fetch entry "+o.value),[4,t.getEntry(o.value,r)];case 2:return[2,e.sent()];case 3:throw n=e.sent(),n=getErrorMessageFromContentfulError(n),new Error("Failed loading Contentful entry "+o.value+" "+n);case 4:return console.timeEnd("fetch entry "+o.value),[7];case 5:return[2]}})})},limitPolicy:e}}function parameterIsContentfulEntrySelector(e){return e.type===exports.CANVAS_CONTENTFUL_PARAMETER_TYPES[0]&&"string"==typeof e.value}function getErrorMessageFromContentfulError(e){return"string"==typeof e?e:"object"==typeof e&&e&&"error"in e?e.error:e instanceof Error?e.toString():JSON.stringify(e,null,2)}exports.CANVAS_CONTENTFUL_PARAMETER_TYPES=Object.freeze(["contentfulEntry"]),exports.createContentfulEnhancer=createContentfulEnhancer;

package/dist/cjs/index.d.ts

@@ -0,0 +1,2 @@
+export * from './createContentfulEnhancer';
+export * from './contentfulRichTextToHtmlEnhancer';

package/dist/cjs/index.js

@@ -0,0 +1 @@
+"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,t,r,n){void 0===n&&(n=r),Object.defineProperty(e,n,{enumerable:!0,get:function(){return t[r]}})}:function(e,t,r,n){e[n=void 0===n?r:n]=t[r]}),__exportStar=this&&this.__exportStar||function(e,t){for(var r in e)"default"===r||Object.prototype.hasOwnProperty.call(t,r)||__createBinding(t,e,r)};Object.defineProperty(exports,"__esModule",{value:!0}),__exportStar(require("./createContentfulEnhancer"),exports),__exportStar(require("./contentfulRichTextToHtmlEnhancer"),exports);

package/dist/esm/contentfulRichTextToHtmlEnhancer.d.ts

@@ -0,0 +1,3 @@
+import { ComponentParameterEnhancerFunction } from '@uniformdev/canvas';
+import { ContentfulEnhancerResult } from './createContentfulEnhancer';
+export declare const contentfulRichTextToHtmlEnhancer: ComponentParameterEnhancerFunction<ContentfulEnhancerResult<unknown>>;

package/dist/esm/contentfulRichTextToHtmlEnhancer.js

@@ -0,0 +1 @@
+import{documentToHtmlString}from"@contentful/rich-text-html-renderer";var contentfulRichTextToHtmlEnhancer=function(e){var n=e.parameter;return"object"!=typeof(null===(e=n.value)||void 0===e?void 0:e.fields)||Object.entries(null!==(e=null===(e=n.value)||void 0===e?void 0:e.fields)&&void 0!==e?e:{}).forEach(function(e){var t=e[0],e=e[1];"object"==typeof e&&"nodeType"in e&&"document"===e.nodeType&&(n.value.fields[t]=documentToHtmlString(e))}),n.value};export{contentfulRichTextToHtmlEnhancer};

package/dist/esm/createContentfulEnhancer.d.ts

@@ -0,0 +1,36 @@
+import { ComponentParameterEnhancer, ComponentInstance, ComponentParameter, LimitPolicy, EnhancerContext } from '@uniformdev/canvas';
+import { ContentfulClientApi, Sys } from 'contentful';
+export declare 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;
+    /** 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. */
+export declare type ContentfulEnhancerResult<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'>>;
+} | null;
+export declare type CreateContentfulEnhancerOptions = {
+    client: ContentfulClientApi;
+    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;
+};
+export declare const CANVAS_CONTENTFUL_PARAMETER_TYPES: readonly string[];
+export declare function createContentfulEnhancer({ client, previewClient, createQuery, useBatching, limitPolicy, }: CreateContentfulEnhancerOptions): ComponentParameterEnhancer<string, ContentfulEnhancerResult<unknown>>;

package/dist/esm/createContentfulEnhancer.js

@@ -0,0 +1 @@
+var __assign=this&&this.__assign||function(){return(__assign=Object.assign||function(e){for(var t,r=1,n=arguments.length;r<n;r++)for(var a in t=arguments[r])Object.prototype.hasOwnProperty.call(t,a)&&(e[a]=t[a]);return e}).apply(this,arguments)},__awaiter=this&&this.__awaiter||function(e,i,u,l){return new(u=u||Promise)(function(r,t){function n(e){try{o(l.next(e))}catch(e){t(e)}}function a(e){try{o(l.throw(e))}catch(e){t(e)}}function o(e){var t;e.done?r(e.value):((t=e.value)instanceof u?t:new u(function(e){e(t)})).then(n,a)}o((l=l.apply(e,i||[])).next())})},__generator=this&&this.__generator||function(r,n){var a,o,i,u={label:0,sent:function(){if(1&i[0])throw i[1];return i[1]},trys:[],ops:[]},e={next:t(0),throw:t(1),return:t(2)};return"function"==typeof Symbol&&(e[Symbol.iterator]=function(){return this}),e;function t(t){return function(e){return function(t){if(a)throw new TypeError("Generator is already executing.");for(;u;)try{if(a=1,o&&(i=2&t[0]?o.return:t[0]?o.throw||((i=o.return)&&i.call(o),0):o.next)&&!(i=i.call(o,t[1])).done)return i;switch(o=0,(t=i?[2&t[0],i.value]:t)[0]){case 0:case 1:i=t;break;case 4:return u.label++,{value:t[1],done:!1};case 5:u.label++,o=t[1],t=[0];continue;case 7:t=u.ops.pop(),u.trys.pop();continue;default:if(!(i=0<(i=u.trys).length&&i[i.length-1])&&(6===t[0]||2===t[0])){u=0;continue}if(3===t[0]&&(!i||t[1]>i[0]&&t[1]<i[3])){u.label=t[1];break}if(6===t[0]&&u.label<i[1]){u.label=i[1],i=t;break}if(i&&u.label<i[2]){u.label=i[2],u.ops.push(t);break}i[2]&&u.ops.pop(),u.trys.pop();continue}t=n.call(r,u)}catch(e){t=[6,e],o=0}finally{a=i=0}if(5&t[0])throw t[1];return{value:t[0]?t[1]:void 0,done:!0}}([t,e])}}};import{createBatchEnhancer,UniqueBatchEntries,createLimitPolicy}from"@uniformdev/canvas";var defaultQuery={select:"fields",include:1},CANVAS_CONTENTFUL_PARAMETER_TYPES=Object.freeze(["contentfulEntry"]);function createContentfulEnhancer(e){var t=this,c=e.client,r=e.previewClient,s=void 0===r?c:r,f=e.createQuery,r=e.useBatching,e=e.limitPolicy||createLimitPolicy({throttle:{limit:55,interval:1e3}});return r?createBatchEnhancer({handleBatch:function(u){return __awaiter(t,void 0,void 0,function(){var t,r,n,a,o,i;return __generator(this,function(e){switch(e.label){case 0:t=u[0].args.context.preview?s:c,r=null!==(i=null==f?void 0:f({defaultQuery:__assign({},defaultQuery),context:u[0].args.context}))&&void 0!==i?i:defaultQuery,e.label=1;case 1:e.trys.push([1,6,,7]),n=new UniqueBatchEntries(u,function(e){return e.parameter.value}),a=Object.keys(n.groups),console.time("fetch entries"),e.label=2;case 2:return e.trys.push([2,,4,5]),[4,t.getEntries(__assign({"sys.id[in]":a.join(","),limit:a.length},r))];case 3:return e.sent().items.forEach(function(e){n.resolveKey(e.sys.id,e)}),n.resolveRemaining(null),[3,5];case 4:return console.timeEnd("fetch entries"),[7];case 5:return[3,7];case 6:return i=e.sent(),i=getErrorMessageFromContentfulError(i),o=new Error("Failed loading Contentful entries batch ("+u.length+") "+i),u.forEach(function(e){return e.reject(o)}),[3,7];case 7:return[2]}})})},shouldQueue:function(e){return parameterIsContentfulEntrySelector(e.parameter)},limitPolicy:e}):{enhanceOne:function(e){var a,o=e.parameter,i=e.parameterName,u=e.component,l=e.context;return __awaiter(this,void 0,void 0,function(){var t,r,n;return __generator(this,function(e){switch(e.label){case 0:if(!parameterIsContentfulEntrySelector(o))return[3,5];if(!o.value)return[2,null];t=l.preview?s:c,r=null!==(a=null==f?void 0:f({parameter:o,parameterName:i,component:u,defaultQuery:__assign({},defaultQuery),context:l}))&&void 0!==a?a:defaultQuery,e.label=1;case 1:return e.trys.push([1,3,4,5]),console.time("fetch entry "+o.value),[4,t.getEntry(o.value,r)];case 2:return[2,e.sent()];case 3:throw n=e.sent(),n=getErrorMessageFromContentfulError(n),new Error("Failed loading Contentful entry "+o.value+" "+n);case 4:return console.timeEnd("fetch entry "+o.value),[7];case 5:return[2]}})})},limitPolicy:e}}function parameterIsContentfulEntrySelector(e){return e.type===CANVAS_CONTENTFUL_PARAMETER_TYPES[0]&&"string"==typeof e.value}function getErrorMessageFromContentfulError(e){return"string"==typeof e?e:"object"==typeof e&&e&&"error"in e?e.error:e instanceof Error?e.toString():JSON.stringify(e,null,2)}export{CANVAS_CONTENTFUL_PARAMETER_TYPES,createContentfulEnhancer};

package/dist/esm/index.d.ts

@@ -0,0 +1,2 @@
+export * from './createContentfulEnhancer';
+export * from './contentfulRichTextToHtmlEnhancer';

package/dist/esm/index.js

@@ -0,0 +1 @@
+export*from"./createContentfulEnhancer";export*from"./contentfulRichTextToHtmlEnhancer";

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@uniformdev/canvas-contentful",
+  "version": "11.0.1-alpha.100+620d5c7",
+  "description": "Contentful data enhancers for Uniform Canvas",
+  "license": "SEE LICENSE IN LICENSE.txt",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "exports": {
+    "import": "./dist/esm/index.js",
+    "require": "./dist/cjs/index.js"
+  },
+  "types": "./dist/cjs/index.d.ts",
+  "sideEffects": false,
+  "scripts": {
+    "build": "run-p build:cjs build:esm",
+    "build:esm": "tsc",
+    "build:cjs": "tsc -p ./tsconfig.cjs.json",
+    "dev": "run-p dev:esm dev:cjs",
+    "dev:esm": "tsc -w",
+    "dev:cjs": "tsc -w -p ./tsconfig.cjs.json",
+    "clean": "rimraf dist",
+    "test": "jest --maxWorkers=1",
+    "lint": "eslint \"src/**/*.{js,ts,tsx}\"",
+    "format": "prettier --write \"src/**/*.{js,ts,tsx}\"",
+    "ci:verify": "run-p lint test",
+    "ci:build": "run-s clean build"
+  },
+  "dependencies": {
+    "@uniformdev/canvas": "^11.0.1-alpha.100+620d5c7"
+  },
+  "peerDependencies": {
+    "@contentful/rich-text-html-renderer": ">= 14",
+    "contentful": ">= 8"
+  },
+  "devDependencies": {
+    "@contentful/rich-text-html-renderer": "15.4.0",
+    "@types/jest": "27.0.2",
+    "@types/node": "16.7.1",
+    "contentful": "9.0.0",
+    "eslint": "7.32.0",
+    "eslint-plugin-react": "7.26.0",
+    "eslint-plugin-react-hooks": "4.2.0",
+    "jest": "27.2.3",
+    "npm-run-all": "4.1.5",
+    "rimraf": "3.0.2",
+    "ts-jest": "27.0.5"
+  },
+  "files": [
+    "/dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "620d5c75566fdb5ee98ab0d1e3969a92fceb2f7a"
+}