@plaidev/karte-action-sdk 1.1.268 → 1.1.269-29151822.663827f4

package/dist/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/action.d.ts

@@ -0,0 +1,63 @@
+import type { ActionVariables, ActionOptions, ActionHook } from "./types.js";
+import type { SvelteComponentTyped } from "svelte";
+import type { VariableQuery } from "./collection.js";
+import type { Props as ModalProps } from "./display-logic.js";
+/**
+* アクションを作成する
+*
+* @param App - Svelte コンポーネントのエントリポイント
+* @param options - {@link ActionOptions | オプション}
+*
+* @returns アクションを破棄する関数
+*
+* @public
+*/
+export declare function create<
+	Props extends ModalProps,
+	Variables,
+	VariablesQuery extends Array<VariableQuery>
+>(App: typeof SvelteComponentTyped, options?: ActionOptions<Props, Variables & ActionVariables, VariablesQuery>): () => void;
+/**
+* アクションの破棄する
+*
+* @public
+*/
+export declare function destroyAction(): void;
+/**
+* アクションが作成 (create) される前にフックする関数
+*
+* @param fn - 呼び出されるフック関数
+*
+* @public
+*/
+export declare function onCreate<
+	Props extends ModalProps,
+	Variables
+>(fn: ActionHook<Props, Variables & ActionVariables>): void;
+/**
+* アクションが破棄 (destroy) される前にフックする関数
+*
+* @param fn - 呼び出されるフック関数
+*
+* @public
+*/
+export declare function onDestroy<
+	Props extends ModalProps,
+	Variables
+>(fn: ActionHook<Props, Variables & ActionVariables>): void;
+/**
+* 非推奨
+*
+* @deprecated 非推奨
+*
+* @internal
+*/
+export declare const showModal: typeof create;
+/**
+* 非推奨
+*
+* @deprecated 非推奨
+*
+* @internal
+*/
+export declare function destroy(): void;

package/dist/svelte5/actionEvent.d.ts

@@ -0,0 +1,25 @@
+import type { ActionSetting } from "./types.js";
+/** @internal */
+export declare const actionId: string;
+/** @internal */
+export declare const ACTION_DESTROY_EVENT: string;
+/** @internal */
+export declare const ACTION_SHOW_EVENT: string;
+/** @internal */
+export declare const ACTION_CLOSE_EVENT: string;
+/** @internal */
+export declare const ACTION_CHANGE_STATE_EVENT: string;
+/** @internal */
+export declare const send_event: (event_name: string, values?: any) => void;
+/** @internal */
+export declare const publish_edge: (topic: string, values?: any) => void;
+/** @internal */
+export declare const initialize: (setting?: ActionSetting) => () => void;
+/** @internal */
+export declare const finalize: () => void;
+/**
+* Dispatch the event to destroy KARTE action
+*
+* @internal
+*/
+export declare function dispatchDestroyEvent(): void;

package/dist/svelte5/collection.d.ts

@@ -0,0 +1,121 @@
+type ActionTableResult = number | string | boolean | Date | null | undefined;
+type ActionTableQueryParam = string | number | boolean | Date;
+type ActionTableQueryParams = {
+	[key: string]: ActionTableQueryParam | ActionTableQueryParam[]
+};
+/**
+* アクションテーブルの設定情報
+*
+* @param api_key - API Key
+* @param table - テーブル名
+* @param endpoint - エンドポイント / 指定がない場合はデフォルトのエンドポイントを使用します。検証用途以外での通常利用では指定なしで大丈夫です。
+*/
+export type CollectionConfig = {
+	api_key: string
+	table: string
+	collection_endpoint?: string
+};
+/**
+* アクションテーブルを管理するメソッドを取得する
+*
+* @param config - アクションテーブル設定情報
+*
+* @returns メソッドを返します
+*
+* @public
+*/
+export declare function collection(config: CollectionConfig): {
+	/**
+	* キーを１つ、または複数指定して、対応するアクションテーブルの行を取得する
+	*
+	* @param key - 取得する行のキーを一つ、または複数配列で指定
+	* @param cb - テーブルの行を取得した後に実行するcallback関数
+	*
+	* @public
+	*/
+	get(key: string | Array<string>, cb: (err: Error | null, items?: ActionTableResult | Array<ActionTableResult>) => void): void
+	/**
+	* クエリーを指定して、アクションテーブルから行を取得する
+	* なお、クエリーは事前に管理画面で設定しておく必要があります。
+	*
+	* @param query_name - クエリー名
+	* @param params - クエリーに指定するパラメーター。 `{key: value}` の形式で指定
+	* @param cb - テーブルの行を取得した後に実行するcallback関数
+	*
+	* @public
+	*/
+	getByQuery(query_name: string, params: ActionTableQueryParams, options: {
+		ignore_fields?: string[]
+	} | null | undefined, cb: (err: Error | null, items?: Array<ActionTableResult>) => void): void
+	/** @internal */
+	set(key: string, value: string, cb: (err: Error | null) => void): void
+};
+/** @internal */
+export type VariableQuery = {
+	resolver: string
+	name: string
+	query: any
+	preview_value?: any
+};
+/** @internal */
+export type ActionTableRowRequestConfig = VariableQuery & {
+	resolver: "action-table-row"
+	query: {
+		table_name: string
+		key: string
+		default_value?: ActionTableResult
+	}
+	preview_value?: ActionTableResult
+};
+/** @internal */
+export type ActionTableRowsRequestConfig = VariableQuery & {
+	resolver: "action-table-rows"
+	query: {
+		table_name: string
+		keys: Array<string>
+		default_value?: Array<ActionTableResult>
+	}
+	preview_value?: Array<ActionTableResult>
+};
+/** @internal */
+export type ActionTableQueryRequestConfig = VariableQuery & {
+	resolver: "action-table-query"
+	query: {
+		table_name: string
+		query_name: string
+		params?: {
+			[key: string]: string
+		}
+		default_value?: Array<ActionTableResult>
+	}
+	preview_value?: Array<ActionTableResult>
+};
+/** @internal */
+export type ActionTableRequestConfig = ActionTableRowRequestConfig | ActionTableRowsRequestConfig | ActionTableQueryRequestConfig;
+/** @internal */
+export declare const loadActionTableRow: (config: ActionTableRowRequestConfig, data: {
+	[key: string]: any
+}, api_key: string, collection_endpoint?: string) => Promise<unknown>;
+/** @internal */
+export declare const loadActionTableRows: (config: ActionTableRowsRequestConfig, data: {
+	[key: string]: any
+}, api_key: string, collection_endpoint?: string) => Promise<unknown>;
+/** @internal */
+export declare const loadActionTableQuery: (config: ActionTableQueryRequestConfig, data: {
+	[key: string]: any
+}, api_key: string, collection_endpoint?: string) => Promise<unknown>;
+/** @internal */
+export declare const loadActionTable: (config: Array<VariableQuery>, data: {
+	[key: string]: any
+}, api_key: string, collection_endpoint?: string) => Promise<{
+	[key: string]: any
+}>;
+/** @internal */
+export declare function setupActionTable(localVariablesQuery: Array<VariableQuery>, data: {
+	[key: string]: any
+}, apiKey: string, collection_endpoint: string): Promise<{
+	success: boolean
+}>;
+/** @internal */
+export declare function initActionTable(localVariablesQuery: Array<VariableQuery> | undefined): void;
+export {};

package/dist/svelte5/components/index.d.ts

@@ -0,0 +1,32 @@
+import { onMount as onMountSvelte, onDestroy as onDestorySvelte, beforeUpdate as beforeUpdateSvelte, afterUpdate as afterUpdateSvelte, tick as tickSvelte } from "svelte";
+/**
+* エレメントをマウントしたときに実行される関数の登録
+*
+* @param fn - マウントしたときに実行される関数
+*/
+export declare const onMount: typeof onMountSvelte;
+/**
+* エレメントを破棄したときに実行される関数の登録
+*
+* @param fn - マウントしたときに実行される関数
+*/
+export declare const onDestory: typeof onDestorySvelte;
+/**
+* エレメントを更新する前に実行される関数の登録
+*
+* @param fn - マウントしたときに実行される関数
+*/
+export declare const beforeUpdate: typeof beforeUpdateSvelte;
+/**
+* エレメントを更新した後に実行される関数の登録
+*
+* @param fn - マウントしたときに実行される関数
+*/
+export declare const afterUpdate: typeof afterUpdateSvelte;
+/**
+* エレメントのライフサイクルを進める
+*
+* @returns Promise<void>
+*/
+export declare const tick: typeof tickSvelte;
+export declare const LAYOUT_COMPONENT_NAMES: string[];

package/dist/svelte5/components-flex/avatar/styles.d.ts

@@ -0,0 +1,3 @@
+import type { PropStyles } from "../shared/types.js";
+import type { AvatarProps } from "./types.js";
+export declare const AVATAR_SIZE_STYLES: PropStyles<AvatarProps, "size">;

package/dist/svelte5/components-flex/avatar/types.d.ts

@@ -0,0 +1,24 @@
+import type { BorderProps, ClickableProps, CommonProps, PaddingProps } from "../props.js";
+import type { Properties } from "csstype";
+export declare const AVATAR_SIZE: {
+	readonly extra_small: "XS（48 x 48）"
+	readonly small: "S（64 x 64）"
+	readonly medium: "M（88 x 88）"
+	readonly large: "L（108 x 108）"
+	readonly extra_large: "XL（128 x 128）"
+};
+export declare const AVATAR_SHAPE: {
+	readonly circle: "サークル"
+	readonly square: "スクエア"
+	readonly rounded: "ラウンド"
+};
+export type AvatarProps = CommonProps & ClickableProps & PaddingProps & BorderProps & {
+	size?: keyof typeof AVATAR_SIZE | number
+	width?: Properties["width"]
+	height?: Properties["height"]
+	shape?: keyof typeof AVATAR_SHAPE
+	image?: string
+	caption?: string
+	alt?: string
+};
+export declare const avatarPropsDefault: AvatarProps;

package/dist/svelte5/components-flex/brand-kit.d.ts

@@ -0,0 +1,16 @@
+export type BrandKit = {
+	font_family: string
+	color_text_primary: string
+	color_text_secondary: string
+	color_brand: string
+	color_link: string
+	color_danger: string
+	color_success: string
+	color_info: string
+	color_warning: string
+	color_white: string
+};
+export declare const getBrandKit: (customBrandKit?: Partial<BrandKit>) => BrandKit;
+export declare const useBrandKit: () => {
+	brandKit: BrandKit
+};

package/dist/svelte5/components-flex/button/styles.d.ts

@@ -0,0 +1,8 @@
+import type { ButtonProps } from "src/components-flex/button/types";
+import type { PropStyles } from "../shared/types.js";
+import type { BrandKit } from "../brand-kit.js";
+import type { BrandableStyles } from "../styles.js";
+export declare const getButtonThemeStyles: (customBrandKit?: Partial<BrandKit>) => BrandableStyles<ButtonProps>;
+export declare const BUTTON_SIZE_STYLES: PropStyles<ButtonProps, "size">;
+export declare const BUTTON_ROUND_STYLES: PropStyles<ButtonProps, "round">;
+export declare const BUTTON_WRAP_STYLES: PropStyles<ButtonProps, "wrap">;