@plaidev/karte-action-sdk 1.1.268-29111070.d0bdfb56 → 1.1.268-29127338.e0debfc5

package/dist/svelte5/widget.d.ts

@@ -0,0 +1,148 @@
+import { showAction, closeAction } from "./modal.js";
+import { collection as newCollection } from "./collection.js";
+type ChangeValCallbackArg = {
+	newVal: any
+	oldVal: any
+	key: string
+};
+type ChangeValCallback = (arg: ChangeValCallbackArg) => void;
+type EventCallback = (event: any) => void;
+type WidgetEventName = "hide" | "clickBackdrop" | "destroyed";
+/**
+* アクションを表示する
+*
+* @remarks
+* この関数は {@link showAction} のエイリアスです
+*
+* @public
+*/
+export { showAction as show };
+/**
+* アクションを非表示にする
+*
+* @remarks
+* この関数は {@link closeAction} のエイリアスです
+*
+* @public
+*/
+export { closeAction as hide };
+/**
+* 変数を設定する
+*
+* @param name - 変数名
+* @param value - 変数値
+*
+* @public
+*/
+export declare function setVal(name: string, value: any): void;
+/**
+* 変数を取得する
+*
+* @param name - 変数名
+*
+* @returns 変数値
+*
+* @public
+*/
+export declare function getVal(name: string): any;
+/**
+* 変数が変更されたときに実行されるコールバック関数を設定する
+*
+* @param name - 変数名
+* @param callback - コールバック関数
+*
+* @public
+*/
+export declare function onChangeVal(name: string, callback: ChangeValCallback): void;
+/**
+* WEBのイベントが発生したときに実行されるコールバック関数を設定する
+*
+* @param name - WEBのイベント名
+* @param callback - コールバック関数
+*
+* @public
+*/
+export declare function method(name: string, callback: EventCallback): void;
+/**
+* Widgetのイベントが発生したときに実行されるコールバック関数を設定する
+*
+* @param name - Widgetのイベント名
+* @param callback - コールバック関数
+*
+* @public
+*/
+export declare function on(name: WidgetEventName, callback: EventCallback): void;
+/**
+* 現在のステートを設定する
+*
+* @param stateId - ステートID
+*
+* @public
+*/
+export declare function setState(stateId: string): void;
+/**
+* 現在のステートを取得する
+*
+* @returns ステートID
+*
+* @public
+*/
+export declare function getState(): string;
+/**
+* ページ内の変数を設定する
+*
+* @param key - 変数のキー
+* @param value - 変数値
+*
+* @public
+*/
+declare function setMemoryStore(key: string, value: any): void;
+/**
+* ページ内の変数を取定する
+*
+* @param key - 変数のキー
+*
+* @returns 変数
+*
+* @public
+*/
+declare function getMemoryStore(key: string): any;
+/**
+* ページをまたぐ変数を設定する
+*
+* @param key - 変数のキー
+* @param value - 変数値
+*
+* @public
+*/
+declare function setLocalStore(key: string, value: any, options?: {
+	expire: number | boolean
+}): void;
+/**
+* ページをまたぐ変数を取得設定する
+*
+* @param key - 変数のキー
+*
+* @returns 変数
+*
+* @public
+*/
+declare function getLocalStore(key: string): any | undefined;
+export declare const storage: {
+	memory: {
+		store: typeof setMemoryStore
+		restore: typeof getMemoryStore
+	}
+	local: {
+		store: typeof setLocalStore
+		restore: typeof getLocalStore
+	}
+};
+/**
+* アクションテーブルを操作するオブジェクト
+*
+* @param table - アクションテーブル名
+*
+* @public
+*/
+export declare function collection(table: string): ReturnType<typeof newCollection>;

package/dist/templates.cjs.js

@@ -1,16 +1,16 @@
-'use strict';
+"use strict";
 
+//#region src/templates.ts
 /**
- * 最新SDKに対応したアクションコードを生成する関数群
- */
+* 最新SDKに対応したアクションコードを生成する関数群
+*/
 /**
- * アクションのアプリコード(App.svelte)の初期値の生成
- *
- * @internal
- */
-function createAppScript(script = '', icons = [], customComponents = []) {
-    // TODO: `script` should be validated!
-    return `<script lang="ts">
+* アクションのアプリコード(App.svelte)の初期値の生成
+*
+* @internal
+*/
+function createAppScript(script = "", icons = [], customComponents = []) {
+	return `<script lang="ts">
 // DON'T TOUCH THIS: SDK generates the following code
 import type { ActionProps, ActionVariables } from '@plaidev/karte-action-sdk';
 import type { Data, Props, Variables } from './gen';
@@ -73,16 +73,12 @@ import {
   FlexClipCopy,
 } from '@plaidev/karte-action-sdk';
 
-${icons.length > 0
-        ? `import {\n  ${icons.join(',\n  ')},\n} from '@plaidev/karte-action-sdk/icons';`
-        : ''}
+${icons.length > 0 ? `import {\n  ${icons.join(",\n  ")},\n} from '@plaidev/karte-action-sdk/icons';` : ""}
 
-${customComponents
-        .map(path => {
-        const componentName = path.split('/').pop().replace('.svelte', '');
-        return `import ${componentName} from '${path}';`;
-    })
-        .join('\n')}
+${customComponents.map((path) => {
+		const componentName = path.split("/").pop().replace(".svelte", "");
+		return `import ${componentName} from '${path}';`;
+	}).join("\n")}
 
 export let send: (event_name: string, values?: any) => void;
 let data_: Data;
@@ -111,13 +107,12 @@ $: cssVariables = getCssVariables({ ...$data, ...$actionVariables });
 </script>`;
 }
 /**
- * アクションのエントリーコード(index.tsx)の初期値の生成
- *
- * @internal
- */
-function createIndexTsx({ script = '' } = {}) {
-    // TODO: `script` should be validated!
-    return `import type { KarteAction, Send, Publish, Props, Variables } from './gen';
+* アクションのエントリーコード(index.tsx)の初期値の生成
+*
+* @internal
+*/
+function createIndexTsx({ script = "" } = {}) {
+	return `import type { KarteAction, Send, Publish, Props, Variables } from './gen';
 import { create } from '@plaidev/karte-action-sdk';
 
 import { props, localVariablesQuery, karteTemplate } from './gen';
@@ -140,26 +135,23 @@ const action = (options: { send: Send; publish: Publish, props: Props; variables
 export default action;`;
 }
 /**
- * 後方互換のためのカスタムスクリプトの初期値の生成
- *
- * customScript.tsが存在しない場合の後方互換コードを生成する。
- * 実際のコードはアクションテンプレートごとに異なるため、この関数で生成するコードを不用意に初期値にしないこと。
- *
- * export defaultの引数をシンプルにするため、標準のアクションで使わない変数をpropsに入れていない。
- * 標準以外の使い方をするケースはサポートドキュメントでフォローする。
- *
- * @internal
- */
-function createCompatibleCustomScript({ script = '', templateType = 'webpopup', } = {}) {
-    // TODO: `script` should be validated!
-    if (templateType === 'script') {
-        return `\
+* 後方互換のためのカスタムスクリプトの初期値の生成
+*
+* customScript.tsが存在しない場合の後方互換コードを生成する。
+* 実際のコードはアクションテンプレートごとに異なるため、この関数で生成するコードを不用意に初期値にしないこと。
+*
+* export defaultの引数をシンプルにするため、標準のアクションで使わない変数をpropsに入れていない。
+* 標準以外の使い方をするケースはサポートドキュメントでフォローする。
+*
+* @internal
+*/
+function createCompatibleCustomScript({ script = "", templateType = "webpopup" } = {}) {
+	if (templateType === "script") return `\
 ${script}
 export default ({ send, data }) => {
   // ここにスクリプトを書いてください
 };`;
-    }
-    return `\
+	return `\
 import { showAction } from '@plaidev/karte-action-sdk';
 ${script}
 export default ({ send, data }) => {
@@ -167,13 +159,12 @@ export default ({ send, data }) => {
   showAction();
 };`;
 }
-// 以下は後方互換。action-editor-frontをデプロイしたら削除可能。
-// @internal
-function createCustomScript(script = '') {
-    return createCompatibleCustomScript({ script });
+function createCustomScript(script = "") {
+	return createCompatibleCustomScript({ script });
 }
 
+//#endregion
 exports.createAppScript = createAppScript;
 exports.createCompatibleCustomScript = createCompatibleCustomScript;
 exports.createCustomScript = createCustomScript;
-exports.createIndexTsx = createIndexTsx;
+exports.createIndexTsx = createIndexTsx;

package/dist/templates.d.ts

@@ -1,34 +1,33 @@
 /**
- * 最新SDKに対応したアクションコードを生成する関数群
- */
+* 最新SDKに対応したアクションコードを生成する関数群
+*/
 /**
- * アクションのアプリコード(App.svelte)の初期値の生成
- *
- * @internal
- */
-declare function createAppScript(script?: string, icons?: string[], customComponents?: string[]): string;
+* アクションのアプリコード(App.svelte)の初期値の生成
+*
+* @internal
+*/
+export declare function createAppScript(script?: string, icons?: string[], customComponents?: string[]): string;
 /**
- * アクションのエントリーコード(index.tsx)の初期値の生成
- *
- * @internal
- */
-declare function createIndexTsx({ script }?: {
-    script?: string;
+* アクションのエントリーコード(index.tsx)の初期値の生成
+*
+* @internal
+*/
+export declare function createIndexTsx({ script }?: {
+	script?: string
 }): string;
 /**
- * 後方互換のためのカスタムスクリプトの初期値の生成
- *
- * customScript.tsが存在しない場合の後方互換コードを生成する。
- * 実際のコードはアクションテンプレートごとに異なるため、この関数で生成するコードを不用意に初期値にしないこと。
- *
- * export defaultの引数をシンプルにするため、標準のアクションで使わない変数をpropsに入れていない。
- * 標準以外の使い方をするケースはサポートドキュメントでフォローする。
- *
- * @internal
- */
-declare function createCompatibleCustomScript({ script, templateType, }?: {
-    script?: string;
-    templateType?: 'webpopup' | 'script';
+* 後方互換のためのカスタムスクリプトの初期値の生成
+*
+* customScript.tsが存在しない場合の後方互換コードを生成する。
+* 実際のコードはアクションテンプレートごとに異なるため、この関数で生成するコードを不用意に初期値にしないこと。
+*
+* export defaultの引数をシンプルにするため、標準のアクションで使わない変数をpropsに入れていない。
+* 標準以外の使い方をするケースはサポートドキュメントでフォローする。
+*
+* @internal
+*/
+export declare function createCompatibleCustomScript({ script, templateType }?: {
+	script?: string
+	templateType?: "webpopup" | "script"
 }): string;
-declare function createCustomScript(script?: string): ReturnType<typeof createCompatibleCustomScript>;
-export { createAppScript, createIndexTsx, createCompatibleCustomScript, createCustomScript };
+export declare function createCustomScript(script?: string): ReturnType<typeof createCompatibleCustomScript>;

package/dist/templates.js

@@ -1,14 +1,14 @@
+//#region src/templates.ts
 /**
- * 最新SDKに対応したアクションコードを生成する関数群
- */
+* 最新SDKに対応したアクションコードを生成する関数群
+*/
 /**
- * アクションのアプリコード(App.svelte)の初期値の生成
- *
- * @internal
- */
-function createAppScript(script = '', icons = [], customComponents = []) {
-    // TODO: `script` should be validated!
-    return `<script lang="ts">
+* アクションのアプリコード(App.svelte)の初期値の生成
+*
+* @internal
+*/
+function createAppScript(script = "", icons = [], customComponents = []) {
+	return `<script lang="ts">
 // DON'T TOUCH THIS: SDK generates the following code
 import type { ActionProps, ActionVariables } from '@plaidev/karte-action-sdk';
 import type { Data, Props, Variables } from './gen';
@@ -71,16 +71,12 @@ import {
   FlexClipCopy,
 } from '@plaidev/karte-action-sdk';
 
-${icons.length > 0
-        ? `import {\n  ${icons.join(',\n  ')},\n} from '@plaidev/karte-action-sdk/icons';`
-        : ''}
+${icons.length > 0 ? `import {\n  ${icons.join(",\n  ")},\n} from '@plaidev/karte-action-sdk/icons';` : ""}
 
-${customComponents
-        .map(path => {
-        const componentName = path.split('/').pop().replace('.svelte', '');
-        return `import ${componentName} from '${path}';`;
-    })
-        .join('\n')}
+${customComponents.map((path) => {
+		const componentName = path.split("/").pop().replace(".svelte", "");
+		return `import ${componentName} from '${path}';`;
+	}).join("\n")}
 
 export let send: (event_name: string, values?: any) => void;
 let data_: Data;
@@ -109,13 +105,12 @@ $: cssVariables = getCssVariables({ ...$data, ...$actionVariables });
 </script>`;
 }
 /**
- * アクションのエントリーコード(index.tsx)の初期値の生成
- *
- * @internal
- */
-function createIndexTsx({ script = '' } = {}) {
-    // TODO: `script` should be validated!
-    return `import type { KarteAction, Send, Publish, Props, Variables } from './gen';
+* アクションのエントリーコード(index.tsx)の初期値の生成
+*
+* @internal
+*/
+function createIndexTsx({ script = "" } = {}) {
+	return `import type { KarteAction, Send, Publish, Props, Variables } from './gen';
 import { create } from '@plaidev/karte-action-sdk';
 
 import { props, localVariablesQuery, karteTemplate } from './gen';
@@ -138,26 +133,23 @@ const action = (options: { send: Send; publish: Publish, props: Props; variables
 export default action;`;
 }
 /**
- * 後方互換のためのカスタムスクリプトの初期値の生成
- *
- * customScript.tsが存在しない場合の後方互換コードを生成する。
- * 実際のコードはアクションテンプレートごとに異なるため、この関数で生成するコードを不用意に初期値にしないこと。
- *
- * export defaultの引数をシンプルにするため、標準のアクションで使わない変数をpropsに入れていない。
- * 標準以外の使い方をするケースはサポートドキュメントでフォローする。
- *
- * @internal
- */
-function createCompatibleCustomScript({ script = '', templateType = 'webpopup', } = {}) {
-    // TODO: `script` should be validated!
-    if (templateType === 'script') {
-        return `\
+* 後方互換のためのカスタムスクリプトの初期値の生成
+*
+* customScript.tsが存在しない場合の後方互換コードを生成する。
+* 実際のコードはアクションテンプレートごとに異なるため、この関数で生成するコードを不用意に初期値にしないこと。
+*
+* export defaultの引数をシンプルにするため、標準のアクションで使わない変数をpropsに入れていない。
+* 標準以外の使い方をするケースはサポートドキュメントでフォローする。
+*
+* @internal
+*/
+function createCompatibleCustomScript({ script = "", templateType = "webpopup" } = {}) {
+	if (templateType === "script") return `\
 ${script}
 export default ({ send, data }) => {
   // ここにスクリプトを書いてください
 };`;
-    }
-    return `\
+	return `\
 import { showAction } from '@plaidev/karte-action-sdk';
 ${script}
 export default ({ send, data }) => {
@@ -165,10 +157,9 @@ export default ({ send, data }) => {
   showAction();
 };`;
 }
-// 以下は後方互換。action-editor-frontをデプロイしたら削除可能。
-// @internal
-function createCustomScript(script = '') {
-    return createCompatibleCustomScript({ script });
+function createCustomScript(script = "") {
+	return createCompatibleCustomScript({ script });
 }
 
-export { createAppScript, createCompatibleCustomScript, createCustomScript, createIndexTsx };
+//#endregion
+export { createAppScript, createCompatibleCustomScript, createCustomScript, createIndexTsx };

package/dist/types.d.ts

@@ -0,0 +1,183 @@
+/**
+* アクションの汎用的なタイプを定義する
+*
+* モーダル(ポップアップ)やアクションテーブルなど機能別のタイプは含めない。
+*/
+/**
+* アクションのイベントハンドラ
+*
+* @public
+*/
+export type ActionEventHandler = (...args: any[]) => any | Promise<any>;
+/**
+* アクションの変数
+*
+* @public
+*/
+export type ActionVariables = {
+	[key: string]: any
+};
+/**
+* アクションの send 関数
+*
+* @public
+*/
+export type SendFunction = (event_name: string, values?: any) => void;
+/**
+* アクションの publish 関数
+*
+* @public
+*/
+export type PublishFunction = (topic: string, values?: any) => void;
+/**
+* アクション設定
+*
+* @public
+*/
+export type ActionSetting = {
+	send?: SendFunction
+	publish?: PublishFunction
+	initialState?: string
+};
+/**
+* アクションのライフサイクル changeState で呼び出されるフック関数
+*
+* @param props - アクションのプロパティ
+* @param newState - アクションの新しいステート
+*
+* @public
+*/
+export type ActionChangeStateHook<
+	Props,
+	Variables
+> = (props: Parameters<ActionHook<Props, Variables & ActionVariables>>[0], newState: string) => void | Promise<void>;
+/**
+* アクションのプロパティ
+*
+* @public
+*/
+export interface ActionProps<
+	Props,
+	Variables
+> {
+	/**
+	* アクションでイベントがトリガーされたときに受信するための関数
+	*/
+	send: SendFunction;
+	/**
+	* アクション内でタグのQueueにリクエストを発行する関数
+	*/
+	publish: PublishFunction;
+	/**
+	* アクションで使用されるデータ
+	*/
+	data: Props & Variables & ActionVariables;
+	/**
+	* アクションが表示されたときにフックされる {@link onShow}
+	*/
+	onShow?: ActionHook<Props, Variables & ActionVariables>;
+	/**
+	* アクションのステートが変更されたときにフックされる {@link onChangeState}
+	*/
+	onChangeState?: ActionChangeStateHook<Props, Variables & ActionVariables>;
+}
+/**
+* アクションのライフサイクルで呼び出されるフック
+*
+* @param props - アクションのプロパティ
+*
+* @public
+*/
+export type ActionHook<
+	Props,
+	Variables
+> = (props: ActionProps<Props, Variables & ActionVariables>) => void | Promise<void>;
+/**
+* {@link create} 向けのオプション
+*
+* @public
+*/
+export interface ActionOptions<
+	Props,
+	Variables,
+	VariablesQuery
+> {
+	/**
+	* アクション内でイベントを発火する関数
+	*
+	* @defaultValue `() => {}`
+	*/
+	send?: SendFunction;
+	/**
+	* アクション内でタグのQueueにリクエストを発行する関数
+	*
+	* @defaultValue `() => {}`
+	*/
+	publish?: PublishFunction;
+	/**
+	* アクションで使用されるプロパティ
+	*
+	* @defaultValue `{}`
+	*/
+	props?: Props;
+	/**
+	* アクションで使用される解析時に取得される変数
+	*
+	* @defaultValue `{}`
+	*/
+	variables?: Variables;
+	/**
+	* アクションで使用されるアクション実行時に取得される変数
+	*
+	* @defaultValue `[]`
+	*/
+	localVariablesQuery?: VariablesQuery;
+	/**
+	* アクションが作成されているときにフックされる {@link onCreate}
+	*
+	* @defaultValue `() => {}`
+	*/
+	onCreate?: ActionHook<Props, Variables & ActionVariables>;
+	/**
+	* KARTEテンプレートの情報
+	*
+	* @defaultValue `{}`
+	*/
+	karteTemplate?: {
+		[key: string]: any
+	};
+	/**
+	* アクション実行時のコンテキスト
+	*/
+	context: ActionRunnerContext;
+}
+/**
+* KARTE のシステム設定情報
+*
+* @public
+*/
+export type SystemConfig = {
+	/**
+	* API キー
+	*/
+	apiKey?: string
+	collection_endpoint?: string
+	/**
+	* 接客ID
+	*/
+	campaignId?: string
+	shortenId?: string
+};
+/** @internal */
+export type ActionHookLog = {
+	name: string
+	values?: any
+};
+/**
+* アクション実行時のコンテキスト
+*/
+export type ActionRunnerContext = {
+	api_key: string
+	collection_endpoint?: string
+	target?: "web" | "native"
+};