@cloudcome/utils-uni 1.1.0 → 1.1.1

package/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## [1.1.1](https://github.com/cloudcome/utils/compare/@cloudcome/utils-uni@1.1.0...@cloudcome/utils-uni@1.1.1) (2025-08-30)
+
+**Note:** Version bump only for package @cloudcome/utils-uni
+
+# 1.1.0 (2025-08-27)
+
+### Features
+
+* **utils-uni:** 添加 usePageQuery hook 函数 ([3e35818](https://github.com/cloudcome/utils/commit/3e358189ce0f68b538c95f710478f864a1cd0182))

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 ☁️淡然
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/package.json

@@ -1 +1,52 @@
-{"name":"@cloudcome/utils-uni","version":"1.1.0","description":"cloudcome utils for uni-app","engines":{"node":">=22"},"engineStrict":true,"sideEffects":false,"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.mjs","require":"./dist/index.cjs"},"./package.json":"./package.json","./page":{"types":"./dist/page.d.ts","import":"./dist/page.mjs","require":"./dist/page.cjs"}},"typesVersions":{"*":{"page":["./dist/page.d.ts"]}},"main":"./dist/index.cjs","module":"./dist/index.mjs","types":"./dist/index.d.ts","files":["dist"],"repository":{"url":"https://github.com/cloudcome/utils","directory":"packages/utils-uni"},"dependencies":{"@cloudcome/utils-core":"1.1.0","@dcloudio/uni-app":"3.0.0-4060620250520001","vue":"^3.5.13"}}
+{
+  "name": "@cloudcome/utils-uni",
+  "version": "1.1.1",
+  "description": "cloudcome utils for uni-app",
+  "engines": {
+    "node": ">=22"
+  },
+  "engineStrict": true,
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    },
+    "./package.json": "./package.json",
+    "./page": {
+      "types": "./dist/page.d.ts",
+      "import": "./dist/page.mjs",
+      "require": "./dist/page.cjs"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      "page": [
+        "./dist/page.d.ts"
+      ]
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "dependencies": {
+    "@cloudcome/utils-core": "1.1.1",
+    "@dcloudio/uni-app": "3.0.0-4060620250520001",
+    "vue": "^3.5.13"
+  },
+  "repository": "https://github.com/cloudcome/utils",
+  "keywords": [
+    "utils",
+    "cloudcome",
+    "utils-core",
+    "utils-vue",
+    "utils-react",
+    "utils-uni",
+    "utils-node",
+    "utils-browser"
+  ],
+  "homepage": "https://github.com/cloudcome/utils",
+  "license": "MIT",
+  "author": "云淡然 <hi@ydr.me> (https://ydr.me/)"
+}

package/src/dts/global.d.ts

@@ -0,0 +1,27 @@
+/**
+ * @file global.d.ts
+ */
+
+/**
+ * package.json name
+ */
+declare const PKG_NAME: string;
+
+/**
+ * package.json version
+ */
+declare const PKG_VERSION: string;
+
+/**
+ * package.json description
+ */
+declare const PKG_DESCRIPTION: string;
+
+declare const IS_TEST: string;
+
+interface TEST_MOCK {
+  IS_BROWSER: boolean;
+  IS_NODE: boolean;
+}
+
+declare const TEST_MOCK: TEST_MOCK;

package/src/index.ts

@@ -0,0 +1 @@
+export const VERSION = PKG_VERSION;

package/{dist/page.d.ts → src/page.ts}

@@ -1,5 +1,7 @@
-import { AnyObject } from '@cloudcome/utils-core/types';
-import { Reactive } from 'vue';
+import type { AnyObject } from '@cloudcome/utils-core/types';
+import { onLoad } from '@dcloudio/uni-app';
+import { type Reactive, reactive, unref } from 'vue';
+
 /**
  * 用于获取页面参数的 hook 函数
  * @template T - 页面参数对象的类型，继承自 AnyObject
@@ -22,4 +24,13 @@ import { Reactive } from 'vue';
  * }
  * const query = usePageQuery<PageParams>();
  */
-export declare function usePageQuery<T extends AnyObject>(onPageLoad?: (query: Reactive<T>) => void): Reactive<T>;
+export function usePageQuery<T extends AnyObject>(onPageLoad?: (query: Reactive<T>) => void) {
+  const query = reactive<T>({} as T);
+
+  onLoad((_query) => {
+    Object.assign(query, _query);
+    onPageLoad?.(query);
+  });
+
+  return query;
+}

package/test/index.test.ts

@@ -0,0 +1,6 @@
+import { VERSION } from '@/index';
+import { expect, it } from 'vitest';
+
+it('version', () => {
+  expect(VERSION).toEqual(PKG_VERSION);
+});

package/test/page.test.ts

@@ -0,0 +1,53 @@
+import { onLoad } from '@dcloudio/uni-app';
+import { describe, expect, it, vi } from 'vitest';
+import { isReactive } from 'vue';
+import { usePageQuery } from '../src/page';
+
+beforeAll(() => {
+  vi.mock('@dcloudio/uni-app');
+});
+
+afterAll(() => {
+  vi.restoreAllMocks();
+});
+
+describe('usePageQuery', () => {
+  it('应该正确获取页面参数', () => {
+    // 模拟 uni-app 的 onLoad 函数
+    const mockOnLoad = vi.fn();
+    vi.mocked(onLoad).mockImplementation(mockOnLoad);
+
+    // 调用 hook
+    const query = usePageQuery();
+
+    // 触发模拟的 onLoad 回调
+    const pageParams = { id: '123', name: 'test' };
+    mockOnLoad.mock.calls[0][0](pageParams);
+
+    // 验证结果
+    expect(query).toEqual(pageParams);
+  });
+
+  it('应该正确执行传入的 onLoad 回调', () => {
+    const mockCallback = vi.fn();
+    const mockOnLoad = vi.fn();
+    vi.mocked(onLoad).mockImplementation(mockOnLoad);
+
+    // 调用 hook 并传入回调
+    usePageQuery(mockCallback);
+
+    // 触发模拟的 onLoad 回调
+    const pageParams = { id: '123' };
+    mockOnLoad.mock.calls[0][0](pageParams);
+
+    // 验证回调被执行
+    expect(mockCallback).toHaveBeenCalledWith(pageParams);
+  });
+
+  it('返回的 query 应该是响应式对象', () => {
+    const query = usePageQuery();
+
+    // 验证响应性
+    expect(isReactive(query)).toBe(true);
+  });
+});

package/tsconfig.json

@@ -0,0 +1,31 @@
+{
+  "compilerOptions": {
+    "jsx": "preserve",
+    "jsxImportSource": "vue",
+    "target": "ES2024",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+
+    "strict": true,
+    "noEmit": true,
+    "allowJs": true,
+    "sourceMap": true,
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    "verbatimModuleSyntax": true,
+    "allowImportingTsExtensions": false,
+    "allowSyntheticDefaultImports": true,
+    "forceConsistentCasingInFileNames": true,
+
+    "lib": ["ES2024"],
+    "types": ["node", "vite/client", "vitest/globals"],
+    "plugins": [],
+    "paths": {
+      "@/*": ["./src/*"]
+    }
+  },
+
+  "include": ["**/*.ts", "**/.*.ts", "**/*.mts", "**/*.tsx", "**/*.vue"],
+  "exclude": []
+}

package/vite.config.mts

@@ -0,0 +1,84 @@
+/**
+ * @file vite.config.mts
+ * @ref https://vitejs.dev/
+ */
+
+import dts from 'vite-plugin-dts';
+import { externalizeDeps } from 'vite-plugin-externalize-deps';
+import tsconfigPaths from 'vite-tsconfig-paths';
+import { defineConfig } from 'vitest/config';
+import pkg from './package.json';
+
+export default defineConfig((env) => {
+  const isProd = env.mode === 'production';
+  const isTest = env.mode === 'test';
+
+  return {
+    base: '/',
+    server: {
+      port: 15170,
+    },
+    preview: {
+      port: 15171,
+    },
+    define: {
+      PKG_NAME: JSON.stringify(isTest ? 'pkg-name-for-test' : pkg.name),
+      PKG_VERSION: JSON.stringify(isTest ? 'pkg-version-for-test' : pkg.version),
+      PKG_DESCRIPTION: JSON.stringify(isTest ? 'pkg-description-for-test' : pkg.description),
+      IS_TEST: JSON.stringify(isTest),
+    },
+    build: {
+      minify: false,
+      sourcemap: true,
+      copyPublicDir: false,
+      reportCompressedSize: false,
+      lib: {
+        entry:
+          // expose-start
+          {
+            index: 'src/index.ts',
+            page: './src/page.ts',
+          },
+        // expose-end
+      },
+      rollupOptions: {
+        output: [
+          {
+            format: 'esm',
+            entryFileNames: '[name].mjs',
+            chunkFileNames: '[name].mjs',
+          },
+          {
+            format: 'cjs',
+            entryFileNames: '[name].cjs',
+            chunkFileNames: '[name].cjs',
+          },
+        ],
+      },
+    },
+    test: {
+      globals: true,
+      coverage: {
+        all: true,
+        include: ['src/**/*.ts'],
+        reporter: ['lcov', 'text'],
+      },
+    },
+    // esbuild: {
+    //   drop: isProd ? ['console', 'debugger'] : [],
+    // },
+    plugins: [
+      tsconfigPaths(),
+      externalizeDeps({
+        deps: true,
+        devDeps: true,
+        peerDeps: true,
+        optionalDeps: true,
+        nodeBuiltins: true,
+      }),
+      dts({
+        include: 'src',
+      }),
+    ],
+  };
+});

package/dist/index.cjs

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const VERSION = "1.1.0";
-exports.VERSION = VERSION;
-//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.cjs","sources":["../src/index.ts"],"sourcesContent":["export const VERSION = PKG_VERSION;\n"],"names":[],"mappings":";;AAAO,MAAM,UAAU;;"}

package/dist/index.d.ts

@@ -1 +0,0 @@
-export declare const VERSION: string;

package/dist/index.mjs

@@ -1,5 +0,0 @@
-const VERSION = "1.1.0";
-export {
-  VERSION
-};
-//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.mjs","sources":["../src/index.ts"],"sourcesContent":["export const VERSION = PKG_VERSION;\n"],"names":[],"mappings":"AAAO,MAAM,UAAU;"}

package/dist/page.cjs

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const uniApp = require("@dcloudio/uni-app");
-const vue = require("vue");
-function usePageQuery(onPageLoad) {
-  const query = vue.reactive({});
-  uniApp.onLoad((_query) => {
-    Object.assign(query, _query);
-    onPageLoad == null ? void 0 : onPageLoad(query);
-  });
-  return query;
-}
-exports.usePageQuery = usePageQuery;
-//# sourceMappingURL=page.cjs.map

package/dist/page.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"page.cjs","sources":["../src/page.ts"],"sourcesContent":["import type { AnyObject } from '@cloudcome/utils-core/types';\nimport { onLoad } from '@dcloudio/uni-app';\nimport { type Reactive, reactive, unref } from 'vue';\n\n/**\n * 用于获取页面参数的 hook 函数\n * @template T - 页面参数对象的类型，继承自 AnyObject\n * @param {function} [onPageLoad] - 页面加载时的回调函数\n * @param {T} onLoad.query - 页面参数对象\n * @returns {T} 响应式的页面参数对象\n * @example\n * // 基本用法\n * const query = usePageQuery();\n *\n * // 带回调的用法\n * const query = usePageQuery((query) => {\n *   console.log('页面参数:', query);\n * });\n *\n * // 指定参数类型\n * interface PageParams {\n *   id: string;\n *   name?: string;\n * }\n * const query = usePageQuery<PageParams>();\n */\nexport function usePageQuery<T extends AnyObject>(onPageLoad?: (query: Reactive<T>) => void) {\n  const query = reactive<T>({} as T);\n\n  onLoad((_query) => {\n    Object.assign(query, _query);\n    onPageLoad?.(query);\n  });\n\n  return query;\n}\n"],"names":["reactive","onLoad"],"mappings":";;;;AA0BO,SAAS,aAAkC,YAA2C;AACrF,QAAA,QAAQA,IAAY,SAAA,EAAO;AAEjCC,SAAA,OAAO,CAAC,WAAW;AACV,WAAA,OAAO,OAAO,MAAM;AAC3B,6CAAa;AAAA,EAAK,CACnB;AAEM,SAAA;AACT;;"}

package/dist/page.mjs

@@ -1,14 +0,0 @@
-import { onLoad } from "@dcloudio/uni-app";
-import { reactive } from "vue";
-function usePageQuery(onPageLoad) {
-  const query = reactive({});
-  onLoad((_query) => {
-    Object.assign(query, _query);
-    onPageLoad == null ? void 0 : onPageLoad(query);
-  });
-  return query;
-}
-export {
-  usePageQuery
-};
-//# sourceMappingURL=page.mjs.map

package/dist/page.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"page.mjs","sources":["../src/page.ts"],"sourcesContent":["import type { AnyObject } from '@cloudcome/utils-core/types';\nimport { onLoad } from '@dcloudio/uni-app';\nimport { type Reactive, reactive, unref } from 'vue';\n\n/**\n * 用于获取页面参数的 hook 函数\n * @template T - 页面参数对象的类型，继承自 AnyObject\n * @param {function} [onPageLoad] - 页面加载时的回调函数\n * @param {T} onLoad.query - 页面参数对象\n * @returns {T} 响应式的页面参数对象\n * @example\n * // 基本用法\n * const query = usePageQuery();\n *\n * // 带回调的用法\n * const query = usePageQuery((query) => {\n *   console.log('页面参数:', query);\n * });\n *\n * // 指定参数类型\n * interface PageParams {\n *   id: string;\n *   name?: string;\n * }\n * const query = usePageQuery<PageParams>();\n */\nexport function usePageQuery<T extends AnyObject>(onPageLoad?: (query: Reactive<T>) => void) {\n  const query = reactive<T>({} as T);\n\n  onLoad((_query) => {\n    Object.assign(query, _query);\n    onPageLoad?.(query);\n  });\n\n  return query;\n}\n"],"names":[],"mappings":";;AA0BO,SAAS,aAAkC,YAA2C;AACrF,QAAA,QAAQ,SAAY,EAAO;AAEjC,SAAO,CAAC,WAAW;AACV,WAAA,OAAO,OAAO,MAAM;AAC3B,6CAAa;AAAA,EAAK,CACnB;AAEM,SAAA;AACT;"}