@vnejs/plugins.text.locs 0.1.6 → 0.1.8

package/dist/index.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.js

@@ -0,0 +1,4 @@
+import { regPlugin } from "@vnejs/shared";
+import { PARAMS, PLUGIN_NAME, SETTINGS_KEYS, SUBSCRIBE_EVENTS } from "@vnejs/plugins.text.locs.contract";
+import { TextLocs } from "./modules/locs.js";
+regPlugin(PLUGIN_NAME, { events: SUBSCRIBE_EVENTS, settings: SETTINGS_KEYS, params: PARAMS }, [TextLocs]);

package/dist/modules/locs.d.ts

@@ -0,0 +1,19 @@
+import { Module } from "@vnejs/module";
+import type { LocsPluginConstants, LocsPluginEvents, LocsPluginParams, LocsPluginSettings } from "../types.js";
+import type { ComponentsInjectResult, LocsComponent, LocsGetPayload, LocsLoadPayload, SettingsChangedPayload, TextReplaceHandlerPayload } from "../utils/locs.js";
+export declare class TextLocs extends Module<LocsPluginEvents, LocsPluginConstants, LocsPluginSettings, LocsPluginParams> {
+    name: string;
+    loading: Record<string, Promise<void> | undefined>;
+    subscribe: () => void;
+    init: () => Promise<unknown[] | undefined>;
+    componentsInjectHandler: (component: LocsComponent) => Promise<ComponentsInjectResult>;
+    textReplaceHandler: ({ text, label }?: TextReplaceHandlerPayload) => Promise<string>;
+    onLocsLoad: ({ label, lang }?: LocsLoadPayload) => Promise<void>;
+    onLocsChanged: () => Promise<void>;
+    onLocsGet: ({ label, lang }?: LocsGetPayload) => Promise<unknown>;
+    onSettingChange: ({ name, value }?: SettingsChangedPayload) => false | Promise<unknown[]> | undefined;
+    getLoadedLocs: (label?: string, lang?: string | null) => Promise<unknown> | undefined;
+    loadLoc: (label?: string) => Promise<void>;
+    setLang: (lang: string) => Promise<unknown[]> | undefined;
+    checkLang: () => boolean;
+}

package/dist/modules/locs.js

@@ -0,0 +1,73 @@
+import { Module } from "@vnejs/module";
+import { toJson } from "@vnejs/helpers";
+export class TextLocs extends Module {
+    name = "text.locs";
+    loading = {};
+    subscribe = () => {
+        this.on(this.EVENTS.LOCS.LOAD, this.onLocsLoad);
+        this.on(this.EVENTS.LOCS.GET, this.onLocsGet);
+        this.on(this.EVENTS.LOCS.CHANGED, this.onLocsChanged);
+        this.on(this.EVENTS.SETTINGS.CHANGED, this.onSettingChange);
+    };
+    init = async () => {
+        await Promise.all([
+            this.emit(this.EVENTS.SETTINGS.INIT, { name: this.SETTINGS.LOCS.LANG, value: this.PARAMS.LOCS.DEFAULT_LANG }),
+            this.emit(this.EVENTS.MEMORY.REG, { module: this.name }),
+            this.emit(this.EVENTS.COMPONENTS.INJECT_REG, { handler: this.componentsInjectHandler }),
+            this.emit(this.EVENTS.TEXT.REPLACE_REG, { priority: -999999, handler: this.textReplaceHandler }),
+        ]);
+        return this.setLang(this.shared.settings[this.SETTINGS.LOCS.LANG]);
+    };
+    componentsInjectHandler = async (component) => {
+        const result = { field: "locs", value: {} };
+        if (component.locLabel)
+            result.value = (await this.emitOne(this.EVENTS.LOCS.GET, { label: component.locLabel }));
+        return result;
+    };
+    textReplaceHandler = async ({ text = "", label = "" } = {}) => {
+        const locs = (await this.emitOne(this.EVENTS.LOCS.GET, { label }));
+        return locs?.[text] || text;
+    };
+    onLocsLoad = async ({ label, lang } = {}) => {
+        await this.waitRerenderCheck(this.checkLang);
+        const mediaId = `${lang || this.shared.lang}:${label}`;
+        const memoryLocs = await this.emitOne(this.EVENTS.MEMORY.GET, { module: this.name, key: mediaId });
+        if (memoryLocs)
+            return;
+        if (this.loading[mediaId])
+            return this.loading[mediaId];
+        return this.loadLoc(label);
+    };
+    onLocsChanged = async () => {
+        const { label } = this.globalState.scenario;
+        const loadedLocs = await this.getLoadedLocs(label);
+        if (!loadedLocs)
+            await this.emit(this.EVENTS.LOCS.LOAD, { label });
+        await this.emit(this.EVENTS.TEXT.RECALC);
+    };
+    onLocsGet = async ({ label = this.PARAMS.SCENARIO.INIT_LABEL_NAME, lang = null } = {}) => {
+        await this.waitRerenderCheck(this.checkLang);
+        const loadedLocs = await this.getLoadedLocs(label, lang);
+        if (loadedLocs)
+            return loadedLocs;
+        await this.emit(this.EVENTS.LOCS.LOAD, { label, lang });
+        return this.getLoadedLocs(label, lang);
+    };
+    onSettingChange = ({ name, value } = {}) => name === this.SETTINGS.LOCS.LANG && this.setLang(value);
+    getLoadedLocs = (label, lang) => this.emitOne(this.EVENTS.MEMORY.GET, { module: this.name, key: `${lang || this.shared.lang}:${label}` });
+    loadLoc = (label) => {
+        const [loadingId, url] = [`${this.shared.lang}:${label}`, this.media.locs?.[`${this.shared.lang}/${label}`]];
+        const promiseFunc = async () => {
+            const value = url ? (await fetch(`${this.CONST.SYSTEM.HOST}/${url}`).then(toJson)) : {};
+            await this.emit(this.EVENTS.MEMORY.SET, { module: this.name, key: loadingId, value });
+            delete this.loading[loadingId];
+        };
+        this.loading[loadingId] = promiseFunc();
+        return this.loading[loadingId];
+    };
+    setLang = (lang) => {
+        this.shared.lang = lang;
+        return this.emit(this.EVENTS.LOCS.CHANGED);
+    };
+    checkLang = () => Boolean(this.shared.lang);
+}

package/dist/types.d.ts

@@ -0,0 +1,12 @@
+import type { VnePluginConstantsMapRegistry, VnePluginEventsMapRegistry, VnePluginParamsMapRegistry, VnePluginSettingsMapRegistry } from "@vnejs/shared";
+import type { PluginName as ComponentsPluginName, SubscribeEvents as ComponentsSubscribeEvents } from "@vnejs/plugins.core.components.contract";
+import type { PluginName as MemoryPluginName, SubscribeEvents as MemorySubscribeEvents } from "@vnejs/plugins.core.memory.contract";
+import type { Params as ScenarioParams, PluginName as ScenarioPluginName, SubscribeEvents as ScenarioSubscribeEvents } from "@vnejs/plugins.core.scenario.contract";
+import type { PluginName as SettingsPluginName, SubscribeEvents as SettingsSubscribeEvents } from "@vnejs/plugins.core.settings.contract";
+import type { Constants as SystemConstants, PluginName as SystemPluginName, SubscribeEvents as SystemSubscribeEvents } from "@vnejs/plugins.core.system.contract";
+import type { PluginName as TextPluginName, SubscribeEvents as TextSubscribeEvents } from "@vnejs/plugins.text.contract";
+import type { Params, PluginName, SettingsKeys, SubscribeEvents } from "@vnejs/plugins.text.locs.contract";
+export type LocsPluginEvents = VnePluginEventsMapRegistry & Record<PluginName, SubscribeEvents> & Record<ComponentsPluginName, ComponentsSubscribeEvents> & Record<MemoryPluginName, MemorySubscribeEvents> & Record<ScenarioPluginName, ScenarioSubscribeEvents> & Record<SettingsPluginName, SettingsSubscribeEvents> & Record<SystemPluginName, SystemSubscribeEvents> & Record<TextPluginName, TextSubscribeEvents>;
+export type LocsPluginConstants = VnePluginConstantsMapRegistry & Record<SystemPluginName, SystemConstants>;
+export type LocsPluginSettings = VnePluginSettingsMapRegistry & Record<PluginName, SettingsKeys>;
+export type LocsPluginParams = VnePluginParamsMapRegistry & Record<PluginName, Params> & Record<ScenarioPluginName, ScenarioParams>;

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/dist/utils/locs.d.ts

@@ -0,0 +1,25 @@
+export type LocsRecord = Record<string, string>;
+export type LocsLoadPayload = {
+    label?: string;
+    lang?: string | null;
+};
+export type LocsGetPayload = {
+    label?: string;
+    lang?: string | null;
+};
+export type LocsComponent = {
+    locLabel?: string;
+};
+export type ComponentsInjectResult = {
+    field: string;
+    value: LocsRecord;
+};
+export type SettingsChangedPayload = {
+    name?: string;
+    value?: unknown;
+};
+export type TextReplaceHandlerPayload = {
+    text?: string;
+    label?: string;
+};
+export type ComponentsInjectHandler = (component: LocsComponent) => ComponentsInjectResult | Promise<ComponentsInjectResult>;

package/dist/utils/locs.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,17 +1,49 @@
 {
   "name": "@vnejs/plugins.text.locs",
-  "version": "0.1.6",
-  "main": "index.js",
+  "version": "0.1.8",
+  "description": "",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src",
+    "tsconfig.json"
+  ],
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "npx @vnejs/monorepo package",
     "publish:major:plugin": "npm run publish:major",
     "publish:minor:plugin": "npm run publish:minor",
     "publish:patch:plugin": "npm run publish:patch",
-    "publish:major": "npm version major && npm publish --access public",
-    "publish:minor": "npm version minor && npm publish --access public",
-    "publish:patch": "npm version patch && npm publish --access public"
+    "publish:major": "npx @vnejs/monorepo publish major --access public",
+    "publish:minor": "npx @vnejs/monorepo publish minor --access public",
+    "publish:patch": "npx @vnejs/monorepo publish patch --access public"
   },
   "author": "",
   "license": "ISC",
-  "description": ""
+  "dependencies": {
+    "@vnejs/plugins.text.locs.contract": "~0.0.1"
+  },
+  "peerDependencies": {
+    "@vnejs/helpers": "~0.1.0",
+    "@vnejs/module": "~0.0.1",
+    "@vnejs/plugins.core.components.contract": "~0.0.1",
+    "@vnejs/plugins.core.memory.contract": "~0.0.1",
+    "@vnejs/plugins.core.scenario.contract": "~0.0.1",
+    "@vnejs/plugins.core.settings.contract": "~0.0.1",
+    "@vnejs/plugins.core.system.contract": "~0.0.1",
+    "@vnejs/plugins.text.contract": "~0.0.1",
+    "@vnejs/shared": "~0.0.9"
+  },
+  "devDependencies": {
+    "@vnejs/configs.ts-common": "~0.0.1"
+  }
 }

package/src/index.ts

@@ -0,0 +1,6 @@
+import { regPlugin } from "@vnejs/shared";
+import { PARAMS, PLUGIN_NAME, SETTINGS_KEYS, SUBSCRIBE_EVENTS } from "@vnejs/plugins.text.locs.contract";
+
+import { TextLocs } from "./modules/locs.js";
+
+regPlugin(PLUGIN_NAME, { events: SUBSCRIBE_EVENTS, settings: SETTINGS_KEYS, params: PARAMS }, [TextLocs]);

package/{modules/locs.js → src/modules/locs.ts}

@@ -1,11 +1,21 @@
 import { Module } from "@vnejs/module";
-
-const toJson = (i) => i.json();
-
-export class TextLocs extends Module {
+import { toJson } from "@vnejs/helpers";
+
+import type { LocsPluginConstants, LocsPluginEvents, LocsPluginParams, LocsPluginSettings } from "../types.js";
+import type {
+  ComponentsInjectResult,
+  LocsComponent,
+  LocsGetPayload,
+  LocsLoadPayload,
+  LocsRecord,
+  SettingsChangedPayload,
+  TextReplaceHandlerPayload,
+} from "../utils/locs.js";
+
+export class TextLocs extends Module<LocsPluginEvents, LocsPluginConstants, LocsPluginSettings, LocsPluginParams> {
   name = "text.locs";
 
-  loading = {};
+  loading: Record<string, Promise<void> | undefined> = {};
 
   subscribe = () => {
     this.on(this.EVENTS.LOCS.LOAD, this.onLocsLoad);
@@ -25,20 +35,22 @@ export class TextLocs extends Module {
 
     return this.setLang(this.shared.settings[this.SETTINGS.LOCS.LANG]);
   };
-  componentsInjectHandler = async (component) => {
-    const result = { field: "locs", value: {} };
 
-    if (component.locLabel) result.value = await this.emitOne(this.EVENTS.LOCS.GET, { label: component.locLabel });
+  componentsInjectHandler = async (component: LocsComponent): Promise<ComponentsInjectResult> => {
+    const result: ComponentsInjectResult = { field: "locs", value: {} };
+
+    if (component.locLabel) result.value = (await this.emitOne(this.EVENTS.LOCS.GET, { label: component.locLabel })) as LocsRecord;
 
     return result;
   };
-  textReplaceHandler = async ({ text = "", label = "" } = {}) => {
-    const locs = await this.emitOne(this.EVENTS.LOCS.GET, { label });
+
+  textReplaceHandler = async ({ text = "", label = "" }: TextReplaceHandlerPayload = {}) => {
+    const locs = (await this.emitOne(this.EVENTS.LOCS.GET, { label })) as LocsRecord | undefined;
 
     return locs?.[text] || text;
   };
 
-  onLocsLoad = async ({ label, lang } = {}) => {
+  onLocsLoad = async ({ label, lang }: LocsLoadPayload = {}) => {
     await this.waitRerenderCheck(this.checkLang);
 
     const mediaId = `${lang || this.shared.lang}:${label}`;
@@ -49,6 +61,7 @@ export class TextLocs extends Module {
 
     return this.loadLoc(label);
   };
+
   onLocsChanged = async () => {
     const { label } = this.globalState.scenario;
 
@@ -58,7 +71,8 @@ export class TextLocs extends Module {
 
     await this.emit(this.EVENTS.TEXT.RECALC);
   };
-  onLocsGet = async ({ label = this.PARAMS.SCENARIO.INIT_LABEL_NAME, lang = null } = {}) => {
+
+  onLocsGet = async ({ label = this.PARAMS.SCENARIO.INIT_LABEL_NAME, lang = null }: LocsGetPayload = {}) => {
     await this.waitRerenderCheck(this.checkLang);
 
     const loadedLocs = await this.getLoadedLocs(label, lang);
@@ -69,14 +83,17 @@ export class TextLocs extends Module {
 
     return this.getLoadedLocs(label, lang);
   };
-  onSettingChange = ({ name, value } = {}) => name === this.SETTINGS.LOCS.LANG && this.setLang(value);
 
-  getLoadedLocs = (label, lang) => this.emitOne(this.EVENTS.MEMORY.GET, { module: this.name, key: `${lang || this.shared.lang}:${label}` });
-  loadLoc = (label) => {
-    const [loadingId, url] = [`${this.shared.lang}:${label}`, this.media.locs[`${this.shared.lang}/${label}`]];
+  onSettingChange = ({ name, value }: SettingsChangedPayload = {}) => name === this.SETTINGS.LOCS.LANG && this.setLang(value as string);
+
+  getLoadedLocs = (label?: string, lang?: string | null) =>
+    this.emitOne(this.EVENTS.MEMORY.GET, { module: this.name, key: `${lang || this.shared.lang}:${label}` });
+
+  loadLoc = (label?: string) => {
+    const [loadingId, url] = [`${this.shared.lang}:${label}`, this.media.locs?.[`${this.shared.lang}/${label}`]];
 
     const promiseFunc = async () => {
-      const value = url ? await fetch(`${this.CONST.SYSTEM.HOST}/${url}`).then(toJson) : {};
+      const value = url ? ((await fetch(`${this.CONST.SYSTEM.HOST}/${url}`).then(toJson)) as LocsRecord) : {};
 
       await this.emit(this.EVENTS.MEMORY.SET, { module: this.name, key: loadingId, value });
 
@@ -87,10 +104,12 @@ export class TextLocs extends Module {
 
     return this.loading[loadingId];
   };
-  setLang = (lang) => {
+
+  setLang = (lang: string) => {
     this.shared.lang = lang;
 
     return this.emit(this.EVENTS.LOCS.CHANGED);
   };
-  checkLang = () => this.shared.lang;
+
+  checkLang = (): boolean => Boolean(this.shared.lang);
 }

package/src/types.ts

@@ -0,0 +1,23 @@
+import type { VnePluginConstantsMapRegistry, VnePluginEventsMapRegistry, VnePluginParamsMapRegistry, VnePluginSettingsMapRegistry } from "@vnejs/shared";
+import type { PluginName as ComponentsPluginName, SubscribeEvents as ComponentsSubscribeEvents } from "@vnejs/plugins.core.components.contract";
+import type { PluginName as MemoryPluginName, SubscribeEvents as MemorySubscribeEvents } from "@vnejs/plugins.core.memory.contract";
+import type { Params as ScenarioParams, PluginName as ScenarioPluginName, SubscribeEvents as ScenarioSubscribeEvents } from "@vnejs/plugins.core.scenario.contract";
+import type { PluginName as SettingsPluginName, SubscribeEvents as SettingsSubscribeEvents } from "@vnejs/plugins.core.settings.contract";
+import type { Constants as SystemConstants, PluginName as SystemPluginName, SubscribeEvents as SystemSubscribeEvents } from "@vnejs/plugins.core.system.contract";
+import type { PluginName as TextPluginName, SubscribeEvents as TextSubscribeEvents } from "@vnejs/plugins.text.contract";
+import type { Params, PluginName, SettingsKeys, SubscribeEvents } from "@vnejs/plugins.text.locs.contract";
+
+export type LocsPluginEvents = VnePluginEventsMapRegistry &
+  Record<PluginName, SubscribeEvents> &
+  Record<ComponentsPluginName, ComponentsSubscribeEvents> &
+  Record<MemoryPluginName, MemorySubscribeEvents> &
+  Record<ScenarioPluginName, ScenarioSubscribeEvents> &
+  Record<SettingsPluginName, SettingsSubscribeEvents> &
+  Record<SystemPluginName, SystemSubscribeEvents> &
+  Record<TextPluginName, TextSubscribeEvents>;
+
+export type LocsPluginConstants = VnePluginConstantsMapRegistry & Record<SystemPluginName, SystemConstants>;
+
+export type LocsPluginSettings = VnePluginSettingsMapRegistry & Record<PluginName, SettingsKeys>;
+
+export type LocsPluginParams = VnePluginParamsMapRegistry & Record<PluginName, Params> & Record<ScenarioPluginName, ScenarioParams>;

package/src/utils/locs.ts

@@ -0,0 +1,32 @@
+export type LocsRecord = Record<string, string>;
+
+export type LocsLoadPayload = {
+  label?: string;
+  lang?: string | null;
+};
+
+export type LocsGetPayload = {
+  label?: string;
+  lang?: string | null;
+};
+
+export type LocsComponent = {
+  locLabel?: string;
+};
+
+export type ComponentsInjectResult = {
+  field: string;
+  value: LocsRecord;
+};
+
+export type SettingsChangedPayload = {
+  name?: string;
+  value?: unknown;
+};
+
+export type TextReplaceHandlerPayload = {
+  text?: string;
+  label?: string;
+};
+
+export type ComponentsInjectHandler = (component: LocsComponent) => ComponentsInjectResult | Promise<ComponentsInjectResult>;

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "@vnejs/configs.ts-common/tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "dist"
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["dist", "node_modules"]
+}

package/const/events.js

@@ -1,5 +0,0 @@
-export const SUBSCRIBE_EVENTS = {
-  LOAD: "vne:locs:load",
-  GET: "vne:locs:get",
-  CHANGED: "vne:locs:changed",
-};

package/const/params.js

@@ -1 +0,0 @@
-export const DEFAULT_LANG = "ru";

package/const/settings.js

@@ -1 +0,0 @@
-export const SETTINGS_KEYS = { LANG: "vne:locs:lang" };

package/index.js

@@ -1,9 +0,0 @@
-import { regPlugin } from "@vnejs/shared";
-
-import { SUBSCRIBE_EVENTS } from "./const/events";
-import * as params from "./const/params";
-import { SETTINGS_KEYS } from "./const/settings";
-
-import { TextLocs } from "./modules/locs";
-
-regPlugin("LOCS", { events: SUBSCRIBE_EVENTS, settings: SETTINGS_KEYS, params }, [TextLocs]);