@plaidev/karte-action-sdk 1.1.52 → 1.1.55

package/dist/hydrate/index.es.d.ts

@@ -1,4 +1,5 @@
 import { Writable } from "svelte/store";
+import { SvelteComponentDev } from "svelte/internal";
 declare const PropTypes: readonly [
     "BooleanKeyword",
     "NumberKeyword",
@@ -314,12 +315,56 @@ declare const handleKeydown: (handlers: {
     [eventName: string]: (e: any) => void;
 }) => (e: any) => void;
 declare const getPositionStyle: (position: ModalPosition) => string;
+declare const getTransform: (position: ModalPosition) => [
+    number,
+    number
+];
 declare const getMarginStyle: (margin: ModalMargin) => string;
 declare function onScroll(fn: Function, rate: number): () => void;
 declare function onTime(fn: Function, time: number): () => void;
 declare function hasSuffix<Suffix extends "px" | "em" | "rem" | "%" | "fr" | "vw" | "vh" | "">(value: string, suffix: Suffix): value is `${number}${Suffix}`;
 declare function toBr(text: string): string;
 declare function randStr(digit?: number): string;
+/**
+ * An option for svelte custom animation
+ */
+interface CustomAnimationOptions {
+    /**
+     * A Transform value in percent of target element
+     */
+    transform: [
+        number,
+        number
+    ];
+    /**
+     * A style of animation(e.g. fade, slide-in)
+     */
+    animationStyle: AnimationStyle;
+    /**
+     * A waiting time in milliseconds before starting animation
+     *
+     * @default 0
+     */
+    delay?: number;
+    /**
+     *  A total duration time in milliseconds of the animation
+     *
+     * @default 1000
+     */
+    duration?: number;
+}
+/**
+ * The function to activate svelte animation.
+ * @see {@link https://svelte.dev/docs#template-syntax-element-directives-transition-fn-custom-transition-functions| Custom transition functions} for detail documentation
+ * @param {Element} node A target node of animation. This argument is passed by svelte, by default.
+ * @param {CustomAnimationOptions} customAnimationOptions A custom animation option object
+ */
+declare function customAnimation(node: Element, { transform, animationStyle, delay, duration }: CustomAnimationOptions): {
+    delay: number;
+    duration: number;
+    easing: (t: any) => any;
+    css: (progress: number) => string;
+};
 declare function hideOnScroll<Props extends {
     hide_on_scroll: boolean;
     hide_on_scroll_rate: number;
@@ -338,6 +383,52 @@ declare function showOnTime<Props extends {
     show_on_time: boolean;
     show_on_time_count: number;
 }>(props: Props, fn?: Function): () => void;
+/**
+ * An options for {@link createApp}
+ */
+interface AppOptions<Props, Variables> {
+    /**
+     * {@link Send} function to receive events triggered in Karte action.
+     *
+     * @default () => {}
+     */
+    send?: Function;
+    /**
+     * {@link Props} used in Karte action.
+     *
+     * @default {}
+     */
+    props?: Props;
+    /**
+     * {@link Variables} in which user variables or action table used in Karte action.
+     *
+     * @default {}
+     */
+    variables?: Variables;
+}
+/**
+ * App application instance that is with {@link createApp}
+ *
+ * @description Currently, svelte component is supported only.
+ */
+interface App {
+    /**
+     * The method to destroy an app instance.
+     */
+    close: () => void;
+    /**
+     * The method to show an app instance.
+     */
+    show: () => void;
+}
+/**
+ * Create an application instance.
+ *
+ * @param App - An entry point of svelte component.
+ * @param options - An {@link AppOptions | options}
+ * @return An {@link App | app} instance
+ */
+declare const createApp: <Props, Variables>(App: typeof SvelteComponentDev, options?: AppOptions<Props, Variables>) => App;
 declare function ensureModalRoot(useShadow?: boolean): ShadowRoot | HTMLElement;
 declare const h: (type: string, props: any, ...children: Array<any>) => HTMLElement;
 declare function createFog({ color, opacity, zIndex, onclick }: {
@@ -364,7 +455,7 @@ declare const collection: (config: {
     } | null | undefined, cb: (err: Error | null, items?: any) => void): void;
     set(key: string, value: string, cb: (err: Error | null) => void): void;
 };
-export { state, closed, maximumZindex, initialize, finalize, send_event, isPreview, setMiximumZindex, none, moveTo, linkTo, closeApp, execOnClickOperation, handleFocus, setPreviousFocus, handleKeydown, getPositionStyle, getMarginStyle, onScroll, onTime, hasSuffix, toBr, randStr, PropTypes, PropType, Code, MediaQueries, MediaQuery, Directions, Direction, AnimationStyles, AnimationStyle, AnimationStyleTranslations, ModalPositions, ModalPosition, ModalPositionTranslations, ModalMarginTranslations, ModalMargin, ModalPlacement, DefaultModalPlacement, Operation, OnClickOperationOptions, OnClickOperation, LongText, Url, Image, LengthUnits, LengthUnit, Length, Color, Justifies, Justify, Alignments, Alignment, ObjectFits, ObjectFit, Repeats, Repeat, BackgroundSizes, BackgroundSize, Style, StateName, hideOnScroll, hideOnTime, showOnScroll, showOnTime, ensureModalRoot, h, createFog, EmbedLogic, embed, collection };
+export { state, closed, maximumZindex, initialize, finalize, send_event, isPreview, setMiximumZindex, none, moveTo, linkTo, closeApp, execOnClickOperation, handleFocus, setPreviousFocus, handleKeydown, getPositionStyle, getTransform, getMarginStyle, onScroll, onTime, hasSuffix, toBr, randStr, customAnimation, PropTypes, PropType, Code, MediaQueries, MediaQuery, Directions, Direction, AnimationStyles, AnimationStyle, AnimationStyleTranslations, ModalPositions, ModalPosition, ModalPositionTranslations, ModalMarginTranslations, ModalMargin, ModalPlacement, DefaultModalPlacement, Operation, OnClickOperationOptions, OnClickOperation, LongText, Url, Image, LengthUnits, LengthUnit, Length, Color, Justifies, Justify, Alignments, Alignment, ObjectFits, ObjectFit, Repeats, Repeat, BackgroundSizes, BackgroundSize, Style, StateName, hideOnScroll, hideOnTime, showOnScroll, showOnTime, AppOptions, App, createApp, ensureModalRoot, h, createFog, EmbedLogic, embed, collection };
 export { default as State } from './components/State.svelte';
 export { default as StateItem } from './components/StateItem.svelte';
 export { default as Modal } from './components/Modal.svelte';