@shisyamo4131/air-guard-v2-schemas 2.4.2-dev.71 → 2.4.2-dev.73

package/package.json

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

package/src/FcmTokens.js

@@ -0,0 +1,39 @@
+/*****************************************************************************
+ * @file ./src/FcmTokens.js
+ * @description FCM トークンを管理するための配列クラス
+ * - 配列クラスに add と remove メソッドを追加して、トークンの管理を容易にしています。
+ *****************************************************************************/
+
+/*****************************************************************************
+ * @class FcmTokens
+ *
+ * @method add - FCM トークンを新たに追加します。但し重複は無視されます。
+ * @method remove - FCM トークンを削除します。
+ *****************************************************************************/
+export class FcmTokens extends Array {
+  /**
+   * トークンを追加
+   */
+  add(token) {
+    if (!token || typeof token !== "string") {
+      throw new Error("Invalid FCM token");
+    }
+    if (this.includes(token)) {
+      return false; // 既に存在
+    }
+    this.push(token);
+    return true;
+  }
+
+  /**
+   * トークンを削除
+   */
+  remove(token) {
+    const index = this.indexOf(token);
+    if (index === -1) {
+      return false; // 存在しない
+    }
+    this.splice(index, 1);
+    return true;
+  }
+}

package/src/Insurance.js

@@ -5,6 +5,7 @@
 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) =>

package/src/User.js

@@ -1,61 +1,52 @@
-/**
- * User Model
- * @version 1.1.0
- * @author shisyamo4131
- * @update 2025-12-25 Added `tagSize` property.
- *                    Added `updateProperties` method for updating multiple properties.
- * @update 2025-11-24 Added `companyId`, `isAdmin`, `isTemporary` property.
- *                    Changed to prevent deletion of admin users.
- *
- * @prop {string} email - User's email address.
- * @prop {string} displayName - User's display name.
- * @prop {string} [employeeId] - Employee ID (not required as some users may not be employees).
- * @prop {Array<string>} roles - User roles/permissions.
- * @prop {boolean} disabled - Indicates if the user is disabled.
- * @prop {string} companyId - ID of the associated company.
- * @prop {boolean} isAdmin - Indicates if the user is an administrator.
- * @prop {boolean} isTemporary - Indicates if the user is temporary.
- * @prop {string} tagSize - Size of the tag associated with the user.
- */
+/*****************************************************************************
+ * @file src/User.js
+ *****************************************************************************/
 import FireModel from "@shisyamo4131/air-firebase-v2";
 import { defField } from "./parts/fieldDefinitions.js";
 import { TAG_SIZE_VALUES, TAG_SIZE_OPTIONS } from "./constants/index.js";
+import { FcmTokens } from "./FcmTokens.js";
 
-const classProps = {
-  email: defField("email", { required: true }),
-  displayName: defField("displayName", { required: true }),
-  employeeId: defField("oneLine", { label: "従業員ID", hidden: true }),
-  roles: {
-    type: Array,
-    default: () => [],
-    label: "権限",
-    required: false,
-    hidden: false,
-  },
-  disabled: defField("check", {
-    label: "使用不可",
-    default: false,
-    required: false,
-    hidden: true,
-  }),
-  companyId: defField("oneLine", { hidden: true, required: true }),
-  isAdmin: defField("check", { hidden: true, default: false }),
-  isTemporary: defField("check", { hidden: true, default: true }),
-  tagSize: defField("select", {
-    label: "タグサイズ",
-    default: TAG_SIZE_VALUES.MEDIUM.value,
-    component: {
-      attrs: {
-        items: TAG_SIZE_OPTIONS,
-      },
-    },
-  }),
-};
-
+/*****************************************************************************
+ * @class User
+ * @extends FireModel
+ *
+ * @property {string} email - メールアドレス
+ * @property {string} displayName - 表示名
+ * @property {string} [employeeId] - 従業員ID（非従業員を許容するために必須とはしない）
+ * @property {Array<string>} roles - アプリケーション利用権限
+ * @property {boolean} disabled - 有効/無効
+ * @property {string} companyId - 会社ID
+ * @property {boolean} isAdmin - 管理者であるかどうか
+ * @property {boolean} isTemporary - 仮登録状態であるかどうか
+ * @property {string} tagSize - 配置管理機能におけるタグコンポーネントの表示サイズ
+ * @property {Array<string>} fcmTokens - Firebase Cloud Messaging (FCM) のトークンの配列
+ *****************************************************************************/
 export default class User extends FireModel {
   static className = "ユーザー";
   static collectionPath = "Users";
-  static classProps = classProps;
+  static classProps = {
+    email: defField("email", { required: true }),
+    displayName: defField("displayName", { required: true }),
+    employeeId: defField("oneLine", { label: "従業員ID", hidden: true }),
+    roles: defField("roles"),
+    disabled: defField("disabled", { hidden: true }),
+    companyId: defField("companyId", { hidden: true, required: true }),
+    isAdmin: defField("isAdmin", { hidden: true }),
+    isTemporary: defField("isTemporary", { hidden: true, default: true }),
+    tagSize: defField("tagSize", { required: true }),
+    fcmTokens: defField("fcmTokens"),
+  };
+
+  /**
+   * `afterInitialize` をオーバーライド
+   * - `fcmTokens` を `FcmTokens` クラスのインスタンスとして扱う
+   * @param {*} item
+   */
+  afterInitialize(item = {}) {
+    super.afterInitialize(item);
+    // fcmTokens を FcmTokens クラスのインスタンスとして扱う
+    this.fcmTokens = new FcmTokens(...this.fcmTokens);
+  }
 
   /**
    * Deletes the user document.
@@ -86,6 +77,9 @@ export default class User extends FireModel {
    * @returns {Promise<DocumentReference>} Reference to the updated document.
    * @throws {Error} If `updateData` is not a valid object.
    * @throws {Error} If `docId` is not set, or if `updateOptions.callback` is not a function.
+   *
+   * Note: このメソッドは複数のプロパティを一括更新するためのヘルパーメソッド。BaseClass に移設しても良いかもしれない。
+   * なお、`useAuthStore` で使用中のようだ。
    */
   async updateProperties(updateData = null, updateOptions = {}) {
     if (!updateData || typeof updateData !== "object") {

package/src/parts/fieldDefinitions/array.js

@@ -2,7 +2,38 @@ import { generalDefinitions } from "./defaultDefinition.js";
 
 /**
  * ARRAY型のフィールド定義
+ * {
+ *   type: Array,
+ *   default: () => [],
+ *   label: undefined,
+ *   length: undefined,
+ *   required: undefined,
+ *   hidden: undefined,
+ *   validator: undefined,
+ *   component: { name: "air-select", attrs: { multiple: true } },
+ * }
  */
 export const arrayFields = {
   array: generalDefinitions.array,
+
+  /**
+   * FCM トークン
+   * Firebase Cloud Messaging (FCM) のトークンを格納するフィールド定義
+   */
+  fcmTokens: {
+    ...generalDefinitions.array,
+    label: "FCMトークン",
+    required: false,
+    hidden: true,
+  },
+
+  /**
+   * アプリケーション利用権限用配列フィールド定義
+   */
+  roles: {
+    ...generalDefinitions.array,
+    label: "権限",
+    required: false,
+    hidden: false,
+  },
 };

package/src/parts/fieldDefinitions/check.js

@@ -2,9 +2,29 @@ import { generalDefinitions } from "./defaultDefinition.js";
 
 /**
  * CHECK型のフィールド定義
+ * {
+ *   type: Boolean,
+ *   default: false,
+ *   label: undefined,
+ *   length: undefined,
+ *   required: undefined,
+ *   hidden: undefined,
+ *   validator: undefined,
+ *   component: { name: "air-checkbox", attrs: {} },
+ * }
  */
 export const checkFields = {
   check: generalDefinitions.check,
+
+  /**
+   * 使用不可を表すフィールド定義
+   * - `label` や他の定義は利用先において定義変更すること。
+   */
+  disabled: {
+    ...generalDefinitions.check,
+    label: "使用不可",
+  },
+
   hasPeriodOfStayLimit: {
     ...generalDefinitions.check,
     label: "在留期間制限",
@@ -13,8 +33,21 @@ export const checkFields = {
     ...generalDefinitions.check,
     label: "就労制限",
   },
+
+  /** 管理者かどうか */
+  isAdmin: {
+    ...generalDefinitions.check,
+    label: "管理者",
+  },
+
   isForeigner: {
     ...generalDefinitions.check,
     label: "外国籍",
   },
+
+  /** 仮登録 */
+  isTemporary: {
+    ...generalDefinitions.check,
+    label: "仮登録",
+  },
 };

package/src/parts/fieldDefinitions/oneLine.js

@@ -2,39 +2,69 @@ import { generalDefinitions } from "./defaultDefinition.js";
 
 /**
  * ONE LINE型のフィールド定義
+ * {
+ *   type: String,
+ *   default: null,
+ *   label: undefined,
+ *   length: undefined,
+ *   required: undefined,
+ *   hidden: undefined,
+ *   validator: undefined,
+ *   component: { name: "air-text-field", attrs: {} },
+ * }
  */
 export const oneLineFields = {
   oneLine: generalDefinitions.oneLine,
+
+  /** 略称 */
   abbreviation: {
     ...generalDefinitions.oneLine,
     label: "略称",
     length: 20,
   },
+
+  /** 町域名・番地 */
   address: {
     ...generalDefinitions.oneLine,
     label: "町域名・番地",
     length: 30,
   },
+
+  /** 支店名など */
   branchName: {
     ...generalDefinitions.oneLine,
     label: "支店名など",
     length: 20,
   },
+
+  /** 建物名・階数 */
   building: {
     ...generalDefinitions.oneLine,
     label: "建物名・階数",
     length: 30,
   },
+
+  /** 市区町村 */
   city: {
     ...generalDefinitions.oneLine,
     label: "市区町村",
     length: 20,
   },
+
+  /** 会社ID */
+  companyId: {
+    ...generalDefinitions.oneLine,
+    label: "会社ID",
+  },
+
+  /** 会社名 */
   companyName: {
     ...generalDefinitions.oneLine,
     label: "会社名",
     length: 20,
   },
+
+  /** 会社名（カナ） */
   companyNameKana: {
     ...generalDefinitions.oneLine,
     label: "会社名（カナ）",
@@ -46,6 +76,12 @@ export const oneLineFields = {
       },
     },
   },
+
+  /**
+   * 取引先
+   * - アプリ側で `useFetchXxxx` コンポーザブルを使用するため
+   *   使用するクラス側で api 関連の設定は不要。
+   */
   customerId: {
     ...generalDefinitions.oneLine,
     label: "取引先",
@@ -60,6 +96,7 @@ export const oneLineFields = {
       },
     },
   },
+
   /**
    * 取引先名
    * - 2文字以上最大20文字
@@ -73,16 +110,22 @@ export const oneLineFields = {
       attrs: { minLength: 2 },
     },
   },
+
+  /** 表示名 */
   displayName: {
     ...generalDefinitions.oneLine,
     label: "表示名",
     length: 6,
   },
+
+  /** 本籍地 */
   domicile: {
     ...generalDefinitions.oneLine,
     label: "本籍地",
     length: 50,
   },
+
+  /** email */
   email: {
     ...generalDefinitions.oneLine,
     label: "email",
@@ -95,21 +138,29 @@ export const oneLineFields = {
       },
     },
   },
+
+  /** 緊急連絡先住所 */
   emergencyContactAddress: {
     ...generalDefinitions.oneLine,
     label: "緊急連絡先住所",
     length: 50,
   },
+
+  /** 緊急連絡先氏名 */
   emergencyContactName: {
     ...generalDefinitions.oneLine,
     label: "緊急連絡先氏名",
     length: 20,
   },
+
+  /** 緊急連絡先続柄詳細 */
   emergencyContactRelationDetail: {
     ...generalDefinitions.oneLine,
     label: "緊急連絡先続柄詳細",
     length: 20,
   },
+
+  /** 緊急連絡先電話番号 */
   emergencyContactPhone: {
     ...generalDefinitions.oneLine,
     label: "緊急連絡先電話番号",
@@ -123,6 +174,8 @@ export const oneLineFields = {
       },
     },
   },
+
+  /** FAX番号 */
   fax: {
     ...generalDefinitions.oneLine,
     label: "FAX番号",
@@ -136,11 +189,15 @@ export const oneLineFields = {
       },
     },
   },
+
+  /** 名 */
   firstName: {
     ...generalDefinitions.oneLine,
     label: "名",
     length: 20,
   },
+
+  /** メイ */
   firstNameKana: {
     ...generalDefinitions.oneLine,
     label: "メイ",
@@ -152,6 +209,8 @@ export const oneLineFields = {
       },
     },
   },
+
+  /** 本名 */
   foreignName: {
     ...generalDefinitions.oneLine,
     label: "本名",
@@ -164,22 +223,29 @@ export const oneLineFields = {
       },
     },
   },
+
+  /** 被保険者番号（整理記号） */
   insuranceNumber: {
     ...generalDefinitions.oneLine,
     label: "被保険者番号（整理記号）",
     length: 20,
   },
-  // 2025-12-26 Added
+
+  /** 発行元 */
   issuedBy: {
     ...generalDefinitions.oneLine,
     label: "発行元",
     length: 20,
   },
+
+  /** 姓 */
   lastName: {
     ...generalDefinitions.oneLine,
     label: "姓",
     length: 20,
   },
+
+  /** セイ */
   lastNameKana: {
     ...generalDefinitions.oneLine,
     label: "セイ",
@@ -191,11 +257,15 @@ export const oneLineFields = {
       },
     },
   },
+
+  /** 喪失理由 */
   lossReason: {
     ...generalDefinitions.oneLine,
     label: "喪失理由",
     length: 40,
   },
+
+  /** 携帯電話 */
   mobile: {
     ...generalDefinitions.oneLine,
     label: "携帯電話",
@@ -209,11 +279,15 @@ export const oneLineFields = {
       },
     },
   },
+
+  /** 名前 */
   name: {
     ...generalDefinitions.oneLine,
     label: "名前",
     length: 20,
   },
+
+  /** 名前（カナ） */
   nameKana: {
     ...generalDefinitions.oneLine,
     label: "名前（カナ）",
@@ -225,27 +299,36 @@ export const oneLineFields = {
       },
     },
   },
+
+  /** 国籍 */
   nationality: {
     ...generalDefinitions.oneLine,
     label: "国籍",
     length: 50,
   },
+
+  /** 在留資格 */
   residenceStatus: {
     ...generalDefinitions.oneLine,
     label: "在留資格",
     length: 10,
   },
+
+  /** 退職理由 */
   reasonOfTermination: {
     ...generalDefinitions.oneLine,
     label: "退職理由",
     length: 20,
   },
-  // 2025-12-26 Added
+
+  /** 証明書番号 */
   serialNumber: {
     ...generalDefinitions.oneLine,
     label: "証明書番号",
     length: 20,
   },
+
+  /** 現場ID */
   siteId: {
     ...generalDefinitions.oneLine,
     label: "現場",
@@ -258,6 +341,8 @@ export const oneLineFields = {
       },
     },
   },
+
+  /** 電話番号 */
   tel: {
     ...generalDefinitions.oneLine,
     label: "電話番号",
@@ -271,16 +356,22 @@ export const oneLineFields = {
       },
     },
   },
+
+  /** 肩書 */
   title: {
     ...generalDefinitions.oneLine,
     label: "肩書",
     length: 20,
   },
+
+  /** 作業内容 */
   workDescription: {
     ...generalDefinitions.oneLine,
     label: "作業内容",
     length: 20,
   },
+
+  /** 郵便番号 */
   zipcode: {
     ...generalDefinitions.oneLine,
     default: null,

package/src/parts/fieldDefinitions/select.js

@@ -52,10 +52,24 @@ import {
   VALUES as SITE_STATUS_VALUES,
   OPTIONS as SITE_STATUS_OPTIONS,
 } from "../../constants/site-status.js";
+import {
+  VALUES as TAG_SIZE_VALUES,
+  OPTIONS as TAG_SIZE_OPTIONS,
+} from "../../constants/tag-size.js";
 import CutoffDate from "../../utils/CutoffDate.js";
 
 /**
  * SELECT型のフィールド定義
+ * {
+ *   type: String,
+ *   default: null,
+ *   label: undefined,
+ *   length: undefined,
+ *   required: undefined,
+ *   hidden: undefined,
+ *   validator: undefined,
+ *   component: { name: "air-select", attrs: {} },
+ * }
  */
 export const selectFields = {
   select: generalDefinitions.select,
@@ -237,4 +251,17 @@ export const selectFields = {
       },
     },
   },
+
+  /** タグサイズ */
+  tagSize: {
+    ...generalDefinitions.select,
+    label: "タグサイズ",
+    default: TAG_SIZE_VALUES.MEDIUM.value,
+    component: {
+      name: generalDefinitions.select.component.name,
+      attrs: {
+        items: TAG_SIZE_OPTIONS,
+      },
+    },
+  },
 };