@uniformdev/canvas 19.88.0 → 19.89.0

package/dist/index.esm.js

@@ -1640,23 +1640,31 @@ function extractLocales({ component }) {
   });
   return variations;
 }
-function localize({
-  composition,
-  locale
-}) {
-  walkNodeTree(composition, ({ type, node, actions }) => {
+function localize(options) {
+  const nodes = "nodes" in options ? options.nodes : options.composition;
+  const locale = options.locale;
+  walkNodeTree(nodes, ({ type, node, actions }) => {
     if (type !== "component") {
-      actions.stopProcessingDescendants();
+      if (typeof locale === "string") {
+        localizeProperties(node.fields, locale);
+      }
       return;
     }
+    const shouldRunPropertyLocalization = typeof locale === "string";
     if (node.type === CANVAS_LOCALIZATION_TYPE) {
       const locales = extractLocales({ component: node });
-      const resolvedLocale = typeof locale === "string" ? locale : locale({ component: node, locales });
+      const resolvedLocale = typeof locale === "string" ? locale : locale == null ? void 0 : locale({ component: node, locales });
       let replaceComponent;
       if (resolvedLocale) {
         replaceComponent = locales[resolvedLocale];
       }
       if (replaceComponent == null ? void 0 : replaceComponent.length) {
+        replaceComponent.forEach((component) => {
+          removeLocaleProperty(component);
+          if (shouldRunPropertyLocalization) {
+            localizeProperties(getPropertiesValue(component), locale);
+          }
+        });
         const [first, ...rest] = replaceComponent;
         actions.replace(first);
         if (rest.length) {
@@ -1665,6 +1673,42 @@ function localize({
       } else {
         actions.remove();
       }
+    } else if (shouldRunPropertyLocalization) {
+      localizeProperties(getPropertiesValue(node), locale);
+    }
+  });
+}
+function removeLocaleProperty(component) {
+  const properties = getPropertiesValue(component);
+  const localeTagProperty = properties == null ? void 0 : properties[CANVAS_LOCALE_TAG_PARAM];
+  if (localeTagProperty) {
+    delete properties[CANVAS_LOCALE_TAG_PARAM];
+  }
+  if (properties && Object.keys(properties).length === 0) {
+    if ("fields" in component) {
+      delete component.fields;
+    }
+    if ("parameters" in component) {
+      delete component.parameters;
+    }
+  }
+}
+function localizeProperties(properties, locale) {
+  if (!properties) {
+    return void 0;
+  }
+  Object.entries(properties).forEach(([key, property]) => {
+    var _a;
+    if (!locale) {
+      delete property.locales;
+    }
+    const currentLocaleValue = locale ? (_a = property.locales) == null ? void 0 : _a[locale] : void 0;
+    if (currentLocaleValue !== void 0) {
+      property.value = currentLocaleValue;
+    }
+    delete property.locales;
+    if (property.value === void 0) {
+      delete properties[key];
     }
   });
 }
@@ -1814,6 +1858,39 @@ function walkComponentTree(component, visitor, initialContext) {
   } while (componentQueue.length > 0);
 }
 
+// src/LocaleClient.ts
+import { ApiClient as ApiClient7 } from "@uniformdev/context/api";
+var localesUrl = "/api/v1/locales";
+var LocaleClient = class extends ApiClient7 {
+  constructor(options) {
+    super(options);
+  }
+  /** Fetches all locales for a project */
+  async get(options) {
+    const { projectId } = this.options;
+    const fetchUri = this.createUrl(localesUrl, { ...options, projectId });
+    return await this.apiClient(fetchUri);
+  }
+  /** Updates or creates (based on id) a locale */
+  async upsert(body) {
+    const fetchUri = this.createUrl(localesUrl);
+    await this.apiClient(fetchUri, {
+      method: "PUT",
+      body: JSON.stringify({ ...body, projectId: this.options.projectId }),
+      expectNoContent: true
+    });
+  }
+  /** Deletes a locale */
+  async remove(body) {
+    const fetchUri = this.createUrl(localesUrl);
+    await this.apiClient(fetchUri, {
+      method: "DELETE",
+      body: JSON.stringify({ ...body, projectId: this.options.projectId }),
+      expectNoContent: true
+    });
+  }
+};
+
 // src/utils/hash.ts
 var generateHash = ({
   composition,
@@ -2171,9 +2248,9 @@ function subscribeToComposition({
 }
 
 // src/PromptClient.ts
-import { ApiClient as ApiClient7 } from "@uniformdev/context/api";
+import { ApiClient as ApiClient8 } from "@uniformdev/context/api";
 var PromptsUrl = "/api/v1/prompts";
-var PromptClient = class extends ApiClient7 {
+var PromptClient = class extends ApiClient8 {
   constructor(options) {
     super(options);
   }
@@ -2204,9 +2281,9 @@ var PromptClient = class extends ApiClient7 {
 };
 
 // src/RouteClient.ts
-import { ApiClient as ApiClient8 } from "@uniformdev/context/api";
+import { ApiClient as ApiClient9 } from "@uniformdev/context/api";
 var ROUTE_URL = "/api/v1/route";
-var RouteClient = class extends ApiClient8 {
+var RouteClient = class extends ApiClient9 {
   constructor(options) {
     var _a;
     if (!options.limitPolicy) {
@@ -2223,6 +2300,9 @@ var RouteClient = class extends ApiClient8 {
   }
 };
 
+// src/types/locales.ts
+var LOCALE_DYNAMIC_INPUT_NAME = "locale";
+
 // src/utils/createApiEnhancer.ts
 var createUniformApiEnhancer = ({ apiUrl }) => {
   return async (message) => {
@@ -2254,7 +2334,8 @@ function convertEntryToPutEntry(entry) {
       _id: entry.entry._id,
       _name: entry.entry._name,
       _slug: entry.entry._slug,
-      fields: entry.entry.fields
+      fields: entry.entry.fields,
+      _locales: entry.entry._locales
     },
     state: entry.state,
     projectId: entry.projectId
@@ -2587,6 +2668,8 @@ export {
   IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM,
   IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
   IS_RENDERED_BY_UNIFORM_ATTRIBUTE,
+  LOCALE_DYNAMIC_INPUT_NAME,
+  LocaleClient,
   PLACEHOLDER_ID,
   PromptClient,
   RouteClient,

package/dist/index.js

@@ -286,7 +286,7 @@ __export(src_exports, {
   ATTRIBUTE_PARAMETER_TYPE: () => ATTRIBUTE_PARAMETER_TYPE,
   ATTRIBUTE_PARAMETER_VALUE: () => ATTRIBUTE_PARAMETER_VALUE,
   ATTRIBUTE_PLACEHOLDER: () => ATTRIBUTE_PLACEHOLDER,
-  ApiClientError: () => import_api10.ApiClientError,
+  ApiClientError: () => import_api11.ApiClientError,
   BatchEntry: () => BatchEntry,
   CANVAS_BLOCK_PARAM_TYPE: () => CANVAS_BLOCK_PARAM_TYPE,
   CANVAS_DRAFT_STATE: () => CANVAS_DRAFT_STATE,
@@ -323,6 +323,8 @@ __export(src_exports, {
   IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM: () => IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM,
   IN_CONTEXT_EDITOR_QUERY_STRING_PARAM: () => IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
   IS_RENDERED_BY_UNIFORM_ATTRIBUTE: () => IS_RENDERED_BY_UNIFORM_ATTRIBUTE,
+  LOCALE_DYNAMIC_INPUT_NAME: () => LOCALE_DYNAMIC_INPUT_NAME,
+  LocaleClient: () => LocaleClient,
   PLACEHOLDER_ID: () => PLACEHOLDER_ID,
   PromptClient: () => PromptClient,
   RouteClient: () => RouteClient,
@@ -1765,23 +1767,31 @@ function extractLocales({ component }) {
   });
   return variations;
 }
-function localize({
-  composition,
-  locale
-}) {
-  walkNodeTree(composition, ({ type, node, actions }) => {
+function localize(options) {
+  const nodes = "nodes" in options ? options.nodes : options.composition;
+  const locale = options.locale;
+  walkNodeTree(nodes, ({ type, node, actions }) => {
     if (type !== "component") {
-      actions.stopProcessingDescendants();
+      if (typeof locale === "string") {
+        localizeProperties(node.fields, locale);
+      }
       return;
     }
+    const shouldRunPropertyLocalization = typeof locale === "string";
     if (node.type === CANVAS_LOCALIZATION_TYPE) {
       const locales = extractLocales({ component: node });
-      const resolvedLocale = typeof locale === "string" ? locale : locale({ component: node, locales });
+      const resolvedLocale = typeof locale === "string" ? locale : locale == null ? void 0 : locale({ component: node, locales });
       let replaceComponent;
       if (resolvedLocale) {
         replaceComponent = locales[resolvedLocale];
       }
       if (replaceComponent == null ? void 0 : replaceComponent.length) {
+        replaceComponent.forEach((component) => {
+          removeLocaleProperty(component);
+          if (shouldRunPropertyLocalization) {
+            localizeProperties(getPropertiesValue(component), locale);
+          }
+        });
         const [first, ...rest] = replaceComponent;
         actions.replace(first);
         if (rest.length) {
@@ -1790,6 +1800,42 @@ function localize({
       } else {
         actions.remove();
       }
+    } else if (shouldRunPropertyLocalization) {
+      localizeProperties(getPropertiesValue(node), locale);
+    }
+  });
+}
+function removeLocaleProperty(component) {
+  const properties = getPropertiesValue(component);
+  const localeTagProperty = properties == null ? void 0 : properties[CANVAS_LOCALE_TAG_PARAM];
+  if (localeTagProperty) {
+    delete properties[CANVAS_LOCALE_TAG_PARAM];
+  }
+  if (properties && Object.keys(properties).length === 0) {
+    if ("fields" in component) {
+      delete component.fields;
+    }
+    if ("parameters" in component) {
+      delete component.parameters;
+    }
+  }
+}
+function localizeProperties(properties, locale) {
+  if (!properties) {
+    return void 0;
+  }
+  Object.entries(properties).forEach(([key, property]) => {
+    var _a;
+    if (!locale) {
+      delete property.locales;
+    }
+    const currentLocaleValue = locale ? (_a = property.locales) == null ? void 0 : _a[locale] : void 0;
+    if (currentLocaleValue !== void 0) {
+      property.value = currentLocaleValue;
+    }
+    delete property.locales;
+    if (property.value === void 0) {
+      delete properties[key];
     }
   });
 }
@@ -1939,6 +1985,39 @@ function walkComponentTree(component, visitor, initialContext) {
   } while (componentQueue.length > 0);
 }
 
+// src/LocaleClient.ts
+var import_api8 = require("@uniformdev/context/api");
+var localesUrl = "/api/v1/locales";
+var LocaleClient = class extends import_api8.ApiClient {
+  constructor(options) {
+    super(options);
+  }
+  /** Fetches all locales for a project */
+  async get(options) {
+    const { projectId } = this.options;
+    const fetchUri = this.createUrl(localesUrl, { ...options, projectId });
+    return await this.apiClient(fetchUri);
+  }
+  /** Updates or creates (based on id) a locale */
+  async upsert(body) {
+    const fetchUri = this.createUrl(localesUrl);
+    await this.apiClient(fetchUri, {
+      method: "PUT",
+      body: JSON.stringify({ ...body, projectId: this.options.projectId }),
+      expectNoContent: true
+    });
+  }
+  /** Deletes a locale */
+  async remove(body) {
+    const fetchUri = this.createUrl(localesUrl);
+    await this.apiClient(fetchUri, {
+      method: "DELETE",
+      body: JSON.stringify({ ...body, projectId: this.options.projectId }),
+      expectNoContent: true
+    });
+  }
+};
+
 // src/utils/hash.ts
 var generateHash = ({
   composition,
@@ -2296,9 +2375,9 @@ function subscribeToComposition({
 }
 
 // src/PromptClient.ts
-var import_api8 = require("@uniformdev/context/api");
+var import_api9 = require("@uniformdev/context/api");
 var PromptsUrl = "/api/v1/prompts";
-var PromptClient = class extends import_api8.ApiClient {
+var PromptClient = class extends import_api9.ApiClient {
   constructor(options) {
     super(options);
   }
@@ -2329,9 +2408,9 @@ var PromptClient = class extends import_api8.ApiClient {
 };
 
 // src/RouteClient.ts
-var import_api9 = require("@uniformdev/context/api");
+var import_api10 = require("@uniformdev/context/api");
 var ROUTE_URL = "/api/v1/route";
-var RouteClient = class extends import_api9.ApiClient {
+var RouteClient = class extends import_api10.ApiClient {
   constructor(options) {
     var _a;
     if (!options.limitPolicy) {
@@ -2348,6 +2427,9 @@ var RouteClient = class extends import_api9.ApiClient {
   }
 };
 
+// src/types/locales.ts
+var LOCALE_DYNAMIC_INPUT_NAME = "locale";
+
 // src/utils/createApiEnhancer.ts
 var createUniformApiEnhancer = ({ apiUrl }) => {
   return async (message) => {
@@ -2379,7 +2461,8 @@ function convertEntryToPutEntry(entry) {
       _id: entry.entry._id,
       _name: entry.entry._name,
       _slug: entry.entry._slug,
-      fields: entry.entry.fields
+      fields: entry.entry.fields,
+      _locales: entry.entry._locales
     },
     state: entry.state,
     projectId: entry.projectId
@@ -2663,8 +2746,8 @@ function handleRichTextNodeBinding(object, options) {
 }
 
 // src/index.ts
-var import_api10 = require("@uniformdev/context/api");
-var CanvasClientError = import_api10.ApiClientError;
+var import_api11 = require("@uniformdev/context/api");
+var CanvasClientError = import_api11.ApiClientError;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ASSETS_SOURCE_CUSTOM_URL,
@@ -2713,6 +2796,8 @@ var CanvasClientError = import_api10.ApiClientError;
   IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM,
   IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
   IS_RENDERED_BY_UNIFORM_ATTRIBUTE,
+  LOCALE_DYNAMIC_INPUT_NAME,
+  LocaleClient,
   PLACEHOLDER_ID,
   PromptClient,
   RouteClient,

package/dist/index.mjs

@@ -1640,23 +1640,31 @@ function extractLocales({ component }) {
   });
   return variations;
 }
-function localize({
-  composition,
-  locale
-}) {
-  walkNodeTree(composition, ({ type, node, actions }) => {
+function localize(options) {
+  const nodes = "nodes" in options ? options.nodes : options.composition;
+  const locale = options.locale;
+  walkNodeTree(nodes, ({ type, node, actions }) => {
     if (type !== "component") {
-      actions.stopProcessingDescendants();
+      if (typeof locale === "string") {
+        localizeProperties(node.fields, locale);
+      }
       return;
     }
+    const shouldRunPropertyLocalization = typeof locale === "string";
     if (node.type === CANVAS_LOCALIZATION_TYPE) {
       const locales = extractLocales({ component: node });
-      const resolvedLocale = typeof locale === "string" ? locale : locale({ component: node, locales });
+      const resolvedLocale = typeof locale === "string" ? locale : locale == null ? void 0 : locale({ component: node, locales });
       let replaceComponent;
       if (resolvedLocale) {
         replaceComponent = locales[resolvedLocale];
       }
       if (replaceComponent == null ? void 0 : replaceComponent.length) {
+        replaceComponent.forEach((component) => {
+          removeLocaleProperty(component);
+          if (shouldRunPropertyLocalization) {
+            localizeProperties(getPropertiesValue(component), locale);
+          }
+        });
         const [first, ...rest] = replaceComponent;
         actions.replace(first);
         if (rest.length) {
@@ -1665,6 +1673,42 @@ function localize({
       } else {
         actions.remove();
       }
+    } else if (shouldRunPropertyLocalization) {
+      localizeProperties(getPropertiesValue(node), locale);
+    }
+  });
+}
+function removeLocaleProperty(component) {
+  const properties = getPropertiesValue(component);
+  const localeTagProperty = properties == null ? void 0 : properties[CANVAS_LOCALE_TAG_PARAM];
+  if (localeTagProperty) {
+    delete properties[CANVAS_LOCALE_TAG_PARAM];
+  }
+  if (properties && Object.keys(properties).length === 0) {
+    if ("fields" in component) {
+      delete component.fields;
+    }
+    if ("parameters" in component) {
+      delete component.parameters;
+    }
+  }
+}
+function localizeProperties(properties, locale) {
+  if (!properties) {
+    return void 0;
+  }
+  Object.entries(properties).forEach(([key, property]) => {
+    var _a;
+    if (!locale) {
+      delete property.locales;
+    }
+    const currentLocaleValue = locale ? (_a = property.locales) == null ? void 0 : _a[locale] : void 0;
+    if (currentLocaleValue !== void 0) {
+      property.value = currentLocaleValue;
+    }
+    delete property.locales;
+    if (property.value === void 0) {
+      delete properties[key];
     }
   });
 }
@@ -1814,6 +1858,39 @@ function walkComponentTree(component, visitor, initialContext) {
   } while (componentQueue.length > 0);
 }
 
+// src/LocaleClient.ts
+import { ApiClient as ApiClient7 } from "@uniformdev/context/api";
+var localesUrl = "/api/v1/locales";
+var LocaleClient = class extends ApiClient7 {
+  constructor(options) {
+    super(options);
+  }
+  /** Fetches all locales for a project */
+  async get(options) {
+    const { projectId } = this.options;
+    const fetchUri = this.createUrl(localesUrl, { ...options, projectId });
+    return await this.apiClient(fetchUri);
+  }
+  /** Updates or creates (based on id) a locale */
+  async upsert(body) {
+    const fetchUri = this.createUrl(localesUrl);
+    await this.apiClient(fetchUri, {
+      method: "PUT",
+      body: JSON.stringify({ ...body, projectId: this.options.projectId }),
+      expectNoContent: true
+    });
+  }
+  /** Deletes a locale */
+  async remove(body) {
+    const fetchUri = this.createUrl(localesUrl);
+    await this.apiClient(fetchUri, {
+      method: "DELETE",
+      body: JSON.stringify({ ...body, projectId: this.options.projectId }),
+      expectNoContent: true
+    });
+  }
+};
+
 // src/utils/hash.ts
 var generateHash = ({
   composition,
@@ -2171,9 +2248,9 @@ function subscribeToComposition({
 }
 
 // src/PromptClient.ts
-import { ApiClient as ApiClient7 } from "@uniformdev/context/api";
+import { ApiClient as ApiClient8 } from "@uniformdev/context/api";
 var PromptsUrl = "/api/v1/prompts";
-var PromptClient = class extends ApiClient7 {
+var PromptClient = class extends ApiClient8 {
   constructor(options) {
     super(options);
   }
@@ -2204,9 +2281,9 @@ var PromptClient = class extends ApiClient7 {
 };
 
 // src/RouteClient.ts
-import { ApiClient as ApiClient8 } from "@uniformdev/context/api";
+import { ApiClient as ApiClient9 } from "@uniformdev/context/api";
 var ROUTE_URL = "/api/v1/route";
-var RouteClient = class extends ApiClient8 {
+var RouteClient = class extends ApiClient9 {
   constructor(options) {
     var _a;
     if (!options.limitPolicy) {
@@ -2223,6 +2300,9 @@ var RouteClient = class extends ApiClient8 {
   }
 };
 
+// src/types/locales.ts
+var LOCALE_DYNAMIC_INPUT_NAME = "locale";
+
 // src/utils/createApiEnhancer.ts
 var createUniformApiEnhancer = ({ apiUrl }) => {
   return async (message) => {
@@ -2254,7 +2334,8 @@ function convertEntryToPutEntry(entry) {
       _id: entry.entry._id,
       _name: entry.entry._name,
       _slug: entry.entry._slug,
-      fields: entry.entry.fields
+      fields: entry.entry.fields,
+      _locales: entry.entry._locales
     },
     state: entry.state,
     projectId: entry.projectId
@@ -2587,6 +2668,8 @@ export {
   IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM,
   IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
   IS_RENDERED_BY_UNIFORM_ATTRIBUTE,
+  LOCALE_DYNAMIC_INPUT_NAME,
+  LocaleClient,
   PLACEHOLDER_ID,
   PromptClient,
   RouteClient,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/canvas",
-  "version": "19.88.0",
+  "version": "19.89.0",
   "description": "Common functionality and types for Uniform Canvas",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -38,8 +38,8 @@
     "pusher-js": "8.2.0"
   },
   "dependencies": {
-    "@uniformdev/assets": "19.88.0",
-    "@uniformdev/context": "19.88.0",
+    "@uniformdev/assets": "19.89.0",
+    "@uniformdev/context": "19.89.0",
     "immer": "10.0.3"
   },
   "files": [
@@ -48,5 +48,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "0a02f919a6b0f0c41307f120adada2e5d45a947b"
+  "gitHead": "247189fb1039d0f81498949534646baaffb8bca7"
 }