@shisyamo4131/air-guard-v2-schemas 1.2.1 → 1.3.1-dev.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shisyamo4131/air-guard-v2-schemas",
-  "version": "1.2.1",
+  "version": "1.3.1-dev.0",
   "description": "Schemas for AirGuard V2",
   "type": "module",
   "main": "index.js",
@@ -33,7 +33,10 @@
     "access": "public"
   },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "dev:publish": "npm version prerelease --preid=dev && npm publish --tag dev",
+    "release:patch": "npm version patch && npm publish",
+    "release:minor": "npm version minor && npm publish",
+    "release:major": "npm version major && npm publish"
   },
   "peerDependencies": {
     "@shisyamo4131/air-firebase-v2": "^1.0.0"

package/src/Agreement.js

@@ -234,6 +234,34 @@ export default class Agreement extends WorkingResult {
   static classProps = classProps;
   static headers = headers;
 
+  /**
+   * Returns an object containing price-related properties.
+   * This accessor is useful for synchronizing price details when creating `OperationResult` instance
+   * from a `SiteOperationSchedule`.
+   * - Includes `regulationWorkMinutes`.
+   * @returns {Object} An object with price-related properties.
+   * @property {number} cutoffDate - Cutoff date
+   * @property {number} regulationWorkMinutes - Regulation work minutes
+   * @property {number} unitPriceBase - Base unit price
+   * @property {number} overtimeUnitPriceBase - Overtime base unit price
+   * @property {number} unitPriceQualified - Qualified unit price
+   * @property {number} overtimeUnitPriceQualified - Overtime qualified unit price
+   * @property {string} billingUnitType - Billing unit type
+   * @property {boolean} includeBreakInBilling - Whether to include break time in billing
+   */
+  get billingInfo() {
+    return {
+      cutoffDate: this.cutoffDate,
+      regulationWorkMinutes: this.regulationWorkMinutes,
+      unitPriceBase: this.unitPriceBase,
+      overtimeUnitPriceBase: this.overtimeUnitPriceBase,
+      unitPriceQualified: this.unitPriceQualified,
+      overtimeUnitPriceQualified: this.overtimeUnitPriceQualified,
+      billingUnitType: this.billingUnitType,
+      includeBreakInBilling: this.includeBreakInBilling,
+    };
+  }
+
   /**
    * Returns an object containing price-related properties.
    * This accessor is useful for synchronizing price details when creating `OperationResult` instance
@@ -249,6 +277,9 @@ export default class Agreement extends WorkingResult {
    * @property {boolean} includeBreakInBilling - Whether to include break time in billing
    */
   get prices() {
+    console.warn(
+      "`Agreement.prices` is deprecated. Use `Agreement.billingInfo` instead."
+    );
     return {
       regulationWorkMinutes: this.regulationWorkMinutes,
       unitPriceBase: this.unitPriceBase,

package/src/Billing.js

@@ -9,16 +9,18 @@
  * @prop {string} billingMonth - billing month (YYYY-MM format)
  * @prop {Date} billingDate - billing date
  * @prop {Date} paymentDueDate - payment due date
+ *
+ * @prop {Array} paymentRecords - payment records (not implemented yet)
+ *
  * @prop {string} status - status (DRAFT/CONFIRMED/PAID/CANCELLED)
- * @prop {Array<OperationResult>} items - operation result items (raw data)
+ * @prop {Array<OperationResult>} operationResults - operation result documents.
  * @prop {Object} adjustment - adjustment
  * @prop {string} remarks - remarks
- * @prop {Object} pdfInfo - PDF information
  *
- * @computed {number} subtotal - subtotal (excluding tax)
- * @computed {number} taxAmount - tax amount
- * @computed {number} totalAmount - total amount (including tax)
- * @computed {Array<Object>} itemsSummary - billing items summary for display
+ * @prop {number} subtotal - subtotal (excluding tax) (computed-readonly)
+ * @prop {number} taxAmount - tax amount (computed-readonly)
+ * @prop {number} totalAmount - total amount (including tax) (computed-readonly)
+ * @prop {Array<Object>} itemsSummary - billing items summary for display (computed-readonly)
  *****************************************************************************/
 
 import FireModel from "@shisyamo4131/air-firebase-v2";
@@ -36,29 +38,21 @@ const classProps = {
   customerId: defField("customerId", { required: true }),
   siteId: defField("siteId", { required: true }),
   billingMonth: defField("oneLine", { required: true }),
-  billingDate: defField("date"),
-  paymentDueDate: defField("date"),
-  status: defField("oneLine", { default: STATUS.DRAFT }),
+  billingDateAt: defField("date"),
+  paymentDueDateAt: defField("date"),
 
-  // OperationResult の生データを配列で保持
-  items: defField("array", { customClass: OperationResult }),
+  // 入金管理用配列（現時点では未使用 将来の拡張用）
+  paymentRecords: defField("array", { default: [] }), // Not implemented yet
 
+  status: defField("oneLine", { default: STATUS.DRAFT }),
+  operationResults: defField("array", { customClass: OperationResult }),
   adjustment: defField("object", {
     default: {
       amount: 0,
       description: "",
     },
   }),
-
   remarks: defField("multipleLine"),
-
-  pdfInfo: defField("object", {
-    default: {
-      url: null,
-      generatedAt: null,
-      version: 1,
-    },
-  }),
 };
 
 export default class Billing extends FireModel {
@@ -75,13 +69,14 @@ export default class Billing extends FireModel {
     // 小計（税抜）を計算
     Object.defineProperty(this, "subtotal", {
       get() {
-        const itemsTotal = this.items.reduce((sum, item) => {
+        const itemsTotal = this.operationResults.reduce((sum, item) => {
           return sum + (item.salesAmount || 0);
         }, 0);
         return itemsTotal + (this.adjustment?.amount || 0);
       },
       set() {},
       enumerable: true,
+      configurable: true,
     });
 
     // 消費税額を計算
@@ -91,6 +86,7 @@ export default class Billing extends FireModel {
       },
       set() {},
       enumerable: true,
+      configurable: true,
     });
 
     // 合計金額（税込）を計算
@@ -100,12 +96,13 @@ export default class Billing extends FireModel {
       },
       set() {},
       enumerable: true,
+      configurable: true,
     });
 
     // 表示用の明細サマリーを生成
     Object.defineProperty(this, "itemsSummary", {
       get() {
-        return this.items.map((item) => ({
+        return this.operationResults.map((item) => ({
           operationResultId: item.docId,
           workDate: item.dateAt,
           shiftType: item.shiftType,
@@ -134,6 +131,7 @@ export default class Billing extends FireModel {
       },
       set() {},
       enumerable: true,
+      configurable: true,
     });
   }
 

package/src/Customer.js

@@ -1,8 +1,9 @@
 /*****************************************************************************
- * Customer ver 1.0.0
+ * Customer ver 1.1.0
  * @author shisyamo4131
  *
  * @description Customer model.
+ *
  * @hasMany Sites - related sites associated with the customer
  *
  * @prop {string} code - customer code
@@ -17,6 +18,8 @@
  * @prop {string} tel - telephone number
  * @prop {string} fax - fax number
  * @prop {string} contractStatus - contract status
+ * @prop {number} paymentMonth - payment site in months
+ * @prop {string} paymentDate - payment site date
  * @prop {string} remarks - additional remarks
  *
  * @readonly
@@ -31,6 +34,7 @@ import FireModel from "@shisyamo4131/air-firebase-v2";
 import { defField } from "./parts/fieldDefinitions.js";
 import { defAccessor } from "./parts/accessorDefinitions.js";
 import { VALUES } from "./constants/contract-status.js";
+import CutoffDate from "./utils/CutoffDate.js";
 
 const classProps = {
   code: defField("code", { label: "取引先コード" }),
@@ -45,6 +49,21 @@ const classProps = {
   tel: defField("tel", { colsDefinition: { cols: 12, sm: 6 } }),
   fax: defField("fax", { colsDefinition: { cols: 12, sm: 6 } }),
   contractStatus: defField("contractStatus", { required: true }),
+  paymentMonth: defField("number", {
+    default: 1,
+    label: "入金サイト（月数）",
+    required: true,
+  }),
+  paymentDate: defField("select", {
+    label: "入金サイト（日付）",
+    default: CutoffDate.VALUES.END_OF_MONTH,
+    required: true,
+    component: {
+      attrs: {
+        items: CutoffDate.OPTIONS,
+      },
+    },
+  }),
   remarks: defField("multipleLine", { label: "備考" }),
 };
 

package/src/OperationBilling.js

@@ -11,54 +11,57 @@
  *   is not implemented, as billing records are typically generated through the OperationResult class.
  * ---------------------------------------------------------------------------
  * @inherited - The following properties are inherited from OperationResult:
- * @props {string|null} siteOperationScheduleId - Associated SiteOperationSchedule document ID
+ * @prop {string|null} siteOperationScheduleId - Associated SiteOperationSchedule document ID
  * - If this OperationBilling was created from a SiteOperationSchedule, this property holds that ID.
  * - If this property is set, the instance cannot be deleted.
- * @props {boolean} useAdjustedQuantity - Flag to indicate if adjusted quantities are used for billing
- * @props {number} adjustedQuantityBase - Adjusted quantity for base workers
+ * @prop {boolean} useAdjustedQuantity - Flag to indicate if adjusted quantities are used for billing
+ * @prop {number} adjustedQuantityBase - Adjusted quantity for base workers
  * - Quantity used for billing base workers when `useAdjustedQuantity` is true.
- * @props {number} adjustedOvertimeBase - Adjusted overtime for base workers
+ * @prop {number} adjustedOvertimeBase - Adjusted overtime for base workers
  * - Overtime used for billing base workers when `useAdjustedQuantity` is true.
- * @props {number} adjustedQuantityQualified - Adjusted quantity for qualified workers
+ * @prop {number} adjustedQuantityQualified - Adjusted quantity for qualified workers
  * - Quantity used for billing qualified workers when `useAdjustedQuantity` is true.
- * @props {number} adjustedOvertimeQualified - Adjusted overtime for qualified workers
+ * @prop {number} adjustedOvertimeQualified - Adjusted overtime for qualified workers
  * - Overtime used for billing qualified workers when `useAdjustedQuantity` is true.
- * @props {Date} billingDateAt - Billing date
+ * @prop {Date} billingDateAt - Billing date
+ * - The date used for billing purposes.
+ * @prop {boolean} isLocked - Lock flag
+ * - When set to true, the OperationBilling is locked from edits exept for editing as OperationBilling.
  * ---------------------------------------------------------------------------
  * @inherited - The following properties are inherited from Operation (via OperationResult):
- * @props {string} siteId - Site document ID (trigger property)
+ * @prop {string} siteId - Site document ID (trigger property)
  * - Automatically synchronizes to all `employees` and `outsourcers` when changed.
- * @props {number} requiredPersonnel - Required number of personnel
- * @props {boolean} qualificationRequired - Qualification required flag
- * @props {string} workDescription - Work description
- * @props {string} remarks - Remarks
- * @props {Array<OperationResultDetail>} 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<OperationResultDetail>} employees - Assigned employees
  * - Array of `OperationResultDetail` instances representing assigned employees
- * @props {Array<OperationResultDetail>} outsourcers - Assigned outsourcers
+ * @prop {Array<OperationResultDetail>} outsourcers - Assigned outsourcers
  * - Array of `OperationResultDetail` instances representing assigned outsourcers
  * ---------------------------------------------------------------------------
  * @inherited - The following properties are inherited from Agreement (via OperationResult):
- * @props {number} unitPriceBase - Base unit price (JPY)
- * @props {number} overtimeUnitPriceBase - Overtime unit price (JPY/hour)
- * @props {number} unitPriceQualified - Qualified unit price (JPY)
- * @props {number} overtimeUnitPriceQualified - Qualified overtime unit price (JPY/hour)
- * @props {string} billingUnitType - Billing unit type
- * @props {boolean} includeBreakInBilling - Whether to include break time in billing if `billingUnitType` is `PER_HOUR`.
- * @props {number} cutoffDate - Cutoff date value from CutoffDate.VALUES
+ * @prop {number} unitPriceBase - Base unit price (JPY)
+ * @prop {number} overtimeUnitPriceBase - Overtime unit price (JPY/hour)
+ * @prop {number} unitPriceQualified - Qualified unit price (JPY)
+ * @prop {number} overtimeUnitPriceQualified - Qualified overtime unit price (JPY/hour)
+ * @prop {string} billingUnitType - Billing unit type
+ * @prop {boolean} includeBreakInBilling - Whether to include break time in billing if `billingUnitType` is `PER_HOUR`.
+ * @prop {number} cutoffDate - Cutoff date value from CutoffDate.VALUES
  * - The cutoff date for billing, using values defined in the CutoffDate utility class.
  * ---------------------------------------------------------------------------
  * @inherited - The following properties are inherited from WorkingResult (via OperationResult):
- * @props {Date} dateAt - Date of operation (placement date) (trigger property)
+ * @prop {Date} dateAt - Date of operation (placement date) (trigger property)
  * - Automatically synchronizes to all `employees` and `outsourcers` when changed.
- * @props {string} dayType - Day type (e.g., `WEEKDAY`, `WEEKEND`, `HOLIDAY`)
- * @props {string} shiftType - `DAY` or `NIGHT` (trigger property)
+ * @prop {string} dayType - Day type (e.g., `WEEKDAY`, `WEEKEND`, `HOLIDAY`)
+ * @prop {string} shiftType - `DAY` or `NIGHT` (trigger property)
  * - Automatically synchronizes to all `employees` and `outsourcers` when changed.
- * @props {string} startTime - Start time (HH:MM format)
- * @props {boolean} isStartNextDay - Next day start flag
+ * @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 (trigger property)
+ * @prop {string} endTime - End time (HH:MM format)
+ * @prop {number} breakMinutes - Break time (minutes)
+ * @prop {number} regulationWorkMinutes - Regulation work minutes (trigger property)
  * - Indicates the maximum working time treated as regular working hours.
  * - Automatically synchronizes to all `employees` and `outsourcers` when changed.
  * ---------------------------------------------------------------------------

package/src/OperationResult.js

@@ -1,5 +1,5 @@
 /*****************************************************************************
- * OperationResult Model ver 1.0.0
+ * OperationResult Model ver 1.1.0
  * @author shisyamo4131
  * ---------------------------------------------------------------------------
  * - Extends Operation class to represent the result of an operation.
@@ -7,6 +7,8 @@
  * - Prevents deletion if the instance has `siteOperationScheduleId`.
  * - Provides comprehensive billing calculations including statistics, sales amounts, and tax.
  * - Supports both daily and hourly billing with adjusted quantities.
+ * - Automatically updates `billingDateAt` based on `dateAt` and `cutoffDate`.
+ * - Introduces a lock mechanism (`isLocked`) to prevent edits when necessary.
  * ---------------------------------------------------------------------------
  * @prop {string|null} siteOperationScheduleId - Associated SiteOperationSchedule document ID
  * - If this OperationResult was created from a SiteOperationSchedule, this property holds that ID.
@@ -21,6 +23,9 @@
  * @prop {number} adjustedOvertimeQualified - Adjusted overtime for qualified workers
  * - Overtime used for billing qualified workers when `useAdjustedQuantity` is true.
  * @prop {Date} billingDateAt - Billing date
+ * - The date used for billing purposes.
+ * @prop {boolean} isLocked - Lock flag
+ * - When set to true, the OperationResult is locked from edits exept for editing as OperationBilling.
  * ---------------------------------------------------------------------------
  * @computed {Object} statistics - Statistics of workers (read-only)
  * - Contains counts and total work minutes for base and qualified workers, including OJT breakdowns.
@@ -38,6 +43,7 @@
  * - Calculated using the `Tax` utility based on `salesAmount` and `date`.
  * @computed {number} billingAmount - Total billing amount including tax (read-only)
  * - Sum of `salesAmount` and `tax`.
+ * @computed {string} billingMonth - Billing month in YYYY-MM format (read-only)
  * ---------------------------------------------------------------------------
  * @inherited - The following properties are inherited from Operation:
  * @prop {string} siteId - Site document ID (trigger property)
@@ -60,10 +66,14 @@
  * @prop {boolean} includeBreakInBilling - Whether to include break time in billing if `billingUnitType` is `PER_HOUR`.
  * @prop {number} cutoffDate - Cutoff date value from CutoffDate.VALUES
  * - The cutoff date for billing, using values defined in the CutoffDate utility class.
+ * - Used to calculate `billingDateAt`.
+ * - When `cutoffDate` or `dateAt` changes, `billingDateAt` is automatically updated.
  * ---------------------------------------------------------------------------
  * @inherited - The following properties are inherited from WorkingResult (via Operation):
  * @prop {Date} dateAt - Date of operation (placement date) (trigger property)
  * - Automatically synchronizes to all `employees` and `outsourcers` when changed.
+ * - Used to determine `dayType`.
+ * - When `dateAt` changes, `billingDateAt` is also updated based on `cutoffDate`.
  * @prop {string} dayType - Day type (e.g., `WEEKDAY`, `WEEKEND`, `HOLIDAY`)
  * @prop {string} shiftType - `DAY` or `NIGHT` (trigger property)
  * - Automatically synchronizes to all `employees` and `outsourcers` when changed.
@@ -132,6 +142,8 @@
  * @method {function} beforeDelete - Override method to prevent deletion with siteOperationScheduleId
  * - Prevents deletion if the instance has `siteOperationScheduleId`.
  * - Throws an error if deletion is attempted on an instance created from SiteOperationSchedule.
+ * @method {function} refreshBillingDateAt - Refresh billingDateAt based on dateAt and cutoffDate
+ * - Updates `billingDateAt` based on the current `dateAt` and `cutoffDate` values.
  * ---------------------------------------------------------------------------
  * @inherited - The following methods are inherited from Operation:
  * @method {function} addWorker - Adds a new worker (employee or outsourcer)
@@ -214,6 +226,10 @@ const classProps = {
   outsourcers: defField("array", {
     customClass: OperationResultDetail,
   }),
+  isLocked: defField("check", {
+    label: "ロック",
+    default: false,
+  }),
 };
 
 export default class OperationResult extends Operation {
@@ -246,12 +262,7 @@ export default class OperationResult extends Operation {
         set(v) {
           _cutoffDate = v;
           // Update billingDateAt when cutoffDate changes
-          if (this.dateAt) {
-            this.billingDateAt = CutoffDate.calculateBillingDateAt(
-              this.dateAt,
-              this.cutoffDate
-            );
-          }
+          this.refreshBillingDateAt();
         },
       },
       statistics: {
@@ -426,13 +437,49 @@ export default class OperationResult extends Operation {
         },
         set(v) {},
       },
+      billingMonth: {
+        configurable: true,
+        enumerable: true,
+        get() {
+          if (!this.billingDateAt) return null;
+          const jstDate = new Date(
+            this.billingDateAt.getTime() + 9 * 60 * 60 * 1000
+          ); /* JST補正 */
+          const year = jstDate.getUTCFullYear();
+          const month = jstDate.getUTCMonth() + 1;
+          return `${year}-${String(month).padStart(2, "0")}`;
+        },
+        set(v) {},
+      },
     });
   }
 
+  /**
+   * Refresh billingDateAt based on dateAt and cutoffDate
+   * @returns {void}
+   */
+  refreshBillingDateAt() {
+    if (!this.dateAt) {
+      this.billingDateAt = null;
+      return;
+    }
+    if (this.cutoffDate !== 0 && !this.cutoffDate) {
+      this.billingDateAt = null;
+      return;
+    }
+    this.billingDateAt = CutoffDate.calculateBillingDateAt(
+      this.dateAt,
+      this.cutoffDate
+    );
+  }
+
+  /**
+   * Override `setDateAtCallback` to refresh billingDateAt
+   * @param {Date} v
+   */
   setDateAtCallback(v) {
     super.setDateAtCallback(v);
-    if (!this.cutoffDate) return;
-    this.billingDateAt = CutoffDate.calculateBillingDateAt(v, this.cutoffDate);
+    this.refreshBillingDateAt();
   }
 
   /**
@@ -447,4 +494,32 @@ export default class OperationResult extends Operation {
       );
     }
   }
+
+  /**
+   * Override update method to prevent editing if isLocked is true
+   * @param {*} options
+   * @returns {Promise<void>}
+   */
+  async update(options = {}) {
+    if (this.isLocked) {
+      throw new Error(
+        "[OperationResult] This OperationResult is locked and cannot be edited."
+      );
+    }
+    return super.update(options);
+  }
+
+  /**
+   * Override delete method to prevent deletion if isLocked is true
+   * @param {*} options
+   * @returns {Promise<void>}
+   */
+  async delete(options = {}) {
+    if (this.isLocked) {
+      throw new Error(
+        "[OperationResult] This OperationResult is locked and cannot be deleted."
+      );
+    }
+    return super.delete(options);
+  }
 }