@uniformdev/canvas 12.2.0 → 12.2.1-alpha.107

package/dist/esm/types/enhancement.d.ts

@@ -1,79 +0,0 @@
-import { LimitPolicy } from '..';
-import { ComponentInstance, ComponentParameter } from './componentInstances';
-export declare type EnhancerContext = {
-    preview?: boolean;
-};
-/** Options passed to a ComponentEnhancer function */
-export declare type ComponentEnhancerOptions<TContext extends EnhancerContext = EnhancerContext> = {
-    component: Readonly<ComponentInstance>;
-    context: TContext;
-};
-/**
- * A function which is called for each matching component in a composition, which can manipulate the value of a specific key in the component's `data` property.
- * Used to enhance layout data with information from other platforms, such as private APIs, where the value is not tied to a parameter
- * and is intrinsic to the component itself.
- *
- * Note: the configuration of enhancers namespaces component enhancers into a named property on the data object to avoid collisions,
- * thus an enhancer need not worry about merging values with other enhancers, nor which key it has been registered under.
- *
- * Return values:
- * TValue - sets the configured key in the component's data value to this value
- * undefined - do not set the component's data key
- */
-export declare type ComponentEnhancerFunction<TValue = unknown, TContext extends EnhancerContext = EnhancerContext> = (options: ComponentEnhancerOptions<TContext>) => Promise<TValue | undefined> | TValue | undefined;
-/**
- * Defines logic to add arbitrary async data to a component's `data` property.
- * Used to enhance layout data with information from other platforms, such as private APIs,
- * where the value is not tied to a parameter and is intrinsic to the component itself.
- */
-export declare type ComponentEnhancer<TValue = unknown, TContext extends EnhancerContext = EnhancerContext> = {
-    /** Function called to enhance a single component in a composition. */
-    enhanceOne: ComponentEnhancerFunction<TValue, TContext>;
-    /**
-     * The limit policy that defines how much concurrency and retry is allowed for this enhancer.
-     * If the enhancer does not define completeAll(), this limit policy is applied to enhanceOne() calls.
-     * If the enhancer does define completeAll(), this limit policy is applied to the completeAll() calls.
-     * If the limit policy is undefined, unbounded concurrency is allowed and no error retrying will occur.
-     */
-    limitPolicy?: LimitPolicy;
-    completeAll?: () => Promise<void>;
-};
-/** Options passed to a ComponentParameterEnhancer function */
-export declare type ComponentParameterEnhancerOptions<TRawValue = unknown, TContext extends EnhancerContext = EnhancerContext> = {
-    parameter: Readonly<ComponentParameter<TRawValue>>;
-    parameterName: string;
-    component: Readonly<ComponentInstance>;
-    context: TContext;
-};
-/**
- * A function which is called for each component parameter in a component tree, which can manipulate the value of the parameter.
- * Used to enhance layout data with information from other platforms, such as CMS, commerce, indexing, etc.
- *
- * Return values:
- * TValue - replaces the original parameter value with this value
- * undefined - do not change the original parameter value
- * null - sets the parameter value to null, replacing any existing value (i.e. if its value could not be resolved in an external system)
- */
-export declare type ComponentParameterEnhancerFunction<TRawValue = unknown, TOutputValue = unknown, TContext extends EnhancerContext = EnhancerContext> = (options: ComponentParameterEnhancerOptions<TRawValue, TContext>) => Promise<TOutputValue | undefined | null> | TOutputValue | undefined | null;
-/**
- * Defines logic to replace the value of a component parameter with arbitrary async data.
- * Used to enhance layout data with information from other platforms, such as CMS, commerce, indexing, etc,
- * where that data is directly expandable from a parameter value.
- */
-export declare type ComponentParameterEnhancer<TRawValue = unknown, TOutputValue = unknown, TContext extends EnhancerContext = EnhancerContext> = {
-    /** Function called to enhance a single parameter to be enhanced. */
-    enhanceOne: ComponentParameterEnhancerFunction<TRawValue, TOutputValue, TContext>;
-    /**
-     * The limit policy that defines how much concurrency and retry is allowed for this enhancer.
-     * If the enhancer does not define completeAll(), this limit policy is applied to enhanceOne() calls.
-     * If the enhancer does define completeAll(), this limit policy is applied to the completeAll() calls.
-     * If the limit policy is undefined, unbounded concurrency is allowed and no error retrying will occur.
-     */
-    limitPolicy?: LimitPolicy;
-    /**
-     * Function called, if defined, after all enhanceOne() calls have completed for the composition being enhanced.
-     * Used to enable batching.
-     * Return the number of batched items processed (or zero if that does not apply).
-     */
-    completeAll?: () => Promise<number>;
-};

package/dist/esm/types/index.d.ts

@@ -1,3 +0,0 @@
-export * from './componentDefinitions';
-export * from './componentInstances';
-export * from './enhancement';

package/dist/esm/types/index.js

@@ -1 +0,0 @@
-export*from"./componentDefinitions";export*from"./componentInstances";export*from"./enhancement";

package/dist/esm/utils/constants.d.ts

@@ -1,20 +0,0 @@
-/** Public ID of Canvas personalization component type */
-export declare const CANVAS_PERSONALIZE_TYPE = "$personalization";
-/** Public ID of Canvas A/B test component type */
-export declare const CANVAS_TEST_TYPE = "$test";
-/** Public ID of Canvas localization component type */
-export declare const CANVAS_LOCALIZATION_TYPE = "$localization";
-/** Public ID of the intent tag parameter on the Canvas personalization component type */
-export declare const CANVAS_INTENT_TAG_PARAM = "intentTag";
-/** Public ID of the locale parameter on Canvas components */
-export declare const CANVAS_LOCALE_TAG_PARAM = "locale";
-/** Name of the slot on CANVAS_PERSONALIZE_TYPE */
-export declare const CANVAS_PERSONALIZE_SLOT = "pz";
-/** Name of the slot on CANVAS_TEST_TYPE */
-export declare const CANVAS_TEST_SLOT = "test";
-/** Name of the slot on CANVAS_TEST_TYPE */
-export declare const CANVAS_LOCALIZATION_SLOT = "localized";
-/** Constant for a draft composition state. Subject to change. */
-export declare const CANVAS_DRAFT_STATE = 0;
-/** Constatnt for a published composition state. Subject to change. */
-export declare const CANVAS_PUBLISHED_STATE = 64;

package/dist/esm/utils/constants.js

@@ -1 +0,0 @@
-var CANVAS_PERSONALIZE_TYPE="$personalization",CANVAS_TEST_TYPE="$test",CANVAS_LOCALIZATION_TYPE="$localization",CANVAS_INTENT_TAG_PARAM="intentTag",CANVAS_LOCALE_TAG_PARAM="locale",CANVAS_PERSONALIZE_SLOT="pz",CANVAS_TEST_SLOT="test",CANVAS_LOCALIZATION_SLOT="localized",CANVAS_DRAFT_STATE=0,CANVAS_PUBLISHED_STATE=64;export{CANVAS_PERSONALIZE_TYPE,CANVAS_TEST_TYPE,CANVAS_LOCALIZATION_TYPE,CANVAS_INTENT_TAG_PARAM,CANVAS_LOCALE_TAG_PARAM,CANVAS_PERSONALIZE_SLOT,CANVAS_TEST_SLOT,CANVAS_LOCALIZATION_SLOT,CANVAS_DRAFT_STATE,CANVAS_PUBLISHED_STATE};

package/dist/esm/utils/isSystemComponentDefinition.d.ts

@@ -1,2 +0,0 @@
-/** Determines if a given Canvas component type is a system-defined type */
-export declare const isSystemComponentDefinition: (componentType: string) => boolean;

package/dist/esm/utils/isSystemComponentDefinition.js

@@ -1 +0,0 @@
-var isSystemComponentDefinition=function(t){return t.startsWith("$")};export{isSystemComponentDefinition};

package/dist/esm/utils/mapSlotToPersonalizedVariations.d.ts

@@ -1,7 +0,0 @@
-import { PersonalizableListItem } from '@uniformdev/optimize-tracker-common';
-import { ComponentInstance } from '../types/componentInstances';
-/**
- * Converts components in a slot into personalized variations (based on each component's intent tag in Canvas) suitable to pass to a personalize component
- * Useful when implementing custom personalization settings for Canvas components.
- */
-export declare function mapSlotToPersonalizedVariations(slot: ComponentInstance[] | undefined): Array<ComponentInstance & PersonalizableListItem>;

package/dist/esm/utils/mapSlotToPersonalizedVariations.js

@@ -1 +0,0 @@
-var __assign=this&&this.__assign||function(){return(__assign=Object.assign||function(n){for(var t,a=1,i=arguments.length;a<i;a++)for(var o in t=arguments[a])Object.prototype.hasOwnProperty.call(t,o)&&(n[o]=t[o]);return n}).apply(this,arguments)};import{CANVAS_INTENT_TAG_PARAM}from"./constants";function mapSlotToPersonalizedVariations(n){return n?n.map(function(n){return __assign(__assign({},n),{intentTag:null===(n=null===(n=n.parameters)||void 0===n?void 0:n[CANVAS_INTENT_TAG_PARAM])||void 0===n?void 0:n.value})}):[]}export{mapSlotToPersonalizedVariations};