@plaidev/karte-action-sdk 1.1.179-28041859.8b5339d0 → 1.1.180-28041937.24d05b80

package/dist/index.es.d.ts

@@ -143,6 +143,14 @@ interface ActionOptions<Props, Variables, VariablesQuery> {
      * @defaultValue `() => {}`
      */
     onCreate?: ActionHook<Props, Variables & ActionVariables>;
+    /**
+     * KARTEテンプレートの情報
+     *
+     * @defaultValue `{}`
+     */
+    karteTemplate?: {
+        [key: string]: any;
+    };
 }
 /**
  * KARTE のシステム設定情報
@@ -160,6 +168,11 @@ type SystemConfig = {
     campaignId?: string;
     shortenId?: string;
 };
+/** @internal */
+type ActionHookLog = {
+    name: string;
+    values?: any;
+};
 type ActionTableResult = number | string | boolean | Date | null | undefined;
 type ActionTableQueryParam = string | number | boolean | Date;
 type ActionTableQueryParams = {
@@ -181,8 +194,7 @@ type CollectionConfig = {
     table: string;
     /**
      * エンドポイント
-     */
-    endpoint?: string;
+     */ endpoint?: string;
 };
 /**
  * アクションテーブルを管理するメソッドを取得する
@@ -246,6 +258,7 @@ declare const loadActionTableRow: (config: ActionTableRowRequestConfig, api_key:
 declare const loadActionTableRows: (config: ActionTableRowsRequestConfig, api_key: string, endpoint?: string) => Promise<unknown>;
 /** @internal */
 declare const loadActionTableQuery: (config: ActionTableQueryRequestConfig, api_key: string, endpoint?: string) => Promise<unknown>;
+/** @internal */
 declare const loadActionTable: (config: Array<VariableQuery>, api_key: string, endpoint?: string) => Promise<{
     [key: string]: any;
 }>;
@@ -369,15 +382,6 @@ declare function showOnScroll<ModalProps extends Pick<Props, "show_on_scroll" |
  */
 declare function showOnTime<ModalProps extends Pick<Props, "show_on_time" | "show_on_time_count">>(props: ModalProps, show?: Function): (() => void) | null;
 type ModalProps = Props;
-/** @internal */
-type ActionHookLog = {
-    name: string;
-    values?: any;
-};
-/** @internal */
-declare const initialize: (setting?: ActionSetting) => () => void;
-/** @internal */
-declare const finalize: () => void;
 /**
  * アクションを作成する
  *
@@ -389,8 +393,6 @@ declare const finalize: () => void;
  * @public
  */
 declare function create<Props extends ModalProps, Variables, VariablesQuery extends Array<VariableQuery>>(App: typeof SvelteComponentDev, options?: ActionOptions<Props, Variables & ActionVariables, VariablesQuery>): () => void;
-/** @internal */
-declare function ensureActionRoot(useShadow?: boolean): ShadowRoot | HTMLElement;
 /**
  * アクションの破棄する
  *
@@ -414,31 +416,6 @@ declare function onCreate<Props extends ModalProps, Variables>(fn: ActionHook<Pr
  */
 declare function onDestroy<Props extends ModalProps, Variables>(fn: ActionHook<Props, Variables & ActionVariables>): void;
 // -------- The following codes are deprecated --------
-/**
- * 非推奨
- *
- * @deprecated 非推奨
- *
- * @internal
- */
-type AppOptions<Props, Variables, VariablesQuery> = ActionOptions<Props, Variables, VariablesQuery>;
-/**
- * 非推奨
- *
- * @deprecated 非推奨
- *
- * @internal
- */
-interface App {
-    /**
-     * The method to destroy an app instance.
-     */
-    close: () => void;
-    /**
-     * The method to show an app instance.
-     */
-    show: () => void;
-}
 /**
  * 非推奨
  *
@@ -447,22 +424,6 @@ interface App {
  * @internal
  */
 declare const showModal: typeof create;
-/**
- * 非推奨
- *
- * @deprecated 非推奨
- *
- * @internal
- */
-declare const ensureModalRoot: typeof ensureActionRoot;
-/**
- * 非推奨
- *
- * @deprecated 非推奨
- *
- * @internal
- */
-declare function createApp<Props, Variables, VariablesQuery>(App: typeof SvelteComponentDev, options?: AppOptions<Props, Variables, VariablesQuery>): App;
 /**
  * 非推奨
  *
@@ -471,22 +432,10 @@ declare function createApp<Props, Variables, VariablesQuery>(App: typeof SvelteC
  * @internal
  */
 declare function destroy(): void;
-/**
- * 非推奨
- *
- * @deprecated 非推奨
- *
- * @internal
- */
-declare function createFog({ color, opacity, zIndex, onclick }: {
-    color?: string;
-    opacity?: string;
-    zIndex?: number;
-    onclick: () => void;
-}): {
-    fog: HTMLDivElement;
-    close: () => void;
-};
+/** @internal */
+declare const initialize: (setting?: ActionSetting) => () => void;
+/** @internal */
+declare const finalize: () => void;
 /**
  * ES Modules に対応していない JavaScript をページに読み込む
  *
@@ -1266,7 +1215,7 @@ declare const logger: {
  * @internal
  */
 declare function listenLogger(): () => void;
-type ModalProps$0 = Props;
+type ModalProps$1 = Props;
 /**
  * 表示アクショントリガー
  *
@@ -1285,7 +1234,7 @@ type CloseTrigger = "button" | "overlay" | "auto" | "none";
  *
  * @public
  */
-declare function onShow<Props extends ModalProps$0, Variables>(fn: ActionHook<Props, Variables & ActionVariables>): void;
+declare function onShow<Props extends ModalProps$1, Variables>(fn: ActionHook<Props, Variables & ActionVariables>): void;
 /**
  * アクションのライフサイクル close で呼び出されるフックする関数
  *
@@ -1294,7 +1243,7 @@ declare function onShow<Props extends ModalProps$0, Variables>(fn: ActionHook<Pr
  *
  * @public
  */
-type ActionCloseHook<Props extends ModalProps$0, Variables> = (props: Parameters<ActionHook<Props, Variables & ActionVariables>>[0], trigger: CloseTrigger) => void | Promise<void>;
+type ActionCloseHook<Props extends ModalProps$1, Variables> = (props: Parameters<ActionHook<Props, Variables & ActionVariables>>[0], trigger: CloseTrigger) => void | Promise<void>;
 /**
  * アクションがクローズ (close) される前にフックする関数
  *
@@ -1302,7 +1251,7 @@ type ActionCloseHook<Props extends ModalProps$0, Variables> = (props: Parameters
  *
  * @public
  */
-declare function onClose<Props extends ModalProps$0, Variables>(fn: ActionCloseHook<Props, Variables & ActionVariables>): void;
+declare function onClose<Props extends ModalProps$1, Variables>(fn: ActionCloseHook<Props, Variables & ActionVariables>): void;
 /**
  * アクションのステートが変更された (changeState) 後にフックする関数
  *
@@ -1310,7 +1259,7 @@ declare function onClose<Props extends ModalProps$0, Variables>(fn: ActionCloseH
  *
  * @public
  */
-declare function onChangeState<Props extends ModalProps$0, Variables>(fn: ActionChangeStateHook<Props, Variables & ActionVariables>): void;
+declare function onChangeState<Props extends ModalProps$1, Variables>(fn: ActionChangeStateHook<Props, Variables & ActionVariables>): void;
 /**
  * アクションを表示する
  *
@@ -1344,7 +1293,7 @@ declare function applyCss(css: string): Promise<HTMLStyleElement>;
  */
 declare function loadStyle(href: string): Promise<void>;
 // @internal
-declare function getCssVariables<Props extends ModalProps$0, Variables>(data: Writable<Props & Variables & ActionVariables & VariableQuery>): string;
+declare function getCssVariables<Props extends ModalProps$1, Variables>(data: Writable<Props & Variables & ActionVariables & VariableQuery>): string;
 /**
  * アクションのルートの DOM 要素を取得する
  *
@@ -1353,7 +1302,8 @@ declare function getCssVariables<Props extends ModalProps$0, Variables>(data: Wr
  * @public
  */
 declare function getActionRoot(): ShadowRoot | null;
-// -------- The following codes are deprecated --------
+/** @internal */
+declare function ensureActionRoot(useShadow?: boolean): ShadowRoot | HTMLElement;
 /**
  * 非推奨
  *
@@ -1370,6 +1320,63 @@ declare const show: typeof showAction;
  * @internal
  */
 declare const close: typeof closeAction;
+/**
+ * 非推奨
+ *
+ * @deprecated 非推奨
+ *
+ * @internal
+ */
+interface App {
+    /**
+     * The method to destroy an app instance.
+     */
+    close: () => void;
+    /**
+     * The method to show an app instance.
+     */
+    show: () => void;
+}
+/**
+ * 非推奨
+ *
+ * @deprecated 非推奨
+ *
+ * @internal
+ */
+type AppOptions<Props, Variables, VariablesQuery> = ActionOptions<Props, Variables, VariablesQuery>;
+/**
+ * 非推奨
+ *
+ * @deprecated 非推奨
+ *
+ * @internal
+ */
+declare const ensureModalRoot: typeof ensureActionRoot;
+/**
+ * 非推奨
+ *
+ * @deprecated 非推奨
+ *
+ * @internal
+ */
+declare function createApp<Props, Variables, VariablesQuery>(App: typeof SvelteComponentDev, options?: AppOptions<Props, Variables, VariablesQuery>): App;
+/**
+ * 非推奨
+ *
+ * @deprecated 非推奨
+ *
+ * @internal
+ */
+declare function createFog({ color, opacity, zIndex, onclick }: {
+    color?: string;
+    opacity?: string;
+    zIndex?: number;
+    onclick: () => void;
+}): {
+    fog: HTMLDivElement;
+    close: () => void;
+};
 declare namespace widget {
     /**
      * アクションの汎用的なタイプを定義する
@@ -1497,6 +1504,14 @@ declare namespace widget {
          * @defaultValue `() => {}`
          */
         onCreate?: ActionHook<Props, Variables & ActionVariables>;
+        /**
+         * KARTEテンプレートの情報
+         *
+         * @defaultValue `{}`
+         */
+        karteTemplate?: {
+            [key: string]: any;
+        };
     }
     /**
      * KARTE のシステム設定情報
@@ -1514,6 +1529,11 @@ declare namespace widget {
         campaignId?: string;
         shortenId?: string;
     };
+    /** @internal */
+    type ActionHookLog = {
+        name: string;
+        values?: any;
+    };
     type ActionTableResult = number | string | boolean | Date | null | undefined;
     type ActionTableQueryParam = string | number | boolean | Date;
     type ActionTableQueryParams = {
@@ -1535,8 +1555,7 @@ declare namespace widget {
         table: string;
         /**
          * エンドポイント
-         */
-        endpoint?: string;
+         */ endpoint?: string;
     };
     /**
      * アクションテーブルを管理するメソッドを取得する
@@ -1600,9 +1619,14 @@ declare namespace widget {
     const loadActionTableRows: (config: ActionTableRowsRequestConfig, api_key: string, endpoint?: string) => Promise<unknown>;
     /** @internal */
     const loadActionTableQuery: (config: ActionTableQueryRequestConfig, api_key: string, endpoint?: string) => Promise<unknown>;
+    /** @internal */
     const loadActionTable: (config: Array<VariableQuery>, api_key: string, endpoint?: string) => Promise<{
         [key: string]: any;
     }>;
+    /** @internal */
+    function setupActionTable(localVariablesQuery: any, apiKey: string): Promise<{
+        success: boolean;
+    }>;
     /**
      * モーダル(ポップアップ)のプロパティ
      *
@@ -1738,6 +1762,8 @@ declare namespace widget {
      * @public
      */
     type CloseTrigger = "button" | "overlay" | "auto" | "none";
+    /** @internal */
+    const handleState: (event: any) => void;
     /**
      * アクションが表示 (show) された後にフックする関数
      *
@@ -1813,6 +1839,10 @@ declare namespace widget {
      * @public
      */
     function getActionRoot(): ShadowRoot | null;
+    /** @internal */
+    function createModal<Props extends ModalProps, Variables, VariablesQuery extends Array<VariableQuery>>(App: typeof SvelteComponentDev, options?: ActionOptions<Props, Variables & ActionVariables, VariablesQuery>): () => void;
+    /** @internal */
+    function ensureActionRoot(useShadow?: boolean): ShadowRoot | HTMLElement;
     // -------- The following codes are deprecated --------
     /**
      * 非推奨
@@ -1822,7 +1852,6 @@ declare namespace widget {
      * @internal
      */
     function getActionShadowRoot(): ShadowRoot | null;
-    // -------- The following codes are deprecated --------
     /**
      * 非推奨
      *
@@ -1839,6 +1868,71 @@ declare namespace widget {
      * @internal
      */
     const close: typeof closeAction;
+    /**
+     * 非推奨
+     *
+     * @deprecated 非推奨
+     *
+     * @internal
+     */
+    interface App {
+        /**
+         * The method to destroy an app instance.
+         */
+        close: () => void;
+        /**
+         * The method to show an app instance.
+         */
+        show: () => void;
+    }
+    /**
+     * 非推奨
+     *
+     * @deprecated 非推奨
+     *
+     * @internal
+     */
+    type AppOptions<Props, Variables, VariablesQuery> = ActionOptions<Props, Variables, VariablesQuery>;
+    /**
+     * 非推奨
+     *
+     * @deprecated 非推奨
+     *
+     * @internal
+     */
+    type ModalOptions<Props, Variables, VariablesQuery> = ActionOptions<Props, Variables, VariablesQuery>;
+    /**
+     * 非推奨
+     *
+     * @deprecated 非推奨
+     *
+     * @internal
+     */
+    const ensureModalRoot: typeof ensureActionRoot;
+    /**
+     * 非推奨
+     *
+     * @deprecated 非推奨
+     *
+     * @internal
+     */
+    function createApp<Props, Variables, VariablesQuery>(App: typeof SvelteComponentDev, options?: AppOptions<Props, Variables, VariablesQuery>): App;
+    /**
+     * 非推奨
+     *
+     * @deprecated 非推奨
+     *
+     * @internal
+     */
+    function createFog({ color, opacity, zIndex, onclick }: {
+        color?: string;
+        opacity?: string;
+        zIndex?: number;
+        onclick: () => void;
+    }): {
+        fog: HTMLDivElement;
+        close: () => void;
+    };
     // @ts-ignore
     type ChangeValCallback = ({ newVal, oldVal, key }: {
         newVal: any;
@@ -2017,8 +2111,8 @@ declare const afterUpdate: typeof afterUpdateSvelte;
 declare const tick: typeof tickSvelte;
 // @internal
 declare const LAYOUT_COMPONENT_NAMES: string[];
-export { ACTION_HOOK_LABEL, KARTE_MODAL_ROOT, create, onCreate, destroyAction, onDestroy, initialize, finalize, showModal, ensureModalRoot, destroy, createApp, createFog, loadGlobalScript, loadGlobalStyle, applyGlobalCss, getState, setState, getStates, isOpened, getVariables, setVariables, resetVariables, getEventHandlers, setEventHandlers, resetEventHandlers, getSystem, setSetting, eventHandlers, variables, formData, state, onScroll, onTime, getLogs, getEvents, logger, listenLogger, 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, FontWeight, SYSTEM_FONT, Fonts, Font, Justifies, Justify, Alignments, Alignment, FlexDirections, FlexDirection, ObjectFits, ObjectFit, ClipPaths, ClipPath, Repeats, Repeat, BackgroundSizes, BackgroundSize, Cursors, Cursor, Overflows, Overflow, Border, BorderStyle, BorderWidth, BoxShadow, Style, TransitState, WritingModes, WritingMode, DateTime, Icon, ListSeparatorTypes, EdgePosition, DefaultEdgePosition, 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, FormButtonColor, DefaultFormButtonColor, showAction, closeAction, loadStyle, applyCss, onShow, onClose, onChangeState, getActionRoot, getCssVariables, show, close, collection, loadActionTableRow, loadActionTableRows, loadActionTableQuery, loadActionTable, widget, onMount, onDestory, beforeUpdate, afterUpdate, tick, LAYOUT_COMPONENT_NAMES };
-export type { ActionHookLog, SystemConfig, ActionVariables, ActionEventHandler, ActionProps, ActionOptions, ActionHook, ActionChangeStateHook, SendFunction, PublishFunction, OnScrollContext, OnScrollFunction, ScrollDirection, LogLevel, Log, Event, ActionCloseHook, ShowTrigger, CloseTrigger, CollectionConfig, ActionTableRowRequestConfig, ActionTableRowsRequestConfig, ActionTableQueryRequestConfig, ActionTableRequestConfig };
+export { ACTION_HOOK_LABEL, KARTE_MODAL_ROOT, create, destroyAction, onCreate, onDestroy, showModal, destroy, initialize, finalize, loadGlobalScript, loadGlobalStyle, applyGlobalCss, getState, setState, getStates, isOpened, getVariables, setVariables, resetVariables, getEventHandlers, setEventHandlers, resetEventHandlers, getSystem, setSetting, eventHandlers, variables, formData, state, onScroll, onTime, getLogs, getEvents, logger, listenLogger, 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, FontWeight, SYSTEM_FONT, Fonts, Font, Justifies, Justify, Alignments, Alignment, FlexDirections, FlexDirection, ObjectFits, ObjectFit, ClipPaths, ClipPath, Repeats, Repeat, BackgroundSizes, BackgroundSize, Cursors, Cursor, Overflows, Overflow, Border, BorderStyle, BorderWidth, BoxShadow, Style, TransitState, WritingModes, WritingMode, DateTime, Icon, ListSeparatorTypes, EdgePosition, DefaultEdgePosition, 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, FormButtonColor, DefaultFormButtonColor, showAction, closeAction, loadStyle, applyCss, onShow, onClose, onChangeState, getActionRoot, getCssVariables, show, close, ensureModalRoot, createApp, createFog, collection, loadActionTableRow, loadActionTableRows, loadActionTableQuery, loadActionTable, widget, onMount, onDestory, beforeUpdate, afterUpdate, tick, LAYOUT_COMPONENT_NAMES };
+export type { SystemConfig, ActionVariables, ActionEventHandler, ActionProps, ActionOptions, ActionHook, ActionHookLog, ActionChangeStateHook, SendFunction, PublishFunction, OnScrollContext, OnScrollFunction, ScrollDirection, LogLevel, Log, Event, ActionCloseHook, ShowTrigger, CloseTrigger, 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';