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

package/dist/prop.d.ts

@@ -0,0 +1,431 @@
+/**
+* ポップアップ(モーダル)のコンポーネントで利用するPropの定義
+*/
+/** @internal */
+export declare const PropTypes: readonly ["BooleanKeyword", "NumberKeyword", "StringKeyword", "Function", "Enum", "Code", "Direction", "Url", "Image", "AnimationStyle", "LongText", "Length", "Color", "Alignment", "State", "TransitState", "Style", "ModalPlacement", "OnClick"];
+/** @internal */
+export type PropType = (typeof PropTypes)[number];
+/** @internal */
+export type Code = string;
+/** @internal */
+export declare const MediaQueries: {
+	[key: string]: string
+};
+/** @internal */
+export type MediaQuery = string;
+/** @internal */
+export declare const Directions: readonly ["row", "column"];
+/** @internal */
+export type Direction = (typeof Directions)[number];
+/** @internal */
+export declare const AnimationStyles: readonly ["none", "fade", "bounce", "slide-down", "slide-up", "slide-left", "slide-right"];
+/** @internal */
+export type AnimationStyle = (typeof AnimationStyles)[number];
+/** @internal */
+export declare const ModalPositions: readonly ["top-left", "top-center", "top-right", "center-left", "center", "center-right", "bottom-left", "bottom-center", "bottom-right", "none"];
+/** @internal */
+export type ModalPosition = (typeof ModalPositions)[number];
+/** @internal */
+export type ModalMargin = {
+	left?: string
+	right?: string
+	top?: string
+	bottom?: string
+};
+/** @internal */
+export type ModalPlacement<M = ModalMargin> = {
+	position?: ModalPosition
+	margin?: M
+	backgroundOverlay?: boolean
+	backgroundClick?: OnClickOperation
+};
+/** @internal */
+export declare const DefaultModalPlacement: Required<ModalPlacement<Required<ModalMargin>>>;
+/** @internal */
+export declare const Elasticities: readonly ["none", "vertical", "horizontal"];
+/** @internal */
+export type Elasticity = (typeof Elasticities)[number];
+/** @internal */
+export declare const ElasticityStyle: {
+	none: string
+	vertical: string
+	horizontal: string
+};
+/** @internal */
+export declare const DefaultElasticity: Elasticity;
+/** @internal */
+export declare const TextDirections: readonly ["horizontal", "vertical"];
+/** @internal */
+export type TextDirection = (typeof TextDirections)[number];
+type OperationArgumentTypes = {
+	StringKeyword: string
+	BooleanKeyword: boolean
+	NumberKeyword: number
+	TransitState: string
+	Url: string
+	Color: string
+	Handler: string
+	Trigger: string
+};
+/** @internal */
+export type OperationArgumentType = keyof OperationArgumentTypes;
+type BaseOperationOptions = ReadonlyArray<{
+	operation: string
+	args: ReadonlyArray<{
+		name: string
+		type: OperationArgumentType
+		default: any
+	}>
+}>;
+type ConvertOperationOptions<O extends BaseOperationOptions> = ConvertOperationOption<O[number]>;
+type ConvertOperationOption<Option extends BaseOperationOptions[number]> = Option extends any ? {
+	operation: Option["operation"]
+	args: ConvertOperationOptionArguments<Option["args"]>
+} : never;
+type ConvertOperationOptionArguments<Arguments extends BaseOperationOptions[number]["args"]> = { -readonly [Index in keyof Arguments] : Arguments[Index] extends BaseOperationOptions[number]["args"][number] ? OperationArgumentTypes[Arguments[Index]["type"]] : never };
+/** @internal */
+export type Operation = ConvertOperationOptions<ReadonlyArray<any>>;
+/** @internal */
+export declare const OnClickOperationOptions: readonly [{
+	readonly operation: "none"
+	readonly args: readonly []
+}, {
+	readonly operation: "linkTo"
+	readonly args: readonly [{
+		readonly name: "url"
+		readonly type: "Url"
+		readonly default: "https://example.com"
+	}, {
+		readonly name: "open_new_tab"
+		readonly type: "BooleanKeyword"
+		readonly default: true
+	}, {
+		readonly name: "decode"
+		readonly type: "BooleanKeyword"
+		readonly default: false
+	}]
+}, {
+	readonly operation: "moveTo"
+	readonly args: readonly [{
+		readonly name: "state"
+		readonly type: "TransitState"
+		readonly default: "/"
+	}]
+}, {
+	readonly operation: "closeApp"
+	readonly args: readonly [{
+		readonly name: "trigger"
+		readonly type: "Trigger"
+		readonly default: "button"
+	}]
+}, {
+	readonly operation: "runScript"
+	readonly args: readonly [{
+		readonly name: "handler"
+		readonly type: "Handler"
+		readonly default: ""
+	}]
+}, {
+	readonly operation: "submitForm"
+	readonly args: readonly [{
+		readonly name: "state"
+		readonly type: "TransitState"
+		readonly default: "/"
+	}]
+}, {
+	readonly operation: "bootChat"
+	readonly args: readonly [{
+		readonly name: "hide_launcher"
+		readonly type: "BooleanKeyword"
+		readonly default: false
+	}, {
+		readonly name: "placement_pc"
+		readonly type: "StringKeyword"
+		readonly default: "left"
+	}, {
+		readonly name: "placement_mobile"
+		readonly type: "StringKeyword"
+		readonly default: "left"
+	}, {
+		readonly name: "horizontal_spacing_pc"
+		readonly type: "NumberKeyword"
+		readonly default: 20
+	}, {
+		readonly name: "horizontal_spacing_mobile"
+		readonly type: "NumberKeyword"
+		readonly default: 20
+	}, {
+		readonly name: "vertical_spacing_pc"
+		readonly type: "NumberKeyword"
+		readonly default: 20
+	}, {
+		readonly name: "vertical_spacing_mobile"
+		readonly type: "NumberKeyword"
+		readonly default: 20
+	}, {
+		readonly name: "theme_color"
+		readonly type: "Color"
+		readonly default: "#2aab9f"
+	}, {
+		readonly name: "header_title"
+		readonly type: "StringKeyword"
+		readonly default: "KARTEサポートチーム"
+	}, {
+		readonly name: "header_description"
+		readonly type: "StringKeyword"
+		readonly default: "ご質問があればお尋ねください。\nKARTEサポート担当者につながります。サポート受付時間は平日10:30-17:30です。"
+	}, {
+		readonly name: "launcher_image"
+		readonly type: "StringKeyword"
+		readonly default: ""
+	}]
+}];
+/** @internal */
+export type OnClickOperation = ConvertOperationOptions<typeof OnClickOperationOptions>;
+/** @internal */
+export type LongText = string;
+/** @internal */
+export type Url = string;
+/** @internal */
+export type RegExpProp = {
+	pattern: string
+	flags: string
+};
+/** @internal */
+export type Image = string;
+/** @internal */
+export declare const LengthUnits: readonly ["px", "em", "rem", "vw", "fr", "%"];
+/** @internal */
+export type LengthUnit = (typeof LengthUnits)[number];
+/** @internal */
+export type Length = `${number}${LengthUnit}` | "auto";
+/** @internal */
+export type Color = `#${string}` | `rgba(${string})`;
+/** @internal */
+export type FontWeight = string;
+/** @internal */
+export declare const SYSTEM_FONT = "sans-serif, serif, monospace, system-ui";
+/** @internal */
+export declare const Fonts: string[];
+export type Font = (typeof Fonts)[number];
+/** @internal */
+export declare const Justifies: readonly ["flex-start", "center", "flex-end"];
+/** @internal */
+export type Justify = (typeof Justifies)[number];
+/** @internal */
+export declare const Alignments: readonly ["flex-start", "center", "flex-end"];
+/** @internal */
+export type Alignment = (typeof Alignments)[number];
+/** @internal */
+export declare const FlexDirections: readonly ["row", "column"];
+/** @internal */
+export type FlexDirection = (typeof FlexDirections)[number];
+/** @internal */
+export declare const ObjectFits: readonly ["cover", "fill", "contain"];
+/** @internal */
+export type ObjectFit = (typeof ObjectFits)[number];
+/** @internal */
+export declare const ClipPaths: readonly ["none", "circle(closest-side)"];
+/** @internal */
+export type ClipPath = (typeof ClipPaths)[number];
+/** @internal */
+export declare const Repeats: readonly ["repeat", "space", "round", "no-repeat"];
+/** @internal */
+export type Repeat = (typeof Repeats)[number];
+/** @internal */
+export declare const BackgroundSizes: readonly ["auto", "cover", "contain"];
+/** @internal */
+export type BackgroundSize = (typeof BackgroundSizes)[number];
+/** @internal */
+export declare const Cursors: readonly ["default", "pointer"];
+/** @internal */
+export type Cursor = (typeof Cursors)[number];
+/** @internal */
+export declare const Overflows: readonly ["hidden", "auto", "visible"];
+/** @internal */
+export type Overflow = (typeof Overflows)[number];
+/** @internal */
+export type Border = string;
+/** @internal */
+export type BorderStyle = string;
+/** @internal */
+export type BorderWidth = `${number}px`;
+/** @internal */
+export type BoxShadow = string;
+/** @internal */
+export type Style = string;
+/** @internal */
+export type TransitState = string;
+/** @internal */
+export declare const WritingModes: readonly ["horizontal-tb", "vertical-lr"];
+/** @internal */
+export type WritingMode = (typeof WritingModes)[number];
+/** @internal */
+export type DateTime = string;
+/** @internal */
+export type Icon = string;
+/** @internal */
+export declare const ListSeparatorTypes: readonly ["none", "border", "gap"];
+/** @internal */
+export interface EdgePosition {
+	edgeDistance: Length;
+	edgeDirectionOffset: Length;
+}
+/** @internal */
+export declare const DefaultEdgePosition: EdgePosition;
+type ListSeparatorType = (typeof ListSeparatorTypes)[number];
+interface BaseListSeparator {
+	type: ListSeparatorType;
+}
+/** @internal */
+export interface ListSeparatorNone extends BaseListSeparator {
+	type: "none";
+}
+/** @internal */
+export interface ListSeparatorBorder extends BaseListSeparator {
+	type: "border";
+	borderStyle: BorderStyle;
+	borderWidth?: BorderWidth;
+	borderColor?: Color;
+}
+/** @internal */
+export interface ListSeparatorGap extends BaseListSeparator {
+	type: "gap";
+	gap: Length;
+}
+/** @internal */
+export type ListSeparator = ListSeparatorNone | ListSeparatorBorder | ListSeparatorGap;
+/** @internal */
+export declare const DefaultListSeparatorNone: Required<ListSeparatorNone>;
+/** @internal */
+export declare const DefaultListSeparatorBorder: Required<ListSeparatorBorder>;
+/** @internal */
+export declare const DefaultListSeparatorGap: Required<ListSeparatorGap>;
+/** @internal */
+export declare const DefaultListSeparator: Required<ListSeparatorBorder>;
+/** @internal */
+export declare const ListBackgroundTypes: readonly ["none", "stripe"];
+type ListBackgroundType = (typeof ListBackgroundTypes)[number];
+interface BaseListBackground {
+	type: ListBackgroundType;
+}
+/** @internal */
+export interface ListBackgroundNone extends BaseListBackground {
+	type: "none";
+}
+/** @internal */
+export interface ListBackgroundStripe extends BaseListBackground {
+	type: "stripe";
+	background1?: Color;
+	background2?: Color;
+}
+/**
+* @internal
+*/
+export type ListBackground = ListBackgroundNone | ListBackgroundStripe;
+/** @internal */
+export declare const DefaultListBackgroundNone: Required<ListBackgroundNone>;
+/** @internal */
+export declare const DefaultListBackgroundStripe: Required<ListBackgroundStripe>;
+/** @internal */
+export declare const DefaultListBackground: Required<ListBackgroundNone>;
+/** @internal */
+export declare const ListDirections: readonly ["vertical", "horizontal"];
+/** @internal */
+export type ListDirection = (typeof ListDirections)[number];
+/** @internal */
+export type ListContext = {
+	separator: ListSeparator
+	background: ListBackground
+	direction: ListDirection
+	registerItem: (props: {
+		onMount: (props: {
+			index: number
+			length: number
+		}) => void
+	}) => string
+	unregisterItem: (id: string) => void
+};
+type SlideButtonType = "icon" | "text";
+type BaseSlideButton = {
+	type: SlideButtonType
+};
+/** @internal */
+export interface SlideButtonIcon extends BaseSlideButton {
+	type: "icon";
+	icon: string;
+	size: Length;
+	color: Color;
+	fill: Color;
+}
+/** @internal */
+export interface SlideButtonText extends BaseSlideButton {
+	type: "text";
+	text: string;
+}
+/** @internal */
+export type SlideButton = SlideButtonIcon | SlideButtonText;
+/** @internal */
+export declare const DefaultSlideButton: {
+	readonly type: "icon"
+	readonly icon: "chevron-left"
+	readonly color: "#999"
+	readonly fill: "#999"
+	readonly size: "20px"
+};
+/** @internal */
+export type SlideButtonPosition = "top" | "middle" | "bottom";
+/** @internal */
+export interface SlideNavigationButton {
+	type: "circle";
+	size: Length;
+	color: Color;
+	colorActive: Color;
+}
+/** @internal */
+export declare const DefaultSlideNavigationButton: {
+	readonly type: "circle"
+	readonly size: "8px"
+	readonly color: "#ddd"
+	readonly colorActive: "#666"
+};
+/** @internal */
+export type FormInputName = string;
+/** @internal */
+export interface FormButtonColor {
+	main: Color;
+	sub: Color;
+}
+/** @internal */
+export declare const DefaultFormButtonColor: {
+	readonly main: "#2aab9f"
+	readonly sub: "#fff"
+};
+/** @internal */
+export type ModalStyle = {
+	placement?: ModalPlacement
+	elasticity?: Elasticity
+};
+/** @internal */
+export type ModalBreakPoint = {
+	PC: ModalStyle
+	SP: ModalStyle
+};
+/** @internal */
+export declare const DefaultModalBreakPoint: ModalBreakPoint;
+export declare const FormIdentifyTextFields: readonly ["email", "phone", "first_name", "last_name", "address"];
+/** @internal */
+export type FormIdentifyTextField = (typeof FormIdentifyTextFields)[number];
+/** @internal */
+export declare const FormIdentifyTextFieldValidations: { [K in FormIdentifyTextField] : RegExpProp };
+/** @internal */
+export declare const FormIdentifyTextFieldPlaceholders: { [K in FormIdentifyTextField] : string };
+/** @internal */
+export declare const DefaultFormIdentifyTextField: FormIdentifyTextField;
+/** @internal */
+export declare const FormIdentifyBooleanFields: readonly ["subscription", "phone_subscribe"];
+/** @internal */
+export type FormIdentifyBooleanField = (typeof FormIdentifyBooleanFields)[number];
+/** @internal */
+export declare const DefaultFormIdentifyBooleanField: FormIdentifyBooleanField;
+export {};

package/dist/script.d.ts

@@ -0,0 +1,33 @@
+import type { ActionVariables, ActionOptions } from "./types.js";
+import type { VariableQuery } from "./collection.js";
+import type { Props as ModalProps } from "./display-logic.js";
+/** @internal */
+export declare function runScript<
+	Props extends ModalProps,
+	Variables,
+	VariablesQuery extends Array<VariableQuery>
+>(options?: ActionOptions<Props, Variables & ActionVariables, VariablesQuery>): Promise<void>;
+/**
+* ES Modules に対応していない JavaScript をページに読み込む
+*
+* @param src - JavaScript ファイルのリンク URL
+*
+* @public
+*/
+export declare function loadGlobalScript(src: string): Promise<any>;
+/**
+* グローバル CSS をページに適用する
+*
+* @param css - CSS
+*
+* @public
+*/
+export declare function applyGlobalCss(css: string): Promise<any>;
+/**
+* style ファイルをページに読み込む
+*
+* @param href - style ファイルのリンク URL
+*
+* @public
+*/
+export declare function loadGlobalStyle(href: string): Promise<any>;