@shisyamo4131/air-guard-v2-schemas 2.3.8-dev.2 → 2.4.1-dev.0

package/index.js

@@ -6,6 +6,7 @@ export { default as Company } from "./src/Company.js";
 export { default as Customer, CustomerMinimal } from "./src/Customer.js";
 export { default as CutoffDate } from "./src/utils/CutoffDate.js";
 export { default as Employee } from "./src/Employee.js";
+export { GeocodableMixin } from "./src/mixins/GeocodableMixin.js";
 export { default as OperationBilling } from "./src/OperationBilling.js";
 export { default as OperationResult } from "./src/OperationResult.js";
 export { default as OperationResultDetail } from "./src/OperationResultDetail.js";

package/package.json

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

package/src/Company.js

@@ -1,11 +1,12 @@
 /**
  * Company Model
- * @version 1.4.0
+ * @version 1.0.0
  * @author shisyamo4131
- * @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.
+ * @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.
  */
 import FireModel from "@shisyamo4131/air-firebase-v2";
 import { defField } from "./parts/fieldDefinitions.js";
@@ -13,6 +14,7 @@ import { defAccessor } from "./parts/accessorDefinitions.js";
 import Agreement from "./Agreement.js";
 import SiteOrder from "./SiteOrder.js";
 import RoundSetting from "./RoundSetting.js";
+import { GeocodableMixin } from "./mixins/GeocodableMixin.js";
 
 const classProps = {
   companyName: defField("name", { label: "会社名", required: true }),
@@ -120,7 +122,7 @@ const classProps = {
   maintenanceStartedBy: defField("oneLine", { default: null, hidden: true }),
 };
 
-export default class Company extends FireModel {
+export default class Company extends GeocodableMixin(FireModel) {
   static className = "会社";
   static collectionPath = "Companies";
   static usePrefix = false;
@@ -149,6 +151,25 @@ export default class Company extends FireModel {
         },
         set() {},
       },
+
+      // Check if all `required` fields are filled.
+      // Used for validating whether the Company info is complete.
+      isCompleteRequiredFields: {
+        enumerable: true,
+        configurable: true,
+        get() {
+          return !!(
+            this.companyName &&
+            this.companyNameKana &&
+            this.zipcode &&
+            this.prefCode &&
+            this.city &&
+            this.address &&
+            this.tel
+          );
+        },
+        set() {},
+      },
     });
 
     /*************************************************************************

package/src/Customer.js

@@ -14,6 +14,7 @@ import {
   CONTRACT_STATUS_VALUES,
   PAYMENT_MONTH_OPTIONS,
 } from "./constants/index.js";
+import { GeocodableMixin } from "./mixins/GeocodableMixin.js";
 
 const classProps = {
   code: defField("code", { label: "取引先コード" }),
@@ -82,7 +83,7 @@ const classProps = {
  * @param {Date} baseDate - base date in UTC (JST - 9 hours)
  * @returns {Date} payment due date in UTC (JST - 9 hours)
  *****************************************************************************/
-export default class Customer extends FireModel {
+export default class Customer extends GeocodableMixin(FireModel) {
   static className = "取引先";
   static collectionPath = "Customers";
   static useAutonumber = false;

package/src/Employee.js

@@ -9,6 +9,7 @@ import { defAccessor } from "./parts/accessorDefinitions.js";
 import { VALUES as EMPLOYMENT_STATUS_VALUES } from "./constants/employment-status.js";
 import { VALUES as BLOOD_TYPE_VALUES } from "./constants/blood-type.js";
 import Certification from "./Certification.js";
+import { GeocodableMixin } from "./mixins/GeocodableMixin.js";
 
 const classProps = {
   code: defField("code", { label: "従業員コード" }),
@@ -213,7 +214,7 @@ const classProps = {
  *
  * @function toTerminated - Change the current employee instance to terminated status.
  *****************************************************************************/
-export default class Employee extends FireModel {
+export default class Employee extends GeocodableMixin(FireModel) {
   static className = "従業員";
   static collectionPath = "Employees";
   static useAutonumber = false;

package/src/Site.js

@@ -18,6 +18,7 @@ import { defAccessor } from "./parts/accessorDefinitions.js";
 import Customer from "./Customer.js";
 import Agreement from "./Agreement.js";
 import { VALUES } from "./constants/site-status.js";
+import { GeocodableMixin } from "./mixins/GeocodableMixin.js";
 
 const classProps = {
   customerId: defField("customerId", {
@@ -99,7 +100,7 @@ const classProps = {
  * @param {Agreement} agreement - Agreement instance to remove.
  * @throws {Error} If agreement not found.
  *****************************************************************************/
-export default class Site extends FireModel {
+export default class Site extends GeocodableMixin(FireModel) {
   static className = "現場";
   static collectionPath = "Sites";
   static useAutonumber = false;

package/src/mixins/GeocodableMixin.js

@@ -0,0 +1,149 @@
+/**
+ * @file src/mixins/GeocodableMixin.js
+ * @description Geocoding 機能を提供する Mixin
+ */
+
+/**
+ * Geocoding 機能を提供する Mixin
+ * @param {Class} BaseClass - 継承元のクラス
+ * @returns {Class} Geocoding 機能を持つクラス
+ */
+export function GeocodableMixin(BaseClass) {
+  return class extends BaseClass {
+    /**
+     * Firestore 用のコンバーターを提供します。
+     * - location から geopoint を自動生成して Firestore に保存します。
+     * - toObject() は純粋なプレーンオブジェクトを返すため、コンポーネント側で安全に使用できます。
+     * @override
+     */
+    static converter() {
+      const superConverter = super.converter();
+      return {
+        toFirestore: (instance) => {
+          const obj = superConverter.toFirestore(instance);
+
+          // location から geopoint を生成
+          if (obj.location?.lat && obj.location?.lng) {
+            try {
+              const adapter = this.getAdapter();
+              const GeoPoint = adapter.GeoPoint;
+
+              if (GeoPoint) {
+                obj.geopoint = new GeoPoint(obj.location.lat, obj.location.lng);
+              }
+            } catch (error) {
+              console.warn(
+                `[${this.className}.converter] GeoPoint generation failed:`,
+                error
+              );
+              obj.geopoint = null;
+            }
+          } else {
+            obj.geopoint = null;
+          }
+
+          return obj;
+        },
+        fromFirestore: superConverter.fromFirestore,
+      };
+    }
+
+    /**
+     * 新しいドキュメントが作成される前に `location` を取得してセットします。
+     * @param {Object} args - Creation options.
+     * @param {boolean} [args.skipGeocoding=false] - Skip geocoding process.
+     * @returns {Promise<void>}
+     */
+    async beforeCreate(args = {}) {
+      await super.beforeCreate(args);
+
+      if (!args.skipGeocoding) {
+        await this._geocodeAndSetLocation("beforeCreate");
+      }
+    }
+
+    /**
+     * ドキュメントが更新される前に `location` を取得してセットします。
+     * 住所に変更がない場合はジオコーディングをスキップします。
+     * @param {Object} args - Update options.
+     * @param {boolean} [args.skipGeocoding=false] - Skip geocoding process.
+     * @returns {Promise<void>}
+     */
+    async beforeUpdate(args = {}) {
+      await super.beforeUpdate(args);
+
+      const currentFullAddress = this.fullAddress;
+      const previousFullAddress = this._beforeData?.fullAddress;
+
+      // 住所に変更がない場合、またはskipGeocodingがtrueの場合はスキップ
+      if (
+        args.skipGeocoding ||
+        (this._beforeData && currentFullAddress === previousFullAddress)
+      ) {
+        return;
+      }
+
+      await this._geocodeAndSetLocation("beforeUpdate");
+    }
+
+    /**
+     * ジオコーディング処理
+     * fullAddress から緯度・経度・正規化された住所を取得し、location に設定
+     * @private
+     * @param {string} context - 呼び出し元のコンテキスト（'beforeCreate' | 'beforeUpdate'）
+     */
+    async _geocodeAndSetLocation(context) {
+      const address = this.fullAddress;
+
+      if (!address || address.trim() === "") {
+        this.location = null;
+        return;
+      }
+
+      if (!GeocodableMixin._geocodingFunction) {
+        console.warn(
+          `[${this.constructor.className}.${context}] Geocoding function not set. Skipping geocoding.`
+        );
+        this.location = null;
+        return;
+      }
+
+      try {
+        const coordinates = await GeocodableMixin._geocodingFunction(address);
+
+        if (coordinates && coordinates.lat && coordinates.lng) {
+          this.location = {
+            formattedAddress: coordinates.formattedAddress || address,
+            lat: coordinates.lat,
+            lng: coordinates.lng,
+          };
+        } else {
+          this.location = null;
+        }
+      } catch (error) {
+        console.warn(
+          `[${this.constructor.className}.${context}] Geocoding failed:`,
+          error
+        );
+        this.location = null;
+      }
+    }
+  };
+}
+
+/**
+ * Geocoding 処理を行う関数（外部から注入）
+ * @type {Function|null}
+ * @static
+ */
+GeocodableMixin._geocodingFunction = null;
+
+/**
+ * Geocoding 関数を設定します。
+ * すべての GeocodableMixin を継承したクラスで共有されます。
+ * @param {Function} fn - 住所文字列を受け取り、{ lat, lng, formattedAddress } を返す非同期関数
+ * @static
+ */
+GeocodableMixin.setGeocodingFunction = function (fn) {
+  GeocodableMixin._geocodingFunction = fn;
+};