@shisyamo4131/air-guard-v2-schemas 2.4.2-dev.8 → 2.4.2-dev.81

package/src/FcmToken.js

@@ -0,0 +1,73 @@
+/*****************************************************************************
+ * @file src/FcmToken.js
+ *****************************************************************************/
+import FireModel from "@shisyamo4131/air-firebase-v2";
+import { defField } from "./parts/fieldDefinitions.js";
+
+/*****************************************************************************
+ * @class FcmToken
+ * @extends FireModel
+ *
+ * Firebase Cloud Messaging (FCM) のトークンをグローバル管理するためのコレクション
+ *
+ * - usePrefix: false でグローバルコレクション（Companies のサブコレクションではない）
+ * - ドキュメントID: FCMトークンそのもの
+ * - 同じトークンは同じデバイスを指すため、最後にログインしたユーザーの情報で上書きされる
+ *
+ * @property {string} token - FCMトークン（ドキュメントIDと同じ）
+ * @property {string} uid - ユーザーID（Firebase Authentication UID）
+ * @property {string} employeeId - 従業員ID
+ * @property {string} companyId - 会社ID
+ * @property {Date} updatedAt - 最終更新日時
+ *****************************************************************************/
+export default class FcmToken extends FireModel {
+  static className = "FCMトークン";
+  static collectionPath = "FcmTokens";
+  static usePrefix = false; // グローバルコレクション
+
+  static classProps = {
+    token: defField("token", {
+      required: true,
+      hidden: true,
+    }),
+    uid: defField("uid", {
+      required: true,
+      hidden: true,
+    }),
+    companyId: defField("companyId", {
+      required: true,
+      hidden: true,
+    }),
+    updatedAt: defField("dateTimeAt", {
+      label: "更新日時",
+      default: () => new Date(),
+      hidden: true,
+    }),
+  };
+
+  /**
+   * fcmToken ドキュメントはドキュメントIDにトークンそのものが使われることを前提としているため、
+   * create メソッドをオーバーライドして、updateOptions に docId が含まれていることを確認する。
+   * @param {*} updateOptions
+   * @returns {Promise<DocumentReference>}
+   */
+  async create(updateOptions = {}) {
+    const { docId } = updateOptions;
+    if (!docId) {
+      throw new Error(
+        "FCMトークンのドキュメントIDはトークンそのものを指定してください",
+      );
+    }
+    return await super.create(updateOptions);
+  }
+
+  /**
+   * FCMトークンは更新できないため、常にエラーを投げる
+   * @param {*} updateOptions
+   */
+  async update(updateOptions = {}) {
+    throw new Error(
+      "FCMトークンは更新できません。新しいトークンでドキュメントを作成してください。",
+    );
+  }
+}

package/src/Insurance.js

@@ -0,0 +1,409 @@
+/*****************************************************************************
+ * @file ./src/Insurance.js
+ * @description 保険（健康保険、厚生年金保険、雇用保険）ベースクラス
+ *****************************************************************************/
+import { BaseClass } from "@shisyamo4131/air-firebase-v2";
+import { VALUES as INSURANCE_STATUS } from "./constants/insurance-status.js";
+import { defField } from "./parts/fieldDefinitions.js";
+import { formatJstDate } from "./utils/index.js";
+
+export const ERROR_MESSAGES = Object.freeze({
+  INVALID_TRANSITION: (allowedStates) =>
+    `不正な処理です。${allowedStates} の状態でなければ処理は行えません。`,
+  PROCESSING_ONLY: (operation) =>
+    `不正な処理です。'加入手続き中' の状態でなければ${operation}は行えません。`,
+  ENROLLED_ONLY: (operation) =>
+    `不正な処理です。'${INSURANCE_STATUS.ENROLLED.title}' の状態でなければ${operation}はできません。`,
+  REQUIRED_FIELD: (field) => `${field}の指定が必要です。`,
+  REQUIRED_DATE: (field) => `日付オブジェクトでの${field}の指定が必要です。`,
+  NO_HISTORY: "復元する履歴がありません。",
+  CANCEL_FIRST:
+    "手続き中は復元処理を行えません。加入手続き取下げ処理を行ってください。",
+});
+
+/*****************************************************************************
+ * @class Insurance
+ *
+ * @property {string} status - 保険の状態を表す文字列。`INSURANCE_STATUS` のいずれかの値を取ります。
+ * @property {string} previousStatus - 直前の保険の状態を表す文字列。`INSURANCE_STATUS` のいずれかの値を取ります。
+ * @property {Date|null} enrollmentDateAt - 加入日を表す日付オブジェクト。加入していない場合は null になります。
+ * @property {string|null} number - 被保険者番号（整理記号）を表す文字列。加入していない場合は null になります。
+ * @property {Date|null} lossDateAt - 喪失日を表す日付オブジェクト。加入していない場合は null になります。
+ * @property {string|null} lossReason - 喪失理由を表す文字列。加入していない場合は null になります。
+ * @property {boolean} isProcessing - 加入手続き中であるかどうかを表す真偽値。加入手続き中の場合は true、そうでない場合は false になります。
+ * @property {boolean} isRetire - 退職による喪失であるかどうかを表す真偽値。退職による喪失の場合は true、そうでない場合は false になります。
+ * @property {Array} history - 状態遷移の履歴を記録するための配列。各要素は状態遷移前の状態を表すオブジェクトです。
+ *
+ * @property {string} enrollmentDate - `enrollmentDateAt` に基づく YYYY-MM-DD 形式の日付文字列 (読み取り専用)
+ *
+ * @note
+ * - 各プロパティは `現在の状態` を表すもので、状態の遷移には対応するメソッドを利用します。
+ *   - `lossDateAt`（喪失日）、`lossReason`（喪失理由）、`isRetire`（退職フラグ）は、`現在の状態` という意味では不要なプロパティですが、
+ *     資格喪失処理の際に必要になる情報であるため、プロパティとして用意しています。
+ * - 状態を遷移させるために必要な情報をこのインスタンスに設定（入力）する場合、
+ *   必ず複製したインスタンスのプロパティを編集し、複製元インスタンスの
+ *   状態遷移用メソッドを呼び出す際に引数として渡す、という形で利用してください。
+ * - 各状態遷移メソッドでは、`lossDateAt`（喪失日）、`lossReason`（喪失理由）、`isRetire`（退職フラグ）は必ず初期化されます。
+ *
+ * @method exempt - 現在の状態を `EXEMPT (適用除外)` に更新します。
+ * @method enroll - 現在の状態を `ENROLLED (加入)` に更新します。
+ * @method enrolled - 加入手続き中の状態を加入完了の状態に更新します。
+ * @method cancelEnroll - 加入手続き中の状態を加入前の状態に更新します。
+ * @method loss - 現在加入中の保険の喪失処理を行います。
+ * @method rollback - 履歴から最新の状態を復元します。
+ *****************************************************************************/
+export default class Insurance extends BaseClass {
+  static className = "Insurance";
+  static classProps = {
+    status: defField("insuranceStatus", { required: true }),
+    previousStatus: defField("insuranceStatus", { default: "" }),
+    enrollmentDateAt: defField("enrollmentDateAt"),
+    number: defField("insuranceNumber"),
+    lossDateAt: defField("lossDateAt"),
+    lossReason: defField("lossReason"),
+    isProcessing: defField("check", { label: "加入手続き中", default: false }),
+    isRetire: defField("check", { label: "退職", default: false }),
+    history: defField("array"), // 状態遷移の履歴を記録するための配列
+  };
+
+  /**
+   * 状態遷移のルールを定義します。
+   * - `NOT_ENROLLED (未加入)` からは `ENROLLED (加入)` または `EXEMPT (適用除外)` に遷移可能です。
+   * - `ENROLLED (加入)` からは `NOT_ENROLLED (未加入)` または `EXEMPT (適用除外)` に遷移可能です。
+   * - `EXEMPT (適用除外)` からは `ENROLLED (加入)` に遷移可能です。
+   * - その他の遷移は不正とします。
+   */
+  static VALID_TRANSITIONS = {
+    // `NOT_ENROLLED` -> `ENROLLED` または `EXEMPT`
+    [INSURANCE_STATUS.NOT_ENROLLED.value]: [
+      INSURANCE_STATUS.ENROLLED.value,
+      INSURANCE_STATUS.EXEMPT.value,
+    ],
+
+    // `ENROLLED` -> `NOT_ENROLLED` または `EXEMPT`
+    [INSURANCE_STATUS.ENROLLED.value]: [
+      INSURANCE_STATUS.NOT_ENROLLED.value,
+      INSURANCE_STATUS.EXEMPT.value,
+    ],
+
+    // `EXEMPT` -> `ENROLLED`
+    [INSURANCE_STATUS.EXEMPT.value]: [INSURANCE_STATUS.ENROLLED.value],
+  };
+
+  afterInitialize(item = {}) {
+    super.afterInitialize(item);
+
+    Object.defineProperties(this, {
+      /**
+       * enrollmentDate - `enrollmentDateAt` に基づく YYYY-MM-DD 形式の日付文字列 (読み取り専用)
+       */
+      enrollmentDate: {
+        configurable: true,
+        enumerable: true,
+        get() {
+          return formatJstDate(this.enrollmentDateAt) || "";
+        },
+        set(v) {},
+      },
+    });
+  }
+
+  /**
+   * 状態チェック用ヘルパーメソッド
+   */
+  isNotEnrolled() {
+    return this.status === INSURANCE_STATUS.NOT_ENROLLED.value;
+  }
+
+  isEnrolled() {
+    return this.status === INSURANCE_STATUS.ENROLLED.value;
+  }
+
+  isExempt() {
+    return this.status === INSURANCE_STATUS.EXEMPT.value;
+  }
+
+  // 手続き状態チェック
+  isProcessingEnrollment() {
+    return this.isEnrolled() && this.isProcessing;
+  }
+
+  isEnrollmentComplete() {
+    return this.isEnrolled() && !this.isProcessing;
+  }
+
+  /**
+   * 状態遷移が可能かどうかを判定します。
+   * @param {string} newStatus 遷移先の状態
+   * @returns {boolean|string} 遷移可能な場合は true、遷移不可能な場合は許可されている状態のタイトル文字列（例: "'未加入' または '加入'"）
+   */
+  _canTransitionTo(newStatus) {
+    const isValid =
+      Insurance.VALID_TRANSITIONS[this.status]?.includes(newStatus) || false;
+
+    if (!isValid) {
+      // 遷移先の状態に遷移可能な元の状態のタイトルを返す
+      const allowedStatuses = Object.values(INSURANCE_STATUS).filter((s) =>
+        Insurance.VALID_TRANSITIONS[s.value]?.includes(newStatus),
+      );
+
+      const allowedTitles = allowedStatuses
+        .map((s) => `'${s.title}'`)
+        .join(" または ");
+
+      return allowedTitles || "不正な状態";
+    }
+
+    return true;
+  }
+
+  /**
+   * 履歴エントリを作成します。
+   * @param {Object} options
+   * @param {Date|null} options.lossDateAt 喪失日
+   * @param {String|null} options.lossReason 喪失理由
+   * @returns {Object} 履歴エントリ
+   */
+  _createHistoryEntry({ lossDateAt = null, lossReason = null } = {}) {
+    return {
+      status: this.status,
+      previousStatus: this.previousStatus,
+      enrollmentDateAt: this.enrollmentDateAt,
+      lossDateAt,
+      lossReason,
+      number: this.number,
+    };
+  }
+
+  /**
+   * 状態を `EXEMPT (適用除外)` に更新します。
+   * - `NOT_ENROLLED (未加入)` または `ENROLLED (加入)` の状態でなければ加入手続きは行えません。
+   * - 現在加入中の場合、加入の履歴を記録します。ただし、加入手続き中 (isProcessing が true) である場合は、加入の実態がなかったこととし、履歴に記録しません。
+   *   - 手続き中である場合、状態が `ENROLLED` から `EXEMPT` に更新される実務上の取り扱いは「加入申請の取り下げ（訂正）」に該当するものとし、加入の実態がなかったこととします。
+   * - 現在加入中の場合、`lossDateAt (喪失日)` と `lossReason (喪失理由)` の指定が必要です。
+   * - `EXEMPT` 状態への更新に伴い、加入日を null に更新します。
+   * - `EXEMPT` 状態への更新に伴い、加入手続き中である場合があるため `isProcessing` を false に更新します。
+   * - `EXEMPT` 状態への更新に伴い、被保険者番号（整理記号）を null に更新します。
+   * @param {Object} options
+   * @param {Date|null} options.lossDateAt 喪失日（現在加入中の場合に必要）
+   * @param {String|null} options.lossReason 喪失理由（現在加入中の場合に必要）
+   * @returns {void}
+   * @throws {Error} `status` が `NOT_ENROLLED (未加入)` または `ENROLLED (加入)` でない場合にエラーをスローします。
+   * @throws {Error} 現在加入中の場合に `lossDateAt` が日付オブジェクトでない場合にエラーをスローします。
+   * @throws {Error} 現在加入中の場合に `lossReason` が指定されていない場合にエラーをスローします。
+   */
+  exempt({ lossDateAt, lossReason } = {}) {
+    // validation
+    const transitionCheck = this._canTransitionTo(
+      INSURANCE_STATUS.EXEMPT.value,
+    );
+    if (transitionCheck !== true) {
+      throw new Error(
+        `不正な処理です。${transitionCheck} の状態でなければ適用除外処理は行えません。`,
+      );
+    }
+
+    // 履歴に記録するための状態を作成
+    const currentStatus = this._createHistoryEntry({ lossDateAt, lossReason });
+
+    // 加入完了している場合の検証（手続き中の場合は不要）
+    if (this.isEnrollmentComplete()) {
+      // validation
+      if (!lossDateAt || !(lossDateAt instanceof Date)) {
+        throw new Error(ERROR_MESSAGES.REQUIRED_DATE("喪失日"));
+      }
+      if (!lossReason) {
+        throw new Error(ERROR_MESSAGES.REQUIRED_FIELD("喪失理由"));
+      }
+    }
+
+    // 現在加入中の場合、履歴に反映（ただし、手続き中である場合を除く）
+    // 手続き中である場合、状態が `ENROLLED` から `EXEMPT` に更新される実務上の取り扱いは
+    // 「加入申請の取り下げ（訂正）」に該当するものとし、加入の実態がなかったこととする。
+    if (this.isEnrollmentComplete()) {
+      this.history.push(currentStatus);
+    }
+
+    this.previousStatus = this.status;
+    this.status = INSURANCE_STATUS.EXEMPT.value;
+    this.enrollmentDateAt = null;
+    this.isProcessing = false; // 加入手続き中である場合があるため false に更新しておく
+    this.number = null;
+    this.lossDateAt = null; // 念のため null に更新しておく
+    this.lossReason = null; // 念のため null に更新しておく
+    this.isRetire = false; // 念のため false に更新しておく
+  }
+
+  /**
+   * 状態を `ENROLLED (加入)` に更新します。
+   * - `NOT_ENROLLED (未加入)` または `EXEMPT (適用除外)` の状態でなければ加入手続きは行えません。
+   * - `isProcessing` が true の場合、被保険者番号（整理記号）の指定が必要です。
+   * @param {Object} options
+   * @param {Date} options.enrollmentDateAt 資格取得日
+   * @param {String} options.number 被保険者番号（整理記号）
+   * @param {Boolean} options.isProcessing 加入手続き中フラグ（true の場合、加入手続き中の状態で更新します）
+   * @returns {void}
+   * @throws {Error} `status` が `NOT_ENROLLED (未加入)` または `EXEMPT (適用除外)` でない場合にエラーをスローします。
+   * @throws {Error} `enrollmentDateAt` が日付オブジェクトでない場合にエラーをスローします。
+   * @throws {Error} `isProcessing` が true で `number` が指定されていない場合にエラーをスローします。
+   */
+  enroll({ enrollmentDateAt, number, isProcessing = false } = {}) {
+    // validation
+    const transitionCheck = this._canTransitionTo(
+      INSURANCE_STATUS.ENROLLED.value,
+    );
+    if (transitionCheck !== true) {
+      throw new Error(
+        `不正な処理です。${transitionCheck} の状態でなければ加入手続きは行えません。`,
+      );
+    }
+
+    if (!enrollmentDateAt || !(enrollmentDateAt instanceof Date)) {
+      throw new Error(ERROR_MESSAGES.REQUIRED_DATE("資格取得日"));
+    }
+
+    if (!isProcessing && !number) {
+      throw new Error(
+        ERROR_MESSAGES.REQUIRED_FIELD("被保険者番号（整理記号）"),
+      );
+    }
+
+    // 状態を更新
+    this.previousStatus = this.status;
+    this.status = INSURANCE_STATUS.ENROLLED.value;
+    this.enrollmentDateAt = enrollmentDateAt;
+    this.number = isProcessing ? null : number;
+    this.isProcessing = !!isProcessing;
+    this.lossDateAt = null; // 念のため null に更新しておく
+    this.lossReason = null; // 念のため null に更新しておく
+    this.isRetire = false; // 念のため false に更新しておく
+  }
+
+  /**
+   * 加入手続き中の状態を加入完了の状態に更新します。
+   * - 被保険者番号（整理記号）が決定したタイミングで行われる処理です。
+   * - `ENROLLED (加入)` かつ `isProcessing = true` の状態でなければ加入手続き完了処理は行えません。
+   * - 被保険者番号（整理記号）の指定が必要です。
+   * @param {Object} options
+   * @param {String} options.number 被保険者番号（整理記号）
+   * @returns {void}
+   * @throws {Error} `status` が `ENROLLED (加入)` で `isProcessing` が true でない場合にエラーをスローします。
+   * @throws {Error} 被保険者番号（整理記号）が指定されていない場合にエラーをスローします。
+   */
+  enrolled({ number } = {}) {
+    // validation
+    if (!this.isProcessingEnrollment()) {
+      throw new Error(ERROR_MESSAGES.PROCESSING_ONLY("加入手続き完了処理"));
+    }
+
+    if (!number) {
+      throw new Error(
+        ERROR_MESSAGES.REQUIRED_FIELD("被保険者番号（整理記号）"),
+      );
+    }
+
+    // 状態を更新
+    this.number = number;
+    this.isProcessing = false;
+    this.lossDateAt = null; // 念のため null に更新しておく
+    this.lossReason = null; // 念のため null に更新しておく
+    this.isRetire = false; // 念のため false に更新しておく
+  }
+
+  /**
+   * 加入手続き中の状態を加入前の状態に更新します。
+   * - `ENROLLED (加入)` かつ `isProcessing = true` の状態でなければ加入手続き取下げ処理は行えません。
+   * - 加入手続き取下げ処理は、加入の実態がなかったこととするため、履歴には記録しません。
+   * @returns {void}
+   * @throws {Error} `status` が `ENROLLED (加入)` で `isProcessing` が true でない場合にエラーをスローします。
+   */
+  cancelEnroll() {
+    // validation
+    if (!this.isProcessingEnrollment()) {
+      throw new Error(ERROR_MESSAGES.PROCESSING_ONLY("加入手続き取下げ処理"));
+    }
+
+    // 状態を更新
+    this.status = this.previousStatus;
+    this.previousStatus = null;
+    this.enrollmentDateAt = null;
+    this.number = null;
+    this.isProcessing = false;
+    this.lossDateAt = null; // 念のため null に更新しておく
+    this.lossReason = null; // 念のため null に更新しておく
+    this.isRetire = false; // 念のため false に更新しておく
+  }
+
+  /**
+   * 加入している保険の喪失処理を行います。
+   * - `ENROLLED (加入)` の状態でなければ喪失処理は行えません。
+   * - `lossDateAt`（喪失日）、`lossReason`（喪失理由）の指定が必要です。
+   * - `isRetire` が true の場合、状態を `EXEMPT (適用除外)` ではなく `NOT_ENROLLED (未加入)` に更新します。
+   * - `isRetire` が false の場合、状態を `EXEMPT (適用除外)` に更新します。
+   * - `history` プロパティに、更新前の状態を記録します。
+   * @param {*} options
+   * @param {*} options.lossDateAt 喪失日
+   * @param {*} options.lossReason 喪失理由
+   * @param {*} options.isRetire 退職フラグ（true の場合、状態を `EXEMPT (適用除外)` ではなく `NOT_ENROLLED (未加入)` に更新します）
+   * @returns {void}
+   * @throws {Error} `status` が `ENROLLED (加入)` でない場合にエラーをスローします。
+   * @throws {Error} 喪失日が日付オブジェクトでない場合にエラーをスローします。
+   * @throws {Error} 喪失理由が指定されていない場合にエラーをスローします。
+   */
+  loss({ lossDateAt, lossReason, isRetire = false } = {}) {
+    // validation
+    if (!this.isEnrolled()) {
+      throw new Error(ERROR_MESSAGES.ENROLLED_ONLY("喪失手続き"));
+    }
+    if (!lossDateAt || !(lossDateAt instanceof Date)) {
+      throw new Error(ERROR_MESSAGES.REQUIRED_DATE("喪失日"));
+    }
+    if (!lossReason) {
+      throw new Error(ERROR_MESSAGES.REQUIRED_FIELD("喪失理由"));
+    }
+
+    // 履歴に記録するための状態を作成
+    const currentStatus = this._createHistoryEntry({ lossDateAt, lossReason });
+
+    this.history.push(currentStatus);
+
+    this.previousStatus = this.status;
+    this.status = isRetire
+      ? INSURANCE_STATUS.NOT_ENROLLED.value
+      : INSURANCE_STATUS.EXEMPT.value;
+    this.enrollmentDateAt = null;
+    this.number = null;
+    this.lossDateAt = null; // 念のため null に更新しておく
+    this.lossReason = null; // 念のため null に更新しておく
+    this.isRetire = false; // 念のため false に更新しておく
+  }
+
+  /**
+   * 履歴から最新の状態を復元します。
+   * - `history` プロパティに復元できる状態が存在しない場合、エラーをスローします。
+   * - 復元処理は、加入手続き中である場合は行えません。加入手続き中である場合は、加入手続き取下げ処理を行ってください。
+   * - 復元処理は、`history` プロパティから最新の状態を取得し、`status`、`previousStatus`、`enrollmentDateAt`、`number` プロパティを復元します。
+   * - 復元処理は、`isProcessing` プロパティを false に更新します。
+   * @returns {void}
+   * @throws {Error} `history` プロパティに復元できる状態が存在しない場合にエラーをスローします。
+   * @throws {Error} 加入手続き中である場合にエラーをスローします。
+   */
+  rollback() {
+    // validation
+    if (this.history.length === 0) {
+      throw new Error(ERROR_MESSAGES.NO_HISTORY);
+    }
+    if (this.isProcessing) {
+      throw new Error(ERROR_MESSAGES.CANCEL_FIRST);
+    }
+    const latestStatus = this.history.pop();
+    this.status = latestStatus.status;
+    this.previousStatus = latestStatus.previousStatus;
+    this.enrollmentDateAt = latestStatus.enrollmentDateAt;
+    this.number = latestStatus.number;
+    this.isProcessing = false; // 念のため false に戻しておく
+    this.lossDateAt = null; // 念のため null に戻しておく
+    this.lossReason = null; // 念のため null に戻しておく
+    this.isRetire = false; // 念のため false に戻しておく
+  }
+}

package/src/Notification.js

@@ -0,0 +1,95 @@
+/*****************************************************************************
+ * @file src/Notification.js
+ *****************************************************************************/
+import FireModel from "@shisyamo4131/air-firebase-v2";
+import { defField } from "./parts/fieldDefinitions.js";
+
+/*****************************************************************************
+ * @class Notification
+ * @extends FireModel
+ *
+ * @description
+ * 通知ドキュメントのスキーマ定義。
+ * Companies/{companyId}/Notifications/{notificationId} に格納される。
+ * 通知の送信履歴と結果を管理するための親ドキュメント。
+ *
+ * @property {string} title - 通知タイトル
+ * @property {string} body - 通知本文
+ * @property {string} imageUrl - 画像URL（任意）
+ * @property {Object} data - カスタムデータ（任意）
+ * @property {Array<string>} recipientUserIds - 送信先ユーザーIDの配列
+ * @property {number} totalCount - 送信対象数
+ * @property {number} successCount - 送信成功数
+ * @property {number} failureCount - 送信失敗数
+ * @property {string} status - 送信ステータス（pending, processing, sent, failed, completed）
+ * @property {string} sourceType - 送信元タイプ（manual, arrangement, billing など）
+ * @property {string} sourceId - 送信元ドキュメントID
+ * @property {string} createdBy - 作成者UID
+ *
+ * @note
+ * - status の値:
+ *   - pending: 送信待ち
+ *   - processing: 送信中
+ *   - sent: 送信成功
+ *   - failed: 送信失敗
+ *   - completed: 全送信完了
+ * - sourceType の例:
+ *   - manual: 手動送信（UI から）
+ *   - arrangement: 配置通知
+ *   - billing: 請求通知
+ *
+ * @author shisyamo4131
+ *****************************************************************************/
+export default class Notification extends FireModel {
+  static className = "通知";
+  static collectionPath = "Notifications";
+  static classProps = {
+    title: defField("oneLine", { label: "通知タイトル", required: true }),
+    body: defField("multipleLine", { label: "通知本文", required: true }),
+    imageUrl: defField("oneLine", { label: "画像URL", required: false }),
+    data: defField("object", { label: "カスタムデータ", required: false }),
+    recipientUserIds: defField("recipientUserIds", { required: false }),
+    totalCount: defField("number", {
+      label: "送信対象数",
+      default: 0,
+      required: false,
+      hidden: true,
+    }),
+    successCount: defField("number", {
+      label: "送信成功数",
+      default: 0,
+      required: false,
+      hidden: true,
+    }),
+    failureCount: defField("number", {
+      label: "送信失敗数",
+      default: 0,
+      required: false,
+      hidden: true,
+    }),
+    status: defField("oneLine", {
+      label: "送信ステータス",
+      default: "pending",
+      required: false,
+      hidden: true,
+    }),
+    sourceType: defField("oneLine", {
+      label: "送信元タイプ",
+      default: "",
+      required: false,
+      hidden: true,
+    }),
+    sourceId: defField("oneLine", {
+      label: "送信元ID",
+      default: "",
+      required: false,
+      hidden: true,
+    }),
+    createdBy: defField("oneLine", {
+      label: "作成者",
+      default: "",
+      required: false,
+      hidden: true,
+    }),
+  };
+}

package/src/NotificationRecipient.js

@@ -0,0 +1,68 @@
+/*****************************************************************************
+ * @file src/NotificationRecipient.js
+ *****************************************************************************/
+import { BaseClass } from "@shisyamo4131/air-firebase-v2";
+import { defField } from "./parts/fieldDefinitions.js";
+
+/*****************************************************************************
+ * @class NotificationRecipient
+ * @extends BaseClass
+ *
+ * @description
+ * 通知の受信者情報を管理するサブコレクションのスキーマ定義。
+ * Companies/{companyId}/Notifications/{notificationId}/Recipients/{recipientId} に格納される。
+ * 個別ユーザーごとの送信結果を記録する。
+ *
+ * @property {string} notificationId - 親 Notification ドキュメントのID
+ * @property {string} userId - 受信者のユーザーID
+ * @property {string} status - 送信ステータス（pending, sent, failed）
+ * @property {Date} sentAt - 送信日時
+ * @property {string} error - エラーメッセージ
+ *
+ * @note
+ * - NotificationRecipient は BaseClass を継承（FireModel ではない）
+ * - Notification ドキュメントのサブコレクションとして格納される
+ * - Cloud Functions のみが作成・更新、アプリ側は読み取り専用
+ * - status の値:
+ *   - pending: 送信待ち
+ *   - sent: 送信成功
+ *   - failed: 送信失敗
+ * - sentAt: 送信が完了した日時（成功・失敗問わず）
+ * - error: 送信失敗時のエラーメッセージ
+ *
+ * @author shisyamo4131
+ *****************************************************************************/
+export default class NotificationRecipient extends BaseClass {
+  static className = "通知受信者";
+  static classProps = {
+    notificationId: defField("oneLine", {
+      label: "通知ID",
+      default: "",
+      required: true,
+      hidden: true,
+    }),
+    userId: defField("oneLine", {
+      label: "ユーザーID",
+      default: "",
+      required: true,
+      hidden: true,
+    }),
+    status: defField("oneLine", {
+      label: "送信ステータス",
+      default: "pending",
+      required: false,
+      hidden: true,
+    }),
+    sentAt: defField("dateTimeAt", {
+      label: "送信日時",
+      required: false,
+      hidden: true,
+    }),
+    error: defField("oneLine", {
+      label: "エラーメッセージ",
+      default: "",
+      required: false,
+      hidden: true,
+    }),
+  };
+}