@orthacms/i18n-server 0.0.0-reserve.0

package/dist/lib/types/locale.d.ts

@@ -0,0 +1,68 @@
+/**
+ * Locale configuration contracts. The host declares its locales once, on the
+ * server plugin (`I18nServerPlugin({ locales })`) — the single source of
+ * truth. The admin fetches them from `GET /api/i18n/locales`; nothing is
+ * duplicated client-side.
+ */
+import type { LocaleDir } from '../i18n.constants';
+export type { LocaleDir };
+/** One configured locale. */
+export interface LocaleDef {
+    /**
+     * Stable machine slug stored on entry rows (e.g. `en`, `de`, `pt-br`).
+     *
+     * **It is a BCP-47 language tag**, and that is a contract, not a
+     * coincidence: the slug regex is the lowercase BCP-47 shape (a 2–3 letter
+     * primary tag with optional `-` subtags), and every value the plugin
+     * returns under `locale` — here, on `EntryLocaleItem`, on the `locale`
+     * column of an entry payload — may be used verbatim as an HTML `lang`
+     * value. A consumer therefore sets `lang={entry.locale}` on the field
+     * region, the preview, and the published page without a mapping table, and
+     * a screen reader announces German content with German pronunciation
+     * instead of the document's `lang="en"` (WCAG 3.1.2 Language of Parts).
+     * Keeping the two identical is why nothing here uppercases a region subtag.
+     */
+    slug: string;
+    /** Human display name (e.g. "English"). */
+    name: string;
+    /**
+     * The default locale — applied when a request names none. Exactly one
+     * locale must set it (validated eagerly at plugin construction).
+     */
+    isDefault?: boolean;
+    /**
+     * Text direction of content written in this locale — the HTML `dir` value
+     * a consumer sets alongside `lang`.
+     *
+     * **Optional in config, always present on the wire.** Omit it and the
+     * plugin infers it from the slug (`ar`, `he`, `fa`, `ur`, … → `rtl`;
+     * everything else `ltr`), so an RTL language is configured like any other;
+     * declare it to override the inference. `GET /api/i18n/locales` always
+     * returns a resolved value, so the admin never has to decide for itself
+     * whether Arabic is right-to-left (WCAG 1.3.2 Meaningful Sequence).
+     */
+    dir?: LocaleDir;
+}
+/** Options accepted by `I18nServerPlugin()`. */
+export interface I18nPluginConfig {
+    /** The available locales, in display order. Exactly one `isDefault`. */
+    locales: LocaleDef[];
+    /**
+     * What to do at boot when entry rows exist in a locale the config no
+     * longer declares — `'fail'` (the default) aborts the boot, `'warn'` logs
+     * the report and continues.
+     *
+     * Removing a locale from this config does **not** remove its rows, and the
+     * rows are then invisible to every read path: `?locale=` 400s the slug, the
+     * locale panel iterates the configured set, coverage and the virtual
+     * filters exclude it. The data is intact and unreachable — the worst shape
+     * for a silent failure, because nothing in the product ever mentions it
+     * again. Failing the boot puts the choice in front of whoever changed the
+     * config, while it is still their change. Set `'warn'` for a deployment
+     * that is knowingly mid-migration.
+     */
+    orphanedLocales?: OrphanedLocalePolicy;
+}
+/** How the plugin reacts to rows left behind by a removed locale. */
+export type OrphanedLocalePolicy = 'fail' | 'warn';
+//# sourceMappingURL=locale.d.ts.map

package/dist/lib/types/locale.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"locale.d.ts","sourceRoot":"","sources":["../../../src/lib/types/locale.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAEnD,YAAY,EAAE,SAAS,EAAE,CAAC;AAE1B,6BAA6B;AAC7B,MAAM,WAAW,SAAS;IACtB;;;;;;;;;;;;;OAaG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,2CAA2C;IAC3C,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;;;;;;;;OAUG;IACH,GAAG,CAAC,EAAE,SAAS,CAAC;CACnB;AAED,gDAAgD;AAChD,MAAM,WAAW,gBAAgB;IAC7B,wEAAwE;IACxE,OAAO,EAAE,SAAS,EAAE,CAAC;IACrB;;;;;;;;;;;;;OAaG;IACH,eAAe,CAAC,EAAE,oBAAoB,CAAC;CAC1C;AAED,qEAAqE;AACrE,MAAM,MAAM,oBAAoB,GAAG,MAAM,GAAG,MAAM,CAAC"}

package/dist/lib/types/locale.js

@@ -0,0 +1,8 @@
+"use strict";
+/**
+ * Locale configuration contracts. The host declares its locales once, on the
+ * server plugin (`I18nServerPlugin({ locales })`) — the single source of
+ * truth. The admin fetches them from `GET /api/i18n/locales`; nothing is
+ * duplicated client-side.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/lib/utils/i18n-plugin.d.ts

@@ -0,0 +1,41 @@
+import type { ServerPlugin } from '@orthacms/bootstrap-server';
+import type { I18nPluginConfig } from '../types/locale';
+/**
+ * Server plugin for content localization, carrying its config alongside the
+ * standard plugin shape.
+ */
+export interface I18nServerPluginType extends ServerPlugin {
+    /** The validated locale configuration. */
+    i18nConfig: I18nPluginConfig;
+}
+/**
+ * Creates the i18n plugin — content localization for `i18n: true` content
+ * types. Register it **after** `ContentPlugin`: it binds content-server's
+ * `CONTENT_ENTRY_EXTENSION` port (locale scoping, create stamping,
+ * shared-field sync, locale filters) and serves the locale-domain API under
+ * `/api/i18n` (locales list, per-entry locale panel, batched summaries,
+ * create-translation).
+ *
+ * Owns **no tables and no migrations** — locales live in this config, and
+ * the `locale` / `locale_group_id` columns live on the host-owned generated
+ * content tables (added by the `i18n: true` type flag).
+ *
+ * @example
+ * ```typescript
+ * createServer({
+ *   plugins: [
+ *     DatabasePlugin({ connectionString: config.database.url }),
+ *     IdentityPlugin(config.plugins.identity),
+ *     ContentPlugin({ types: contentTypes }),
+ *     I18nServerPlugin({
+ *       locales: [
+ *         { slug: 'en', name: 'English', isDefault: true },
+ *         { slug: 'de', name: 'Deutsch' }
+ *       ]
+ *     })
+ *   ]
+ * });
+ * ```
+ */
+export declare function I18nServerPlugin(config: I18nPluginConfig): I18nServerPluginType;
+//# sourceMappingURL=i18n-plugin.d.ts.map

package/dist/lib/utils/i18n-plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"i18n-plugin.d.ts","sourceRoot":"","sources":["../../../src/lib/utils/i18n-plugin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC/D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAIxD;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,YAAY;IACtD,0CAA0C;IAC1C,UAAU,EAAE,gBAAgB,CAAC;CAChC;AAcD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAgB,gBAAgB,CAC5B,MAAM,EAAE,gBAAgB,GACzB,oBAAoB,CAOtB"}

package/dist/lib/utils/i18n-plugin.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.I18nServerPlugin = I18nServerPlugin;
+const locale_set_1 = require("../domain/value-objects/locale-set");
+const i18n_module_1 = require("../i18n.module");
+/**
+ * Validate the locale config **eagerly** (like `ContentPlugin`'s registry):
+ * a misconfigured host fails at construction — before boot, before the first
+ * request. Building the domain {@link LocaleSet} enforces every invariant (at
+ * least one locale; unique, well-formed slugs; non-blank names; exactly one
+ * default), so the raw-string rules live on the `Locale` / `LocaleSet` value
+ * objects rather than inline here.
+ */
+function assertConfig(config) {
+    locale_set_1.LocaleSet.fromDefs(config.locales);
+}
+/**
+ * Creates the i18n plugin — content localization for `i18n: true` content
+ * types. Register it **after** `ContentPlugin`: it binds content-server's
+ * `CONTENT_ENTRY_EXTENSION` port (locale scoping, create stamping,
+ * shared-field sync, locale filters) and serves the locale-domain API under
+ * `/api/i18n` (locales list, per-entry locale panel, batched summaries,
+ * create-translation).
+ *
+ * Owns **no tables and no migrations** — locales live in this config, and
+ * the `locale` / `locale_group_id` columns live on the host-owned generated
+ * content tables (added by the `i18n: true` type flag).
+ *
+ * @example
+ * ```typescript
+ * createServer({
+ *   plugins: [
+ *     DatabasePlugin({ connectionString: config.database.url }),
+ *     IdentityPlugin(config.plugins.identity),
+ *     ContentPlugin({ types: contentTypes }),
+ *     I18nServerPlugin({
+ *       locales: [
+ *         { slug: 'en', name: 'English', isDefault: true },
+ *         { slug: 'de', name: 'Deutsch' }
+ *       ]
+ *     })
+ *   ]
+ * });
+ * ```
+ */
+function I18nServerPlugin(config) {
+    assertConfig(config);
+    return {
+        name: 'i18n',
+        module: i18n_module_1.I18nModule.forRoot(config),
+        i18nConfig: config
+    };
+}

package/package.json

@@ -0,0 +1,47 @@
+{
+    "name": "@orthacms/i18n-server",
+    "version": "0.0.0-reserve.0",
+    "description": "@orthacms/i18n-server — part of Ortha CMS.",
+    "license": "MIT",
+    "homepage": "https://github.com/ortha-source/ortha-cms/tree/main/packages/i18n/server",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/ortha-source/ortha-cms.git",
+        "directory": "packages/i18n/server"
+    },
+    "bugs": {
+        "url": "https://github.com/ortha-source/ortha-cms/issues"
+    },
+    "main": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "default": "./dist/index.js"
+        },
+        "./package.json": "./package.json"
+    },
+    "files": [
+        "dist"
+    ],
+    "dependencies": {
+        "@nestjs/common": "^11.0.0",
+        "@nestjs/swagger": "^11.4.6",
+        "@orthacms/bootstrap-server": "^0.0.1",
+        "@orthacms/content-server": "^0.0.1",
+        "@orthacms/copilot-domain": "^0.0.1",
+        "@orthacms/copilot-server": "^0.0.1",
+        "@orthacms/database": "^0.0.1",
+        "@orthacms/identity-server": "^0.0.1",
+        "@orthacms/tools-server": "^0.0.1",
+        "@orthacms/utils-server": "^0.0.1",
+        "@orthacms/workspaces-server": "^0.0.1",
+        "class-transformer": "^0.5.1",
+        "class-validator": "^0.15.1",
+        "drizzle-orm": "^0.45.0",
+        "tslib": "^2.3.0"
+    },
+    "publishConfig": {
+        "access": "public"
+    }
+}