@remkoj/optimizely-cms-react 2.0.0-pre4 → 2.0.0

package/dist/server/components/get-content-type.js

@@ -22,33 +22,28 @@ export async function getContentType(link, gqlClient) {
     const items = gqlResponse.Content?.items;
     if (!items || items.length == 0)
         throw new Error("The content item could not be found!");
-    const contentType = Utils.normalizeContentType(items[0]?.ContentType);
+    const contentType = Utils.normalizeContentType(items[0]?._metadata?.types);
     if (!contentType)
         throw new Error("The item did not contain type information");
     return contentType;
 }
 export default getContentType;
-export const getContentTypeQuery = gql `query getContentType($id: Int, $workId: Int, $guidValue: String, $locale: [Locales])
+export const getContentTypeQuery = gql `query getContentType($key: String!, $version: String, $locale: [Locales])
 {
-  Content(
+  _Content(
     where: {
-      ContentLink: {
-        GuidValue: {
-          eq: $guidValue
-        }
-        Id: {
-          eq: $id
-        },
-        WorkId: {
-          eq: $workId
-        }
+      _metadata: {
+        key: { eq: $key }
+        version: { eq: $version }
       }
     },
     locale: $locale
     limit: 1
   ) {
     items {
-    	ContentType
+    	_metadata {
+        types
+      }
     },
     total
   }

package/dist/server/components/get-content-type.js.map

@@ -1 +1 @@
-{"version":3,"file":"get-content-type.js","sourceRoot":"","sources":["../../../src/server/components/get-content-type.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAA;AACrC,OAAO,KAAK,KAAK,MAAM,oBAAoB,CAAA;AAC3C,OAAO,EAAE,aAAa,EAAE,MAAM,uCAAuC,CAAA;AAErE,MAAM,KAAK,GAAG,KAAK,CAAA;AAEnB;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,IAA2B,EAAE,SAA2B;IAEzF,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC;QACpB,MAAM,IAAI,KAAK,CAAC,kEAAkE,CAAC,CAAA;IACvF,MAAM,YAAY,GAAG,KAAK,CAAC,6BAA6B,CAAC,IAAI,CAAC,CAAA;IAC9D,MAAM,WAAW,GAAG,MAAM,SAAS,CAAC,OAAO,CAAyB,mBAAmB,EAAE,YAAY,CAAC,CAAA;IACtG,IAAI,WAAW,CAAC,OAAO,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QAClC,IAAI,KAAK;YACL,OAAO,CAAC,KAAK,CAAC,uDAAwD,WAAW,CAAC,OAAO,EAAE,KAAK,IAAI,CAAE,YAAY,EAAE,YAAY,CAAC,CAAA;QACrI,OAAO,SAAS,CAAA;IACpB,CAAC;IAED,MAAM,KAAK,GAAG,WAAW,CAAC,OAAO,EAAE,KAAK,CAAA;IACxC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,MAAM,IAAI,CAAC;QAC3B,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAA;IAE3D,MAAM,WAAW,GAAG,KAAK,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,CAAA;IACrE,IAAI,CAAC,WAAW;QACZ,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAA;IAEhE,OAAO,WAAW,CAAA;AACtB,CAAC;AAED,eAAe,cAAc,CAAA;AAW7B,MAAM,CAAC,MAAM,mBAAmB,GAAG,GAAG,CAAA;;;;;;;;;;;;;;;;;;;;;;;;EAwBpC,CAAA"}
+{"version":3,"file":"get-content-type.js","sourceRoot":"","sources":["../../../src/server/components/get-content-type.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAA;AACrC,OAAO,KAAK,KAAK,MAAM,oBAAoB,CAAA;AAC3C,OAAO,EAAE,aAAa,EAAE,MAAM,uCAAuC,CAAA;AAErE,MAAM,KAAK,GAAG,KAAK,CAAA;AAEnB;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,IAA2B,EAAE,SAA2B;IAEzF,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC;QACpB,MAAM,IAAI,KAAK,CAAC,kEAAkE,CAAC,CAAA;IACvF,MAAM,YAAY,GAAG,KAAK,CAAC,6BAA6B,CAAC,IAAI,CAAC,CAAA;IAC9D,MAAM,WAAW,GAAG,MAAM,SAAS,CAAC,OAAO,CAAyB,mBAAmB,EAAE,YAAY,CAAC,CAAA;IACtG,IAAI,WAAW,CAAC,OAAO,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QAClC,IAAI,KAAK;YACL,OAAO,CAAC,KAAK,CAAC,uDAAwD,WAAW,CAAC,OAAO,EAAE,KAAK,IAAI,CAAE,YAAY,EAAE,YAAY,CAAC,CAAA;QACrI,OAAO,SAAS,CAAA;IACpB,CAAC;IAED,MAAM,KAAK,GAAG,WAAW,CAAC,OAAO,EAAE,KAAK,CAAA;IACxC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,MAAM,IAAI,CAAC;QAC3B,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAA;IAE3D,MAAM,WAAW,GAAG,KAAK,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,KAAK,CAAC,CAAA;IAC1E,IAAI,CAAC,WAAW;QACZ,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAA;IAEhE,OAAO,WAAW,CAAA;AACtB,CAAC;AAED,eAAe,cAAc,CAAA;AAa7B,MAAM,CAAC,MAAM,mBAAmB,GAAG,GAAG,CAAA;;;;;;;;;;;;;;;;;;;EAmBpC,CAAA"}

package/dist/server/components/index.d.ts

@@ -1,3 +1,4 @@
 export * from './cms-content.js';
 export * from './cms-content-area.js';
+export * from './cms-editable.js';
 export * from './visual-builder/index.js';

package/dist/server/components/index.js

@@ -1,4 +1,5 @@
 export * from './cms-content.js';
 export * from './cms-content-area.js';
+export * from './cms-editable.js';
 export * from './visual-builder/index.js';
 //# sourceMappingURL=index.js.map

package/dist/server/components/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/server/components/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAA;AAChC,cAAc,uBAAuB,CAAA;AACrC,cAAc,2BAA2B,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/server/components/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAA;AAChC,cAAc,uBAAuB,CAAA;AACrC,cAAc,mBAAmB,CAAA;AACjC,cAAc,2BAA2B,CAAA"}

package/dist/server/components/queries.js

@@ -2,19 +2,19 @@ import { gql } from 'graphql-request';
 export const CmsContentFragments = {
     IContentDataProps: ["_metadata", "_type", "__typename"],
     ContentLink: gql `fragment ContentLink on ContentModelReference {
-      id: Id,
-      workId: WorkId,
-      guidValue: GuidValue
+        id: Id,
+        workId: WorkId,
+        guidValue: GuidValue
     }`,
     ContentLinkSearch: gql `fragment ContentLinkSearch on ContentModelReferenceSearch {
-      id: Id,
-      workId: WorkId,
-      guidValue: GuidValue
+        id: Id,
+        workId: WorkId,
+        guidValue: GuidValue
     }`,
     IContentData: gql `fragment IContentData on IContent {
         contentType: ContentType
         id: ContentLink {
-          ...ContentLink
+            ...ContentLink
         }
         locale: Language {
             name: Name
@@ -25,7 +25,7 @@ export const CmsContentFragments = {
         item: ContentLink {
             ...ContentLinkSearch
             data: Expanded {
-            ...BlockData
+                ...BlockData
             }
         }
         displayOption:DisplayOption
@@ -34,7 +34,7 @@ export const CmsContentFragments = {
         item: ContentLink {
             ...ContentLinkSearch
             data: Expanded {
-            ...IContentData
+                ...IContentData
             }
         }
         displayOption:DisplayOption
@@ -43,7 +43,7 @@ export const CmsContentFragments = {
         item: ContentLink {
             ...ContentLink
             data: Expanded {
-            ...IContentData
+                ...IContentData
             }
         }
         displayOption:DisplayOption
@@ -102,7 +102,7 @@ export const ContentAreaFragments = {
   }`
 };
 export const getContentById = gql `query getContentById($id: Int, $workId: Int, $guidValue: String, $locale: [Locales!], $isCommonDraft: Boolean) {
-    Content(
+    content:_Content(
         where: {
             ContentLink: { 
                 Id: { eq: $id }, 
@@ -123,7 +123,7 @@ export const getContentById = gql `query getContentById($id: Int, $workId: Int,
 }`;
 export const getContentByPath = gql `query getContentByPath($path: String!, $locale: [Locales], $siteId: String)
 {
-  Content(
+  content: _Content(
     where: {
       RelativePath: {
         eq: $path

package/dist/server/components/visual-builder/Composition.d.ts

@@ -1,5 +1,10 @@
-/// <reference types="react" />
 import 'server-only';
 import type { OptimizelyCompositionProps } from './types.js';
+/**
+ * Render the composition as made available through Optimizely Graph for Visual Builder
+ *
+ * @param param0
+ * @returns     The
+ */
 export declare function OptimizelyComposition({ node, leafPropsFactory, nodePropsFactory }: OptimizelyCompositionProps): Promise<JSX.Element>;
 export default OptimizelyComposition;

package/dist/server/components/visual-builder/Composition.js

@@ -1,86 +1,44 @@
+import { jsx as _jsx } from "react/jsx-runtime";
 import 'server-only';
-import { isElementNode } from './functions.js';
+import { isElementNode, defaultNodePropsFactory, defaultPropsFactory } from './functions.js';
 import { CmsContent } from '../cms-content.js';
-import { isContentLink, isInlineContentLink } from '@remkoj/optimizely-graph-client';
 import getServerContext from '../../context.js';
-function isContentType(toTest) {
-    return Array.isArray(toTest) && toTest.every(x => typeof (x) == 'string' && x.length > 0);
-}
-const defaultPropsFactory = (node) => {
-    const contentType = node.element?._metadata?.types;
-    if (!isContentType(contentType))
-        throw new Error("Invalid content type: " + JSON.stringify(contentType));
-    const contentLink = {
-        key: node.element?._metadata?.key || node.key || undefined,
-        version: node.element?._metadata?.version,
-        locale: node.element?._metadata?.locale
-    };
-    if (!(isContentLink(contentLink) || isInlineContentLink(contentLink)))
-        throw new Error("Invalid content link: " + JSON.stringify(contentLink));
-    const layoutData = {
-        type: node.type,
-        layoutType: node.layoutType,
-        template: node.template,
-        settings: node.settings
-    };
-    return [contentLink, contentType, node.element, layoutData];
-};
-function ucFirst(input) {
-    return input[0].toUpperCase() + input.substring(1);
-}
-const defaultNodePropsFactory = (node) => {
-    const componentTypes = [
-        [node.template, node.type ? ucFirst(node.type) : null, ucFirst(node.layoutType), "Component", "Content"].filter(x => x),
-        (node.template && node.type) ? [node.type ? ucFirst(node.type) : null, ucFirst(node.layoutType), "Component", "Content"].filter(x => x) : null,
-        ["Node", "Component", "Content"]
-    ].filter(x => x);
-    const contentLink = { key: node.key ?? '' };
-    const componentData = {};
-    const layoutData = {
-        type: node.type,
-        layoutType: node.layoutType,
-        template: node.template,
-        settings: node.settings
-    };
-    if (!(isContentLink(contentLink) || isInlineContentLink(contentLink)))
-        throw new Error("Invalid content link: " + JSON.stringify(contentLink));
-    return [contentLink, componentTypes, componentData, layoutData];
-};
+/**
+ * Render the composition as made available through Optimizely Graph for Visual Builder
+ *
+ * @param param0
+ * @returns     The
+ */
 export async function OptimizelyComposition({ node, leafPropsFactory = defaultPropsFactory, nodePropsFactory = defaultNodePropsFactory }) {
+    const { factory, isDebug } = getServerContext();
     if (isElementNode(node)) {
+        if (isDebug)
+            console.log(`⚪ [VisualBuilder] Rendering element node ${JSON.stringify(node)}`);
         const [contentLink, contentType, fragmentData, layoutProps] = leafPropsFactory(node);
-        return CmsContent({ contentLink, contentType, fragmentData, layoutProps });
+        //@ts-expect-error CmsContent is an Asynchronous server component, which isn't supported by the generic React Typings
+        return _jsx(CmsContent, { contentLink: contentLink, contentType: contentType, fragmentData: fragmentData, layoutProps: layoutProps });
     }
-    const { factory, isDebug } = getServerContext();
+    if (isDebug)
+        console.log(`⚪ [VisualBuilder] Rendering structure node ${JSON.stringify(node)}`);
     if (!factory)
-        throw new Error("OptimizelyComposition requires the factory be defined within the serverContext");
-    const children = await Promise.all((node.nodes ?? []).map((child, idx) => {
-        const childKey = `vb::node::${child.key}::${child.name}`;
-        return OptimizelyComposition({
-            key: childKey,
-            node: child,
-            leafPropsFactory,
-            nodePropsFactory
-        });
-    }));
+        throw new Error("🟡 [VisualBuilder] [OptimizelyComposition] The factory must be defined within the serverContext");
     const [contentLink, contentTypes, fragmentData, layoutProps] = nodePropsFactory(node);
     const firstExistingType = contentTypes.map(ct => {
         const reversed = [...ct].reverse();
         const hasType = factory.has(reversed);
         if (!hasType && isDebug)
-            console.log(`🟡 [VisualBuilder] Content type ${reversed.join('/')} not found within factory`);
+            console.log(`🟡 [VisualBuilder] [OptimizelyComposition] Content type ${reversed.join('/')} not found within factory`);
         return hasType;
     }).indexOf(true);
     const contentType = contentTypes[firstExistingType];
     if (!contentType)
-        throw new Error("OptimizelyComposition requires the factory have a definition for Component/Node");
-    return CmsContent({
-        contentType,
-        contentLink,
-        fragmentData,
-        children,
-        layoutProps
-    });
+        throw new Error("🟡 [VisualBuilder] [OptimizelyComposition] The factory must have a definition for Component/Node");
+    //@ts-expect-error CmsContent is an Asynchronous server component, which isn't supported by the generic React Typings
+    return _jsx(CmsContent, { contentType: contentType, contentLink: contentLink, fragmentData: fragmentData, layoutProps: layoutProps, children: (node.nodes ?? []).map((child) => {
+            const childKey = child.key ? child.key : `vb::${JSON.stringify(child)}`;
+            //@ts-expect-error OptimizelyComposition is an Asynchronous server component, which isn't supported by the generic React Typings
+            return _jsx(OptimizelyComposition, { node: child, leafPropsFactory: leafPropsFactory, nodePropsFactory: nodePropsFactory }, childKey);
+        }) });
 }
 export default OptimizelyComposition;
 //# sourceMappingURL=Composition.js.map

package/dist/server/components/visual-builder/Composition.js.map

@@ -1 +1 @@
-{"version":3,"file":"Composition.js","sourceRoot":"","sources":["../../../../src/server/components/visual-builder/Composition.tsx"],"names":[],"mappings":"AAAA,OAAO,aAAa,CAAA;AACpB,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AAC9C,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AAG9C,OAAO,EAAE,aAAa,EAAyB,mBAAmB,EAAE,MAAM,iCAAiC,CAAA;AAE3G,OAAO,gBAAgB,MAAM,kBAAkB,CAAA;AAE/C,SAAS,aAAa,CAAC,MAAW;IAE9B,OAAO,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,OAAM,CAAC,CAAC,CAAC,IAAI,QAAQ,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;AAC5F,CAAC;AAED,MAAM,mBAAmB,GAAsB,CAA8C,IAAgC,EAAE,EAAE;IAC7H,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,EAAE,SAAS,EAAE,KAAK,CAAA;IAClD,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC;QAC3B,MAAM,IAAI,KAAK,CAAC,wBAAwB,GAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAA;IAEzE,MAAM,WAAW,GAAwC;QACrD,GAAG,EAAE,IAAI,CAAC,OAAO,EAAE,SAAS,EAAE,GAAG,IAAI,IAAI,CAAC,GAAG,IAAI,SAAS;QAC1D,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,SAAS,EAAE,OAAO;QACzC,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE,SAAS,EAAE,MAAM;KAC1C,CAAA;IACD,IAAI,CAAC,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,mBAAmB,CAAC,WAAW,CAAC,CAAC;QACjE,MAAM,IAAI,KAAK,CAAC,wBAAwB,GAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAA;IAEzE,MAAM,UAAU,GAAG;QACf,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,QAAQ,EAAE,IAAI,CAAC,QAAQ;KAC1B,CAAA;IAED,OAAO,CAAE,WAAW,EAAE,WAAW,EAAE,IAAI,CAAC,OAAO,EAAE,UAAU,CAAE,CAAA;AACjE,CAAC,CAAA;AAED,SAAS,OAAO,CAAC,KAAa;IAE1B,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;AACtD,CAAC;AAED,MAAM,uBAAuB,GAAsB,CAA8C,IAA8B,EAAE,EAAE;IAC/H,MAAM,cAAc,GAAG;QACnB,CAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,WAAW,EAAE,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAa;QACpI,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,WAAW,EAAE,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAa,CAAC,CAAC,CAAC,IAAI;QAC3J,CAAC,MAAM,EAAC,WAAW,EAAC,SAAS,CAAC;KACjC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAyB,CAAA;IACxC,MAAM,WAAW,GAA+B,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,IAAI,EAAE,EAAE,CAAA;IACvE,MAAM,aAAa,GAAQ,EAAQ,CAAA;IACnC,MAAM,UAAU,GAAG;QACf,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,QAAQ,EAAE,IAAI,CAAC,QAAQ;KAC1B,CAAA;IAED,IAAI,CAAC,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,mBAAmB,CAAC,WAAW,CAAC,CAAC;QACjE,MAAM,IAAI,KAAK,CAAC,wBAAwB,GAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAA;IAEzE,OAAO,CAAE,WAAW,EAAE,cAAc,EAAE,aAAa,EAAE,UAAU,CAAE,CAAA;AACrE,CAAC,CAAA;AAED,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,EAAE,IAAI,EAAE,gBAAgB,GAAG,mBAAmB,EAAE,gBAAgB,GAAG,uBAAuB,EAA6B;IAE/J,IAAI,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;QACtB,MAAM,CAAE,WAAW,EAAE,WAAW,EAAE,YAAY,EAAE,WAAW,CAAE,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAA;QACtF,OAAO,UAAU,CAAC,EAAC,WAAW,EAAE,WAAW,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC,CAAA;IAC7E,CAAC;IAED,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,gBAAgB,EAAE,CAAA;IAC/C,IAAI,CAAC,OAAO;QACR,MAAM,IAAI,KAAK,CAAC,gFAAgF,CAAC,CAAA;IAErG,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;QACrE,MAAM,QAAQ,GAAG,aAAa,KAAK,CAAC,GAAG,KAAK,KAAK,CAAC,IAAI,EAAE,CAAA;QACxD,OAAO,qBAAqB,CAAC;YACzB,GAAG,EAAE,QAAQ;YACb,IAAI,EAAE,KAAK;YACX,gBAAgB;YAChB,gBAAgB;SACnB,CAAC,CAAA;IACN,CAAC,CAAC,CAAC,CAAC;IAEJ,MAAM,CAAE,WAAW,EAAE,YAAY,EAAE,YAAY,EAAE,WAAW,CAAE,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAA;IACvF,MAAM,iBAAiB,GAAG,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE;QAC5C,MAAM,QAAQ,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,OAAO,EAAE,CAAA;QAClC,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QACrC,IAAI,CAAC,OAAO,IAAI,OAAO;YACnB,OAAO,CAAC,GAAG,CAAC,mCAAoC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAE,2BAA2B,CAAC,CAAA;QACnG,OAAO,OAAO,CAAA;IAClB,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;IAChB,MAAM,WAAW,GAAG,YAAY,CAAC,iBAAiB,CAAC,CAAA;IACnD,IAAI,CAAC,WAAW;QACZ,MAAM,IAAI,KAAK,CAAC,iFAAiF,CAAC,CAAA;IAEtG,OAAO,UAAU,CAAC;QACd,WAAW;QACX,WAAW;QACX,YAAY;QACZ,QAAQ;QACR,WAAW;KACd,CAAC,CAAA;AACN,CAAC;AAED,eAAe,qBAAqB,CAAA"}
+{"version":3,"file":"Composition.js","sourceRoot":"","sources":["../../../../src/server/components/visual-builder/Composition.tsx"],"names":[],"mappings":";AAAA,OAAO,aAAa,CAAA;AACpB,OAAO,EAAE,aAAa,EAAE,uBAAuB,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAA;AAC5F,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AAE9C,OAAO,gBAAgB,MAAM,kBAAkB,CAAA;AAE/C;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,EAAE,IAAI,EAAE,gBAAgB,GAAG,mBAAmB,EAAE,gBAAgB,GAAG,uBAAuB,EAA6B;IAE/J,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,gBAAgB,EAAE,CAAA;IAE/C,IAAI,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;QACtB,IAAI,OAAO;YACP,OAAO,CAAC,GAAG,CAAC,4CAA6C,IAAI,CAAC,SAAS,CAAC,IAAI,CAAE,EAAE,CAAC,CAAA;QACrF,MAAM,CAAE,WAAW,EAAE,WAAW,EAAE,YAAY,EAAE,WAAW,CAAE,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAA;QACtF,qHAAqH;QACrH,OAAO,KAAC,UAAU,IAAC,WAAW,EAAG,WAAW,EAAG,WAAW,EAAG,WAAW,EAAG,YAAY,EAAG,YAAY,EAAG,WAAW,EAAG,WAAW,GAAK,CAAA;IAC3I,CAAC;IACD,IAAI,OAAO;QACP,OAAO,CAAC,GAAG,CAAC,8CAA+C,IAAI,CAAC,SAAS,CAAC,IAAI,CAAE,EAAE,CAAC,CAAA;IAEvF,IAAI,CAAC,OAAO;QACR,MAAM,IAAI,KAAK,CAAC,iGAAiG,CAAC,CAAA;IAEtH,MAAM,CAAE,WAAW,EAAE,YAAY,EAAE,YAAY,EAAE,WAAW,CAAE,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAA;IACvF,MAAM,iBAAiB,GAAG,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE;QAC5C,MAAM,QAAQ,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,OAAO,EAAE,CAAA;QAClC,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QACrC,IAAI,CAAC,OAAO,IAAI,OAAO;YACnB,OAAO,CAAC,GAAG,CAAC,2DAA4D,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAE,2BAA2B,CAAC,CAAA;QAC3H,OAAO,OAAO,CAAA;IAClB,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;IAChB,MAAM,WAAW,GAAG,YAAY,CAAC,iBAAiB,CAAC,CAAA;IACnD,IAAI,CAAC,WAAW;QACZ,MAAM,IAAI,KAAK,CAAC,kGAAkG,CAAC,CAAA;IAEvH,qHAAqH;IACrH,OAAO,KAAC,UAAU,IAAC,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,WAAW,YACtH,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;YAC9B,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,OAAQ,IAAI,CAAC,SAAS,CAAE,KAAK,CAAE,EAAE,CAAA;YAC1E,gIAAgI;YAChI,OAAO,KAAC,qBAAqB,IAAkB,IAAI,EAAG,KAAK,EAAG,gBAAgB,EAAG,gBAAgB,EAAG,gBAAgB,EAAG,gBAAgB,IAAnG,QAAQ,CAAgG,CAAA;QAChJ,CAAC,CAAC,GACO,CAAA;AACjB,CAAC;AAED,eAAe,qBAAqB,CAAA"}

package/dist/server/components/visual-builder/functions.d.ts

@@ -1,5 +1,10 @@
-import { CompositionNode, CompositionElementNode, CompositionStructureNode } from './types.js';
+import type { ContentType } from '../../../types.js';
+import type { CompositionNode, LeafPropsFactory, CompositionElementNode, NodePropsFactory, CompositionStructureNode } from './types.js';
 export declare function isElementNode(node: CompositionNode<Record<string, any>>): node is CompositionElementNode<Record<string, any>>;
 export declare function isElementNodeOfType<ET extends Record<string, any>>(node: CompositionNode<Record<string, any>>, test: (data: Record<string, any>) => data is ET): node is CompositionElementNode<ET>;
 export declare function isStructureNode(node: CompositionNode<Record<string, any>>): node is CompositionStructureNode;
 export declare function isNode(toTest: any): toTest is CompositionNode;
+export declare function isContentType(toTest: any): toTest is ContentType;
+export declare const defaultPropsFactory: LeafPropsFactory;
+export declare const defaultNodePropsFactory: NodePropsFactory;
+export declare function ucFirst(input: string | undefined | null): string | null;

package/dist/server/components/visual-builder/functions.js

@@ -1,3 +1,4 @@
+import { isContentLink, isInlineContentLink } from '@remkoj/optimizely-graph-client';
 export function isElementNode(node) {
     return node.layoutType == "element";
 }
@@ -17,4 +18,49 @@ export function isNode(toTest) {
     const hasValidType = typeof toTest.layoutType == 'string' && nodeTypes.includes(toTest.layoutType);
     return hasValidName && hasValidType;
 }
+export function isContentType(toTest) {
+    return Array.isArray(toTest) && toTest.every(x => typeof (x) == 'string' && x.length > 0);
+}
+export const defaultPropsFactory = (node) => {
+    const contentType = node.element?._metadata?.types;
+    if (!isContentType(contentType))
+        throw new Error("Invalid content type: " + JSON.stringify(contentType));
+    const contentLink = {
+        key: node.element?._metadata?.key || node.key || undefined,
+        version: node.element?._metadata?.version,
+        locale: node.element?._metadata?.locale
+    };
+    if (!(isContentLink(contentLink) || isInlineContentLink(contentLink)))
+        throw new Error("Invalid content link: " + JSON.stringify(contentLink));
+    const layoutData = {
+        type: node.type,
+        layoutType: node.layoutType,
+        template: node.template,
+        settings: node.settings
+    };
+    return [contentLink, contentType, node.element, layoutData];
+};
+export const defaultNodePropsFactory = (node) => {
+    const componentTypes = [
+        [node.template, ucFirst(node.type), ucFirst(node.layoutType), "Component", "Content"].filter(x => x),
+        (node.template && node.type) ? [node.type ? ucFirst(node.type) : null, ucFirst(node.layoutType), "Component", "Content"].filter(x => x) : null,
+        ["Node", "Component", "Content"]
+    ].filter(x => x);
+    const contentLink = { key: node.key ?? '' };
+    const componentData = {};
+    const layoutData = {
+        type: node.type,
+        layoutType: node.layoutType,
+        template: node.template,
+        settings: node.settings
+    };
+    if (!(isContentLink(contentLink) || isInlineContentLink(contentLink)))
+        throw new Error("🔴 [VisualBuilder] Invalid content link: " + JSON.stringify(contentLink) + " - Node: " + JSON.stringify(node));
+    return [contentLink, componentTypes, componentData, layoutData];
+};
+export function ucFirst(input) {
+    if (typeof (input) == 'string' && input.length > 0)
+        return input[0].toUpperCase() + input.substring(1);
+    return null;
+}
 //# sourceMappingURL=functions.js.map

package/dist/server/components/visual-builder/functions.js.map

@@ -1 +1 @@
-{"version":3,"file":"functions.js","sourceRoot":"","sources":["../../../../src/server/components/visual-builder/functions.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,aAAa,CAAC,IAAyC;IAEnE,OAAO,IAAI,CAAC,UAAU,IAAI,SAAS,CAAA;AACvC,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAgC,IAAyC,EAAE,IAA8C;IAExJ,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC;QACpB,OAAO,KAAK,CAAA;IAChB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;AAC7B,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,IAAyC;IAErE,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAA;AAC/B,CAAC;AAED,MAAM,UAAU,MAAM,CAAC,MAAW;IAE9B,IAAI,OAAM,CAAC,MAAM,CAAC,IAAI,QAAQ,IAAI,MAAM,IAAI,IAAI;QAC5C,OAAO,KAAK,CAAA;IAEhB,MAAM,SAAS,GAAG,CAAC,YAAY,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAA;IAC/E,MAAM,YAAY,GAAG,CAAC,OAAQ,MAA0B,CAAC,IAAI,IAAI,QAAQ,IAAI,CAAE,MAA0B,CAAC,IAAI,EAAE,MAAM,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,IAAK,MAA0B,CAAC,IAAI,IAAI,IAAI,CAAA;IAC7K,MAAM,YAAY,GAAG,OAAQ,MAA0B,CAAC,UAAU,IAAI,QAAQ,IAAI,SAAS,CAAC,QAAQ,CAAE,MAA0B,CAAC,UAAU,CAAC,CAAA;IAE5I,OAAO,YAAY,IAAI,YAAY,CAAA;AACvC,CAAC"}
+{"version":3,"file":"functions.js","sourceRoot":"","sources":["../../../../src/server/components/visual-builder/functions.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAyB,mBAAmB,EAAE,MAAM,iCAAiC,CAAA;AAG3G,MAAM,UAAU,aAAa,CAAC,IAAyC;IAEnE,OAAO,IAAI,CAAC,UAAU,IAAI,SAAS,CAAA;AACvC,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAgC,IAAyC,EAAE,IAA8C;IAExJ,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC;QACpB,OAAO,KAAK,CAAA;IAChB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;AAC7B,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,IAAyC;IAErE,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAA;AAC/B,CAAC;AAED,MAAM,UAAU,MAAM,CAAC,MAAW;IAE9B,IAAI,OAAM,CAAC,MAAM,CAAC,IAAI,QAAQ,IAAI,MAAM,IAAI,IAAI;QAC5C,OAAO,KAAK,CAAA;IAEhB,MAAM,SAAS,GAAG,CAAC,YAAY,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAA;IAC/E,MAAM,YAAY,GAAG,CAAC,OAAQ,MAA0B,CAAC,IAAI,IAAI,QAAQ,IAAI,CAAE,MAA0B,CAAC,IAAI,EAAE,MAAM,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,IAAK,MAA0B,CAAC,IAAI,IAAI,IAAI,CAAA;IAC7K,MAAM,YAAY,GAAG,OAAQ,MAA0B,CAAC,UAAU,IAAI,QAAQ,IAAI,SAAS,CAAC,QAAQ,CAAE,MAA0B,CAAC,UAAU,CAAC,CAAA;IAE5I,OAAO,YAAY,IAAI,YAAY,CAAA;AACvC,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,MAAW;IAErC,OAAO,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,OAAM,CAAC,CAAC,CAAC,IAAI,QAAQ,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;AAC5F,CAAC;AAED,MAAM,CAAC,MAAM,mBAAmB,GAAsB,CAA8C,IAAgC,EAAE,EAAE;IACpI,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,EAAE,SAAS,EAAE,KAAK,CAAA;IAClD,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC;QAC3B,MAAM,IAAI,KAAK,CAAC,wBAAwB,GAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAA;IAEzE,MAAM,WAAW,GAAwC;QACrD,GAAG,EAAE,IAAI,CAAC,OAAO,EAAE,SAAS,EAAE,GAAG,IAAI,IAAI,CAAC,GAAG,IAAI,SAAS;QAC1D,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,SAAS,EAAE,OAAO;QACzC,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE,SAAS,EAAE,MAAM;KAC1C,CAAA;IACD,IAAI,CAAC,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,mBAAmB,CAAC,WAAW,CAAC,CAAC;QACjE,MAAM,IAAI,KAAK,CAAC,wBAAwB,GAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAA;IAEzE,MAAM,UAAU,GAAG;QACf,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,QAAQ,EAAE,IAAI,CAAC,QAAQ;KAC1B,CAAA;IAED,OAAO,CAAE,WAAW,EAAE,WAAW,EAAE,IAAI,CAAC,OAAO,EAAE,UAAU,CAAE,CAAA;AACjE,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,uBAAuB,GAAsB,CAA8C,IAA8B,EAAE,EAAE;IACtI,MAAM,cAAc,GAAG;QACnB,CAAE,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,WAAW,EAAE,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAa;QACjH,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,WAAW,EAAE,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAa,CAAC,CAAC,CAAC,IAAI;QAC3J,CAAC,MAAM,EAAC,WAAW,EAAC,SAAS,CAAC;KACjC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAyB,CAAA;IACxC,MAAM,WAAW,GAA+B,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,IAAI,EAAE,EAAE,CAAA;IACvE,MAAM,aAAa,GAAQ,EAAQ,CAAA;IACnC,MAAM,UAAU,GAAG;QACf,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,QAAQ,EAAE,IAAI,CAAC,QAAQ;KAC1B,CAAA;IAED,IAAI,CAAC,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,mBAAmB,CAAC,WAAW,CAAC,CAAC;QACjE,MAAM,IAAI,KAAK,CAAC,2CAA2C,GAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,GAAE,WAAW,GAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAA;IAE/H,OAAO,CAAE,WAAW,EAAE,cAAc,EAAE,aAAa,EAAE,UAAU,CAAE,CAAA;AACrE,CAAC,CAAA;AAED,MAAM,UAAU,OAAO,CAAC,KAAgC;IAEpD,IAAI,OAAM,CAAC,KAAK,CAAC,IAAI,QAAQ,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;QAC7C,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;IACtD,OAAO,IAAI,CAAA;AACf,CAAC"}

package/dist/server/components/visual-builder/types.d.ts

@@ -34,9 +34,19 @@ export type CompositionComponentType<NT extends CompositionNode> = ComponentType
 }>>;
 export type LeafPropsFactory = <ET extends Record<string, any>, LT = string>(node: CompositionElementNode<ET>) => [ContentLinkWithLocale<LT> | InlineContentLinkWithLocale<LT>, ContentType, ET] | [ContentLinkWithLocale<LT> | InlineContentLinkWithLocale<LT>, ContentType, ET, Record<string, any>];
 export type NodePropsFactory = <ET extends Record<string, any>, LT = string>(node: CompositionStructureNode) => [ContentLinkWithLocale<LT> | InlineContentLinkWithLocale<LT>, Array<ContentType>, ET] | [ContentLinkWithLocale<LT> | InlineContentLinkWithLocale<LT>, Array<ContentType>, ET, Record<string, any>];
-export type OptimizelyCompositionProps = {
+export type OptimizelyCompositionProps = JSX.IntrinsicAttributes & {
+    /**
+     * The Visual Builder node to start rendering from
+     */
     node: CompositionNode<Record<string, any>>;
+    /**
+     * Allows overriding of the factory that transforms the data received from
+     * Optimizely Graph into properties for an element.
+     */
     leafPropsFactory?: LeafPropsFactory;
+    /**
+     * Allows overriding of the factory that transforms the data received from
+     * Optimizely Graph into properties for a structure node.
+     */
     nodePropsFactory?: NodePropsFactory;
-    key?: string;
 };

package/dist/server/type-utils.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 /**
  * Tests if K is a property of T - if so: it is the type of
  * T[K]; if not: it is equal to never

package/dist/types.d.ts

@@ -2,10 +2,10 @@ import type { PropsWithChildren, ComponentType as ReactComponentType, ExoticComp
 import type { DocumentNode } from "graphql";
 import type { TypedDocumentNode } from '@graphql-typed-document-node/core';
 import type { IOptiGraphClient } from "@remkoj/optimizely-graph-client";
-import type { ContentLink, ContentLinkWithLocale, InlineContentLinkWithLocale } from "@remkoj/optimizely-graph-client";
+import type { ContentLinkWithLocale, InlineContentLinkWithLocale } from "@remkoj/optimizely-graph-client";
 export type ContentType = string[];
 export type { ContentLink, ContentLinkWithLocale } from "@remkoj/optimizely-graph-client";
-export type CmsComponentProps<T> = PropsWithChildren<{
+export type CmsComponentProps<T, L extends Record<string, any> = Record<string, any>> = PropsWithChildren<{
     /**
      * The identifier of the content item
      */
@@ -21,10 +21,9 @@ export type CmsComponentProps<T> = PropsWithChildren<{
     /**
      * Contextual layout data, if any
      */
-    layoutProps?: Record<string, any>;
+    layoutProps?: L;
 }>;
-export type ContentQueryProps<LocaleType = string> = ContentLink & {
-    locale?: Array<LocaleType> | LocaleType | null;
+export type ContentQueryProps<LocaleType = string> = ContentLinkWithLocale<LocaleType> & {
     path?: string | null;
     domain?: string | null;
 };
@@ -43,17 +42,17 @@ export type WithGqlFragment<BaseComponent, DataType> = BaseComponent & {
 export type WithGqlQuery<B, T> = B & {
     getDataQuery: GetDataQuery<T>;
 };
-export type BaseCmsComponent<T = {}> = T extends never | TypedDocumentNode | DocumentNode ? DynamicCmsComponent<T> : ReactComponentType<CmsComponentProps<T>>;
-export type DynamicCmsComponent<T extends TypedDocumentNode | DocumentNode = DocumentNode> = ReactComponentType<CmsComponentProps<ResponseDataType<T>>>;
+export type BaseCmsComponent<T = {}, L extends Record<string, any> = Record<string, any>> = T extends never | TypedDocumentNode | DocumentNode ? DynamicCmsComponent<T> : ReactComponentType<CmsComponentProps<T, L>>;
+export type DynamicCmsComponent<T extends TypedDocumentNode | DocumentNode = DocumentNode, L extends Record<string, any> = Record<string, any>> = ReactComponentType<CmsComponentProps<ResponseDataType<T>, L>>;
 export type GraphQLFragmentBase = {
     ' $fragmentName'?: string;
 };
 export type GraphQLQueryBase = {
     __typename?: 'Query';
 };
-export type CmsComponentWithFragment<T = DocumentNode> = BaseCmsComponent<T> & WithGqlFragment<{}, T>;
-export type CmsComponentWithQuery<T = DocumentNode> = BaseCmsComponent<T> & WithGqlQuery<{}, T>;
-export type CmsComponentWithOptionalQuery<T = DocumentNode> = BaseCmsComponent<T> & Partial<WithGqlQuery<{}, T>>;
+export type CmsComponentWithFragment<T = DocumentNode, L extends Record<string, any> = Record<string, any>> = BaseCmsComponent<T, L> & WithGqlFragment<{}, T>;
+export type CmsComponentWithQuery<T = DocumentNode, L extends Record<string, any> = Record<string, any>> = BaseCmsComponent<T, L> & WithGqlQuery<{}, T>;
+export type CmsComponentWithOptionalQuery<T = DocumentNode, L extends Record<string, any> = Record<string, any>> = BaseCmsComponent<T, L> & Partial<WithGqlQuery<{}, T>>;
 /**
  * A generic Optimizely CMS Component that will change the static surface based upon the
  * provided data type for the component. It will detect automatically whether the component
@@ -63,21 +62,53 @@ export type CmsComponentWithOptionalQuery<T = DocumentNode> = BaseCmsComponent<T
  * When a type is provided that cannot be resolved to either the output of a Query or a Fragment,
  * it will assume an optional getDataQuery method.
  */
-export type CmsComponent<T = DocumentNode> = T extends TypedDocumentNode<infer R, any> ? CmsComponentWithQuery<R> : T extends DocumentNode ? CmsComponentWithQuery<{
+export type CmsComponent<T = DocumentNode, L extends Record<string, any> = Record<string, any>> = T extends TypedDocumentNode<infer R, any> ? CmsComponentWithQuery<R, L> : T extends DocumentNode ? CmsComponentWithQuery<{
     [key: string]: any;
-}> : T extends GraphQLFragmentBase ? CmsComponentWithFragment<T> : T extends GraphQLQueryBase ? CmsComponentWithQuery<T> : CmsComponentWithOptionalQuery<T>;
-export type CmsLayoutComponent<T = never> = ReactComponentType<CmsComponentProps<T>>;
+}, L> : T extends GraphQLFragmentBase ? CmsComponentWithFragment<T, L> : T extends GraphQLQueryBase ? CmsComponentWithQuery<T, L> : CmsComponentWithOptionalQuery<T, L>;
+export type CmsLayoutComponent<L extends Record<string, any> = Record<string, any>, T = never> = ReactComponentType<CmsComponentProps<T, L>>;
 export type ComponentType = (ReactComponentType<any>) | (ReactExoticComponent<any>) | (keyof JSX.IntrinsicElements);
 export type ComponentTypeHandle = string | string[];
 export type ComponentTypeDictionary = {
     type: ComponentTypeHandle;
     component: ComponentType;
 }[];
+/**
+ * Component Factory
+ */
 export interface ComponentFactory {
+    /**
+     * Check if the component type has been registered within the factory
+     *
+     * @param       type            The component type to check for
+     * @returns     Whether or not the type exists within the factory
+     */
     has(type: ComponentTypeHandle): boolean;
+    /**
+     * Register an individual component
+     * @param       type            The component type to register
+     * @param       componentType   The component to bind to the type
+     */
     register(type: ComponentTypeHandle, componentType: ComponentType): void;
+    /**
+     * Register all components provided through the dictionary
+     *
+     * @param       components  The components to register
+     */
     registerAll(components: ComponentTypeDictionary): void;
+    /**
+     * Resolve a component type
+     *
+     * @param       type    The type to search the component for
+     * @returns     The component that was resolved for the provided type
+     */
     resolve(type: ComponentTypeHandle): ComponentType | undefined;
+    /**
+     * Retrieve the registered components as a dictionary that can be used to
+     * be imported in a new instance.
+     *
+     * @returns     The dictionary
+     */
+    extract(): ComponentTypeDictionary;
 }
 export interface GenericContext {
     readonly client?: IOptiGraphClient;

package/dist/utilities.d.ts

@@ -4,7 +4,28 @@ import type { DocumentNode } from 'graphql';
 export declare function isNonEmptyString(toTest: any): toTest is string;
 export declare function isNotNullOrUndefined<T>(toTest?: T | null): toTest is T;
 export declare function isContentType(toTest: any): toTest is Types.ContentType;
-export declare function normalizeContentType(toNormalize: (string | null)[] | null | undefined): Types.ContentType | undefined;
+/**
+ * Normalizes the content type by:
+ *  - Converting strings to ContentType
+ *  - Stripping the leading underscore, if any
+ *
+ * @param       toNormalize         The Content Type value to process
+ * @param       stripContent        When set to true, the global base type "Content" will be removed as well
+ * @returns
+ */
+export declare function normalizeContentType(toNormalize: (string | null)[] | string | null | undefined, stripContent?: boolean): Types.ContentType | undefined;
+/**
+ * Normalizes and prefixes the content type by:
+ *  - Converting strings to ContentType
+ *  - Stripping the leading underscore, if any
+ *  - Removing the global base type "Content"
+ *  - Ensuring that in the remaining type the least specific type is equal to the provided prefix
+ *
+ * @param       contentType
+ * @param       prefix
+ * @returns
+ */
+export declare function normalizeAndPrefixContentType(contentType: Array<string | null> | string | null | undefined, prefix: string): Types.ContentType;
 export declare function isCmsComponentWithDataQuery<T = DocumentNode>(toTest?: Types.BaseCmsComponent<T>): toTest is Types.CmsComponentWithQuery<T>;
 export declare function isCmsComponentWithFragment<T = DocumentNode>(toTest?: Types.BaseCmsComponent<T>): toTest is Types.CmsComponentWithFragment<T>;
 export declare function validatesFragment<T extends ComponentType<any>>(toTest?: T): toTest is T & Pick<Required<Types.WithGqlFragment<T, any>>, "validateFragment">;

package/dist/utilities.js

@@ -10,12 +10,42 @@ export function isContentType(toTest) {
         return false;
     return toTest.every(isNonEmptyString);
 }
-export function normalizeContentType(toNormalize) {
-    if (!Array.isArray(toNormalize))
+/**
+ * Normalizes the content type by:
+ *  - Converting strings to ContentType
+ *  - Stripping the leading underscore, if any
+ *
+ * @param       toNormalize         The Content Type value to process
+ * @param       stripContent        When set to true, the global base type "Content" will be removed as well
+ * @returns
+ */
+export function normalizeContentType(toNormalize, stripContent = false) {
+    if (!toNormalize)
         return undefined;
-    const filtered = toNormalize.filter(isNonEmptyString);
+    let filtered = (typeof (toNormalize) == 'string' ? toNormalize.split('/') : toNormalize).filter(isNonEmptyString).map(x => x.startsWith('_') ? x.substring(1) : x);
+    if (stripContent)
+        filtered = filtered.filter(x => x.toLowerCase() != 'content');
     return filtered.length > 0 ? filtered : undefined;
 }
+/**
+ * Normalizes and prefixes the content type by:
+ *  - Converting strings to ContentType
+ *  - Stripping the leading underscore, if any
+ *  - Removing the global base type "Content"
+ *  - Ensuring that in the remaining type the least specific type is equal to the provided prefix
+ *
+ * @param       contentType
+ * @param       prefix
+ * @returns
+ */
+export function normalizeAndPrefixContentType(contentType, prefix) {
+    if (!contentType)
+        return [prefix];
+    const processedContentType = (typeof (contentType) == 'string' ? contentType.split('/') : contentType).filter(isNonEmptyString).map(x => x.startsWith('_') ? x.substring(1) : x).filter(x => x.toLowerCase() != 'content');
+    if (processedContentType[0] != prefix)
+        processedContentType.unshift(prefix);
+    return processedContentType;
+}
 export function isCmsComponentWithDataQuery(toTest) {
     const toTestType = typeof (toTest);
     if ((toTestType == 'function' || toTestType == 'object') && toTest != null) {

package/dist/utilities.js.map

@@ -1 +1 @@
-{"version":3,"file":"utilities.js","sourceRoot":"","sources":["../src/utilities.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uCAAuC,CAAA;AAE3E,MAAM,UAAU,gBAAgB,CAAC,MAAW;IAExC,OAAO,OAAM,CAAC,MAAM,CAAC,IAAI,QAAQ,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,CAAA;AAC1D,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAI,MAAiB;IAErD,OAAO,CAAC,CAAC,MAAM,IAAI,IAAI,IAAI,MAAM,IAAI,SAAS,CAAC,CAAA;AACnD,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,MAAW;IAErC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;QACtB,OAAO,KAAK,CAAA;IAEhB,OAAO,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAA;AACzC,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,WAAiD;IAElF,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC;QAC3B,OAAO,SAAS,CAAA;IAEpB,MAAM,QAAQ,GAAG,WAAW,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAA;IACrD,OAAO,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAA;AACrD,CAAC;AAED,MAAM,UAAU,2BAA2B,CAAmB,MAAkC;IAE5F,MAAM,UAAU,GAAG,OAAM,CAAC,MAAM,CAAC,CAAA;IACjC,IAAI,CAAC,UAAU,IAAI,UAAU,IAAI,UAAU,IAAI,QAAQ,CAAC,IAAI,MAAM,IAAI,IAAI,EAC1E,CAAC;QACG,OAAQ,MAAsC,CAAC,YAAY,IAAI,OAAM,CAAE,MAAsC,CAAC,YAAY,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAA;IAC5J,CAAC;IACD,OAAO,KAAK,CAAA;AAChB,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAmB,MAAkC;IAE3F,MAAM,UAAU,GAAG,OAAM,CAAC,MAAM,CAAC,CAAA;IACjC,IAAI,CAAC,UAAU,IAAI,UAAU,IAAI,UAAU,IAAI,QAAQ,CAAC,IAAI,MAAM,IAAI,IAAI;QACtE,OAAQ,MAAyC,CAAC,eAAe,IAAI,OAAM,CAAE,MAAyC,CAAC,eAAe,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAA;IACxK,OAAO,KAAK,CAAA;AAChB,CAAC;AAED,MAAM,UAAU,iBAAiB,CAA+B,MAAU;IAGtE,MAAM,UAAU,GAAG,OAAM,CAAC,MAAM,CAAC,CAAA;IACjC,IAAI,CAAC,UAAU,IAAI,UAAU,IAAI,UAAU,IAAI,QAAQ,CAAC,IAAI,MAAM,IAAI,IAAI;QACtE,OAAQ,MAAoB,CAAC,gBAAgB,IAAI,OAAM,CAAE,MAAoB,CAAC,gBAAgB,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAA;IAChI,OAAO,KAAK,CAAA;AAChB,CAAC;AAED,MAAM,UAAU,6BAA6B,CAAC,WAAwC;IAElF,MAAM,SAAS,GAA6B;QACxC,GAAG,EAAE,WAAW,CAAC,GAAG,IAAI,uBAAuB;QAC/C,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,mBAAmB,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS;QAChF,OAAO,EAAE,WAAW,CAAC,OAAO;KAC/B,CAAA;IACD,IAAI,SAAS,CAAC,OAAO,IAAI,SAAS,IAAI,SAAS,CAAC,OAAO,IAAI,EAAE;QACzD,SAAS,CAAC,OAAO,GAAG,IAAI,CAAA;IAC5B,OAAO,SAAS,CAAA;AACpB,CAAC;AAED,MAAM,UAAU,cAAc,CAAgB,KAAQ,EAAE,KAAa,EAAE,KAAe;IAElF,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAA;AACxC,CAAC;AAED,MAAM,UAAU,IAAI,CAAsC,WAAc;IAEpE,IAAI,OAAM,CAAC,WAAW,CAAC,IAAI,QAAQ;QAC/B,OAAO,WAAW,CAAC,IAAI,EAAO,CAAA;IAClC,OAAO,WAAW,CAAA;AACtB,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,WAA8B;IAE3D,OAAO,WAAW,CAAC,GAAG,CAAA;AAC1B,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,YAAY,CAAC,SAAiB,KAAK;IAE/C,IAAI,CAAC;QACD,OAAO,GAAG,MAAM,KAAK,MAAM,CAAC,UAAU,EAAE,EAAE,CAAA;IAC9C,CAAC;IAAC,MAAM,CAAC;QACL,OAAO,GAAG,MAAM,KAAK,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,KAAK,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,KAAK,CAAC,EAAE,CAAA;IAClG,CAAC;AACL,CAAC"}
+{"version":3,"file":"utilities.js","sourceRoot":"","sources":["../src/utilities.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uCAAuC,CAAA;AAE3E,MAAM,UAAU,gBAAgB,CAAC,MAAW;IAExC,OAAO,OAAM,CAAC,MAAM,CAAC,IAAI,QAAQ,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,CAAA;AAC1D,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAI,MAAiB;IAErD,OAAO,CAAC,CAAC,MAAM,IAAI,IAAI,IAAI,MAAM,IAAI,SAAS,CAAC,CAAA;AACnD,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,MAAW;IAErC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;QACtB,OAAO,KAAK,CAAA;IAEhB,OAAO,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAA;AACzC,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,oBAAoB,CAAC,WAA0D,EAAE,eAAwB,KAAK;IAE1H,IAAI,CAAC,WAAW;QACZ,OAAO,SAAS,CAAA;IAEpB,IAAI,QAAQ,GAAG,CAAC,OAAM,CAAC,WAAW,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IACjK,IAAI,YAAY;QACZ,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,IAAI,SAAS,CAAC,CAAA;IACjE,OAAO,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAA;AACrD,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,6BAA6B,CAAC,WAA6D,EAAE,MAAc;IAEvH,IAAI,CAAC,WAAW;QACZ,OAAO,CAAE,MAAM,CAAE,CAAA;IAErB,MAAM,oBAAoB,GAAG,CAAC,OAAM,CAAC,WAAW,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,IAAI,SAAS,CAAC,CAAA;IACzN,IAAI,oBAAoB,CAAC,CAAC,CAAC,IAAI,MAAM;QACjC,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;IAExC,OAAO,oBAAoB,CAAA;AAC/B,CAAC;AAED,MAAM,UAAU,2BAA2B,CAAmB,MAAkC;IAE5F,MAAM,UAAU,GAAG,OAAM,CAAC,MAAM,CAAC,CAAA;IACjC,IAAI,CAAC,UAAU,IAAI,UAAU,IAAI,UAAU,IAAI,QAAQ,CAAC,IAAI,MAAM,IAAI,IAAI,EAC1E,CAAC;QACG,OAAQ,MAAsC,CAAC,YAAY,IAAI,OAAM,CAAE,MAAsC,CAAC,YAAY,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAA;IAC5J,CAAC;IACD,OAAO,KAAK,CAAA;AAChB,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAmB,MAAkC;IAE3F,MAAM,UAAU,GAAG,OAAM,CAAC,MAAM,CAAC,CAAA;IACjC,IAAI,CAAC,UAAU,IAAI,UAAU,IAAI,UAAU,IAAI,QAAQ,CAAC,IAAI,MAAM,IAAI,IAAI;QACtE,OAAQ,MAAyC,CAAC,eAAe,IAAI,OAAM,CAAE,MAAyC,CAAC,eAAe,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAA;IACxK,OAAO,KAAK,CAAA;AAChB,CAAC;AAED,MAAM,UAAU,iBAAiB,CAA+B,MAAU;IAGtE,MAAM,UAAU,GAAG,OAAM,CAAC,MAAM,CAAC,CAAA;IACjC,IAAI,CAAC,UAAU,IAAI,UAAU,IAAI,UAAU,IAAI,QAAQ,CAAC,IAAI,MAAM,IAAI,IAAI;QACtE,OAAQ,MAAoB,CAAC,gBAAgB,IAAI,OAAM,CAAE,MAAoB,CAAC,gBAAgB,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAA;IAChI,OAAO,KAAK,CAAA;AAChB,CAAC;AAED,MAAM,UAAU,6BAA6B,CAAC,WAAwC;IAElF,MAAM,SAAS,GAA6B;QACxC,GAAG,EAAE,WAAW,CAAC,GAAG,IAAI,uBAAuB;QAC/C,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,mBAAmB,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS;QAChF,OAAO,EAAE,WAAW,CAAC,OAAO;KAC/B,CAAA;IACD,IAAI,SAAS,CAAC,OAAO,IAAI,SAAS,IAAI,SAAS,CAAC,OAAO,IAAI,EAAE;QACzD,SAAS,CAAC,OAAO,GAAG,IAAI,CAAA;IAC5B,OAAO,SAAS,CAAA;AACpB,CAAC;AAED,MAAM,UAAU,cAAc,CAAgB,KAAQ,EAAE,KAAa,EAAE,KAAe;IAElF,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAA;AACxC,CAAC;AAED,MAAM,UAAU,IAAI,CAAsC,WAAc;IAEpE,IAAI,OAAM,CAAC,WAAW,CAAC,IAAI,QAAQ;QAC/B,OAAO,WAAW,CAAC,IAAI,EAAO,CAAA;IAClC,OAAO,WAAW,CAAA;AACtB,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,WAA8B;IAE3D,OAAO,WAAW,CAAC,GAAG,CAAA;AAC1B,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,YAAY,CAAC,SAAiB,KAAK;IAE/C,IAAI,CAAC;QACD,OAAO,GAAG,MAAM,KAAK,MAAM,CAAC,UAAU,EAAE,EAAE,CAAA;IAC9C,CAAC;IAAC,MAAM,CAAC;QACL,OAAO,GAAG,MAAM,KAAK,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,KAAK,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,KAAK,CAAC,EAAE,CAAA;IAClG,CAAC;AACL,CAAC"}