@rpcbase/db 0.36.0 → 0.37.0

package/README.md

@@ -13,8 +13,32 @@ const ZUser = z.object({
 })
 ```
 
+### `LocalizedString` / `zI18nString()`
+
+`zI18nString()` (alias of `zLocalizedString()`) describes a localized string as an object keyed by *language codes* (BCP47):
+
+```ts
+import { z, zI18nString } from "@rpcbase/db"
+
+const ZPost = z.object({
+  title: zI18nString(), // { "en": "...", "fr": "...", "fr-FR": "..." }
+})
+```
+
 ### Mongoose re-export
 
 ```ts
 import { Schema, model, mongoose } from "@rpcbase/db"
 ```
+
+### Mongoose localized fallback (optional)
+
+When storing localized strings as plain objects, `mongooseLocalizedStringField()` adds a getter that returns a proxy with fallback behavior:
+
+```ts
+import { Schema, mongooseLocalizedStringField } from "@rpcbase/db"
+
+const PostSchema = new Schema({
+  title: mongooseLocalizedStringField(),
+})
+```

package/dist/index.browser.js

@@ -1,5 +1,90 @@
 import { z } from "zod";
 import { z as z2 } from "zod";
+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()
+  );
+  return schema;
+};
+const zI18nString = zLocalizedString;
 let zodExtended = false;
 function extendZod(zod) {
   if (zodExtended) return;
@@ -18,5 +103,12 @@ function extendZod(zod) {
 }
 extendZod(z);
 export {
-  z2 as z
+  LANGUAGE_CODE_REGEX,
+  buildLocaleFallbackChain,
+  extendZod,
+  resolveLocalizedString,
+  withLocalizedStringFallback,
+  z2 as z,
+  zI18nString,
+  zLocalizedString
 };

package/dist/index.d.ts

@@ -4,7 +4,6 @@ export * from './mongoose';
 export * from './pagination';
 export * from './zod';
 export * from './createModels';
-export * from './extendMongooseSchema';
 export * from './modelsApi';
 export * from './tenantFilesystemDb';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAA;AACrB,cAAc,UAAU,CAAA;AACxB,cAAc,YAAY,CAAA;AAC1B,cAAc,cAAc,CAAA;AAC5B,cAAc,OAAO,CAAA;AAErB,cAAc,gBAAgB,CAAA;AAC9B,cAAc,wBAAwB,CAAA;AACtC,cAAc,aAAa,CAAA;AAC3B,cAAc,sBAAsB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAA;AACrB,cAAc,UAAU,CAAA;AACxB,cAAc,YAAY,CAAA;AAC1B,cAAc,cAAc,CAAA;AAC5B,cAAc,OAAO,CAAA;AAErB,cAAc,gBAAgB,CAAA;AAC9B,cAAc,aAAa,CAAA;AAC3B,cAAc,sBAAsB,CAAA"}

package/dist/index.js

@@ -5,7 +5,8 @@ import { default as default2 } from "mongoose";
 import { z } from "zod";
 import { z as z2 } from "zod";
 import { timingSafeEqual, createHmac } from "node:crypto";
-import "./index.browser.js";
+import { withLocalizedStringFallback } from "./index.browser.js";
+import { LANGUAGE_CODE_REGEX, buildLocaleFallbackChain, extendZod, resolveLocalizedString, zI18nString, zLocalizedString } from "./index.browser.js";
 import assert from "assert";
 import { accessibleBy, accessibleRecordsPlugin } from "@casl/mongoose";
 import "@casl/ability";
@@ -432,6 +433,24 @@ const frameworkSchemas = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.de
   ZRBUploadSessionStatus,
   ZRBUser
 }, Symbol.toStringTag, { value: "Module" }));
+function extendMongooseSchema(baseSchema, ...extensions) {
+  const schema = baseSchema.clone();
+  extensions.forEach((extension) => schema.add(extension));
+  return schema;
+}
+function omitMongooseSchemaPaths(schema, paths) {
+  const clone = schema.clone();
+  paths.forEach((path) => clone.remove(path));
+  return clone;
+}
+function localizedStringField(options) {
+  const userGet = options?.get;
+  return {
+    ...options,
+    type: Schema$1.Types.Mixed,
+    get: (value) => withLocalizedStringFallback(userGet ? userGet(value) : value)
+  };
+}
 const { Schema, model } = mongoose;
 class PaginationValidationError extends Error {
   code = "invalid_pagination";
@@ -1178,16 +1197,6 @@ const createModels = (modules) => {
     getGlobal
   };
 };
-function extendMongooseSchema(baseSchema, ...extensions) {
-  const schema = baseSchema.clone();
-  extensions.forEach((extension) => schema.add(extension));
-  return schema;
-}
-function omitSchemaPaths(schema, paths) {
-  const clone = schema.clone();
-  paths.forEach((path) => clone.remove(path));
-  return clone;
-}
 const getAppName = () => {
   const appName = process.env.APP_NAME?.trim();
   assert(appName, "Missing APP_NAME");
@@ -1206,6 +1215,7 @@ const getTenantFilesystemDbFromCtx = async (ctx) => {
   return getTenantFilesystemDb(tenantId);
 };
 export {
+  LANGUAGE_CODE_REGEX,
   PaginationValidationError,
   RBNotificationPolicy,
   RBNotificationSchema,
@@ -1243,9 +1253,11 @@ export {
   ZRBUser,
   b as buildAbility,
   d as buildAbilityFromSession,
+  buildLocaleFallbackChain,
   f as can,
   createModels,
   extendMongooseSchema,
+  extendZod,
   e as getAccessibleByQuery,
   g as getRegisteredPolicies,
   getTenantFilesystemDb,
@@ -1253,12 +1265,17 @@ export {
   getTenantFilesystemDbName,
   c as getTenantRolesFromSessionUser,
   isPaginationValidationError,
+  localizedStringField,
   model,
   models,
   mongoPaginationPlugin,
   default2 as mongoose,
-  omitSchemaPaths,
+  omitMongooseSchemaPaths,
   registerPoliciesFromModules,
   r as registerPolicy,
-  z2 as z
+  resolveLocalizedString,
+  withLocalizedStringFallback,
+  z2 as z,
+  zI18nString,
+  zLocalizedString
 };

package/dist/mongoose/extendMongooseSchema.d.ts

@@ -0,0 +1,6 @@
+import { Schema } from '../../../vite/node_modules/mongoose';
+type MongooseSchemaExtension = Parameters<Schema["add"]>[0];
+export declare function extendMongooseSchema<TSchema extends Schema>(baseSchema: TSchema, ...extensions: MongooseSchemaExtension[]): TSchema;
+export declare function omitMongooseSchemaPaths<TSchema extends Schema>(schema: TSchema, paths: string[]): TSchema;
+export {};
+//# sourceMappingURL=extendMongooseSchema.d.ts.map

package/dist/mongoose/extendMongooseSchema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"extendMongooseSchema.d.ts","sourceRoot":"","sources":["../../src/mongoose/extendMongooseSchema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAGjC,KAAK,uBAAuB,GAAG,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;AAE3D,wBAAgB,oBAAoB,CAAC,OAAO,SAAS,MAAM,EACzD,UAAU,EAAE,OAAO,EACnB,GAAG,UAAU,EAAE,uBAAuB,EAAE,GACvC,OAAO,CAMT;AAED,wBAAgB,uBAAuB,CAAC,OAAO,SAAS,MAAM,EAC5D,MAAM,EAAE,OAAO,EACf,KAAK,EAAE,MAAM,EAAE,GACd,OAAO,CAIT"}

package/dist/mongoose/index.d.ts

@@ -1,4 +1,6 @@
-import { default as mongoose } from '../../../vite/node_modules/mongoose';
+import { default as mongoose, InferSchemaType } from '../../../vite/node_modules/mongoose';
 declare const Schema: typeof mongoose.Schema, model: typeof mongoose.model;
-export { Schema, model, mongoose };
+export { Schema, model, mongoose, type InferSchemaType };
+export * from './extendMongooseSchema';
+export * from './localizedStringField';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/mongoose/index.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,UAAU,CAAA;AAG/B,QAAA,MAAQ,MAAM,0BAAE,KAAK,uBAAa,CAAA;AAElC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/mongoose/index.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,UAAU,CAAA;AAC/B,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,UAAU,CAAA;AAG/C,QAAA,MAAQ,MAAM,0BAAE,KAAK,uBAAa,CAAA;AAElC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,eAAe,EAAE,CAAA;AACxD,cAAc,wBAAwB,CAAA;AACtC,cAAc,wBAAwB,CAAA"}

package/dist/mongoose/localizedStringField.d.ts

@@ -0,0 +1,4 @@
+import { SchemaTypeOptions } from '../../../vite/node_modules/mongoose';
+import { LocalizedString } from '../zod/localizedString';
+export declare function localizedStringField(options?: Omit<SchemaTypeOptions<LocalizedString>, "type" | "get">): SchemaTypeOptions<LocalizedString>;
+//# sourceMappingURL=localizedStringField.d.ts.map

package/dist/mongoose/localizedStringField.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"localizedStringField.d.ts","sourceRoot":"","sources":["../../src/mongoose/localizedStringField.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAA;AAEjD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAA;AAI7D,wBAAgB,oBAAoB,CAClC,OAAO,CAAC,EAAE,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,GACjE,iBAAiB,CAAC,eAAe,CAAC,CAQpC"}

package/dist/zod/index.d.ts

@@ -1,3 +1,5 @@
 import { z, ZodError } from '../../../vite/node_modules/zod';
-export { z, ZodError };
+import { extendZod } from './extension';
+export * from './localizedString';
+export { extendZod, z, ZodError };
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/zod/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,KAAK,QAAQ,EAAE,MAAM,KAAK,CAAA;AAOtC,OAAO,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/zod/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,KAAK,QAAQ,EAAE,MAAM,KAAK,CAAA;AAEtC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAGvC,cAAc,mBAAmB,CAAA;AAKjC,OAAO,EAAE,SAAS,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAA"}

package/dist/zod/localizedString.d.ts

@@ -0,0 +1,14 @@
+import { z } from '../../../vite/node_modules/zod';
+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>;
+//# sourceMappingURL=localizedString.d.ts.map

package/dist/zod/localizedString.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"localizedString.d.ts","sourceRoot":"","sources":["../../src/zod/localizedString.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAGvB,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,6CAS5B,CAAA;AAED,eAAO,MAAM,WAAW,6CAAmB,CAAA"}

package/package.json

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

package/dist/extendMongooseSchema.d.ts

@@ -1,6 +0,0 @@
-import { Schema } from '../../vite/node_modules/mongoose';
-type MongooseSchemaExtension = Parameters<Schema["add"]>[0];
-export declare function extendMongooseSchema<TSchema extends Schema>(baseSchema: TSchema, ...extensions: MongooseSchemaExtension[]): TSchema;
-export declare function omitSchemaPaths<TSchema extends Schema>(schema: TSchema, paths: string[]): TSchema;
-export {};
-//# sourceMappingURL=extendMongooseSchema.d.ts.map

package/dist/extendMongooseSchema.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"extendMongooseSchema.d.ts","sourceRoot":"","sources":["../src/extendMongooseSchema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAGjC,KAAK,uBAAuB,GAAG,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;AAE3D,wBAAgB,oBAAoB,CAAC,OAAO,SAAS,MAAM,EACzD,UAAU,EAAE,OAAO,EACnB,GAAG,UAAU,EAAE,uBAAuB,EAAE,GACvC,OAAO,CAMT;AAED,wBAAgB,eAAe,CAAC,OAAO,SAAS,MAAM,EACpD,MAAM,EAAE,OAAO,EACf,KAAK,EAAE,MAAM,EAAE,GACd,OAAO,CAIT"}