datocms-plugin-sdk 2.0.4 → 2.0.5

package/dist/cjs/manifest.js

@@ -58,7 +58,7 @@ exports.manifest = {
             returnType: 'UploadSidebar[]',
             location: {
                 filePath: 'src/hooks/uploadSidebars.ts',
-                lineNumber: 10,
+                lineNumber: 11,
             },
         },
         uploadSidebarPanels: {
@@ -76,7 +76,7 @@ exports.manifest = {
             returnType: 'UploadSidebarPanel[]',
             location: {
                 filePath: 'src/hooks/uploadSidebarPanels.ts',
-                lineNumber: 10,
+                lineNumber: 18,
             },
         },
         settingsAreaSidebarItemGroups: {
@@ -1481,7 +1481,7 @@ exports.manifest = {
                             itemType: {
                                 location: {
                                     filePath: 'src/hooks/overrideFieldExtensions.ts',
-                                    lineNumber: 22,
+                                    lineNumber: 31,
                                 },
                                 type: 'ItemType',
                             },
@@ -1493,7 +1493,7 @@ exports.manifest = {
             returnType: 'FieldExtensionOverride | undefined',
             location: {
                 filePath: 'src/hooks/overrideFieldExtensions.ts',
-                lineNumber: 15,
+                lineNumber: 24,
             },
         },
         onBoot: {
@@ -1621,7 +1621,7 @@ exports.manifest = {
             returnType: 'ManualFieldExtension[]',
             location: {
                 filePath: 'src/hooks/manualFieldExtensions.ts',
-                lineNumber: 10,
+                lineNumber: 18,
             },
         },
         mainNavigationTabs: {
@@ -1639,7 +1639,7 @@ exports.manifest = {
             returnType: 'MainNavigationTab[]',
             location: {
                 filePath: 'src/hooks/mainNavigationTabs.ts',
-                lineNumber: 11,
+                lineNumber: 18,
             },
         },
         itemsDropdownActions: {
@@ -1697,7 +1697,7 @@ exports.manifest = {
             returnType: 'ItemFormSidebar[]',
             location: {
                 filePath: 'src/hooks/itemFormSidebars.ts',
-                lineNumber: 13,
+                lineNumber: 14,
             },
         },
         itemFormSidebarPanels: {
@@ -1720,7 +1720,7 @@ exports.manifest = {
             returnType: 'ItemFormSidebarPanel[]',
             location: {
                 filePath: 'src/hooks/itemFormSidebarPanels.ts',
-                lineNumber: 14,
+                lineNumber: 22,
             },
         },
         itemFormOutlets: {
@@ -1743,7 +1743,7 @@ exports.manifest = {
             returnType: 'ItemFormOutlet[]',
             location: {
                 filePath: 'src/hooks/itemFormOutlets.ts',
-                lineNumber: 13,
+                lineNumber: 14,
             },
         },
         itemFormDropdownActions: {
@@ -1878,7 +1878,7 @@ exports.manifest = {
             returnType: 'ItemCollectionOutlet[]',
             location: {
                 filePath: 'src/hooks/itemCollectionOutlets.ts',
-                lineNumber: 13,
+                lineNumber: 14,
             },
         },
         initialLocationQueryForItemSelector: {
@@ -2652,7 +2652,7 @@ exports.manifest = {
                             itemType: {
                                 location: {
                                     filePath: 'src/hooks/customMarksForStructuredTextField.ts',
-                                    lineNumber: 22,
+                                    lineNumber: 29,
                                 },
                                 type: 'ItemType',
                             },
@@ -2664,7 +2664,7 @@ exports.manifest = {
             returnType: 'StructuredTextCustomMark[] | undefined',
             location: {
                 filePath: 'src/hooks/customMarksForStructuredTextField.ts',
-                lineNumber: 15,
+                lineNumber: 22,
             },
         },
         customBlockStylesForStructuredTextField: {
@@ -2687,7 +2687,7 @@ exports.manifest = {
                             itemType: {
                                 location: {
                                     filePath: 'src/hooks/customBlockStylesForStructuredTextField.ts',
-                                    lineNumber: 22,
+                                    lineNumber: 23,
                                 },
                                 type: 'ItemType',
                             },
@@ -2699,7 +2699,7 @@ exports.manifest = {
             returnType: 'StructuredTextCustomBlockStyle[] | undefined',
             location: {
                 filePath: 'src/hooks/customBlockStylesForStructuredTextField.ts',
-                lineNumber: 15,
+                lineNumber: 16,
             },
         },
         contentAreaSidebarItems: {
@@ -2717,7 +2717,7 @@ exports.manifest = {
             returnType: 'ContentAreaSidebarItem[]',
             location: {
                 filePath: 'src/hooks/contentAreaSidebarItems.ts',
-                lineNumber: 10,
+                lineNumber: 17,
             },
         },
         buildItemPresentationInfo: {
@@ -2740,7 +2740,7 @@ exports.manifest = {
             returnType: 'MaybePromise<ItemPresentationInfo | undefined>',
             location: {
                 filePath: 'src/hooks/buildItemPresentationInfo.ts',
-                lineNumber: 14,
+                lineNumber: 15,
             },
         },
         assetSources: {
@@ -2758,7 +2758,7 @@ exports.manifest = {
             returnType: 'AssetSource[] | undefined',
             location: {
                 filePath: 'src/hooks/assetSources.ts',
-                lineNumber: 11,
+                lineNumber: 12,
             },
         },
     },

package/dist/cjs/shared.js

@@ -1,3 +1,28 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.isDropdownAction = isDropdownAction;
+exports.isDropdownActionGroup = isDropdownActionGroup;
+var guardUtils_js_1 = require("./guardUtils.js");
+var icon_1 = require("./icon");
+function isDropdownAction(value) {
+    if (!(0, guardUtils_js_1.isRecord)(value))
+        return false;
+    return ((0, guardUtils_js_1.isString)(value.id) &&
+        ((0, guardUtils_js_1.isNullish)(value.parameters) || (0, guardUtils_js_1.isRecord)(value.parameters)) &&
+        (0, guardUtils_js_1.isString)(value.label) &&
+        (0, icon_1.isIcon)(value.icon) &&
+        ((0, guardUtils_js_1.isNullish)(value.active) || (0, guardUtils_js_1.isBoolean)(value.active)) &&
+        ((0, guardUtils_js_1.isNullish)(value.alert) || (0, guardUtils_js_1.isBoolean)(value.alert)) &&
+        ((0, guardUtils_js_1.isNullish)(value.disabled) || (0, guardUtils_js_1.isBoolean)(value.disabled)) &&
+        ((0, guardUtils_js_1.isNullish)(value.closeMenuOnClick) || (0, guardUtils_js_1.isBoolean)(value.closeMenuOnClick)) &&
+        ((0, guardUtils_js_1.isNullish)(value.rank) || (0, guardUtils_js_1.isNumber)(value.rank)));
+}
+function isDropdownActionGroup(value) {
+    if (!(0, guardUtils_js_1.isRecord)(value))
+        return false;
+    return ((0, guardUtils_js_1.isString)(value.label) &&
+        (0, icon_1.isIcon)(value.icon) &&
+        (0, guardUtils_js_1.isArray)(value.actions, isDropdownAction) &&
+        ((0, guardUtils_js_1.isNullish)(value.rank) || (0, guardUtils_js_1.isNumber)(value.rank)));
+}
 //# sourceMappingURL=shared.js.map

package/dist/cjs/shared.js.map

@@ -1 +1 @@
-{"version":3,"file":"shared.js","sourceRoot":"","sources":["../../src/shared.ts"],"names":[],"mappings":""}
+{"version":3,"file":"shared.js","sourceRoot":"","sources":["../../src/shared.ts"],"names":[],"mappings":";;AAsFA,4CAcC;AAED,sDAWC;AAjHD,iDAOyB;AACzB,+BAAsC;AA8EtC,SAAgB,gBAAgB,CAAC,KAAc;IAC7C,IAAI,CAAC,IAAA,wBAAQ,EAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAEnC,OAAO,CACL,IAAA,wBAAQ,EAAC,KAAK,CAAC,EAAE,CAAC;QAClB,CAAC,IAAA,yBAAS,EAAC,KAAK,CAAC,UAAU,CAAC,IAAI,IAAA,wBAAQ,EAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC3D,IAAA,wBAAQ,EAAC,KAAK,CAAC,KAAK,CAAC;QACrB,IAAA,aAAM,EAAC,KAAK,CAAC,IAAI,CAAC;QAClB,CAAC,IAAA,yBAAS,EAAC,KAAK,CAAC,MAAM,CAAC,IAAI,IAAA,yBAAS,EAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACpD,CAAC,IAAA,yBAAS,EAAC,KAAK,CAAC,KAAK,CAAC,IAAI,IAAA,yBAAS,EAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAClD,CAAC,IAAA,yBAAS,EAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,IAAA,yBAAS,EAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACxD,CAAC,IAAA,yBAAS,EAAC,KAAK,CAAC,gBAAgB,CAAC,IAAI,IAAA,yBAAS,EAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;QACxE,CAAC,IAAA,yBAAS,EAAC,KAAK,CAAC,IAAI,CAAC,IAAI,IAAA,wBAAQ,EAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAChD,CAAC;AACJ,CAAC;AAED,SAAgB,qBAAqB,CACnC,KAAc;IAEd,IAAI,CAAC,IAAA,wBAAQ,EAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAEnC,OAAO,CACL,IAAA,wBAAQ,EAAC,KAAK,CAAC,KAAK,CAAC;QACrB,IAAA,aAAM,EAAC,KAAK,CAAC,IAAI,CAAC;QAClB,IAAA,uBAAO,EAAC,KAAK,CAAC,OAAO,EAAE,gBAAgB,CAAC;QACxC,CAAC,IAAA,yBAAS,EAAC,KAAK,CAAC,IAAI,CAAC,IAAI,IAAA,wBAAQ,EAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAChD,CAAC;AACJ,CAAC"}

package/dist/esm/guardUtils.d.ts

@@ -0,0 +1,7 @@
+export declare function isNullish(value: unknown): value is null | undefined;
+export declare function isBoolean(value: unknown): value is boolean;
+export declare function isString(value: unknown): value is string;
+export declare function isNumber(value: unknown): value is number;
+export declare function isRecord(value: unknown): value is Record<string, unknown>;
+export declare function isArray<T>(value: unknown, checkItem: (item: unknown) => item is T): value is T[];
+export declare function isPlacement(value: unknown): boolean;

package/dist/esm/guardUtils.js

@@ -0,0 +1,24 @@
+export function isNullish(value) {
+    return value === null || value === undefined;
+}
+export function isBoolean(value) {
+    return typeof value === 'boolean';
+}
+export function isString(value) {
+    return typeof value === 'string';
+}
+export function isNumber(value) {
+    return typeof value === 'number';
+}
+export function isRecord(value) {
+    return typeof value === 'object' && value !== null && !Array.isArray(value);
+}
+export function isArray(value, checkItem) {
+    return Array.isArray(value) && value.every(checkItem);
+}
+export function isPlacement(value) {
+    return (isArray(value, isString) &&
+        value.length === 2 &&
+        ['before', 'after'].includes(value[0]));
+}
+//# sourceMappingURL=guardUtils.js.map

package/dist/esm/guardUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"guardUtils.js","sourceRoot":"","sources":["../../src/guardUtils.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,SAAS,CAAC,KAAc;IACtC,OAAO,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,CAAC;AAC/C,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,KAAc;IACtC,OAAO,OAAO,KAAK,KAAK,SAAS,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC;AACnC,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC;AACnC,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC;AAED,MAAM,UAAU,OAAO,CACrB,KAAc,EACd,SAAuC;IAEvC,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;AACxD,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,KAAc;IACxC,OAAO,CACL,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC;QACxB,KAAK,CAAC,MAAM,KAAK,CAAC;QAClB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CACvC,CAAC;AACJ,CAAC"}

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

@@ -10,7 +10,11 @@ export type AssetSourcesHook = {
     assetSources: (ctx: AssetSourcesCtx) => AssetSource[] | undefined;
 };
 export type AssetSourcesCtx = Ctx;
-/** An additional asset source */
+/**
+ * An object expressing an additional asset source
+ *
+ * @see {isAssetSource}
+ */
 export type AssetSource = {
     /**
      * ID of the asset source. Will be the first argument for the
@@ -40,3 +44,9 @@ export type AssetSource = {
         initialHeight?: number;
     };
 };
+/**
+ * Type guard for AssetSource.
+ * @param value - The value to check.
+ * @returns true if the value is an AssetSource, false otherwise.
+ */
+export declare function isAssetSource(value: unknown): value is AssetSource;

package/dist/esm/hooks/assetSources.js

@@ -1,2 +1,25 @@
-export {};
+import { isNullish, isNumber, isRecord, isString } from '../guardUtils.js';
+import { isIcon } from '../icon';
+/**
+ * Type guard for AssetSource.
+ * @param value - The value to check.
+ * @returns true if the value is an AssetSource, false otherwise.
+ */
+export function isAssetSource(value) {
+    if (isNullish(value))
+        return false;
+    if (!isRecord(value))
+        return false;
+    var id = value.id, name = value.name, icon = value.icon, modal = value.modal;
+    return (isString(id) &&
+        isString(name) &&
+        isIcon(icon) &&
+        (isNullish(modal) ||
+            (isRecord(modal) &&
+                (isNullish(modal.width) ||
+                    (isString(modal.width) &&
+                        ['s', 'm', 'l', 'xl'].includes(modal.width)) ||
+                    isNumber(modal.width)) &&
+                (isNullish(modal.initialHeight) || isNumber(modal.initialHeight)))));
+}
 //# sourceMappingURL=assetSources.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"assetSources.js","sourceRoot":"","sources":["../../../src/hooks/assetSources.ts"],"names":[],"mappings":""}
+{"version":3,"file":"assetSources.js","sourceRoot":"","sources":["../../../src/hooks/assetSources.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC3E,OAAO,EAAQ,MAAM,EAAE,MAAM,SAAS,CAAC;AAiDvC;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,KAAc;IAC1C,IAAI,SAAS,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACnC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAE3B,IAAA,EAAE,GAAwB,KAAK,GAA7B,EAAE,IAAI,GAAkB,KAAK,KAAvB,EAAE,IAAI,GAAY,KAAK,KAAjB,EAAE,KAAK,GAAK,KAAK,MAAV,CAAW;IAExC,OAAO,CACL,QAAQ,CAAC,EAAE,CAAC;QACZ,QAAQ,CAAC,IAAI,CAAC;QACd,MAAM,CAAC,IAAI,CAAC;QACZ,CAAC,SAAS,CAAC,KAAK,CAAC;YACf,CAAC,QAAQ,CAAC,KAAK,CAAC;gBACd,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC;oBACrB,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC;wBACpB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;oBAC9C,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBACxB,CAAC,SAAS,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CACxE,CAAC;AACJ,CAAC"}

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

@@ -12,6 +12,11 @@ export type BuildItemPresentationInfoHook = {
     buildItemPresentationInfo: (item: Item, ctx: BuildItemPresentationInfoCtx) => MaybePromise<ItemPresentationInfo | undefined>;
 };
 export type BuildItemPresentationInfoCtx = Ctx;
+/**
+ * An object expressing how a record should be presented in the interface
+ *
+ * @see {isItemPresentationInfo}
+ */
 export type ItemPresentationInfo = {
     /** The title to present the record */
     title: string;
@@ -26,4 +31,10 @@ export type ItemPresentationInfo = {
      */
     rank?: number;
 };
+/**
+ * Checks if the value is an ItemPresentationInfo type.
+ * @param value The value to check.
+ * @returns True if the value is an ItemPresentationInfo, false otherwise.
+ */
+export declare function isItemPresentationInfo(value: unknown): value is ItemPresentationInfo;
 export {};

package/dist/esm/hooks/buildItemPresentationInfo.js

@@ -1,2 +1,13 @@
-export {};
+import { isNullish, isNumber, isRecord, isString } from '../guardUtils.js';
+/**
+ * Checks if the value is an ItemPresentationInfo type.
+ * @param value The value to check.
+ * @returns True if the value is an ItemPresentationInfo, false otherwise.
+ */
+export function isItemPresentationInfo(value) {
+    return (isRecord(value) &&
+        isString(value.title) &&
+        (isNullish(value.imageUrl) || isString(value.imageUrl)) &&
+        (isNullish(value.rank) || isNumber(value.rank)));
+}
 //# sourceMappingURL=buildItemPresentationInfo.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"buildItemPresentationInfo.js","sourceRoot":"","sources":["../../../src/hooks/buildItemPresentationInfo.ts"],"names":[],"mappings":""}
+{"version":3,"file":"buildItemPresentationInfo.js","sourceRoot":"","sources":["../../../src/hooks/buildItemPresentationInfo.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAwC3E;;;;GAIG;AACH,MAAM,UAAU,sBAAsB,CACpC,KAAc;IAEd,OAAO,CACL,QAAQ,CAAC,KAAK,CAAC;QACf,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC;QACrB,CAAC,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACvD,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAChD,CAAC;AACJ,CAAC"}

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

@@ -9,6 +9,11 @@ export type ContentAreaSidebarItemsHook = {
     contentAreaSidebarItems: (ctx: ContentAreaSidebarItemsCtx) => ContentAreaSidebarItem[];
 };
 export type ContentAreaSidebarItemsCtx = Ctx;
+/**
+ * An object expressing an item in the content area sidebar
+ *
+ * @see {isContentAreaSidebarItem}
+ */
 export type ContentAreaSidebarItem = {
     /** Label to be shown. Must be unique. */
     label: string;
@@ -38,3 +43,9 @@ export type ContentAreaSidebarItem = {
      */
     rank?: number;
 };
+/**
+ * Checks if the value is a ContentAreaSidebarItem.
+ * @param value - The value to check.
+ * @returns True if the value is a ContentAreaSidebarItem, false otherwise.
+ */
+export declare function isContentAreaSidebarItem(value: unknown): value is ContentAreaSidebarItem;

package/dist/esm/hooks/contentAreaSidebarItems.js

@@ -1,2 +1,17 @@
-export {};
+import { isNullish, isNumber, isPlacement, isRecord, isString, } from '../guardUtils.js';
+import { isIcon } from '../icon';
+/**
+ * Checks if the value is a ContentAreaSidebarItem.
+ * @param value - The value to check.
+ * @returns True if the value is a ContentAreaSidebarItem, false otherwise.
+ */
+export function isContentAreaSidebarItem(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=contentAreaSidebarItems.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"contentAreaSidebarItems.js","sourceRoot":"","sources":["../../../src/hooks/contentAreaSidebarItems.ts"],"names":[],"mappings":""}
+{"version":3,"file":"contentAreaSidebarItems.js","sourceRoot":"","sources":["../../../src/hooks/contentAreaSidebarItems.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;AAkDvC;;;;GAIG;AACH,MAAM,UAAU,wBAAwB,CACtC,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/customBlockStylesForStructuredTextField.d.ts

@@ -15,7 +15,11 @@ export type CustomBlockStylesForStructuredTextFieldHook = {
 export type CustomBlockStylesForStructuredTextFieldCtx = Ctx<{
     itemType: ItemType;
 }>;
-/** An object expressing a custom block style for a Structured Text field */
+/**
+ * An object expressing a custom block style for a Structured Text field
+ *
+ * @see {isStructuredTextCustomBlockStyle}
+ */
 export type StructuredTextCustomBlockStyle = {
     /** ID of custom block style */
     id: string;
@@ -33,4 +37,10 @@ export type StructuredTextCustomBlockStyle = {
      */
     rank?: number;
 };
+/**
+ * Checks if the given value is a StructuredTextCustomBlockStyle.
+ * @param value - The value to check.
+ * @returns True if the value is a StructuredTextCustomBlockStyle, otherwise false.
+ */
+export declare function isStructuredTextCustomBlockStyle(value: unknown): value is StructuredTextCustomBlockStyle;
 export {};

package/dist/esm/hooks/customBlockStylesForStructuredTextField.js

@@ -1,2 +1,14 @@
-export {};
+import { isNullish, isNumber, isRecord, isString } from '../guardUtils.js';
+/**
+ * Checks if the given value is a StructuredTextCustomBlockStyle.
+ * @param value - The value to check.
+ * @returns True if the value is a StructuredTextCustomBlockStyle, otherwise false.
+ */
+export function isStructuredTextCustomBlockStyle(value) {
+    return (isRecord(value) &&
+        isString(value.id) &&
+        isString(value.label) &&
+        isString(value.node) &&
+        (isNullish(value.rank) || isNumber(value.rank)));
+}
 //# 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,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AA6C3E;;;;GAIG;AACH,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"}

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,10 @@ export type StructuredTextCustomMarkPlacement = [
     'before' | 'after',
     'strong' | 'emphasis' | 'underline' | 'code' | 'highlight' | 'strikethrough'
 ];
+/**
+ * Checks if the given value is a StructuredTextCustomMark.
+ * @param value The value to check.
+ * @returns True if the value is a StructuredTextCustomMark, false otherwise.
+ */
+export declare function isStructuredTextCustomMark(value: unknown): value is StructuredTextCustomMark;
 export {};

package/dist/esm/hooks/customMarksForStructuredTextField.js

@@ -1,2 +1,18 @@
-export {};
+import { isNullish, isNumber, isPlacement, isRecord, isString, } from '../guardUtils.js';
+import { isIcon } from '../icon';
+/**
+ * Checks if the given value is a StructuredTextCustomMark.
+ * @param value The value to check.
+ * @returns True if the value is a StructuredTextCustomMark, false otherwise.
+ */
+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));
+}
 //# 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,SAAS,EACT,QAAQ,EACR,WAAW,EACX,QAAQ,EACR,QAAQ,GACT,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAQ,MAAM,EAAE,MAAM,SAAS,CAAC;AAmEvC;;;;GAIG;AACH,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"}

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,10 @@ export type InitialLocationQueryForItemSelector = {
      */
     rank?: number;
 };
+/**
+ * Type guard for InitialLocationQueryForItemSelector
+ * @param value - The value to check
+ * @returns True if value is of type InitialLocationQueryForItemSelector, false otherwise
+ */
+export declare function isInitialLocationQueryForItemSelector(value: unknown): value is InitialLocationQueryForItemSelector;
 export {};

package/dist/esm/hooks/initialLocationQueryForItemSelector.js

@@ -1,2 +1,12 @@
-export {};
+import { isNullish, isNumber, isRecord } from '../guardUtils.js';
+/**
+ * Type guard for InitialLocationQueryForItemSelector
+ * @param value - The value to check
+ * @returns True if value is of type InitialLocationQueryForItemSelector, false otherwise
+ */
+export function isInitialLocationQueryForItemSelector(value) {
+    return (isRecord(value) &&
+        isRecord(value.locationQuery) &&
+        (isNullish(value.rank) || isNumber(value.rank)));
+}
 //# 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;;;;GAIG;AACH,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"}

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,10 @@ export type ItemCollectionOutlet = {
     /** The initial height to set for the iframe that will render the outlet */
     initialHeight?: number;
 };
+/**
+ * Checks if the given value is an ItemCollectionOutlet.
+ * @param value - The value to check.
+ * @returns True if the value is an ItemCollectionOutlet, false otherwise.
+ */
+export declare function isItemCollectionOutlet(value: unknown): value is ItemCollectionOutlet;
 export {};

package/dist/esm/hooks/itemCollectionOutlets.js

@@ -1,2 +1,13 @@
-export {};
+import { isNullish, isNumber, isRecord, isString } from '../guardUtils.js';
+/**
+ * Checks if the given value is an ItemCollectionOutlet.
+ * @param value - The value to check.
+ * @returns True if the value is an ItemCollectionOutlet, false otherwise.
+ */
+export function isItemCollectionOutlet(value) {
+    return (isRecord(value) &&
+        isString(value.id) &&
+        (isNullish(value.rank) || isNumber(value.rank)) &&
+        (isNullish(value.initialHeight) || isNumber(value.initialHeight)));
+}
 //# 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,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAyC3E;;;;GAIG;AACH,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"}

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,10 @@ export type ItemFormOutlet = {
     /** The initial height to set for the iframe that will render the outlet */
     initialHeight?: number;
 };
+/**
+ * Checks if the given value is an ItemFormOutlet.
+ * @param value - The value to check.
+ * @returns True if the value is an ItemFormOutlet, false otherwise.
+ */
+export declare function isItemFormOutlet(value: unknown): value is ItemFormOutlet;
 export {};

package/dist/esm/hooks/itemFormOutlets.js

@@ -1,2 +1,13 @@
-export {};
+import { isNullish, isNumber, isRecord, isString } from '../guardUtils.js';
+/**
+ * Checks if the given value is an ItemFormOutlet.
+ * @param value - The value to check.
+ * @returns True if the value is an ItemFormOutlet, false otherwise.
+ */
+export function isItemFormOutlet(value) {
+    return (isRecord(value) &&
+        isString(value.id) &&
+        (isNullish(value.rank) || isNumber(value.rank)) &&
+        (isNullish(value.initialHeight) || isNumber(value.initialHeight)));
+}
 //# 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,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAyC3E;;;;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,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/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,10 @@ export type ItemFormSidebarPanel = {
     /** The initial height to set for the iframe that will render the sidebar panel */
     initialHeight?: number;
 };
+/**
+ * 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 declare function isItemFormSidebarPanel(value: unknown): value is ItemFormSidebarPanel;
 export {};