datocms-plugin-sdk 2.0.4 → 2.0.6

package/dist/esm/hooks/customBlockStylesForStructuredTextField.js

@@ -1,2 +1,12 @@
-export {};
+import { isArray, isNullish, isNumber, isRecord, isString, } from '../guardUtils.js';
+export function isStructuredTextCustomBlockStyle(value) {
+    return (isRecord(value) &&
+        isString(value.id) &&
+        isString(value.label) &&
+        isString(value.node) &&
+        (isNullish(value.rank) || isNumber(value.rank)));
+}
+export function isReturnTypeOfCustomBlockStylesForStructuredTextFieldHook(value) {
+    return isNullish(value) || isArray(value, isStructuredTextCustomBlockStyle);
+}
 //# sourceMappingURL=customBlockStylesForStructuredTextField.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"customBlockStylesForStructuredTextField.js","sourceRoot":"","sources":["../../../src/hooks/customBlockStylesForStructuredTextField.ts"],"names":[],"mappings":""}
+{"version":3,"file":"customBlockStylesForStructuredTextField.js","sourceRoot":"","sources":["../../../src/hooks/customBlockStylesForStructuredTextField.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,OAAO,EACP,SAAS,EACT,QAAQ,EACR,QAAQ,EACR,QAAQ,GACT,MAAM,kBAAkB,CAAC;AA6C1B,MAAM,UAAU,gCAAgC,CAC9C,KAAc;IAEd,OAAO,CACL,QAAQ,CAAC,KAAK,CAAC;QACf,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAClB,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC;QACrB,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC;QACpB,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAChD,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,yDAAyD,CACvE,KAAc;IAEd,OAAO,SAAS,CAAC,KAAK,CAAC,IAAI,OAAO,CAAC,KAAK,EAAE,gCAAgC,CAAC,CAAC;AAC9E,CAAC"}

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

@@ -15,7 +15,11 @@ export type CustomMarksForStructuredTextFieldHook = {
 export type CustomMarksForStructuredTextFieldCtx = Ctx<{
     itemType: ItemType;
 }>;
-/** An object expressing a custom mark for a Structured Text field */
+/**
+ * An object expressing a custom mark for a Structured Text field
+ *
+ * @see {isStructuredTextCustomMark}
+ */
 export type StructuredTextCustomMark = {
     /** ID of mark */
     id: string;
@@ -54,4 +58,6 @@ export type StructuredTextCustomMarkPlacement = [
     'before' | 'after',
     'strong' | 'emphasis' | 'underline' | 'code' | 'highlight' | 'strikethrough'
 ];
+export declare function isStructuredTextCustomMark(value: unknown): value is StructuredTextCustomMark;
+export declare function isReturnTypeOfCustomMarksForStructuredTextFieldHook(value: unknown): value is StructuredTextCustomMark[] | undefined;
 export {};

package/dist/esm/hooks/customMarksForStructuredTextField.js

@@ -1,2 +1,16 @@
-export {};
+import { isArray, isNullish, isNumber, isPlacement, isRecord, isString, } from '../guardUtils.js';
+import { isIcon } from '../icon';
+export function isStructuredTextCustomMark(value) {
+    return (isRecord(value) &&
+        isString(value.id) &&
+        isString(value.label) &&
+        isIcon(value.icon) &&
+        (isNullish(value.placement) || isPlacement(value.placement)) &&
+        (isNullish(value.rank) || isNumber(value.rank)) &&
+        (isNullish(value.keyboardShortcut) || isString(value.keyboardShortcut)) &&
+        isRecord(value.appliedStyle));
+}
+export function isReturnTypeOfCustomMarksForStructuredTextFieldHook(value) {
+    return isNullish(value) || isArray(value, isStructuredTextCustomMark);
+}
 //# sourceMappingURL=customMarksForStructuredTextField.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"customMarksForStructuredTextField.js","sourceRoot":"","sources":["../../../src/hooks/customMarksForStructuredTextField.ts"],"names":[],"mappings":""}
+{"version":3,"file":"customMarksForStructuredTextField.js","sourceRoot":"","sources":["../../../src/hooks/customMarksForStructuredTextField.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,OAAO,EACP,SAAS,EACT,QAAQ,EACR,WAAW,EACX,QAAQ,EACR,QAAQ,GACT,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAQ,MAAM,EAAE,MAAM,SAAS,CAAC;AAmEvC,MAAM,UAAU,0BAA0B,CACxC,KAAc;IAEd,OAAO,CACL,QAAQ,CAAC,KAAK,CAAC;QACf,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAClB,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC;QACrB,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;QAClB,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,gBAAgB,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;QACvE,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC,CAC7B,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,mDAAmD,CACjE,KAAc;IAEd,OAAO,SAAS,CAAC,KAAK,CAAC,IAAI,OAAO,CAAC,KAAK,EAAE,0BAA0B,CAAC,CAAC;AACxE,CAAC"}

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

@@ -13,6 +13,11 @@ export type InitialLocationQueryForItemSelectorHook = {
     initialLocationQueryForItemSelector: (openerField: Field, itemType: ItemType, ctx: InitialLocationQueryForItemSelectorCtx) => MaybePromise<InitialLocationQueryForItemSelector | undefined>;
 };
 export type InitialLocationQueryForItemSelectorCtx = Ctx;
+/**
+ * An object expressing which filters should be applied to the record selector
+ *
+ * @see {isInitialLocationQueryForItemSelector}
+ */
 export type InitialLocationQueryForItemSelector = {
     locationQuery: ItemListLocationQuery;
     /**
@@ -24,4 +29,6 @@ export type InitialLocationQueryForItemSelector = {
      */
     rank?: number;
 };
+export declare function isInitialLocationQueryForItemSelector(value: unknown): value is InitialLocationQueryForItemSelector;
+export declare function isReturnTypeOfInitialLocationQueryForItemSelectorHook(value: unknown): value is InitialLocationQueryForItemSelector | undefined;
 export {};

package/dist/esm/hooks/initialLocationQueryForItemSelector.js

@@ -1,2 +1,10 @@
-export {};
+import { isNullish, isNumber, isRecord } from '../guardUtils.js';
+export function isInitialLocationQueryForItemSelector(value) {
+    return (isRecord(value) &&
+        isRecord(value.locationQuery) &&
+        (isNullish(value.rank) || isNumber(value.rank)));
+}
+export function isReturnTypeOfInitialLocationQueryForItemSelectorHook(value) {
+    return isNullish(value) || isInitialLocationQueryForItemSelector(value);
+}
 //# sourceMappingURL=initialLocationQueryForItemSelector.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"initialLocationQueryForItemSelector.js","sourceRoot":"","sources":["../../../src/hooks/initialLocationQueryForItemSelector.ts"],"names":[],"mappings":""}
+{"version":3,"file":"initialLocationQueryForItemSelector.js","sourceRoot":"","sources":["../../../src/hooks/initialLocationQueryForItemSelector.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAuCjE,MAAM,UAAU,qCAAqC,CACnD,KAAc;IAEd,OAAO,CACL,QAAQ,CAAC,KAAK,CAAC;QACf,QAAQ,CAAC,KAAK,CAAC,aAAa,CAAC;QAC7B,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAChD,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,qDAAqD,CACnE,KAAc;IAEd,OAAO,SAAS,CAAC,KAAK,CAAC,IAAI,qCAAqC,CAAC,KAAK,CAAC,CAAC;AAC1E,CAAC"}

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

@@ -11,7 +11,11 @@ export type ItemCollectionOutletsHook = {
     itemCollectionOutlets: (itemType: ItemType, ctx: ItemCollectionOutletsCtx) => ItemCollectionOutlet[];
 };
 export type ItemCollectionOutletsCtx = Ctx;
-/** An outlet to be shown at the top of a record's collection page */
+/**
+ * An object expressing an outlet to be shown at the top of a record's collection page
+ *
+ * @see {isItemCollectionOutlet}
+ */
 export type ItemCollectionOutlet = {
     /**
      * ID of the outlet. Will be the first argument for the `renderItemCollectionOutlet`
@@ -28,4 +32,6 @@ export type ItemCollectionOutlet = {
     /** The initial height to set for the iframe that will render the outlet */
     initialHeight?: number;
 };
+export declare function isItemCollectionOutlet(value: unknown): value is ItemCollectionOutlet;
+export declare function isReturnTypeOfItemCollectionOutletsHook(value: unknown): value is ItemCollectionOutlet[];
 export {};

package/dist/esm/hooks/itemCollectionOutlets.js

@@ -1,2 +1,11 @@
-export {};
+import { isArray, isNullish, isNumber, isRecord, isString, } from '../guardUtils.js';
+export function isItemCollectionOutlet(value) {
+    return (isRecord(value) &&
+        isString(value.id) &&
+        (isNullish(value.rank) || isNumber(value.rank)) &&
+        (isNullish(value.initialHeight) || isNumber(value.initialHeight)));
+}
+export function isReturnTypeOfItemCollectionOutletsHook(value) {
+    return isArray(value, isItemCollectionOutlet);
+}
 //# sourceMappingURL=itemCollectionOutlets.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"itemCollectionOutlets.js","sourceRoot":"","sources":["../../../src/hooks/itemCollectionOutlets.ts"],"names":[],"mappings":""}
+{"version":3,"file":"itemCollectionOutlets.js","sourceRoot":"","sources":["../../../src/hooks/itemCollectionOutlets.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,OAAO,EACP,SAAS,EACT,QAAQ,EACR,QAAQ,EACR,QAAQ,GACT,MAAM,kBAAkB,CAAC;AAyC1B,MAAM,UAAU,sBAAsB,CACpC,KAAc;IAEd,OAAO,CACL,QAAQ,CAAC,KAAK,CAAC;QACf,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAClB,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,MAAM,UAAU,uCAAuC,CACrD,KAAc;IAEd,OAAO,OAAO,CAAC,KAAK,EAAE,sBAAsB,CAAC,CAAC;AAChD,CAAC"}

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

@@ -11,6 +11,11 @@ export type ItemFormOutletsHook = {
     itemFormOutlets: (itemType: ItemType, ctx: ItemFormOutletsCtx) => ItemFormOutlet[];
 };
 export type ItemFormOutletsCtx = Ctx;
+/**
+ * An object expressing an outlet to be shown at the top of a record's editing page
+ *
+ * @see {isItemFormOutlet}
+ */
 export type ItemFormOutlet = {
     /**
      * ID of the outlet. Will be the first argument for the `renderItemFormOutlet`
@@ -27,4 +32,6 @@ export type ItemFormOutlet = {
     /** The initial height to set for the iframe that will render the outlet */
     initialHeight?: number;
 };
+export declare function isItemFormOutlet(value: unknown): value is ItemFormOutlet;
+export declare function isReturnTypeOfItemFormOutletsHook(value: unknown): value is ItemFormOutlet[];
 export {};

package/dist/esm/hooks/itemFormOutlets.js

@@ -1,2 +1,11 @@
-export {};
+import { isArray, isNullish, isNumber, isRecord, isString, } from '../guardUtils.js';
+export function isItemFormOutlet(value) {
+    return (isRecord(value) &&
+        isString(value.id) &&
+        (isNullish(value.rank) || isNumber(value.rank)) &&
+        (isNullish(value.initialHeight) || isNumber(value.initialHeight)));
+}
+export function isReturnTypeOfItemFormOutletsHook(value) {
+    return isArray(value, isItemFormOutlet);
+}
 //# sourceMappingURL=itemFormOutlets.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"itemFormOutlets.js","sourceRoot":"","sources":["../../../src/hooks/itemFormOutlets.ts"],"names":[],"mappings":""}
+{"version":3,"file":"itemFormOutlets.js","sourceRoot":"","sources":["../../../src/hooks/itemFormOutlets.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,OAAO,EACP,SAAS,EACT,QAAQ,EACR,QAAQ,EACR,QAAQ,GACT,MAAM,kBAAkB,CAAC;AAyC1B,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,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,MAAM,UAAU,iCAAiC,CAC/C,KAAc;IAEd,OAAO,OAAO,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAC;AAC1C,CAAC"}

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

@@ -12,6 +12,12 @@ export type ItemFormSidebarPanelsHook = {
     itemFormSidebarPanels: (itemType: ItemType, ctx: ItemFormSidebarPanelsCtx) => ItemFormSidebarPanel[];
 };
 export type ItemFormSidebarPanelsCtx = Ctx;
+/**
+ * An object expressing a sidebar panel to be shown when the user
+ * edits records of a particular model
+ *
+ * @see {isItemFormSidebarPanel}
+ */
 export type ItemFormSidebarPanel = {
     /**
      * ID of the panel. Will be the first argument for the
@@ -45,4 +51,6 @@ export type ItemFormSidebarPanel = {
     /** The initial height to set for the iframe that will render the sidebar panel */
     initialHeight?: number;
 };
+export declare function isItemFormSidebarPanel(value: unknown): value is ItemFormSidebarPanel;
+export declare function isReturnTypeOfItemFormSidebarPanelsHook(value: unknown): value is ItemFormSidebarPanel[];
 export {};

package/dist/esm/hooks/itemFormSidebarPanels.js

@@ -1,2 +1,15 @@
-export {};
+import { isArray, isBoolean, isNullish, isNumber, isPlacement, isRecord, isString, } from '../guardUtils.js';
+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)));
+}
+export function isReturnTypeOfItemFormSidebarPanelsHook(value) {
+    return isArray(value, isItemFormSidebarPanel);
+}
 //# 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,OAAO,EACP,SAAS,EACT,SAAS,EACT,QAAQ,EACR,WAAW,EACX,QAAQ,EACR,QAAQ,GACT,MAAM,kBAAkB,CAAC;AA4D1B,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;AAED,MAAM,UAAU,uCAAuC,CACrD,KAAc;IAEd,OAAO,OAAO,CAAC,KAAK,EAAE,sBAAsB,CAAC,CAAC;AAChD,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,6 @@ export type ItemFormSidebar = {
     /** The preferred width for the sidebar */
     preferredWidth?: number;
 };
+export declare function isItemFormSidebar(value: unknown): value is ItemFormSidebar;
+export declare function isReturnTypeOfItemFormSidebarsHook(value: unknown): value is ItemFormSidebar[];
 export {};

package/dist/esm/hooks/itemFormSidebars.js

@@ -1,2 +1,13 @@
-export {};
+import { isArray, isNullish, isNumber, isRecord, isString, } from '../guardUtils.js';
+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)));
+}
+export function isReturnTypeOfItemFormSidebarsHook(value) {
+    return isArray(value, isItemFormSidebar);
+}
 //# 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,EACL,OAAO,EACP,SAAS,EACT,QAAQ,EACR,QAAQ,EACR,QAAQ,GACT,MAAM,kBAAkB,CAAC;AAkD1B,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;AAED,MAAM,UAAU,kCAAkC,CAChD,KAAc;IAEd,OAAO,OAAO,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAAC;AAC3C,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,5 @@ export type MainNavigationTab = {
      */
     rank?: number;
 };
+export declare function isMainNavigationTab(value: unknown): value is MainNavigationTab;
+export declare function isReturnTypeOfMainNavigationTabsHook(value: unknown): value is MainNavigationTab[];

package/dist/esm/hooks/mainNavigationTabs.js

@@ -1,2 +1,15 @@
-export {};
+import { isArray, isNullish, isNumber, isPlacement, isRecord, isString, } from '../guardUtils.js';
+import { isIcon } from '../icon';
+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)));
+}
+export function isReturnTypeOfMainNavigationTabsHook(value) {
+    return isArray(value, isMainNavigationTab);
+}
 //# 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,OAAO,EACP,SAAS,EACT,QAAQ,EACR,WAAW,EACX,QAAQ,EACR,QAAQ,GACT,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAQ,MAAM,EAAE,MAAM,SAAS,CAAC;AAmDvC,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;AAED,MAAM,UAAU,oCAAoC,CAClD,KAAc;IAEd,OAAO,OAAO,CAAC,KAAK,EAAE,mBAAmB,CAAC,CAAC;AAC7C,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,5 @@ 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';
+export declare function isManualFieldExtension(value: unknown): value is ManualFieldExtension;
+export declare function isReturnTypeOfManualFieldExtensionsHook(value: unknown): value is ManualFieldExtension[];

package/dist/esm/hooks/manualFieldExtensions.js

@@ -1,2 +1,23 @@
-export {};
+import { isArray, isBoolean, isNullish, isNumber, isRecord, isString, } from '../guardUtils.js';
+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)));
+}
+export function isReturnTypeOfManualFieldExtensionsHook(value) {
+    return isArray(value, isManualFieldExtension);
+}
 //# 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,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;AAED,MAAM,UAAU,uCAAuC,CACrD,KAAc;IAEd,OAAO,OAAO,CAAC,KAAK,EAAE,sBAAsB,CAAC,CAAC;AAChD,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,8 @@ export type AddonOverride = {
      */
     initialHeight?: number;
 };
+export declare function isFieldExtensionOverride(value: unknown): value is FieldExtensionOverride;
+export declare function isEditorOverride(value: unknown): value is EditorOverride;
+export declare function isAddonOverride(value: unknown): value is AddonOverride;
+export declare function isReturnTypeOfOverrideFieldExtensionsHook(value: unknown): value is FieldExtensionOverride | undefined;
 export {};

package/dist/esm/hooks/overrideFieldExtensions.js

@@ -1,2 +1,32 @@
-export {};
+import { isArray, isBoolean, isNullish, isNumber, isPlacement, isRecord, isString, } from '../guardUtils.js';
+export function isFieldExtensionOverride(value) {
+    return (isNullish(value) ||
+        (isRecord(value) &&
+            (isNullish(value.editor) || isEditorOverride(value.editor)) &&
+            (isNullish(value.addons) || isArray(value.addons, isAddonOverride))));
+}
+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)));
+}
+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)));
+}
+export function isReturnTypeOfOverrideFieldExtensionsHook(value) {
+    return isNullish(value) || isFieldExtensionOverride(value);
+}
 //# 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,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,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,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;AAED,MAAM,UAAU,yCAAyC,CACvD,KAAc;IAEd,OAAO,SAAS,CAAC,KAAK,CAAC,IAAI,wBAAwB,CAAC,KAAK,CAAC,CAAC;AAC7D,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,5 @@ export type UploadSidebarPanelPlacement = [
     'before' | 'after',
     ('defaultMetadata' | 'categorization' | 'creator' | 'videoTracks' | 'links' | 'replace')
 ];
+export declare function isUploadSidebarPanel(value: unknown): value is UploadSidebarPanel;
+export declare function isReturnTypeOfUploadSidebarPanelsHook(value: unknown): value is UploadSidebarPanel[];

package/dist/esm/hooks/uploadSidebarPanels.js

@@ -1,2 +1,15 @@
-export {};
+import { isArray, isBoolean, isNullish, isNumber, isPlacement, isRecord, isString, } from '../guardUtils.js';
+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)));
+}
+export function isReturnTypeOfUploadSidebarPanelsHook(value) {
+    return isArray(value, isUploadSidebarPanel);
+}
 //# 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,OAAO,EACP,SAAS,EACT,SAAS,EACT,QAAQ,EACR,WAAW,EACX,QAAQ,EACR,QAAQ,GACT,MAAM,kBAAkB,CAAC;AAkE1B,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;AAED,MAAM,UAAU,qCAAqC,CACnD,KAAc;IAEd,OAAO,OAAO,CAAC,KAAK,EAAE,oBAAoB,CAAC,CAAC;AAC9C,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,5 @@ export type UploadSidebar = {
     /** The preferred width for the sidebar */
     preferredWidth?: number;
 };
+export declare function isUploadSidebar(value: unknown): value is UploadSidebar;
+export declare function isReturnTypeOfUploadSidebarsHook(value: unknown): value is UploadSidebar[];

package/dist/esm/hooks/uploadSidebars.js

@@ -1,2 +1,13 @@
-export {};
+import { isArray, isNullish, isNumber, isRecord, isString, } from '../guardUtils.js';
+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)));
+}
+export function isReturnTypeOfUploadSidebarsHook(value) {
+    return isArray(value, isUploadSidebar);
+}
 //# 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,EACL,OAAO,EACP,SAAS,EACT,QAAQ,EACR,QAAQ,EACR,QAAQ,GACT,MAAM,kBAAkB,CAAC;AA6C1B,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;AAED,MAAM,UAAU,gCAAgC,CAC9C,KAAc;IAEd,OAAO,OAAO,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC;AACzC,CAAC"}

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

@@ -7,3 +7,4 @@ export type ValidateManualFieldExtensionParametersHook = {
      */
     validateManualFieldExtensionParameters: (fieldExtensionId: string, parameters: Record<string, unknown>) => Record<string, unknown> | Promise<Record<string, unknown>>;
 };
+export declare function isReturnTypeOfValidateManualFieldExtensionParametersHook(value: unknown): value is Record<string, unknown>;

package/dist/esm/hooks/validateManualFieldExtensionParameters.js

@@ -1,2 +1,5 @@
-export {};
+import { isRecord } from '../guardUtils';
+export function isReturnTypeOfValidateManualFieldExtensionParametersHook(value) {
+    return isRecord(value);
+}
 //# sourceMappingURL=validateManualFieldExtensionParameters.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"validateManualFieldExtensionParameters.js","sourceRoot":"","sources":["../../../src/hooks/validateManualFieldExtensionParameters.ts"],"names":[],"mappings":""}
+{"version":3,"file":"validateManualFieldExtensionParameters.js","sourceRoot":"","sources":["../../../src/hooks/validateManualFieldExtensionParameters.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAezC,MAAM,UAAU,wDAAwD,CACtE,KAAc;IAEd,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC;AACzB,CAAC"}