@shisyamo4131/air-guard-v2-schemas 2.4.2-dev.75 → 2.4.2-dev.77

package/index.js

@@ -14,6 +14,7 @@ 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";

package/package.json

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

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/parts/fieldDefinitions/oneLine.js

@@ -364,6 +364,18 @@ export const oneLineFields = {
     length: 20,
   },
 
+  /** token */
+  token: {
+    ...generalDefinitions.oneLine,
+    label: "トークン",
+  },
+
+  /** ユーザーID */
+  uid: {
+    ...generalDefinitions.oneLine,
+    label: "ユーザーID",
+  },
+
   /** 作業内容 */
   workDescription: {
     ...generalDefinitions.oneLine,