@plaidev/karte-action-sdk 1.1.123 → 1.1.124-27946655.bba7dcb4

package/dist/index.es.d.ts

@@ -559,11 +559,13 @@ declare const state: Store<string>;
  * 現在のステートを設定する
  *
  * @param stateId - 表示するステートID
- * @param force - 強制的にステートを設定するフラグ。デフォルトは `false`
+ * @param options - オプション。`options.disableInPreview`でプレビュー時のステート遷移を無効化できます。
  *
  * @public
  */
-declare function setState(stateId: string, force?: boolean): void;
+declare function setState(stateId: string, options?: {
+    disableInPreview: boolean;
+}): void;
 /**
  * 現在のステートを取得する
  *
@@ -892,10 +894,8 @@ type Event = {
     values?: any;
     date?: Date;
 };
-// 実行ログ
-declare let messages: Log[];
-// KARTEイベント
-declare let events: Event[];
+declare function getLogs(): Log[];
+declare function getEvents(): Event[];
 /**
  * ログを送信する関数群
  */
@@ -1036,6 +1036,82 @@ declare function showOnScroll<Props extends Pick<_Props, "show_on_scroll" | "sho
  * @internal
  */
 declare function showOnTime<Props extends Pick<_Props, "show_on_time" | "show_on_time_count">>(props: Props, show?: Function): (() => void) | null;
+type ActionTableResult = number | string | boolean | Date | null | undefined;
+type ActionTableQueryParam = string | number | boolean | Date;
+type ActionTableQueryParams = {
+    [key: string]: ActionTableQueryParam | ActionTableQueryParam[];
+};
+/**
+ * アクションテーブルの設定情報
+ *
+ * @public
+ */
+type CollectionConfig = {
+    /**
+     * APIキー
+     */
+    api_key: string;
+    /**
+     * テーブル名
+     */
+    table: string;
+    /**
+     * エンドポイント
+     */
+    endpoint?: string;
+};
+/**
+ * アクションテーブルを管理するメソッドを取得する
+ *
+ * @param config - 設定情報
+ *
+ * @returns メソッドを返します
+ *
+ * @public
+ */
+declare function collection(config: CollectionConfig): {
+    get(key: string | Array<string>, cb: (err: Error | null, items?: ActionTableResult | Array<ActionTableResult>) => void): void;
+    getByQuery(query_name: string, params: ActionTableQueryParams, options: {
+        ignore_fields?: string[];
+    } | null | undefined, cb: (err: Error | null, items?: Array<ActionTableResult>) => void): void;
+    set(key: string, value: string, cb: (err: Error | null) => void): void;
+};
+type ActionTableRowRequestConfig = {
+    resolver: "action-table-row";
+    name: string;
+    default: {
+        table_name: string;
+        key: string;
+        default_value?: ActionTableResult;
+    };
+    preview_value?: ActionTableResult;
+};
+type ActionTableRowsRequestConfig = {
+    resolver: "action-table-rows";
+    name: string;
+    default: {
+        table_name: string;
+        key: Array<string>;
+        default_value?: Array<ActionTableResult>;
+    };
+    preview_value?: Array<ActionTableResult>;
+};
+type ActionTableQueryRequestConfig = {
+    resolver: "action-table-query";
+    name: string;
+    default: {
+        table_name: string;
+        query_name: string;
+        params?: ActionTableQueryParams;
+        default_value?: Array<ActionTableResult>;
+    };
+    preview_value?: Array<ActionTableResult>;
+};
+type ActionTableRequestConfig = ActionTableRowRequestConfig | ActionTableRowsRequestConfig | ActionTableQueryRequestConfig;
+declare const loadActionTableRow: (config: ActionTableRowRequestConfig, api_key: string, endpoint?: string) => Promise<unknown>;
+declare const loadActionTableRows: (config: ActionTableRowsRequestConfig, api_key: string, endpoint?: string) => Promise<unknown>;
+declare const loadActionTableQuery: (config: ActionTableQueryRequestConfig, api_key: string, endpoint?: string) => Promise<unknown>;
+declare const loadActionTable: (config: Array<ActionTableRequestConfig>, api_key: string, endpoint?: string) => Promise<{}>;
 type _Props$0 = Props;
 /**
  * アクションのライフサイクルで呼び出されるフック
@@ -1137,7 +1213,7 @@ interface ActionProps<Props, Variables> {
  *
  * @public
  */
-interface ActionOptions<Props, Variables> {
+interface ActionOptions<Props, Variables, VariablesQuery> {
     /**
      * アクションでイベントがトリガーされたときに受信するための関数
      *
@@ -1151,11 +1227,17 @@ interface ActionOptions<Props, Variables> {
      */
     props?: Props;
     /**
-     * アクションで使用されるアクションテーブルのユーザー環境変数
+     * アクションで使用される解析時に取得される変数
      *
      * @defaultValue `{}`
      */
     variables?: Variables;
+    /**
+     * アクションで使用されるアクション実行時に取得される変数
+     *
+     * @defaultValue `[]`
+     */
+    localVariablesQuery?: VariablesQuery;
     /**
      * アクションが作成されているときにフックされる {@link onCreate}
      *
@@ -1173,7 +1255,7 @@ interface ActionOptions<Props, Variables> {
  *
  * @public
  */
-declare function create<Props extends _Props$0, Variables>(App: typeof SvelteComponentDev, options?: ActionOptions<Props, Variables & CustomVariables>): () => void;
+declare function create<Props extends _Props$0, Variables, VariablesQuery extends ActionTableRequestConfig[]>(App: typeof SvelteComponentDev, options?: ActionOptions<Props, Variables & CustomVariables, VariablesQuery>): () => void;
 /**
  * アクションの破棄する
  *
@@ -1289,7 +1371,7 @@ declare const close: typeof closeAction;
  *
  * @internal
  */
-type AppOptions<Props, Variables> = ActionOptions<Props, Variables>;
+type AppOptions<Props, Variables, VariablesQuery> = ActionOptions<Props, Variables, VariablesQuery>;
 /**
  * App application instance that is with {@link createApp}
  *
@@ -1321,44 +1403,7 @@ interface App {
  *
  * @internal
  */
-declare function createApp<Props, Variables>(App: typeof SvelteComponentDev, options?: AppOptions<Props, Variables>): App;
-/**
- * アクションテーブルの設定情報
- *
- * @public
- */
-type CollectionConfig = {
-    /**
-     * APIキー
-     */
-    api_key: string;
-    /**
-     * テーブル名
-     */
-    table: string;
-    /**
-     * エンドポイント
-     */
-    endpoint?: string;
-};
-/**
- * アクションテーブルを管理するメソッドを取得する
- *
- * @param config - 設定情報
- *
- * @returns メソッドを返します
- *
- * @public
- */
-declare function collection(config: CollectionConfig): {
-    get(key: string | string[], cb: (err: Error | null, items?: any) => void): void;
-    getByQuery(query_name: string, params: {
-        [p: string]: string | number | boolean | (string | number | boolean)[];
-    }, options: {
-        ignore_fields?: string[];
-    } | null | undefined, cb: (err: Error | null, items?: any) => void): void;
-    set(key: string, value: string, cb: (err: Error | null) => void): void;
-};
+declare function createApp<Props, Variables, VariablesQuery>(App: typeof SvelteComponentDev, options?: AppOptions<Props, Variables, VariablesQuery>): App;
 declare namespace widget {
     /** @internal */
     const PropTypes: readonly [
@@ -1950,11 +1995,13 @@ declare namespace widget {
      * 現在のステートを設定する
      *
      * @param stateId - 表示するステートID
-     * @param force - 強制的にステートを設定するフラグ。デフォルトは `false`
+     * @param options - オプション。`options.disableInPreview`でプレビュー時のステート遷移を無効化できます。
      *
      * @public
      */
-    function setState(stateId: string, force?: boolean): void;
+    function setState(stateId: string, options?: {
+        disableInPreview: boolean;
+    }): void;
     /**
      * 現在のステートを取得する
      *
@@ -2367,6 +2414,82 @@ declare namespace widget {
      * @internal
      */
     const setAutoStart: (on?: boolean) => void;
+    type ActionTableResult = number | string | boolean | Date | null | undefined;
+    type ActionTableQueryParam = string | number | boolean | Date;
+    type ActionTableQueryParams = {
+        [key: string]: ActionTableQueryParam | ActionTableQueryParam[];
+    };
+    /**
+     * アクションテーブルの設定情報
+     *
+     * @public
+     */
+    type CollectionConfig = {
+        /**
+         * APIキー
+         */
+        api_key: string;
+        /**
+         * テーブル名
+         */
+        table: string;
+        /**
+         * エンドポイント
+         */
+        endpoint?: string;
+    };
+    /**
+     * アクションテーブルを管理するメソッドを取得する
+     *
+     * @param config - 設定情報
+     *
+     * @returns メソッドを返します
+     *
+     * @public
+     */
+    function collection(config: CollectionConfig): {
+        get(key: string | Array<string>, cb: (err: Error | null, items?: ActionTableResult | Array<ActionTableResult>) => void): void;
+        getByQuery(query_name: string, params: ActionTableQueryParams, options: {
+            ignore_fields?: string[];
+        } | null | undefined, cb: (err: Error | null, items?: Array<ActionTableResult>) => void): void;
+        set(key: string, value: string, cb: (err: Error | null) => void): void;
+    };
+    type ActionTableRowRequestConfig = {
+        resolver: "action-table-row";
+        name: string;
+        default: {
+            table_name: string;
+            key: string;
+            default_value?: ActionTableResult;
+        };
+        preview_value?: ActionTableResult;
+    };
+    type ActionTableRowsRequestConfig = {
+        resolver: "action-table-rows";
+        name: string;
+        default: {
+            table_name: string;
+            key: Array<string>;
+            default_value?: Array<ActionTableResult>;
+        };
+        preview_value?: Array<ActionTableResult>;
+    };
+    type ActionTableQueryRequestConfig = {
+        resolver: "action-table-query";
+        name: string;
+        default: {
+            table_name: string;
+            query_name: string;
+            params?: ActionTableQueryParams;
+            default_value?: Array<ActionTableResult>;
+        };
+        preview_value?: Array<ActionTableResult>;
+    };
+    type ActionTableRequestConfig = ActionTableRowRequestConfig | ActionTableRowsRequestConfig | ActionTableQueryRequestConfig;
+    const loadActionTableRow: (config: ActionTableRowRequestConfig, api_key: string, endpoint?: string) => Promise<unknown>;
+    const loadActionTableRows: (config: ActionTableRowsRequestConfig, api_key: string, endpoint?: string) => Promise<unknown>;
+    const loadActionTableQuery: (config: ActionTableQueryRequestConfig, api_key: string, endpoint?: string) => Promise<unknown>;
+    const loadActionTable: (config: Array<ActionTableRequestConfig>, api_key: string, endpoint?: string) => Promise<{}>;
     /**
      * プロパティ
      *
@@ -2523,7 +2646,7 @@ declare namespace widget {
      *
      * @public
      */
-    interface ActionOptions<Props, Variables> {
+    interface ActionOptions<Props, Variables, VariablesQuery> {
         /**
          * アクションでイベントがトリガーされたときに受信するための関数
          *
@@ -2537,11 +2660,17 @@ declare namespace widget {
          */
         props?: Props;
         /**
-         * アクションで使用されるアクションテーブルのユーザー環境変数
+         * アクションで使用される解析時に取得される変数
          *
          * @defaultValue `{}`
          */
         variables?: Variables;
+        /**
+         * アクションで使用されるアクション実行時に取得される変数
+         *
+         * @defaultValue `[]`
+         */
+        localVariablesQuery?: VariablesQuery;
         /**
          * アクションが作成されているときにフックされる {@link onCreate}
          *
@@ -2559,7 +2688,7 @@ declare namespace widget {
      *
      * @public
      */
-    function create<Props extends _Props, Variables>(App: typeof SvelteComponentDev, options?: ActionOptions<Props, Variables & CustomVariables>): () => void;
+    function create<Props extends _Props, Variables, VariablesQuery extends ActionTableRequestConfig[]>(App: typeof SvelteComponentDev, options?: ActionOptions<Props, Variables & CustomVariables, VariablesQuery>): () => void;
     /**
      * Dispatch the event to destroy KARTE action
      *
@@ -2659,7 +2788,7 @@ declare namespace widget {
      *
      * @internal
      */
-    type ModalOptions<Props, Variables> = ActionOptions<Props, Variables>;
+    type ModalOptions<Props, Variables, VariablesQuery> = ActionOptions<Props, Variables, VariablesQuery>;
     /**
      * 非推奨です
      *
@@ -2699,7 +2828,7 @@ declare namespace widget {
      *
      * @internal
      */
-    type AppOptions<Props, Variables> = ActionOptions<Props, Variables>;
+    type AppOptions<Props, Variables, VariablesQuery> = ActionOptions<Props, Variables, VariablesQuery>;
     /**
      * App application instance that is with {@link createApp}
      *
@@ -2731,7 +2860,7 @@ declare namespace widget {
      *
      * @internal
      */
-    function createApp<Props, Variables>(App: typeof SvelteComponentDev, options?: AppOptions<Props, Variables>): App;
+    function createApp<Props, Variables, VariablesQuery>(App: typeof SvelteComponentDev, options?: AppOptions<Props, Variables, VariablesQuery>): App;
     // @ts-ignore
     type ChangeValCallback = ({ newVal, oldVal, key }: {
         newVal: any;
@@ -2859,13 +2988,13 @@ declare namespace widget {
      *
      * @public
      */
-    function collection(table: string): {
-        get(key: string | string[], cb: (err: Error, items?: any) => void): void;
+    function collection$0(table: string): {
+        get(key: string | string[], cb: (err: Error, items?: (string | number | boolean | Date) | (string | number | boolean | Date)[]) => void): void;
         getByQuery(query_name: string, params: {
-            [p: string]: string | number | boolean | (string | number | boolean)[];
+            [key: string]: (string | number | boolean | Date) | (string | number | boolean | Date)[];
         }, options: {
             ignore_fields?: string[];
-        }, cb: (err: Error, items?: any) => void): void;
+        }, cb: (err: Error, items?: (string | number | boolean | Date)[]) => void): void;
         set(key: string, value: string, cb: (err: Error) => void): void;
     };
     /**
@@ -2878,8 +3007,8 @@ declare namespace widget {
      */
     export { showAction as show, closeAction as hide };
 }
-export { loadGlobalScript, loadGlobalStyle, applyGlobalCss, initialize, finalize, setAutoStart, getState, setState, getStates, isOpened, getCustomVariables, setCustomVariables, updateCustomVariables, getCustomHandlers, setCustomHandlers, updateCustomHandlers, getSystem, setActionSetting, customHandlers, customVariables, formData, state, opened, closed, destroyed, stopped, isClosed, setClosed, getStoreState, onScroll, onTime, messages, events, logger, listenLogger, listenConsoleLogger, hideOnScroll, hideOnTime, showOnScroll, showOnTime, PropTypes, PropType, Code, MediaQueries, MediaQuery, Directions, Direction, AnimationStyles, AnimationStyle, ModalPositions, ModalPosition, ModalMargin, ModalPlacement, DefaultModalPlacement, Elasticities, Elasticity, ElasticityStyle, TextDirections, TextDirection, OperationArgumentType, Operation, OnClickOperationOptions, OnClickOperation, LongText, Url, Image, LengthUnits, LengthUnit, Length, Color, Justifies, Justify, Alignments, Alignment, ObjectFits, ObjectFit, ClipPaths, ClipPath, Repeats, Repeat, BackgroundSizes, BackgroundSize, Cursors, Cursor, Overflows, Overflow, Border, BorderStyle, BorderWidth, Style, StateName, WritingModes, WritingMode, ListSeparatorTypes, ListSeparatorNone, ListSeparatorBorder, ListSeparatorGap, ListSeparator, DefaultListSeparatorNone, DefaultListSeparatorBorder, DefaultListSeparatorGap, DefaultListSeparator, ListBackgroundTypes, ListBackgroundNone, ListBackgroundStripe, ListBackground, DefaultListBackgroundNone, DefaultListBackgroundStripe, DefaultListBackground, ListDirections, ListDirection, ListContext, SlideButtonIcon, SlideButtonText, SlideButton, DefaultSlideButton, SlideButtonPosition, SlideNavigationButton, DefaultSlideNavigationButton, FormInputName, FormButtonStyle, DefaultFormButtonStyle, FormSelectStyle, DefaultFormSelectStyle, FormRatingButtonType, FormRatingButtonTypes, DefaultFormRatingButtonType, create, destroy, closeAction, showAction, loadStyle, applyCss, getActionShadowRoot, onCreate, onShow, onClose, onDestroy, onChangeState, showModal, ensureModalRoot, show, close, createApp, createFog, KARTE_MODAL_ROOT, collection, widget };
-export type { CloseTrigger, CustomVariables, ActionEventHandler, SystemConfig, OnScrollContext, OnScrollFunction, ScrollDirection, LogLevel, Log, Event, ActionProps, ActionOptions, ActionHook, ActionCloseHook, ActionChangeStateHook, SendFunction, CollectionConfig };
+export { loadGlobalScript, loadGlobalStyle, applyGlobalCss, initialize, finalize, setAutoStart, getState, setState, getStates, isOpened, getCustomVariables, setCustomVariables, updateCustomVariables, getCustomHandlers, setCustomHandlers, updateCustomHandlers, getSystem, setActionSetting, customHandlers, customVariables, formData, state, opened, closed, destroyed, stopped, isClosed, setClosed, getStoreState, onScroll, onTime, getLogs, getEvents, logger, listenLogger, listenConsoleLogger, hideOnScroll, hideOnTime, showOnScroll, showOnTime, PropTypes, PropType, Code, MediaQueries, MediaQuery, Directions, Direction, AnimationStyles, AnimationStyle, ModalPositions, ModalPosition, ModalMargin, ModalPlacement, DefaultModalPlacement, Elasticities, Elasticity, ElasticityStyle, TextDirections, TextDirection, OperationArgumentType, Operation, OnClickOperationOptions, OnClickOperation, LongText, Url, Image, LengthUnits, LengthUnit, Length, Color, Justifies, Justify, Alignments, Alignment, ObjectFits, ObjectFit, ClipPaths, ClipPath, Repeats, Repeat, BackgroundSizes, BackgroundSize, Cursors, Cursor, Overflows, Overflow, Border, BorderStyle, BorderWidth, Style, StateName, WritingModes, WritingMode, ListSeparatorTypes, ListSeparatorNone, ListSeparatorBorder, ListSeparatorGap, ListSeparator, DefaultListSeparatorNone, DefaultListSeparatorBorder, DefaultListSeparatorGap, DefaultListSeparator, ListBackgroundTypes, ListBackgroundNone, ListBackgroundStripe, ListBackground, DefaultListBackgroundNone, DefaultListBackgroundStripe, DefaultListBackground, ListDirections, ListDirection, ListContext, SlideButtonIcon, SlideButtonText, SlideButton, DefaultSlideButton, SlideButtonPosition, SlideNavigationButton, DefaultSlideNavigationButton, FormInputName, FormButtonStyle, DefaultFormButtonStyle, FormSelectStyle, DefaultFormSelectStyle, FormRatingButtonType, FormRatingButtonTypes, DefaultFormRatingButtonType, create, destroy, closeAction, showAction, loadStyle, applyCss, getActionShadowRoot, onCreate, onShow, onClose, onDestroy, onChangeState, showModal, ensureModalRoot, show, close, createApp, createFog, KARTE_MODAL_ROOT, collection, loadActionTableRow, loadActionTableRows, loadActionTableQuery, loadActionTable, widget };
+export type { CloseTrigger, CustomVariables, ActionEventHandler, SystemConfig, OnScrollContext, OnScrollFunction, ScrollDirection, LogLevel, Log, Event, ActionProps, ActionOptions, ActionHook, ActionCloseHook, ActionChangeStateHook, SendFunction, CollectionConfig, ActionTableRowRequestConfig, ActionTableRowsRequestConfig, ActionTableQueryRequestConfig, ActionTableRequestConfig };
 export { default as State } from './components/State.svelte';
 export { default as StateItem } from './components/StateItem.svelte';
 export { default as Modal } from './components/Modal.svelte';