@plasmicapp/host 1.0.223 → 1.0.225

package/registerComponent/dist/types/primitive-types.d.ts

@@ -0,0 +1,123 @@
+/// <reference types="react" />
+import { CSSProperties } from "../element-types";
+import { StyleSection } from "../registerComponent";
+import { ContextDependentConfig } from "./shared-controls";
+export interface RichBooleanCore {
+    type: "boolean";
+}
+export interface NumberTypeBaseCore<Ctx extends any[]> {
+    type: "number";
+    min?: number | ContextDependentConfig<Ctx, number>;
+    max?: number | ContextDependentConfig<Ctx, number>;
+}
+export interface PlainNumberCore<Ctx extends any[]> extends NumberTypeBaseCore<Ctx> {
+    control?: "default";
+}
+export interface SliderNumberCore<Ctx extends any[]> extends NumberTypeBaseCore<Ctx> {
+    control: "slider";
+    step?: number | ContextDependentConfig<Ctx, number>;
+}
+export interface PlainStringCore {
+    type: "string";
+    control?: "default" | "large";
+    isLocalizable?: boolean;
+}
+export interface CodeStringCore {
+    type: "code";
+    lang: "css" | "html" | "javascript" | "json";
+}
+export interface RichTextCore {
+    type: "richText";
+}
+export interface HrefCore {
+    type: "href";
+}
+export interface ColorCore {
+    type: "color";
+    /**
+     * If specified, and the user picks a color token in the Studio, then
+     * the value passed in as prop is a css variable reference, like
+     * `var(--TOKEN_ID)`, instead of the resolved hex value of the token.
+     * You should take care in using this in the proper css context --
+     * the css token is only defined if you are rendering under some
+     * Plasmic component in the DOM tree, which is usually the case,
+     * unless you are using a React portal.
+     */
+    keepCssVar?: boolean;
+    /**
+     * Prevent tokens from being selected.
+     */
+    disableTokens?: boolean;
+}
+export interface DateStringCore {
+    type: "dateString";
+}
+export interface DateRangeStringsCore {
+    type: "dateRangeStrings";
+}
+export interface ClassCore {
+    type: "class";
+    /**
+     * Additional css selectors that can change how this style should look.
+     * Some examples:
+     *
+     * * `:hover` -- on hover
+     * * `[data-something="blah"] -- when the element with this class has
+     *   an html attribute "data-something=blah"
+     * * :component[data-something="blah"] :self -- when the root of the
+     *   component has an html attribute "data-something=blah". Note that
+     *   the non-standard `:component` selector is used to select the
+     *   component root, and the non-standard `:self` selector is used
+     *   to select the element that this class is attached to.
+     */
+    selectors?: {
+        /**
+         * A css selector, like `:hover` or `[data-something="blah"]`.
+         */
+        selector: string;
+        /**
+         * An optional human-friendly label for the selector, so the studio user
+         * knows what this selector means.
+         */
+        label?: string;
+        /**
+         * Initial styles to be applied for this selector
+         */
+        defaultStyles?: CSSProperties;
+    }[];
+    /**
+     * If specified, then only shows these style sections for styling this class
+     */
+    styleSections?: StyleSection[];
+    /**
+     * Initial styles to be applied for this class
+     */
+    defaultStyles?: CSSProperties;
+}
+export interface ThemeResetClassCore {
+    type: "themeResetClass";
+    /**
+     * Normally, theme reset class will only target Plasmic-generated tags
+     * with the default tag styles. If you also want to target non-Plasmic-generated
+     * tags (say, rendered by your code components, or fetched as an HTML blob
+     * from somewhere), then specify `true` here.
+     */
+    targetAllTags?: boolean;
+}
+export interface CardPickerCore<Ctx extends any[]> {
+    type: "cardPicker";
+    modalTitle?: React.ReactNode | ContextDependentConfig<Ctx, React.ReactNode>;
+    options: {
+        value: string;
+        label?: string;
+        imgUrl: string;
+        footer?: React.ReactNode;
+    }[] | ContextDependentConfig<Ctx, {
+        value: string;
+        label?: string;
+        imgUrl: string;
+        footer?: React.ReactNode;
+    }[]>;
+    showInput?: boolean | ContextDependentConfig<Ctx, boolean>;
+    onSearch?: ContextDependentConfig<Ctx, ((value: string) => void) | undefined>;
+}

package/registerComponent/dist/types/shared-controls.d.ts

@@ -0,0 +1,40 @@
+export type GenericContext<Props, Data, Extra = unknown> = [Props, Data, Extra];
+/**
+ * Config option that takes the context (e.g., props) of the component instance
+ * or function to dynamically set its value.
+ */
+export type ContextDependentConfig<Ctx extends any[], R> = (...args: Ctx) => R;
+export type MaybeContextDependentConfig<Ctx extends any[], V> = V | ContextDependentConfig<Ctx, V>;
+export interface CanvasComponentProps<Data = any> {
+    /**
+     * This prop is only provided within the canvas of Plasmic Studio.
+     * Allows the component to set data to be consumed by the props' controls.
+     */
+    setControlContextData?: (data: Data) => void;
+}
+export type ControlExtras = {
+    path: (string | number)[];
+    item?: any;
+};
+export type InferDataType<P> = P extends CanvasComponentProps<infer Data> ? Data : any;
+export interface CommonTypeBase<Ctx extends any[]> {
+    description?: string;
+    helpText?: string;
+    required?: boolean;
+    /**
+     * If the user has chosen to use a dynamic expression for this prop, provide
+     * a hint as to the expected values that the expression should evaluate to.
+     * This hint will be displayed alongside the code editor.  You may use
+     * markdown in the text here.
+     */
+    exprHint?: string;
+    /**
+     * Function for whether this prop should be hidden in the right panel,
+     * given the current props for this component
+     */
+    hidden?: ContextDependentConfig<Ctx, boolean>;
+    /**
+     * If true, does not allow the user to use a dynamic expression for this prop
+     */
+    disableDynamicValue?: boolean;
+}

package/registerComponent/dist/version.d.ts

@@ -1 +1 @@
-export declare const hostVersion = "1.0.223";
+export declare const hostVersion = "1.0.225";

package/registerFunction/dist/exports.d.ts

@@ -4,9 +4,9 @@ export { PlasmicElement } from "./element-types";
 export { registerFetcher as unstable_registerFetcher } from "./fetcher";
 export * from "./global-actions";
 export * from "./link";
-export { ChoiceObject, ChoiceOptions, ChoiceValue, ContextDependentConfig, CustomControlProps, ProjectData, PropType, StudioOps, } from "./prop-types";
+export { ChoiceObject, ChoiceOptions, ChoiceValue, ComponentContextConfig, ComponentControlContext, ContextDependentConfig, ControlExtras, CustomControlProps, ProjectData, PropType, StudioOps, } from "./prop-types";
 export { Action, ActionProps, CodeComponentMeta, CodeComponentMode, ComponentHelpers, ComponentMeta, ComponentRegistration, ComponentTemplates, StateHelpers, StateSpec, default as registerComponent, stateHelpersKeys, } from "./registerComponent";
-export { CustomFunctionMeta, CustomFunctionRegistration, ParamType, default as registerFunction, } from "./registerFunction";
+export { CustomFunctionMeta, CustomFunctionRegistration, FunctionContextConfig, FunctionControlContext, ParamType, default as registerFunction, } from "./registerFunction";
 export { GlobalContextMeta, PropType as GlobalContextPropType, GlobalContextRegistration, default as registerGlobalContext, } from "./registerGlobalContext";
 export { TokenRegistration, TokenType, default as registerToken, } from "./registerToken";
 export { BasicTrait, ChoiceTrait, TraitMeta, TraitRegistration, default as registerTrait, } from "./registerTrait";

package/registerFunction/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":["../../src/registerFunction.ts"],"sourcesContent":["import { Nullish } from \"./type-utils\";\n\nconst root = globalThis as any;\n\n/**\n * Context that we pass back to control functions.\n */\nexport type ControlContext<P> = [\n  /**\n   * props\n   */\n  Partial<P>,\n  /**\n   * context data\n   */\n  any\n];\n\n/**\n * Config option that takes the context (e.g., props) of the function call\n * to dynamically set its value.\n */\nexport type ContextDependentConfig<P, R> = (...args: ControlContext<P>) => R;\n\nexport interface BaseParam {\n  name: string;\n  description?: string;\n  isOptional?: boolean;\n  isRestParameter?: boolean;\n}\n\nexport interface ChoiceTypeBase<P, T> extends BaseParam {\n  type: \"choice\";\n  options:\n    | T[]\n    | {\n        label: string;\n        value: T;\n      }[]\n    | ContextDependentConfig<\n        P,\n        | T[]\n        | {\n            label: string;\n            value: T;\n          }[]\n      >;\n  allowSearch?: boolean;\n  filterOption?: boolean;\n  onSearch?: ContextDependentConfig<P, ((value: string) => void) | undefined>;\n}\n\nexport interface SingleChoiceType<P, T> extends ChoiceTypeBase<P, T> {\n  multiSelect?: false;\n}\n\nexport interface MultiChoiceType<P, T> extends ChoiceTypeBase<P, T[]> {\n  multiSelect: true;\n}\n\nexport interface CustomChoiceType<P, T> extends ChoiceTypeBase<P, T | T[]> {\n  multiSelect: ContextDependentConfig<P, boolean>;\n}\n\nexport type ChoiceType<P, T> =\n  | SingleChoiceType<P, T>\n  | MultiChoiceType<P, T>\n  | CustomChoiceType<P, T>;\n\nexport interface PlainStringType<T extends Nullish<string> = string>\n  extends BaseParam {\n  type: \"string\" | `'${T}'`;\n}\n\nexport type StringType<P, T extends Nullish<string> = string> =\n  | \"string\"\n  | PlainStringType<T>\n  | ChoiceType<P, T>\n  | AnyType;\n\nexport interface PlainNumberType<T extends Nullish<number> = number>\n  extends BaseParam {\n  type: \"number\" | `${number extends T ? number : T}`;\n}\n\nexport type NumberType<P, T extends Nullish<number> = number> =\n  | PlainNumberType<T>\n  | ChoiceType<P, T>\n  | AnyType;\n\nexport interface PlainBooleanType<T extends Nullish<boolean> = boolean>\n  extends BaseParam {\n  type: \"boolean\" | `${boolean extends T ? boolean : T}`;\n}\n\nexport type BooleanType<P, T extends Nullish<boolean> = boolean> =\n  | PlainBooleanType<T>\n  | ChoiceType<P, T>\n  | AnyType;\n\nexport type GraphQLValue = {\n  query: string;\n  variables?: Record<string, any>;\n};\n\nexport interface GraphQLType<P> extends BaseParam {\n  type: \"code\";\n  lang: \"graphql\";\n  endpoint: string | ContextDependentConfig<P, string>;\n  method?: string | ContextDependentConfig<P, string>;\n  headers?: object | ContextDependentConfig<P, object>;\n}\n\nexport interface PlainNullType extends BaseParam {\n  type: \"null\";\n}\nexport type NullType = PlainNullType | AnyType;\n\nexport interface PlainUndefinedType extends BaseParam {\n  type: \"undefined\";\n}\nexport type UndefinedType = PlainUndefinedType | AnyType;\n\nexport interface PlainArrayType extends BaseParam {\n  type: \"array\";\n}\nexport type ArrayType = PlainArrayType | AnyType;\n\nexport interface PlainObjectType extends BaseParam {\n  type: \"object\";\n}\nexport type ObjectType = PlainObjectType | AnyType;\n\nexport interface PlainAnyType extends BaseParam {\n  type: \"any\";\n}\nexport type AnyType = PlainAnyType;\n\nexport interface PlainVoidType extends BaseParam {\n  type: \"void\";\n}\nexport type VoidType = PlainVoidType | AnyType;\n\ntype IsAny<T> = 0 extends 1 & T ? true : false;\n\ntype CommonType<P, T> = T extends GraphQLValue\n  ? GraphQLType<P>\n  : T extends null\n  ? NullType\n  : T extends undefined\n  ? UndefinedType\n  : T extends Array<any>\n  ? ArrayType\n  : T extends object\n  ? ObjectType\n  : AnyType;\n\ntype AnyTyping<P, T> = T extends string\n  ? StringType<P, T>\n  : T extends number\n  ? NumberType<P, T>\n  : T extends boolean\n  ? BooleanType<P, T>\n  : CommonType<P, T>;\n\nexport type RestrictedType<P, T> = IsAny<T> extends true\n  ? AnyTyping<P, T>\n  : [T] extends [Nullish<string>]\n  ? StringType<P, T>\n  : [T] extends [Nullish<number>]\n  ? NumberType<P, T>\n  : [T] extends [Nullish<boolean>]\n  ? BooleanType<P, T>\n  : CommonType<P, T>;\n\nexport type ParamType<P, T> = RestrictedType<P, T>;\n\nexport type RequiredParam<P, T> = ParamType<P, T> & {\n  isOptional?: false;\n  isRestParameter?: false;\n};\n\nexport type OptionalParam<P, T> = ParamType<P, T> & {\n  isRestParameter?: false;\n};\n\nexport type RestParam<P, T> = ParamType<P, T> & {\n  isOptional?: false;\n  isRestParameter: true;\n};\n\n// https://stackoverflow.com/questions/70684030/remove-all-optional-items-from-a-tuple-type\ntype RequiredParams<\n  T extends any[],\n  U extends any[] = []\n> = Partial<T> extends T\n  ? U\n  : T extends [infer F, ...infer R]\n  ? RequiredParams<R, [...U, F]>\n  : U;\n\ntype OptionalParams<T extends any[]> = T extends [\n  ...RequiredParams<T>,\n  ...infer R\n]\n  ? [...R]\n  : [];\n\ntype HandleRequiredParams<P, R extends any[]> = R extends [infer H, ...infer T]\n  ? [string | RequiredParam<P, H>, ...HandleRequiredParams<P, T>]\n  : [];\n\ntype HandleOptionalParams<P, R extends any[]> = R extends [infer H, ...infer T]\n  ?\n      | []\n      | [\n          string | OptionalParam<P, H | undefined>,\n          ...HandleOptionalParams<P, T>\n        ]\n  : R extends []\n  ? []\n  : R extends Array<infer T>\n  ? [] | [RestParam<P, T[]>]\n  : [];\n\nexport type HandleParams<P extends any[]> = [\n  ...HandleRequiredParams<P, RequiredParams<P>>,\n  ...HandleOptionalParams<P, Required<OptionalParams<P>>>\n];\n\nexport type HandleReturnType<P, T> = VoidType | ParamType<P, T>;\n\nexport interface CustomFunctionMeta<F extends (...args: any[]) => any> {\n  /**\n   * The javascript name of the function. Notice it must be unique across all\n   * other functions and function namespaces. If two functions have the same\n   * name, they should be registered with different `meta.namespace`.\n   */\n  name: string;\n  /**\n   * A namespace for organizing groups of functions. It's also used to handle\n   * function name collisions. If a function has a namespace, it will be used\n   * whenever accessing the function.\n   */\n  namespace?: string;\n  /**\n   * A display name for the function. It will be shown only in studio.\n   */\n  displayName?: string;\n  /**\n   * Documentation for the registered function.\n   */\n  description?: string;\n  /**\n   * An array containing the list of parameters names the function takes.\n   * Optionally they can also be registered with the expected param types.\n   */\n  params?: HandleParams<Parameters<F>>;\n  /**\n   * Return value information.\n   */\n  returnValue?: {\n    /**\n     * The function return type.\n     */\n    type?: HandleReturnType<Parameters<F>, ReturnType<F>>;\n    /**\n     * The function return value description.\n     */\n    description?: string;\n  };\n  /**\n   * Typescript function declaration. If specified, it ignores the types\n   * provided by `params` and `returnValue`.\n   */\n  typescriptDeclaration?: string;\n\n  /**\n   * Whether this function can be used as a query in the editor.\n   */\n  isQuery?: boolean;\n  /**\n   * The path to be used when importing the function in the generated code.\n   * It can be the name of the package that contains the function, or the path\n   * to the file in the project (relative to the root directory).\n   */\n  importPath: string;\n  /**\n   * Whether the function is the default export from that path. Optional: if\n   * not specified, it's considered `false`.\n   */\n  isDefaultExport?: boolean;\n\n  /**\n   * A function that takes the function arguments and returns a data key\n   * and a fetcher function.\n   * The data key is used to cache the result of the fetcher, and should only\n   * include the arguments that are used to fetch the data.\n   * The result of the fetcher will be used as the context of the function\n   * in studio and should return a promise.\n   */\n  fnContext?: (...args: Partial<Parameters<F>>) => {\n    dataKey: string;\n    fetcher: () => Promise<any>;\n  };\n}\n\nexport interface CustomFunctionRegistration {\n  function: (...args: any[]) => any;\n  meta: CustomFunctionMeta<any>;\n}\n\ndeclare global {\n  interface Window {\n    __PlasmicFunctionsRegistry: CustomFunctionRegistration[];\n  }\n}\n\nif (root.__PlasmicFunctionsRegistry == null) {\n  root.__PlasmicFunctionsRegistry = [];\n}\n\nexport default function registerFunction<F extends (...args: any[]) => any>(\n  fn: F,\n  meta: CustomFunctionMeta<F>\n) {\n  // Check for duplicates\n  if (\n    root.__PlasmicFunctionsRegistry.some(\n      (r: CustomFunctionRegistration) =>\n        r.function === fn &&\n        r.meta.name === meta.name &&\n        r.meta.namespace == meta.namespace\n    )\n  ) {\n    return;\n  }\n  root.__PlasmicFunctionsRegistry.push({ function: fn, meta });\n}\n"],"names":[],"mappings":";;;;;AAEA,IAAM,IAAI,GAAG,UAAiB,CAAC;AA4T/B,IAAI,IAAI,CAAC,0BAA0B,IAAI,IAAI,EAAE;AAC3C,IAAA,IAAI,CAAC,0BAA0B,GAAG,EAAE,CAAC;AACtC,CAAA;AAEa,SAAU,gBAAgB,CACtC,EAAK,EACL,IAA2B,EAAA;;AAG3B,IAAA,IACE,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAClC,UAAC,CAA6B,EAAA;AAC5B,QAAA,OAAA,CAAC,CAAC,QAAQ,KAAK,EAAE;AACjB,YAAA,CAAC,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI;AACzB,YAAA,CAAC,CAAC,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,CAAA;AAFlC,KAEkC,CACrC,EACD;QACA,OAAO;AACR,KAAA;AACD,IAAA,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAA,IAAA,EAAE,CAAC,CAAC;AAC/D;;;;"}
+{"version":3,"file":"index.cjs.js","sources":["../../src/registerFunction.ts"],"sourcesContent":["const root = globalThis as any;\n\nimport { HandleParams, HandleReturnType } from \"./types/function-types\";\nexport type * from \"./types/function-types\";\n\nexport interface CustomFunctionMeta<F extends (...args: any[]) => any> {\n  /**\n   * The javascript name of the function. Notice it must be unique across all\n   * other functions and function namespaces. If two functions have the same\n   * name, they should be registered with different `meta.namespace`.\n   */\n  name: string;\n  /**\n   * A namespace for organizing groups of functions. It's also used to handle\n   * function name collisions. If a function has a namespace, it will be used\n   * whenever accessing the function.\n   */\n  namespace?: string;\n  /**\n   * A display name for the function. It will be shown only in studio.\n   */\n  displayName?: string;\n  /**\n   * Documentation for the registered function.\n   */\n  description?: string;\n  /**\n   * An array containing the list of parameters names the function takes.\n   * Optionally they can also be registered with the expected param types.\n   */\n  params?: HandleParams<Parameters<F>>;\n  /**\n   * Return value information.\n   */\n  returnValue?: {\n    /**\n     * The function return type.\n     */\n    type?: HandleReturnType<Parameters<F>, ReturnType<F>>;\n    /**\n     * The function return value description.\n     */\n    description?: string;\n  };\n  /**\n   * Typescript function declaration. If specified, it ignores the types\n   * provided by `params` and `returnValue`.\n   */\n  typescriptDeclaration?: string;\n\n  /**\n   * Whether this function can be used as a query in the editor.\n   */\n  isQuery?: boolean;\n  /**\n   * The path to be used when importing the function in the generated code.\n   * It can be the name of the package that contains the function, or the path\n   * to the file in the project (relative to the root directory).\n   */\n  importPath: string;\n  /**\n   * Whether the function is the default export from that path. Optional: if\n   * not specified, it's considered `false`.\n   */\n  isDefaultExport?: boolean;\n\n  /**\n   * A function that takes the function arguments and returns a data key\n   * and a fetcher function.\n   * The data key is used to cache the result of the fetcher, and should only\n   * include the arguments that are used to fetch the data.\n   * The result of the fetcher will be used as the context of the function\n   * in studio and should return a promise.\n   */\n  fnContext?: (...args: Partial<Parameters<F>>) => {\n    dataKey: string;\n    fetcher: () => Promise<any>;\n  };\n}\n\nexport interface CustomFunctionRegistration {\n  function: (...args: any[]) => any;\n  meta: CustomFunctionMeta<any>;\n}\n\ndeclare global {\n  interface Window {\n    __PlasmicFunctionsRegistry: CustomFunctionRegistration[];\n  }\n}\n\nif (root.__PlasmicFunctionsRegistry == null) {\n  root.__PlasmicFunctionsRegistry = [];\n}\n\nexport default function registerFunction<F extends (...args: any[]) => any>(\n  fn: F,\n  meta: CustomFunctionMeta<F>\n) {\n  // Check for duplicates\n  if (\n    root.__PlasmicFunctionsRegistry.some(\n      (r: CustomFunctionRegistration) =>\n        r.function === fn &&\n        r.meta.name === meta.name &&\n        r.meta.namespace == meta.namespace\n    )\n  ) {\n    return;\n  }\n  root.__PlasmicFunctionsRegistry.push({ function: fn, meta });\n}\n"],"names":[],"mappings":";;;;;AAAA,IAAM,IAAI,GAAG,UAAiB,CAAC;AA2F/B,IAAI,IAAI,CAAC,0BAA0B,IAAI,IAAI,EAAE;AAC3C,IAAA,IAAI,CAAC,0BAA0B,GAAG,EAAE,CAAC;AACtC,CAAA;AAEa,SAAU,gBAAgB,CACtC,EAAK,EACL,IAA2B,EAAA;;AAG3B,IAAA,IACE,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAClC,UAAC,CAA6B,EAAA;AAC5B,QAAA,OAAA,CAAC,CAAC,QAAQ,KAAK,EAAE;AACjB,YAAA,CAAC,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI;AACzB,YAAA,CAAC,CAAC,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,CAAA;AAFlC,KAEkC,CACrC,EACD;QACA,OAAO;AACR,KAAA;AACD,IAAA,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAA,IAAA,EAAE,CAAC,CAAC;AAC/D;;;;"}

package/registerFunction/dist/index.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.esm.js","sources":["../../src/registerFunction.ts"],"sourcesContent":["import { Nullish } from \"./type-utils\";\n\nconst root = globalThis as any;\n\n/**\n * Context that we pass back to control functions.\n */\nexport type ControlContext<P> = [\n  /**\n   * props\n   */\n  Partial<P>,\n  /**\n   * context data\n   */\n  any\n];\n\n/**\n * Config option that takes the context (e.g., props) of the function call\n * to dynamically set its value.\n */\nexport type ContextDependentConfig<P, R> = (...args: ControlContext<P>) => R;\n\nexport interface BaseParam {\n  name: string;\n  description?: string;\n  isOptional?: boolean;\n  isRestParameter?: boolean;\n}\n\nexport interface ChoiceTypeBase<P, T> extends BaseParam {\n  type: \"choice\";\n  options:\n    | T[]\n    | {\n        label: string;\n        value: T;\n      }[]\n    | ContextDependentConfig<\n        P,\n        | T[]\n        | {\n            label: string;\n            value: T;\n          }[]\n      >;\n  allowSearch?: boolean;\n  filterOption?: boolean;\n  onSearch?: ContextDependentConfig<P, ((value: string) => void) | undefined>;\n}\n\nexport interface SingleChoiceType<P, T> extends ChoiceTypeBase<P, T> {\n  multiSelect?: false;\n}\n\nexport interface MultiChoiceType<P, T> extends ChoiceTypeBase<P, T[]> {\n  multiSelect: true;\n}\n\nexport interface CustomChoiceType<P, T> extends ChoiceTypeBase<P, T | T[]> {\n  multiSelect: ContextDependentConfig<P, boolean>;\n}\n\nexport type ChoiceType<P, T> =\n  | SingleChoiceType<P, T>\n  | MultiChoiceType<P, T>\n  | CustomChoiceType<P, T>;\n\nexport interface PlainStringType<T extends Nullish<string> = string>\n  extends BaseParam {\n  type: \"string\" | `'${T}'`;\n}\n\nexport type StringType<P, T extends Nullish<string> = string> =\n  | \"string\"\n  | PlainStringType<T>\n  | ChoiceType<P, T>\n  | AnyType;\n\nexport interface PlainNumberType<T extends Nullish<number> = number>\n  extends BaseParam {\n  type: \"number\" | `${number extends T ? number : T}`;\n}\n\nexport type NumberType<P, T extends Nullish<number> = number> =\n  | PlainNumberType<T>\n  | ChoiceType<P, T>\n  | AnyType;\n\nexport interface PlainBooleanType<T extends Nullish<boolean> = boolean>\n  extends BaseParam {\n  type: \"boolean\" | `${boolean extends T ? boolean : T}`;\n}\n\nexport type BooleanType<P, T extends Nullish<boolean> = boolean> =\n  | PlainBooleanType<T>\n  | ChoiceType<P, T>\n  | AnyType;\n\nexport type GraphQLValue = {\n  query: string;\n  variables?: Record<string, any>;\n};\n\nexport interface GraphQLType<P> extends BaseParam {\n  type: \"code\";\n  lang: \"graphql\";\n  endpoint: string | ContextDependentConfig<P, string>;\n  method?: string | ContextDependentConfig<P, string>;\n  headers?: object | ContextDependentConfig<P, object>;\n}\n\nexport interface PlainNullType extends BaseParam {\n  type: \"null\";\n}\nexport type NullType = PlainNullType | AnyType;\n\nexport interface PlainUndefinedType extends BaseParam {\n  type: \"undefined\";\n}\nexport type UndefinedType = PlainUndefinedType | AnyType;\n\nexport interface PlainArrayType extends BaseParam {\n  type: \"array\";\n}\nexport type ArrayType = PlainArrayType | AnyType;\n\nexport interface PlainObjectType extends BaseParam {\n  type: \"object\";\n}\nexport type ObjectType = PlainObjectType | AnyType;\n\nexport interface PlainAnyType extends BaseParam {\n  type: \"any\";\n}\nexport type AnyType = PlainAnyType;\n\nexport interface PlainVoidType extends BaseParam {\n  type: \"void\";\n}\nexport type VoidType = PlainVoidType | AnyType;\n\ntype IsAny<T> = 0 extends 1 & T ? true : false;\n\ntype CommonType<P, T> = T extends GraphQLValue\n  ? GraphQLType<P>\n  : T extends null\n  ? NullType\n  : T extends undefined\n  ? UndefinedType\n  : T extends Array<any>\n  ? ArrayType\n  : T extends object\n  ? ObjectType\n  : AnyType;\n\ntype AnyTyping<P, T> = T extends string\n  ? StringType<P, T>\n  : T extends number\n  ? NumberType<P, T>\n  : T extends boolean\n  ? BooleanType<P, T>\n  : CommonType<P, T>;\n\nexport type RestrictedType<P, T> = IsAny<T> extends true\n  ? AnyTyping<P, T>\n  : [T] extends [Nullish<string>]\n  ? StringType<P, T>\n  : [T] extends [Nullish<number>]\n  ? NumberType<P, T>\n  : [T] extends [Nullish<boolean>]\n  ? BooleanType<P, T>\n  : CommonType<P, T>;\n\nexport type ParamType<P, T> = RestrictedType<P, T>;\n\nexport type RequiredParam<P, T> = ParamType<P, T> & {\n  isOptional?: false;\n  isRestParameter?: false;\n};\n\nexport type OptionalParam<P, T> = ParamType<P, T> & {\n  isRestParameter?: false;\n};\n\nexport type RestParam<P, T> = ParamType<P, T> & {\n  isOptional?: false;\n  isRestParameter: true;\n};\n\n// https://stackoverflow.com/questions/70684030/remove-all-optional-items-from-a-tuple-type\ntype RequiredParams<\n  T extends any[],\n  U extends any[] = []\n> = Partial<T> extends T\n  ? U\n  : T extends [infer F, ...infer R]\n  ? RequiredParams<R, [...U, F]>\n  : U;\n\ntype OptionalParams<T extends any[]> = T extends [\n  ...RequiredParams<T>,\n  ...infer R\n]\n  ? [...R]\n  : [];\n\ntype HandleRequiredParams<P, R extends any[]> = R extends [infer H, ...infer T]\n  ? [string | RequiredParam<P, H>, ...HandleRequiredParams<P, T>]\n  : [];\n\ntype HandleOptionalParams<P, R extends any[]> = R extends [infer H, ...infer T]\n  ?\n      | []\n      | [\n          string | OptionalParam<P, H | undefined>,\n          ...HandleOptionalParams<P, T>\n        ]\n  : R extends []\n  ? []\n  : R extends Array<infer T>\n  ? [] | [RestParam<P, T[]>]\n  : [];\n\nexport type HandleParams<P extends any[]> = [\n  ...HandleRequiredParams<P, RequiredParams<P>>,\n  ...HandleOptionalParams<P, Required<OptionalParams<P>>>\n];\n\nexport type HandleReturnType<P, T> = VoidType | ParamType<P, T>;\n\nexport interface CustomFunctionMeta<F extends (...args: any[]) => any> {\n  /**\n   * The javascript name of the function. Notice it must be unique across all\n   * other functions and function namespaces. If two functions have the same\n   * name, they should be registered with different `meta.namespace`.\n   */\n  name: string;\n  /**\n   * A namespace for organizing groups of functions. It's also used to handle\n   * function name collisions. If a function has a namespace, it will be used\n   * whenever accessing the function.\n   */\n  namespace?: string;\n  /**\n   * A display name for the function. It will be shown only in studio.\n   */\n  displayName?: string;\n  /**\n   * Documentation for the registered function.\n   */\n  description?: string;\n  /**\n   * An array containing the list of parameters names the function takes.\n   * Optionally they can also be registered with the expected param types.\n   */\n  params?: HandleParams<Parameters<F>>;\n  /**\n   * Return value information.\n   */\n  returnValue?: {\n    /**\n     * The function return type.\n     */\n    type?: HandleReturnType<Parameters<F>, ReturnType<F>>;\n    /**\n     * The function return value description.\n     */\n    description?: string;\n  };\n  /**\n   * Typescript function declaration. If specified, it ignores the types\n   * provided by `params` and `returnValue`.\n   */\n  typescriptDeclaration?: string;\n\n  /**\n   * Whether this function can be used as a query in the editor.\n   */\n  isQuery?: boolean;\n  /**\n   * The path to be used when importing the function in the generated code.\n   * It can be the name of the package that contains the function, or the path\n   * to the file in the project (relative to the root directory).\n   */\n  importPath: string;\n  /**\n   * Whether the function is the default export from that path. Optional: if\n   * not specified, it's considered `false`.\n   */\n  isDefaultExport?: boolean;\n\n  /**\n   * A function that takes the function arguments and returns a data key\n   * and a fetcher function.\n   * The data key is used to cache the result of the fetcher, and should only\n   * include the arguments that are used to fetch the data.\n   * The result of the fetcher will be used as the context of the function\n   * in studio and should return a promise.\n   */\n  fnContext?: (...args: Partial<Parameters<F>>) => {\n    dataKey: string;\n    fetcher: () => Promise<any>;\n  };\n}\n\nexport interface CustomFunctionRegistration {\n  function: (...args: any[]) => any;\n  meta: CustomFunctionMeta<any>;\n}\n\ndeclare global {\n  interface Window {\n    __PlasmicFunctionsRegistry: CustomFunctionRegistration[];\n  }\n}\n\nif (root.__PlasmicFunctionsRegistry == null) {\n  root.__PlasmicFunctionsRegistry = [];\n}\n\nexport default function registerFunction<F extends (...args: any[]) => any>(\n  fn: F,\n  meta: CustomFunctionMeta<F>\n) {\n  // Check for duplicates\n  if (\n    root.__PlasmicFunctionsRegistry.some(\n      (r: CustomFunctionRegistration) =>\n        r.function === fn &&\n        r.meta.name === meta.name &&\n        r.meta.namespace == meta.namespace\n    )\n  ) {\n    return;\n  }\n  root.__PlasmicFunctionsRegistry.push({ function: fn, meta });\n}\n"],"names":[],"mappings":";AAEA,IAAM,IAAI,GAAG,UAAiB,CAAC;AA4T/B,IAAI,IAAI,CAAC,0BAA0B,IAAI,IAAI,EAAE;AAC3C,IAAA,IAAI,CAAC,0BAA0B,GAAG,EAAE,CAAC;AACtC,CAAA;AAEa,SAAU,gBAAgB,CACtC,EAAK,EACL,IAA2B,EAAA;;AAG3B,IAAA,IACE,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAClC,UAAC,CAA6B,EAAA;AAC5B,QAAA,OAAA,CAAC,CAAC,QAAQ,KAAK,EAAE;AACjB,YAAA,CAAC,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI;AACzB,YAAA,CAAC,CAAC,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,CAAA;AAFlC,KAEkC,CACrC,EACD;QACA,OAAO;AACR,KAAA;AACD,IAAA,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAA,IAAA,EAAE,CAAC,CAAC;AAC/D;;;;"}
+{"version":3,"file":"index.esm.js","sources":["../../src/registerFunction.ts"],"sourcesContent":["const root = globalThis as any;\n\nimport { HandleParams, HandleReturnType } from \"./types/function-types\";\nexport type * from \"./types/function-types\";\n\nexport interface CustomFunctionMeta<F extends (...args: any[]) => any> {\n  /**\n   * The javascript name of the function. Notice it must be unique across all\n   * other functions and function namespaces. If two functions have the same\n   * name, they should be registered with different `meta.namespace`.\n   */\n  name: string;\n  /**\n   * A namespace for organizing groups of functions. It's also used to handle\n   * function name collisions. If a function has a namespace, it will be used\n   * whenever accessing the function.\n   */\n  namespace?: string;\n  /**\n   * A display name for the function. It will be shown only in studio.\n   */\n  displayName?: string;\n  /**\n   * Documentation for the registered function.\n   */\n  description?: string;\n  /**\n   * An array containing the list of parameters names the function takes.\n   * Optionally they can also be registered with the expected param types.\n   */\n  params?: HandleParams<Parameters<F>>;\n  /**\n   * Return value information.\n   */\n  returnValue?: {\n    /**\n     * The function return type.\n     */\n    type?: HandleReturnType<Parameters<F>, ReturnType<F>>;\n    /**\n     * The function return value description.\n     */\n    description?: string;\n  };\n  /**\n   * Typescript function declaration. If specified, it ignores the types\n   * provided by `params` and `returnValue`.\n   */\n  typescriptDeclaration?: string;\n\n  /**\n   * Whether this function can be used as a query in the editor.\n   */\n  isQuery?: boolean;\n  /**\n   * The path to be used when importing the function in the generated code.\n   * It can be the name of the package that contains the function, or the path\n   * to the file in the project (relative to the root directory).\n   */\n  importPath: string;\n  /**\n   * Whether the function is the default export from that path. Optional: if\n   * not specified, it's considered `false`.\n   */\n  isDefaultExport?: boolean;\n\n  /**\n   * A function that takes the function arguments and returns a data key\n   * and a fetcher function.\n   * The data key is used to cache the result of the fetcher, and should only\n   * include the arguments that are used to fetch the data.\n   * The result of the fetcher will be used as the context of the function\n   * in studio and should return a promise.\n   */\n  fnContext?: (...args: Partial<Parameters<F>>) => {\n    dataKey: string;\n    fetcher: () => Promise<any>;\n  };\n}\n\nexport interface CustomFunctionRegistration {\n  function: (...args: any[]) => any;\n  meta: CustomFunctionMeta<any>;\n}\n\ndeclare global {\n  interface Window {\n    __PlasmicFunctionsRegistry: CustomFunctionRegistration[];\n  }\n}\n\nif (root.__PlasmicFunctionsRegistry == null) {\n  root.__PlasmicFunctionsRegistry = [];\n}\n\nexport default function registerFunction<F extends (...args: any[]) => any>(\n  fn: F,\n  meta: CustomFunctionMeta<F>\n) {\n  // Check for duplicates\n  if (\n    root.__PlasmicFunctionsRegistry.some(\n      (r: CustomFunctionRegistration) =>\n        r.function === fn &&\n        r.meta.name === meta.name &&\n        r.meta.namespace == meta.namespace\n    )\n  ) {\n    return;\n  }\n  root.__PlasmicFunctionsRegistry.push({ function: fn, meta });\n}\n"],"names":[],"mappings":";AAAA,IAAM,IAAI,GAAG,UAAiB,CAAC;AA2F/B,IAAI,IAAI,CAAC,0BAA0B,IAAI,IAAI,EAAE;AAC3C,IAAA,IAAI,CAAC,0BAA0B,GAAG,EAAE,CAAC;AACtC,CAAA;AAEa,SAAU,gBAAgB,CACtC,EAAK,EACL,IAA2B,EAAA;;AAG3B,IAAA,IACE,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAClC,UAAC,CAA6B,EAAA;AAC5B,QAAA,OAAA,CAAC,CAAC,QAAQ,KAAK,EAAE;AACjB,YAAA,CAAC,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI;AACzB,YAAA,CAAC,CAAC,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,CAAA;AAFlC,KAEkC,CACrC,EACD;QACA,OAAO;AACR,KAAA;AACD,IAAA,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAA,IAAA,EAAE,CAAC,CAAC;AAC/D;;;;"}