@shisyamo4131/air-guard-v2-schemas 2.3.7-dev.1 → 2.3.7-dev.11

package/package.json

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

package/src/Company.js

@@ -1,7 +1,8 @@
 /**
  * Company Model
- * @version 1.2.0
+ * @version 1.3.0
  * @author shisyamo4131
+ * @update 2025-12-01 Add Stripe integration fields (stripeCustomerId, subscription).
  * @update 2025-11-27 Add bank information fields for billing.
  * @update 2025-11-23 Set `usePrefix` to false.
  */
@@ -92,6 +93,24 @@ const classProps = {
       },
     },
   }),
+
+  /** Stripe連携フィールド */
+  stripeCustomerId: defField("oneLine", {
+    label: "Stripe顧客ID",
+    hidden: true,
+    length: 100,
+  }),
+
+  subscription: defField("object", {
+    label: "サブスクリプション情報",
+    hidden: true,
+    default: () => ({
+      id: null,
+      status: null,
+      currentPeriodEnd: null,
+      employeeLimit: 10,
+    }),
+  }),
 };
 
 export default class Company extends FireModel {
@@ -109,6 +128,22 @@ export default class Company extends FireModel {
       prefecture: defAccessor("prefecture"),
     });
 
+    Object.defineProperties(this, {
+      hasBankInfo: {
+        enumerable: true,
+        configurable: true,
+        get() {
+          return !!(
+            this.bankName &&
+            this.branchName &&
+            this.accountNumber &&
+            this.accountHolder
+          );
+        },
+        set() {},
+      },
+    });
+
     /*************************************************************************
      * CUSTOM METHODS FOR siteOrder ARRAY
      * Note: These methods modify the siteOrder array directly.

package/src/Operation.js

@@ -2,9 +2,8 @@
  * Operation Model ver 1.0.0
  * @author shisyamo4131
  * ---------------------------------------------------------------------------
- * - Base class of SiteOperationSchedule based on WorkingResult.
- * - `dateAt` property indicates the date of operation (placement date)
- *   used for billing purposes.
+ * - Base class of SiteOperationSchedule and OperationResult based on WorkingResult.
+ * - `dateAt` property indicates the date of operation (placement date) used for billing purposes.
  *   Actual working day may differ from this date.
  * - `siteId`, `dateAt`, `shiftType`, and `regulationWorkMinutes` are
  *   automatically synchronized to all assigned employees and outsourcers
@@ -12,27 +11,51 @@
  * - `startTime`, `endTime`, and `breakMinutes` are NOT synchronized here.
  *   They should be synchronized at `SiteOperationSchedule` level instead.
  * ---------------------------------------------------------------------------
- * @prop {string} siteId - Site document ID (trigger property)
+ * @prop {string} siteId
+ * - Site document ID (trigger property)
  * - Automatically synchronizes to all `employees` and `outsourcers` when changed.
- * @prop {number} requiredPersonnel - Required number of personnel
- * @prop {boolean} qualificationRequired - Qualification required flag
- * @prop {string} workDescription - Work description
- * @prop {string} remarks - Remarks
- * @prop {Array<OperationDetail>} employees - Assigned employees
+ *
+ * @prop {number} requiredPersonnel
+ * - Required number of personnel
+ *
+ * @prop {boolean} qualificationRequired
+ * - Qualification required flag
+ *
+ * @prop {string} workDescription
+ * - Work description
+ *
+ * @prop {string} remarks
+ * - Remarks
+ *
+ * @prop {Array<OperationDetail>} employees
+ * - Assigned employees
  * - Array of `OperationDetail` instances representing assigned employees
- * @prop {Array<OperationDetail>} outsourcers - Assigned outsourcers
+ *
+ * @prop {Array<OperationDetail>} outsourcers
+ * - Assigned outsourcers
  * - Array of `OperationDetail` instances representing assigned outsourcers
- * ---------------------------------------------------------------------------
- * @computed {Array<string>} employeeIds - Array of employee IDs from `employees` (read-only)
- * @computed {Array<string>} outsourcerIds - Array of outsourcer IDs from `outsourcers` (read-only)
- * @computed {number} employeesCount - Count of assigned employees (read-only)
- * @computed {number} outsourcersCount - Count of assigned outsourcers (sum of amounts) (read-only)
- * @computed {boolean} isPersonnelShortage - Indicates if there is a shortage of personnel (read-only)
+ *
+ * @prop {Array<string>} employeeIds - Array of employee IDs from `employees` (read-only)
+ * - Array of employee IDs from `employees` (read-only)
+ *
+ * @prop {Array<string>} outsourcerIds
+ * - Array of outsourcer IDs from `outsourcers` (read-only)
+ *
+ * @prop {number} employeesCount
+ * - Count of assigned employees (read-only)
+ *
+ * @prop {number} outsourcersCount
+ * - Count of assigned outsourcers (sum of amounts) (read-only)
+ *
+ * @prop {boolean} isPersonnelShortage
+ * - Indicates if there is a shortage of personnel (read-only)
  * - `true` if the sum of `employeesCount` and `outsourcersCount` is less than `requiredPersonnel`
- * @computed {Array<OperationDetail>} workers - Combined array of `employees` and `outsourcers`
+ *
+ * @prop {Array<OperationDetail>} workers
+ * - Combined array of `employees` and `outsourcers`
  * - Getter: Returns concatenated array of employees and outsourcers
  * - Setter: Splits array into employees and outsourcers based on `isEmployee` property
- * ---------------------------------------------------------------------------
+ *
  * @getter {string} groupKey - Combines `siteId`, `shiftType`, and `date` to indicate operation grouping (read-only)
  * @getter {boolean} isEmployeesChanged - Indicates whether the employees have changed (read-only)
  * - Returns true if the employee IDs have changed compared to `_beforeData`
@@ -46,6 +69,8 @@
  * - Workers whose `startTime`, `isStartNextDay`, `endTime`, `breakMinutes`, `isQualified`, or `isOjt` have changed
  * ---------------------------------------------------------------------------
  * @inherited - The following properties are inherited from WorkingResult:
+ * @prop {string} key - Unique key combining `siteId`, `date`, `dayType`, and `shiftType` (override/read-only)
+ * - A unique identifier for the working result, combining `siteId`, `date`, `dayType`, and `shiftType`.
  * @prop {Date} dateAt - Date of operation (placement date) (trigger property)
  * - Automatically synchronizes to all `employees` and `outsourcers` when changed.
  * @prop {string} dayType - Day type (e.g., `WEEKDAY`, `WEEKEND`, `HOLIDAY`)
@@ -87,6 +112,8 @@
  * - Extracted from `endTime`.
  * @getter {number} endMinute - End minute (0-59) (read-only)
  * - Extracted from `endTime`.
+ * @getter {boolean} isKeyChanged - Flag indicating whether the key has changed compared to previous data (read-only)
+ * - Compares the current `key` with the `key` in `_beforeData`.
  * ---------------------------------------------------------------------------
  * @method {function} addWorker - Adds a new worker (employee or outsourcer)
  * - @param {Object} options - Options for adding a worker
@@ -234,6 +261,21 @@ export default class Operation extends WorkingResult {
   afterInitialize(item = {}) {
     super.afterInitialize(item);
 
+    /**
+     * Override `key` computed property
+     * - `key`: Combines `siteId`, `date`, `dayType`, and `shiftType`.
+     */
+    Object.defineProperties(this, {
+      key: {
+        configurable: true,
+        enumberable: true,
+        get() {
+          return `${this.siteId}-${this.date}-${this.dayType}-${this.shiftType}`;
+        },
+        set() {},
+      },
+    });
+
     /***********************************************************
      * TRIGGERS FOR SYNCRONIZATION TO EMPLOYEES AND OUTSOURCERS
      * ---------------------------------------------------------
@@ -581,8 +623,6 @@ export default class Operation extends WorkingResult {
         enumerable: false,
       },
     });
-    /** Remove unnecessary properties */
-    delete this.key; // From workingResult.js
   }
 
   /***************************************************************************

package/src/OperationResult.js

@@ -10,8 +10,12 @@
  * - Automatically updates `billingDateAt` based on `dateAt` and `cutoffDate`.
  * - Introduces a lock mechanism (`isLocked`) to prevent edits when necessary.
  *
+ * @prop {string} key - Unique key combining `siteId`, `date`, `dayType`, and `shiftType` (override/read-only)
+ * - A unique identifier for the working result, combining `siteId`, `date`, `dayType`, and `shiftType`.
+ *
  * @prop {string} siteId - Site document ID (trigger property)
  * - Automatically synchronizes to all `employees` and `outsourcers` when changed.
+ *
  * @prop {Date} dateAt - Date of operation (placement date) (trigger property)
  * - Automatically synchronizes to all `employees` and `outsourcers` when changed.
  * - Used to determine `dayType`.
@@ -128,6 +132,8 @@
  * - Extracted from `endTime`.
  * @getter {number} endMinute - End minute (0-59) (read-only)
  * - Extracted from `endTime`.
+ * @getter {boolean} isKeyChanged - Flag indicating whether the key has changed compared to previous data (read-only)
+ * - Compares the current `key` with the `key` in `_beforeData`.
  *
  * @method refreshBillingDateAt - Refresh billingDateAt based on dateAt and cutoffDate
  * - Updates `billingDateAt` based on the current `dateAt` and `cutoffDate` values.
@@ -535,11 +541,11 @@ export default class OperationResult extends Operation {
   }
 
   /**
-   * Synchronize customerId from siteId
+   * Synchronize customerId and apply (re-apply) agreement from siteId
    * @returns {Promise<void>}
    * @throws {Error} If the specified siteId does not exist
    */
-  async _syncCustomerId() {
+  async _syncCustomerIdAndApplyAgreement() {
     if (!this.siteId) return;
     const siteInstance = new Site();
     const siteExists = await siteInstance.fetch({ docId: this.siteId });
@@ -549,6 +555,7 @@ export default class OperationResult extends Operation {
       );
     }
     this.customerId = siteInstance.customerId;
+    this.agreement = siteInstance.getAgreement(this);
   }
 
   /**
@@ -558,12 +565,12 @@ export default class OperationResult extends Operation {
   async beforeCreate() {
     await super.beforeCreate();
 
-    // Sync customerId
-    await this._syncCustomerId();
+    // Sync customerId and apply agreement
+    await this._syncCustomerIdAndApplyAgreement();
   }
 
   /**
-   * Override beforeUpdate to sync customerId if siteId changed
+   * Override beforeUpdate to sync customerId and apply agreement if key changed
    * @returns {Promise<void>}
    */
   async beforeUpdate() {
@@ -576,9 +583,9 @@ export default class OperationResult extends Operation {
       );
     }
 
-    // Sync customerId if siteId changed
-    if (this.siteId === this._beforeData.siteId && this.customerId) return;
-    await this._syncCustomerId();
+    // Sync customerId and apply agreement if key changed
+    if (this.key === this._beforeData.key) return;
+    await this._syncCustomerIdAndApplyAgreement();
   }
 
   /**

package/src/SiteOperationSchedule.js

@@ -1,8 +1,9 @@
 /*****************************************************************************
  * SiteOperationSchedule Model ver 1.1.0
- * @version 1.1.0
+ * @version 1.1.1
  * @author shisyamo4131
  *
+ * @update 2025-11-28 v1.1.1 - Removed the `agreement` parameter from `syncToOperationResult` method.
  * @update 2025-11-22 v1.1.0 - Moved `duplicate`, `notify`, `syncToOperationResult`,
  *                             and `toEvent` methods from client side code.
  *
@@ -17,6 +18,9 @@
  *   `siteId`, `dateAt`, `shiftType`, and `regulationWorkMinutes` are synchronized
  *   in the parent `Operation` class.
  *
+ * @prop {string} key - Unique key combining `siteId`, `date`, `dayType`, and `shiftType` (override/read-only)
+ * - A unique identifier for the working result, combining `siteId`, `date`, `dayType`, and `shiftType`.
+ *
  * @prop {string|null} operationResultId - Associated OperationResult document ID
  * - If an OperationResult has been created based on this schedule, this property
  *   holds the ID of that OperationResult document.
@@ -149,6 +153,9 @@
  * @getter {number} endMinute - End minute (0-59) (read-only)
  * - Extracted from `endTime`.
  *
+ * @getter {boolean} isKeyChanged - Flag indicating whether the key has changed compared to previous data (read-only)
+ * - Compares the current `key` with the `key` in `_beforeData`.
+ *
  * @method duplicate - Duplicates the SiteOperationSchedule for specified dates
  * - Creates new SiteOperationSchedule documents for each specified date,
  *   excluding the original date and avoiding duplicates.
@@ -161,7 +168,8 @@
  * @method syncToOperationResult - Creates an OperationResult document based on the current SiteOperationSchedule
  * - The OperationResult document ID will be the same as the SiteOperationSchedule document ID.
  * - Sets the `operationResultId` property of the SiteOperationSchedule to the created OperationResult document ID.
- * - Accepts an `agreement` object containing necessary properties for creating the OperationResult.
+ * - If an OperationResult already exists, it will be overwritten.
+ * - [UPDATE 2025-11-28] Removed the `agreement` parameter. The agreement is now fetched internally.
  *
  * @method toEvent - Converts the SiteOperationSchedule instance to a VCalendar event object
  * - Returns an object with properties required for displaying events in Vuetify's VCalendar component.
@@ -673,9 +681,14 @@ export default class SiteOperationSchedule extends Operation {
    *   既に存在する場合は上書きされます。
    * - 現場稼働予定ドキュメントの `operationResultId` プロパティに
    *   作成された稼働実績ドキュメントの ID が設定されます。（当該ドキュメント ID と同一）
-   * @param {Object} agreement - 取極め情報オブジェクト。稼働実績ドキュメントの生成に必要なプロパティを含みます。
+   * @param {Object} notifications - 配置通知オブジェクトのマップ。
+   *   - キー: 配置通知の一意キー（`notificationKey` プロパティ）
+   *   - 値: 配置通知ドキュメントオブジェクト
+   * @returns {Promise<void>}
+   *
+   * @update 2025-11-28 - Removed the `agreement` parameter.
    */
-  async syncToOperationResult(agreement, notifications = {}) {
+  async syncToOperationResult(notifications = {}) {
     if (!this.docId) {
       throw new Error(
         "不正な処理です。作成前の現場稼働予定から稼働実績を作成することはできません。"
@@ -689,18 +702,12 @@ export default class SiteOperationSchedule extends Operation {
       return this[prop].map((w) => {
         const notification = notifications[w.notificationKey];
         if (!notification) return w;
-        const {
-          actualStartTime: startTime,
-          actualEndTime: endTime,
-          actualBreakMinutes: breakMinutes,
-          actualIsStartNextDay: isStartNextDay,
-        } = notification;
         return new SiteOperationScheduleDetail({
           ...w.toObject(),
-          startTime,
-          endTime,
-          breakMinutes,
-          isStartNextDay,
+          startTime: notification.actualStartTime,
+          endTime: notification.actualEndTime,
+          breakMinutes: notification.actualBreakMinutes,
+          isStartNextDay: notification.actualIsStartNextDay,
         });
       });
     };
@@ -712,10 +719,8 @@ export default class SiteOperationSchedule extends Operation {
         ...this.toObject(),
         employees,
         outsourcers,
-        agreement: agreement || null,
         siteOperationScheduleId: this.docId,
       });
-      operationResult.refreshBillingDateAt();
       await this.constructor.runTransaction(async (transaction) => {
         const docRef = await operationResult.create({
           docId: this.docId,

package/src/System.js

@@ -0,0 +1,43 @@
+/**
+ * System.js
+ * @version 1.0.0
+ * @description System model
+ * @author shisyamo4131
+ */
+import FireModel from "@shisyamo4131/air-firebase-v2";
+import { defField } from "./parts/fieldDefinitions.js";
+
+const classProps = {
+  isMaintenance: defField("check", { default: false, hidden: true }),
+  updatedAt: defField("dateAt", { default: null, hidden: true }),
+  lastMaintenanceBy: defField("oneLine", {
+    default: "admin-sdk",
+    hidden: true,
+  }),
+};
+
+/**
+ * @prop {boolean} isMaintenance - maintenance mode flag
+ * @prop {Date} updatedAt - last updated timestamp
+ * @prop {string} lastMaintenanceBy - identifier of the last maintainer
+ */
+export default class System extends FireModel {
+  static className = "System";
+  static collectionPath = "System";
+  static usePrefix = false;
+  static useAutonumber = false;
+  static logicalDelete = false;
+  static classProps = classProps;
+
+  async create() {
+    return Promise.reject(new Error("[System.js] Not implemented."));
+  }
+
+  async update() {
+    return Promise.reject(new Error("[System.js] Not implemented."));
+  }
+
+  async delete() {
+    return Promise.reject(new Error("[System.js] Not implemented."));
+  }
+}

package/src/WorkingResult.js

@@ -7,40 +7,41 @@
  * - `dateAt` is defined as a trigger property. When it is set, `dayType` is automatically updated.
  * - Subclasses can override `setDateAtCallback` to add custom behavior when `dateAt` changes.
  * ---------------------------------------------------------------------------
- * @props {Date} dateAt - Applicable start date (trigger property)
- * @props {string} dayType - Day type (e.g., `WEEKDAY`, `WEEKEND`, `HOLIDAY`)
- * @props {string} shiftType - Shift type (`DAY`, `NIGHT`)
- * @props {string} startTime - Start time (HH:MM format)
- * @props {boolean} isStartNextDay - Next day start flag
+ * @prop {Date} dateAt - Applicable start date (trigger property)
+ * @prop {string} dayType - Day type (e.g., `WEEKDAY`, `WEEKEND`, `HOLIDAY`)
+ * @prop {string} shiftType - Shift type (`DAY`, `NIGHT`)
+ * @prop {string} startTime - Start time (HH:MM format)
+ * @prop {boolean} isStartNextDay - Next day start flag
  * - `true` if the actual work starts the day after the placement date `dateAt`
- * @props {string} endTime - End time (HH:MM format)
- * @props {number} breakMinutes - Break time (minutes)
- * @props {number} regulationWorkMinutes - Regulation work minutes
+ * @prop {string} endTime - End time (HH:MM format)
+ * @prop {number} breakMinutes - Break time (minutes)
+ * @prop {number} regulationWorkMinutes - Regulation work minutes
  * - The maximum working time defined by `unitPriceBase` (or `unitPriceQualified`).
  * - Exceeding this time is considered overtime.
- * ---------------------------------------------------------------------------
- * @computed {string} key - Unique key combining `date`, `dayType`, and `shiftType` (read-only)
+ *
+ * @computed
+ * @prop {string} key - Unique key combining `date`, `dayType`, and `shiftType` (read-only)
  * - A unique identifier for the working result, combining `date`, `dayType`, and `shiftType`.
- * @computed {string} date - Date string in YYYY-MM-DD format based on `dateAt` (read-only)
+ * @prop {string} date - Date string in YYYY-MM-DD format based on `dateAt` (read-only)
  * - Returns a string in the format YYYY-MM-DD based on `dateAt`.
- * @computed {boolean} isSpansNextDay - Flag indicating whether the date spans from start date to end date (read-only)
+ * @prop {boolean} isSpansNextDay - Flag indicating whether the date spans from start date to end date (read-only)
  * - `true` if `startTime` is later than `endTime`
- * @computed {Date} startAt - Start date and time (Date object) (read-only)
+ * @prop {Date} startAt - Start date and time (Date object) (read-only)
  * - Returns a Date object with `startTime` set based on `dateAt`.
  * - If `isStartNextDay` is true, add 1 day.
- * @computed {Date} endAt - End date and time (Date object) (read-only)
+ * @prop {Date} endAt - End date and time (Date object) (read-only)
  * - Returns a Date object with `endTime` set based on `dateAt`.
  * - If `isStartNextDay` is true, add 1 day.
  * - If `isSpansNextDay` is true, add 1 day.
- * @computed {number} totalWorkMinutes - Total working time in minutes (excluding break time) (read-only)
+ * @prop {number} totalWorkMinutes - Total working time in minutes (excluding break time) (read-only)
  * - Calculated as the difference between `endAt` and `startAt` minus `breakMinutes`
  * - If the difference between `endAt` and `startAt` is negative, returns 0.
  * - If `startAt` or `endAt` is not set, returns 0.
- * @computed {number} regularTimeWorkMinutes - Regular working time in minutes (read-only)
+ * @prop {number} regularTimeWorkMinutes - Regular working time in minutes (read-only)
  * - The portion of `totalWorkMinutes` that is considered within the contract's `regulationWorkMinutes`.
  * - If actual working time is less than regulation time (e.g., early leave), it equals `totalWorkMinutes`.
  * - If actual working time exceeds regulation time (overtime), it equals `regulationWorkMinutes`.
- * @computed {number} overtimeWorkMinutes - Overtime work in minutes (read-only)
+ * @prop {number} overtimeWorkMinutes - Overtime work in minutes (read-only)
  * - Calculated as `totalWorkMinutes` minus `regulationWorkMinutes`
  * - Overtime work is not negative; the minimum is 0.
  * ---------------------------------------------------------------------------
@@ -52,6 +53,8 @@
  * - Extracted from `endTime`.
  * @getter {number} endMinute - End minute (0-59) (read-only)
  * - Extracted from `endTime`.
+ * @getter {boolean} isKeyChanged - Flag indicating whether the key has changed compared to previous data (read-only)
+ * - Compares the current `key` with the `key` in `_beforeData`.
  * ---------------------------------------------------------------------------
  * @method {function} setDateAtCallback - Callback method called when `dateAt` is set
  * - Override this method in subclasses to add custom behavior when `dateAt` changes.
@@ -301,4 +304,15 @@ export default class WorkingResult extends FireModel {
   get endMinute() {
     return this.endTime ? Number(this.endTime.split(":")[1]) : 0;
   }
+
+  /**
+   * Returns whether the key has changed compared to the previous data.
+   * - Compares the current `key` with the `key` in `_beforeData`.
+   * - Returns `true` if they are different, otherwise `false`.
+   */
+  get isKeyChanged() {
+    const current = this.key;
+    const before = this._beforeData?.key;
+    return current !== before;
+  }
 }