datocms-plugin-sdk 2.0.4 → 2.0.5

package/dist/esm/hooks/itemFormSidebarPanels.js

@@ -1,2 +1,17 @@
-export {};
+import { isBoolean, isNullish, isNumber, isPlacement, isRecord, isString, } from '../guardUtils.js';
+/**
+ * Checks if the given value is an ItemFormSidebarPanel.
+ * @param value - The value to check.
+ * @returns True if the value is an ItemFormSidebarPanel, false otherwise.
+ */
+export function isItemFormSidebarPanel(value) {
+    return (isRecord(value) &&
+        isString(value.id) &&
+        isString(value.label) &&
+        (isNullish(value.parameters) || isRecord(value.parameters)) &&
+        (isNullish(value.startOpen) || isBoolean(value.startOpen)) &&
+        (isNullish(value.placement) || isPlacement(value.placement)) &&
+        (isNullish(value.rank) || isNumber(value.rank)) &&
+        (isNullish(value.initialHeight) || isNumber(value.initialHeight)));
+}
 //# sourceMappingURL=itemFormSidebarPanels.js.map

package/dist/esm/hooks/itemFormSidebarPanels.js.map

@@ -1 +1 @@
-{"version":3,"file":"itemFormSidebarPanels.js","sourceRoot":"","sources":["../../../src/hooks/itemFormSidebarPanels.ts"],"names":[],"mappings":""}
+{"version":3,"file":"itemFormSidebarPanels.js","sourceRoot":"","sources":["../../../src/hooks/itemFormSidebarPanels.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,SAAS,EACT,SAAS,EACT,QAAQ,EACR,WAAW,EACX,QAAQ,EACR,QAAQ,GACT,MAAM,kBAAkB,CAAC;AA4D1B;;;;GAIG;AACH,MAAM,UAAU,sBAAsB,CACpC,KAAc;IAEd,OAAO,CACL,QAAQ,CAAC,KAAK,CAAC;QACf,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAClB,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC;QACrB,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC3D,CAAC,SAAS,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC1D,CAAC,SAAS,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,WAAW,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC5D,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC/C,CAAC,SAAS,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAClE,CAAC;AACJ,CAAC"}

package/dist/esm/hooks/itemFormSidebars.d.ts

@@ -11,6 +11,12 @@ export type ItemFormSidebarsHook = {
     itemFormSidebars: (itemType: ItemType, ctx: ItemFormSidebarsCtx) => ItemFormSidebar[];
 };
 export type ItemFormSidebarsCtx = Ctx;
+/**
+ * An object expressing a sidebar to be shown when the user edits
+ * records of a particular model
+ *
+ * @see {isItemFormSidebar}
+ */
 export type ItemFormSidebar = {
     /**
      * ID of the sidebar. Will be the first argument for the
@@ -35,4 +41,10 @@ export type ItemFormSidebar = {
     /** The preferred width for the sidebar */
     preferredWidth?: number;
 };
+/**
+ * Type guard to check if the value is an ItemFormSidebar.
+ * @param value - The value to check.
+ * @returns true if the value is an ItemFormSidebar, false otherwise.
+ */
+export declare function isItemFormSidebar(value: unknown): value is ItemFormSidebar;
 export {};

package/dist/esm/hooks/itemFormSidebars.js

@@ -1,2 +1,15 @@
-export {};
+import { isNullish, isNumber, isRecord, isString } from '../guardUtils.js';
+/**
+ * Type guard to check if the value is an ItemFormSidebar.
+ * @param value - The value to check.
+ * @returns true if the value is an ItemFormSidebar, false otherwise.
+ */
+export function isItemFormSidebar(value) {
+    return (isRecord(value) &&
+        isString(value.id) &&
+        isString(value.label) &&
+        (isNullish(value.parameters) || isRecord(value.parameters)) &&
+        (isNullish(value.rank) || isNumber(value.rank)) &&
+        (isNullish(value.preferredWidth) || isNumber(value.preferredWidth)));
+}
 //# sourceMappingURL=itemFormSidebars.js.map

package/dist/esm/hooks/itemFormSidebars.js.map

@@ -1 +1 @@
-{"version":3,"file":"itemFormSidebars.js","sourceRoot":"","sources":["../../../src/hooks/itemFormSidebars.ts"],"names":[],"mappings":""}
+{"version":3,"file":"itemFormSidebars.js","sourceRoot":"","sources":["../../../src/hooks/itemFormSidebars.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAkD3E;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAAc;IAC9C,OAAO,CACL,QAAQ,CAAC,KAAK,CAAC;QACf,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAClB,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC;QACrB,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC3D,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC/C,CAAC,SAAS,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CACpE,CAAC;AACJ,CAAC"}

package/dist/esm/hooks/mainNavigationTabs.d.ts

@@ -10,7 +10,11 @@ export type MainNavigationTabsHook = {
     mainNavigationTabs: (ctx: MainNavigationTabsCtx) => MainNavigationTab[];
 };
 export type MainNavigationTabsCtx = Ctx;
-/** A tab to be displayed in the top-bar of the UI */
+/**
+ * An object expressing a tab to be displayed in the top-bar of the UI
+ *
+ * @see {isMainNavigationTab}
+ */
 export type MainNavigationTab = {
     /** Label to be shown. Must be unique. */
     label: string;
@@ -42,3 +46,9 @@ export type MainNavigationTab = {
      */
     rank?: number;
 };
+/**
+ * Checks if the given value is a MainNavigationTab.
+ * @param value The value to check.
+ * @returns True if the value is a MainNavigationTab, false otherwise.
+ */
+export declare function isMainNavigationTab(value: unknown): value is MainNavigationTab;

package/dist/esm/hooks/mainNavigationTabs.js

@@ -1,2 +1,17 @@
-export {};
+import { isNullish, isNumber, isPlacement, isRecord, isString, } from '../guardUtils.js';
+import { isIcon } from '../icon';
+/**
+ * Checks if the given value is a MainNavigationTab.
+ * @param value The value to check.
+ * @returns True if the value is a MainNavigationTab, false otherwise.
+ */
+export function isMainNavigationTab(value) {
+    return (isRecord(value) &&
+        isString(value.label) &&
+        isIcon(value.icon) &&
+        isRecord(value.pointsTo) &&
+        isString(value.pointsTo.pageId) &&
+        (isNullish(value.placement) || isPlacement(value.placement)) &&
+        (isNullish(value.rank) || isNumber(value.rank)));
+}
 //# sourceMappingURL=mainNavigationTabs.js.map

package/dist/esm/hooks/mainNavigationTabs.js.map

@@ -1 +1 @@
-{"version":3,"file":"mainNavigationTabs.js","sourceRoot":"","sources":["../../../src/hooks/mainNavigationTabs.ts"],"names":[],"mappings":""}
+{"version":3,"file":"mainNavigationTabs.js","sourceRoot":"","sources":["../../../src/hooks/mainNavigationTabs.ts"],"names":[],"mappings":"AACA,OAAO,EACL,SAAS,EACT,QAAQ,EACR,WAAW,EACX,QAAQ,EACR,QAAQ,GACT,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAQ,MAAM,EAAE,MAAM,SAAS,CAAC;AAmDvC;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CACjC,KAAc;IAEd,OAAO,CACL,QAAQ,CAAC,KAAK,CAAC;QACf,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC;QACrB,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;QAClB,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC;QACxB,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC;QAC/B,CAAC,SAAS,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,WAAW,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC5D,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAChD,CAAC;AACJ,CAAC"}

package/dist/esm/hooks/manualFieldExtensions.d.ts

@@ -9,6 +9,12 @@ export type ManualFieldExtensionsHook = {
     manualFieldExtensions: (ctx: ManualFieldExtensionsCtx) => ManualFieldExtension[];
 };
 export type ManualFieldExtensionsCtx = Ctx;
+/**
+ * An object expressing a field extension that users will be able
+ * to install manually in some field
+ *
+ * @see {isManualFieldExtension}
+ */
 export type ManualFieldExtension = {
     /**
      * ID of field extension. Will be the first argument for the
@@ -57,3 +63,9 @@ export type ManualFieldExtension = {
  */
 export type FieldExtensionType = 'editor' | 'addon';
 export type FieldType = 'boolean' | 'color' | 'date_time' | 'date' | 'file' | 'float' | 'gallery' | 'integer' | 'json' | 'lat_lon' | 'link' | 'links' | 'rich_text' | 'seo' | 'slug' | 'string' | 'structured_text' | 'text' | 'video';
+/**
+ * Checks if the provided value is a ManualFieldExtension.
+ * @param value - The value to check.
+ * @returns True if the value is a ManualFieldExtension, otherwise false.
+ */
+export declare function isManualFieldExtension(value: unknown): value is ManualFieldExtension;

package/dist/esm/hooks/manualFieldExtensions.js

@@ -1,2 +1,25 @@
-export {};
+import { isArray, isBoolean, isNullish, isNumber, isRecord, isString, } from '../guardUtils.js';
+/**
+ * Checks if the provided value is a ManualFieldExtension.
+ * @param value - The value to check.
+ * @returns True if the value is a ManualFieldExtension, otherwise false.
+ */
+export function isManualFieldExtension(value) {
+    return (isRecord(value) &&
+        isString(value.id) &&
+        isString(value.name) &&
+        isString(value.type) &&
+        ['editor', 'addon'].includes(value.type) &&
+        (isNullish(value.asSidebarPanel) ||
+            isBoolean(value.asSidebarPanel) ||
+            (isRecord(value.asSidebarPanel) &&
+                isBoolean(value.asSidebarPanel.startOpen))) &&
+        ((isString(value.fieldTypes) && value.fieldTypes === 'all') ||
+            isArray(value.fieldTypes, isString)) &&
+        (isNullish(value.configurable) ||
+            isBoolean(value.configurable) ||
+            (isRecord(value.configurable) &&
+                isNumber(value.configurable.initialHeight))) &&
+        (isNullish(value.initialHeight) || isNumber(value.initialHeight)));
+}
 //# sourceMappingURL=manualFieldExtensions.js.map

package/dist/esm/hooks/manualFieldExtensions.js.map

@@ -1 +1 @@
-{"version":3,"file":"manualFieldExtensions.js","sourceRoot":"","sources":["../../../src/hooks/manualFieldExtensions.ts"],"names":[],"mappings":""}
+{"version":3,"file":"manualFieldExtensions.js","sourceRoot":"","sources":["../../../src/hooks/manualFieldExtensions.ts"],"names":[],"mappings":"AACA,OAAO,EACL,OAAO,EACP,SAAS,EACT,SAAS,EACT,QAAQ,EACR,QAAQ,EACR,QAAQ,GACT,MAAM,kBAAkB,CAAC;AAyF1B;;;;GAIG;AACH,MAAM,UAAU,sBAAsB,CACpC,KAAc;IAEd,OAAO,CACL,QAAQ,CAAC,KAAK,CAAC;QACf,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAClB,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC;QACpB,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC;QACpB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC;QACxC,CAAC,SAAS,CAAC,KAAK,CAAC,cAAc,CAAC;YAC9B,SAAS,CAAC,KAAK,CAAC,cAAc,CAAC;YAC/B,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC;gBAC7B,SAAS,CAAC,KAAK,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,CAAC;QAC/C,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,KAAK,CAAC,UAAU,KAAK,KAAK,CAAC;YACzD,OAAO,CAAC,KAAK,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QACtC,CAAC,SAAS,CAAC,KAAK,CAAC,YAAY,CAAC;YAC5B,SAAS,CAAC,KAAK,CAAC,YAAY,CAAC;YAC7B,CAAC,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC;gBAC3B,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC;QAChD,CAAC,SAAS,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAClE,CAAC;AACJ,CAAC"}

package/dist/esm/hooks/overrideFieldExtensions.d.ts

@@ -18,6 +18,8 @@ export type OverrideFieldExtensionsCtx = Ctx<{
 /**
  * An object expressing some field extensions you want to force on a particular
  * field
+ *
+ * @see {isFieldExtensionOverride}
  */
 export type FieldExtensionOverride = {
     /** Force a field editor/sidebar extension on a field */
@@ -85,4 +87,22 @@ export type AddonOverride = {
      */
     initialHeight?: number;
 };
+/**
+ * Checks if the value is a FieldExtensionOverride.
+ * @param value The value to check.
+ * @returns True if the value is a FieldExtensionOverride, false otherwise.
+ */
+export declare function isFieldExtensionOverride(value: unknown): value is FieldExtensionOverride;
+/**
+ * Checks if the value is an EditorOverride.
+ * @param value The value to check.
+ * @returns True if the value is an EditorOverride, false otherwise.
+ */
+export declare function isEditorOverride(value: unknown): value is EditorOverride;
+/**
+ * Checks if the value is an AddonOverride.
+ * @param value The value to check.
+ * @returns True if the value is an AddonOverride, false otherwise.
+ */
+export declare function isAddonOverride(value: unknown): value is AddonOverride;
 export {};

package/dist/esm/hooks/overrideFieldExtensions.js

@@ -1,2 +1,44 @@
-export {};
+import { isArray, isBoolean, isNullish, isNumber, isPlacement, isRecord, isString, } from '../guardUtils.js';
+/**
+ * Checks if the value is a FieldExtensionOverride.
+ * @param value The value to check.
+ * @returns True if the value is a FieldExtensionOverride, false otherwise.
+ */
+export function isFieldExtensionOverride(value) {
+    return (isNullish(value) ||
+        (isRecord(value) &&
+            (isNullish(value.editor) || isEditorOverride(value.editor)) &&
+            (isNullish(value.addons) || isArray(value.addons, isAddonOverride))));
+}
+/**
+ * Checks if the value is an EditorOverride.
+ * @param value The value to check.
+ * @returns True if the value is an EditorOverride, false otherwise.
+ */
+export function isEditorOverride(value) {
+    return (isRecord(value) &&
+        isString(value.id) &&
+        (isNullish(value.asSidebarPanel) ||
+            isBoolean(value.asSidebarPanel) ||
+            (isRecord(value.asSidebarPanel) &&
+                (isNullish(value.asSidebarPanel.startOpen) ||
+                    isBoolean(value.asSidebarPanel.startOpen)) &&
+                (isNullish(value.asSidebarPanel.placement) ||
+                    isPlacement(value.asSidebarPanel.placement)))) &&
+        (isNullish(value.parameters) || isRecord(value.parameters)) &&
+        (isNullish(value.rank) || isNumber(value.rank)) &&
+        (isNullish(value.initialHeight) || isNumber(value.initialHeight)));
+}
+/**
+ * Checks if the value is an AddonOverride.
+ * @param value The value to check.
+ * @returns True if the value is an AddonOverride, false otherwise.
+ */
+export function isAddonOverride(value) {
+    return (isRecord(value) &&
+        isString(value.id) &&
+        (isNullish(value.parameters) || isRecord(value.parameters)) &&
+        (isNullish(value.rank) || isNumber(value.rank)) &&
+        (isNullish(value.initialHeight) || isNumber(value.initialHeight)));
+}
 //# sourceMappingURL=overrideFieldExtensions.js.map

package/dist/esm/hooks/overrideFieldExtensions.js.map

@@ -1 +1 @@
-{"version":3,"file":"overrideFieldExtensions.js","sourceRoot":"","sources":["../../../src/hooks/overrideFieldExtensions.ts"],"names":[],"mappings":""}
+{"version":3,"file":"overrideFieldExtensions.js","sourceRoot":"","sources":["../../../src/hooks/overrideFieldExtensions.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,OAAO,EACP,SAAS,EACT,SAAS,EACT,QAAQ,EACR,WAAW,EACX,QAAQ,EACR,QAAQ,GACT,MAAM,kBAAkB,CAAC;AAiG1B;;;;GAIG;AACH,MAAM,UAAU,wBAAwB,CACtC,KAAc;IAEd,OAAO,CACL,SAAS,CAAC,KAAK,CAAC;QAChB,CAAC,QAAQ,CAAC,KAAK,CAAC;YACd,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,gBAAgB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAC3D,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,CACvE,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAc;IAC7C,OAAO,CACL,QAAQ,CAAC,KAAK,CAAC;QACf,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAClB,CAAC,SAAS,CAAC,KAAK,CAAC,cAAc,CAAC;YAC9B,SAAS,CAAC,KAAK,CAAC,cAAc,CAAC;YAC/B,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC;gBAC7B,CAAC,SAAS,CAAC,KAAK,CAAC,cAAc,CAAC,SAAS,CAAC;oBACxC,SAAS,CAAC,KAAK,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;gBAC5C,CAAC,SAAS,CAAC,KAAK,CAAC,cAAc,CAAC,SAAS,CAAC;oBACxC,WAAW,CAAC,KAAK,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QACpD,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC3D,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC/C,CAAC,SAAS,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAClE,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAC,KAAc;IAC5C,OAAO,CACL,QAAQ,CAAC,KAAK,CAAC;QACf,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAClB,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC3D,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC/C,CAAC,SAAS,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAClE,CAAC;AACJ,CAAC"}

package/dist/esm/hooks/uploadSidebarPanels.d.ts

@@ -9,6 +9,12 @@ export type UploadSidebarPanelsHook = {
     uploadSidebarPanels: (ctx: UploadSidebarPanelsCtx) => UploadSidebarPanel[];
 };
 export type UploadSidebarPanelsCtx = Ctx;
+/**
+ * An object expressing a sidebar panel to be shown when the user
+ * opens up an asset in the Media Area
+ *
+ * @see {isUploadSidebarPanel}
+ */
 export type UploadSidebarPanel = {
     /**
      * ID of the panel. Will be the first argument for the
@@ -46,3 +52,9 @@ export type UploadSidebarPanelPlacement = [
     'before' | 'after',
     ('defaultMetadata' | 'categorization' | 'creator' | 'videoTracks' | 'links' | 'replace')
 ];
+/**
+ * Type guard for UploadSidebarPanel
+ * @param value - The value to check
+ * @returns True if the value is an UploadSidebarPanel
+ */
+export declare function isUploadSidebarPanel(value: unknown): value is UploadSidebarPanel;

package/dist/esm/hooks/uploadSidebarPanels.js

@@ -1,2 +1,17 @@
-export {};
+import { isBoolean, isNullish, isNumber, isPlacement, isRecord, isString, } from '../guardUtils.js';
+/**
+ * Type guard for UploadSidebarPanel
+ * @param value - The value to check
+ * @returns True if the value is an UploadSidebarPanel
+ */
+export function isUploadSidebarPanel(value) {
+    return (isRecord(value) &&
+        isString(value.id) &&
+        isString(value.label) &&
+        (isNullish(value.parameters) || isRecord(value.parameters)) &&
+        (isNullish(value.startOpen) || isBoolean(value.startOpen)) &&
+        (isNullish(value.placement) || isPlacement(value.placement)) &&
+        (isNullish(value.rank) || isNumber(value.rank)) &&
+        (isNullish(value.initialHeight) || isNumber(value.initialHeight)));
+}
 //# sourceMappingURL=uploadSidebarPanels.js.map

package/dist/esm/hooks/uploadSidebarPanels.js.map

@@ -1 +1 @@
-{"version":3,"file":"uploadSidebarPanels.js","sourceRoot":"","sources":["../../../src/hooks/uploadSidebarPanels.ts"],"names":[],"mappings":""}
+{"version":3,"file":"uploadSidebarPanels.js","sourceRoot":"","sources":["../../../src/hooks/uploadSidebarPanels.ts"],"names":[],"mappings":"AACA,OAAO,EACL,SAAS,EACT,SAAS,EACT,QAAQ,EACR,WAAW,EACX,QAAQ,EACR,QAAQ,GACT,MAAM,kBAAkB,CAAC;AAkE1B;;;;GAIG;AACH,MAAM,UAAU,oBAAoB,CAClC,KAAc;IAEd,OAAO,CACL,QAAQ,CAAC,KAAK,CAAC;QACf,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAClB,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC;QACrB,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC3D,CAAC,SAAS,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC1D,CAAC,SAAS,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,WAAW,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC5D,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC/C,CAAC,SAAS,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAClE,CAAC;AACJ,CAAC"}

package/dist/esm/hooks/uploadSidebars.d.ts

@@ -9,6 +9,12 @@ export type UploadSidebarsHook = {
     uploadSidebars: (ctx: UploadSidebarsCtx) => UploadSidebar[];
 };
 export type UploadSidebarsCtx = Ctx;
+/**
+ * An object expressing a sidebar to be shown when the user opens
+ * up an asset in the Media Area
+ *
+ * @see {isUploadSidebar}
+ */
 export type UploadSidebar = {
     /**
      * ID of the sidebar. Will be the first argument for the
@@ -33,3 +39,9 @@ export type UploadSidebar = {
     /** The preferred width for the sidebar */
     preferredWidth?: number;
 };
+/**
+ * Checks if the provided value is an UploadSidebar.
+ * @param value - The value to check.
+ * @returns True if the value is an UploadSidebar, otherwise false.
+ */
+export declare function isUploadSidebar(value: unknown): value is UploadSidebar;

package/dist/esm/hooks/uploadSidebars.js

@@ -1,2 +1,15 @@
-export {};
+import { isNullish, isNumber, isRecord, isString } from '../guardUtils.js';
+/**
+ * Checks if the provided value is an UploadSidebar.
+ * @param value - The value to check.
+ * @returns True if the value is an UploadSidebar, otherwise false.
+ */
+export function isUploadSidebar(value) {
+    return (isRecord(value) &&
+        isString(value.id) &&
+        isString(value.label) &&
+        (isNullish(value.parameters) || isRecord(value.parameters)) &&
+        (isNullish(value.rank) || isNumber(value.rank)) &&
+        (isNullish(value.preferredWidth) || isNumber(value.preferredWidth)));
+}
 //# sourceMappingURL=uploadSidebars.js.map

package/dist/esm/hooks/uploadSidebars.js.map

@@ -1 +1 @@
-{"version":3,"file":"uploadSidebars.js","sourceRoot":"","sources":["../../../src/hooks/uploadSidebars.ts"],"names":[],"mappings":""}
+{"version":3,"file":"uploadSidebars.js","sourceRoot":"","sources":["../../../src/hooks/uploadSidebars.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AA6C3E;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAC,KAAc;IAC5C,OAAO,CACL,QAAQ,CAAC,KAAK,CAAC;QACf,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAClB,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC;QACrB,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC3D,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC/C,CAAC,SAAS,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CACpE,CAAC;AACJ,CAAC"}