ch3chi-commons-vue 1.8.0 → 1.8.1

package/src/stores/VueSessionStoreInstaller.ts

@@ -0,0 +1,22 @@
+import { App } from 'vue';
+import HasPermission from '../components/HasPermission.vue';
+import { SESSION_STORE_KEY } from '../auth/keys';
+import { UserSessionActions } from './ViewStore';
+import {createPermissionDirectives} from "../directive/PermissionDirective";
+
+/**
+ * VueSessionStoreInstaller 是一個 Vue 插件，用於全域註冊與提供使用者會話相關的功能。
+ * 它會將傳入的 sessionStore 實例注入到 Vue 應用中，並註冊一個權限檢查的組件和指令。
+ */
+export default {
+  install(app: App, options: { sessionStore: UserSessionActions }) {
+    // 1. 全域提供 sessionStore 實例
+    app.provide(SESSION_STORE_KEY, options.sessionStore);
+
+    // 2. 註冊全域組件
+    app.component('HasPermission', HasPermission);
+
+    // 3. (選配) 如果你也想保留指令版，也可以在這裡一起註冊
+    app.directive('permission', createPermissionDirectives(options));
+  }
+};

package/src/types/turnstile.d.ts

@@ -0,0 +1,8 @@
+interface Turnstile {
+  render: (el: HTMLElement, options: { sitekey: string, callback: (token: string) => void }) => void;
+  // 根據實際 API 補充其他方法
+}
+
+interface Window {
+  turnstile?: Turnstile;
+}

package/src/utils/CToolUtils.ts

@@ -0,0 +1,133 @@
+import dayjs from "dayjs";
+import _ from "lodash";
+import * as yup from "yup";
+
+/**
+ * 空函式
+ */
+export const voidFunction = () => {}
+
+/**
+ * 延遲指定毫秒數
+ * @param ms 毫秒數
+ */
+export const delay = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
+
+/**
+ * 從 params 中挑選有值的屬性並指派到 payload 中
+ * @param payload
+ * @param params
+ */
+export const pickAndAssign = (payload: Record<string, any>, params: Record<string, any>) =>
+  _.assign(payload, _.pickBy(params, _.identity));
+
+/**
+ * 寫入 Vue ref 物件的值
+ * @param refObj
+ * @param value
+ */
+export const writeVueRefValue = (refObj: any, value: any) => {
+  if(_.isNil(refObj) || !('value' in refObj)) {
+    return;
+  }
+  refObj.value = value;
+}
+
+/**
+ * Lodash 擴充工具
+ */
+export const lodashExTools = {
+  // 安全取得物件屬性值
+  getVal: (obj: any, path: string | null | undefined, defaultValue?: any) => {
+    if(_.isNil(path) || _.isEmpty(path)) {
+      return defaultValue;
+    }
+    return _.get(obj, path, defaultValue);
+  }
+};
+
+/**
+ * 檢查是否有相同的檔案
+ * @param fileList 檔案列表
+ * @param file 要檢查的檔案
+ */
+export const checkHasSameFile = (fileList: File[], file: File) => {
+  return fileList.some(item => item.name === file.name
+    && item.size === file.size
+    && item.type === file.type
+    && item.lastModified === file.lastModified);
+}
+
+/**
+ * 格式化物件中的所有日期屬性為指定格式的字串。
+ * @param obj
+ */
+export function formatDatesInObject(obj: any): any {
+  if (_.isNil(obj)) {
+    return obj;
+  }
+  // 如果是 FormData，直接回傳，不處理
+  if (obj instanceof FormData) {
+    return obj;
+  }
+
+  // 如果是 Date 或 dayjs 物件，進行格式化
+  if (dayjs.isDayjs(obj) || obj instanceof Date) {
+    // 格式化日期成字串
+    // console.log(`format date: ${obj} ISO string => ${dayjs(obj).toISOString()}`);
+    // console.log(`format date: ${obj} with timezone => ${dayjs(obj).tz('Asia/Taipei').toISOString()}`);
+    // console.log(`format date: ${obj} pattern => ${dayjs(obj).format('YYYY-MM-DDTHH:mm:ssZ')}`);
+    // return dayjs(obj).toISOString();
+    return dayjs(obj).format('YYYY-MM-DDTHH:mm:ss');
+  }
+
+  // 如果是陣列，遞迴處理每個元素
+  if (_.isArray(obj)) {
+    return obj.map(item => formatDatesInObject(item));
+  }
+
+  // 如果是物件，遞迴處理每個屬性值
+  if (_.isObject(obj)) {
+    return _.mapValues(obj, value => formatDatesInObject(value));
+  }
+
+  // 其他類型直接回傳
+  return obj;
+}
+
+/**
+ * 建立一個日期區間驗證器，用於 yup 的 test 方法中。
+ * @param startDateKey
+ * @param endDateKey
+ * @param startDateMessage
+ * @param endDateMessage
+ */
+export function makeDateRangeValidator({
+  startDateKey, endDateKey, startDateMessage, endDateMessage
+}: {startDateKey: string, endDateKey: string, startDateMessage: string, endDateMessage: string}) {
+  return function (this: yup.TestContext, formValues: Record<string, any>) {
+    const startsAt = formValues[startDateKey];
+    const endsAt = formValues[endDateKey];
+    if (startsAt == null && endsAt == null) {
+      return true;
+    }
+    const errors: yup.ValidationError[] = [];
+
+    if (startsAt && endsAt && (startsAt > endsAt)) {
+      errors.push(this.createError({
+        path: startDateKey,
+        message: startDateMessage
+      }));
+      errors.push(this.createError({
+        path: endDateKey,
+        message: endDateMessage
+      }));
+    }
+    if (errors.length > 0) {
+      // 注意：這裡我們回傳一個新的 ValidationError 實例，它包裹了所有收集到的錯誤
+      return new yup.ValidationError(errors);
+    }
+    return true;
+  }
+}
+