@uniformdev/canvas 12.0.1-alpha.94 → 12.2.1-alpha.121

package/dist/index.d.ts

@@ -0,0 +1,365 @@
+import { C as ComponentInstance, a as ComponentParameter, b as CompositionAPIOptions, c as CompositionListAPIResponse, d as CompositionAPIResponse, e as CompositionAPIPutRequest, f as CompositionAPIDeleteRequest, g as ComponentDefinitionListAPIOptions, h as ComponentDefinitionAPIResponse, i as ComponentDefinitionAPIPutRequest, j as ComponentDefinitionAPIDeleteRequest, P as PreviewEventBus } from './createEventBus-ca90547e';
+export { r as ChannelSubscription, o as ComponentDefinition, j as ComponentDefinitionAPIDeleteRequest, i as ComponentDefinitionAPIPutRequest, h as ComponentDefinitionAPIResponse, g as ComponentDefinitionListAPIOptions, k as ComponentDefinitionParameter, n as ComponentDefinitionSlot, m as ComponentDefinitionSlugSettings, l as ComponentDefinitionVariant, C as ComponentInstance, a as ComponentParameter, f as CompositionAPIDeleteRequest, b as CompositionAPIOptions, e as CompositionAPIPutRequest, d as CompositionAPIResponse, q as CompositionFetchState, c as CompositionListAPIResponse, p as CreatingComponentDefinition, P as PreviewEventBus, R as RootComponentInstance, s as createEventBus } from './createEventBus-ca90547e';
+import { Options } from 'p-throttle';
+import { Options as Options$1 } from 'p-retry';
+import { PersonalizedVariant, TestVariant } from '@uniformdev/context';
+import 'pusher-js';
+
+declare type EnhancerContext = {
+    preview?: boolean;
+};
+/** Options passed to a ComponentEnhancer function */
+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
+ */
+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.
+ */
+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 */
+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)
+ */
+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.
+ */
+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>;
+};
+
+declare type ComponentLocationReference = {
+    component: ComponentInstance;
+    parentSlot?: string;
+    parentSlotIndex?: number;
+};
+declare type WalkComponentTreeActions = {
+    replaceComponent: (replacementComponent: ComponentInstance) => void;
+    removeComponent: () => void;
+    insertAfter: (components: ComponentInstance | ComponentInstance[]) => void;
+};
+/** Walks a composition's component tree, visiting each component instance depth-first, in order. */
+declare function walkComponentTree(component: ComponentInstance, visitor: (component: ComponentInstance, ancestorsAndSelf: Array<ComponentLocationReference>, actions: WalkComponentTreeActions) => void): void;
+declare function getComponentPath(ancestorsAndSelf: Array<ComponentLocationReference>): string;
+
+/** A single entry in a batch of queued enhancements. */
+declare class BatchEntry<TArgs, TResult> {
+    private _resolve;
+    private _reject;
+    args: TArgs;
+    private _isCompleted;
+    constructor(_resolve: (result: TResult) => void, _reject: (reason: any) => void, args: TArgs);
+    /** Mark the batch entry as successfully completed. */
+    resolve(result: TResult): void;
+    /** Mark the batch entry as failed. */
+    reject(reason: any): void;
+    /** @return Whether the batch entry has been completed (resolved or rejected). */
+    get isCompleted(): boolean;
+}
+/**
+ * An enhancer that queues up promises for each component that needs enhancing,
+ * and once all enhancements have been queued handles them all in a batch.
+ * Note: this type is adaptable to both ComponentParameterEnhancer and ComponentEnhancer types.
+ */
+declare type BatchEnhancer<TArgs, TResult> = {
+    /** Adds a promise to the enhancement queue. */
+    enhanceOne: (args: TArgs) => Promise<TResult | undefined>;
+    /** Calls the batch enhancer function for all queued promises and resolves them. Returns number of processed items. */
+    completeAll: () => Promise<number>;
+    limitPolicy?: LimitPolicy;
+};
+/**
+ * Creates an enhancer that batches up all enhancements for a composition into a set of promises,
+ * and then handles them all in a single batch. Used to reduce the number of HTTP requests
+ * needed to fulfill layout enhancements when a layout uses many resources from other systems.
+ */
+declare function createBatchEnhancer<TArgs, TResult>({ handleBatch, shouldQueue, limitPolicy, }: {
+    /** Function called to handle one or more batched up enhancements. (note: queue will never be an empty array) */
+    handleBatch: (queue: ReadonlyArray<Readonly<BatchEntry<TArgs, TResult>>>) => Promise<void>;
+    /** Function called to determine if a given enhancement should be queued, i.e. don't queue invalid or null/undefined values. */
+    shouldQueue?: (args: TArgs) => boolean;
+    limitPolicy?: LimitPolicy;
+}): BatchEnhancer<TArgs, TResult>;
+
+/**
+ * Given a batch of enhancements containing potentially duplicate entries (i.e. several components referencing the same thing),
+ * group them together by some unique identifier and enable simpler batch processing.
+ */
+declare class UniqueBatchEntries<TArgs, TResult> {
+    groups: Readonly<Record<string, ReadonlyArray<Readonly<BatchEntry<TArgs, TResult>>>>>;
+    constructor(
+    /** The batch queue being processed. */
+    entries: ReadonlyArray<Readonly<BatchEntry<TArgs, TResult>>>, 
+    /** A function to select the unique identifier for a given batch entry. */
+    uniqueKeySelector: (entry: Readonly<TArgs>) => string);
+    /** Resolves all entries in a group key with the same result value. */
+    resolveKey(key: string, result: TResult): void;
+    /** Resolves all remaining entries that have not been otherwise resolved with a specific value */
+    resolveRemaining(value: TResult): void;
+}
+
+/**
+ * Builds a definition of the enhancers to run on Canvas components to add data from other systems.
+ * Note that only the first matching enhancer will be run.
+ */
+declare class ChildEnhancerBuilder {
+    private _paramMatches;
+    private _dataMatches;
+    /** Targets an enhancer to modify the value of any parameter */
+    parameter(enhancer: ComponentParameterEnhancer<any, any> | ComponentParameterEnhancerFunction<any>): this;
+    /** Targets an enhancer to modify the value of any parameter with a specific name */
+    parameterName(name: string | readonly string[], enhancer: ComponentParameterEnhancer<any, any> | ComponentParameterEnhancerFunction<any>): this;
+    /** Targets an enhancer to modify the value of any parameter with a specific type */
+    parameterType(type: string | readonly string[], enhancer: ComponentParameterEnhancer<any, any> | ComponentParameterEnhancerFunction<any>): this;
+    /**
+     * Targets an enhancer to set a specific object key on the component's `data` property.
+     * Note: an exception will be thrown if the same key is registered more than once.
+     */
+    data(name: string, enhancer: ComponentEnhancer<any> | ComponentEnhancerFunction<any>): this;
+    /**
+     * Resolves the parameter enhancer for a given parameter, if one exists.
+     * The first matching enhancer by registration order is returned, if more than one could match.
+     */
+    resolveParameterEnhancer(parameterName: string, parameter: ComponentParameter): ComponentParameterEnhancer<unknown, unknown, EnhancerContext> | undefined;
+    /**
+     * Resolves component enhancer(s) for a given component.
+     * Returns a Map where the key is the name of the data property and the value is the enhancer.
+     */
+    resolveComponentEnhancers(): Map<string, ComponentEnhancer<unknown, EnhancerContext>>;
+    private _resolveParameterEnhancer;
+}
+/**
+ * Builds a definition of the enhancers to run on Canvas components to add data from other systems.
+ * Note that only the first matching enhancer will be run.
+ */
+declare class EnhancerBuilder {
+    private _componentIndex;
+    private _rootBuilder;
+    /** Targets an enhancer to modify the value of any parameter */
+    parameter(enhancer: ComponentParameterEnhancer<any, any> | ComponentParameterEnhancerFunction): this;
+    /** Targets an enhancer to modify the value of any parameter with a specific name */
+    parameterName(name: string | readonly string[], enhancer: ComponentParameterEnhancer<any, any> | ComponentParameterEnhancerFunction): this;
+    /** Targets an enhancer to modify the value of any parameter with a specific type */
+    parameterType(type: string | readonly string[], enhancer: ComponentParameterEnhancer<any, any> | ComponentParameterEnhancerFunction<any>): this;
+    /**
+     * Targets an enhancer to set a specific object key on the component's `data` property.
+     * Note: an exception will be thrown if the same key is registered more than once.
+     */
+    data(name: string, enhancer: ComponentEnhancer<any> | ComponentEnhancerFunction<any>): this;
+    /**
+     * Targets a subset of enhancers at a specific component type.
+     * Global enhancers will still be run if no matching enhancer is registered for this component's properties.
+     */
+    component(name: string | readonly string[], builder: (builder: ChildEnhancerBuilder) => void): EnhancerBuilder;
+    /**
+     * Resolves the parameter enhancer for a given parameter, if one exists.
+     * The first matching enhancer by registration order is returned, if more than one could match.
+     */
+    resolveParameterEnhancer(component: ComponentInstance, parameterName: string, parameter: ComponentParameter): ComponentParameterEnhancer<unknown, unknown, EnhancerContext> | undefined;
+    /**
+     * Resolves component enhancer(s) for a given component.
+     * Returns a Map where the key is the name of the data property and the value is the enhancer.
+     */
+    resolveComponentEnhancers(component: ComponentInstance): Map<string, ComponentEnhancer<unknown, EnhancerContext>>;
+}
+
+declare type EnhancerError = {
+    message: string;
+    error: Error | string;
+};
+/**
+ * Applies enhancer functions to a component tree.
+ * IMPORTANT: the input composition object is mutated. Plan accordingly.
+ * Want immutability? Grab immer :)
+ */
+declare function enhance<TContext extends EnhancerContext = EnhancerContext>({ composition, enhancers, context, onErrors, }: {
+    composition: ComponentInstance;
+    enhancers: EnhancerBuilder;
+    context: TContext;
+    onErrors?: (errors: EnhancerError[]) => void;
+}): Promise<void>;
+
+/**
+ * Composes several enhancers into a synchronous chain. Can be used to modify the output of an enhancer.
+ * NOTE: only the first enhancer in the chain may use batching (completeAll()).
+ */
+declare const compose: (input: ComponentParameterEnhancer<any, any>, ...composers: ReadonlyArray<ComponentParameterEnhancer<any, any> | ComponentParameterEnhancerFunction<any>>) => ComponentParameterEnhancer<any, any>;
+
+declare type LimitPolicy = <ReturnValue>(func: () => Promise<ReturnValue>) => Promise<ReturnValue>;
+declare function createLimitPolicy({ throttle, retry, }: {
+    throttle?: Options | false;
+    retry?: Options$1 | false;
+}): LimitPolicy;
+declare const nullLimitPolicy: LimitPolicy;
+
+declare type CanvasClientOptions = {
+    /** The Uniform API host to use. Internal use. */
+    apiHost?: string;
+    /** The Uniform API key to use when sending API requests. This or bearer token must be specified. */
+    apiKey?: string | null;
+    /** The Uniform bearer token to use. Internal use. */
+    bearerToken?: string | null;
+    /** The Uniform project ID to connect to */
+    projectId?: string | null;
+    /** Specify a fetch implementation to use when fetching data. Useful if you want to only polyfill selectively. */
+    fetch?: typeof fetch;
+    /**
+     * Specify how to retry and throttle requests.
+     * Default: retry 3x on failures with exponential backoff, up to 10 requests per second.
+     * Use createLimitPolicy() to help creating a policy. */
+    limitPolicy?: LimitPolicy;
+};
+declare class CanvasClientError extends Error {
+    errorMessage: string;
+    fetchMethod: string;
+    fetchUri: string;
+    statusCode?: number | undefined;
+    statusText?: string | undefined;
+    constructor(errorMessage: string, fetchMethod: string, fetchUri: string, statusCode?: number | undefined, statusText?: string | undefined);
+}
+declare class CanvasClient {
+    private options;
+    constructor(options: CanvasClientOptions);
+    /** Fetches lists of Canvas compositions, optionally by type */
+    getCompositionList(options?: Omit<CompositionAPIOptions, 'projectId'>): Promise<CompositionListAPIResponse>;
+    /** Fetches a Canvas composition by string name (slug) */
+    getCompositionBySlug(options: Pick<CompositionAPIOptions, 'slug' | 'state' | 'skipEnhance' | 'skipPatternResolution'>): Promise<CompositionAPIResponse>;
+    /** Fetches a Canvas composition by its public UUID */
+    getCompositionById(options: Pick<CompositionAPIOptions, 'compositionId' | 'state' | 'skipEnhance' | 'skipPatternResolution'>): Promise<CompositionAPIResponse>;
+    /** Updates or creates a Canvas component definition */
+    updateComposition(body: Omit<CompositionAPIPutRequest, 'projectId'>): Promise<void>;
+    /** Deletes a Canvas component definition */
+    removeComposition(body: Omit<CompositionAPIDeleteRequest, 'projectId'>): Promise<void>;
+    /** Fetches all Canvas component definitions */
+    getComponentDefinitions(options?: Omit<ComponentDefinitionListAPIOptions, 'projectId'>): Promise<ComponentDefinitionAPIResponse>;
+    /** Updates or creates a Canvas component definition */
+    updateComponentDefinition(body: Omit<ComponentDefinitionAPIPutRequest, 'projectId'>): Promise<void>;
+    /** Deletes a Canvas component definition */
+    removeComponentDefinition(body: Omit<ComponentDefinitionAPIDeleteRequest, 'projectId'>): Promise<void>;
+    private apiClient;
+    private createUrl;
+}
+
+/** Public ID of Canvas personalization component type */
+declare const CANVAS_PERSONALIZE_TYPE = "$personalization";
+/** Public ID of Canvas A/B test component type */
+declare const CANVAS_TEST_TYPE = "$test";
+/** Public ID of Canvas localization component type */
+declare const CANVAS_LOCALIZATION_TYPE = "$localization";
+/** Public ID of the intent tag parameter on the Canvas personalization component type */
+declare const CANVAS_INTENT_TAG_PARAM = "intentTag";
+/** Public ID of the locale parameter on Canvas components */
+declare const CANVAS_LOCALE_TAG_PARAM = "locale";
+/** Name of the slot on CANVAS_PERSONALIZE_TYPE */
+declare const CANVAS_PERSONALIZE_SLOT = "pz";
+/** Name of the slot on CANVAS_TEST_TYPE */
+declare const CANVAS_TEST_SLOT = "test";
+/** Name of the slot on CANVAS_TEST_TYPE */
+declare const CANVAS_LOCALIZATION_SLOT = "localized";
+/** Constant for a draft composition state. Subject to change. */
+declare const CANVAS_DRAFT_STATE = 0;
+/** Constant for a published composition state. Subject to change. */
+declare const CANVAS_PUBLISHED_STATE = 64;
+/** Public ID of the Uniform Context personalization parameter on Canvas components */
+declare const CANVAS_PERSONALIZATION_PARAM = "$pzCrit";
+/** Public ID of the Uniform Context enrichment tag parameter on Canvas components */
+declare const CANVAS_ENRICHMENT_TAG_PARAM = "$enr";
+
+/** Determines if a given Canvas component type is a system-defined type */
+declare const isSystemComponentDefinition: (componentType: string) => boolean;
+
+/**
+ * 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.
+ */
+declare function mapSlotToPersonalizedVariations(slot: ComponentInstance[] | undefined): Array<ComponentInstance & PersonalizedVariant>;
+
+/**
+ * Converts components in a slot into test variations (based on each component's Context tag in Canvas) suitable to pass to a personalize component
+ * Useful when implementing custom test settings for Canvas components.
+ */
+declare function mapSlotToTestVariations(slot: ComponentInstance[] | undefined): Array<ComponentInstance & TestVariant>;
+
+declare function getChannelName(projectId: string, compositionId: string, state: number): string;
+
+declare type EventNames = 'updated';
+
+declare type SubscribeToCompositionOptions = {
+    projectId: string;
+    compositionId: string;
+    compositionState: number;
+    callback: (data: unknown) => void;
+    eventBus: PreviewEventBus;
+    event: EventNames;
+};
+declare type UnsubscribeCallback = () => void;
+/** Subscribes to a composition event */
+declare function subscribeToComposition({ projectId, compositionId, compositionState, eventBus: { subscribe }, callback, event, }: SubscribeToCompositionOptions): UnsubscribeCallback;
+
+declare function extractLocales({ component }: {
+    component: ComponentInstance;
+}): Record<string, ComponentInstance[]>;
+declare function localize({ composition, locale, }: {
+    composition: ComponentInstance;
+    locale: string | ((options: {
+        component: Readonly<ComponentInstance>;
+        locales: Readonly<Record<string, ComponentInstance[]>>;
+    }) => string | undefined);
+}): void;
+
+export { BatchEnhancer, BatchEntry, CANVAS_DRAFT_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CanvasClient, CanvasClientError, CanvasClientOptions, ChildEnhancerBuilder, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentLocationReference, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, EnhancerBuilder, EnhancerContext, EnhancerError, EventNames, LimitPolicy, SubscribeToCompositionOptions, UniqueBatchEntries, UnsubscribeCallback, compose, createBatchEnhancer, createLimitPolicy, enhance, extractLocales, getChannelName, getComponentPath, isSystemComponentDefinition, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, walkComponentTree };

package/dist/index.esm.js

@@ -0,0 +1,4 @@
+import{a as L,b as d,c as j,d as k,e as F,f as N,g as v,h as f,i as T,j as V,k as U,l as w,m as z,n as W,o as D,p as H}from"./chunk-A4MBTKCQ.mjs";function y(o,e){let t=[{ancestorsAndSelf:[{component:o,parentSlot:void 0,parentSlotIndex:void 0}]}];do{let n=t.pop();if(!n)continue;let r=n.ancestorsAndSelf[0];e(r.component,n.ancestorsAndSelf,{replaceComponent:i=>{Object.assign(r.component,i),["parameters","variant","slots","data","_pattern","_patternError"].forEach(s=>{i[s]||delete r.component[s]})},removeComponent:()=>{let{parentSlot:i,parentSlotIndex:c}=n.ancestorsAndSelf[0],s=n.ancestorsAndSelf[1];if(i&&typeof c!="undefined")s.component.slots[i].splice(c,1);else throw new Error("Unable to delete composition.")},insertAfter:i=>{let c=Array.isArray(i)?i:[i],{parentSlot:s,parentSlotIndex:p}=n.ancestorsAndSelf[0],m=n.ancestorsAndSelf[1];if(s&&typeof p!="undefined")m.component.slots[s].splice(p+1,0,...c);else throw new Error("Unable to insert after a component not in a slot.")}});let a=r.component.slots;if(a){let i=Object.keys(a);for(let c=i.length-1;c>=0;c--){let s=i[c],p=a[s];for(let m=p.length-1;m>=0;m--)t.push({ancestorsAndSelf:[{component:p[m],parentSlot:s,parentSlotIndex:m},...n.ancestorsAndSelf]})}}}while(t.length>0)}function E(o){let e=[];for(let t=o.length-1;t>=0;t--){let{parentSlot:n,parentSlotIndex:r}=o[t];n&&r!==void 0&&e.push(`${n}[${r}]`)}return`.${e.join(".")}`}var I=class{constructor(e,t){this.groups=e.reduce((n,r)=>{var i;let a=t(r.args);return n[a]=(i=n[a])!=null?i:[],n[a].push(r),n},{})}resolveKey(e,t){this.groups[e].forEach(n=>n.resolve(t))}resolveRemaining(e){Object.keys(this.groups).forEach(t=>{this.groups[t].forEach(n=>{n.isCompleted||n.resolve(e)})})}};var P=class{constructor(){this._paramMatches=Array();this._dataMatches=new Map}parameter(e){return this._paramMatches.push({enhancer:this._resolveParameterEnhancer(e)}),this}parameterName(e,t){return(Array.isArray(e)?e:[e]).forEach(r=>this._paramMatches.push({name:r,enhancer:this._resolveParameterEnhancer(t)})),this}parameterType(e,t){return(Array.isArray(e)?e:[e]).forEach(r=>this._paramMatches.push({type:r,enhancer:this._resolveParameterEnhancer(t)})),this}data(e,t){if(this._dataMatches.has(e))throw new Error(`${e} enhancer data key has been used more than once. This will cause data loss.`);return this._dataMatches.set(e,typeof t=="function"?{enhanceOne:t}:t),this}resolveParameterEnhancer(e,t){var n;return(n=this._paramMatches.find(r=>r.name&&r.name===e||r.type&&r.type===t.type||!r.type&&!r.name))==null?void 0:n.enhancer}resolveComponentEnhancers(){return this._dataMatches}_resolveParameterEnhancer(e){return typeof e=="function"?{enhanceOne:e}:e}},R=class{constructor(){this._componentIndex={};this._rootBuilder=new P}parameter(e){return this._rootBuilder.parameter(e),this}parameterName(e,t){return this._rootBuilder.parameterName(e,t),this}parameterType(e,t){return this._rootBuilder.parameterType(e,t),this}data(e,t){return this._rootBuilder.data(e,t),this}component(e,t){return(Array.isArray(e)?e:[e]).forEach(r=>{this._componentIndex[r]=this._componentIndex[r]||new P,t(this._componentIndex[r])}),this}resolveParameterEnhancer(e,t,n){let r=this._componentIndex[e.type];if(r){let a=r.resolveParameterEnhancer(t,n);if(a)return a}return this._rootBuilder.resolveParameterEnhancer(t,n)}resolveComponentEnhancers(e){let t=this._rootBuilder.resolveComponentEnhancers(),n=this._componentIndex[e.type];if(n){t=new Map(t);for(let[r,a]of n.resolveComponentEnhancers())t.set(r,a)}return t}};var _=class{constructor(e,t,n){this._resolve=e;this._reject=t;this.args=n;this._isCompleted=!1}resolve(e){this._resolve(e),this._isCompleted=!0}reject(e){this._reject(e),this._isCompleted=!0}get isCompleted(){return this._isCompleted}};function q({handleBatch:o,shouldQueue:e,limitPolicy:t}){let n=[];return{enhanceOne:async i=>{if(!e||e(i))return new Promise((c,s)=>{n.push(new _(c,s,i))})},completeAll:async()=>{if(n.length>0){try{await o(n)}catch(c){n.forEach(s=>s.reject(c))}if(n.some(c=>!c.isCompleted))throw new Error("The completeAll() function failed to resolve or reject all promises in the batch!")}let i=n.length;return n=[],i},limitPolicy:t}}async function ee({composition:o,enhancers:e,context:t,onErrors:n=r=>{throw new Error(r.map(a=>`${a.message}
+ ${typeof a.error=="object"&&"stack"in a.error?a.error.stack:a.error}`).join(`
+
+`))}}){let r=[],a=new Set,i=new Set;y(o,(s,p)=>{var h;Object.entries((h=s.parameters)!=null?h:{}).forEach(([g,A])=>{let C=e.resolveParameterEnhancer(s,g,A);C&&(i.add(C),r.push(B(s,p,g,A,C,t)))});let m=e.resolveComponentEnhancers(s);r.push(S(s,p,m,t)),a.add(m)}),r.push(...Array.from(a).flatMap(s=>Array.from(s).map(async([,p])=>{var m;try{p.completeAll&&await((m=p.limitPolicy)!=null?m:d)(()=>p.completeAll())}catch(h){return{error:h,message:"Batch component enhancer failed. Individual failed components should receive their own rejections."}}}))),r.push(...Array.from(i).map(async s=>{var p;try{s.completeAll&&await((p=s.limitPolicy)!=null?p:d)(()=>s.completeAll())}catch(m){return{error:m,message:"Batch parameter enhancer failed. Individual failed parameters should receive their own rejections."}}}));let c=(await Promise.all(r)).flatMap(s=>Array.isArray(s)?s:[s]).filter(s=>s);c.length&&n(c)}async function S(o,e,t,n){return t.size&&(o.data={}),await Promise.all(Array.from(t).map(async([r,a])=>{var i;try{let s=await(a.completeAll?d:(i=a.limitPolicy)!=null?i:d)(async()=>a.enhanceOne({component:o,context:n}));s!=null&&(o.data[r]=s)}catch(c){let s=`Component ${E(e)} (type: ${o.type}): data.${r} enhancer threw exception. Data key will not be present.`;return delete o.data[r],{message:s,error:c}}}))}async function B(o,e,t,n,r,a){var i;try{let s=await(r.completeAll?d:(i=r.limitPolicy)!=null?i:d)(async()=>r.enhanceOne({parameter:n,parameterName:t,component:o,context:a}));s===null?delete o.parameters[t]:typeof s=="undefined"?o.parameters[t]={...n,value:n.value}:o.parameters[t]={...n,value:s}}catch(c){let s=`Component ${E(e)} (type: ${o.type}): enhancing parameter ${t} (type: ${n.type}) threw exception. Parameter will be removed.`;return delete o.parameters[t],{message:s,error:c}}}var te=(o,...e)=>({enhanceOne:n=>{let r=o.enhanceOne(n);for(let a of e){let i=O(r)?r:Promise.resolve(r),c="enhanceOne"in a?a.enhanceOne:a;r=i.then(s=>c({...n,parameter:{type:n.parameter.type,value:s}}))}return r},completeAll:()=>{var n,r;for(let a of e)if("completeAll"in a)throw new Error("Only the first enhancer in a compose chain can use the completeAll function (batching)");return(r=(n=o.completeAll)==null?void 0:n.call(o))!=null?r:Promise.resolve(0)}});function O(o){return!!o&&(typeof o=="object"||typeof o=="function")&&typeof o.then=="function"}var oe=o=>o.startsWith("$");function ie(o){return o?o.map((e,t)=>{var a,i,c;let n=(i=(a=e.parameters)==null?void 0:a[f])==null?void 0:i.value,r=(c=n==null?void 0:n.id)!=null?c:"testId"in e?e.testId:`pz-${t}-${e.type}`;return{...e,id:r,pz:n==null?void 0:n.pz}}):[]}function me(o){return o?o.map((e,t)=>{var a,i,c;let n=(i=(a=e.parameters)==null?void 0:a[f])==null?void 0:i.value,r=(c=n==null?void 0:n.id)!=null?c:"testId"in e?e.testId:`ab-${t}-${e.type}`;return{...e,id:r,testDistribution:n==null?void 0:n.testDistribution}}):[]}var x="https://js.pusher.com/7.0.3/pusher.min.js";async function M(){if(!(typeof document=="undefined"||typeof window=="undefined"))return window.Pusher?window.Pusher:new Promise((o,e)=>{let t=setTimeout(()=>{window.Pusher&&o(window.Pusher),e(`Unable to load pusher.js; Uniform Canvas live preview disabled. Consider adding <script src="${x}"><\/script> manually.`)},5e3),n=document.createElement("script");n.src=x,n.addEventListener("load",()=>{clearTimeout(t),o(window.Pusher)}),document.head.appendChild(n)})}async function ue(){let o=await M();if(!o)return;let e=window.__UNIFORM_EVENT_BUS__;if(!e){let t=new o("7b5f5abd160fea549ffe",{cluster:"mt1"});t.connect(),console.log("[canvas] \u{1F525} preview connected"),e=window.__UNIFORM_EVENT_BUS__={subscribe:n=>{let r=t.subscribe(n);return{unsubscribe:()=>t.unsubscribe(n),addEventHandler:(a,i)=>(r.bind(a,i),()=>r.unbind(a,i))}}}}return e}function b(o,e,t){return`${o}.${e}@${t}`}function ye({projectId:o,compositionId:e,compositionState:t=0,eventBus:{subscribe:n},callback:r,event:a="updated"}){let i=b(o,e,t),c=n(i),s=c.addEventHandler(a,r);return()=>{s(),c.unsubscribe()}}function $({component:o}){var n;let e={},t=(n=o.slots)==null?void 0:n[w];return t==null||t.forEach(r=>{var i;let a=(i=r.parameters)==null?void 0:i[T];(a==null?void 0:a.value)&&typeof a.value=="string"&&(e[a.value]=e[a.value]||[],e[a.value].push(r))}),e}function ge({composition:o,locale:e}){y(o,(t,n,r)=>{if(t.type===v){let a=$({component:t}),i=typeof e=="string"?e:e({component:t,locales:a}),c;if(i&&(c=a[i]),c==null?void 0:c.length){let[s,...p]=c;r.replaceComponent(s),p.length&&r.insertAfter(p)}else r.removeComponent()}})}export{_ as BatchEntry,z as CANVAS_DRAFT_STATE,H as CANVAS_ENRICHMENT_TAG_PARAM,f as CANVAS_INTENT_TAG_PARAM,T as CANVAS_LOCALE_TAG_PARAM,w as CANVAS_LOCALIZATION_SLOT,v as CANVAS_LOCALIZATION_TYPE,D as CANVAS_PERSONALIZATION_PARAM,V as CANVAS_PERSONALIZE_SLOT,F as CANVAS_PERSONALIZE_TYPE,W as CANVAS_PUBLISHED_STATE,U as CANVAS_TEST_SLOT,N as CANVAS_TEST_TYPE,k as CanvasClient,j as CanvasClientError,P as ChildEnhancerBuilder,R as EnhancerBuilder,I as UniqueBatchEntries,te as compose,q as createBatchEnhancer,ue as createEventBus,L as createLimitPolicy,ee as enhance,$ as extractLocales,b as getChannelName,E as getComponentPath,oe as isSystemComponentDefinition,ge as localize,ie as mapSlotToPersonalizedVariations,me as mapSlotToTestVariations,d as nullLimitPolicy,ye as subscribeToComposition,y as walkComponentTree};

package/dist/index.js

@@ -0,0 +1,5 @@
+var V=Object.create;var C=Object.defineProperty;var M=Object.getOwnPropertyDescriptor;var F=Object.getOwnPropertyNames;var D=Object.getPrototypeOf,z=Object.prototype.hasOwnProperty;var b=r=>C(r,"__esModule",{value:!0});var H=(r,e)=>{for(var n in e)C(r,n,{get:e[n],enumerable:!0})},S=(r,e,n,t)=>{if(e&&typeof e=="object"||typeof e=="function")for(let o of F(e))!z.call(r,o)&&(n||o!=="default")&&C(r,o,{get:()=>e[o],enumerable:!(t=M(e,o))||t.enumerable});return r},O=(r,e)=>S(b(C(r!=null?V(D(r)):{},"default",!e&&r&&r.__esModule?{get:()=>r.default,enumerable:!0}:{value:r,enumerable:!0})),r),K=(r=>(e,n)=>r&&r.get(e)||(n=S(b({}),e,1),r&&r.set(e,n),n))(typeof WeakMap!="undefined"?new WeakMap:0);var he={};H(he,{BatchEntry:()=>g,CANVAS_DRAFT_STATE:()=>te,CANVAS_ENRICHMENT_TAG_PARAM:()=>ie,CANVAS_INTENT_TAG_PARAM:()=>y,CANVAS_LOCALE_TAG_PARAM:()=>v,CANVAS_LOCALIZATION_SLOT:()=>w,CANVAS_LOCALIZATION_TYPE:()=>T,CANVAS_PERSONALIZATION_PARAM:()=>re,CANVAS_PERSONALIZE_SLOT:()=>ee,CANVAS_PERSONALIZE_TYPE:()=>Q,CANVAS_PUBLISHED_STATE:()=>oe,CANVAS_TEST_SLOT:()=>ne,CANVAS_TEST_TYPE:()=>X,CanvasClient:()=>U,CanvasClientError:()=>f,ChildEnhancerBuilder:()=>P,EnhancerBuilder:()=>N,UniqueBatchEntries:()=>L,compose:()=>J,createBatchEnhancer:()=>q,createEventBus:()=>me,createLimitPolicy:()=>I,enhance:()=>G,extractLocales:()=>k,getChannelName:()=>_,getComponentPath:()=>A,isSystemComponentDefinition:()=>se,localize:()=>ue,mapSlotToPersonalizedVariations:()=>ae,mapSlotToTestVariations:()=>ce,nullLimitPolicy:()=>u,subscribeToComposition:()=>le,walkComponentTree:()=>d});function d(r,e){let n=[{ancestorsAndSelf:[{component:r,parentSlot:void 0,parentSlotIndex:void 0}]}];do{let t=n.pop();if(!t)continue;let o=t.ancestorsAndSelf[0];e(o.component,t.ancestorsAndSelf,{replaceComponent:s=>{Object.assign(o.component,s),["parameters","variant","slots","data","_pattern","_patternError"].forEach(a=>{s[a]||delete o.component[a]})},removeComponent:()=>{let{parentSlot:s,parentSlotIndex:c}=t.ancestorsAndSelf[0],a=t.ancestorsAndSelf[1];if(s&&typeof c!="undefined")a.component.slots[s].splice(c,1);else throw new Error("Unable to delete composition.")},insertAfter:s=>{let c=Array.isArray(s)?s:[s],{parentSlot:a,parentSlotIndex:p}=t.ancestorsAndSelf[0],l=t.ancestorsAndSelf[1];if(a&&typeof p!="undefined")l.component.slots[a].splice(p+1,0,...c);else throw new Error("Unable to insert after a component not in a slot.")}});let i=o.component.slots;if(i){let s=Object.keys(i);for(let c=s.length-1;c>=0;c--){let a=s[c],p=i[a];for(let l=p.length-1;l>=0;l--)n.push({ancestorsAndSelf:[{component:p[l],parentSlot:a,parentSlotIndex:l},...t.ancestorsAndSelf]})}}}while(n.length>0)}function A(r){let e=[];for(let n=r.length-1;n>=0;n--){let{parentSlot:t,parentSlotIndex:o}=r[n];t&&o!==void 0&&e.push(`${t}[${o}]`)}return`.${e.join(".")}`}var L=class{constructor(e,n){this.groups=e.reduce((t,o)=>{var s;let i=n(o.args);return t[i]=(s=t[i])!=null?s:[],t[i].push(o),t},{})}resolveKey(e,n){this.groups[e].forEach(t=>t.resolve(n))}resolveRemaining(e){Object.keys(this.groups).forEach(n=>{this.groups[n].forEach(t=>{t.isCompleted||t.resolve(e)})})}};var P=class{constructor(){this._paramMatches=Array();this._dataMatches=new Map}parameter(e){return this._paramMatches.push({enhancer:this._resolveParameterEnhancer(e)}),this}parameterName(e,n){return(Array.isArray(e)?e:[e]).forEach(o=>this._paramMatches.push({name:o,enhancer:this._resolveParameterEnhancer(n)})),this}parameterType(e,n){return(Array.isArray(e)?e:[e]).forEach(o=>this._paramMatches.push({type:o,enhancer:this._resolveParameterEnhancer(n)})),this}data(e,n){if(this._dataMatches.has(e))throw new Error(`${e} enhancer data key has been used more than once. This will cause data loss.`);return this._dataMatches.set(e,typeof n=="function"?{enhanceOne:n}:n),this}resolveParameterEnhancer(e,n){var t;return(t=this._paramMatches.find(o=>o.name&&o.name===e||o.type&&o.type===n.type||!o.type&&!o.name))==null?void 0:t.enhancer}resolveComponentEnhancers(){return this._dataMatches}_resolveParameterEnhancer(e){return typeof e=="function"?{enhanceOne:e}:e}},N=class{constructor(){this._componentIndex={};this._rootBuilder=new P}parameter(e){return this._rootBuilder.parameter(e),this}parameterName(e,n){return this._rootBuilder.parameterName(e,n),this}parameterType(e,n){return this._rootBuilder.parameterType(e,n),this}data(e,n){return this._rootBuilder.data(e,n),this}component(e,n){return(Array.isArray(e)?e:[e]).forEach(o=>{this._componentIndex[o]=this._componentIndex[o]||new P,n(this._componentIndex[o])}),this}resolveParameterEnhancer(e,n,t){let o=this._componentIndex[e.type];if(o){let i=o.resolveParameterEnhancer(n,t);if(i)return i}return this._rootBuilder.resolveParameterEnhancer(n,t)}resolveComponentEnhancers(e){let n=this._rootBuilder.resolveComponentEnhancers(),t=this._componentIndex[e.type];if(t){n=new Map(n);for(let[o,i]of t.resolveComponentEnhancers())n.set(o,i)}return n}};var g=class{constructor(e,n,t){this._resolve=e;this._reject=n;this.args=t;this._isCompleted=!1}resolve(e){this._resolve(e),this._isCompleted=!0}reject(e){this._reject(e),this._isCompleted=!0}get isCompleted(){return this._isCompleted}};function q({handleBatch:r,shouldQueue:e,limitPolicy:n}){let t=[];return{enhanceOne:async s=>{if(!e||e(s))return new Promise((c,a)=>{t.push(new g(c,a,s))})},completeAll:async()=>{if(t.length>0){try{await r(t)}catch(c){t.forEach(a=>a.reject(c))}if(t.some(c=>!c.isCompleted))throw new Error("The completeAll() function failed to resolve or reject all promises in the batch!")}let s=t.length;return t=[],s},limitPolicy:n}}var j=O(require("p-throttle")),B=O(require("p-retry"));function I({throttle:r={interval:1e3,limit:10},retry:e={retries:1,factor:1.66}}){let n=r?(0,j.default)(r):null;return function(o){let i=async()=>await o();if(n&&(i=n(i)),e){let s=i;i=()=>(0,B.default)(s,e)}return i()}}var u=async r=>await r();async function G({composition:r,enhancers:e,context:n,onErrors:t=o=>{throw new Error(o.map(i=>`${i.message}
+ ${typeof i.error=="object"&&"stack"in i.error?i.error.stack:i.error}`).join(`
+
+`))}}){let o=[],i=new Set,s=new Set;d(r,(a,p)=>{var h;Object.entries((h=a.parameters)!=null?h:{}).forEach(([x,R])=>{let E=e.resolveParameterEnhancer(a,x,R);E&&(s.add(E),o.push(Y(a,p,x,R,E,n)))});let l=e.resolveComponentEnhancers(a);o.push(Z(a,p,l,n)),i.add(l)}),o.push(...Array.from(i).flatMap(a=>Array.from(a).map(async([,p])=>{var l;try{p.completeAll&&await((l=p.limitPolicy)!=null?l:u)(()=>p.completeAll())}catch(h){return{error:h,message:"Batch component enhancer failed. Individual failed components should receive their own rejections."}}}))),o.push(...Array.from(s).map(async a=>{var p;try{a.completeAll&&await((p=a.limitPolicy)!=null?p:u)(()=>a.completeAll())}catch(l){return{error:l,message:"Batch parameter enhancer failed. Individual failed parameters should receive their own rejections."}}}));let c=(await Promise.all(o)).flatMap(a=>Array.isArray(a)?a:[a]).filter(a=>a);c.length&&t(c)}async function Z(r,e,n,t){return n.size&&(r.data={}),await Promise.all(Array.from(n).map(async([o,i])=>{var s;try{let a=await(i.completeAll?u:(s=i.limitPolicy)!=null?s:u)(async()=>i.enhanceOne({component:r,context:t}));a!=null&&(r.data[o]=a)}catch(c){let a=`Component ${A(e)} (type: ${r.type}): data.${o} enhancer threw exception. Data key will not be present.`;return delete r.data[o],{message:a,error:c}}}))}async function Y(r,e,n,t,o,i){var s;try{let a=await(o.completeAll?u:(s=o.limitPolicy)!=null?s:u)(async()=>o.enhanceOne({parameter:t,parameterName:n,component:r,context:i}));a===null?delete r.parameters[n]:typeof a=="undefined"?r.parameters[n]={...t,value:t.value}:r.parameters[n]={...t,value:a}}catch(c){let a=`Component ${A(e)} (type: ${r.type}): enhancing parameter ${n} (type: ${t.type}) threw exception. Parameter will be removed.`;return delete r.parameters[n],{message:a,error:c}}}var J=(r,...e)=>({enhanceOne:t=>{let o=r.enhanceOne(t);for(let i of e){let s=W(o)?o:Promise.resolve(o),c="enhanceOne"in i?i.enhanceOne:i;o=s.then(a=>c({...t,parameter:{type:t.parameter.type,value:a}}))}return o},completeAll:()=>{var t,o;for(let i of e)if("completeAll"in i)throw new Error("Only the first enhancer in a compose chain can use the completeAll function (batching)");return(o=(t=r.completeAll)==null?void 0:t.call(r))!=null?o:Promise.resolve(0)}});function W(r){return!!r&&(typeof r=="object"||typeof r=="function")&&typeof r.then=="function"}var f=class extends Error{constructor(e,n,t,o,i){super(`${e}
+ ${o}${i?" "+i:""} (${n} ${t})`);this.errorMessage=e;this.fetchMethod=n;this.fetchUri=t;this.statusCode=o;this.statusText=i;Object.setPrototypeOf(this,f.prototype)}},U=class{constructor(e){var t,o,i,s,c;if(!e.apiKey&&!e.bearerToken)throw new Error("You must provide an API key or a bearer token");let n=e.fetch;if(!n)if(typeof window!="undefined")n=window.fetch.bind(window);else if(typeof fetch!="undefined")n=fetch;else throw new Error("You must provide or polyfill a fetch implementation when not in a browser");this.options={...e,fetch:n,apiHost:(t=e.apiHost)!=null?t:"https://uniform.app",apiKey:(o=e.apiKey)!=null?o:null,projectId:(i=e.projectId)!=null?i:null,bearerToken:(s=e.bearerToken)!=null?s:null,limitPolicy:(c=e.limitPolicy)!=null?c:I({})}}async getCompositionList(e){let{projectId:n}=this.options,t=this.createUrl("/api/v1/canvas",{...e,projectId:n});return await this.apiClient(t)}async getCompositionBySlug(e){let{projectId:n}=this.options,t=this.createUrl("/api/v1/canvas",{...e,projectId:n});return await this.apiClient(t)}async getCompositionById(e){let{projectId:n}=this.options,t=this.createUrl("/api/v1/canvas",{...e,projectId:n});return await this.apiClient(t)}async updateComposition(e){let n=this.createUrl("/api/v1/canvas");await this.apiClient(n,{method:"PUT",body:JSON.stringify({...e,projectId:this.options.projectId}),expectNoContent:!0})}async removeComposition(e){let n=this.createUrl("/api/v1/canvas");await this.apiClient(n,{method:"DELETE",body:JSON.stringify({...e,projectId:this.options.projectId}),expectNoContent:!0})}async getComponentDefinitions(e){let{projectId:n}=this.options,t=this.createUrl("/api/v1/canvas-definitions",{...e,projectId:n});return await this.apiClient(t)}async updateComponentDefinition(e){let n=this.createUrl("/api/v1/canvas-definitions");await this.apiClient(n,{method:"PUT",body:JSON.stringify({...e,projectId:this.options.projectId}),expectNoContent:!0})}async removeComponentDefinition(e){let n=this.createUrl("/api/v1/canvas-definitions");await this.apiClient(n,{method:"DELETE",body:JSON.stringify({...e,projectId:this.options.projectId}),expectNoContent:!0})}async apiClient(e,n){return this.options.limitPolicy(async()=>{var i;let t=this.options.apiKey?{"x-api-key":this.options.apiKey}:{Authorization:`Bearer ${this.options.bearerToken}`},o=await this.options.fetch(e.toString(),{...n,headers:{...n==null?void 0:n.headers,...t}});if(!o.ok){let s="";try{let c=await o.text();try{let a=JSON.parse(c);a.errorMessage?s=Array.isArray(a.errorMessage)?a.errorMessage.join(", "):a.errorMessage:s=c}catch(a){s=c}}catch(c){s="General error"}throw new f(s,(i=n==null?void 0:n.method)!=null?i:"GET",e.toString(),o.status)}return(n==null?void 0:n.expectNoContent)?null:await o.json()})}createUrl(e,n){let t=new URL(`${this.options.apiHost}${e}`);return Object.entries(n!=null?n:{}).forEach(([o,i])=>{var s;typeof i!==void 0&&i!==null&&t.searchParams.append(o,(s=i==null?void 0:i.toString())!=null?s:"")}),t}};var Q="$personalization",X="$test",T="$localization",y="intentTag",v="locale",ee="pz",ne="test",w="localized",te=0,oe=64,re="$pzCrit",ie="$enr";var se=r=>r.startsWith("$");function ae(r){return r?r.map((e,n)=>{var i,s,c;let t=(s=(i=e.parameters)==null?void 0:i[y])==null?void 0:s.value,o=(c=t==null?void 0:t.id)!=null?c:"testId"in e?e.testId:`pz-${n}-${e.type}`;return{...e,id:o,pz:t==null?void 0:t.pz}}):[]}function ce(r){return r?r.map((e,n)=>{var i,s,c;let t=(s=(i=e.parameters)==null?void 0:i[y])==null?void 0:s.value,o=(c=t==null?void 0:t.id)!=null?c:"testId"in e?e.testId:`ab-${n}-${e.type}`;return{...e,id:o,testDistribution:t==null?void 0:t.testDistribution}}):[]}var $="https://js.pusher.com/7.0.3/pusher.min.js";async function pe(){if(!(typeof document=="undefined"||typeof window=="undefined"))return window.Pusher?window.Pusher:new Promise((r,e)=>{let n=setTimeout(()=>{window.Pusher&&r(window.Pusher),e(`Unable to load pusher.js; Uniform Canvas live preview disabled. Consider adding <script src="${$}"><\/script> manually.`)},5e3),t=document.createElement("script");t.src=$,t.addEventListener("load",()=>{clearTimeout(n),r(window.Pusher)}),document.head.appendChild(t)})}async function me(){let r=await pe();if(!r)return;let e=window.__UNIFORM_EVENT_BUS__;if(!e){let n=new r("7b5f5abd160fea549ffe",{cluster:"mt1"});n.connect(),console.log("[canvas] \u{1F525} preview connected"),e=window.__UNIFORM_EVENT_BUS__={subscribe:t=>{let o=n.subscribe(t);return{unsubscribe:()=>n.unsubscribe(t),addEventHandler:(i,s)=>(o.bind(i,s),()=>o.unbind(i,s))}}}}return e}function _(r,e,n){return`${r}.${e}@${n}`}function le({projectId:r,compositionId:e,compositionState:n=0,eventBus:{subscribe:t},callback:o,event:i="updated"}){let s=_(r,e,n),c=t(s),a=c.addEventHandler(i,o);return()=>{a(),c.unsubscribe()}}function k({component:r}){var t;let e={},n=(t=r.slots)==null?void 0:t[w];return n==null||n.forEach(o=>{var s;let i=(s=o.parameters)==null?void 0:s[v];(i==null?void 0:i.value)&&typeof i.value=="string"&&(e[i.value]=e[i.value]||[],e[i.value].push(o))}),e}function ue({composition:r,locale:e}){d(r,(n,t,o)=>{if(n.type===T){let i=k({component:n}),s=typeof e=="string"?e:e({component:n,locales:i}),c;if(s&&(c=i[s]),c==null?void 0:c.length){let[a,...p]=c;o.replaceComponent(a),p.length&&o.insertAfter(p)}else o.removeComponent()}})}module.exports=K(he);0&&(module.exports={BatchEntry,CANVAS_DRAFT_STATE,CANVAS_ENRICHMENT_TAG_PARAM,CANVAS_INTENT_TAG_PARAM,CANVAS_LOCALE_TAG_PARAM,CANVAS_LOCALIZATION_SLOT,CANVAS_LOCALIZATION_TYPE,CANVAS_PERSONALIZATION_PARAM,CANVAS_PERSONALIZE_SLOT,CANVAS_PERSONALIZE_TYPE,CANVAS_PUBLISHED_STATE,CANVAS_TEST_SLOT,CANVAS_TEST_TYPE,CanvasClient,CanvasClientError,ChildEnhancerBuilder,EnhancerBuilder,UniqueBatchEntries,compose,createBatchEnhancer,createEventBus,createLimitPolicy,enhance,extractLocales,getChannelName,getComponentPath,isSystemComponentDefinition,localize,mapSlotToPersonalizedVariations,mapSlotToTestVariations,nullLimitPolicy,subscribeToComposition,walkComponentTree});

package/dist/index.mjs

@@ -0,0 +1,4 @@
+import{a as L,b as d,c as j,d as k,e as F,f as N,g as v,h as f,i as T,j as V,k as U,l as w,m as z,n as W,o as D,p as H}from"./chunk-A4MBTKCQ.mjs";function y(o,e){let t=[{ancestorsAndSelf:[{component:o,parentSlot:void 0,parentSlotIndex:void 0}]}];do{let n=t.pop();if(!n)continue;let r=n.ancestorsAndSelf[0];e(r.component,n.ancestorsAndSelf,{replaceComponent:i=>{Object.assign(r.component,i),["parameters","variant","slots","data","_pattern","_patternError"].forEach(s=>{i[s]||delete r.component[s]})},removeComponent:()=>{let{parentSlot:i,parentSlotIndex:c}=n.ancestorsAndSelf[0],s=n.ancestorsAndSelf[1];if(i&&typeof c!="undefined")s.component.slots[i].splice(c,1);else throw new Error("Unable to delete composition.")},insertAfter:i=>{let c=Array.isArray(i)?i:[i],{parentSlot:s,parentSlotIndex:p}=n.ancestorsAndSelf[0],m=n.ancestorsAndSelf[1];if(s&&typeof p!="undefined")m.component.slots[s].splice(p+1,0,...c);else throw new Error("Unable to insert after a component not in a slot.")}});let a=r.component.slots;if(a){let i=Object.keys(a);for(let c=i.length-1;c>=0;c--){let s=i[c],p=a[s];for(let m=p.length-1;m>=0;m--)t.push({ancestorsAndSelf:[{component:p[m],parentSlot:s,parentSlotIndex:m},...n.ancestorsAndSelf]})}}}while(t.length>0)}function E(o){let e=[];for(let t=o.length-1;t>=0;t--){let{parentSlot:n,parentSlotIndex:r}=o[t];n&&r!==void 0&&e.push(`${n}[${r}]`)}return`.${e.join(".")}`}var I=class{constructor(e,t){this.groups=e.reduce((n,r)=>{var i;let a=t(r.args);return n[a]=(i=n[a])!=null?i:[],n[a].push(r),n},{})}resolveKey(e,t){this.groups[e].forEach(n=>n.resolve(t))}resolveRemaining(e){Object.keys(this.groups).forEach(t=>{this.groups[t].forEach(n=>{n.isCompleted||n.resolve(e)})})}};var P=class{constructor(){this._paramMatches=Array();this._dataMatches=new Map}parameter(e){return this._paramMatches.push({enhancer:this._resolveParameterEnhancer(e)}),this}parameterName(e,t){return(Array.isArray(e)?e:[e]).forEach(r=>this._paramMatches.push({name:r,enhancer:this._resolveParameterEnhancer(t)})),this}parameterType(e,t){return(Array.isArray(e)?e:[e]).forEach(r=>this._paramMatches.push({type:r,enhancer:this._resolveParameterEnhancer(t)})),this}data(e,t){if(this._dataMatches.has(e))throw new Error(`${e} enhancer data key has been used more than once. This will cause data loss.`);return this._dataMatches.set(e,typeof t=="function"?{enhanceOne:t}:t),this}resolveParameterEnhancer(e,t){var n;return(n=this._paramMatches.find(r=>r.name&&r.name===e||r.type&&r.type===t.type||!r.type&&!r.name))==null?void 0:n.enhancer}resolveComponentEnhancers(){return this._dataMatches}_resolveParameterEnhancer(e){return typeof e=="function"?{enhanceOne:e}:e}},R=class{constructor(){this._componentIndex={};this._rootBuilder=new P}parameter(e){return this._rootBuilder.parameter(e),this}parameterName(e,t){return this._rootBuilder.parameterName(e,t),this}parameterType(e,t){return this._rootBuilder.parameterType(e,t),this}data(e,t){return this._rootBuilder.data(e,t),this}component(e,t){return(Array.isArray(e)?e:[e]).forEach(r=>{this._componentIndex[r]=this._componentIndex[r]||new P,t(this._componentIndex[r])}),this}resolveParameterEnhancer(e,t,n){let r=this._componentIndex[e.type];if(r){let a=r.resolveParameterEnhancer(t,n);if(a)return a}return this._rootBuilder.resolveParameterEnhancer(t,n)}resolveComponentEnhancers(e){let t=this._rootBuilder.resolveComponentEnhancers(),n=this._componentIndex[e.type];if(n){t=new Map(t);for(let[r,a]of n.resolveComponentEnhancers())t.set(r,a)}return t}};var _=class{constructor(e,t,n){this._resolve=e;this._reject=t;this.args=n;this._isCompleted=!1}resolve(e){this._resolve(e),this._isCompleted=!0}reject(e){this._reject(e),this._isCompleted=!0}get isCompleted(){return this._isCompleted}};function q({handleBatch:o,shouldQueue:e,limitPolicy:t}){let n=[];return{enhanceOne:async i=>{if(!e||e(i))return new Promise((c,s)=>{n.push(new _(c,s,i))})},completeAll:async()=>{if(n.length>0){try{await o(n)}catch(c){n.forEach(s=>s.reject(c))}if(n.some(c=>!c.isCompleted))throw new Error("The completeAll() function failed to resolve or reject all promises in the batch!")}let i=n.length;return n=[],i},limitPolicy:t}}async function ee({composition:o,enhancers:e,context:t,onErrors:n=r=>{throw new Error(r.map(a=>`${a.message}
+ ${typeof a.error=="object"&&"stack"in a.error?a.error.stack:a.error}`).join(`
+
+`))}}){let r=[],a=new Set,i=new Set;y(o,(s,p)=>{var h;Object.entries((h=s.parameters)!=null?h:{}).forEach(([g,A])=>{let C=e.resolveParameterEnhancer(s,g,A);C&&(i.add(C),r.push(B(s,p,g,A,C,t)))});let m=e.resolveComponentEnhancers(s);r.push(S(s,p,m,t)),a.add(m)}),r.push(...Array.from(a).flatMap(s=>Array.from(s).map(async([,p])=>{var m;try{p.completeAll&&await((m=p.limitPolicy)!=null?m:d)(()=>p.completeAll())}catch(h){return{error:h,message:"Batch component enhancer failed. Individual failed components should receive their own rejections."}}}))),r.push(...Array.from(i).map(async s=>{var p;try{s.completeAll&&await((p=s.limitPolicy)!=null?p:d)(()=>s.completeAll())}catch(m){return{error:m,message:"Batch parameter enhancer failed. Individual failed parameters should receive their own rejections."}}}));let c=(await Promise.all(r)).flatMap(s=>Array.isArray(s)?s:[s]).filter(s=>s);c.length&&n(c)}async function S(o,e,t,n){return t.size&&(o.data={}),await Promise.all(Array.from(t).map(async([r,a])=>{var i;try{let s=await(a.completeAll?d:(i=a.limitPolicy)!=null?i:d)(async()=>a.enhanceOne({component:o,context:n}));s!=null&&(o.data[r]=s)}catch(c){let s=`Component ${E(e)} (type: ${o.type}): data.${r} enhancer threw exception. Data key will not be present.`;return delete o.data[r],{message:s,error:c}}}))}async function B(o,e,t,n,r,a){var i;try{let s=await(r.completeAll?d:(i=r.limitPolicy)!=null?i:d)(async()=>r.enhanceOne({parameter:n,parameterName:t,component:o,context:a}));s===null?delete o.parameters[t]:typeof s=="undefined"?o.parameters[t]={...n,value:n.value}:o.parameters[t]={...n,value:s}}catch(c){let s=`Component ${E(e)} (type: ${o.type}): enhancing parameter ${t} (type: ${n.type}) threw exception. Parameter will be removed.`;return delete o.parameters[t],{message:s,error:c}}}var te=(o,...e)=>({enhanceOne:n=>{let r=o.enhanceOne(n);for(let a of e){let i=O(r)?r:Promise.resolve(r),c="enhanceOne"in a?a.enhanceOne:a;r=i.then(s=>c({...n,parameter:{type:n.parameter.type,value:s}}))}return r},completeAll:()=>{var n,r;for(let a of e)if("completeAll"in a)throw new Error("Only the first enhancer in a compose chain can use the completeAll function (batching)");return(r=(n=o.completeAll)==null?void 0:n.call(o))!=null?r:Promise.resolve(0)}});function O(o){return!!o&&(typeof o=="object"||typeof o=="function")&&typeof o.then=="function"}var oe=o=>o.startsWith("$");function ie(o){return o?o.map((e,t)=>{var a,i,c;let n=(i=(a=e.parameters)==null?void 0:a[f])==null?void 0:i.value,r=(c=n==null?void 0:n.id)!=null?c:"testId"in e?e.testId:`pz-${t}-${e.type}`;return{...e,id:r,pz:n==null?void 0:n.pz}}):[]}function me(o){return o?o.map((e,t)=>{var a,i,c;let n=(i=(a=e.parameters)==null?void 0:a[f])==null?void 0:i.value,r=(c=n==null?void 0:n.id)!=null?c:"testId"in e?e.testId:`ab-${t}-${e.type}`;return{...e,id:r,testDistribution:n==null?void 0:n.testDistribution}}):[]}var x="https://js.pusher.com/7.0.3/pusher.min.js";async function M(){if(!(typeof document=="undefined"||typeof window=="undefined"))return window.Pusher?window.Pusher:new Promise((o,e)=>{let t=setTimeout(()=>{window.Pusher&&o(window.Pusher),e(`Unable to load pusher.js; Uniform Canvas live preview disabled. Consider adding <script src="${x}"><\/script> manually.`)},5e3),n=document.createElement("script");n.src=x,n.addEventListener("load",()=>{clearTimeout(t),o(window.Pusher)}),document.head.appendChild(n)})}async function ue(){let o=await M();if(!o)return;let e=window.__UNIFORM_EVENT_BUS__;if(!e){let t=new o("7b5f5abd160fea549ffe",{cluster:"mt1"});t.connect(),console.log("[canvas] \u{1F525} preview connected"),e=window.__UNIFORM_EVENT_BUS__={subscribe:n=>{let r=t.subscribe(n);return{unsubscribe:()=>t.unsubscribe(n),addEventHandler:(a,i)=>(r.bind(a,i),()=>r.unbind(a,i))}}}}return e}function b(o,e,t){return`${o}.${e}@${t}`}function ye({projectId:o,compositionId:e,compositionState:t=0,eventBus:{subscribe:n},callback:r,event:a="updated"}){let i=b(o,e,t),c=n(i),s=c.addEventHandler(a,r);return()=>{s(),c.unsubscribe()}}function $({component:o}){var n;let e={},t=(n=o.slots)==null?void 0:n[w];return t==null||t.forEach(r=>{var i;let a=(i=r.parameters)==null?void 0:i[T];(a==null?void 0:a.value)&&typeof a.value=="string"&&(e[a.value]=e[a.value]||[],e[a.value].push(r))}),e}function ge({composition:o,locale:e}){y(o,(t,n,r)=>{if(t.type===v){let a=$({component:t}),i=typeof e=="string"?e:e({component:t,locales:a}),c;if(i&&(c=a[i]),c==null?void 0:c.length){let[s,...p]=c;r.replaceComponent(s),p.length&&r.insertAfter(p)}else r.removeComponent()}})}export{_ as BatchEntry,z as CANVAS_DRAFT_STATE,H as CANVAS_ENRICHMENT_TAG_PARAM,f as CANVAS_INTENT_TAG_PARAM,T as CANVAS_LOCALE_TAG_PARAM,w as CANVAS_LOCALIZATION_SLOT,v as CANVAS_LOCALIZATION_TYPE,D as CANVAS_PERSONALIZATION_PARAM,V as CANVAS_PERSONALIZE_SLOT,F as CANVAS_PERSONALIZE_TYPE,W as CANVAS_PUBLISHED_STATE,U as CANVAS_TEST_SLOT,N as CANVAS_TEST_TYPE,k as CanvasClient,j as CanvasClientError,P as ChildEnhancerBuilder,R as EnhancerBuilder,I as UniqueBatchEntries,te as compose,q as createBatchEnhancer,ue as createEventBus,L as createLimitPolicy,ee as enhance,$ as extractLocales,b as getChannelName,E as getComponentPath,oe as isSystemComponentDefinition,ge as localize,ie as mapSlotToPersonalizedVariations,me as mapSlotToTestVariations,d as nullLimitPolicy,ye as subscribeToComposition,y as walkComponentTree};

package/package.json

@@ -1,68 +1,69 @@
 {
   "name": "@uniformdev/canvas",
-  "version": "12.0.1-alpha.94+0290763c",
+  "version": "12.2.1-alpha.121+3d33c2be",
   "description": "Common functionality and types for Uniform Canvas",
   "license": "SEE LICENSE IN LICENSE.txt",
-  "main": "./dist/cjs/index.js",
-  "module": "./dist/esm/index.js",
+  "main": "./dist/index.js",
+  "module": "./dist/index.esm.js",
   "exports": {
     ".": {
-      "import": "./dist/esm/index.js",
-      "require": "./dist/cjs/index.js"
+      "import": {
+        "node": "./dist/index.mjs",
+        "default": "./dist/index.esm.js"
+      },
+      "require": "./dist/index.js"
     },
     "./cli": {
-      "import": "./dist/esm/cli/cli.js",
-      "require": "./dist/cjs/cli/cli.js"
+      "import": "./dist/cli/cli.mjs",
+      "require": "./dist/cli/cli.js"
     }
   },
+  "types": "./dist/index.d.ts",
   "typesVersions": {
     "*": {
-      ".": [
-        "./dist/esm/index.d.ts"
+      "*": [
+        "./dist/index.d.ts"
       ],
       "cli": [
-        "./dist/esm/cli/cli.d.ts"
+        "./dist/cli/cli.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",
+    "build": "tsup",
+    "dev": "tsup --watch",
     "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"
+    "ci:build": "tsup --minify --clean"
   },
   "devDependencies": {
-    "@types/diff": "5.0.1",
-    "@types/jest": "27.0.2",
-    "@types/js-yaml": "4.0.4",
+    "@types/diff": "5.0.2",
+    "@types/jest": "27.4.0",
+    "@types/js-yaml": "4.0.5",
     "@types/lodash.isequalwith": "4.4.6",
-    "@types/node": "16.7.1",
-    "@types/yargs": "17.0.3",
-    "@uniformdev/cli": "^12.0.1-alpha.94+0290763c",
-    "eslint": "7.32.0",
-    "eslint-plugin-react": "7.26.1",
-    "eslint-plugin-react-hooks": "4.2.0",
-    "jest": "27.3.1",
+    "@types/node": "16.11.19",
+    "@types/yargs": "17.0.8",
+    "@uniformdev/cli": "^12.2.1-alpha.121+3d33c2be",
+    "eslint": "8.6.0",
+    "eslint-plugin-react": "7.28.0",
+    "eslint-plugin-react-hooks": "4.3.0",
+    "jest": "27.4.7",
     "npm-run-all": "4.1.5",
+    "pusher-js": "7.0.3",
     "rimraf": "3.0.2",
-    "ts-jest": "27.0.7",
-    "yargs": "17.2.1"
+    "ts-jest": "27.1.2",
+    "tsup": "5.11.11",
+    "yargs": "17.3.1"
   },
   "peerDependencies": {
     "yargs": "^17.0.1"
   },
   "dependencies": {
-    "@uniformdev/optimize-common": "^12.0.1-alpha.94+0290763c",
-    "@uniformdev/optimize-tracker-common": "^12.0.1-alpha.94+0290763c",
+    "@uniformdev/context": "^12.2.1-alpha.121+3d33c2be",
     "chalk": "^4.1.2",
     "diff": "^5.0.0",
     "isomorphic-unfetch": "^3.1.0",
@@ -70,8 +71,7 @@
     "lodash.isequalwith": "^4.4.0",
     "p-limit": "^3.1.0",
     "p-retry": "^4.6.1",
-    "p-throttle": "^4.1.1",
-    "pusher-js": ">=7.0.3"
+    "p-throttle": "^4.1.1"
   },
   "files": [
     "/dist"
@@ -79,5 +79,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "0290763c5d9801ad4293fd59cb4cbeb35f5e1408"
+  "gitHead": "3d33c2be484210ce3f056e80176fc6f56b69dabc"
 }

package/dist/cjs/CanvasClient.d.ts

@@ -1,50 +0,0 @@
-import { LimitPolicy } from './enhancement/createLimitPolicy';
-import { ComponentDefinitionAPIDeleteRequest, ComponentDefinitionAPIPutRequest, ComponentDefinitionAPIResponse, ComponentDefinitionListAPIOptions } from './types/componentDefinitions';
-import { CompositionAPIDeleteRequest, CompositionAPIOptions, CompositionAPIPutRequest, CompositionAPIResponse, CompositionListAPIResponse } from './types/componentInstances';
-export declare type CanvasClientOptions = {
-    /** The Uniform API host to use. Internal use. */
-    apiHost?: string;
-    /** The Uniform API key to use when sending API requests. This or bearer token must be specified. */
-    apiKey?: string | null;
-    /** The Uniform bearer token to use. Internal use. */
-    bearerToken?: string | null;
-    /** The Uniform project ID to connect to */
-    projectId?: string | null;
-    /** Specify a fetch implementation to use when fetching data. Useful if you want to only polyfill selectively. */
-    fetch?: typeof fetch;
-    /**
-     * Specify how to retry and throttle requests.
-     * Default: retry 3x on failures with exponential backoff, up to 10 requests per second.
-     * Use createLimitPolicy() to help creating a policy. */
-    limitPolicy?: LimitPolicy;
-};
-export declare class CanvasClientError extends Error {
-    errorMessage: string;
-    fetchMethod: string;
-    fetchUri: string;
-    statusCode?: number | undefined;
-    statusText?: string | undefined;
-    constructor(errorMessage: string, fetchMethod: string, fetchUri: string, statusCode?: number | undefined, statusText?: string | undefined);
-}
-export declare class CanvasClient {
-    private options;
-    constructor(options: CanvasClientOptions);
-    /** Fetches lists of Canvas compositions, optionally by type */
-    getCompositionList(options?: Omit<CompositionAPIOptions, 'projectId'>): Promise<CompositionListAPIResponse>;
-    /** Fetches a Canvas composition by string name (slug) */
-    getCompositionBySlug(options: Pick<CompositionAPIOptions, 'slug' | 'state' | 'skipEnhance' | 'skipPatternResolution'>): Promise<CompositionAPIResponse>;
-    /** Fetches a Canvas composition by its public UUID */
-    getCompositionById(options: Pick<CompositionAPIOptions, 'compositionId' | 'state' | 'skipEnhance' | 'skipPatternResolution'>): Promise<CompositionAPIResponse>;
-    /** Updates or creates a Canvas component definition */
-    updateComposition(body: Omit<CompositionAPIPutRequest, 'projectId'>): Promise<void>;
-    /** Deletes a Canvas component definition */
-    removeComposition(body: Omit<CompositionAPIDeleteRequest, 'projectId'>): Promise<void>;
-    /** Fetches all Canvas component definitions */
-    getComponentDefinitions(options?: Omit<ComponentDefinitionListAPIOptions, 'projectId'>): Promise<ComponentDefinitionAPIResponse>;
-    /** Updates or creates a Canvas component definition */
-    updateComponentDefinition(body: Omit<ComponentDefinitionAPIPutRequest, 'projectId'>): Promise<void>;
-    /** Deletes a Canvas component definition */
-    removeComponentDefinition(body: Omit<ComponentDefinitionAPIDeleteRequest, 'projectId'>): Promise<void>;
-    private apiClient;
-    private createUrl;
-}