datocms-plugin-sdk 1.1.1 → 2.0.1

package/dist/types/manifestTypes.d.ts

@@ -0,0 +1,146 @@
+/**
+ * Type representing a manifest.
+ */
+export type Manifest = {
+    /**
+     * Hooks and their respective information.
+     */
+    hooks: Record<string, HookInfo>;
+    /**
+     * Base properties and methods available on every context argument.
+     */
+    baseCtx: {
+        /**
+         * Properties in the base context.
+         */
+        properties: AdditionalPropertiesOrMethodsGroup[];
+        /**
+         * Methods in the base context.
+         */
+        methods: AdditionalPropertiesOrMethodsGroup[];
+    };
+    /**
+     * Extra properties and methods available on every SelfResizingPluginFrameCtx context argument
+     */
+    selfResizingPluginFrameCtxSizingUtilities: AdditionalPropertiesOrMethodsGroup;
+};
+/**
+ * Type representing hook information.
+ */
+export type HookInfo = {
+    /**
+     * Name of the hook.
+     */
+    name: string;
+    /**
+     * JSDoc comment and tag for the hook.
+     */
+    comment?: Comment;
+    /**
+     * Non-context arguments for the hook.
+     */
+    nonCtxArguments: NonCtxArgument[];
+    /**
+     * Context argument for the hook, if any.
+     */
+    ctxArgument?: CtxArgument;
+    /**
+     * Return type of the hook function.
+     */
+    returnType: string;
+    /**
+     * Code location where the hook is defined.
+     */
+    location: CodeLocation;
+};
+/**
+ * Type representing a code location.
+ */
+export type CodeLocation = {
+    /**
+     * File path where the code is defined.
+     */
+    filePath: string;
+    /**
+     * Line number in the file where the hook is defined.
+     */
+    lineNumber: number;
+};
+/**
+ * Type alias for additional parameters or methods in context.
+ */
+export type AdditionalPropertyOrMethod = {
+    /**
+     * Description of the parameter or method.
+     */
+    comment?: Comment;
+    /**
+     * Code location where the parameter or method is defined.
+     */
+    location: CodeLocation;
+    /**
+     * Type of the parameter or method.
+     */
+    type: string;
+};
+export type AdditionalPropertiesOrMethodsGroup = {
+    /**
+     * Name of the group
+     */
+    name?: string;
+    /**
+     * Description of the group
+     */
+    comment?: Comment;
+    /**
+     * Type of the parameter or method.
+     */
+    items: Record<string, AdditionalPropertyOrMethod>;
+};
+/**
+ * Type alias for the context argument extracted from hook type.
+ */
+export type CtxArgument = {
+    /**
+     * Type of the context argument.
+     */
+    type: string;
+    /**
+     * Additional properties in the context argument, if any.
+     */
+    additionalProperties?: AdditionalPropertiesOrMethodsGroup[];
+    /**
+     * Additional methods in the context argument, if any.
+     */
+    additionalMethods?: AdditionalPropertiesOrMethodsGroup[];
+};
+/**
+ * Type alias for non-context arguments.
+ */
+export type NonCtxArgument = {
+    /**
+     * Name of the non-context argument.
+     */
+    name: string;
+    /**
+     * Type name of the non-context argument.
+     */
+    typeName: string;
+};
+/**
+ * Type representing a comment.
+ */
+export type Comment = {
+    /**
+     * The comment itself.
+     */
+    comment: string;
+    /**
+     * JSDoc tag for the comment, if any.
+     */
+    tag?: string;
+    /**
+     * Example or example code for the comment, if any.
+     */
+    example?: string;
+};

package/dist/types/shared.d.ts

@@ -0,0 +1,56 @@
+import { Icon } from './icon';
+export type DropdownAction = {
+    /**
+     * ID of action. Will be the first argument for the
+     * execute function
+     */
+    id: string;
+    /**
+     * An arbitrary configuration object that will be passed as the `parameters`
+     * property of the second argument of the execute function
+     */
+    parameters?: Record<string, unknown>;
+    /** Label to be shown. Must be unique. */
+    label: string;
+    /**
+     * Icon to be shown alongside the label. Can be a FontAwesome icon name (ie.
+     * `"address-book"`) or a custom SVG definition. To maintain visual
+     * consistency with the rest of the interface, try to use FontAwesome icons
+     * whenever possible.
+     */
+    icon: Icon;
+    active?: boolean;
+    alert?: boolean;
+    disabled?: boolean;
+    closeMenuOnClick?: boolean;
+    /**
+     * Actions will be displayed by ascending `rank`. If you want to specify an
+     * explicit value for `rank`, make sure to offer a way for final users to
+     * customize it inside the plugin's settings form, otherwise the hardcoded
+     * value you choose might clash with the one of another plugin!
+     */
+    rank?: number;
+};
+export type DropdownActionGroup = {
+    /** Label to be shown. Must be unique. */
+    label: string;
+    /**
+     * Icon to be shown alongside the label. Can be a FontAwesome icon name (ie.
+     * `"address-book"`) or a custom SVG definition. To maintain visual
+     * consistency with the rest of the interface, try to use FontAwesome icons
+     * whenever possible.
+     */
+    icon: Icon;
+    actions: DropdownAction[];
+    /**
+     * Actions will be displayed by ascending `rank`. If you want to specify an
+     * explicit value for `rank`, make sure to offer a way for final users to
+     * customize it inside the plugin's settings form, otherwise the hardcoded
+     * value you choose might clash with the one of another plugin!
+     */
+    rank?: number;
+};
+export type ItemFormSidebarPanelPlacement = [
+    'before' | 'after',
+    'info' | 'publishedVersion' | 'schedule' | 'links' | 'history'
+];

package/dist/types/utils.d.ts

@@ -0,0 +1,31 @@
+import type { SchemaTypes } from '@datocms/cma-client';
+import { FullConnectParameters } from './connect';
+import { Ctx } from './ctx/base';
+import { ImposedSizePluginFrameCtx, SelfResizingPluginFrameCtx } from './ctx/pluginFrame';
+type Field = SchemaTypes.Field;
+type ItemType = SchemaTypes.ItemType;
+export type AwaitedReturnType<T extends (...args: any) => any> = Awaited<ReturnType<T>>;
+type ModeForPluginFrameCtx<T> = T extends ImposedSizePluginFrameCtx<infer Mode, any, any> ? Mode : never;
+export type MaybePromise<T> = T | Promise<T>;
+export declare function pick<T extends object, K extends keyof T>(obj: T, keys: readonly K[]): Pick<T, K>;
+export declare function omit<T extends object, K extends keyof T>(obj: T, keys: readonly K[]): Omit<T, K>;
+export declare function fromOneFieldIntoMultipleAndResultsById<Result>(fn: ((field: Field, ctx: Ctx<any, any> & {
+    itemType: ItemType;
+}) => Result) | undefined): (fields: Field[], ctx: Ctx<any, any>) => Record<string, Result> | undefined;
+export type Methods = {
+    getSettings: () => Promise<Properties>;
+};
+export type Properties<Mode extends string = string> = {
+    mode: Mode;
+};
+type OnChangeListenerFn = (newSettings: any) => void;
+export type ExtractRenderHooks<T extends Record<string, unknown>> = {
+    [K in keyof T as K extends `render${string}` ? K : never]: T[K];
+};
+export type Bootstrapper<H extends keyof ExtractRenderHooks<FullConnectParameters>> = {
+    (connectConfiguration: Partial<ExtractRenderHooks<FullConnectParameters>>, methods: Methods, initialProperties: Properties): undefined | OnChangeListenerFn;
+    mode: H;
+};
+export declare function containedRenderModeBootstrapper<Ctx extends SelfResizingPluginFrameCtx<any, {}, {}>>(mode: ModeForPluginFrameCtx<Ctx>, callConfigurationMethod: (connectConfiguration: Partial<ExtractRenderHooks<FullConnectParameters>>, ctx: Ctx) => void): Bootstrapper<Ctx['mode']>;
+export declare function fullScreenRenderModeBootstrapper<Ctx extends ImposedSizePluginFrameCtx<any, {}, {}>>(mode: ModeForPluginFrameCtx<Ctx>, callConfigurationMethod: (connectConfiguration: Partial<ExtractRenderHooks<FullConnectParameters>>, ctx: Ctx) => void): Bootstrapper<Ctx['mode']>;
+export {};