haori 0.1.0

package/dist/src/procedure.d.ts

@@ -0,0 +1,203 @@
+/**
+ * @fileoverview 手続き的処理管理機能
+ *
+ * イベントに基づく手続き的な処理を提供します。
+ */
+import { ElementFragment } from './fragment';
+/**
+ * フェッチ前実行スクリプト戻り値型。
+ */
+export interface BeforeCallbackResult {
+    /** 処理を停止する場合は true */
+    stop?: boolean;
+    /** 上書きするフェッチURL */
+    fetchUrl?: string | null;
+    /** 上書きするフェッチオプション */
+    fetchOptions?: RequestInit | null;
+}
+/**
+ * フェッチ後実行スクリプト戻り値型。
+ */
+export interface AfterCallbackResult {
+    /** 処理を停止する場合は true */
+    stop?: boolean;
+    /** レスポンスとして使用するデータ */
+    response?: Response;
+}
+/**
+ * Procedureクラスのオプションインターフェース。
+ */
+export interface ProcedureOptions {
+    /** 処理対象のフラグメント */
+    targetFragment?: ElementFragment;
+    /** バリデーションを行うかどうか */
+    valid?: boolean;
+    /** 確認メッセージ */
+    confirmMessage?: string | null;
+    /** 送信もしくは受信データ */
+    data?: Record<string, unknown> | null;
+    /** フェッチ前実行スクリプト */
+    beforeCallback?: (fetchUrl: string | null, fetchOptions: RequestInit | null) => BeforeCallbackResult | boolean | void;
+    /** 対象フォームフラグメント */
+    formFragment?: ElementFragment | null;
+    /** フェッチURL */
+    fetchUrl?: string | null;
+    /** フェッチオプション */
+    fetchOptions?: RequestInit | null;
+    /** バインド対象フラグメント */
+    bindFragments?: ElementFragment[] | null;
+    /** レスポンスデータから抽出するパラメータ名のリスト */
+    bindParams?: string[] | null;
+    /** レスポンスデータをバインドする際のキー名 */
+    bindArg?: string | null;
+    /** フェッチ後実行スクリプト */
+    afterCallback?: (response: Response | Record<string, unknown>) => AfterCallbackResult | boolean | void;
+    /** 値を変更するフラグメント */
+    adjustFragments?: ElementFragment[] | null;
+    /** 変更する値の増減値 */
+    adjustValue?: number | null;
+    /** 行追加の有無 */
+    rowAdd?: boolean | null;
+    /** 行削除の有無 */
+    rowRemove?: boolean | null;
+    /** 前の行へ移動するかどうか */
+    rowMovePrev?: boolean | null;
+    /** 次の行へ移動するかどうか */
+    rowMoveNext?: boolean | null;
+    /** リセットするフラグメント */
+    resetFragments?: ElementFragment[] | null;
+    /** 再フェッチするフラグメント */
+    refetchFragments?: ElementFragment[] | null;
+    /** クリックするフラグメント */
+    clickFragments?: ElementFragment[] | null;
+    /** ダイアログを開くフラグメント */
+    openFragments?: ElementFragment[] | null;
+    /** ダイアログを閉じるフラグメント */
+    closeFragments?: ElementFragment[] | null;
+    /** ダイアログメッセージ */
+    dialogMessage?: string | null;
+    /** トーストメッセージ */
+    toastMessage?: string | null;
+    /** リダイレクトURL */
+    redirectUrl?: string | null;
+}
+/**
+ * 手続き的処理管理クラスです。
+ */
+export default class Procedure {
+    /**
+     * イベント属性名を正しく生成します。
+     * 例: ("click", "fetch") => "data-click-fetch"
+     *    (null, "fetch") => "data-fetch"
+     *    ("change", "bind-arg") => "data-change-bind-arg"
+     * 非イベント変種が "data-fetch-xxx" として存在するものについては、event が null の場合にそちらを返します。
+     */
+    private static attrName;
+    /**
+     * オプションをフラグメントの属性から構築します。
+     *
+     * @param fragment フラグメント
+     * @param event イベント名
+     * @return 構築されたオプション
+     */
+    private static buildOptions;
+    /**
+     * ElementFragment の構造的タイプガード。
+     *
+     * @param value チェックする値
+     * @returns ElementFragment である場合は true、それ以外は false
+     */
+    private static isElementFragment;
+    /** オプション */
+    private readonly options;
+    /**
+     * オプションを指定してProcedureクラスのインスタンスを生成します。
+     *
+     * @param options オプション
+     */
+    constructor(options: ProcedureOptions);
+    /**
+     * フラグメントの属性からオプションを生成してProcedureクラスのインスタンスを生成します。
+     *
+     * @param fragment フラグメント
+     * @param event イベント名
+     */
+    constructor(fragment: ElementFragment, event: string | null);
+    /**
+     * 一連の処理を実行します。オプションが空の場合は即座にresolveされます。
+     *
+     * @returns 実行結果のPromise
+     */
+    run(): Promise<void>;
+    /**
+     * フェッチ後の処理を実行します。
+     */
+    private handleFetchResult;
+    /**
+     * フェッチエラー応答のメッセージを適切な要素へ伝播します。
+     */
+    private handleFetchError;
+    /**
+     * 対象のフラグメント以下の入力要素に対してバリデーションを実行します。
+     * バリデーションエラーがある場合は、最初のエラー要素にフォーカスを移動します。
+     *
+     * @param fragment 対象のフラグメント
+     * @returns バリデーション結果（true: 成功, false: 失敗）
+     */
+    validate(fragment: ElementFragment): boolean;
+    /**
+     * 対象のフラグメントに対してバリデーションを実行します。
+     *
+     * @param fragment 対象のフラグメント
+     * @returns バリデーション結果（true: 成功, false: 失敗）
+     */
+    private validateOne;
+    /**
+     * 確認メッセージを表示し、ユーザーの確認を求めます。
+     * メッセージが設定されていない場合は、即座に成功とみなします。
+     *
+     * @returns ユーザーの確認結果を含むPromise（true: 確認, false: キャンセル）
+     */
+    private confirm;
+    /**
+     * 結果データを対象のフラグメントにバインドします。
+     *
+     * @param response フェッチのレスポンスオブジェクト
+     */
+    private bindResult;
+    /**
+     * 値の増減を行います。
+     */
+    private adjust;
+    /**
+     * 行フラグメントを取得します。
+     *
+     * @returns 行フラグメントまたはnull
+     */
+    private getRowFragment;
+    /**
+     * 行を追加します。
+     *
+     * @returns 処理結果のPromise
+     */
+    private addRow;
+    /**
+     * 行を削除します。
+     *
+     * @returns 処理結果のPromise
+     */
+    private removeRow;
+    /**
+     * 前の行へ移動します。
+     *
+     * @returns 処理結果のPromise
+     */
+    private movePrevRow;
+    /**
+     * 次の行へ移動します。
+     *
+     * @returns 処理結果のPromise
+     */
+    private moveNextRow;
+}
+//# sourceMappingURL=procedure.d.ts.map

package/dist/src/procedure.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"procedure.d.ts","sourceRoot":"","sources":["../../src/procedure.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAKH,OAAiB,EAAC,eAAe,EAAC,MAAM,YAAY,CAAC;AAKrD;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,sBAAsB;IACtB,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf,mBAAmB;IACnB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,qBAAqB;IACrB,YAAY,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,sBAAsB;IACtB,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf,sBAAsB;IACtB,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,kBAAkB;IAClB,cAAc,CAAC,EAAE,eAAe,CAAC;IAEjC,qBAAqB;IACrB,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB,cAAc;IACd,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B,kBAAkB;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAEtC,mBAAmB;IACnB,cAAc,CAAC,EAAE,CACf,QAAQ,EAAE,MAAM,GAAG,IAAI,EACvB,YAAY,EAAE,WAAW,GAAG,IAAI,KAC7B,oBAAoB,GAAG,OAAO,GAAG,IAAI,CAAC;IAE3C,mBAAmB;IACnB,YAAY,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;IAEtC,cAAc;IACd,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,gBAAgB;IAChB,YAAY,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;IAElC,mBAAmB;IACnB,aAAa,CAAC,EAAE,eAAe,EAAE,GAAG,IAAI,CAAC;IAEzC,+BAA+B;IAC/B,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAE7B,2BAA2B;IAC3B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,mBAAmB;IACnB,aAAa,CAAC,EAAE,CACd,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KACzC,mBAAmB,GAAG,OAAO,GAAG,IAAI,CAAC;IAE1C,mBAAmB;IACnB,eAAe,CAAC,EAAE,eAAe,EAAE,GAAG,IAAI,CAAC;IAE3C,gBAAgB;IAChB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,aAAa;IACb,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAExB,aAAa;IACb,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE3B,mBAAmB;IACnB,WAAW,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE7B,mBAAmB;IACnB,WAAW,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE7B,mBAAmB;IACnB,cAAc,CAAC,EAAE,eAAe,EAAE,GAAG,IAAI,CAAC;IAE1C,oBAAoB;IACpB,gBAAgB,CAAC,EAAE,eAAe,EAAE,GAAG,IAAI,CAAC;IAE5C,mBAAmB;IACnB,cAAc,CAAC,EAAE,eAAe,EAAE,GAAG,IAAI,CAAC;IAE1C,qBAAqB;IACrB,aAAa,CAAC,EAAE,eAAe,EAAE,GAAG,IAAI,CAAC;IAEzC,sBAAsB;IACtB,cAAc,CAAC,EAAE,eAAe,EAAE,GAAG,IAAI,CAAC;IAE1C,iBAAiB;IACjB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B,gBAAgB;IAChB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,gBAAgB;IAChB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,SAAS;IAC5B;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ;IAavB;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,CAAC,YAAY;IAsc3B;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,iBAAiB;IAWhC,YAAY;IACZ,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAmB;IAE3C;;;;OAIG;gBACS,OAAO,EAAE,gBAAgB;IAErC;;;;;OAKG;gBACS,QAAQ,EAAE,eAAe,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAmB3D;;;;OAIG;IACH,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;IA2LpB;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAqHzB;;OAEG;YACW,gBAAgB;IA0F9B;;;;;;OAMG;IACH,QAAQ,CAAC,QAAQ,EAAE,eAAe,GAAG,OAAO;IAmB5C;;;;;OAKG;IACH,OAAO,CAAC,WAAW;IAcnB;;;;;OAKG;IACH,OAAO,CAAC,OAAO;IAQf;;;;OAIG;IACH,OAAO,CAAC,UAAU;IAgDlB;;OAEG;IACH,OAAO,CAAC,MAAM;IA4Bd;;;;OAIG;IACH,OAAO,CAAC,cAAc;IAetB;;;;OAIG;IACH,OAAO,CAAC,MAAM;IAmBd;;;;OAIG;IACH,OAAO,CAAC,SAAS;IAyBjB;;;;OAIG;IACH,OAAO,CAAC,WAAW;IAmBnB;;;;OAIG;IACH,OAAO,CAAC,WAAW;CAkBpB"}