@worldware/msg 0.5.5 → 0.6.0

package/README.md

@@ -145,9 +145,9 @@ resource.add('complex-message', 'This is a complex message', {
 
 // Access attributes
 const message = resource.get('complex-message');
-console.log(message?.lang); // 'en'
-console.log(message?.dir);  // 'ltr'
-console.log(message?.dnt);  // false
+console.log(message?.attributes.lang); // 'en'
+console.log(message?.attributes.dir);  // 'ltr'
+console.log(message?.attributes.dnt);  // false
 ```
 
 ### Serialization
@@ -210,10 +210,7 @@ const data = resource.getData();
 **Properties:**
 - `key: string` - Message key
 - `value: string` - Message value
-- `attributes: MsgAttributes` - Message attributes
-- `lang: string` - Language code
-- `dir: string` - Text direction
-- `dnt: boolean` - Do-not-translate flag
+- `attributes: MsgAttributes` - Message attributes (lang, dir, dnt)
 - `notes: MsgNote[]` - Message notes
 
 ## Development

package/dist/chunk-4SWDABOO.mjs

@@ -0,0 +1,135 @@
+import {
+  DEFAULT_ATTRIBUTES
+} from "./chunk-OMRO6GAZ.mjs";
+import {
+  MsgMessage
+} from "./chunk-GHRFKA7N.mjs";
+
+// src/classes/MsgResource/MsgResource.ts
+var MsgResource = class _MsgResource extends Map {
+  _attributes = DEFAULT_ATTRIBUTES;
+  _notes = [];
+  _title;
+  _project;
+  static create(data, project) {
+    const { title, attributes, notes, messages } = data;
+    const res = new _MsgResource(title, attributes, project, notes);
+    if (messages) {
+      messages.forEach((messageData) => {
+        const { key, value, attributes: attributes2, notes: notes2 } = messageData;
+        res.add(key, value, attributes2, notes2);
+      });
+    } else {
+      res.clear();
+    }
+    return res;
+  }
+  constructor(title, attributes, project, notes) {
+    super();
+    this._title = title;
+    this._attributes = { ...this._attributes, ...attributes };
+    this._project = project;
+    if (notes) {
+      notes.forEach((note) => this.addNote(note));
+    }
+  }
+  get attributes() {
+    return this._attributes;
+  }
+  set attributes(attributes) {
+    this._attributes = attributes;
+  }
+  get notes() {
+    return this._notes;
+  }
+  set notes(notes) {
+    this._notes = notes;
+  }
+  addNote(note) {
+    this.notes.push(note);
+  }
+  get title() {
+    return this._title;
+  }
+  set title(title) {
+    this._title = title;
+  }
+  getProject() {
+    return this._project;
+  }
+  add(key, value, attributes, notes) {
+    const merged = { ...this.attributes, ...attributes };
+    const msg = MsgMessage.create({
+      key,
+      value,
+      attributes: merged,
+      notes
+    });
+    this.set(key, msg);
+    return this;
+  }
+  translate(data) {
+    const { title, attributes, messages } = data;
+    if (title !== this.title) {
+      throw new TypeError("Title of resource and translations do not match.");
+    }
+    const translated = _MsgResource.create({
+      title,
+      attributes,
+      notes: this.notes
+      // transfer the notes
+    }, this._project);
+    this.forEach((msg) => {
+      translated.set(msg.key, msg);
+    });
+    messages?.forEach((messageData) => {
+      const { key, value, attributes: attributes2 } = messageData;
+      const msg = MsgMessage.create({
+        key,
+        value,
+        attributes: attributes2
+      });
+      const notes = this.get(key)?.notes || [];
+      notes.forEach((note) => {
+        msg.addNote(note);
+      });
+      translated.set(key, msg);
+    });
+    return translated;
+  }
+  async getTranslation(lang) {
+    const project = this._project;
+    const languageChain = project.getTargetLocale(lang);
+    if (!languageChain) {
+      throw new Error("Unsupported locale for resource.");
+    }
+    if (languageChain.length == 0) {
+      throw new Error(`Empty language chain for locale: ${lang}`);
+    }
+    let translated = this;
+    for (let i = 0; i < languageChain.length; i++) {
+      const lang2 = languageChain[i];
+      if (lang2 && project._locales.targetLocales[lang2]) {
+        translated = await translated._project._loader(project.project.name, translated.title, lang2).then((data) => translated.translate(data));
+      }
+    }
+    return translated;
+  }
+  getData(stripNotes = false) {
+    const messages = [];
+    this.forEach((msg) => messages.push(msg.getData(stripNotes)));
+    return {
+      title: this.title,
+      attributes: this.attributes,
+      notes: !stripNotes && this.notes.length > 0 ? this.notes : void 0,
+      messages
+    };
+  }
+  toJSON(stripNotes = false) {
+    return JSON.stringify(this.getData(stripNotes), null, 2);
+  }
+};
+
+export {
+  MsgResource
+};

package/dist/chunk-GHRFKA7N.mjs

@@ -0,0 +1,72 @@
+// src/classes/MsgMessage/MsgMessage.ts
+import { MessageFormat } from "messageformat";
+var DEFAULT_ATTRIBUTES = {
+  lang: "",
+  dir: "",
+  dnt: false
+};
+var MsgMessage = class _MsgMessage {
+  _key;
+  _value;
+  _mf;
+  _attributes = DEFAULT_ATTRIBUTES;
+  _notes = [];
+  constructor(key, value, attributes, notes) {
+    this._key = key;
+    this._value = value;
+    this._attributes = attributes ? { ...this._attributes, ...attributes } : this._attributes;
+    if (notes) {
+      notes.forEach((note) => this.addNote(note));
+    }
+  }
+  static create(data) {
+    const { key, value, attributes, notes } = data;
+    const message = new _MsgMessage(key, value, attributes, notes);
+    return message;
+  }
+  get key() {
+    return this._key;
+  }
+  get value() {
+    return this._value;
+  }
+  get attributes() {
+    return this._attributes;
+  }
+  get notes() {
+    return this._notes;
+  }
+  addNote(note) {
+    this.notes.push(note);
+  }
+  format(data, options) {
+    if (!this._mf) {
+      this._mf = new MessageFormat(this.attributes.lang, this.value, options);
+    }
+    return this._mf.format(data);
+  }
+  formatToParts(data, options) {
+    if (!this._mf) {
+      this._mf = new MessageFormat(this.attributes.lang, this.value, options);
+    }
+    return this._mf?.formatToParts(data);
+  }
+  getData(stripNotes = false) {
+    return {
+      key: this.key,
+      value: this.value,
+      attributes: this.attributes,
+      notes: !stripNotes && this.notes.length > 0 ? this.notes : void 0
+    };
+  }
+  toString() {
+    return this.value;
+  }
+  toJSON(stripNotes = false) {
+    return JSON.stringify(this.getData(stripNotes), null, 2);
+  }
+};
+
+export {
+  MsgMessage
+};

package/dist/chunk-OMRO6GAZ.mjs

@@ -0,0 +1,10 @@
+// src/classes/MsgInterface/MsgInterface.ts
+var DEFAULT_ATTRIBUTES = {
+  lang: "",
+  dir: "",
+  dnt: false
+};
+
+export {
+  DEFAULT_ATTRIBUTES
+};

package/dist/chunk-XS43NAP2.mjs

@@ -0,0 +1,42 @@
+// src/classes/MsgProject/MsgProject.ts
+var defaultProjectSettings = {
+  name: "messages",
+  version: 1
+};
+var defaultLocalesSettings = {
+  sourceLocale: "en",
+  pseudoLocale: "en-XA",
+  targetLocales: {
+    en: ["en"]
+  }
+};
+var MsgProject = class _MsgProject {
+  _project;
+  _locales;
+  _loader;
+  static create(data) {
+    const { project, locales, loader } = data;
+    return new _MsgProject(project, locales, loader);
+  }
+  constructor(projectSettings, localesSettings, loader) {
+    this._project = { ...defaultProjectSettings, ...projectSettings };
+    this._locales = { ...defaultLocalesSettings, ...localesSettings };
+    this._loader = loader;
+  }
+  get project() {
+    return this._project;
+  }
+  get locales() {
+    return this._locales;
+  }
+  get loader() {
+    return this._loader;
+  }
+  getTargetLocale(locale) {
+    return this._locales.targetLocales[locale];
+  }
+};
+
+export {
+  MsgProject
+};

package/dist/classes/MsgInterface/MsgInterface.cjs

@@ -0,0 +1,34 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/classes/MsgInterface/MsgInterface.ts
+var MsgInterface_exports = {};
+__export(MsgInterface_exports, {
+  DEFAULT_ATTRIBUTES: () => DEFAULT_ATTRIBUTES
+});
+module.exports = __toCommonJS(MsgInterface_exports);
+var DEFAULT_ATTRIBUTES = {
+  lang: "",
+  dir: "",
+  dnt: false
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  DEFAULT_ATTRIBUTES
+});

package/dist/classes/MsgInterface/MsgInterface.d.cts

@@ -0,0 +1,17 @@
+type NoteTypes = 'DESCRIPTION' | 'AUTHORSHIP' | 'PARAMETERS' | 'CONTEXT' | 'COMMENT';
+type MsgNote = {
+    type: NoteTypes;
+    content: string;
+};
+type MsgAttributes = {
+    lang?: string;
+    dir?: string;
+    dnt?: boolean;
+};
+declare const DEFAULT_ATTRIBUTES: MsgAttributes;
+interface MsgInterface {
+    attributes: MsgAttributes;
+    notes: MsgNote[];
+}
+
+export { DEFAULT_ATTRIBUTES, type MsgAttributes, type MsgInterface, type MsgNote };

package/dist/classes/MsgInterface/MsgInterface.d.ts

@@ -1,17 +1,17 @@
 type NoteTypes = 'DESCRIPTION' | 'AUTHORSHIP' | 'PARAMETERS' | 'CONTEXT' | 'COMMENT';
-export type MsgNote = {
+type MsgNote = {
     type: NoteTypes;
     content: string;
 };
-export type MsgAttributes = {
+type MsgAttributes = {
     lang?: string;
     dir?: string;
     dnt?: boolean;
 };
-export declare const DEFAULT_ATTRIBUTES: MsgAttributes;
-export interface MsgInterface {
+declare const DEFAULT_ATTRIBUTES: MsgAttributes;
+interface MsgInterface {
     attributes: MsgAttributes;
     notes: MsgNote[];
 }
-export {};
-//# sourceMappingURL=MsgInterface.d.ts.map
+
+export { DEFAULT_ATTRIBUTES, type MsgAttributes, type MsgInterface, type MsgNote };

package/dist/classes/MsgInterface/MsgInterface.mjs

@@ -0,0 +1,6 @@
+import {
+  DEFAULT_ATTRIBUTES
+} from "../../chunk-OMRO6GAZ.mjs";
+export {
+  DEFAULT_ATTRIBUTES
+};

package/dist/classes/MsgMessage/MsgMessage.cjs

@@ -0,0 +1,96 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/classes/MsgMessage/MsgMessage.ts
+var MsgMessage_exports = {};
+__export(MsgMessage_exports, {
+  MsgMessage: () => MsgMessage
+});
+module.exports = __toCommonJS(MsgMessage_exports);
+var import_messageformat = require("messageformat");
+var DEFAULT_ATTRIBUTES = {
+  lang: "",
+  dir: "",
+  dnt: false
+};
+var MsgMessage = class _MsgMessage {
+  _key;
+  _value;
+  _mf;
+  _attributes = DEFAULT_ATTRIBUTES;
+  _notes = [];
+  constructor(key, value, attributes, notes) {
+    this._key = key;
+    this._value = value;
+    this._attributes = attributes ? { ...this._attributes, ...attributes } : this._attributes;
+    if (notes) {
+      notes.forEach((note) => this.addNote(note));
+    }
+  }
+  static create(data) {
+    const { key, value, attributes, notes } = data;
+    const message = new _MsgMessage(key, value, attributes, notes);
+    return message;
+  }
+  get key() {
+    return this._key;
+  }
+  get value() {
+    return this._value;
+  }
+  get attributes() {
+    return this._attributes;
+  }
+  get notes() {
+    return this._notes;
+  }
+  addNote(note) {
+    this.notes.push(note);
+  }
+  format(data, options) {
+    if (!this._mf) {
+      this._mf = new import_messageformat.MessageFormat(this.attributes.lang, this.value, options);
+    }
+    return this._mf.format(data);
+  }
+  formatToParts(data, options) {
+    if (!this._mf) {
+      this._mf = new import_messageformat.MessageFormat(this.attributes.lang, this.value, options);
+    }
+    return this._mf?.formatToParts(data);
+  }
+  getData(stripNotes = false) {
+    return {
+      key: this.key,
+      value: this.value,
+      attributes: this.attributes,
+      notes: !stripNotes && this.notes.length > 0 ? this.notes : void 0
+    };
+  }
+  toString() {
+    return this.value;
+  }
+  toJSON(stripNotes = false) {
+    return JSON.stringify(this.getData(stripNotes), null, 2);
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  MsgMessage
+});

package/dist/classes/MsgMessage/MsgMessage.d.cts

@@ -0,0 +1,36 @@
+import * as messageformat from 'messageformat';
+import { MessageFormatOptions } from 'messageformat';
+import { MsgAttributes, MsgNote, MsgInterface } from '../MsgInterface/MsgInterface.cjs';
+
+type MsgMessageData = {
+    key: string;
+    value: string;
+    attributes?: MsgAttributes;
+    notes?: MsgNote[];
+};
+declare class MsgMessage implements MsgInterface {
+    private _key;
+    private _value;
+    private _mf?;
+    private _attributes;
+    private _notes;
+    private constructor();
+    static create(data: MsgMessageData): MsgMessage;
+    get key(): string;
+    get value(): string;
+    get attributes(): MsgAttributes;
+    get notes(): MsgNote[];
+    addNote(note: MsgNote): void;
+    format(data: Record<string, any>, options?: MessageFormatOptions): string;
+    formatToParts(data: Record<string, any>, options?: MessageFormatOptions): messageformat.MessagePart<never>[];
+    getData(stripNotes?: boolean): {
+        key: string;
+        value: string;
+        attributes: MsgAttributes;
+        notes: MsgNote[] | undefined;
+    };
+    toString(): string;
+    toJSON(stripNotes?: boolean): string;
+}
+
+export { MsgMessage, type MsgMessageData };

package/dist/classes/MsgMessage/MsgMessage.d.ts

@@ -1,12 +1,14 @@
-import { type MessageFormatOptions } from "messageformat";
-import { MsgInterface, type MsgAttributes, type MsgNote } from "../MsgInterface/MsgInterface.js";
-export type MsgMessageData = {
+import * as messageformat from 'messageformat';
+import { MessageFormatOptions } from 'messageformat';
+import { MsgAttributes, MsgNote, MsgInterface } from '../MsgInterface/MsgInterface.js';
+
+type MsgMessageData = {
     key: string;
     value: string;
     attributes?: MsgAttributes;
     notes?: MsgNote[];
 };
-export declare class MsgMessage implements MsgInterface {
+declare class MsgMessage implements MsgInterface {
     private _key;
     private _value;
     private _mf?;
@@ -17,13 +19,10 @@ export declare class MsgMessage implements MsgInterface {
     get key(): string;
     get value(): string;
     get attributes(): MsgAttributes;
-    get lang(): string | undefined;
-    get dir(): string | undefined;
-    get dnt(): boolean | undefined;
     get notes(): MsgNote[];
     addNote(note: MsgNote): void;
     format(data: Record<string, any>, options?: MessageFormatOptions): string;
-    formatToParts(data: Record<string, any>, options?: MessageFormatOptions): import("messageformat").MessagePart<never>[];
+    formatToParts(data: Record<string, any>, options?: MessageFormatOptions): messageformat.MessagePart<never>[];
     getData(stripNotes?: boolean): {
         key: string;
         value: string;
@@ -33,4 +32,5 @@ export declare class MsgMessage implements MsgInterface {
     toString(): string;
     toJSON(stripNotes?: boolean): string;
 }
-//# sourceMappingURL=MsgMessage.d.ts.map
+
+export { MsgMessage, type MsgMessageData };

package/dist/classes/MsgMessage/MsgMessage.mjs

@@ -0,0 +1,6 @@
+import {
+  MsgMessage
+} from "../../chunk-GHRFKA7N.mjs";
+export {
+  MsgMessage
+};

package/dist/classes/MsgProject/MsgProject.cjs

@@ -0,0 +1,66 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/classes/MsgProject/MsgProject.ts
+var MsgProject_exports = {};
+__export(MsgProject_exports, {
+  MsgProject: () => MsgProject
+});
+module.exports = __toCommonJS(MsgProject_exports);
+var defaultProjectSettings = {
+  name: "messages",
+  version: 1
+};
+var defaultLocalesSettings = {
+  sourceLocale: "en",
+  pseudoLocale: "en-XA",
+  targetLocales: {
+    en: ["en"]
+  }
+};
+var MsgProject = class _MsgProject {
+  _project;
+  _locales;
+  _loader;
+  static create(data) {
+    const { project, locales, loader } = data;
+    return new _MsgProject(project, locales, loader);
+  }
+  constructor(projectSettings, localesSettings, loader) {
+    this._project = { ...defaultProjectSettings, ...projectSettings };
+    this._locales = { ...defaultLocalesSettings, ...localesSettings };
+    this._loader = loader;
+  }
+  get project() {
+    return this._project;
+  }
+  get locales() {
+    return this._locales;
+  }
+  get loader() {
+    return this._loader;
+  }
+  getTargetLocale(locale) {
+    return this._locales.targetLocales[locale];
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  MsgProject
+});

package/dist/classes/MsgProject/MsgProject.d.cts

@@ -0,0 +1,63 @@
+import { MsgMessageData, MsgMessage } from '../MsgMessage/MsgMessage.cjs';
+import { MsgAttributes, MsgNote, MsgInterface } from '../MsgInterface/MsgInterface.cjs';
+import 'messageformat';
+
+type MsgProjectSettings = {
+    name: string;
+    version?: number;
+};
+type MsgTargetLocalesSettings = {
+    [key: string]: string[];
+};
+type MsgLocalesSettings = {
+    sourceLocale: string;
+    pseudoLocale: string;
+    targetLocales: MsgTargetLocalesSettings;
+};
+type MsgTranslationLoader = (project: string, title: string, lang: string) => Promise<MsgResourceData>;
+type MsgProjectData = {
+    project: MsgProjectSettings;
+    locales: MsgLocalesSettings;
+    loader: MsgTranslationLoader;
+};
+declare class MsgProject {
+    _project: MsgProjectSettings;
+    _locales: MsgLocalesSettings;
+    _loader: MsgTranslationLoader;
+    static create(data: MsgProjectData): MsgProject;
+    private constructor();
+    get project(): MsgProjectSettings;
+    get locales(): MsgLocalesSettings;
+    get loader(): MsgTranslationLoader;
+    getTargetLocale(locale: string): string[] | undefined;
+}
+
+type MsgResourceData = {
+    title: string;
+    attributes: MsgAttributes;
+    notes?: MsgNote[];
+    messages?: MsgMessageData[];
+};
+declare class MsgResource extends Map<string, MsgMessage> implements MsgInterface {
+    private _attributes;
+    private _notes;
+    private _title;
+    private _project;
+    static create(data: MsgResourceData, project: MsgProject): MsgResource;
+    private constructor();
+    get attributes(): MsgAttributes;
+    set attributes(attributes: MsgAttributes);
+    get notes(): MsgNote[];
+    set notes(notes: MsgNote[]);
+    addNote(note: MsgNote): void;
+    get title(): string;
+    set title(title: string);
+    getProject(): MsgProject;
+    add(key: string, value: string, attributes?: MsgAttributes, notes?: MsgNote[]): this;
+    translate(data: MsgResourceData): MsgResource;
+    getTranslation(lang: string): Promise<MsgResource>;
+    getData(stripNotes?: boolean): MsgResourceData;
+    toJSON(stripNotes?: boolean): string;
+}
+
+export { type MsgResourceData as M, MsgProject, type MsgProjectData, type MsgTranslationLoader, MsgResource as a };