@uniformdev/canvas 18.17.1-alpha.13 → 18.19.0

package/dist/index.esm.js

@@ -16,6 +16,10 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
   isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
   mod
 ));
@@ -78,7 +82,7 @@ var require_retry_operation = __commonJS({
       if (!err) {
         return false;
       }
-      var currentTime = new Date().getTime();
+      var currentTime = (/* @__PURE__ */ new Date()).getTime();
       if (err && currentTime - this._operationStart >= this._maxRetryTime) {
         this._errors.push(err);
         this._errors.unshift(new Error("RetryOperation timeout occurred"));
@@ -128,7 +132,7 @@ var require_retry_operation = __commonJS({
           self._operationTimeoutCb();
         }, self._operationTimeout);
       }
-      this._operationStart = new Date().getTime();
+      this._operationStart = (/* @__PURE__ */ new Date()).getTime();
       this._fn(this._attempts);
     };
     RetryOperation.prototype.try = function(fn) {
@@ -268,10 +272,15 @@ import { ApiClient } from "@uniformdev/context/api";
 var import_retry = __toESM(require_retry2(), 1);
 var networkErrorMsgs = /* @__PURE__ */ new Set([
   "Failed to fetch",
+  // Chrome
   "NetworkError when attempting to fetch resource.",
+  // Firefox
   "The Internet connection appears to be offline.",
+  // Safari
   "Network request failed",
+  // `cross-fetch`
   "fetch failed"
+  // Undici (Node.js)
 ]);
 var AbortError = class extends Error {
   constructor(message) {
@@ -452,6 +461,7 @@ var CanvasClient = class extends ApiClient {
     super(options);
     this.edgeApiHost = (_a = options.edgeApiHost) != null ? _a : "https://uniform.global";
   }
+  /** Fetches lists of Canvas compositions, optionally by type */
   async getCompositionList(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl(CANVAS_URL, { ...options, projectId });
@@ -460,12 +470,14 @@ var CanvasClient = class extends ApiClient {
   getCompositionByNodePath(options) {
     return this.getOneComposition(options);
   }
+  /** @deprecated use getCompositionByNodePath instead */
   unstable_getCompositionByNodePath(options) {
     return this.getOneComposition(options);
   }
   getCompositionByNodeId(options) {
     return this.getOneComposition(options);
   }
+  /** @deprecated Use getCompositionByNodeId instead */
   unstable_getCompositionByNodeId(options) {
     return this.getOneComposition(options);
   }
@@ -494,6 +506,7 @@ var CanvasClient = class extends ApiClient {
     const edgeUrl = this.createUrl("/api/v1/composition", edgeParams, this.edgeApiHost);
     return this.apiClient(edgeUrl);
   }
+  /** Updates or creates a Canvas component definition */
   async updateComposition(body) {
     const fetchUri = this.createUrl(CANVAS_URL);
     await this.apiClient(fetchUri, {
@@ -502,6 +515,7 @@ var CanvasClient = class extends ApiClient {
       expectNoContent: true
     });
   }
+  /** Deletes a Canvas component definition */
   async removeComposition(body) {
     const fetchUri = this.createUrl(CANVAS_URL);
     const { projectId } = this.options;
@@ -511,11 +525,13 @@ var CanvasClient = class extends ApiClient {
       expectNoContent: true
     });
   }
+  /** Fetches all Canvas component definitions */
   async getComponentDefinitions(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl("/api/v1/canvas-definitions", { ...options, projectId });
     return await this.apiClient(fetchUri);
   }
+  /** Updates or creates a Canvas component definition */
   async updateComponentDefinition(body) {
     const fetchUri = this.createUrl("/api/v1/canvas-definitions");
     await this.apiClient(fetchUri, {
@@ -524,6 +540,7 @@ var CanvasClient = class extends ApiClient {
       expectNoContent: true
     });
   }
+  /** Deletes a Canvas component definition */
   async removeComponentDefinition(body) {
     const fetchUri = this.createUrl("/api/v1/canvas-definitions");
     await this.apiClient(fetchUri, {
@@ -547,16 +564,19 @@ var DataSourceClient = class extends ApiClient2 {
   constructor(options) {
     super(options);
   }
+  /** Fetches all DataSources for a project */
   async get(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl(dataSourceUrl, { ...options, projectId });
     return await this.apiClient(fetchUri);
   }
+  /** Fetches all DataSources for a project */
   async getList(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl(dataSourcesUrl, { ...options, projectId });
     return await this.apiClient(fetchUri);
   }
+  /** Updates or creates (based on id) a DataSource */
   async upsert(body) {
     const fetchUri = this.createUrl(dataSourceUrl);
     await this.apiClient(fetchUri, {
@@ -565,6 +585,7 @@ var DataSourceClient = class extends ApiClient2 {
       expectNoContent: true
     });
   }
+  /** Deletes a DataSource */
   async remove(body) {
     const fetchUri = this.createUrl(dataSourceUrl);
     await this.apiClient(fetchUri, {
@@ -582,11 +603,13 @@ var _DataTypeClient = class extends ApiClient3 {
   constructor(options) {
     super(options);
   }
+  /** Fetches all DataTypes for a project */
   async get(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl(__privateGet(_DataTypeClient, _url), { ...options, projectId });
     return await this.apiClient(fetchUri);
   }
+  /** Updates or creates (based on id) a DataType */
   async upsert(body) {
     const fetchUri = this.createUrl(__privateGet(_DataTypeClient, _url));
     await this.apiClient(fetchUri, {
@@ -595,6 +618,7 @@ var _DataTypeClient = class extends ApiClient3 {
       expectNoContent: true
     });
   }
+  /** Deletes a DataType */
   async remove(body) {
     const fetchUri = this.createUrl(__privateGet(_DataTypeClient, _url));
     await this.apiClient(fetchUri, {
@@ -616,14 +640,17 @@ var BatchEntry = class {
     this.args = args;
     this._isCompleted = false;
   }
+  /** Mark the batch entry as successfully completed. */
   resolve(result) {
     this._resolve(result);
     this._isCompleted = true;
   }
+  /** Mark the batch entry as failed. */
   reject(reason) {
     this._reject(reason);
     this._isCompleted = true;
   }
+  /** @return Whether the batch entry has been completed (resolved or rejected). */
   get isCompleted() {
     return this._isCompleted;
   }
@@ -956,10 +983,12 @@ var ChildEnhancerBuilder = class {
     this._paramMatches = Array();
     this._dataMatches = /* @__PURE__ */ new Map();
   }
+  /** Targets an enhancer to modify the value of any parameter */
   parameter(enhancer) {
     this._paramMatches.push({ enhancer: this._resolveParameterEnhancer(enhancer) });
     return this;
   }
+  /** Targets an enhancer to modify the value of any parameter with a specific name */
   parameterName(name, enhancer) {
     const names = Array.isArray(name) ? name : [name];
     names.forEach(
@@ -967,6 +996,7 @@ var ChildEnhancerBuilder = class {
     );
     return this;
   }
+  /** Targets an enhancer to modify the value of any parameter with a specific type */
   parameterType(type, enhancer) {
     const types = Array.isArray(type) ? type : [type];
     types.forEach(
@@ -974,6 +1004,10 @@ var ChildEnhancerBuilder = class {
     );
     return 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, enhancer) {
     if (this._dataMatches.has(name)) {
       throw new Error(`${name} enhancer data key has been used more than once. This will cause data loss.`);
@@ -981,12 +1015,20 @@ var ChildEnhancerBuilder = class {
     this._dataMatches.set(name, typeof enhancer === "function" ? { enhanceOne: enhancer } : enhancer);
     return 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, parameter) {
     var _a;
     return (_a = this._paramMatches.find(
       (m) => m.name && m.name === parameterName || m.type && m.type === parameter.type || !m.type && !m.name
     )) == null ? void 0 : _a.enhancer;
   }
+  /**
+   * 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() {
     return this._dataMatches;
   }
@@ -1003,22 +1045,33 @@ var EnhancerBuilder = class {
     this._componentIndex = {};
     this._rootBuilder = new ChildEnhancerBuilder();
   }
+  /** Targets an enhancer to modify the value of any parameter */
   parameter(enhancer) {
     this._rootBuilder.parameter(enhancer);
     return this;
   }
+  /** Targets an enhancer to modify the value of any parameter with a specific name */
   parameterName(name, enhancer) {
     this._rootBuilder.parameterName(name, enhancer);
     return this;
   }
+  /** Targets an enhancer to modify the value of any parameter with a specific type */
   parameterType(type, enhancer) {
     this._rootBuilder.parameterType(type, enhancer);
     return 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, enhancer) {
     this._rootBuilder.data(name, enhancer);
     return 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, builder) {
     const names = Array.isArray(name) ? name : [name];
     names.forEach((name2) => {
@@ -1027,6 +1080,10 @@ var EnhancerBuilder = class {
     });
     return 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(component, parameterName, parameter) {
     const eb = this._componentIndex[component.type];
     if (eb) {
@@ -1037,6 +1094,10 @@ var EnhancerBuilder = class {
     }
     return this._rootBuilder.resolveParameterEnhancer(parameterName, parameter);
   }
+  /**
+   * 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) {
     let componentEnhancers = this._rootBuilder.resolveComponentEnhancers();
     const eb = this._componentIndex[component.type];
@@ -1127,9 +1188,11 @@ var UniqueBatchEntries = class {
       return acc;
     }, {});
   }
+  /** Resolves all entries in a group key with the same result value. */
   resolveKey(key, result) {
     this.groups[key].forEach((task) => task.resolve(result));
   }
+  /** Resolves all remaining entries that have not been otherwise resolved with a specific value */
   resolveRemaining(value) {
     Object.keys(this.groups).forEach((key) => {
       this.groups[key].forEach((task) => {
@@ -1302,7 +1365,7 @@ async function loadPusher() {
         resolve(window.Pusher);
       }
       reject(
-        `Unable to load pusher.js; Uniform Canvas live preview disabled. Consider adding <script src="${PUSHER_SRC}"><\/script> manually.`
+        `Unable to load pusher.js; Uniform Canvas live preview disabled. Consider adding <script src="${PUSHER_SRC}"></script> manually.`
       );
     }, 5e3);
     const pusher = document.createElement("script");
@@ -1419,6 +1482,7 @@ function mapSlotToTestVariations(slot) {
     return {
       ...v,
       id
+      //testDistribution: contextTag?.testDistribution,
     };
   });
 }

package/dist/index.js

@@ -21,6 +21,10 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
   isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
   mod
 ));
@@ -84,7 +88,7 @@ var require_retry_operation = __commonJS({
       if (!err) {
         return false;
       }
-      var currentTime = new Date().getTime();
+      var currentTime = (/* @__PURE__ */ new Date()).getTime();
       if (err && currentTime - this._operationStart >= this._maxRetryTime) {
         this._errors.push(err);
         this._errors.unshift(new Error("RetryOperation timeout occurred"));
@@ -134,7 +138,7 @@ var require_retry_operation = __commonJS({
           self._operationTimeoutCb();
         }, self._operationTimeout);
       }
-      this._operationStart = new Date().getTime();
+      this._operationStart = (/* @__PURE__ */ new Date()).getTime();
       this._fn(this._attempts);
     };
     RetryOperation.prototype.try = function(fn) {
@@ -339,10 +343,15 @@ var import_api = require("@uniformdev/context/api");
 var import_retry = __toESM(require_retry2(), 1);
 var networkErrorMsgs = /* @__PURE__ */ new Set([
   "Failed to fetch",
+  // Chrome
   "NetworkError when attempting to fetch resource.",
+  // Firefox
   "The Internet connection appears to be offline.",
+  // Safari
   "Network request failed",
+  // `cross-fetch`
   "fetch failed"
+  // Undici (Node.js)
 ]);
 var AbortError = class extends Error {
   constructor(message) {
@@ -523,6 +532,7 @@ var CanvasClient = class extends import_api.ApiClient {
     super(options);
     this.edgeApiHost = (_a = options.edgeApiHost) != null ? _a : "https://uniform.global";
   }
+  /** Fetches lists of Canvas compositions, optionally by type */
   async getCompositionList(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl(CANVAS_URL, { ...options, projectId });
@@ -531,12 +541,14 @@ var CanvasClient = class extends import_api.ApiClient {
   getCompositionByNodePath(options) {
     return this.getOneComposition(options);
   }
+  /** @deprecated use getCompositionByNodePath instead */
   unstable_getCompositionByNodePath(options) {
     return this.getOneComposition(options);
   }
   getCompositionByNodeId(options) {
     return this.getOneComposition(options);
   }
+  /** @deprecated Use getCompositionByNodeId instead */
   unstable_getCompositionByNodeId(options) {
     return this.getOneComposition(options);
   }
@@ -565,6 +577,7 @@ var CanvasClient = class extends import_api.ApiClient {
     const edgeUrl = this.createUrl("/api/v1/composition", edgeParams, this.edgeApiHost);
     return this.apiClient(edgeUrl);
   }
+  /** Updates or creates a Canvas component definition */
   async updateComposition(body) {
     const fetchUri = this.createUrl(CANVAS_URL);
     await this.apiClient(fetchUri, {
@@ -573,6 +586,7 @@ var CanvasClient = class extends import_api.ApiClient {
       expectNoContent: true
     });
   }
+  /** Deletes a Canvas component definition */
   async removeComposition(body) {
     const fetchUri = this.createUrl(CANVAS_URL);
     const { projectId } = this.options;
@@ -582,11 +596,13 @@ var CanvasClient = class extends import_api.ApiClient {
       expectNoContent: true
     });
   }
+  /** Fetches all Canvas component definitions */
   async getComponentDefinitions(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl("/api/v1/canvas-definitions", { ...options, projectId });
     return await this.apiClient(fetchUri);
   }
+  /** Updates or creates a Canvas component definition */
   async updateComponentDefinition(body) {
     const fetchUri = this.createUrl("/api/v1/canvas-definitions");
     await this.apiClient(fetchUri, {
@@ -595,6 +611,7 @@ var CanvasClient = class extends import_api.ApiClient {
       expectNoContent: true
     });
   }
+  /** Deletes a Canvas component definition */
   async removeComponentDefinition(body) {
     const fetchUri = this.createUrl("/api/v1/canvas-definitions");
     await this.apiClient(fetchUri, {
@@ -618,16 +635,19 @@ var DataSourceClient = class extends import_api2.ApiClient {
   constructor(options) {
     super(options);
   }
+  /** Fetches all DataSources for a project */
   async get(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl(dataSourceUrl, { ...options, projectId });
     return await this.apiClient(fetchUri);
   }
+  /** Fetches all DataSources for a project */
   async getList(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl(dataSourcesUrl, { ...options, projectId });
     return await this.apiClient(fetchUri);
   }
+  /** Updates or creates (based on id) a DataSource */
   async upsert(body) {
     const fetchUri = this.createUrl(dataSourceUrl);
     await this.apiClient(fetchUri, {
@@ -636,6 +656,7 @@ var DataSourceClient = class extends import_api2.ApiClient {
       expectNoContent: true
     });
   }
+  /** Deletes a DataSource */
   async remove(body) {
     const fetchUri = this.createUrl(dataSourceUrl);
     await this.apiClient(fetchUri, {
@@ -653,11 +674,13 @@ var _DataTypeClient = class extends import_api3.ApiClient {
   constructor(options) {
     super(options);
   }
+  /** Fetches all DataTypes for a project */
   async get(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl(__privateGet(_DataTypeClient, _url), { ...options, projectId });
     return await this.apiClient(fetchUri);
   }
+  /** Updates or creates (based on id) a DataType */
   async upsert(body) {
     const fetchUri = this.createUrl(__privateGet(_DataTypeClient, _url));
     await this.apiClient(fetchUri, {
@@ -666,6 +689,7 @@ var _DataTypeClient = class extends import_api3.ApiClient {
       expectNoContent: true
     });
   }
+  /** Deletes a DataType */
   async remove(body) {
     const fetchUri = this.createUrl(__privateGet(_DataTypeClient, _url));
     await this.apiClient(fetchUri, {
@@ -687,14 +711,17 @@ var BatchEntry = class {
     this.args = args;
     this._isCompleted = false;
   }
+  /** Mark the batch entry as successfully completed. */
   resolve(result) {
     this._resolve(result);
     this._isCompleted = true;
   }
+  /** Mark the batch entry as failed. */
   reject(reason) {
     this._reject(reason);
     this._isCompleted = true;
   }
+  /** @return Whether the batch entry has been completed (resolved or rejected). */
   get isCompleted() {
     return this._isCompleted;
   }
@@ -1027,10 +1054,12 @@ var ChildEnhancerBuilder = class {
     this._paramMatches = Array();
     this._dataMatches = /* @__PURE__ */ new Map();
   }
+  /** Targets an enhancer to modify the value of any parameter */
   parameter(enhancer) {
     this._paramMatches.push({ enhancer: this._resolveParameterEnhancer(enhancer) });
     return this;
   }
+  /** Targets an enhancer to modify the value of any parameter with a specific name */
   parameterName(name, enhancer) {
     const names = Array.isArray(name) ? name : [name];
     names.forEach(
@@ -1038,6 +1067,7 @@ var ChildEnhancerBuilder = class {
     );
     return this;
   }
+  /** Targets an enhancer to modify the value of any parameter with a specific type */
   parameterType(type, enhancer) {
     const types = Array.isArray(type) ? type : [type];
     types.forEach(
@@ -1045,6 +1075,10 @@ var ChildEnhancerBuilder = class {
     );
     return 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, enhancer) {
     if (this._dataMatches.has(name)) {
       throw new Error(`${name} enhancer data key has been used more than once. This will cause data loss.`);
@@ -1052,12 +1086,20 @@ var ChildEnhancerBuilder = class {
     this._dataMatches.set(name, typeof enhancer === "function" ? { enhanceOne: enhancer } : enhancer);
     return 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, parameter) {
     var _a;
     return (_a = this._paramMatches.find(
       (m) => m.name && m.name === parameterName || m.type && m.type === parameter.type || !m.type && !m.name
     )) == null ? void 0 : _a.enhancer;
   }
+  /**
+   * 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() {
     return this._dataMatches;
   }
@@ -1074,22 +1116,33 @@ var EnhancerBuilder = class {
     this._componentIndex = {};
     this._rootBuilder = new ChildEnhancerBuilder();
   }
+  /** Targets an enhancer to modify the value of any parameter */
   parameter(enhancer) {
     this._rootBuilder.parameter(enhancer);
     return this;
   }
+  /** Targets an enhancer to modify the value of any parameter with a specific name */
   parameterName(name, enhancer) {
     this._rootBuilder.parameterName(name, enhancer);
     return this;
   }
+  /** Targets an enhancer to modify the value of any parameter with a specific type */
   parameterType(type, enhancer) {
     this._rootBuilder.parameterType(type, enhancer);
     return 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, enhancer) {
     this._rootBuilder.data(name, enhancer);
     return 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, builder) {
     const names = Array.isArray(name) ? name : [name];
     names.forEach((name2) => {
@@ -1098,6 +1151,10 @@ var EnhancerBuilder = class {
     });
     return 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(component, parameterName, parameter) {
     const eb = this._componentIndex[component.type];
     if (eb) {
@@ -1108,6 +1165,10 @@ var EnhancerBuilder = class {
     }
     return this._rootBuilder.resolveParameterEnhancer(parameterName, parameter);
   }
+  /**
+   * 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) {
     let componentEnhancers = this._rootBuilder.resolveComponentEnhancers();
     const eb = this._componentIndex[component.type];
@@ -1198,9 +1259,11 @@ var UniqueBatchEntries = class {
       return acc;
     }, {});
   }
+  /** Resolves all entries in a group key with the same result value. */
   resolveKey(key, result) {
     this.groups[key].forEach((task) => task.resolve(result));
   }
+  /** Resolves all remaining entries that have not been otherwise resolved with a specific value */
   resolveRemaining(value) {
     Object.keys(this.groups).forEach((key) => {
       this.groups[key].forEach((task) => {
@@ -1373,7 +1436,7 @@ async function loadPusher() {
         resolve(window.Pusher);
       }
       reject(
-        `Unable to load pusher.js; Uniform Canvas live preview disabled. Consider adding <script src="${PUSHER_SRC}"><\/script> manually.`
+        `Unable to load pusher.js; Uniform Canvas live preview disabled. Consider adding <script src="${PUSHER_SRC}"></script> manually.`
       );
     }, 5e3);
     const pusher = document.createElement("script");
@@ -1490,6 +1553,7 @@ function mapSlotToTestVariations(slot) {
     return {
       ...v,
       id
+      //testDistribution: contextTag?.testDistribution,
     };
   });
 }