@shisyamo4131/air-guard-v2-schemas 2.4.2-dev.9 → 2.4.2-dev.91

package/src/errorDefinitions.js

@@ -0,0 +1,173 @@
+/**
+ * バリデーションエラー定義
+ * - validator がオブジェクト形式でエラーを返す際に使用します。
+ * - 各エラーは関数として定義され、動的なパラメータを受け取ります。
+ *
+ * 返却値の形式:
+ * {
+ *   code: 'ERROR_CODE',           // エラーコード
+ *   message: 'English message',    // 英語メッセージ（デフォルト言語）
+ *   messages: {                    // その他の言語のメッセージ
+ *     ja: '日本語メッセージ'
+ *   }
+ * }
+ *
+ * 使用例:
+ * ```javascript
+ * import { VALIDATION_ERRORS } from './errorDefinitions.js';
+ *
+ * validator: (v) => {
+ *   const minValue = 0;
+ *   if (v < minValue) {
+ *     return VALIDATION_ERRORS.MIN_VALUE_ERROR(minValue);
+ *   }
+ *   return true;
+ * }
+ * ```
+ */
+
+export const VALIDATION_ERRORS = {
+  /**
+   * 最小値エラー
+   * @param {number} minValue - 最小値
+   * @returns {Object} エラーオブジェクト
+   */
+  MIN_VALUE_ERROR: (minValue) => ({
+    code: "MIN_VALUE_ERROR",
+    message: `Please enter a value of ${minValue} or more.`,
+    messages: {
+      ja: `${minValue}以上の値を入力してください。`,
+    },
+  }),
+
+  /**
+   * 最大値エラー
+   * @param {number} maxValue - 最大値
+   * @returns {Object} エラーオブジェクト
+   */
+  MAX_VALUE_ERROR: (maxValue) => ({
+    code: "MAX_VALUE_ERROR",
+    message: `Please enter a value of ${maxValue} or less.`,
+    messages: {
+      ja: `${maxValue}以下の値を入力してください。`,
+    },
+  }),
+
+  /**
+   * 範囲エラー
+   * @param {number} minValue - 最小値
+   * @param {number} maxValue - 最大値
+   * @returns {Object} エラーオブジェクト
+   */
+  RANGE_ERROR: (minValue, maxValue) => ({
+    code: "RANGE_ERROR",
+    message: `Please enter a value between ${minValue} and ${maxValue}.`,
+    messages: {
+      ja: `${minValue}以上${maxValue}以下の値を入力してください。`,
+    },
+  }),
+
+  /**
+   * 最小文字数エラー
+   * @param {number} minLength - 最小文字数
+   * @returns {Object} エラーオブジェクト
+   */
+  MIN_LENGTH_ERROR: (minLength) => ({
+    code: "MIN_LENGTH_ERROR",
+    message: `Please enter at least ${minLength} characters.`,
+    messages: {
+      ja: `${minLength}文字以上で入力してください。`,
+    },
+  }),
+
+  /**
+   * 最大文字数エラー
+   * @param {number} maxLength - 最大文字数
+   * @returns {Object} エラーオブジェクト
+   */
+  MAX_LENGTH_ERROR: (maxLength) => ({
+    code: "MAX_LENGTH_ERROR",
+    message: `Please enter ${maxLength} characters or less.`,
+    messages: {
+      ja: `${maxLength}文字以内で入力してください。`,
+    },
+  }),
+
+  /**
+   * パターン不一致エラー
+   * @param {string} pattern - パターン名（例: 'email', 'phone'）
+   * @returns {Object} エラーオブジェクト
+   */
+  PATTERN_ERROR: (pattern) => ({
+    code: "PATTERN_ERROR",
+    message: `Please enter a valid ${pattern} format.`,
+    messages: {
+      ja: `正しい${pattern}の形式で入力してください。`,
+    },
+  }),
+
+  /**
+   * 必須エラー（カスタムメッセージ用）
+   * @param {string} fieldName - フィールド名
+   * @returns {Object} エラーオブジェクト
+   */
+  REQUIRED_FIELD_ERROR: (fieldName) => ({
+    code: "REQUIRED_FIELD_ERROR",
+    message: `${fieldName} is required.`,
+    messages: {
+      ja: `${fieldName}は必須です。`,
+    },
+  }),
+
+  /**
+   * 日付範囲エラー
+   * @param {string} startDate - 開始日
+   * @param {string} endDate - 終了日
+   * @returns {Object} エラーオブジェクト
+   */
+  DATE_RANGE_ERROR: (startDate, endDate) => ({
+    code: "DATE_RANGE_ERROR",
+    message: `Please select a date between ${startDate} and ${endDate}.`,
+    messages: {
+      ja: `${startDate}から${endDate}の間の日付を選択してください。`,
+    },
+  }),
+
+  /**
+   * 日付順序エラー
+   * @returns {Object} エラーオブジェクト
+   */
+  DATE_ORDER_ERROR: () => ({
+    code: "DATE_ORDER_ERROR",
+    message: "Start date must be before end date.",
+    messages: {
+      ja: "開始日は終了日より前である必要があります。",
+    },
+  }),
+
+  /**
+   * 重複エラー
+   * @param {string} fieldName - フィールド名
+   * @returns {Object} エラーオブジェクト
+   */
+  DUPLICATE_ERROR: (fieldName) => ({
+    code: "DUPLICATE_ERROR",
+    message: `${fieldName} is already registered.`,
+    messages: {
+      ja: `${fieldName}は既に登録されています。`,
+    },
+  }),
+
+  /**
+   * カスタムエラー（汎用）
+   * @param {string} code - エラーコード
+   * @param {string} message - 英語メッセージ
+   * @param {Object} messages - 多言語メッセージオブジェクト（例: { ja: '日本語メッセージ' }）
+   * @returns {Object} エラーオブジェクト
+   */
+  CUSTOM_ERROR: (code, message, messages) => ({
+    code,
+    message,
+    messages,
+  }),
+};

package/src/parts/fieldDefinitions/array.js

@@ -0,0 +1,50 @@
+import { generalDefinitions } from "./defaultDefinition.js";
+
+/**
+ * ARRAY型のフィールド定義
+ * {
+ *   type: Array,
+ *   default: () => [],
+ *   label: undefined,
+ *   length: undefined,
+ *   required: undefined,
+ *   hidden: undefined,
+ *   validator: undefined,
+ *   component: { name: "air-select", attrs: { multiple: true } },
+ * }
+ */
+export const arrayFields = {
+  array: generalDefinitions.array,
+
+  /**
+   * FCM トークン
+   * Firebase Cloud Messaging (FCM) のトークンを格納するフィールド定義
+   */
+  fcmTokens: {
+    ...generalDefinitions.array,
+    label: "FCMトークン",
+    required: false,
+    hidden: true,
+  },
+
+  /**
+   * アプリケーション利用権限用配列フィールド定義
+   */
+  roles: {
+    ...generalDefinitions.array,
+    label: "権限",
+    required: false,
+    hidden: false,
+  },
+
+  /**
+   * 通知の送信先ユーザーID配列
+   * Notification ドキュメントで使用
+   */
+  recipientUserIds: {
+    ...generalDefinitions.array,
+    label: "送信先ユーザーID",
+    required: false,
+    hidden: true,
+  },
+};

package/src/parts/fieldDefinitions/check.js

@@ -0,0 +1,53 @@
+import { generalDefinitions } from "./defaultDefinition.js";
+
+/**
+ * CHECK型のフィールド定義
+ * {
+ *   type: Boolean,
+ *   default: false,
+ *   label: undefined,
+ *   length: undefined,
+ *   required: undefined,
+ *   hidden: undefined,
+ *   validator: undefined,
+ *   component: { name: "air-checkbox", attrs: {} },
+ * }
+ */
+export const checkFields = {
+  check: generalDefinitions.check,
+
+  /**
+   * 使用不可を表すフィールド定義
+   * - `label` や他の定義は利用先において定義変更すること。
+   */
+  disabled: {
+    ...generalDefinitions.check,
+    label: "使用不可",
+  },
+
+  hasPeriodOfStayLimit: {
+    ...generalDefinitions.check,
+    label: "在留期間制限",
+  },
+  hasWorkRestrictions: {
+    ...generalDefinitions.check,
+    label: "就労制限",
+  },
+
+  /** 管理者かどうか */
+  isAdmin: {
+    ...generalDefinitions.check,
+    label: "管理者",
+  },
+
+  isForeigner: {
+    ...generalDefinitions.check,
+    label: "外国籍",
+  },
+
+  /** 仮登録 */
+  isTemporary: {
+    ...generalDefinitions.check,
+    label: "仮登録",
+  },
+};

package/src/parts/fieldDefinitions/code.js

@@ -0,0 +1,8 @@
+import { generalDefinitions } from "./defaultDefinition.js";
+
+/**
+ * CODE型のフィールド定義
+ */
+export const codeFields = {
+  code: generalDefinitions.code,
+};

package/src/parts/fieldDefinitions/constants.js

@@ -0,0 +1,9 @@
+/**
+ * フィールド定義で使用する定数
+ */
+
+export const DEFAULT_WORKING_MINUTES = 480;
+export const DEFAULT_BREAK_MINUTES = 60;
+export const MINUTES_PER_HOUR = 60;
+export const MINUTES_PER_QUARTER_HOUR = 15;
+export const MAX_SCHEDULED_WORKING_MINUTES = 480; // 8時間 * 60分

package/src/parts/fieldDefinitions/dateAt.js

@@ -0,0 +1,63 @@
+import { generalDefinitions } from "./defaultDefinition.js";
+
+/**
+ * DATE AT型のフィールド定義
+ */
+export const dateAtFields = {
+  dateAt: generalDefinitions.dateAt,
+  dateOfBirth: {
+    ...generalDefinitions.dateAt,
+    label: "生年月日",
+    default: null, // 2025-12-26 Set default to null
+    component: {
+      ...generalDefinitions.dateAt.component,
+      attrs: {
+        viewMode: "year", // 2025-12-26 Added
+      },
+    },
+  },
+  dateOfHire: {
+    ...generalDefinitions.dateAt,
+    label: "入社日",
+  },
+  // 2025-12-26 Added
+  dateOfSecurityGuardRegistration: {
+    ...generalDefinitions.dateAt,
+    label: "警備員登録日",
+    default: null,
+  },
+  dateOfTermination: {
+    ...generalDefinitions.dateAt,
+    label: "退職日",
+    default: null, // 2025-12-26 Set default to null
+  },
+  enrollmentDateAt: {
+    ...generalDefinitions.dateAt,
+    label: "資格取得日",
+    default: null,
+  },
+  // 2025-12-26 Added
+  expirationDateAt: {
+    ...generalDefinitions.dateAt,
+    label: "有効期限",
+    default: null,
+  },
+  issueDateAt: {
+    ...generalDefinitions.dateAt,
+    label: "取得日",
+  },
+  lossDateAt: {
+    ...generalDefinitions.dateAt,
+    label: "資格喪失日",
+    default: null,
+  },
+  notificationSentAt: {
+    ...generalDefinitions.dateAt,
+    label: "通知送信日時",
+    default: null,
+  },
+  periodOfStay: {
+    ...generalDefinitions.dateAt,
+    label: "在留期間満了日",
+  },
+};

package/src/parts/fieldDefinitions/dateTimeAt.js

@@ -0,0 +1,8 @@
+import { generalDefinitions } from "./defaultDefinition.js";
+
+/**
+ * DATE TIME AT型のフィールド定義
+ */
+export const dateTimeAtFields = {
+  dateTimeAt: generalDefinitions.dateTimeAt,
+};

package/src/parts/fieldDefinitions/defaultDefinition.js

@@ -0,0 +1,118 @@
+/**
+ * フィールド定義のデフォルト値
+ * - `air-firebase` が提供する `FireModel (BaseClass)` において、クラスが保有するフィールドの定義および値の検証に使用されます。
+ * - `component` プロパティは `air-vuetify` の入力コンポーネント生成の為の属性として使用されます。
+ *   但し、required, label, hidden, length は入力コンポーネントの属性としても使用されます。
+ * - `validator` の返り値は原則オブジェクトです。文字列を返すこともでき、その文字列がエラーメッセージとして扱われますが多言語対応のためには
+ *   オブジェクトを返すことを推奨します。
+ *   返り値が true/false の場合は、従来通りのバリデーション結果として扱われます。
+ * @key {String|Number|Boolean|Object|Array|Date} type - データの型
+ * @key {any} default - 既定値
+ * @key {String} label - フィールドのラベル
+ * @key {Number} length - 入力可能な最大文字数（文字列型の場合）
+ * @key {Boolean} required - 入力必須かどうか
+ * @key {Boolean} hidden - フィールドをUI上で非表示にするかどうか
+ * @key {Function} validator - フィールドの値を検証する関数。引数に値を取り、エラーメッセージを返すか、true/falseで検証結果を返す。
+ * @key {Object} component - フィールドに対応するUIコンポーネントの定義
+ * @key {String} component.name - 使用するコンポーネントの名前（AirVuetifyコンポーネントのみ指定可能）
+ * @key {Object} component.attrs - コンポーネントに渡す属性の定義
+ */
+export const defaultDefinition = {
+  type: String,
+  default: null,
+  label: undefined,
+  length: undefined,
+  required: undefined,
+  hidden: undefined,
+  validator: undefined,
+  component: {
+    name: undefined,
+    attrs: {},
+  },
+};
+
+/** 汎用パーツ */
+export const generalDefinitions = {
+  array: {
+    ...defaultDefinition,
+    type: Array,
+    default: () => [],
+    component: { name: "air-select", attrs: { multiple: true } },
+  },
+  check: {
+    ...defaultDefinition,
+    type: Boolean,
+    default: false,
+    component: { name: "air-checkbox", attrs: {} },
+  },
+  code: {
+    ...defaultDefinition,
+    length: 10,
+    component: { name: "air-text-field", attrs: { inputType: "alphanumeric" } },
+  },
+  // 日付（00時固定としたDateオブジェクトとして使用する）
+  dateAt: {
+    ...defaultDefinition,
+    type: Object,
+    label: "日付",
+    default: () => {
+      const date = new Date();
+      date.setHours(0, 0, 0, 0);
+      return date;
+    },
+    component: {
+      name: "air-date-input",
+    },
+  },
+  // 日時（時刻までを含んだDateオブジェクト）
+  dateTimeAt: {
+    ...defaultDefinition,
+    type: Object,
+    label: "日時",
+    default: null,
+    component: { name: "air-date-time-picker-input", attrs: {} },
+  },
+  multipleLine: {
+    ...defaultDefinition,
+    length: 200,
+    component: {
+      name: "air-textarea",
+      attrs: { counter: true, maxlength: 200 },
+    },
+  },
+  number: {
+    ...defaultDefinition,
+    type: Number,
+    component: {
+      name: "air-number-input",
+      attrs: {
+        controlVariant: "split",
+      },
+    },
+  },
+  object: {
+    ...defaultDefinition,
+    type: Object,
+    component: { name: "air-select" }, // `AirTextField` that is used as default ui component could not handle object type.
+  },
+  oneLine: {
+    ...defaultDefinition,
+    component: { name: "air-text-field", attrs: {} },
+  },
+  radio: {
+    ...defaultDefinition,
+    component: { name: "air-radio-group", attrs: {} },
+  },
+  select: {
+    ...defaultDefinition,
+    component: { name: "air-select", attrs: {} },
+  },
+  // 時刻文字列
+  time: {
+    ...defaultDefinition,
+    label: "時刻",
+    component: {
+      name: "air-time-picker-input",
+    },
+  },
+};

package/src/parts/fieldDefinitions/multipleLine.js

@@ -0,0 +1,16 @@
+import { generalDefinitions } from "./defaultDefinition.js";
+
+/**
+ * MULTIPLE LINE型のフィールド定義
+ */
+export const multipleLineFields = {
+  multipleLine: generalDefinitions.multipleLine,
+  notificationError: {
+    ...generalDefinitions.multipleLine,
+    label: "通知送信エラー",
+  },
+  remarks: {
+    ...generalDefinitions.multipleLine,
+    label: "備考",
+  },
+};

package/src/parts/fieldDefinitions/number.js

@@ -0,0 +1,69 @@
+import { generalDefinitions } from "./defaultDefinition.js";
+import { DEFAULT_BREAK_MINUTES, DEFAULT_WORKING_MINUTES } from "./constants.js";
+import { VALIDATION_ERRORS } from "../../errorDefinitions.js";
+
+/**
+ * NUMBER型のフィールド定義
+ */
+export const numberFields = {
+  number: generalDefinitions.number,
+  breakMinutes: {
+    ...generalDefinitions.number,
+    label: "休憩時間（分）",
+    default: DEFAULT_BREAK_MINUTES,
+    validator: (v) => {
+      if (v < 0) {
+        return VALIDATION_ERRORS.MIN_VALUE_ERROR(0);
+      }
+      return true;
+    },
+    component: {
+      ...generalDefinitions.number.component,
+      attrs: {
+        ...generalDefinitions.number.component.attrs,
+        min: 0,
+      },
+    },
+  },
+  overtimeWorkMinutes: {
+    ...generalDefinitions.number,
+    label: "残業時間（分）",
+    default: 0,
+    validator: (v) => {
+      if (v < 0) {
+        return VALIDATION_ERRORS.MIN_VALUE_ERROR(0);
+      }
+      return true;
+    },
+    component: {
+      ...generalDefinitions.number.component,
+      attrs: {
+        ...generalDefinitions.number.component.attrs,
+        min: 0,
+      },
+    },
+  },
+  regulationWorkMinutes: {
+    ...generalDefinitions.number,
+    label: "規定実働時間（分）",
+    default: DEFAULT_WORKING_MINUTES,
+    validator: (v) => {
+      if (v < 0) {
+        return VALIDATION_ERRORS.MIN_VALUE_ERROR(0);
+      }
+      return true;
+    },
+    component: {
+      ...generalDefinitions.number.component,
+      attrs: {
+        ...generalDefinitions.number.component.attrs,
+        min: 0,
+        persistentHint: true,
+        hint: "この時間を超えると残業扱いになります。",
+      },
+    },
+  },
+  price: {
+    ...generalDefinitions.number,
+  },
+};

package/src/parts/fieldDefinitions/object.js

@@ -0,0 +1,38 @@
+import { generalDefinitions } from "./defaultDefinition.js";
+
+/**
+ * OBJECT型のフィールド定義
+ */
+export const objectFields = {
+  object: generalDefinitions.object,
+  customer: {
+    ...generalDefinitions.object,
+    label: "取引先",
+    component: {
+      name: "air-autocomplete-api",
+      attrs: {
+        cacheItems: true,
+        clearable: true,
+        itemTitle: "name",
+        itemValue: "docId",
+        returnObject: true,
+      },
+    },
+  },
+  employmentInsurance: {
+    ...generalDefinitions.object,
+    label: "雇用保険",
+  },
+  healthInsurance: {
+    ...generalDefinitions.object,
+    label: "健康保険",
+  },
+  pensionInsurance: {
+    ...generalDefinitions.object,
+    label: "厚生年金保険",
+  },
+  location: {
+    ...generalDefinitions.object,
+    hidden: true,
+  },
+};