@rpcbase/db 0.11.0 → 0.13.0

package/README.md

@@ -0,0 +1,25 @@
+## `@rpcbase/db`
+
+### `LocalizedString` / `zI18nString()`
+
+`zI18nString()` (alias de `zLocalizedString()`) décrit une string localisée sous forme d’objet, avec des clés en *language codes* (BCP47) :
+
+```ts
+import { z } from "zod"
+import { zI18nString, zodSchema } from "@rpcbase/db"
+
+const ZPost = z.object({
+  title: zI18nString(), // { "en": "...", "fr": "...", "fr-FR": "..." }
+})
+
+const schema = zodSchema(ZPost)
+```
+
+**Côté Mongoose (important)**
+
+- Le champ est stocké comme un objet et typé `SchemaTypes.Mixed` (pas un `Map`).
+- À la lecture, le getter Mongoose renvoie un objet “proxy” avec fallback automatique : `fr-FR` retombe sur `fr` si `fr-FR` n’existe pas.
+  - `doc.title["fr-FR"]` → fallback
+  - `doc.title.get("fr-FR")` → fallback (helper de lecture)
+  - `doc.title.getExact("fr-FR")` → exact (sans fallback)
+- À l’écriture, comme c’est du `Mixed`, évite les mutations profondes silencieuses : préfère remplacer l’objet (`doc.title = { ...doc.title, fr: "Salut" }`) ou appelle `doc.markModified("title")`.

package/dist/index.js

@@ -350,10 +350,92 @@ const zUUID = (ref) => {
   };
   return output;
 };
-const zI18nString = () => z.record(
-  z.string().regex(/^[A-Za-z]{2}$/i, { message: "Expected a country code (ISO 3166-1 alpha-2)." }),
-  z.string()
-);
+const LANGUAGE_CODE_REGEX = /^[a-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$/;
+const LOCALIZED_STRING_PROXY_CACHE = /* @__PURE__ */ new WeakMap();
+function normalizeLocale(locale) {
+  const trimmed = locale.trim();
+  if (!trimmed) return "";
+  const getCanonicalLocales = Intl?.getCanonicalLocales;
+  if (typeof getCanonicalLocales !== "function") return trimmed;
+  try {
+    return getCanonicalLocales(trimmed)[0] ?? trimmed;
+  } catch {
+    return trimmed;
+  }
+}
+function buildLocaleFallbackChain(locale, fallbacks) {
+  const base = locale.trim();
+  const canonical = normalizeLocale(base);
+  const extra = typeof fallbacks === "string" ? [fallbacks] : fallbacks ?? [];
+  const output = [];
+  const seen = /* @__PURE__ */ new Set();
+  const push = (value) => {
+    if (!value) return;
+    if (seen.has(value)) return;
+    seen.add(value);
+    output.push(value);
+  };
+  const addChain = (value) => {
+    if (!value) return;
+    const parts = value.split("-").filter(Boolean);
+    while (parts.length > 0) {
+      push(parts.join("-"));
+      parts.pop();
+    }
+  };
+  addChain(base);
+  addChain(canonical);
+  for (const fallback of extra) addChain(normalizeLocale(fallback));
+  return output;
+}
+function resolveLocalizedString(value, locale, options) {
+  if (!value) return void 0;
+  const chain = buildLocaleFallbackChain(locale, options?.fallbacks);
+  if (chain.length === 0) return void 0;
+  const record = value;
+  for (const key of chain) {
+    if (!Object.prototype.hasOwnProperty.call(record, key)) continue;
+    return record[key];
+  }
+  return void 0;
+}
+function withLocalizedStringFallback(value) {
+  if (!value || typeof value !== "object" || Array.isArray(value)) return value;
+  if (value instanceof Map) return value;
+  const cached = LOCALIZED_STRING_PROXY_CACHE.get(value);
+  if (cached) return cached;
+  const proxy = withFallbackRecord(value);
+  LOCALIZED_STRING_PROXY_CACHE.set(value, proxy);
+  return proxy;
+}
+function withFallbackRecord(record) {
+  const getExact = (key) => record[key];
+  const hasExact = (key) => Object.prototype.hasOwnProperty.call(record, key);
+  return new Proxy(record, {
+    get(target, prop) {
+      if (prop === "getExact") return getExact;
+      if (prop === "hasExact") return hasExact;
+      if (prop === "get") return (key) => resolveLocalizedString(record, key);
+      if (typeof prop === "string" && !(prop in target)) {
+        return resolveLocalizedString(record, prop);
+      }
+      return target[prop];
+    },
+    set(target, prop, next) {
+      target[prop] = next;
+      return true;
+    }
+  });
+}
+const zLocalizedString = () => {
+  const schema = z.record(
+    z.string().regex(LANGUAGE_CODE_REGEX, { message: "Expected a language code (BCP 47, e.g. en or fr-FR)." }),
+    z.string()
+  );
+  schema.__rpcbase_localizedString = true;
+  return schema;
+};
+const zI18nString = zLocalizedString;
 function zodSchema(schema, options) {
   const definition = parseObject(schema);
   return new Schema(definition, options);
@@ -525,6 +607,28 @@ function parseField(field, required = true, def, refinement) {
   if (zmAssert$1.any(field)) {
     return parseMixed(required, def);
   }
+  if (field.__rpcbase_localizedString) {
+    return {
+      type: SchemaTypes.Mixed,
+      default: def,
+      required,
+      validate: {
+        validator: (value) => {
+          if (value == null) return true;
+          if (typeof value !== "object" || Array.isArray(value)) return false;
+          const proto = Object.getPrototypeOf(value);
+          if (proto !== Object.prototype && proto !== null) return false;
+          for (const [key, entry] of Object.entries(value)) {
+            if (!LANGUAGE_CODE_REGEX.test(key)) return false;
+            if (typeof entry !== "string") return false;
+          }
+          return true;
+        },
+        message: "Expected a localized string record."
+      },
+      get: (value) => value == null ? value : withLocalizedStringFallback(value)
+    };
+  }
   if (zmAssert$1.mapOrRecord(field)) {
     const mapValueType = field.valueType ?? field.valueSchema;
     const mapKeyType = field.keyType ?? field.keySchema;
@@ -715,17 +819,22 @@ const loadModel = async (modelName, ctx) => {
   return modelConnection.models[modelName];
 };
 export {
+  LANGUAGE_CODE_REGEX,
   RBTenantSchema,
   RBUserSchema,
   ZRBTenant,
   ZRBUser,
+  buildLocaleFallbackChain,
   extendZod,
   getRegisteredModels,
   loadModel,
   registerModels,
+  resolveLocalizedString,
+  withLocalizedStringFallback,
   z2 as z,
   zI18nString,
   zId,
+  zLocalizedString,
   zUUID,
   zodSchema,
   zodSchemaRaw

package/dist/schema/extension.d.ts

@@ -62,7 +62,17 @@ export type TzmUUID = ReturnType<typeof createUUID> & {
 };
 declare const createUUID: () => z.ZodUnion<[z.ZodUUID, z.ZodCustom<Types.UUID, Types.UUID>]>;
 export declare const zUUID: (ref?: string) => TzmUUID;
-export type I18nStringRecord = Record<string, string>;
+export type LanguageCode = string;
+export type LocalizedString = Record<LanguageCode, string>;
+export type I18nStringRecord = LocalizedString;
+export type I18nString = LocalizedString;
+export declare const LANGUAGE_CODE_REGEX: RegExp;
+export declare function buildLocaleFallbackChain(locale: string, fallbacks?: string | string[]): string[];
+export declare function resolveLocalizedString(value: LocalizedString | null | undefined, locale: string, options?: {
+    fallbacks?: string | string[];
+}): string | undefined;
+export declare function withLocalizedStringFallback<T extends object>(value: T): T;
+export declare const zLocalizedString: () => z.ZodRecord<z.ZodString, z.ZodString>;
 export declare const zI18nString: () => z.ZodRecord<z.ZodString, z.ZodString>;
 export {};
 //# sourceMappingURL=extension.d.ts.map

package/dist/schema/extension.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"extension.d.ts","sourceRoot":"","sources":["../../src/schema/extension.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAmB,MAAM,UAAU,CAAA;AACjD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAGvB,OAAO,QAAQ,KAAK,CAAC;IACnB,UAAU,SAAS;QACjB,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,OAAO,KAAK,SAAS,CAAA;QACpC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,OAAO,KAAK,SAAS,CAAA;QACpC,WAAW,EAAE,OAAO,CAAA;QACpB,WAAW,EAAE,OAAO,CAAA;KACrB;IAED,UAAU,SAAS;QACjB,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,OAAO,KAAK,SAAS,CAAA;QACpC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,OAAO,KAAK,SAAS,CAAA;QACpC,WAAW,EAAE,OAAO,CAAA;QACpB,WAAW,EAAE,OAAO,CAAA;KACrB;IAED,UAAU,OAAO;QACf,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,OAAO,KAAK,OAAO,CAAA;QAClC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,OAAO,KAAK,OAAO,CAAA;QAClC,WAAW,EAAE,OAAO,CAAA;QACpB,WAAW,EAAE,OAAO,CAAA;KACrB;CAEF;AA+CD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,OAAO,CAAC,QA2DtC;AAED,MAAM,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,QAAQ,CAAC,GAAG;IAChD,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,OAAO,KAAK,KAAK,CAAA;IAChC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,OAAO,KAAK,KAAK,CAAA;IAChC,GAAG,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,KAAK,CAAA;IAC3B,OAAO,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,KAAK,CAAA;CAChC,CAAA;AAED,QAAA,MAAM,QAAQ,8EAKb,CAAA;AAED,eAAO,MAAM,GAAG,GAAI,MAAM,MAAM,KAAG,KAoDlC,CAAA;AAED,MAAM,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,UAAU,CAAC,GAAG;IACpD,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,OAAO,KAAK,OAAO,CAAA;IAClC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,OAAO,KAAK,OAAO,CAAA;IAClC,GAAG,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAA;IAC7B,OAAO,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAA;CAClC,CAAA;AAED,QAAA,MAAM,UAAU,oEAEf,CAAA;AAED,eAAO,MAAM,KAAK,GAAI,MAAM,MAAM,KAAG,OAoDpC,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;AAErD,eAAO,MAAM,WAAW,QAMjB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC,CAAA"}
+{"version":3,"file":"extension.d.ts","sourceRoot":"","sources":["../../src/schema/extension.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAmB,MAAM,UAAU,CAAA;AACjD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAGvB,OAAO,QAAQ,KAAK,CAAC;IACnB,UAAU,SAAS;QACjB,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,OAAO,KAAK,SAAS,CAAA;QACpC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,OAAO,KAAK,SAAS,CAAA;QACpC,WAAW,EAAE,OAAO,CAAA;QACpB,WAAW,EAAE,OAAO,CAAA;KACrB;IAED,UAAU,SAAS;QACjB,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,OAAO,KAAK,SAAS,CAAA;QACpC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,OAAO,KAAK,SAAS,CAAA;QACpC,WAAW,EAAE,OAAO,CAAA;QACpB,WAAW,EAAE,OAAO,CAAA;KACrB;IAED,UAAU,OAAO;QACf,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,OAAO,KAAK,OAAO,CAAA;QAClC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,OAAO,KAAK,OAAO,CAAA;QAClC,WAAW,EAAE,OAAO,CAAA;QACpB,WAAW,EAAE,OAAO,CAAA;KACrB;CAEF;AA+CD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,OAAO,CAAC,QA2DtC;AAED,MAAM,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,QAAQ,CAAC,GAAG;IAChD,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,OAAO,KAAK,KAAK,CAAA;IAChC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,OAAO,KAAK,KAAK,CAAA;IAChC,GAAG,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,KAAK,CAAA;IAC3B,OAAO,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,KAAK,CAAA;CAChC,CAAA;AAED,QAAA,MAAM,QAAQ,8EAKb,CAAA;AAED,eAAO,MAAM,GAAG,GAAI,MAAM,MAAM,KAAG,KAoDlC,CAAA;AAED,MAAM,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,UAAU,CAAC,GAAG;IACpD,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,OAAO,KAAK,OAAO,CAAA;IAClC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,OAAO,KAAK,OAAO,CAAA;IAClC,GAAG,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAA;IAC7B,OAAO,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAA;CAClC,CAAA;AAED,QAAA,MAAM,UAAU,oEAEf,CAAA;AAED,eAAO,MAAM,KAAK,GAAI,MAAM,MAAM,KAAG,OAoDpC,CAAA;AAED,MAAM,MAAM,YAAY,GAAG,MAAM,CAAA;AAEjC,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,CAAA;AAE1D,MAAM,MAAM,gBAAgB,GAAG,eAAe,CAAA;AAE9C,MAAM,MAAM,UAAU,GAAG,eAAe,CAAA;AAExC,eAAO,MAAM,mBAAmB,QAAuC,CAAA;AAgBvE,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,CA6BhG;AAED,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,eAAe,GAAG,IAAI,GAAG,SAAS,EACzC,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE;IAAE,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CAAE,GAC1C,MAAM,GAAG,SAAS,CAWpB;AAED,wBAAgB,2BAA2B,CAAC,CAAC,SAAS,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CASzE;AAwBD,eAAO,MAAM,gBAAgB,6CAU5B,CAAA;AAED,eAAO,MAAM,WAAW,6CAAmB,CAAA"}

package/dist/schema/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/schema/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,KAAK,aAAa,EAAe,MAAM,UAAU,CAAA;AAClE,OAAO,EAEL,SAAS,EACT,WAAW,EAGX,CAAC,EACF,MAAM,KAAK,CAAA;AAGZ,OAAO,KAAK,KAAK,EAAE,MAAM,kBAAkB,CAAA;AAG3C,cAAc,aAAa,CAAA;AAC3B,cAAc,KAAK,CAAA;AAEnB,OAAO,EAAE,CAAC,EAAE,CAAA;AAEZ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,WAAW,EAC7C,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,EACpB,OAAO,CAAC,EAAE,aAAa,CAAC,GAAG,CAAC,GAC3B,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,MAAM,CAAC,CAAC,CAGhC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS,WAAW,EAChD,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,GACnB,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,CAEf;AA6ZD,eAAe,SAAS,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/schema/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,KAAK,aAAa,EAAe,MAAM,UAAU,CAAA;AAClE,OAAO,EAEL,SAAS,EACT,WAAW,EAGX,CAAC,EACF,MAAM,KAAK,CAAA;AAIZ,OAAO,KAAK,KAAK,EAAE,MAAM,kBAAkB,CAAA;AAG3C,cAAc,aAAa,CAAA;AAC3B,cAAc,KAAK,CAAA;AAEnB,OAAO,EAAE,CAAC,EAAE,CAAA;AAEZ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,WAAW,EAC7C,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,EACpB,OAAO,CAAC,EAAE,aAAa,CAAC,GAAG,CAAC,GAC3B,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,MAAM,CAAC,CAAC,CAGhC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS,WAAW,EAChD,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,GACnB,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,CAEf;AAqbD,eAAe,SAAS,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rpcbase/db",
-  "version": "0.11.0",
+  "version": "0.13.0",
   "type": "module",
   "files": [
     "dist"