@plasmicapp/host 2.0.0-test.0 → 2.0.0

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

@@ -0,0 +1,50 @@
+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 {
+    description?: string;
+    helpText?: string;
+    /**
+     * If true, will hide the prop in a collapsed section; good for props that
+     * should not usually be used.
+     */
+    advanced?: 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;
+    /**
+     * If true, does not allow the user to use a dynamic expression for this prop
+     */
+    disableDynamicValue?: boolean;
+}
+export interface Defaultable<Ctx extends any[], T> {
+    /**
+     * Default value to set for this prop when the component is instantiated
+     */
+    defaultValue?: T;
+    /**
+     * Specify that default when no prop/param is provided,
+     * so the Plasmic user can see it in the studio UI
+     */
+    defaultValueHint?: T | ContextDependentConfig<Ctx, T | undefined>;
+}

package/registerTrait/dist/version.d.ts

@@ -1 +1 @@
-export declare const hostVersion = "2.0.0-test.0";
+export declare const hostVersion = "2.0.0";

package/dist/fetcher.d.ts

@@ -1,40 +0,0 @@
-import { PrimitiveType } from "./prop-types";
-export type Fetcher = (...args: any[]) => Promise<any>;
-export interface FetcherMeta {
-    /**
-     * Any unique identifying string for this fetcher.
-     */
-    name: string;
-    /**
-     * The Studio-user-friendly display name.
-     */
-    displayName?: string;
-    /**
-     * The symbol to import from the importPath.
-     */
-    importName?: string;
-    args: {
-        name: string;
-        type: PrimitiveType;
-    }[];
-    returns: PrimitiveType;
-    /**
-     * Either the path to the fetcher relative to `rootDir` or the npm
-     * package name
-     */
-    importPath: string;
-    /**
-     * Whether it's a default export or named export
-     */
-    isDefaultExport?: boolean;
-}
-export interface FetcherRegistration {
-    fetcher: Fetcher;
-    meta: FetcherMeta;
-}
-declare global {
-    interface Window {
-        __PlasmicFetcherRegistry: FetcherRegistration[];
-    }
-}
-export declare function registerFetcher(fetcher: Fetcher, meta: FetcherMeta): void;

package/registerComponent/dist/fetcher.d.ts

@@ -1,40 +0,0 @@
-import { PrimitiveType } from "./prop-types";
-export type Fetcher = (...args: any[]) => Promise<any>;
-export interface FetcherMeta {
-    /**
-     * Any unique identifying string for this fetcher.
-     */
-    name: string;
-    /**
-     * The Studio-user-friendly display name.
-     */
-    displayName?: string;
-    /**
-     * The symbol to import from the importPath.
-     */
-    importName?: string;
-    args: {
-        name: string;
-        type: PrimitiveType;
-    }[];
-    returns: PrimitiveType;
-    /**
-     * Either the path to the fetcher relative to `rootDir` or the npm
-     * package name
-     */
-    importPath: string;
-    /**
-     * Whether it's a default export or named export
-     */
-    isDefaultExport?: boolean;
-}
-export interface FetcherRegistration {
-    fetcher: Fetcher;
-    meta: FetcherMeta;
-}
-declare global {
-    interface Window {
-        __PlasmicFetcherRegistry: FetcherRegistration[];
-    }
-}
-export declare function registerFetcher(fetcher: Fetcher, meta: FetcherMeta): void;

package/registerFunction/dist/fetcher.d.ts

@@ -1,40 +0,0 @@
-import { PrimitiveType } from "./prop-types";
-export type Fetcher = (...args: any[]) => Promise<any>;
-export interface FetcherMeta {
-    /**
-     * Any unique identifying string for this fetcher.
-     */
-    name: string;
-    /**
-     * The Studio-user-friendly display name.
-     */
-    displayName?: string;
-    /**
-     * The symbol to import from the importPath.
-     */
-    importName?: string;
-    args: {
-        name: string;
-        type: PrimitiveType;
-    }[];
-    returns: PrimitiveType;
-    /**
-     * Either the path to the fetcher relative to `rootDir` or the npm
-     * package name
-     */
-    importPath: string;
-    /**
-     * Whether it's a default export or named export
-     */
-    isDefaultExport?: boolean;
-}
-export interface FetcherRegistration {
-    fetcher: Fetcher;
-    meta: FetcherMeta;
-}
-declare global {
-    interface Window {
-        __PlasmicFetcherRegistry: FetcherRegistration[];
-    }
-}
-export declare function registerFetcher(fetcher: Fetcher, meta: FetcherMeta): void;

package/registerGlobalContext/dist/fetcher.d.ts

@@ -1,40 +0,0 @@
-import { PrimitiveType } from "./prop-types";
-export type Fetcher = (...args: any[]) => Promise<any>;
-export interface FetcherMeta {
-    /**
-     * Any unique identifying string for this fetcher.
-     */
-    name: string;
-    /**
-     * The Studio-user-friendly display name.
-     */
-    displayName?: string;
-    /**
-     * The symbol to import from the importPath.
-     */
-    importName?: string;
-    args: {
-        name: string;
-        type: PrimitiveType;
-    }[];
-    returns: PrimitiveType;
-    /**
-     * Either the path to the fetcher relative to `rootDir` or the npm
-     * package name
-     */
-    importPath: string;
-    /**
-     * Whether it's a default export or named export
-     */
-    isDefaultExport?: boolean;
-}
-export interface FetcherRegistration {
-    fetcher: Fetcher;
-    meta: FetcherMeta;
-}
-declare global {
-    interface Window {
-        __PlasmicFetcherRegistry: FetcherRegistration[];
-    }
-}
-export declare function registerFetcher(fetcher: Fetcher, meta: FetcherMeta): void;

package/registerToken/dist/fetcher.d.ts

@@ -1,40 +0,0 @@
-import { PrimitiveType } from "./prop-types";
-export type Fetcher = (...args: any[]) => Promise<any>;
-export interface FetcherMeta {
-    /**
-     * Any unique identifying string for this fetcher.
-     */
-    name: string;
-    /**
-     * The Studio-user-friendly display name.
-     */
-    displayName?: string;
-    /**
-     * The symbol to import from the importPath.
-     */
-    importName?: string;
-    args: {
-        name: string;
-        type: PrimitiveType;
-    }[];
-    returns: PrimitiveType;
-    /**
-     * Either the path to the fetcher relative to `rootDir` or the npm
-     * package name
-     */
-    importPath: string;
-    /**
-     * Whether it's a default export or named export
-     */
-    isDefaultExport?: boolean;
-}
-export interface FetcherRegistration {
-    fetcher: Fetcher;
-    meta: FetcherMeta;
-}
-declare global {
-    interface Window {
-        __PlasmicFetcherRegistry: FetcherRegistration[];
-    }
-}
-export declare function registerFetcher(fetcher: Fetcher, meta: FetcherMeta): void;

package/registerTrait/dist/fetcher.d.ts

@@ -1,40 +0,0 @@
-import { PrimitiveType } from "./prop-types";
-export type Fetcher = (...args: any[]) => Promise<any>;
-export interface FetcherMeta {
-    /**
-     * Any unique identifying string for this fetcher.
-     */
-    name: string;
-    /**
-     * The Studio-user-friendly display name.
-     */
-    displayName?: string;
-    /**
-     * The symbol to import from the importPath.
-     */
-    importName?: string;
-    args: {
-        name: string;
-        type: PrimitiveType;
-    }[];
-    returns: PrimitiveType;
-    /**
-     * Either the path to the fetcher relative to `rootDir` or the npm
-     * package name
-     */
-    importPath: string;
-    /**
-     * Whether it's a default export or named export
-     */
-    isDefaultExport?: boolean;
-}
-export interface FetcherRegistration {
-    fetcher: Fetcher;
-    meta: FetcherMeta;
-}
-declare global {
-    interface Window {
-        __PlasmicFetcherRegistry: FetcherRegistration[];
-    }
-}
-export declare function registerFetcher(fetcher: Fetcher, meta: FetcherMeta): void;