@shisyamo4131/air-guard-v2-schemas 2.4.2-dev.8 → 2.4.2-dev.81

package/src/Company.js

@@ -1,29 +1,51 @@
-/**
- * Company Model
- * @version 1.0.0
+/*****************************************************************************
+ * @class Company
+ * @extends FireModel
  * @author shisyamo4131
- * @update 2026-01-06 - Add `firstDayOfWeek` property.
- * @update 2025-12-29 - Add `isCompleteRequiredFields` computed property.
- * @update 2025-12-02 - Add maintenance information properties.
- * @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.
- */
+ *
+ * @property {string} companyName - 会社名
+ * @property {string} companyNameKana - 会社名（カナ）
+ * @property {string} zipcode - 郵便番号
+ * @property {string} prefCode - 都道府県コード
+ * @property {string} city - 市区町村
+ * @property {string} address - 住所
+ * @property {string} building - 建物名
+ * @property {string} tel - 電話番号
+ * @property {string} fax - FAX番号
+ * @property {string} bankName - 銀行名
+ * @property {string} branchName - 支店名
+ * @property {string} accountType - 口座種別（普通、当座）
+ * @property {string} accountNumber - 口座番号
+ * @property {string} accountHolder - 口座名義
+ * @property {AgreementV2[]} agreementsV2 - 会社の既定取極めの配列（バージョン2）
+ * @property {SiteOrder[]} siteOrder - 配置管理のサイト・勤務区分ペアの表示順を管理する配列
+ * @property {SiteOrder[]} scheduleOrder - サイト・勤務区分ペアの表示順を管理する配列（スケジュール用）
+ * @property {object} location - 会社の位置情報
+ * @property {number} minuteInterval - 時刻選択間隔（分）
+ * @property {string} roundSetting - 端数処理設定
+ * @property {string} firstDayOfWeek - 週の始まり
+ * @property {string} stripeCustomerId - Stripe顧客ID
+ * @property {object} subscription - サブスクリプション情報
+ * @property {boolean} maintenanceMode - メンテナンスモードフラグ
+ * @property {string} maintenanceReason - メンテナンス理由
+ * @property {Date} maintenanceStartAt - メンテナンス開始日時
+ * @property {string} maintenanceStartedBy - メンテナンス開始者
+ *
+ * @deprecated `agreements` is deprecated. Use `agreementsV2` instead.
+ *****************************************************************************/
 import FireModel from "@shisyamo4131/air-firebase-v2";
 import { defField } from "./parts/fieldDefinitions.js";
 import { defAccessor } from "./parts/accessorDefinitions.js";
-import Agreement from "./Agreement.js";
+// import Agreement from "./Agreement.js";
+import AgreementV2 from "./AgreementV2.js";
 import SiteOrder from "./SiteOrder.js";
 import RoundSetting from "./RoundSetting.js";
 import { GeocodableMixin } from "./mixins/GeocodableMixin.js";
 import { DAY_OF_WEEK_OPTIONS, DAY_OF_WEEK_VALUES } from "./constants/index.js";
 
 const classProps = {
-  companyName: defField("name", { label: "会社名", required: true }),
-  companyNameKana: defField("nameKana", {
-    label: "会社名（カナ）",
-    required: true,
-  }),
+  companyName: defField("companyName", { required: true }),
+  companyNameKana: defField("companyNameKana", { required: true }),
 
   /**
    * これ以降のフィールドは管理者アカウント作成時に未入力状態で作成されるため required は未定義（false）とする
@@ -49,18 +71,33 @@ const classProps = {
   accountNumber: defField("oneLine", { label: "口座番号", length: 7 }),
   accountHolder: defField("oneLine", { label: "口座名義", length: 50 }),
 
-  /** 会社の既定取極め */
-  agreements: defField("array", {
+  /**
+   * 会社既定の取極め
+   * @deprecated `agreements` is deprecated. Use `agreementsV2` instead.
+   */
+  // agreements: defField("array", {
+  //   label: "既定の取極め",
+  //   customClass: Agreement,
+  // }),
+  agreementsV2: defField("array", {
     label: "既定の取極め",
-    customClass: Agreement,
+    customClass: AgreementV2,
   }),
 
   /**
-   * Field to manage the display order of site-shift type pairs for placement management.
+   * Property to manage the display order of site-shift type pairs for arrangement management.
    * Format: { siteId, shiftType }
+   * NOTE: `key` is a unique identifier combined from siteId and shiftType.
    */
   siteOrder: defField("array", { customClass: SiteOrder, hidden: true }),
 
+  /**
+   * Property to manage the display order of site-shift type pairs for site-operation-schedule.
+   * Format: { siteId, shiftType, key }
+   * NOTE: `key` is a unique identifier combined from siteId and shiftType.
+   */
+  scheduleOrder: defField("array", { customClass: SiteOrder, hidden: true }),
+
   /** Geolocation */
   location: defField("location", { hidden: true }),
 
@@ -203,7 +240,7 @@ export default class Company extends GeocodableMixin(FireModel) {
           const newOrder = new SiteOrder({ siteId, shiftType });
           if (this.some((order) => order.key === newOrder.key)) {
             throw new Error(
-              `SiteOrder with key ${newOrder.key} already exists.`
+              `SiteOrder with key ${newOrder.key} already exists.`,
             );
           }
           index === -1 ? this.push(newOrder) : this.splice(index, 0, newOrder);
@@ -250,16 +287,104 @@ export default class Company extends GeocodableMixin(FireModel) {
           if (typeof arg === "string") {
             key = arg;
           } else if (typeof arg === "object" && arg.siteId && arg.shiftType) {
-            key = `${arg.siteId}-${arg.shiftType}`;
+            key = `${arg.siteId}_${arg.shiftType}`;
           } else {
             throw new Error(
-              "Invalid argument for remove. Must be a string key or an object with siteId and shiftType."
+              "Invalid argument for remove. Must be a string key or an object with siteId and shiftType.",
             );
           }
 
           const index = this.findIndex((order) => order.key === key);
           if (index === -1) {
-            throw new Error(`SiteOrder with key ${key} does not exist.`);
+            throw new Error(`ScheduleOrder with key ${key} does not exist.`);
+          }
+
+          this.splice(index, 1);
+        },
+        writable: false,
+        enumerable: false,
+        configurable: true,
+      },
+    });
+
+    /*************************************************************************
+     * CUSTOM METHODS FOR scheduleOrder ARRAY
+     * Note: These methods modify the scheduleOrder array directly.
+     * The Company instance itself is not updated by these methods.
+     * Use the provided public methods to interact with scheduleOrder.
+     *************************************************************************/
+    Object.defineProperties(this.scheduleOrder, {
+      /**
+       * Inserts a new ScheduleOrder into the `scheduleOrder` array.
+       * @param {Object} params - The parameters for the ScheduleOrder.
+       * @param {string} params.siteId - The ID of the site.
+       * @param {string} params.shiftType - The shift type associated with the site.
+       * @param {number} [index=-1] - The position to insert the new ScheduleOrder. Defaults to the end.
+       * @returns {ScheduleOrder} The newly created ScheduleOrder instance.
+       * @throws {Error} If a ScheduleOrder with the same key already exists.
+       */
+      add: {
+        value: function ({ siteId, shiftType }, index = -1) {
+          const newOrder = new ScheduleOrder({ siteId, shiftType });
+          if (this.some((order) => order.key === newOrder.key)) {
+            throw new Error(
+              `ScheduleOrder with key ${newOrder.key} already exists.`,
+            );
+          }
+          index === -1 ? this.push(newOrder) : this.splice(index, 0, newOrder);
+          return newOrder;
+        },
+        writable: false,
+        enumerable: false,
+        configurable: true,
+      },
+      /**
+       * Changes the order of a ScheduleOrder in the scheduleOrder array.
+       * Note: Company instance does not be updated by this method.
+       * @param {number} oldIndex - The current index of the ScheduleOrder.
+       * @param {number} newIndex - The new index to move the ScheduleOrder to.
+       * @returns {void}
+       * @throws {Error} If oldIndex or newIndex are out of bounds.
+       */
+      change: {
+        value: function (oldIndex, newIndex) {
+          const length = this.length;
+          if (oldIndex < 0 || oldIndex >= length) {
+            throw new Error("Invalid oldIndex for site order change.");
+          }
+          if (newIndex < 0 || newIndex >= length) {
+            throw new Error("Invalid newIndex for site order change.");
+          }
+          const [movedOrder] = this.splice(oldIndex, 1);
+          this.splice(newIndex, 0, movedOrder);
+        },
+        writable: false,
+        enumerable: false,
+        configurable: true,
+      },
+      /**
+       * Removes a ScheduleOrder from the scheduleOrder array.
+       * Note: Company instance does not be updated by this method.
+       * @param {string|Object} arg - The key or {siteId, shiftType} of the ScheduleOrder to remove.
+       * @returns {void}
+       * @throws {Error} If the ScheduleOrder does not exist or if the argument is invalid.
+       */
+      remove: {
+        value: function (arg) {
+          let key = "";
+          if (typeof arg === "string") {
+            key = arg;
+          } else if (typeof arg === "object" && arg.siteId && arg.shiftType) {
+            key = `${arg.siteId}_${arg.shiftType}`;
+          } else {
+            throw new Error(
+              "Invalid argument for remove. Must be a string key or an object with siteId and shiftType.",
+            );
+          }
+
+          const index = this.findIndex((order) => order.key === key);
+          if (index === -1) {
+            throw new Error(`ScheduleOrder with key ${key} does not exist.`);
           }
 
           this.splice(index, 1);
@@ -272,6 +397,18 @@ export default class Company extends GeocodableMixin(FireModel) {
   }
 
   /***************************************************************************
-   * PUBLIC METHODS
+   * FOR DEPRECATED PROPERTIES
    ***************************************************************************/
+  get agreements() {
+    console.warn(
+      "Warning: `agreements` is deprecated. Use `agreementsV2` instead.",
+    );
+    return [];
+  }
+
+  set agreements(newValue) {
+    console.warn(
+      "Warning: `agreements` is deprecated. Use `agreementsV2` instead.",
+    );
+  }
 }

package/src/Customer.js

@@ -1,24 +1,49 @@
-/**
- * Customer
- * @version 1.1.1
- * @description This module defines the Customer model for managing customer data.
- * @hasMany Sites - related sites associated with the customer
+/*****************************************************************************
+ * @class Customer
+ * @extends FireModel
  * @author shisyamo4131
- * @update 2025-12-08 - Changed `paymentMonth` type from direct number to select field.
- */
+ *
+ * @property {string} code - customer code
+ * @property {string} name - customer name
+ * @property {string} branchName - 支店名などの会社名の補足情報
+ * @property {string} abbreviation - 会社名略称
+ * @property {string} nameKana - customer name in kana
+ * @property {string} zipcode - postal code
+ * @property {string} prefCode - prefecture code
+ * @property {string} city - city name
+ * @property {string} address - address details
+ * @property {string} building - building name
+ * @property {object} location - geographical location
+ * @property {string} tel - telephone number
+ * @property {string} fax - fax number
+ * @property {string} contractStatus - contract status
+ * @property {number} paymentMonth - payment site in months
+ * @property {string} paymentDate - payment site date
+ * @property {string} remarks - additional remarks
+ *
+ * @readonly
+ * @property {string} fullAddress - full address combining prefecture, city, and address (read-only)
+ * @property {string} prefecture - prefecture name derived from `prefCode` (read-only)
+ *
+ * @static
+ * @property {object} STATUS - constant mapping for contract statuses
+ * @property {string} STATUS_ACTIVE - constant for active contract status
+ * @property {string} STATUS_TERMINATED - constant for terminated contract status
+ *
+ * @method getPaymentDueDateAt
+ *****************************************************************************/
 import FireModel from "@shisyamo4131/air-firebase-v2";
 import { defField } from "./parts/fieldDefinitions.js";
 import { defAccessor } from "./parts/accessorDefinitions.js";
 import CutoffDate from "./utils/CutoffDate.js";
-import {
-  CONTRACT_STATUS_VALUES,
-  PAYMENT_MONTH_OPTIONS,
-} from "./constants/index.js";
+import { CONTRACT_STATUS_VALUES } from "./constants/index.js";
 import { GeocodableMixin } from "./mixins/GeocodableMixin.js";
 
 const classProps = {
   code: defField("code", { label: "取引先コード" }),
   name: defField("name", { label: "取引先名", required: true }),
+  branchName: defField("branchName", { required: false }),
+  abbreviation: defField("abbreviation", { required: true }),
   nameKana: defField("nameKana", { label: "取引先名（カナ）", required: true }),
   zipcode: defField("zipcode", { required: true }),
   prefCode: defField("prefCode", { required: true }),
@@ -30,58 +55,13 @@ const classProps = {
   fax: defField("fax", { colsDefinition: { cols: 12, sm: 6 } }),
   contractStatus: defField("contractStatus", { required: true }),
   cutoffDate: defField("cutoffDate", { required: true }),
-  paymentMonth: defField("select", {
-    default: 1,
-    label: "入金サイト（月数）",
-    required: true,
-    component: {
-      attrs: {
-        items: PAYMENT_MONTH_OPTIONS,
-      },
-    },
-  }),
-  paymentDate: defField("select", {
-    label: "入金サイト（日付）",
-    default: CutoffDate.VALUES[0].value,
-    required: true,
-    component: {
-      attrs: {
-        items: CutoffDate.OPTIONS,
-      },
-    },
-  }),
+  paymentMonth: defField("paymentMonth", { required: true }),
+  paymentDate: defField("paymentDate", { required: true }),
   remarks: defField("multipleLine", { label: "備考" }),
 };
 
 /*****************************************************************************
- * @prop {string} code - customer code
- * @prop {string} name - customer name
- * @prop {string} nameKana - customer name in kana
- * @prop {string} zipcode - postal code
- * @prop {string} prefCode - prefecture code
- * @prop {string} city - city name
- * @prop {string} address - address details
- * @prop {string} building - building name
- * @prop {object} location - geographical location
- * @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
- * @prop {string} fullAddress - full address combining prefecture, city, and address (read-only)
- * @prop {string} prefecture - prefecture name derived from `prefCode` (read-only)
- *
- * @static
- * @prop {object} STATUS - constant mapping for contract statuses
- * @prop {string} STATUS_ACTIVE - constant for active contract status
- * @prop {string} STATUS_TERMINATED - constant for terminated contract status
- *
- * @method getPaymentDueDateAt
- * @param {Date} baseDate - base date in UTC (JST - 9 hours)
- * @returns {Date} payment due date in UTC (JST - 9 hours)
+ * CUSTOMER
  *****************************************************************************/
 export default class Customer extends GeocodableMixin(FireModel) {
   static className = "取引先";