@plaidev/karte-action-sdk 1.1.268-29111070.d0bdfb56 → 1.1.268-29127137.d0ff6db4

package/dist/svelte5/stores.d.ts

@@ -0,0 +1,376 @@
+import { get as get_ } from "svelte/store";
+import type { Writable as Writable_ } from "svelte/store";
+import type { ActionSetting, ActionEventHandler, ActionVariables, SystemConfig, ActionRunnerContext } from "./types.js";
+/** @internal */
+export type Store<T> = Writable_<T>;
+/**
+* get store state value
+*
+* @deprecated 非推奨
+*
+* @internal
+*/
+export declare const getStoreState: typeof get_;
+/**
+* Store to handle action setting
+*
+* @internal
+*/
+export declare const actionSetting: Store<ActionSetting>;
+/**
+* {@link getSetting} function to get action setting.
+*
+* @returns Current action setting
+*
+* @internal
+*/
+export declare function getSetting(): ActionSetting;
+/**
+* アクション設定を更新する
+*
+* @param setting - 更新するアクション設定
+*
+* @returns 新しいアクション設定
+*
+* @public
+*/
+export declare function setSetting(setting: ActionSetting): ActionSetting;
+/**
+* {@link resetSetting} function to reset action setting
+*
+* @internal
+*/
+export declare function resetSetting(): void;
+/**
+* Store to read KARTE system config
+*
+* @internal
+*/
+export declare const system: Store<SystemConfig>;
+/**
+* KARTE の設定を取得する
+*
+* @remarks
+* アクションが表示されて設定されるため、{@link onShow} フック関数で利用できます。
+* 取得できる設定は、APIキー、接客ID、アクションショートIDなどです。
+*
+* @returns 現在の KARTE システムの設定を返します
+*
+* @public
+*/
+export declare function getSystem(): SystemConfig;
+/**
+* {@link setSystem} function to set KARTE system config.
+*
+* @internal
+*/
+export declare function setSystem(config: SystemConfig): void;
+/**
+* アクション実行時のコンテキストを保存するストア
+*
+* @internal
+*/
+export declare const actionRunnerContext: Store<ActionRunnerContext | null>;
+/**
+* アクション実行時のコンテキストを取得する
+*
+* @internal
+*/
+export declare function getActionRunnerContext(): ActionRunnerContext | null;
+/**
+* アクション実行時のコンテキストを保存する
+*
+* @internal
+*/
+export declare function setActionRunnerContext(value: ActionRunnerContext | null): void;
+/**
+* Store to handle current state ID
+*
+* This is exported becase of compatible interface for App.svelte.
+* Don't use directly.
+*
+* @internal
+*/
+export declare const state: Store<string>;
+/**
+* 現在のステートを設定する
+*
+* @param stateId - 表示するステートID
+* @param options - オプション。`options.disableInPreview`でプレビュー時のステート遷移を無効化できます。
+*
+* @public
+*/
+export declare function setState(stateId: string, options?: {
+	disableInPreview: boolean
+}): void;
+/**
+* 現在のステートを取得する
+*
+* @remarks
+* アクションが表示されて設定されるため、{@link onShow} フック関数で利用できます。
+*
+* @returns 現在のステートID
+*
+* @public
+*/
+export declare function getState(): string;
+/**
+* Store to handle all state IDs
+*
+* @internal
+*/
+export declare const states: Store<string[]>;
+/**
+* {@link getStates} function to add new state ID to list of state IDs.
+*
+* @param stateId - New state ID
+*
+* @internal
+*/
+export declare function addState(stateId: string): void;
+/**
+* ステートID一覧を取得する
+*
+* @remarks
+* アクションが表示されて設定されるため、{@link onShow} フック関数で利用できます。
+*
+* @returns すべてのステートID
+*
+* @public
+*/
+export declare function getStates(): string[];
+/**
+* Store to handle visibility of action
+*
+* @internal
+*/
+export declare const opened: Store<boolean>;
+/**
+* アクションの表示・非表示の状態を取得する
+*
+* @returns アクションが表示されているときは `true`、非表示のときは `false` を返します。
+*
+* @public
+*/
+export declare function isOpened(): boolean;
+/**
+* {@link setOpened} function to set if action is opened.
+*
+* @internal
+*/
+export declare function setOpened(on: boolean): void;
+/**
+* Store to handle visibility of action
+*
+* @deprecated 非推奨
+*
+* @internal
+*/
+export declare const closed: Store<boolean>;
+/**
+* {@link isClosed} function to check if action is clsoed.
+*
+* @returns Flag if action is closed / true: Closed, false: Not closed
+*
+* @deprecated 非推奨
+*
+* @internal
+*/
+export declare function isClosed(): boolean;
+/**
+* {@link setClosed} function to set if action is closed.
+*
+* @deprecated 非推奨
+*
+* @internal
+*/
+export declare function setClosed(on: boolean): void;
+/**
+* Store to handle max z-index for grid items
+*
+* @internal
+*/
+export declare const maximumZindex: Store<number>;
+/**
+* Set maximum z-index.
+*
+* @internal
+*/
+export declare const setMaximumZindex: (zindex?: number) => void;
+/**
+* Store to handle font-family of CSS
+*
+* @internal
+*/
+export declare const fonts: Store<string[]>;
+/**
+* Add font-family
+*
+* @internal
+*/
+export declare const addFont: (font: string) => void;
+/**
+* Store to handle internal event handlers
+*
+* @internal
+*/
+export declare const internalHandlers: Store<{
+	[key: string]: ActionEventHandler[]
+}>;
+/**
+* {@link getInternalHandlers} function to get internal event handlers.
+*
+* @returns Current internal handlers
+*
+* @internal
+*/
+export declare function getInternalHandlers(): {
+	[key: string]: ActionEventHandler[]
+};
+/**
+* {@link setInternalHandlers} function to set internal event handlers.
+*
+* @param handlers - New internal event handlers
+*
+* @internal
+*/
+export declare function setInternalHandlers(handlers: {
+	[key: string]: ActionEventHandler[]
+}): {
+	[key: string]: ActionEventHandler[]
+};
+/**
+* Store to handle internal event handlers for widget API
+*
+* @internal
+*/
+export declare const widgetHandlers: Store<{
+	[key: string]: ActionEventHandler[]
+}>;
+/**
+* {@link getWidgetHandlers} function to get internal event handlers for widget API.
+*
+* @param handlers - New internal widget event handlers
+*
+* @returns Current internal widget handlers
+*
+* @internal
+*/
+export declare function getWidgetHandlers(): {
+	[key: string]: ActionEventHandler[]
+};
+/**
+* {@link setWidgetHandlers} function to set internal event handlers.
+*
+* @internal
+*/
+export declare function setWidgetHandlers(handlers: {
+	[key: string]: ActionEventHandler[]
+}): void;
+/**
+* Store to handle event handlers
+*
+* This is used internally.
+*
+* @internal
+*/
+export declare const eventHandlers: Store<{
+	[key: string]: ActionEventHandler
+}>;
+/**
+* イベントハンドラーの一覧を取得する
+*
+* @returns 現在のイベントハンドラー
+*
+* @public
+*/
+export declare function getEventHandlers(): {
+	[key: string]: ActionEventHandler
+};
+/**
+* イベントハンドラーを登録する
+*
+* @remarks
+* 登録したイベントハンドラーは、ビジュアルエディタでアクション本体とのテキストボタンのクリック時の動作で利用できます。
+*
+* @param handlers - 登録するイベントハンドラー
+*
+* @public
+*/
+export declare function setEventHandlers(handlers: {
+	[key: string]: ActionEventHandler
+}): {
+	[key: string]: ActionEventHandler
+};
+/**
+* イベントハンドラーをリセットする
+*
+*/
+export declare function resetEventHandlers(): void;
+/**
+* Store to handle destruction of action
+*
+* @internal
+*/
+export declare const destroyed: Store<boolean>;
+/**
+* {@link isDestroyed} function to check if action is destroyed.
+*
+* @returns Flag if action is destoryed / true: Destroyed, false: Not Destroyed
+*
+* @internal
+*/
+export declare function isDestroyed(): boolean;
+/**
+* {@link setDestroyed} function to set if action is destroyed.
+*
+* @internal
+*/
+export declare function setDestroyed(on: boolean): void;
+/**
+* Store to handle variables
+*
+* @internal
+*/
+export declare const variables: Store<{
+	[key: string]: any
+}>;
+/**
+* 変数の一覧を取得する
+*
+* @returns 現在の変数の一覧
+*/
+export declare function getVariables(): ActionVariables;
+/**
+* 変数を設定する
+*
+* @remarks
+* 設定した変数は、ビジュアルエディタのテキストフォームなどで利用できます。
+*
+* @param vars - 変数
+*/
+export declare function setVariables(vars: ActionVariables): ActionVariables;
+/**
+* 変数をリセットする
+*/
+export declare function resetVariables(): void;
+/** @internal */
+export interface FormData {
+	[name: string]: {
+		value: any
+		statePath: string
+		isValid: boolean
+	};
+}
+/**
+* Store for form data
+*
+* @internal
+*/
+export declare const formData: Writable_<FormData>;
+/**
+* Store for identify form data
+*
+* @internal
+*/
+export declare const identifyFormData: Writable_<FormData>;

package/dist/svelte5/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"
+};

package/dist/svelte5/utils.d.ts

@@ -0,0 +1,171 @@
+import type { ModalMargin, ModalPosition } from "./prop.js";
+/** @internal */
+export declare const NOOP: Function;
+/** @internal */
+export declare const isPreview: () => boolean;
+export declare const isCanvasPreview: () => boolean;
+export declare const isOnSite: () => boolean;
+export declare const isInFrame: () => boolean;
+/** @internal */
+export declare const setPreviousFocus: () => void;
+/** @internal */
+export declare const handleKeydown: (handlers: {
+	[eventName: string]: (e: any) => void
+}) => (e: any) => void;
+declare const TRANSFORM: {
+	readonly "top-center": {
+		readonly x: 50
+		readonly y: 0
+	}
+	readonly "top-left": {
+		readonly x: 0
+		readonly y: 0
+	}
+	readonly "top-right": {
+		readonly x: 0
+		readonly y: 0
+	}
+	readonly "center-left": {
+		readonly x: 0
+		readonly y: -50
+	}
+	readonly center: {
+		readonly x: -50
+		readonly y: -50
+	}
+	readonly "center-right": {
+		readonly x: 0
+		readonly y: -50
+	}
+	readonly "bottom-left": {
+		readonly x: 0
+		readonly y: 0
+	}
+	readonly "bottom-center": {
+		readonly x: -50
+		readonly y: 0
+	}
+	readonly "bottom-right": {
+		readonly x: 0
+		readonly y: 0
+	}
+	readonly none: {
+		readonly x: 0
+		readonly y: 0
+	}
+};
+/** @internal */
+export declare const getPositionStyle: (position: ModalPosition) => string;
+/** @internal */
+export declare const getTransform: (position: ModalPosition) => (typeof TRANSFORM)[ModalPosition];
+/** @internal */
+export declare const getMarginStyle: (margin: ModalMargin) => string;
+/** @internal */
+export declare const parseStyle: (style: string) => Record<string, string>;
+/** @internal */
+export declare const stringifyStyleObj: (styleObj: Record<string, string>) => string;
+/** @internal */
+export declare const formatObjectKey: ({ obj, prefix, suffix }: {
+	obj: {
+		[key: string]: any
+	}
+	prefix?: string
+	suffix?: string
+}) => {
+	[key: string]: any
+};
+/**
+* スクロール方向
+*
+* @public
+*
+* @see {@link onScroll}
+*/
+export type ScrollDirection = "up" | "down";
+/**
+* {@link onScroll} のスクロールコンテキスト情報
+*
+* @remarks
+* このコンテキスト情報は、{@link OnScrollFunction} が呼び出されたタイミングの情報が格納されています
+*
+* @see {@link onScroll}
+*
+* @public
+*/
+export interface OnScrollContext {
+	/**
+	* {@link onScroll} によって指定されたスクロール率
+	*/
+	rate: number;
+	/**
+	* ページのスクロール率
+	*/
+	scrollRate: number;
+	/**
+	* 前のスクロール率
+	*/
+	previousRate: number;
+	/**
+	* 現在のスクロール率と前のスクロール率との差分値
+	*/
+	deltaRate: number;
+	/**
+	* スクロール方向
+	*/
+	direction: ScrollDirection;
+}
+/**
+* {@link onScroll} によって呼び出されるコールバック関数
+*
+* @see {@link onScroll}
+*
+* @public
+*/
+export type OnScrollFunction = (ctx: OnScrollContext) => boolean;
+/**
+* スクロール率が達したときに呼び出すコールバックを登録します
+*
+* @param rate - スクロール率。この値は viewport でのスクロールのパーセンテージ
+* @param fn - スクロール率が達したときに呼び出されるコールバック関数
+*
+* @returns スクロール率によって呼び出されるコールバックを停止する関数を返します
+*
+* @public
+*/
+export declare function onScroll(rate: number | number[], fn: OnScrollFunction): () => void;
+/**
+* 指定した時間の経過後に呼び出すコールバックを登録します
+*
+* @param time - コールバックを呼び出すまでの時間。単位はミリセカンド(ms)
+* @param fn - 指定した時間が経過後に呼び出されるコールバック関数
+*
+* @returns コールバックを呼び出すためのタイマーを停止する関数を返します
+*
+* @public
+*/
+export declare function onTime(time: number, fn: Function): () => void;
+/** @internal */
+export declare function hasSuffix<Suffix extends "px" | "em" | "rem" | "%" | "fr" | "vw" | "vh" | "">(value: string, suffix: Suffix): value is `${number}${Suffix}`;
+/** @internal */
+export declare function toBr(text: string): string;
+/** @internal */
+export declare function randStr(digit?: number): string;
+/**
+* Goolge Fonts用のURLを生成
+*
+* @param fonts - フォント名の配列
+* @param texts - 使用するテキストの配列
+*
+* @remarks
+* textsを指定した場合フォントサイズが削減される
+*
+* @internal
+*/
+export declare function makeGoogleFontUrl(fonts: string[], texts?: string[]): string;
+/**
+* HTML要素を生成
+*
+* @internal
+*/
+export declare const h: (type: string, props: any, ...children: Array<any>) => HTMLElement;
+export {};