@remkoj/optimizely-cms-react 6.0.0-pre8 → 6.0.0-rc.1

package/dist/factory/default.js

@@ -15,6 +15,15 @@ export class DefaultComponentFactory {
      */
     constructor(initialComponents) {
         this.registry = new Map();
+        /**
+         * A list of interfaces to ignore when resolving components. Adjust this
+         * list if you're experiencing issues with resolving components due to
+         * contracts. Values **must be** provided lowercase and without leading
+         * underscore. For example `_Item` must be provided as `item`.
+         *
+         * The default value includes the common ones for SaaS CMS.
+         */
+        this.ignoredContracts = ['item', 'assetitem', 'imageitem', 'content'];
         // Resolve debug mode
         try {
             this.dbg = process.env.OPTIMIZELY_DEBUG == '1';
@@ -26,31 +35,27 @@ export class DefaultComponentFactory {
         if (initialComponents)
             this.registerAll(initialComponents);
     }
-    register(type, component, useSuspense = false, loader) {
-        const registryKey = processComponentTypeHandle(type);
+    register(type, component, useSuspense = false, loader, variant = 'default') {
+        const registryKey = this.processComponentTypeHandle(type, variant);
         if (this.dbg)
             console.log(`➕ [DefaultComponentFactory] Registering ${registryKey}`);
-        this.registry.set(registryKey, { type, component, useSuspense, loader });
+        this.registry.set(registryKey, { type: registryKey, component, useSuspense, loader, variant });
     }
     registerAll(components) {
-        components.forEach((c) => {
-            const registryKey = processComponentTypeHandle(c.type);
-            if (this.dbg)
-                console.log(`➕ [DefaultComponentFactory] Registering ${registryKey}`);
-            this.registry.set(registryKey, c);
-        });
+        components.forEach(c => this.register(c.type, c.component, c.useSuspense, c.loader, c.variant));
     }
-    has(type) {
-        const registryKey = processComponentTypeHandle(type);
-        //if (this.dbg) console.log(`🔎 [DefaultComponentFactory] Checking for ${ registryKey }`)
+    has(type, variant = 'default') {
+        const registryKey = this.processComponentTypeHandle(type, variant);
+        if (this.dbg)
+            console.log(`🔎 [DefaultComponentFactory] Checking for ${registryKey} - ${this.registry.has(registryKey) ? 'YES' : 'NO'}`);
         return this.registry.has(registryKey);
     }
-    resolve(type) {
-        const registryKey = processComponentTypeHandle(type);
+    resolve(type, variant = 'default') {
+        const registryKey = this.processComponentTypeHandle(type, variant);
         const entry = this.registry.get(registryKey);
         if (!entry) {
             if (this.dbg)
-                console.warn(`⚡ [DefaultComponentFactory] Unable to resolve ${registryKey}`);
+                console.warn(`❌ [DefaultComponentFactory] Unable to resolve ${registryKey}, this will prevent the item from rendering`);
             return undefined; // The key is not registered in the factory
         }
         if (entry.useSuspense != true)
@@ -69,23 +74,32 @@ export class DefaultComponentFactory {
         });
     }
     remove(type) {
-        const registryKey = processComponentTypeHandle(type);
+        const registryKey = this.processComponentTypeHandle(type);
         if (this.dbg)
             console.log(`🔎 [DefaultComponentFactory] Removing ${registryKey}`);
         if (!this.registry.has(registryKey))
             return true;
         return this.registry.delete(registryKey);
     }
-}
-function processComponentTypeHandle(handle) {
-    if (typeof handle == 'string')
-        return handle == '' ? EmptyComponentHandle : handle;
-    if (Array.isArray(handle) && handle.every((s) => typeof s == 'string'))
-        return handle
-            .map((s) => (s.startsWith('_') ? s.substring(1) : s)) // Remove all leading underscores
-            .filter((s) => s.toLowerCase() != 'content') // Remove the "Content" base type
-            .map((s) => (s == '' ? EmptyComponentHandle : s)) // Fall back to a fragment
-            .join(MERGE_SYMBOL); // Types are processed as a string
-    throw new Error(`Invalid component type handle: ${typeof handle}`);
+    /**
+     * Process the component variant handle into
+     *
+     * @param handle
+     * @param variant
+     * @returns
+     */
+    processComponentTypeHandle(handle, variant) {
+        let handleToProcess = typeof handle === 'string' ? handle.split(MERGE_SYMBOL) : [...handle];
+        if (Array.isArray(handleToProcess) && handleToProcess.every((s) => typeof s === 'string')) {
+            const offset = (['component', 'page', 'experience'].includes(handleToProcess.at(handleToProcess.length - 3)?.toLowerCase() ?? '') &&
+                !['row', 'column', 'section', 'experience', 'media'].includes(handleToProcess.at(handleToProcess.length - 2)?.toLowerCase() ?? '')) ? 1 : 0;
+            const typeName = handleToProcess.at(handleToProcess.length - (1 + offset));
+            const prefix = handleToProcess.at(handleToProcess.length - (2 + offset)) === 'RichText' ? 'RichText/' : '';
+            const actualVariant = offset > 0 ? handleToProcess.at(handleToProcess.length - 1) ?? variant ?? 'default' : variant ?? 'default';
+            const newHandle = prefix + typeName + '/' + actualVariant;
+            return newHandle;
+        }
+        throw new Error(`Invalid component type handle: ${typeof handle}`);
+    }
 }
 //# sourceMappingURL=default.js.map

package/dist/factory/default.js.map

@@ -1 +1 @@
-{"version":3,"file":"default.js","sourceRoot":"","sources":["../../src/factory/default.tsx"],"names":[],"mappings":";AAOA,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAA;AAEhC,MAAM,CAAC,MAAM,YAAY,GAAG,GAAG,CAAA;AAE/B,MAAM,CAAC,MAAM,oBAAoB,GAAG,cAAc,CAAA;AAElD;;;GAGG;AACH,MAAM,OAAO,uBAAuB;IAIlC;;;;;OAKG;IACH,YAAmB,iBAA2C;QATtD,aAAQ,GAAG,IAAI,GAAG,EAAwC,CAAA;QAUhE,qBAAqB;QACrB,IAAI,CAAC;YACH,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,gBAAgB,IAAI,GAAG,CAAA;QAChD,CAAC;QAAC,MAAM,CAAC;YACP,IAAI,CAAC,GAAG,GAAG,KAAK,CAAA;QAClB,CAAC;QAED,kCAAkC;QAClC,IAAI,iBAAiB;YAAE,IAAI,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAA;IAC5D,CAAC;IAED,QAAQ,CACN,IAAyB,EACzB,SAAwB,EACxB,cAAuB,KAAK,EAC5B,MAAsB;QAEtB,MAAM,WAAW,GAAG,0BAA0B,CAAC,IAAI,CAAC,CAAA;QACpD,IAAI,IAAI,CAAC,GAAG;YACV,OAAO,CAAC,GAAG,CAAC,2CAA2C,WAAW,EAAE,CAAC,CAAA;QACvE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC,CAAA;IAC1E,CAAC;IAED,WAAW,CAAC,UAAmC;QAC7C,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YACvB,MAAM,WAAW,GAAG,0BAA0B,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;YACtD,IAAI,IAAI,CAAC,GAAG;gBACV,OAAO,CAAC,GAAG,CAAC,2CAA2C,WAAW,EAAE,CAAC,CAAA;YACvE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC,CAAA;QACnC,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,GAAG,CAAC,IAAyB;QAC3B,MAAM,WAAW,GAAG,0BAA0B,CAAC,IAAI,CAAC,CAAA;QACpD,yFAAyF;QACzF,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;IACvC,CAAC;IAED,OAAO,CAAC,IAAyB;QAC/B,MAAM,WAAW,GAAG,0BAA0B,CAAC,IAAI,CAAC,CAAA;QAEpD,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;QAC5C,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,IAAI,IAAI,CAAC,GAAG;gBACV,OAAO,CAAC,IAAI,CACV,iDAAiD,WAAW,EAAE,CAC/D,CAAA;YACH,OAAO,SAAS,CAAA,CAAC,2CAA2C;QAC9D,CAAC;QACD,IAAI,KAAK,CAAC,WAAW,IAAI,IAAI;YAAE,OAAO,KAAK,CAAC,SAAS,CAAA,CAAC,6DAA6D;QAEnH,6CAA6C;QAC7C,MAAM,cAAc,GAAG,KAAK,CAAC,SAAS,CAAA;QACtC,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,CAAA;QAChC,SAAS,SAAS,CAAC,KAA0B;YAC3C,OAAO,CACL,KAAC,QAAQ,IAAC,QAAQ,EAAE,WAAW,IAAI,KAAC,WAAW,OAAK,KAAK,GAAI,YAC3D,KAAC,cAAc,OAAK,KAAK,GAAI,GACpB,CACZ,CAAA;QACH,CAAC;QACD,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,OAAO;QACL,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YAC9D,OAAO,EAAE,GAAG,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,CAAA;QAChC,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,MAAM,CAAC,IAAyB;QAC9B,MAAM,WAAW,GAAG,0BAA0B,CAAC,IAAI,CAAC,CAAA;QACpD,IAAI,IAAI,CAAC,GAAG;YACV,OAAO,CAAC,GAAG,CAAC,yCAAyC,WAAW,EAAE,CAAC,CAAA;QACrE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC;YAAE,OAAO,IAAI,CAAA;QAChD,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,CAAA;IAC1C,CAAC;CACF;AAED,SAAS,0BAA0B,CAAC,MAA2B;IAC7D,IAAI,OAAO,MAAM,IAAI,QAAQ;QAC3B,OAAO,MAAM,IAAI,EAAE,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,MAAM,CAAA;IACrD,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,QAAQ,CAAC;QACpE,OAAO,MAAM;aACV,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,iCAAiC;aACtF,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,IAAI,SAAS,CAAC,CAAC,iCAAiC;aAC7E,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,0BAA0B;aAC3E,IAAI,CAAC,YAAY,CAAC,CAAA,CAAC,kCAAkC;IAC1D,MAAM,IAAI,KAAK,CAAC,kCAAkC,OAAO,MAAM,EAAE,CAAC,CAAA;AACpE,CAAC"}
+{"version":3,"file":"default.js","sourceRoot":"","sources":["../../src/factory/default.tsx"],"names":[],"mappings":";AAOA,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAA;AAEhC,MAAM,CAAC,MAAM,YAAY,GAAG,GAAG,CAAA;AAE/B,MAAM,CAAC,MAAM,oBAAoB,GAAG,cAAc,CAAA;AAElD;;;GAGG;AACH,MAAM,OAAO,uBAAuB;IAclC;;;;;OAKG;IACH,YAAmB,iBAA2C;QAnBtD,aAAQ,GAAG,IAAI,GAAG,EAAwC,CAAA;QAGlE;;;;;;;WAOG;QACI,qBAAgB,GAAa,CAAC,MAAM,EAAC,WAAW,EAAC,WAAW,EAAC,SAAS,CAAC,CAAA;QAS5E,qBAAqB;QACrB,IAAI,CAAC;YACH,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,gBAAgB,IAAI,GAAG,CAAA;QAChD,CAAC;QAAC,MAAM,CAAC;YACP,IAAI,CAAC,GAAG,GAAG,KAAK,CAAA;QAClB,CAAC;QAED,kCAAkC;QAClC,IAAI,iBAAiB;YAAE,IAAI,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAA;IAC5D,CAAC;IAEM,QAAQ,CACb,IAAyB,EACzB,SAAwB,EACxB,cAAuB,KAAK,EAC5B,MAAsB,EACtB,UAAkB,SAAS;QAE3B,MAAM,WAAW,GAAG,IAAI,CAAC,0BAA0B,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAClE,IAAI,IAAI,CAAC,GAAG;YACV,OAAO,CAAC,GAAG,CAAC,2CAA2C,WAAW,EAAE,CAAC,CAAA;QACvE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAA;IAChG,CAAC;IAEM,WAAW,CAAC,UAAmC;QACpD,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAA;IACjG,CAAC;IAEM,GAAG,CAAC,IAAyB,EAAE,UAAkB,SAAS;QAC/D,MAAM,WAAW,GAAG,IAAI,CAAC,0BAA0B,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAClE,IAAI,IAAI,CAAC,GAAG;YACV,OAAO,CAAC,GAAG,CAAC,6CAA8C,WAAY,MAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAA;QAC/H,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;IACvC,CAAC;IAEM,OAAO,CAAC,IAAyB,EAAE,UAAkB,SAAS;QACnE,MAAM,WAAW,GAAG,IAAI,CAAC,0BAA0B,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAElE,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;QAC5C,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,IAAI,IAAI,CAAC,GAAG;gBACV,OAAO,CAAC,IAAI,CACV,iDAAiD,WAAW,6CAA6C,CAC1G,CAAA;YACH,OAAO,SAAS,CAAA,CAAC,2CAA2C;QAC9D,CAAC;QACD,IAAI,KAAK,CAAC,WAAW,IAAI,IAAI;YAAE,OAAO,KAAK,CAAC,SAAS,CAAA,CAAC,6DAA6D;QAEnH,6CAA6C;QAC7C,MAAM,cAAc,GAAG,KAAK,CAAC,SAAS,CAAA;QACtC,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,CAAA;QAChC,SAAS,SAAS,CAAC,KAA0B;YAC3C,OAAO,CACL,KAAC,QAAQ,IAAC,QAAQ,EAAE,WAAW,IAAI,KAAC,WAAW,OAAK,KAAK,GAAI,YAC3D,KAAC,cAAc,OAAK,KAAK,GAAI,GACpB,CACZ,CAAA;QACH,CAAC;QACD,OAAO,SAAS,CAAA;IAClB,CAAC;IAEM,OAAO;QACZ,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YAC9D,OAAO,EAAE,GAAG,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,CAAA;QAChC,CAAC,CAAC,CAAA;IACJ,CAAC;IAEM,MAAM,CAAC,IAAyB;QACrC,MAAM,WAAW,GAAG,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,CAAA;QACzD,IAAI,IAAI,CAAC,GAAG;YACV,OAAO,CAAC,GAAG,CAAC,yCAAyC,WAAW,EAAE,CAAC,CAAA;QACrE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC;YAAE,OAAO,IAAI,CAAA;QAChD,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,CAAA;IAC1C,CAAC;IAED;;;;;;OAMG;IACK,0BAA0B,CAAC,MAA2B,EAAE,OAAgB;QAC9E,IAAI,eAAe,GAAG,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;QAC5F,IAAI,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC,IAAI,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,EAAE,CAAC;YAE1F,MAAM,MAAM,GAAG,CACb,CAAC,WAAW,EAAC,MAAM,EAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,WAAW,EAAE,IAAE,EAAE,CAAC;gBAC7G,CAAC,CAAC,KAAK,EAAC,QAAQ,EAAC,SAAS,EAAC,YAAY,EAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,WAAW,EAAE,IAAE,EAAE,CAAC,CAC7H,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;YAET,MAAM,QAAQ,GAAG,eAAe,CAAC,EAAE,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC,GAAC,MAAM,CAAC,CAAC,CAAA;YACxE,MAAM,MAAM,GAAG,eAAe,CAAC,EAAE,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC,GAAC,MAAM,CAAC,CAAC,KAAK,UAAU,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,CAAA;YACxG,MAAM,aAAa,GAAG,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,EAAE,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,OAAO,IAAI,SAAS,CAAC,CAAC,CAAC,OAAO,IAAI,SAAS,CAAA;YAChI,MAAM,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,GAAG,GAAG,aAAa,CAAA;YAEzD,OAAO,SAAS,CAAA;QAClB,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,kCAAkC,OAAO,MAAM,EAAE,CAAC,CAAA;IACpE,CAAC;CACF"}

package/dist/factory/types.d.ts

@@ -25,18 +25,36 @@ export type ComponentTypeDictionaryEntry = {
      * The component to use as "loading" state by the <Suspense />
      */
     loader?: ComponentType;
+    /**
+     * Used for the loading of a specific variant of the component (for example 'header', 'footer', 'menu')
+     */
+    variant?: string;
+    /**
+     * Optional marker to indicate that the component is a Client Side component, which
+     * may add attribute filtering in the future.
+     */
+    isClient?: boolean;
 };
 /**
  * Component Factory
  */
 export interface ComponentFactory {
+    /**
+     * A list of interfaces to ignore when resolving components. Adjust this
+     * list if you're experiencing issues with resolving components due to
+     * contracts. Values **must be** provided lowercase and without leading
+     * underscore. For example `_Item` must be provided as `item`.
+     *
+     * The default value includes the common ones for SaaS CMS.
+     */
+    ignoredContracts: string[];
     /**
      * 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;
+    has(type: ComponentTypeHandle, variant?: string): boolean;
     /**
      * Register an individual component. When the component type has already
      * been registered it will be updated.
@@ -45,8 +63,9 @@ export interface ComponentFactory {
      * @param       component       The component to bind to the type
      * @param       useSuspense     If set to 'true' the registered component will be wrapped in <Suspense />
      * @param       loader          The component to use as "loading" state by the <Suspense />
+     * @param       variant         The specific variant of the component (for example 'header', 'footer', 'menu')
      */
-    register(type: ComponentTypeHandle, component: ComponentType, useSuspense?: boolean, loader?: ComponentType): void;
+    register(type: ComponentTypeHandle, component: ComponentType, useSuspense?: boolean, loader?: ComponentType, variant?: string): void;
     /**
      * Register all components provided through the dictionary. When the
      * component type has already been registered it will be updated.
@@ -59,17 +78,18 @@ export interface ComponentFactory {
      * the implemenation supports it.
      *
      * @param       type            The component type to remove
+     * @param       variant         The variant of the component type, will remove all if not specified
      * @returns     `true` If the component was not found or removed, `false`
      *              otherwise
      */
-    remove?: (type: ComponentTypeHandle) => boolean;
+    remove?: (type: ComponentTypeHandle, variant?: string) => boolean;
     /**
      * 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;
+    resolve(type: ComponentTypeHandle, variant?: string): ComponentType | undefined;
     /**
      * Retrieve the registered components as a dictionary that can be used to
      * be imported in a new instance.

package/dist/factory/undef.d.ts

@@ -1,9 +1,11 @@
-import { ComponentType, ComponentTypeDictionary, ComponentTypeHandle, type ComponentFactory } from "./types.js";
+import { ComponentType, ComponentTypeDictionary, type ComponentFactory } from "./types.js";
 export declare class UndefinedComponentFactory implements ComponentFactory {
-    has(type: ComponentTypeHandle): boolean;
-    register(type: ComponentTypeHandle, componentType: ComponentType): void;
-    registerAll(components: ComponentTypeDictionary): void;
-    resolve(type: ComponentTypeHandle): ComponentType | undefined;
+    get ignoredContracts(): string[];
+    set ignoredContracts(newList: string[]);
+    has(): boolean;
+    register(): void;
+    registerAll(): void;
+    resolve(): ComponentType | undefined;
     extract(): ComponentTypeDictionary;
 }
 export default UndefinedComponentFactory;

package/dist/factory/undef.js

@@ -1,14 +1,20 @@
 export class UndefinedComponentFactory {
-    has(type) {
+    get ignoredContracts() {
         throw new Error("Factory not specified, please specify a factory.");
     }
-    register(type, componentType) {
+    set ignoredContracts(newList) {
         throw new Error("Factory not specified, please specify a factory.");
     }
-    registerAll(components) {
+    has() {
         throw new Error("Factory not specified, please specify a factory.");
     }
-    resolve(type) {
+    register() {
+        throw new Error("Factory not specified, please specify a factory.");
+    }
+    registerAll() {
+        throw new Error("Factory not specified, please specify a factory.");
+    }
+    resolve() {
         throw new Error("Factory not specified, please specify a factory.");
     }
     extract() {

package/dist/factory/undef.js.map

@@ -1 +1 @@
-{"version":3,"file":"undef.js","sourceRoot":"","sources":["../../src/factory/undef.ts"],"names":[],"mappings":"AAEA,MAAM,OAAO,yBAAyB;IAClC,GAAG,CAAC,IAAyB;QACzB,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;IACxE,CAAC;IACD,QAAQ,CAAC,IAAyB,EAAE,aAA4B;QAC5D,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;IACxE,CAAC;IACD,WAAW,CAAC,UAAmC;QAC3C,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;IACxE,CAAC;IACD,OAAO,CAAC,IAAyB;QAC7B,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;IACxE,CAAC;IACD,OAAO;QACH,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;IACxE,CAAC;CACJ;AAED,eAAe,yBAAyB,CAAA"}
+{"version":3,"file":"undef.js","sourceRoot":"","sources":["../../src/factory/undef.ts"],"names":[],"mappings":"AAEA,MAAM,OAAO,yBAAyB;IACpC,IAAI,gBAAgB;QAClB,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;IACtE,CAAC;IACD,IAAI,gBAAgB,CAAC,OAAiB;QACpC,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;IACtE,CAAC;IACD,GAAG;QACD,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;IACtE,CAAC;IACD,QAAQ;QACN,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;IACtE,CAAC;IACD,WAAW;QACT,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;IACtE,CAAC;IACD,OAAO;QACL,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;IACtE,CAAC;IACD,OAAO;QACL,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;IACtE,CAAC;CACF;AAED,eAAe,yBAAyB,CAAA"}

package/dist/rsc.d.ts

@@ -6,5 +6,29 @@ export * from './factory/index.js';
 export * from './context/types.js';
 export * from './context/rsc.js';
 export * from './components/rsc.js';
+/**
+ * RSC component exports, including `CmsEditable`, `CmsContent`,
+ * `CmsContentArea` and their prop types.
+ *
+ * `CmsContent` usage:
+ *
+ * ```tsx
+ * import { CmsContent } from '@remkoj/optimizely-cms-react/rsc'
+ *
+ * <CmsContent contentLink={{ key: content._metadata.key, locale: 'en' }} />
+ * ```
+ *
+ * `CmsContentArea` usage:
+ *
+ * ```tsx
+ * import { CmsContentArea } from '@remkoj/optimizely-cms-react/rsc'
+ *
+ * <CmsContentArea
+ *   items={content.MainContentArea}
+ *   fieldName="MainContentArea"
+ *   as="section"
+ * />
+ * ```
+ */
 export * from './components/rsc-components.js';
 export * from './rsc-utilities.js';

package/dist/rsc.js

@@ -12,6 +12,30 @@ export * from './context/types.js';
 // Export React Server Components
 export * from './context/rsc.js';
 export * from './components/rsc.js';
+/**
+ * RSC component exports, including `CmsEditable`, `CmsContent`,
+ * `CmsContentArea` and their prop types.
+ *
+ * `CmsContent` usage:
+ *
+ * ```tsx
+ * import { CmsContent } from '@remkoj/optimizely-cms-react/rsc'
+ *
+ * <CmsContent contentLink={{ key: content._metadata.key, locale: 'en' }} />
+ * ```
+ *
+ * `CmsContentArea` usage:
+ *
+ * ```tsx
+ * import { CmsContentArea } from '@remkoj/optimizely-cms-react/rsc'
+ *
+ * <CmsContentArea
+ *   items={content.MainContentArea}
+ *   fieldName="MainContentArea"
+ *   as="section"
+ * />
+ * ```
+ */
 export * from './components/rsc-components.js';
 export * from './rsc-utilities.js';
 //# sourceMappingURL=rsc.js.map

package/dist/rsc.js.map

@@ -1 +1 @@
-{"version":3,"file":"rsc.js","sourceRoot":"","sources":["../src/rsc.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,SAAS,MAAM,gBAAgB,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAA;AAC5D,MAAM,CAAC,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAA;AAExC,iBAAiB;AACjB,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AACrC,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAA;AACvC,cAAc,YAAY,CAAA;AAC1B,cAAc,oBAAoB,CAAA;AAClC,cAAc,oBAAoB,CAAA;AAElC,iCAAiC;AACjC,cAAc,kBAAkB,CAAA;AAChC,cAAc,qBAAqB,CAAA;AACnC,cAAc,gCAAgC,CAAA;AAC9C,cAAc,oBAAoB,CAAA"}
+{"version":3,"file":"rsc.js","sourceRoot":"","sources":["../src/rsc.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,SAAS,MAAM,gBAAgB,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAA;AAC5D,MAAM,CAAC,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAA;AAExC,iBAAiB;AACjB,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AACrC,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAA;AACvC,cAAc,YAAY,CAAA;AAC1B,cAAc,oBAAoB,CAAA;AAClC,cAAc,oBAAoB,CAAA;AAElC,iCAAiC;AACjC,cAAc,kBAAkB,CAAA;AAChC,cAAc,qBAAqB,CAAA;AACnC;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,cAAc,gCAAgC,CAAA;AAC9C,cAAc,oBAAoB,CAAA"}

package/dist/types.d.ts

@@ -3,6 +3,9 @@ import type { DocumentNode } from "graphql";
 import type { TypedDocumentNode } from '@graphql-typed-document-node/core';
 import type { ContentLinkWithLocale, ContentLink, InlineContentLinkWithLocale } from "@remkoj/optimizely-graph-client";
 import type { GenericContext } from "./context/types.js";
+import type { CmsEditableProps } from "./components/cms-editable/index.js";
+import type { VariationInput } from "@remkoj/optimizely-graph-client/router";
+export type { VariationInput } from "@remkoj/optimizely-graph-client/router";
 export type ContentType = string[];
 export type { 
 /**
@@ -13,9 +16,10 @@ ContentLink,
  * @deprecated  Use the export from `@remkoj/optimizely-graph-client` directly
  */
 ContentLinkWithLocale } from "@remkoj/optimizely-graph-client";
+export type ComponentCmsEditableProps = Pick<CmsEditableProps<'div'>, 'cmsId' | 'ctx' | 'currentContent'>;
 export type CmsComponentProps<T, L extends Record<string, any> = Record<string, any>> = PropsWithChildren<{
     /**
-     * The identifier of the content item
+     * The identifier of the content item.
      */
     contentLink: ContentLinkWithLocale | InlineContentLinkWithLocale;
     /**
@@ -24,22 +28,30 @@ export type CmsComponentProps<T, L extends Record<string, any> = Record<string,
     data: T;
     /**
      * Use the Server/Client context instead if you need this information
+     *
+     * @deprecated
      */
     inEditMode?: boolean;
     /**
-     * Contextual layout data, if any
+     * Contextual layout data from an Experience. This will be `undefined` if
+     * there's no layout data attached.
      */
     layoutProps?: L;
+    /**
+     * The minimal properties needed to render a CmsEditable inside the
+     * component.
+     */
+    editProps?: ComponentCmsEditableProps;
     /**
      * The context in which this component will be rendered
      */
     ctx?: GenericContext;
 }>;
-export type ContentQueryProps<LocaleType = string> = ContentLink & {
+export type ContentQueryProps<LocaleType = string> = Omit<ContentLink, 'isInline' | 'variation'> & {
     locale?: Array<LocaleType> | LocaleType | null;
     path?: string | null;
     domain?: string | null;
-    changeset?: string | null;
+    variation?: VariationInput | null;
 };
 /**
  * Extract the data type from a GraphQL Query
@@ -47,7 +59,22 @@ export type ContentQueryProps<LocaleType = string> = ContentLink & {
 export type ResponseDataType<T extends DocumentNode> = T extends TypedDocumentNode<infer DataType> ? DataType : {
     [key: string]: any;
 };
-export type GetDataQuery<T> = () => TypedDocumentNode<T, ContentQueryProps> | DocumentNode;
+export type GetDataQueryResponseTemplate = {
+    __typename?: 'Query' | null;
+    data?: {
+        __typename?: string | null;
+        item?: {
+            __typename?: string | null;
+            _metadata?: {
+                key?: string | null;
+                locale?: any | null;
+            } | null;
+            [key: string]: any;
+        } | null;
+    } | null;
+};
+export type ProcessQueryResponse<T> = T extends GetDataQueryResponseTemplate ? NonNullable<NonNullable<Required<T>['data']>['item']> : T;
+export type GetDataQuery<T> = () => TypedDocumentNode<T, Omit<ContentQueryProps, 'path' | 'domain'>> | DocumentNode;
 export type GetDataFragment<T> = () => [string, TypedDocumentNode<T, never> | DocumentNode | string];
 export type WithGqlFragment<BaseComponent, DataType> = BaseComponent & {
     getDataFragment: GetDataFragment<DataType>;
@@ -56,7 +83,7 @@ export type WithGqlFragment<BaseComponent, DataType> = BaseComponent & {
 export type WithGqlQuery<B, T> = B & {
     getDataQuery: GetDataQuery<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 BaseCmsComponent<T = {}, L extends Record<string, any> = Record<string, any>> = T extends never | TypedDocumentNode | DocumentNode ? DynamicCmsComponent<ProcessQueryResponse<T>> : ReactComponentType<CmsComponentProps<ProcessQueryResponse<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;
@@ -79,4 +106,8 @@ export type CmsComponentWithOptionalQuery<T = DocumentNode, L extends Record<str
 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;
 }, L> : T extends GraphQLFragmentBase ? CmsComponentWithFragment<T, L> : T extends GraphQLQueryBase ? CmsComponentWithQuery<T, L> : CmsComponentWithOptionalQuery<T, L>;
+/**
+ * A generic Optimizely CMS Component used to render a layout node from an experience, which cannot
+ * be loaded directly as independent Content Item from Optimizely Graph
+ */
 export type CmsLayoutComponent<L extends Record<string, any> = Record<string, any>, T = never> = ReactComponentType<CmsComponentProps<T, L>>;

package/dist/utilities.d.ts

@@ -1,9 +1,24 @@
 import type { ComponentType } from 'react';
 import type { DocumentNode } from 'graphql';
-import type { ContentLinkWithLocale, ContentLink } from '@remkoj/optimizely-graph-client';
-import type { ContentType, BaseCmsComponent, CmsComponentWithQuery, CmsComponentWithFragment, WithGqlFragment, ContentQueryProps } from './types.js';
-import type { ComponentFactory, ComponentTypeHandle } from './factory/types.js';
+import type { ContentLinkWithLocale, ContentLink, IOptiGraphClient, InlineContentLink } from '@remkoj/optimizely-graph-client';
+import type { ContentType, BaseCmsComponent, CmsComponentWithQuery, CmsComponentWithFragment, WithGqlFragment, ContentQueryProps, CmsComponentProps } from './types.js';
+import type { ComponentFactory } from './factory/types.js';
 export * from './components/rich-text/utils.js';
+/**
+ * Safeguard filter to remove default properties from the CmsComponent, intended
+ * to prevent these properties to be passed to client components. It will also
+ * remove all properties where the name starts with a `_`.
+ *
+ * @param     toFilter  The object to filter the
+ * @returns   W
+ */
+export declare function filterCmsComponentProps<T extends object>(toFilter: T): Omit<T, keyof CmsComponentProps<any>>;
+/**
+ *
+ *
+ * @param     toTest
+ * @returns
+ */
 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 ContentType;
@@ -40,14 +55,40 @@ export declare function normalizeAndPrefixContentType(contentType: Array<string
  * @param       variants    The variants to test
  * @returns     The resolved Component or undefined if not found
  */
-export declare function resolveComponentType(factory: ComponentFactory, type: ComponentTypeHandle, variants?: Array<string>): ReturnType<ComponentFactory['resolve']>;
+export declare function resolveComponentType(factory: ComponentFactory, type: ContentType, variants?: Array<string>): ReturnType<ComponentFactory['resolve']>;
 export declare function isCmsComponentWithDataQuery<T = DocumentNode>(toTest?: BaseCmsComponent<T>): toTest is CmsComponentWithQuery<T>;
 export declare function isCmsComponentWithFragment<T = DocumentNode>(toTest?: BaseCmsComponent<T>): toTest is CmsComponentWithFragment<T>;
 export declare function validatesFragment<T extends ComponentType<any>>(toTest?: T): toTest is T & Pick<Required<WithGqlFragment<T, any>>, "validateFragment">;
-export declare function contentLinkToRequestVariables(contentLink: ContentLinkWithLocale): ContentQueryProps;
+/**
+ * Take a ContentLink and transform it into the normalized set of request variables used query for content across
+ * multiple components.
+ *
+ * @param     contentLink     The contentlink to transform
+ * @param     client          If provided, the the configuration of the client is applied to the variables
+ * @returns   The request variables to use for querying Optimizely Graph
+ */
+export declare function contentLinkToRequestVariables(contentLink: ContentLinkWithLocale, client: IOptiGraphClient): ContentQueryProps;
+/**
+ * Normalizes a string|null|undefined input to a non-empty string or undefined. This ensures that a
+ * non-empty string is considered insignificant and will not yield an empty result. When provided,
+ * the transformer function is applied *after* the non-empty check and the outcome of the transformer
+ * is returned.
+ *
+ * @param     inputValue    The current value to check
+ * @param     transformer   The transformer to apply to a non-empty string value
+ * @returns   The output of the transformer when the input is a non-empty string, `undefined` otherwise
+ */
+export declare function ifNonEmptyString<T = string>(inputValue?: string | null, transformer?: (iv: string) => T): T | undefined;
 export declare function toUniqueValues<R extends any>(value: R, index: number, array: Array<R>): value is R;
 export declare function trim<T extends string | null | undefined>(valueToTrim: T): T;
-export declare function getContentEditId(contentLink: ContentLink): string;
+/**
+ * Extract the identifier needed for the edit HTML properties from the contentLink. This will ensure
+ * that inline content links don't output an identifier.
+ *
+ * @param contentLink
+ * @returns
+ */
+export declare function getContentEditId(contentLink?: ContentLink | InlineContentLink | null): string | undefined;
 /**
  * Generate a pseudo-random identifier usable to satisfy the unique key
  * requirement for children within a React node. However this effectively will
@@ -61,3 +102,12 @@ export declare function getContentEditId(contentLink: ContentLink): string;
  * @returns     The unique key
  */
 export declare function getRandomKey(prefix?: string): string;
+/**
+ * Parse the provided string to determine if it's a valid positive (i.e. larger then 0) number,
+ * return the number if it is, `undefined` or the `defaultValue` otherwise.
+ *
+ * @param     value
+ * @param     defaultValue
+ * @returns
+ */
+export declare function tryParsePositiveInt(value: string | undefined | null, defaultValue?: number): number | undefined;