@shisyamo4131/air-guard-v2-schemas 1.0.0

package/src/Company.js

@@ -0,0 +1,176 @@
+/*****************************************************************************
+ * Company Model ver 1.0.0
+ * @author shisyamo4131
+ *****************************************************************************/
+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 SiteOrder from "./SiteOrder.js";
+import RoundSetting from "./RoundSetting.js";
+
+const classProps = {
+  companyName: defField("name", { label: "会社名", required: true }),
+  companyNameKana: defField("nameKana", {
+    label: "会社名（カナ）",
+    required: true,
+  }),
+  /** 以下、管理者アカウント作成時に未入力状態で作成されるため required は未定義とする */
+  zipcode: defField("zipcode"),
+  prefCode: defField("prefCode"),
+  city: defField("city"),
+  address: defField("address"),
+  building: defField("building"),
+  location: defField("location", { hidden: true }),
+  tel: defField("tel"),
+  fax: defField("fax"),
+  agreements: defField("array", {
+    label: "既定の取極め",
+    customClass: Agreement,
+  }),
+  /**
+   * Field to manage the display order of site-shift type pairs for placement management.
+   * Format: { siteId, shiftType }
+   */
+  siteOrder: defField("array", {
+    customClass: SiteOrder,
+    hidden: true,
+  }),
+  /**
+   * Interval in minutes used for VTimePicker's allowed-minutes.
+   */
+  minuteInterval: defField("number", {
+    label: "時刻選択間隔（分）",
+    default: 15,
+    component: {
+      name: "air-number-input",
+      attrs: {
+        controlVariant: "split",
+        min: 1,
+        max: 30,
+        hint: "1〜30分の範囲で指定してください",
+        persistentHint: true,
+      },
+    },
+  }),
+  roundSetting: defField("select", {
+    label: "端数処理",
+    default: RoundSetting.ROUND,
+    component: {
+      name: "air-select",
+      attrs: {
+        items: RoundSetting.ITEMS,
+        hint: "売上金額や消費税の端数処理をどのように行うかを設定します。",
+        persistentHint: true,
+      },
+    },
+  }),
+};
+
+export default class Company extends FireModel {
+  static className = "会社";
+  static collectionPath = "Companies";
+  static useAutonumber = false;
+  static logicalDelete = false;
+  static classProps = classProps;
+
+  // Override `afterInitialize` to define computed properties.
+  afterInitialize() {
+    Object.defineProperties(this, {
+      fullAddress: defAccessor("fullAddress"),
+      prefecture: defAccessor("prefecture"),
+    });
+
+    /*************************************************************************
+     * CUSTOM METHODS FOR siteOrder ARRAY
+     * Note: These methods modify the siteOrder array directly.
+     * The Company instance itself is not updated by these methods.
+     * Use the provided public methods to interact with siteOrder.
+     *************************************************************************/
+    Object.defineProperties(this.siteOrder, {
+      /**
+       * Inserts a new SiteOrder into the `siteOrder` array.
+       * @param {Object} params - The parameters for the SiteOrder.
+       * @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 SiteOrder. Defaults to the end.
+       * @returns {SiteOrder} The newly created SiteOrder instance.
+       * @throws {Error} If a SiteOrder with the same key already exists.
+       */
+      add: {
+        value: function ({ siteId, shiftType }, index = -1) {
+          const newOrder = new SiteOrder({ siteId, shiftType });
+          if (this.some((order) => order.key === newOrder.key)) {
+            throw new Error(
+              `SiteOrder 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 SiteOrder in the siteOrder array.
+       * Note: Company instance does not be updated by this method.
+       * @param {number} oldIndex - The current index of the SiteOrder.
+       * @param {number} newIndex - The new index to move the SiteOrder 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 SiteOrder from the siteOrder array.
+       * Note: Company instance does not be updated by this method.
+       * @param {string|Object} arg - The key or {siteId, shiftType} of the SiteOrder to remove.
+       * @returns {void}
+       * @throws {Error} If the SiteOrder 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(`SiteOrder with key ${key} does not exist.`);
+          }
+
+          this.splice(index, 1);
+        },
+        writable: false,
+        enumerable: false,
+        configurable: true,
+      },
+    });
+  }
+
+  /***************************************************************************
+   * PUBLIC METHODS
+   ***************************************************************************/
+}

package/src/Customer.js

@@ -0,0 +1,98 @@
+/*****************************************************************************
+ * Customer ver 1.0.0
+ * @author shisyamo4131
+ *
+ * @description Customer model.
+ * @hasMany Sites - related sites associated with the customer
+ *
+ * @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 {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 {string} STATUS_ACTIVE - constant for active contract status
+ * @prop {string} STATUS_TERMINATED - constant for terminated contract status
+ *****************************************************************************/
+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";
+
+const classProps = {
+  code: defField("code", { label: "取引先コード" }),
+  name: defField("name", { label: "取引先名", required: true }),
+  nameKana: defField("nameKana", { label: "取引先名（カナ）", required: true }),
+  zipcode: defField("zipcode", { required: true }),
+  prefCode: defField("prefCode", { required: true }),
+  city: defField("city", { required: true }),
+  address: defField("address", { required: true }),
+  building: defField("building"),
+  location: defField("location", { hidden: true }),
+  tel: defField("tel", { colsDefinition: { cols: 12, sm: 6 } }),
+  fax: defField("fax", { colsDefinition: { cols: 12, sm: 6 } }),
+  contractStatus: defField("contractStatus", { required: true }),
+  remarks: defField("multipleLine", { label: "備考" }),
+};
+
+export default class Customer extends FireModel {
+  static className = "取引先";
+  static collectionPath = "Customers";
+  static useAutonumber = false;
+  static logicalDelete = true;
+  static classProps = classProps;
+  static tokenFields = ["name", "nameKana"];
+  static hasMany = [
+    {
+      collectionPath: "Sites",
+      field: "customerId",
+      condition: "==",
+      type: "collection",
+    },
+  ];
+
+  static headers = [
+    { key: "code", title: "取引先コード" },
+    { key: "name", title: "取引先名" },
+    { key: "fullAddress", title: "所在地" },
+  ];
+
+  static STATUS_ACTIVE = VALUES.ACTIVE.value;
+  static STATUS_TERMINATED = VALUES.TERMINATED.value;
+
+  afterInitialize(item = {}) {
+    super.afterInitialize(item);
+    Object.defineProperties(this, {
+      fullAddress: defAccessor("fullAddress"),
+      prefecture: defAccessor("prefecture"),
+    });
+  }
+}
+
+/*****************************************************************************
+ * A minimal version of the Customer model with non-essential fields removed for
+ * lightweight data handling.
+ *****************************************************************************/
+export class CustomerMinimal extends Customer {
+  afterInitialize() {
+    super.afterInitialize();
+    delete this.remarks;
+    delete this.tokenMap;
+    delete this.uid;
+    delete this.createdAt;
+    delete this.updatedAt;
+  }
+}

package/src/Employee.js

@@ -0,0 +1,201 @@
+/**
+ * @file src/Employee.js
+ * @author shisyamo4131
+ * @version 1.0.0
+ */
+import FireModel from "@shisyamo4131/air-firebase-v2";
+import { defField } from "./parts/fieldDefinitions.js";
+import { defAccessor } from "./parts/accessorDefinitions.js";
+import { VALUES } from "./constants/employment-status.js";
+
+const classProps = {
+  code: defField("code", { label: "従業員コード" }),
+  lastName: defField("lastName", { required: true }),
+  firstName: defField("firstName", { required: true }),
+  lastNameKana: defField("lastNameKana", { required: true }),
+  firstNameKana: defField("firstNameKana", { required: true }),
+  displayName: defField("displayName", { required: true }),
+  title: defField("oneLine", { label: "肩書", required: true }),
+  gender: defField("gender", { required: true }),
+  dateOfBirth: defField("dateAt", { label: "生年月日", required: true }),
+  zipcode: defField("zipcode", { required: true }),
+  prefCode: defField("prefCode", { required: true }),
+  city: defField("city", { required: true }),
+  address: defField("address", { required: true }),
+  building: defField("building"),
+  location: defField("location", { hidden: true }), // 非表示でOK
+  dateOfHire: defField("dateAt", { label: "入社日", required: true }),
+  employmentStatus: defField("employmentStatus", { required: true }),
+  dateOfTermination: defField("dateAt", {
+    label: "退職日",
+    component: {
+      attrs: {
+        required: (item) => item.employmentStatus === "terminated",
+      },
+    },
+  }),
+  isForeigner: defField("isForeigner"),
+  foreignName: defField("foreignName", {
+    component: {
+      attrs: {
+        required: (item) => item.isForeigner,
+      },
+    },
+  }),
+  nationality: defField("nationality", {
+    component: {
+      attrs: {
+        required: (item) => item.isForeigner,
+      },
+    },
+  }),
+  residenceStatus: {
+    type: String,
+    default: null,
+    label: "在留資格",
+    required: undefined,
+    component: {
+      name: "air-text-field",
+      attrs: {
+        required: (item) => item.isForeigner,
+      },
+    },
+  },
+  periodOfStay: defField("dateAt", {
+    label: "在留期間満了日",
+    component: {
+      attrs: {
+        required: (item) => item.isForeigner,
+      },
+    },
+  }),
+  remarks: defField("multipleLine", { label: "備考" }),
+};
+
+/*****************************************************************************
+ * Employee Model
+ * @props {string} code - Employee code.
+ * @props {string} lastName - Last name.
+ * @props {string} firstName - First name.
+ * @props {string} lastNameKana - Last name in Kana.
+ * @props {string} firstNameKana - First name in Kana.
+ * @props {string} displayName - Display name.
+ * @props {string} title - Job title.
+ * @props {string} gender - Gender.
+ * @props {Date} dateOfBirth - Date of birth.
+ * @props {string} zipcode - Postal code.
+ * @props {string} prefCode - Prefecture code.
+ * @props {string} city - City name.
+ * @props {string} address - Address details.
+ * @props {string} building - Building name.
+ * @props {object} location - Geographical location.
+ * @props {Date} dateOfHire - Date of hire.
+ * @props {string} employmentStatus - Employment status.
+ * @props {Date} dateOfTermination - Date of termination.
+ * @props {boolean} isForeigner - Is the employee a foreigner.
+ * @props {string} foreignName - Foreign name.
+ * @props {string} nationality - Nationality.
+ * @props {string} residenceStatus - Residence status.
+ * @props {Date} periodOfStay - Period of stay expiration date.
+ * @props {string} remarks - Additional remarks.
+ * @computed {string} fullName - Full name combining last and first names (read-only)
+ * @computed {string} fullAddress - Full address combining prefecture, city, and address (read-only)
+ * @computed {string} prefecture - Prefecture name derived from `prefCode` (read-only)
+ *****************************************************************************/
+export default class Employee extends FireModel {
+  static className = "従業員";
+  static collectionPath = "Employees";
+  static useAutonumber = false;
+  static logicalDelete = true;
+  static classProps = classProps;
+  static tokenFields = [
+    "lastName",
+    "firstName",
+    "lastNameKana",
+    "firstNameKana",
+    "foreignName",
+    "displayName",
+  ];
+
+  static headers = [
+    { title: "code", key: "code" },
+    { title: "名前", key: "fullName" },
+  ];
+
+  static STATUS_ACTIVE = VALUES.ACTIVE.value;
+  static STATUS_TERMINATED = VALUES.TERMINATED.value;
+
+  afterInitialize(item = {}) {
+    super.afterInitialize(item);
+    Object.defineProperties(this, {
+      fullName: defAccessor("fullName"),
+      fullAddress: defAccessor("fullAddress"),
+      prefecture: defAccessor("prefecture"),
+    });
+  }
+
+  /**
+   * 外国籍の場合の必須フィールドを検証します。
+   * エラーがある場合は例外をスローします。
+   */
+  _validateForeignerRequiredFields() {
+    if (this.isForeigner) {
+      if (!this.foreignName) {
+        throw new Error(
+          "[Employee.js] foreignName is required when isForeigner is true."
+        );
+      }
+      if (!this.nationality) {
+        throw new Error(
+          "[Employee.js] nationality is required when isForeigner is true."
+        );
+      }
+      if (!this.residenceStatus) {
+        throw new Error(
+          "[Employee.js] residenceStatus is required when isForeigner is true."
+        );
+      }
+      if (!this.periodOfStay) {
+        throw new Error(
+          "[Employee.js] periodOfStay is required when isForeigner is true."
+        );
+      }
+    }
+  }
+
+  /**
+   * 退職済である場合の必須フィールドを検証します。
+   * エラーがある場合は例外をスローします。
+   */
+  _validateTerminatedRequiredFields() {
+    if (this.employmentStatus === "terminated") {
+      if (!this.dateOfTermination) {
+        throw new Error(
+          "[Employee.js] dateOfTermination is required when employmentStatus is 'terminated'."
+        );
+      }
+    }
+  }
+
+  /**
+   * 新しい従業員ドキュメントが作成される前に実行されるフック。
+   * - 親クラスの `beforeCreate` を呼び出します。
+   * - 従業員が外国人の場合、外国人名と国籍が未入力であればエラーをスローします。
+   */
+  async beforeCreate() {
+    await super.beforeCreate();
+    this._validateForeignerRequiredFields();
+    this._validateTerminatedRequiredFields();
+  }
+
+  /**
+   * 従業員ドキュメントが更新される前に実行されるフック。
+   * - 親クラスの `beforeUpdate` を呼び出します。
+   * - 従業員が外国人の場合、外国人名と国籍が未入力であればエラーをスローします。
+   */
+  async beforeUpdate() {
+    await super.beforeUpdate();
+    this._validateForeignerRequiredFields();
+    this._validateTerminatedRequiredFields();
+  }
+}