@box/metadata-template-editor 1.19.1 → 1.20.0

package/dist/esm/lib/components/metadata-template-editor-modal/metadata-template-editor-modal.js

@@ -37,10 +37,10 @@ function re({
     a ? i(a) : d.current?.requestClose();
   }, _ = (a) => {
     g(a.displayName), C?.(a);
-  }, M = (a) => async (x) => {
+  }, M = (a) => async (...x) => {
     y(!0);
     try {
-      await a(x), i(!1);
+      await a(...x), i(!1);
     } finally {
       y(!1);
     }

package/dist/esm/lib/metadata-template-editor.js

@@ -1,4 +1,4 @@
-import { forwardRef as W, useState as n, useCallback as L, useImperativeHandle as G, useEffect as N, useMemo as Q } from "react";
+import { forwardRef as Q, useState as n, useCallback as b, useImperativeHandle as W, useEffect as L, useMemo as G } from "react";
 import { Formik as X } from "formik";
 import { useIntl as Y } from "react-intl";
 import { useNotification as Z, LoadingIndicator as $, EmptyState as M, Text as P } from "@box/blueprint-web";
@@ -23,54 +23,54 @@ import '../../styles/metadata-template-editor.css';const fe = "_loading_1o2vk_8"
   templateKey: "",
   fields: [],
   hidden: !1
-}, Ue = /* @__PURE__ */ W(function({
-  onCancel: d,
-  onDirtyStateChange: u,
-  onValidationChange: I,
-  onSubmitError: S,
-  onTemplateLoad: h,
-  taxonomyOptions: F,
-  fetchTaxonomies: _,
-  formId: B,
-  hideActions: K = !1,
+}, Ue = /* @__PURE__ */ Q(function({
+  onCancel: m,
+  onDirtyStateChange: h,
+  onValidationChange: F,
+  onSubmitError: I,
+  onTemplateLoad: y,
+  taxonomyOptions: S,
+  fetchTaxonomies: K,
+  formId: _,
+  hideActions: B = !1,
   fieldExtensions: U,
   ...l
 }, w) {
   const x = oe(), {
     formatMessage: t
   } = Y(), {
-    addNotification: y
-  } = Z(), c = l.mode === ae.Edit, [g, k] = n(!1), [D, m] = n(!1), f = L(() => {
-    g ? m(!0) : d?.();
-  }, [g, d]);
-  G(w, () => ({
-    requestClose: f
-  }), [f]);
-  const O = L((e) => {
-    k(e), u?.(e);
-  }, [u]), [V, v] = n(c), [H, C] = n(!1), [R, j] = n(0), [o, T] = n(void 0), p = c ? l.fetchTemplate : void 0, q = () => {
+    addNotification: g
+  } = Z(), c = l.mode === ae.Edit, [v, k] = n(!1), [D, f] = n(!1), p = b(() => {
+    v ? f(!0) : m?.();
+  }, [v, m]);
+  W(w, () => ({
+    requestClose: p
+  }), [p]);
+  const O = b((e) => {
+    k(e), h?.(e);
+  }, [h]), [V, C] = n(c), [H, T] = n(!1), [R, j] = n(0), [o, E] = n(void 0), u = c ? l.fetchTemplate : void 0, q = () => {
     j((e) => e + 1);
   };
-  N(() => {
-    if (!p)
+  L(() => {
+    if (!u)
       return;
     let e = !1;
-    return v(!0), C(!1), T(void 0), (async () => {
+    return C(!0), T(!1), E(void 0), (async () => {
       try {
-        const s = await p();
-        e || T(s);
+        const s = await u();
+        e || E(s);
       } catch {
-        e || C(!0);
+        e || T(!0);
       } finally {
-        e || v(!1);
+        e || C(!1);
       }
     })(), () => {
       e = !0;
     };
-  }, [p, R]), N(() => {
-    o !== void 0 && h?.(o);
-  }, [o, h]);
-  const E = c ? void 0 : l.namespace, b = Q(() => o ? {
+  }, [u, R]), L(() => {
+    o !== void 0 && y?.(o);
+  }, [o, y]);
+  const N = c ? void 0 : l.namespace, d = G(() => o ? {
     displayName: o.displayName,
     templateKey: o.templateKey,
     namespace: o.namespace,
@@ -78,12 +78,15 @@ import '../../styles/metadata-template-editor.css';const fe = "_loading_1o2vk_8"
     fields: o.fields.map((e) => ie(e))
   } : {
     ...ue,
-    namespace: E ?? ""
-  }, [o, E]), z = async (e) => {
+    namespace: N ?? ""
+  }, [o, N]), z = async (e) => {
     try {
       if (c) {
-        const i = se(b, e);
-        await l.onEditTemplate(i);
+        const i = se(d, e);
+        await l.onEditTemplate(i, {
+          namespaceFQN: d.namespace,
+          templateKey: d.templateKey
+        });
       } else {
         const i = re(e.fields), s = {
           namespace: e.namespace,
@@ -94,7 +97,7 @@ import '../../styles/metadata-template-editor.css';const fe = "_loading_1o2vk_8"
         };
         await l.onCreateTemplate(s);
       }
-      y({
+      g({
         sensitivity: "foreground",
         variant: "success",
         styledText: t(a.saveSuccessNotification),
@@ -110,7 +113,7 @@ import '../../styles/metadata-template-editor.css';const fe = "_loading_1o2vk_8"
         s = t(J === ce ? a.displayNameUsedBefore : a.saveErrorNotification);
       } else
         s = t(a.saveErrorNotification);
-      y({
+      g({
         sensitivity: "foreground",
         variant: "error",
         styledText: s,
@@ -118,7 +121,7 @@ import '../../styles/metadata-template-editor.css';const fe = "_loading_1o2vk_8"
         closeButtonAriaLabel: t(a.notificationCloseButtonAriaLabel)
       });
       try {
-        S?.(i);
+        I?.(i);
       } catch {
       }
       throw i;
@@ -147,24 +150,24 @@ import '../../styles/metadata-template-editor.css';const fe = "_loading_1o2vk_8"
     })
   }) : /* @__PURE__ */ de(me, {
     children: [/* @__PURE__ */ r(X, {
-      initialValues: b,
+      initialValues: d,
       validationSchema: x,
       onSubmit: z,
       children: /* @__PURE__ */ r(ne, {
-        formId: B,
-        onCancel: f,
-        taxonomyOptions: F,
-        fetchTaxonomies: _,
-        hideActions: K,
+        formId: _,
+        onCancel: p,
+        taxonomyOptions: S,
+        fetchTaxonomies: K,
+        hideActions: B,
         isEditMode: c,
         onDirtyStateChange: O,
-        onValidationChange: I,
+        onValidationChange: F,
         fieldExtensions: U
       })
     }), D && /* @__PURE__ */ r(le, {
-      onClose: () => m(!1),
+      onClose: () => f(!1),
       onConfirm: () => {
-        m(!1), d?.();
+        f(!1), m?.();
       },
       title: t(a.unsavedChangesTitle),
       body: t(a.unsavedChangesBody),

package/dist/types/lib/components/metadata-template-editor-modal/metadata-template-editor-modal.d.ts

@@ -46,7 +46,7 @@ export type MetadataTemplateEditorModalProps = MetadataTemplateEditorProps & {
  *   open={open}
  *   onOpenChange={setOpen}
  *   fetchTemplate={useCallback(() => api.getTemplate(templateKey), [templateKey])}
- *   onEditTemplate={async patches => { await api.updateTemplate(patches); }}
+ *   onEditTemplate={async (patches, { namespaceFQN, templateKey }) => { await api.updateTemplate(namespaceFQN, templateKey, patches); }}
  *   onSubmitError={err => logger.error('save failed', err)}
  *   title="Edit Template"
  * />

package/dist/types/lib/metadata-template-editor.d.ts

@@ -180,10 +180,15 @@ type EditModeProps = {
     /**
      * Called when the user saves changes to an **existing** template and the form
      * passes all validation. Receives the array of JSON Patch operations that
-     * describe only the changes made since the template was loaded.
+     * describe only the changes made since the template was loaded, and the
+     * `{ namespaceFQN, templateKey }` identifier needed to target the correct
+     * Box API PATCH endpoint (`PUT /metadata_templates/{namespaceFQN}/{templateKey}/schema`).
      * `await` this if you need `isSubmitting` to remain `true` during the API call.
      */
-    onEditTemplate: (patchItems: MetadataTemplatePatchItem[]) => Promise<void> | void;
+    onEditTemplate: (patchItems: MetadataTemplatePatchItem[], identifier: {
+        namespaceFQN: string;
+        templateKey: string;
+    }) => Promise<void> | void;
     onCreateTemplate?: never;
     /**
      * Called once (and re-called whenever the reference changes) to fetch the
@@ -255,7 +260,7 @@ export type MetadataTemplateEditorHandle = {
  * <MetadataTemplateEditor
  *   mode={MetadataTemplateEditorMode.Edit}
  *   fetchTemplate={useCallback(() => api.getTemplate(templateKey), [templateKey])}
- *   onEditTemplate={async patches => { await api.updateTemplate(patches); }}
+ *   onEditTemplate={async (patches, { namespaceFQN, templateKey }) => { await api.updateTemplate(namespaceFQN, templateKey, patches); }}
  *   onCancel={() => navigate(-1)}
  * />
  * ```
@@ -269,7 +274,7 @@ export type MetadataTemplateEditorHandle = {
  * <MetadataTemplateEditor
  *   mode={MetadataTemplateEditorMode.Edit}
  *   fetchTemplate={() => api.getTemplate(templateKey)}
- *   onEditTemplate={async patches => { await api.updateTemplate(patches); }}
+ *   onEditTemplate={async (patches, { namespaceFQN, templateKey }) => { await api.updateTemplate(namespaceFQN, templateKey, patches); }}
  *   onTemplateLoad={t => setPageTitle(t.displayName)}
  *   onDirtyStateChange={setIsDirty}
  *   onValidationChange={setIsFormValid}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@box/metadata-template-editor",
-    "version": "1.19.1",
+    "version": "1.20.0",
     "license": "SEE LICENSE IN LICENSE",
     "peerDependencies": {
         "@box/blueprint-web": "^14.2.0",