@shisyamo4131/air-guard-v2-schemas 2.4.2-dev.74 → 2.4.2-dev.76

package/index.js

@@ -14,8 +14,11 @@ export { default as Customer, CustomerMinimal } from "./src/Customer.js";
 export { default as CutoffDate } from "./src/utils/CutoffDate.js";
 export { default as Employee } from "./src/Employee.js";
 export { VALIDATION_ERRORS } from "./src/errorDefinitions.js";
+export { default as FcmToken } from "./src/FcmToken.js";
 export { GeocodableMixin } from "./src/mixins/GeocodableMixin.js";
 export { default as Insurance } from "./src/Insurance.js";
+export { default as Notification } from "./src/Notification.js";
+export { default as NotificationRecipient } from "./src/NotificationRecipient.js";
 export { default as OperationBilling } from "./src/OperationBilling.js";
 export { default as OperationResult } from "./src/OperationResult.js";
 export { default as OperationResultDetail } from "./src/OperationResultDetail.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shisyamo4131/air-guard-v2-schemas",
-  "version": "2.4.2-dev.74",
+  "version": "2.4.2-dev.76",
   "description": "Schemas for AirGuard V2",
   "type": "module",
   "main": "index.js",

package/src/ArrangementNotification.js

@@ -16,6 +16,8 @@
  * @prop {string} actualEndTime - Actual end time (HH:MM format)
  * @prop {number} actualBreakMinutes - Actual break time (minutes)
  * @prop {string} status - Arrangement notification status
+ * @prop {Date} notificationSentAt - Push notification sent date and time
+ * @prop {string} notificationError - Push notification send error message
  * ---------------------------------------------------------------------------
  * @computed {Date} actualStartAt - Actual start date and time (Date object) (read-only)
  * - Returns a Date object with `actualStartTime` set based on `dateAt`.
@@ -159,6 +161,12 @@ const classProps = {
     default: 60,
     required: true,
   }),
+  notificationSentAt: defField("notificationSentAt", {
+    hidden: true,
+  }),
+  notificationError: defField("notificationError", {
+    hidden: true,
+  }),
 };
 
 export default class ArrangementNotification extends SiteOperationScheduleDetail {

package/src/FcmToken.js

@@ -0,0 +1,77 @@
+/*****************************************************************************
+ * @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,
+    }),
+    employeeId: defField("employeeId", {
+      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/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,
+    }),
+  };
+}

package/src/parts/fieldDefinitions/array.js

@@ -36,4 +36,15 @@ export const arrayFields = {
     required: false,
     hidden: false,
   },
+
+  /**
+   * 通知の送信先ユーザーID配列
+   * Notification ドキュメントで使用
+   */
+  recipientUserIds: {
+    ...generalDefinitions.array,
+    label: "送信先ユーザーID",
+    required: false,
+    hidden: true,
+  },
 };

package/src/parts/fieldDefinitions/dateAt.js

@@ -51,6 +51,11 @@ export const dateAtFields = {
     label: "資格喪失日",
     default: null,
   },
+  notificationSentAt: {
+    ...generalDefinitions.dateAt,
+    label: "通知送信日時",
+    default: null,
+  },
   periodOfStay: {
     ...generalDefinitions.dateAt,
     label: "在留期間満了日",

package/src/parts/fieldDefinitions/multipleLine.js

@@ -5,6 +5,10 @@ import { generalDefinitions } from "./defaultDefinition.js";
  */
 export const multipleLineFields = {
   multipleLine: generalDefinitions.multipleLine,
+  notificationError: {
+    ...generalDefinitions.multipleLine,
+    label: "通知送信エラー",
+  },
   remarks: {
     ...generalDefinitions.multipleLine,
     label: "備考",

package/src/parts/fieldDefinitions/oneLine.js

@@ -175,6 +175,12 @@ export const oneLineFields = {
     },
   },
 
+  /** 従業員ID */
+  employeeId: {
+    ...generalDefinitions.oneLine,
+    label: "従業員ID",
+  },
+
   /** FAX番号 */
   fax: {
     ...generalDefinitions.oneLine,
@@ -364,6 +370,18 @@ export const oneLineFields = {
     length: 20,
   },
 
+  /** token */
+  token: {
+    ...generalDefinitions.oneLine,
+    label: "トークン",
+  },
+
+  /** ユーザーID */
+  uid: {
+    ...generalDefinitions.oneLine,
+    label: "ユーザーID",
+  },
+
   /** 作業内容 */
   workDescription: {
     ...generalDefinitions.oneLine,