@lacqjs/nuxt-dict 0.0.4 → 0.0.6

package/dist/module.d.mts

@@ -1,9 +1,10 @@
 import * as _nuxt_schema from '@nuxt/schema';
 import * as __runtime_types from '../dist/runtime/types/index.js';
 import { ModuleOptions } from '../dist/runtime/types/index.js';
-export { DictItem, DictTranslator, GetDictItemOptions, ModuleOptions, TranslateOptions, TranslatePathOptions, TreeNode } from '../dist/runtime/types/index.js';
+export { DictAdapter, DictItem, DictTranslator, GetDictItemOptions, ModuleOptions, TranslateOptions, TranslatePathOptions, TreeNode } from '../dist/runtime/types/index.js';
 export { DictManager } from '../dist/runtime/core/dict-manager.js';
 export { createDictTranslator } from '../dist/runtime/utils/dict-translator.js';
+export { defineDictAdapter } from '../dist/runtime/utils/define-adapter.js';
 
 /**
  * Nuxt Dict 模块入口。

package/dist/module.d.ts

@@ -1,9 +1,10 @@
 import * as _nuxt_schema from '@nuxt/schema';
 import * as __runtime_types from '../dist/runtime/types/index.js';
 import { ModuleOptions } from '../dist/runtime/types/index.js';
-export { DictItem, DictTranslator, GetDictItemOptions, ModuleOptions, TranslateOptions, TranslatePathOptions, TreeNode } from '../dist/runtime/types/index.js';
+export { DictAdapter, DictItem, DictTranslator, GetDictItemOptions, ModuleOptions, TranslateOptions, TranslatePathOptions, TreeNode } from '../dist/runtime/types/index.js';
 export { DictManager } from '../dist/runtime/core/dict-manager.js';
 export { createDictTranslator } from '../dist/runtime/utils/dict-translator.js';
+export { defineDictAdapter } from '../dist/runtime/utils/define-adapter.js';
 
 /**
  * Nuxt Dict 模块入口。

package/dist/module.json

@@ -1,6 +1,6 @@
 {
   "name": "@lacqjs/nuxt-dict",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "configKey": "dict",
   "compatibility": {
     "nuxt": "^4.4.8"

package/dist/module.mjs

@@ -1,10 +1,13 @@
-import { defineNuxtModule, useLogger, createResolver, addPlugin, addImportsDir, addTypeTemplate } from '@nuxt/kit';
+import { defineNuxtModule, useLogger, createResolver, addTemplate, addTypeTemplate, addPlugin, addImportsDir } from '@nuxt/kit';
+import { existsSync } from 'node:fs';
+import { resolve } from 'node:path';
 import { defaultOptions } from '../dist/runtime/options.js';
 import { createLogger } from '../dist/runtime/utils/logger.js';
 export { createDictTranslator } from '../dist/runtime/utils/dict-translator.js';
+export { defineDictAdapter } from '../dist/runtime/utils/define-adapter.js';
 
 const name = "@lacqjs/nuxt-dict";
-const version = "0.0.4";
+const version = "0.0.6";
 const devDependencies = {
 	nuxt: "^4.4.8"};
 const pkg = {
@@ -160,6 +163,14 @@ declare module '#app' {
     }
   });
 }
+function resolveAdapterPath(nuxt, explicitPath, conventionName) {
+  if (typeof explicitPath === "string") return explicitPath;
+  const base = resolve(nuxt.options.srcDir, "dict", conventionName);
+  for (const ext of [".ts", ".js", ".mjs"]) {
+    if (existsSync(base + ext)) return (base + ext).replaceAll("\\", "/");
+  }
+  return void 0;
+}
 const module$1 = defineNuxtModule().with({
   meta: {
     name: pkg.name,
@@ -180,7 +191,71 @@ const module$1 = defineNuxtModule().with({
       return;
     }
     const resolver = createResolver(import.meta.url);
-    _nuxt.options.runtimeConfig.public.dict = _options;
+    const globalAdapterPath = resolveAdapterPath(
+      _nuxt,
+      _options.api?.adapter,
+      "dict-adapter"
+    );
+    const storeAdapterPaths = {};
+    for (const [name, config] of Object.entries(_options.stores ?? {})) {
+      const adapterPath = resolveAdapterPath(
+        _nuxt,
+        config.adapter,
+        `${name}-adapter`
+      );
+      if (adapterPath) storeAdapterPaths[name] = adapterPath;
+    }
+    addTemplate({
+      filename: "nuxt-dict/adapters.ts",
+      getContents: () => {
+        let code = "";
+        if (globalAdapterPath) {
+          code += `export { default as globalAdapter } from '${globalAdapterPath}'
+`;
+        } else {
+          code += "export const globalAdapter = undefined\n";
+        }
+        const entries = Object.entries(storeAdapterPaths);
+        if (entries.length > 0) {
+          code += entries.map(
+            ([name, p]) => `import adapter_${name.replaceAll(/\W/gu, "_")} from '${p}'`
+          ).join("\n") + "\n";
+          code += `export const storeAdapters = { ${entries.map(
+            ([name]) => `'${name}': adapter_${name.replaceAll(/\W/gu, "_")}`
+          ).join(", ")} }
+`;
+        } else {
+          code += "export const storeAdapters = {} as Record<string, never>\n";
+        }
+        return code;
+      }
+    });
+    addTypeTemplate({
+      filename: "types/nuxt-dict-adapters.d.ts",
+      getContents: () => `
+declare module '#build/nuxt-dict/adapters' {
+  import type { DictAdapter } from '@lacqjs/nuxt-dict'
+  export const globalAdapter: DictAdapter | undefined
+  export const storeAdapters: Record<string, DictAdapter>
+}
+`
+    });
+    if (_options.api?.adapter && typeof _options.api.adapter !== "string") {
+      logger.warn(
+        "dict.api.adapter \u4E0D\u652F\u6301\u5185\u8054\u51FD\u6570\uFF08\u65E0\u6CD5\u5E8F\u5217\u5316\u5230\u5BA2\u6237\u7AEF\uFF09\u3002\u8BF7\u6539\u7528\u6587\u4EF6\u8DEF\u5F84\u6216\u5C06\u6587\u4EF6\u653E\u5728\u7EA6\u5B9A\u4F4D\u7F6E ~/dict/dict-adapter.ts"
+      );
+    }
+    const { adapter: _globalAdapter, ...apiWithoutAdapter } = _options.api;
+    const sanitizedStores = {};
+    for (const [k, v] of Object.entries(_options.stores ?? {})) {
+      const { adapter: _storeAdapter, ...rest } = v;
+      sanitizedStores[k] = rest;
+    }
+    _nuxt.options.runtimeConfig.public.dict = {
+      ..._options,
+      api: apiWithoutAdapter,
+      stores: sanitizedStores
+    };
     _nuxt.options.build.transpile.push(resolver.resolve("./runtime"));
     addPlugin(resolver.resolve("./runtime/plugins/dict"));
     addImportsDir(resolver.resolve("./runtime/composables"));

package/dist/runtime/composables/useDict.js

@@ -1,4 +1,4 @@
-import { shallowRef, ref, watch, onMounted, onBeforeUnmount } from "vue";
+import { shallowRef, ref, watch, onMounted, onBeforeUnmount, triggerRef } from "vue";
 import { useNuxtApp } from "#imports";
 import { DEFAULT_STORE_NAME } from "../core/cache/indexeddb-cache.js";
 const activeInstances = /* @__PURE__ */ new Map();
@@ -7,7 +7,12 @@ async function fetchDictData(manager, dictType, storeName, data, loading, error,
   error.value = null;
   try {
     const entry = await (mode === "refresh" ? manager.refresh(dictType, storeName) : manager.getDict(dictType, storeName));
-    data.value = entry.items;
+    if (data.value) {
+      data.value.splice(0, data.value.length, ...entry.items);
+      triggerRef(data);
+    } else {
+      data.value = entry.items;
+    }
     if (itemMap) {
       itemMap.clear();
       for (const item of entry.items) {

package/dist/runtime/composables/useDictTree.js

@@ -1,4 +1,4 @@
-import { shallowRef, ref, watch, onMounted } from "vue";
+import { shallowRef, ref, watch, onMounted, triggerRef } from "vue";
 import { useNuxtApp } from "#imports";
 import { DEFAULT_STORE_NAME } from "../core/cache/indexeddb-cache.js";
 export function useDictTree(storeOrType, maybeType) {
@@ -29,7 +29,13 @@ export function useDictTree(storeOrType, maybeType) {
     loading.value = true;
     try {
       const entry = await manager.getDict(dictType, storeName);
-      tree.value = entry.tree ?? null;
+      const newTree = entry.tree ?? null;
+      if (tree.value && newTree) {
+        tree.value.splice(0, tree.value.length, ...newTree);
+        triggerRef(tree);
+      } else {
+        tree.value = newTree;
+      }
       if (entry.tree) buildMaps(entry.tree, nodeMap, pathMap);
     } finally {
       loading.value = false;
@@ -39,7 +45,13 @@ export function useDictTree(storeOrType, maybeType) {
     loading.value = true;
     try {
       const entry = await manager.refresh(dictType, storeName);
-      tree.value = entry.tree ?? null;
+      const newTree = entry.tree ?? null;
+      if (tree.value && newTree) {
+        tree.value.splice(0, tree.value.length, ...newTree);
+        triggerRef(tree);
+      } else {
+        tree.value = newTree;
+      }
       if (entry.tree) buildMaps(entry.tree, nodeMap, pathMap);
     } finally {
       loading.value = false;

package/dist/runtime/core/dict-manager.js

@@ -192,7 +192,7 @@ export class DictManager {
     const key = this.buildKey(type, storeName);
     const entry = this.memoryCache.get(key);
     if (!entry) return String(value);
-    const item = entry.data.items.find((i) => this.codeMatch(i.value, value));
+    const item = entry.data?.items?.find((i) => this.codeMatch(i.value, value));
     if (!item) return String(value);
     return item[field] ?? item.label;
   }

package/dist/runtime/plugins/dict.js

@@ -1,5 +1,6 @@
 import { watch } from "vue";
 import { defineNuxtPlugin, useRequestEvent, useCookie, useRoute } from "#imports";
+import { globalAdapter, storeAdapters } from "#build/nuxt-dict/adapters";
 import { createDefaultAdapter } from "../core/adapter.js";
 import { IndexedDBCache, DEFAULT_STORE_NAME } from "../core/cache/indexeddb-cache.js";
 import { DictManager } from "../core/dict-manager.js";
@@ -70,7 +71,7 @@ async function executePrefetch(manager, types, logger) {
 }
 function createAdapters(options, logger) {
   const adapters = /* @__PURE__ */ new Map();
-  const defaultAdapter = options.api.adapter ?? createDefaultAdapter({
+  const defaultAdapter = globalAdapter ?? createDefaultAdapter({
     baseURL: resolveBaseURL(options.api.baseURL),
     dictEndpoint: options.api.dictEndpoint,
     versionEndpoint: options.api.versionEndpoint,
@@ -82,7 +83,7 @@ function createAdapters(options, logger) {
     `Dict adapter created for default store '${DEFAULT_STORE_NAME}': ${options.api.baseURL}${options.api.dictEndpoint}`
   );
   for (const [storeName, storeApi] of Object.entries(options.stores)) {
-    const adapter = storeApi.adapter ?? createDefaultAdapter({
+    const adapter = storeAdapters[storeName] ?? createDefaultAdapter({
       baseURL: resolveBaseURL(storeApi.baseURL ?? options.api.baseURL),
       dictEndpoint: storeApi.dictEndpoint ?? options.api.dictEndpoint,
       versionEndpoint: storeApi.versionEndpoint ?? options.api.versionEndpoint,
@@ -90,7 +91,7 @@ function createAdapters(options, logger) {
       apiHeaderKey: options.locale.apiHeaderKey
     });
     adapters.set(storeName, adapter);
-    const desc = storeApi.adapter ? "custom adapter" : `${storeApi.baseURL ?? options.api.baseURL}${storeApi.dictEndpoint ?? options.api.dictEndpoint}`;
+    const desc = storeAdapters[storeName] ? "custom adapter" : `${storeApi.baseURL ?? options.api.baseURL}${storeApi.dictEndpoint ?? options.api.dictEndpoint}`;
     logger.debug(`Dict adapter created for store '${storeName}': ${desc}`);
   }
   return adapters;

package/dist/runtime/types/index.d.ts

@@ -86,8 +86,8 @@ export interface StoreApiOptions {
     dictEndpoint?: string;
     /** 版本号接口路径，默认继承全局 `api.versionEndpoint` */
     versionEndpoint?: string;
-    /** 自定义字典适配器，不传则使用默认 REST 适配器（继承全局 api 配置） */
-    adapter?: DictAdapter;
+    /** 自定义字典适配器文件路径（如 '~/dict/dict-adapter'），不传则按约定路径自动发现或使用默认 REST 适配器 */
+    adapter?: string;
 }
 /** 模块配置项（用户可传，字段均可选） */
 export interface ModuleOptions {
@@ -102,8 +102,8 @@ export interface ModuleOptions {
         dictEndpoint?: string;
         /** 版本号接口路径，默认 `'/dict/version'` */
         versionEndpoint?: string;
-        /** 自定义字典适配器，不传则使用默认 REST 适配器 */
-        adapter?: DictAdapter;
+        /** 自定义字典适配器文件路径（如 '~/dict/dict-adapter'），不传则按约定路径自动发现或使用默认 REST 适配器 */
+        adapter?: string;
     };
     cache?: {
         /** 内存缓存最大条目数，默认 `200` */
@@ -155,7 +155,7 @@ export interface ResolvedModuleOptions {
         baseURL: string;
         dictEndpoint: string;
         versionEndpoint: string;
-        adapter?: DictAdapter;
+        adapter?: string;
     };
     cache: {
         memoryMax: number;

package/dist/runtime/utils/define-adapter.d.ts

@@ -0,0 +1,26 @@
+import type { DictAdapter } from '../types/index.js';
+/**
+ * 定义自定义字典适配器（类型辅助函数）。
+ *
+ * @description 提供完整的 TypeScript 类型推导，确保适配器实现符合 DictAdapter 接口。
+ * 运行时原样返回，不做任何处理。用于自定义适配器文件（如 ~/dict/dict-adapter.ts）中导出适配器。
+ *
+ * @param {DictAdapter} adapter - 适配器对象，需实现 fetchDict 和 fetchVersion 方法
+ * @returns {DictAdapter} 原样返回传入的适配器对象
+ *
+ * @example
+ * // ~/dict/dict-adapter.ts
+ * import { defineDictAdapter } from '@lacqjs/nuxt-dict'
+ *
+ * export default defineDictAdapter({
+ *   async fetchDict(storeName, { types, locale }) {
+ *     const res = await fetch(`/api/dict?types=${types.join(',')}&lang=${locale}`)
+ *     return res.json()
+ *   },
+ *   async fetchVersion(storeName) {
+ *     const res = await fetch('/api/dict/version')
+ *     return (await res.json()).version
+ *   },
+ * })
+ */
+export declare function defineDictAdapter(adapter: DictAdapter): DictAdapter;

package/dist/runtime/utils/define-adapter.js

@@ -0,0 +1,3 @@
+export function defineDictAdapter(adapter) {
+  return adapter;
+}

package/dist/types.d.mts

@@ -1,7 +1,9 @@
-export { type DictItem, type DictTranslator, type GetDictItemOptions, type ModuleOptions, type TranslateOptions, type TranslatePathOptions, type TreeNode } from '../dist/runtime/types/index.js'
+export { type DictAdapter, type DictItem, type DictTranslator, type GetDictItemOptions, type ModuleOptions, type TranslateOptions, type TranslatePathOptions, type TreeNode } from '../dist/runtime/types/index.js'
 
 export { type DictManager } from '../dist/runtime/core/dict-manager.js'
 
 export { type createDictTranslator } from '../dist/runtime/utils/dict-translator.js'
 
+export { type defineDictAdapter } from '../dist/runtime/utils/define-adapter.js'
+
 export { default } from './module.mjs'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lacqjs/nuxt-dict",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "Nuxt 数据字典模块，提供扁平/树形字典翻译、多语言国际化、三级缓存与 SSR 预取。",
   "keywords": [
     "@lacqjs/nuxt-dict",
@@ -79,6 +79,7 @@
     "docs:cleanup": "pnpx rimraf docs/.nuxt docs/.output docs/dist docs/node_modules docs/.data",
     "playground:cleanup": "pnpx rimraf playground/.nuxt playground/.output playground/dist playground/node_modules",
     "demo:base-api:dev": "nuxi dev examples/demo-base-api",
+    "demo:base-adapter:dev": "nuxi dev examples/demo-base-adapter",
     "release": "pnpm lint && pnpm typecheck && pnpm prepack && changelogen --release && pnpm publish && git push origin dev --follow-tags",
     "release:major": "pnpm lint && pnpm typecheck && pnpm prepack && changelogen --release --major && pnpm publish && git push origin dev --follow-tags",
     "release:e2e": "pnpm lint && pnpm e2e && pnpm typecheck && pnpm prepack && changelogen --release && pnpm publish && git push origin dev --follow-tags",