@uniformdev/canvas 12.0.1-alpha.98 → 12.2.1-alpha.122

package/dist/esm/cli/syncEngineConsoleLogger.js

@@ -1 +0,0 @@
-import chalk from"chalk";function createSyncEngineConsoleLogger(e){var l=e.diffMode;return function(e){var a=e.action,n=e.displayName,c=e.whatIf,o=e.diff,r="";switch(a){case"create":r=chalk.green("[A]");break;case"update":r=chalk.white("[U]");break;case"delete":r=chalk.yellow("[D]")}e="";("on"===l||"update"===l&&"update"===a)&&(e="\n"+o.map(function(e){return e.added?chalk.green(e.value):e.removed?chalk.red(e.value):e.value}).join("")),console.log(""+(c?chalk.gray("[WHATIF]"):"")+r+" "+n+e)}}export{createSyncEngineConsoleLogger};

package/dist/esm/cli/util.d.ts

@@ -1,43 +0,0 @@
-import { Argv } from 'yargs';
-import { CompositionAPIResponse } from '../types/componentInstances';
-import pLimit from 'p-limit';
-import { DiffMode } from './syncEngineConsoleLogger';
-export declare type ApiArgs = {
-    apiKey: string;
-    apiHost: string;
-};
-export declare function withApiOptions<T>(yargs: Argv<T>): Argv<T>;
-export declare type ProjectArgs = {
-    project: string;
-};
-export declare function withProjectOptions<T>(yargs: Argv<T>): Argv<T>;
-export declare type FormatArgs = {
-    format: 'json' | 'yaml';
-    filename?: string;
-};
-export declare function withFormatOptions<T>(yargs: Argv<T>): Argv<T>;
-export declare type DiffArgs = {
-    diff: DiffMode;
-};
-export declare function withDiffOptions<T>(yargs: Argv<T>): Argv<T>;
-export declare function isPathAPackageFile(path: string): boolean;
-export declare function emitWithFormat(object: any, format?: string, filename?: string): void;
-export declare function readFileToObject<T = unknown>(filename: string): T;
-export declare function prepCompositionForDisk(composition: CompositionAPIResponse): {
-    state: number;
-    projectId: string;
-    composition: import("../types/componentInstances").RootComponentInstance;
-    pattern: boolean;
-    created?: string | undefined;
-    modified?: string | undefined;
-};
-export declare type CLICompositionState = 'preview' | 'published' | number;
-export declare type StateArgs = {
-    state: CLICompositionState;
-};
-export declare function withStateOptions<T>(yargs: Argv<T>): Argv<T>;
-export declare function paginateAsync<TResult>(fetchPage: (offset: number, limit: number) => Promise<TResult[]>, options: {
-    pageSize: number;
-}): AsyncIterableIterator<TResult>;
-export declare function convertCompositionState(state: CLICompositionState): number;
-export declare const limitPolicy: pLimit.Limit;

package/dist/esm/cli/util.js

@@ -1 +0,0 @@
-var __assign=this&&this.__assign||function(){return(__assign=Object.assign||function(t){for(var e,n=1,r=arguments.length;n<r;n++)for(var o in e=arguments[n])Object.prototype.hasOwnProperty.call(e,o)&&(t[o]=e[o]);return t}).apply(this,arguments)},__generator=this&&this.__generator||function(n,r){var o,i,a,s={label:0,sent:function(){if(1&a[0])throw a[1];return a[1]},trys:[],ops:[]},t={next:e(0),throw:e(1),return:e(2)};return"function"==typeof Symbol&&(t[Symbol.iterator]=function(){return this}),t;function e(e){return function(t){return function(e){if(o)throw new TypeError("Generator is already executing.");for(;s;)try{if(o=1,i&&(a=2&e[0]?i.return:e[0]?i.throw||((a=i.return)&&a.call(i),0):i.next)&&!(a=a.call(i,e[1])).done)return a;switch(i=0,(e=a?[2&e[0],a.value]:e)[0]){case 0:case 1:a=e;break;case 4:return s.label++,{value:e[1],done:!1};case 5:s.label++,i=e[1],e=[0];continue;case 7:e=s.ops.pop(),s.trys.pop();continue;default:if(!(a=0<(a=s.trys).length&&a[a.length-1])&&(6===e[0]||2===e[0])){s=0;continue}if(3===e[0]&&(!a||e[1]>a[0]&&e[1]<a[3])){s.label=e[1];break}if(6===e[0]&&s.label<a[1]){s.label=a[1],a=e;break}if(a&&s.label<a[2]){s.label=a[2],s.ops.push(e);break}a[2]&&s.ops.pop(),s.trys.pop();continue}e=r.call(n,s)}catch(t){e=[6,t],i=0}finally{o=a=0}if(5&e[0])throw e[1];return{value:e[0]?e[1]:void 0,done:!0}}([e,t])}}},__await=this&&this.__await||function(t){return this instanceof __await?(this.v=t,this):new __await(t)},__asyncGenerator=this&&this.__asyncGenerator||function(t,e,n){if(!Symbol.asyncIterator)throw new TypeError("Symbol.asyncIterator is not defined.");var o=n.apply(t,e||[]),i=[],a={};return r("next"),r("throw"),r("return"),a[Symbol.asyncIterator]=function(){return this},a;function r(r){o[r]&&(a[r]=function(n){return new Promise(function(t,e){1<i.push([r,n,t,e])||s(r,n)})})}function s(t,e){try{(n=o[t](e)).value instanceof __await?Promise.resolve(n.value.v).then(u,l):c(i[0][2],n)}catch(t){c(i[0][3],t)}var n}function u(t){s("next",t)}function l(t){s("throw",t)}function c(t,e){t(e),i.shift(),i.length&&s(i[0][0],i[0][1])}},__values=this&&this.__values||function(t){var e="function"==typeof Symbol&&Symbol.iterator,n=e&&t[e],r=0;if(n)return n.call(t);if(t&&"number"==typeof t.length)return{next:function(){return{value:(t=t&&r>=t.length?void 0:t)&&t[r++],done:!t}}};throw new TypeError(e?"Object is not iterable.":"Symbol.iterator is not defined.")};import{dump,load}from"js-yaml";import{writeFileSync}from"fs";import{extname}from"path";import{readFileSync}from"fs";import{CANVAS_DRAFT_STATE,CANVAS_PUBLISHED_STATE}from"../utils/constants";import pLimit from"p-limit";function withApiOptions(t){return t.option("apiKey",{describe:"Uniform API key. Defaults to CANVAS_CLI_API_KEY or UNIFORM_API_KEY env. Supports dotenv.",default:null!==(t=null!==(t=process.env.CANVAS_CLI_API_KEY)&&void 0!==t?t:process.env.UPM_CLI_API_KEY)&&void 0!==t?t:process.env.UNIFORM_API_KEY,demandOption:!0,type:"string"}).option("apiHost",{describe:"Uniform host. Defaults to UNIFORM_CLI_BASE_URL env or https://uniform.app. Supports dotenv.",default:process.env.UNIFORM_CLI_BASE_URL||"https://uniform.app",demandOption:!0,type:"string"})}function withProjectOptions(t){return t.option("project",{describe:"Uniform project ID. Defaults to CANVAS_CLI_PROJECT_ID or UNIFORM_PROJECT_ID env. Supports dotenv.",default:null!==(t=null!==(t=process.env.CANVAS_CLI_PROJECT_ID)&&void 0!==t?t:process.env.UPM_CLI_PROJECT_ID)&&void 0!==t?t:process.env.UNIFORM_PROJECT_ID,demandOption:!0,type:"string",alias:["p"]})}function withFormatOptions(t){return t.option("format",{alias:["f"],describe:"Output format",default:"yaml",choices:["yaml","json"],type:"string"}).option("filename",{alias:["o"],describe:"Output filename. If not specified, write to stdout.",type:"string"})}function withDiffOptions(t){return t.option("diff",{describe:"Whether to show diffs in stdout. off = no diffs; update = on for updates; on = updates, creates, deletes",default:"off",type:"string",choices:["off","update","on"],alias:["d"]})}function isPathAPackageFile(t){t=extname(t);return".yaml"===t||".yml"===t||".json"===t}function emitWithFormat(t,e,n){var r;if(n&&!e){var o=extname(n);".yaml"===o||".yml"===o?e="yaml":".json"===o&&(e="json")}else if(!e)throw new Error("Format must be specified when no filename is passed");switch(e){case"json":r=JSON.stringify(t,null,2);break;case"yaml":r=dump(t);break;default:throw new Error("Unsupported format: "+e)}n?writeFileSync(n,r,"utf8"):console.log(r)}function readFileToObject(t){var e=readFileSync(t,"utf8");return load(e,{filename:t,json:!0})}function prepCompositionForDisk(t){t=__assign({},t);return delete t.projectId,delete t.state,t}function withStateOptions(t){return t.option("state",{type:"string",describe:"Composition state to fetch.",choices:["preview","published"],default:"preview"})}function paginateAsync(l,c){return __asyncGenerator(this,arguments,function(){var e,n,r,o,i,a,s,u;return __generator(this,function(t){switch(t.label){case 0:e=c.pageSize||100,n=0,r=[],t.label=1;case 1:return[4,__await(l(n,e))];case 2:r=t.sent(),t.label=3;case 3:t.trys.push([3,9,10,11]),s=void 0,o=__values(r),i=o.next(),t.label=4;case 4:return i.done?[3,8]:(a=i.value,[4,__await(a)]);case 5:return[4,t.sent()];case 6:t.sent(),t.label=7;case 7:return i=o.next(),[3,4];case 8:return[3,11];case 9:return a=t.sent(),s={error:a},[3,11];case 10:try{i&&!i.done&&(u=o.return)&&u.call(o)}finally{if(s)throw s.error}return[7];case 11:n+=e,t.label=12;case 12:if(r.length===e)return[3,1];t.label=13;case 13:return[2]}})})}function convertCompositionState(t){var e=Number(t);if(!isNaN(e))return e;if(!t)return CANVAS_PUBLISHED_STATE;if("string"!=typeof t)throw new Error('state must be "published", "preview", or a number');return"preview"===t?CANVAS_DRAFT_STATE:CANVAS_PUBLISHED_STATE}var limitPolicy=pLimit(8);export{withApiOptions,withProjectOptions,withFormatOptions,withDiffOptions,isPathAPackageFile,emitWithFormat,readFileToObject,prepCompositionForDisk,withStateOptions,paginateAsync,convertCompositionState,limitPolicy};

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

@@ -1,66 +0,0 @@
-import { ComponentEnhancer, ComponentEnhancerFunction, ComponentParameterEnhancer, ComponentParameterEnhancerFunction } from '../types';
-import { ComponentInstance, ComponentParameter } from '../types/componentInstances';
-/**
- * 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.
- */
-export 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, import("../types").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, import("../types").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.
- */
-export 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, import("../types").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, import("../types").EnhancerContext>>;
-}

package/dist/esm/enhancement/EnhancerBuilder.js

@@ -1 +0,0 @@
-var __values=this&&this.__values||function(e){var r="function"==typeof Symbol&&Symbol.iterator,t=r&&e[r],n=0;if(t)return t.call(e);if(e&&"number"==typeof e.length)return{next:function(){return{value:(e=e&&n>=e.length?void 0:e)&&e[n++],done:!e}}};throw new TypeError(r?"Object is not iterable.":"Symbol.iterator is not defined.")},__read=this&&this.__read||function(e,r){var t="function"==typeof Symbol&&e[Symbol.iterator];if(!t)return e;var n,a,o=t.call(e),i=[];try{for(;(void 0===r||0<r--)&&!(n=o.next()).done;)i.push(n.value)}catch(e){a={error:e}}finally{try{n&&!n.done&&(t=o.return)&&t.call(o)}finally{if(a)throw a.error}}return i},ChildEnhancerBuilder=function(){function e(){this._paramMatches=Array(),this._dataMatches=new Map}return e.prototype.parameter=function(e){return this._paramMatches.push({enhancer:this._resolveParameterEnhancer(e)}),this},e.prototype.parameterName=function(e,r){var t=this;return(Array.isArray(e)?e:[e]).forEach(function(e){return t._paramMatches.push({name:e,enhancer:t._resolveParameterEnhancer(r)})}),this},e.prototype.parameterType=function(e,r){var t=this;return(Array.isArray(e)?e:[e]).forEach(function(e){return t._paramMatches.push({type:e,enhancer:t._resolveParameterEnhancer(r)})}),this},e.prototype.data=function(e,r){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,"function"==typeof r?{enhanceOne:r}:r),this},e.prototype.resolveParameterEnhancer=function(r,t){var e;return null===(e=this._paramMatches.find(function(e){return e.name&&e.name===r||e.type&&e.type===t.type||!e.type&&!e.name}))||void 0===e?void 0:e.enhancer},e.prototype.resolveComponentEnhancers=function(){return this._dataMatches},e.prototype._resolveParameterEnhancer=function(e){return"function"==typeof e?{enhanceOne:e}:e},e}(),EnhancerBuilder=function(){function e(){this._componentIndex={},this._rootBuilder=new ChildEnhancerBuilder}return e.prototype.parameter=function(e){return this._rootBuilder.parameter(e),this},e.prototype.parameterName=function(e,r){return this._rootBuilder.parameterName(e,r),this},e.prototype.parameterType=function(e,r){return this._rootBuilder.parameterType(e,r),this},e.prototype.data=function(e,r){return this._rootBuilder.data(e,r),this},e.prototype.component=function(e,r){var t=this;return(Array.isArray(e)?e:[e]).forEach(function(e){t._componentIndex[e]=t._componentIndex[e]||new ChildEnhancerBuilder,r(t._componentIndex[e])}),this},e.prototype.resolveParameterEnhancer=function(e,r,t){e=this._componentIndex[e.type];if(e){e=e.resolveParameterEnhancer(r,t);if(e)return e}return this._rootBuilder.resolveParameterEnhancer(r,t)},e.prototype.resolveComponentEnhancers=function(e){var r,t,n=this._rootBuilder.resolveComponentEnhancers(),e=this._componentIndex[e.type];if(e){n=new Map(n);try{for(var a=__values(e.resolveComponentEnhancers()),o=a.next();!o.done;o=a.next()){var i=__read(o.value,2),h=i[0],c=i[1];n.set(h,c)}}catch(e){r={error:e}}finally{try{o&&!o.done&&(t=a.return)&&t.call(a)}finally{if(r)throw r.error}}}return n},e}();export{ChildEnhancerBuilder,EnhancerBuilder};

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

@@ -1,17 +0,0 @@
-import { BatchEntry } from './batchEnhancer';
-/**
- * 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.
- */
-export 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;
-}

package/dist/esm/enhancement/UniqueBatchEntries.js

@@ -1 +0,0 @@
-var UniqueBatchEntries=function(){function r(r,t){this.groups=r.reduce(function(r,e){var n,o=t(e.args);return r[o]=null!==(n=r[o])&&void 0!==n?n:[],r[o].push(e),r},{})}return r.prototype.resolveKey=function(r,e){this.groups[r].forEach(function(r){return r.resolve(e)})},r.prototype.resolveRemaining=function(e){var n=this;Object.keys(this.groups).forEach(function(r){n.groups[r].forEach(function(r){r.isCompleted||r.resolve(e)})})},r}();export{UniqueBatchEntries};

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

@@ -1,39 +0,0 @@
-import { LimitPolicy } from '..';
-/** A single entry in a batch of queued enhancements. */
-export 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.
- */
-export 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.
- */
-export 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>;

package/dist/esm/enhancement/batchEnhancer.js

@@ -1 +0,0 @@
-var __awaiter=this&&this.__awaiter||function(e,a,c,u){return new(c=c||Promise)(function(n,t){function r(e){try{i(u.next(e))}catch(e){t(e)}}function o(e){try{i(u.throw(e))}catch(e){t(e)}}function i(e){var t;e.done?n(e.value):((t=e.value)instanceof c?t:new c(function(e){e(t)})).then(r,o)}i((u=u.apply(e,a||[])).next())})},__generator=this&&this.__generator||function(n,r){var o,i,a,c={label:0,sent:function(){if(1&a[0])throw a[1];return a[1]},trys:[],ops:[]},e={next:t(0),throw:t(1),return:t(2)};return"function"==typeof Symbol&&(e[Symbol.iterator]=function(){return this}),e;function t(t){return function(e){return function(t){if(o)throw new TypeError("Generator is already executing.");for(;c;)try{if(o=1,i&&(a=2&t[0]?i.return:t[0]?i.throw||((a=i.return)&&a.call(i),0):i.next)&&!(a=a.call(i,t[1])).done)return a;switch(i=0,(t=a?[2&t[0],a.value]:t)[0]){case 0:case 1:a=t;break;case 4:return c.label++,{value:t[1],done:!1};case 5:c.label++,i=t[1],t=[0];continue;case 7:t=c.ops.pop(),c.trys.pop();continue;default:if(!(a=0<(a=c.trys).length&&a[a.length-1])&&(6===t[0]||2===t[0])){c=0;continue}if(3===t[0]&&(!a||t[1]>a[0]&&t[1]<a[3])){c.label=t[1];break}if(6===t[0]&&c.label<a[1]){c.label=a[1],a=t;break}if(a&&c.label<a[2]){c.label=a[2],c.ops.push(t);break}a[2]&&c.ops.pop(),c.trys.pop();continue}t=r.call(n,c)}catch(e){t=[6,e],i=0}finally{o=a=0}if(5&t[0])throw t[1];return{value:t[0]?t[1]:void 0,done:!0}}([t,e])}}},BatchEntry=function(){function e(e,t,n){this._resolve=e,this._reject=t,this.args=n,this._isCompleted=!1}return e.prototype.resolve=function(e){this._resolve(e),this._isCompleted=!0},e.prototype.reject=function(e){this._reject(e),this._isCompleted=!0},Object.defineProperty(e.prototype,"isCompleted",{get:function(){return this._isCompleted},enumerable:!1,configurable:!0}),e}();function createBatchEnhancer(e){var t=this,r=e.handleBatch,o=e.shouldQueue,e=e.limitPolicy,i=[];return{enhanceOne:function(n){return __awaiter(t,void 0,void 0,function(){return __generator(this,function(e){return!o||o(n)?[2,new Promise(function(e,t){i.push(new BatchEntry(e,t,n))})]:[2,void 0]})})},completeAll:function(){return __awaiter(t,void 0,void 0,function(){var t,n;return __generator(this,function(e){switch(e.label){case 0:if(!(0<i.length))return[3,5];e.label=1;case 1:return e.trys.push([1,3,,4]),[4,r(i)];case 2:return e.sent(),[3,4];case 3:return t=e.sent(),i.forEach(function(e){return e.reject(t)}),[3,4];case 4:if(i.some(function(e){return!e.isCompleted}))throw new Error("The completeAll() function failed to resolve or reject all promises in the batch!");e.label=5;case 5:return n=i.length,i=[],[2,n]}})})},limitPolicy:e}}export{BatchEntry,createBatchEnhancer};

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

@@ -1,6 +0,0 @@
-import { ComponentParameterEnhancer, ComponentParameterEnhancerFunction } from '../types/enhancement';
-/**
- * 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()).
- */
-export declare const compose: (input: ComponentParameterEnhancer<any, any>, ...composers: ReadonlyArray<ComponentParameterEnhancer<any, any> | ComponentParameterEnhancerFunction<any>>) => ComponentParameterEnhancer<any, any>;

package/dist/esm/enhancement/compose.js

@@ -1 +0,0 @@
-var __assign=this&&this.__assign||function(){return(__assign=Object.assign||function(e){for(var n,r=1,t=arguments.length;r<t;r++)for(var o in n=arguments[r])Object.prototype.hasOwnProperty.call(n,o)&&(e[o]=n[o]);return e}).apply(this,arguments)},__values=this&&this.__values||function(e){var n="function"==typeof Symbol&&Symbol.iterator,r=n&&e[n],t=0;if(r)return r.call(e);if(e&&"number"==typeof e.length)return{next:function(){return{value:(e=e&&t>=e.length?void 0:e)&&e[t++],done:!e}}};throw new TypeError(n?"Object is not iterable.":"Symbol.iterator is not defined.")},compose=function(l){for(var a=[],e=1;e<arguments.length;e++)a[e-1]=arguments[e];return{enhanceOne:function(t){var n,e,o=l.enhanceOne(t);try{for(var r=__values(a),i=r.next();!i.done;i=r.next())!function(e){var n=isPromise(o)?o:Promise.resolve(o),r="enhanceOne"in e?e.enhanceOne:e;o=n.then(function(e){return r(__assign(__assign({},t),{parameter:{type:t.parameter.type,value:e}}))})}(i.value)}catch(e){n={error:e}}finally{try{i&&!i.done&&(e=r.return)&&e.call(r)}finally{if(n)throw n.error}}return o},completeAll:function(){var e,n;try{for(var r=__values(a),t=r.next();!t.done;t=r.next())if("completeAll"in t.value)throw new Error("Only the first enhancer in a compose chain can use the completeAll function (batching)")}catch(e){n={error:e}}finally{try{t&&!t.done&&(e=r.return)&&e.call(r)}finally{if(n)throw n.error}}return null!==(n=null===(n=l.completeAll)||void 0===n?void 0:n.call(l))&&void 0!==n?n:Promise.resolve(0)}}};function isPromise(e){return!!e&&("object"==typeof e||"function"==typeof e)&&"function"==typeof e.then}export{compose};

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

@@ -1,8 +0,0 @@
-import { Options as ThrottleOptions } from 'p-throttle';
-import { Options as RetryOptions } from 'p-retry';
-export declare type LimitPolicy = <ReturnValue>(func: () => Promise<ReturnValue>) => Promise<ReturnValue>;
-export declare function createLimitPolicy({ throttle, retry, }: {
-    throttle?: ThrottleOptions | false;
-    retry?: RetryOptions | false;
-}): LimitPolicy;
-export declare const nullLimitPolicy: LimitPolicy;

package/dist/esm/enhancement/createLimitPolicy.js

@@ -1 +0,0 @@
-var __awaiter=this&&this.__awaiter||function(t,a,u,c){return new(u=u||Promise)(function(r,e){function n(t){try{o(c.next(t))}catch(t){e(t)}}function i(t){try{o(c.throw(t))}catch(t){e(t)}}function o(t){var e;t.done?r(t.value):((e=t.value)instanceof u?e:new u(function(t){t(e)})).then(n,i)}o((c=c.apply(t,a||[])).next())})},__generator=this&&this.__generator||function(r,n){var i,o,a,u={label:0,sent:function(){if(1&a[0])throw a[1];return a[1]},trys:[],ops:[]},t={next:e(0),throw:e(1),return:e(2)};return"function"==typeof Symbol&&(t[Symbol.iterator]=function(){return this}),t;function e(e){return function(t){return function(e){if(i)throw new TypeError("Generator is already executing.");for(;u;)try{if(i=1,o&&(a=2&e[0]?o.return:e[0]?o.throw||((a=o.return)&&a.call(o),0):o.next)&&!(a=a.call(o,e[1])).done)return a;switch(o=0,(e=a?[2&e[0],a.value]:e)[0]){case 0:case 1:a=e;break;case 4:return u.label++,{value:e[1],done:!1};case 5:u.label++,o=e[1],e=[0];continue;case 7:e=u.ops.pop(),u.trys.pop();continue;default:if(!(a=0<(a=u.trys).length&&a[a.length-1])&&(6===e[0]||2===e[0])){u=0;continue}if(3===e[0]&&(!a||e[1]>a[0]&&e[1]<a[3])){u.label=e[1];break}if(6===e[0]&&u.label<a[1]){u.label=a[1],a=e;break}if(a&&u.label<a[2]){u.label=a[2],u.ops.push(e);break}a[2]&&u.ops.pop(),u.trys.pop();continue}e=n.call(r,u)}catch(t){e=[6,t],o=0}finally{i=a=0}if(5&e[0])throw e[1];return{value:e[0]?e[1]:void 0,done:!0}}([e,t])}}};import pThrottle from"p-throttle";import pRetry from"p-retry";function createLimitPolicy(t){var e=t.throttle,e=void 0===e?{interval:1e3,limit:10}:e,t=t.retry,i=void 0===t?{retries:1,factor:1.66}:t,o=e?pThrottle(e):null;return function(e){var t,r=this,n=function(){return __awaiter(r,void 0,void 0,function(){return __generator(this,function(t){switch(t.label){case 0:return[4,e()];case 1:return[2,t.sent()]}})})};return o&&(n=o(n)),i&&(t=n,n=function(){return pRetry(t,i)}),n()}}var nullLimitPolicy=function(e){return __awaiter(void 0,void 0,void 0,function(){return __generator(this,function(t){switch(t.label){case 0:return[4,e()];case 1:return[2,t.sent()]}})})};export{createLimitPolicy,nullLimitPolicy};

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

@@ -1,18 +0,0 @@
-import { EnhancerContext } from '../types';
-import { ComponentInstance } from '../types/componentInstances';
-import { EnhancerBuilder } from './EnhancerBuilder';
-export 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 :)
- */
-export declare function enhance<TContext extends EnhancerContext = EnhancerContext>({ composition, enhancers, context, onErrors, }: {
-    composition: ComponentInstance;
-    enhancers: EnhancerBuilder;
-    context: TContext;
-    onErrors?: (errors: EnhancerError[]) => void;
-}): Promise<void>;

package/dist/esm/enhancement/enhance.js

@@ -1 +0,0 @@
-var __assign=this&&this.__assign||function(){return(__assign=Object.assign||function(e){for(var r,t=1,n=arguments.length;t<n;t++)for(var a in r=arguments[t])Object.prototype.hasOwnProperty.call(r,a)&&(e[a]=r[a]);return e}).apply(this,arguments)},__awaiter=this&&this.__awaiter||function(e,i,c,l){return new(c=c||Promise)(function(t,r){function n(e){try{o(l.next(e))}catch(e){r(e)}}function a(e){try{o(l.throw(e))}catch(e){r(e)}}function o(e){var r;e.done?t(e.value):((r=e.value)instanceof c?r:new c(function(e){e(r)})).then(n,a)}o((l=l.apply(e,i||[])).next())})},__generator=this&&this.__generator||function(t,n){var a,o,i,c={label:0,sent:function(){if(1&i[0])throw i[1];return i[1]},trys:[],ops:[]},e={next:r(0),throw:r(1),return:r(2)};return"function"==typeof Symbol&&(e[Symbol.iterator]=function(){return this}),e;function r(r){return function(e){return function(r){if(a)throw new TypeError("Generator is already executing.");for(;c;)try{if(a=1,o&&(i=2&r[0]?o.return:r[0]?o.throw||((i=o.return)&&i.call(o),0):o.next)&&!(i=i.call(o,r[1])).done)return i;switch(o=0,(r=i?[2&r[0],i.value]:r)[0]){case 0:case 1:i=r;break;case 4:return c.label++,{value:r[1],done:!1};case 5:c.label++,o=r[1],r=[0];continue;case 7:r=c.ops.pop(),c.trys.pop();continue;default:if(!(i=0<(i=c.trys).length&&i[i.length-1])&&(6===r[0]||2===r[0])){c=0;continue}if(3===r[0]&&(!i||r[1]>i[0]&&r[1]<i[3])){c.label=r[1];break}if(6===r[0]&&c.label<i[1]){c.label=i[1],i=r;break}if(i&&c.label<i[2]){c.label=i[2],c.ops.push(r);break}i[2]&&c.ops.pop(),c.trys.pop();continue}r=n.call(t,c)}catch(e){r=[6,e],o=0}finally{a=i=0}if(5&r[0])throw r[1];return{value:r[0]?r[1]:void 0,done:!0}}([r,e])}}},__read=this&&this.__read||function(e,r){var t="function"==typeof Symbol&&e[Symbol.iterator];if(!t)return e;var n,a,o=t.call(e),i=[];try{for(;(void 0===r||0<r--)&&!(n=o.next()).done;)i.push(n.value)}catch(e){a={error:e}}finally{try{n&&!n.done&&(t=o.return)&&t.call(o)}finally{if(a)throw a.error}}return i},__spreadArray=this&&this.__spreadArray||function(e,r,t){if(t||2===arguments.length)for(var n,a=0,o=r.length;a<o;a++)!n&&a in r||((n=n||Array.prototype.slice.call(r,0,a))[a]=r[a]);return e.concat(n||Array.prototype.slice.call(r))};import{nullLimitPolicy}from"./createLimitPolicy";import{getComponentPath,walkComponentTree}from"./walkComponentTree";function enhance(e){var a=e.composition,c=e.enhancers,l=e.context,e=e.onErrors,u=void 0===e?function(e){throw new Error(e.map(function(e){return e.message+"\n "+("object"==typeof e.error&&"stack"in e.error?e.error.stack:e.error)}).join("\n\n"))}:e;return __awaiter(this,void 0,void 0,function(){var o,r,i,t,n=this;return __generator(this,function(e){switch(e.label){case 0:return o=[],r=new Set,i=new Set,walkComponentTree(a,function(n,a){Object.entries(null!==(e=n.parameters)&&void 0!==e?e:{}).forEach(function(e){var r=__read(e,2),t=r[0],e=r[1],r=c.resolveParameterEnhancer(n,t,e);r&&(i.add(r),o.push(enhanceParameter(n,a,t,e,r,l)))});var e=c.resolveComponentEnhancers(n);o.push(enhanceComponent(n,a,e,l)),r.add(e)}),o.push.apply(o,__spreadArray([],__read(Array.from(r).flatMap(function(e){return Array.from(e).map(function(e){var t=__read(e,2)[1];return __awaiter(n,void 0,void 0,function(){var r;return __generator(this,function(e){switch(e.label){case 0:return(e.trys.push([0,3,,4]),t.completeAll)?[4,(null!==(r=t.limitPolicy)&&void 0!==r?r:nullLimitPolicy)(function(){return t.completeAll()})]:[3,2];case 1:e.sent(),e.label=2;case 2:return[3,4];case 3:return[2,{error:e.sent(),message:"Batch component enhancer failed. Individual failed components should receive their own rejections."}];case 4:return[2]}})})})})),!1)),o.push.apply(o,__spreadArray([],__read(Array.from(i).map(function(t){return __awaiter(n,void 0,void 0,function(){var r;return __generator(this,function(e){switch(e.label){case 0:return(e.trys.push([0,3,,4]),t.completeAll)?[4,(null!==(r=t.limitPolicy)&&void 0!==r?r:nullLimitPolicy)(function(){return t.completeAll()})]:[3,2];case 1:e.sent(),e.label=2;case 2:return[3,4];case 3:return[2,{error:e.sent(),message:"Batch parameter enhancer failed. Individual failed parameters should receive their own rejections."}];case 4:return[2]}})})})),!1)),[4,Promise.all(o)];case 1:return(t=e.sent().flatMap(function(e){return Array.isArray(e)?e:[e]}).filter(function(e){return e})).length&&u(t),[2]}})})}function enhanceComponent(c,l,t,u){return __awaiter(this,void 0,void 0,function(){var r=this;return __generator(this,function(e){switch(e.label){case 0:return t.size&&(c.data={}),[4,Promise.all(Array.from(t).map(function(e){var e=__read(e,2),o=e[0],i=e[1];return __awaiter(r,void 0,void 0,function(){var r,t,n,a=this;return __generator(this,function(e){switch(e.label){case 0:return e.trys.push([0,2,,3]),[4,(!i.completeAll&&null!==(n=i.limitPolicy)&&void 0!==n?n:nullLimitPolicy)(function(){return __awaiter(a,void 0,void 0,function(){return __generator(this,function(e){return[2,i.enhanceOne({component:c,context:u})]})})})];case 1:return null!=(t=e.sent())&&(c.data[o]=t),[3,3];case 2:return r=e.sent(),t="Component "+getComponentPath(l)+" (type: "+c.type+"): data."+o+" enhancer threw exception. Data key will not be present.",delete c.data[o],[2,{message:t,error:r}];case 3:return[2]}})})}))];case 1:return[2,e.sent()]}})})}function enhanceParameter(a,o,i,c,l,u){var s;return __awaiter(this,void 0,void 0,function(){var r,t,n=this;return __generator(this,function(e){switch(e.label){case 0:return e.trys.push([0,2,,3]),[4,(!l.completeAll&&null!==(s=l.limitPolicy)&&void 0!==s?s:nullLimitPolicy)(function(){return __awaiter(n,void 0,void 0,function(){return __generator(this,function(e){return[2,l.enhanceOne({parameter:c,parameterName:i,component:a,context:u})]})})})];case 1:return null===(t=e.sent())?delete a.parameters[i]:a.parameters[i]=__assign(__assign({},c),void 0===t?{value:c.value}:{value:t}),[3,3];case 2:return r=e.sent(),t="Component "+getComponentPath(o)+" (type: "+a.type+"): enhancing parameter "+i+" (type: "+c.type+") threw exception. Parameter will be removed.",delete a.parameters[i],[2,{message:t,error:r}];case 3:return[2]}})})}export{enhance};

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

@@ -1,11 +0,0 @@
-import { ComponentInstance } from '../types/componentInstances';
-export declare function extractLocales({ component }: {
-    component: ComponentInstance;
-}): Record<string, ComponentInstance>;
-export declare function localize({ composition, locale, }: {
-    composition: ComponentInstance;
-    locale: string | ((options: {
-        component: Readonly<ComponentInstance>;
-        locales: Readonly<Record<string, ComponentInstance>>;
-    }) => string | undefined);
-}): void;

package/dist/esm/enhancement/localize.js

@@ -1 +0,0 @@
-import{walkComponentTree}from"./walkComponentTree";import{CANVAS_LOCALIZATION_TYPE,CANVAS_LOCALIZATION_SLOT,CANVAS_LOCALE_TAG_PARAM}from"../utils/constants";function extractLocales(o){var o=o.component,n={},o=null===(o=o.slots)||void 0===o?void 0:o[CANVAS_LOCALIZATION_SLOT];return null!=o&&o.forEach(function(o){var e=null===(e=o.parameters)||void 0===e?void 0:e[CANVAS_LOCALE_TAG_PARAM];null!=e&&e.value&&"string"==typeof e.value&&(n[e.value]=o)}),n}function localize(o){var e=o.composition,A=o.locale;walkComponentTree(e,function(o,e,n){var t,l;o.type===CANVAS_LOCALIZATION_TYPE&&(t=extractLocales({component:o}),l=void 0,(l=(o="string"==typeof A?A:A({component:o,locales:t}))?t[o]:l)?n.replaceComponent(l):n.removeComponent())})}export{extractLocales,localize};

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

@@ -1,14 +0,0 @@
-import { ComponentInstance } from '../types/componentInstances';
-export declare type ComponentLocationReference = {
-    component: ComponentInstance;
-    parentSlot?: string;
-    parentSlotIndex?: number;
-};
-declare type WalkComponentTreeActions = {
-    replaceComponent: (replacementComponent: ComponentInstance) => void;
-    removeComponent: () => void;
-};
-/** Walks a composition's component tree, visiting each component instance depth-first, in order. */
-export declare function walkComponentTree(component: ComponentInstance, visitor: (component: ComponentInstance, ancestorsAndSelf: Array<ComponentLocationReference>, actions: WalkComponentTreeActions) => void): void;
-export declare function getComponentPath(ancestorsAndSelf: Array<ComponentLocationReference>): string;
-export {};

package/dist/esm/enhancement/walkComponentTree.js

@@ -1 +0,0 @@
-var __read=this&&this.__read||function(n,e){var t="function"==typeof Symbol&&n[Symbol.iterator];if(!t)return n;var r,o,a=t.call(n),l=[];try{for(;(void 0===e||0<e--)&&!(r=a.next()).done;)l.push(r.value)}catch(n){o={error:n}}finally{try{r&&!r.done&&(t=a.return)&&t.call(a)}finally{if(o)throw o.error}}return l},__spreadArray=this&&this.__spreadArray||function(n,e,t){if(t||2===arguments.length)for(var r,o=0,a=e.length;o<a;o++)!r&&o in e||((r=r||Array.prototype.slice.call(e,0,o))[o]=e[o]);return n.concat(r||Array.prototype.slice.call(e))};function walkComponentTree(n,c){for(var s=[{ancestorsAndSelf:[{component:n,parentSlot:void 0,parentSlotIndex:void 0}]}];function(){var r=s.pop();if(!r)return;var t=r.ancestorsAndSelf[0];c(t.component,r.ancestorsAndSelf,{replaceComponent:function(e){Object.assign(t.component,e);["parameters","variant","slots","data","_pattern","_patternError"].forEach(function(n){e[n]||delete t.component[n]})},removeComponent:function(){var n=r.ancestorsAndSelf[0],e=n.parentSlot,t=n.parentSlotIndex,n=r.ancestorsAndSelf[1];if(!e||void 0===t)throw new Error("Unable to delete composition.");n.component.slots[e].splice(t,1)}});var n=t.component.slots;if(n)for(var e=Object.keys(n),o=e.length-1;0<=o;o--)for(var a=e[o],l=n[a],p=l.length-1;0<=p;p--)s.push({ancestorsAndSelf:__spreadArray([{component:l[p],parentSlot:a,parentSlotIndex:p}],__read(r.ancestorsAndSelf),!1)})}(),0<s.length;);}function getComponentPath(n){for(var e=[],t=n.length-1;0<=t;t--){var r=n[t],o=r.parentSlot,r=r.parentSlotIndex;o&&void 0!==r&&e.push(o+"["+r+"]")}return"."+e.join(".")}export{walkComponentTree,getComponentPath};

package/dist/esm/index.d.ts

@@ -1,17 +0,0 @@
-export * from './types';
-export * from './enhancement/walkComponentTree';
-export * from './enhancement/UniqueBatchEntries';
-export * from './enhancement/EnhancerBuilder';
-export * from './enhancement/batchEnhancer';
-export * from './enhancement/enhance';
-export * from './enhancement/compose';
-export * from './enhancement/createLimitPolicy';
-export * from './CanvasClient';
-export * from './utils/constants';
-export * from './utils/isSystemComponentDefinition';
-export * from './utils/mapSlotToPersonalizedVariations';
-export * from './preview/createEventBus';
-export * from './preview/getChannelName';
-export * from './preview/subscribeToComposition';
-export * from './preview/EventNames';
-export * from './enhancement/localize';

package/dist/esm/index.js

@@ -1 +0,0 @@
-export*from"./types";export*from"./enhancement/walkComponentTree";export*from"./enhancement/UniqueBatchEntries";export*from"./enhancement/EnhancerBuilder";export*from"./enhancement/batchEnhancer";export*from"./enhancement/enhance";export*from"./enhancement/compose";export*from"./enhancement/createLimitPolicy";export*from"./CanvasClient";export*from"./utils/constants";export*from"./utils/isSystemComponentDefinition";export*from"./utils/mapSlotToPersonalizedVariations";export*from"./preview/createEventBus";export*from"./preview/getChannelName";export*from"./preview/subscribeToComposition";export*from"./preview/EventNames";export*from"./enhancement/localize";

package/dist/esm/preview/EventNames.d.ts

@@ -1 +0,0 @@
-export declare type EventNames = 'updated';

package/dist/esm/preview/createEventBus.d.ts

@@ -1,6 +0,0 @@
-import Pusher from 'pusher-js';
-export declare type PreviewEventBus = {
-    client: Pusher;
-};
-/** Creates an event bus client to receive updates from Canvas */
-export declare function createEventBus(): PreviewEventBus;

package/dist/esm/preview/createEventBus.js

@@ -1 +0,0 @@
-import Pusher from"pusher-js";function createEventBus(){return{client:new Pusher("7b5f5abd160fea549ffe",{cluster:"mt1"})}}export{createEventBus};

package/dist/esm/preview/getChannelName.d.ts

@@ -1 +0,0 @@
-export declare function getChannelName(projectId: string, compositionId: string, state: number): string;

package/dist/esm/preview/getChannelName.js

@@ -1 +0,0 @@
-function getChannelName(e,n,t){return e+"."+n+"@"+t}export{getChannelName};

package/dist/esm/preview/subscribeToComposition.d.ts

@@ -1,13 +0,0 @@
-import { PreviewEventBus } from './createEventBus';
-import { EventNames } from './EventNames';
-export declare type SubscribeToCompositionOptions = {
-    projectId: string;
-    compositionId: string;
-    compositionState: number;
-    callback: (data: any) => void;
-    eventBus: PreviewEventBus;
-    event: EventNames;
-};
-export declare type UnsubscribeCallback = () => void;
-/** Subscribes to a composition event */
-export declare function subscribeToComposition({ projectId, compositionId, compositionState, eventBus: { client }, callback, event, }: SubscribeToCompositionOptions): UnsubscribeCallback;

package/dist/esm/preview/subscribeToComposition.js

@@ -1 +0,0 @@
-import{getChannelName}from"./getChannelName";function subscribeToComposition(o){var e=o.projectId,n=o.compositionId,i=o.compositionState,t=void 0===i?0:i,s=o.eventBus.client,i=o.callback,o=o.event,c=void 0===o?"updated":o,t=getChannelName(e,n,t),a=s.subscribe(t);return console.log("[canvas] subscribed to "+c+" on "+t),a.bind(c,i),function(){a.unbind(),s.unsubscribe(c)}}export{subscribeToComposition};

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

@@ -1,90 +0,0 @@
-/** Shape of the GET response from /api/v1/canvas-definitions */
-export declare type ComponentDefinitionAPIResponse = {
-    componentDefinitions: Array<ComponentDefinition>;
-};
-/** Shape of the PUT request body for /api/v1/canvas-definitions */
-export declare type ComponentDefinitionAPIPutRequest = {
-    componentDefinition: CreatingComponentDefinition;
-    projectId: string;
-};
-/** Shape of the DELETE request body for /api/v1/canvas-definitions */
-export declare type ComponentDefinitionAPIDeleteRequest = {
-    /** Public ID of the component definition to delete */
-    componentId: string;
-    /** Project ID that the component definition lives on */
-    projectId: string;
-};
-/** Query parameter options for GET /api/v1/canvas-definitions */
-export declare type ComponentDefinitionListAPIOptions = {
-    /** Limit list to one result by ID (response remains an array) */
-    componentId?: string;
-    /** Number of records to skip */
-    offset?: number;
-    /** Max number of records to return (defaults to 100) */
-    limit?: number;
-    projectId: string;
-};
-/** The definition of a component parameter */
-export declare type ComponentDefinitionParameter<TConfig = unknown> = {
-    /** Public ID of the parameter (used in code). Do not change after creation. */
-    id: string;
-    /** Friendly name of the parameter */
-    name: string;
-    /** Type name of the parameter (provided by a Uniform integration) */
-    type: string;
-    /** The configuration object for the type (type-specific) */
-    typeConfig?: TConfig;
-};
-/** The definition of a component variant */
-export declare type ComponentDefinitionVariant = {
-    /** Public ID of the variant (used in code). Do not change after creation. */
-    id: string;
-    /** Friendly name of the variant */
-    name: string;
-};
-/** The definition of a named component slot that can contain other components */
-export declare type ComponentDefinitionSlot = {
-    /** Public ID of the slot (used in code). Do not change after creation. */
-    id: string;
-    /** Friendly name of the slot */
-    name: string;
-    /** Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant. */
-    inheritAllowedComponents: boolean;
-    /** A list of component definition public IDs that are allowed in this named slot */
-    allowedComponents: Array<string>;
-    /** Minimum valid number of components in this slot */
-    minComponents?: number;
-    /** Maximum valid number of components in this slot */
-    maxComponents?: number;
-};
-/** Defines a component type that can live on a Composition */
-export declare type ComponentDefinition = {
-    /** Public ID of the component (used in code). Do not change after creation. */
-    id: string;
-    /** Friendly name of the component definition */
-    name: string;
-    /** Icon name for the component definition (e.g. 'screen') */
-    icon: string;
-    /**
-     * The public ID of the parameter whose value should be used to create a display title for this component in the UI.
-     * The parameter type must support being used as a title parameter for this to work.
-     */
-    titleParameter?: string | null;
-    /** Whether this component type can be the root of a composition. If false, this component is only used within slots on other components. */
-    canBeComposition?: boolean;
-    /** The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
-    parameters?: Array<ComponentDefinitionParameter>;
-    /** The named slots for this component; placement areas where arrays of other components can be added. */
-    slots?: Array<ComponentDefinitionSlot>;
-    /** Named variants for this component; enables creation of visual variants that use the same parameter data/ */
-    variants?: Array<ComponentDefinitionVariant>;
-    /** Created date string for this definition */
-    created?: string;
-    /** Modified date string for this definition */
-    modified?: string;
-};
-/** Defines a component type that can live on a Composition, when it is being created or updated */
-export declare type CreatingComponentDefinition = Omit<Partial<ComponentDefinition>, 'created' | 'modified' | 'id' | 'name'> & {
-    id: string;
-    name: string;
-};

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

@@ -1,104 +0,0 @@
-/** @deprecated use CANVAS_DRAFT_STATE and CANVAS_PUBLISHED_STATE instead */
-export declare type CompositionFetchState = 'preview' | 'published' | number;
-/** The GET response from /api/v1/canvas when `component` or `slug` params are specified */
-export declare type CompositionAPIResponse = {
-    /** The state of the layout. See CANVAS_DRAFT_STATE and CANVAS_PUBLISHED_STATE. */
-    state: number;
-    /** The project ID that this layout data is part of */
-    projectId: string;
-    /** Layout data being read or written */
-    composition: RootComponentInstance;
-    /** Whether this composition is a pattern (can be referenced by other compositions) */
-    pattern: boolean;
-    /** Created date string for this definition */
-    created?: string;
-    /** Modified date string for this definition */
-    modified?: string;
-};
-/** Shape of the PUT request body for /api/v1/canvas */
-export declare type CompositionAPIPutRequest = Omit<CompositionAPIResponse, 'projectId'> & {
-    projectId: string;
-};
-/** Shape of the DELETE request body for /api/v1/canvas */
-export declare type CompositionAPIDeleteRequest = {
-    /** Public ID of the composition to delete */
-    compositionId: string;
-    /** Project ID that the composition lives on. */
-    projectId: string;
-    /** The state to delete. If unspecified, all states will be deleted. See CANVAS_DRAFT_STATE and CANVAS_PUBLISHED_STATE. */
-    state?: number;
-};
-/** The GET response from /api/v1/canvas when `component` or `slug` are not specified */
-export declare type CompositionListAPIResponse = {
-    compositions: Array<CompositionAPIResponse>;
-};
-/** Query parameter options for GET /api/v1/canvas */
-export declare type CompositionAPIOptions = {
-    /** Specify a single composition ID to fetch. Changes response from list to single. */
-    compositionId?: string;
-    /** Specify a single composition to fetch by slug. Changes response from list to single. */
-    slug?: string;
-    /** The project the composition(s) are on. */
-    projectId: string;
-    /** The component type to filter by */
-    type?: string;
-    /** Number of records to skip */
-    offset?: number;
-    /** Max number of records to return (defaults to 100) */
-    limit?: number;
-    /** State of compositions to fetch. Default = 'published' */
-    state?: number;
-    /**
-     * Signals a Canvas enhancer proxy to skip processing enhancements to the data and return raw data only.
-     * This improves performance if you do not require enhanced component data.
-     * If calling the Canvas API directly with no enhancer proxy, this has no effect.
-     */
-    skipEnhance?: boolean;
-    /**
-     * If true, any pattern references in the composition will be left unresolved.
-     * This is appropriate if you intend to serialize the composition data without pattern
-     * data embedded into it, and serialize the pattern data separately.
-     */
-    skipPatternResolution?: boolean;
-};
-export declare type ComponentParameter<TValue = unknown> = {
-    /** The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
-    type: string;
-    /**
-     * The value of the parameter.
-     * Any JSON-serializable value is acceptable.
-     */
-    value: TValue;
-};
-/**
- * Defines the shape of a component instance served by the composition API.
- */
-export declare type ComponentInstance = {
-    /** Type of the component instance (public_id of its definition) */
-    type: string;
-    /** Component parameter values for the component instance */
-    parameters?: Record<string, ComponentParameter>;
-    /** Public ID of alternate visual appearance for this component, if any selected */
-    variant?: string;
-    /** Slots containing any sub-components */
-    slots?: Record<string, ComponentInstance[]>;
-    /** Data for the component instance, provided by a component enhancer. Never set in unenhanced data. */
-    data?: Record<string, unknown>;
-    /** Indicates this component instance should be sourced from a pattern library pattern */
-    _pattern?: string;
-    /**
-     * If an error occurs resolving a pattern reference, it is left unresolved and this property is set to indicate why.
-     * CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
-     * NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, or not be published yet.
-     */
-    _patternError?: 'CYCLIC' | 'NOTFOUND';
-};
-/** Defines the shape of the root component in a composition */
-export declare type RootComponentInstance = ComponentInstance & {
-    /** The public UUID of the composition. */
-    _id?: string;
-    /** Slug pattern of this component. */
-    _slug?: string | null;
-    /** Friendly name of this component. */
-    _name?: string;
-};