@vnejs/plugins.canvas.sprite.speak 0.1.1 → 0.1.4

package/dist/index.d.ts

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

package/dist/index.js

@@ -0,0 +1,4 @@
+import { regPlugin } from "@vnejs/shared";
+import { PLUGIN_NAME } from "@vnejs/plugins.canvas.sprite.speak.contract";
+import { LayerSpriteSpeak } from "./modules/speak.js";
+regPlugin(PLUGIN_NAME, {}, [LayerSpriteSpeak]);

package/dist/modules/speak.d.ts

@@ -0,0 +1,14 @@
+import { Module } from "@vnejs/module";
+import type { SpriteSpeakPluginConstants, SpriteSpeakPluginEvents, SpriteSpeakPluginParams, SpriteSpeakPluginSettings } from "../types.js";
+import type { SpriteSpeakPreloadPayload, SpriteSpeakRecord, TextEmitPayload } from "../utils/speak.js";
+export declare class LayerSpriteSpeak extends Module<SpriteSpeakPluginEvents, SpriteSpeakPluginConstants, SpriteSpeakPluginSettings, SpriteSpeakPluginParams> {
+    name: string;
+    inProcessSpeaker: string | null;
+    subscribe: () => void;
+    onText: ({ speaker }?: TextEmitPayload) => void;
+    onTextCicle: () => Promise<void | undefined>;
+    onTextEndAnimation: () => Promise<false | void>;
+    onSpritePreload: ({ variation, args, priority }?: SpriteSpeakPreloadPayload) => false | Promise<[unknown[] | undefined, unknown[] | undefined]>;
+    setSpeakOption: (sprite: SpriteSpeakRecord, value: boolean) => Promise<void>;
+    getSpeakerSprite: () => Promise<SpriteSpeakRecord | undefined>;
+}

package/dist/modules/speak.js

@@ -0,0 +1,48 @@
+import { Module } from "@vnejs/module";
+export class LayerSpriteSpeak extends Module {
+    name = "layer.sprite.speak";
+    inProcessSpeaker = null;
+    subscribe = () => {
+        this.on(this.EVENTS.TEXT.EMIT, this.onText);
+        this.on(this.EVENTS.TEXT.CICLE, this.onTextCicle);
+        this.on(this.EVENTS.TEXT.EMIT_END, this.onTextEndAnimation);
+        this.on(this.EVENTS.LAYER_SPRITE.PRELOAD, this.onSpritePreload);
+    };
+    onText = ({ speaker = "" } = {}) => {
+        if (speaker && !this.shared.textNoAnimationSources.length)
+            this.inProcessSpeaker = speaker;
+    };
+    onTextCicle = async () => {
+        const sprite = await this.getSpeakerSprite();
+        return sprite && this.setSpeakOption(sprite, true);
+    };
+    onTextEndAnimation = async () => {
+        if (!this.inProcessSpeaker || this.shared.textNoAnimationSources.length)
+            return;
+        const sprite = await this.getSpeakerSprite();
+        this.inProcessSpeaker = null;
+        return sprite?.args?.options?.speak && this.setSpeakOption(sprite, false);
+    };
+    onSpritePreload = ({ variation = "", args = {}, priority } = {}) => !args.options &&
+        Promise.all([
+            this.emit(this.EVENTS.LAYER_SPRITE.PRELOAD, { variation, priority, args: { ...args, options: { speak: true } } }),
+            this.emit(this.EVENTS.LAYER_SPRITE.PRELOAD, { variation, priority, args: { ...args, options: { speak: false } } }),
+        ]);
+    setSpeakOption = async (sprite, value) => {
+        const args = (await this.emitOne(this.EVENTS.VENDORS.CLONE, sprite.args));
+        if (!args.options)
+            args.options = {};
+        args.options.speak = value;
+        await this.emit(this.EVENTS.LAYER_SPRITE.CHANGE, { ...sprite, args });
+    };
+    getSpeakerSprite = async () => {
+        for (let i = 0; i < 5; i++) {
+            const sprite = (await this.emitOne(this.EVENTS.LAYER_SPRITE.STATE_GET, { id: this.inProcessSpeaker }));
+            if (sprite) {
+                await this.waitRerender();
+                return this.emitOne(this.EVENTS.LAYER_SPRITE.STATE_GET, { id: this.inProcessSpeaker });
+            }
+            await this.waitRerender();
+        }
+    };
+}

package/dist/types.d.ts

@@ -0,0 +1,9 @@
+import "@vnejs/plugins.text.contract";
+import type { VnePluginConstantsMapRegistry, VnePluginEventsMapRegistry, VnePluginParamsMapRegistry, VnePluginSettingsMapRegistry } from "@vnejs/shared";
+import type { PluginName as SpritePluginName, SubscribeEvents as SpriteSubscribeEvents } from "@vnejs/plugins.canvas.sprite.contract";
+import type { PluginName as TextPluginName, SubscribeEvents as TextSubscribeEvents } from "@vnejs/plugins.text.contract";
+import type { PluginName as VendorsPluginName, SubscribeEvents as VendorsSubscribeEvents } from "@vnejs/plugins.core.vendors.contract";
+export type SpriteSpeakPluginEvents = VnePluginEventsMapRegistry & Record<SpritePluginName, SpriteSubscribeEvents> & Record<TextPluginName, TextSubscribeEvents> & Record<VendorsPluginName, VendorsSubscribeEvents>;
+export type SpriteSpeakPluginConstants = VnePluginConstantsMapRegistry;
+export type SpriteSpeakPluginSettings = VnePluginSettingsMapRegistry;
+export type SpriteSpeakPluginParams = VnePluginParamsMapRegistry;

package/dist/types.js

@@ -0,0 +1 @@
+import "@vnejs/plugins.text.contract";

package/dist/utils/speak.d.ts

@@ -0,0 +1,23 @@
+export type TextEmitPayload = {
+    speaker?: string;
+};
+export type SpriteSpeakArgs = Record<string, unknown> & {
+    parts?: Record<string, string>;
+    options?: {
+        speak?: boolean;
+    };
+};
+export type SpriteSpeakRecord = {
+    id: string;
+    variation?: string;
+    layer?: string;
+    mediaType?: string;
+    position?: string;
+    duration?: number;
+    args?: SpriteSpeakArgs;
+};
+export type SpriteSpeakPreloadPayload = {
+    variation?: string;
+    args?: SpriteSpeakArgs;
+    priority?: string;
+};

package/dist/utils/speak.js

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

package/package.json

@@ -1,17 +1,45 @@
 {
   "name": "@vnejs/plugins.canvas.sprite.speak",
-  "version": "0.1.1",
-  "main": "index.js",
+  "version": "0.1.4",
+  "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.canvas.sprite.speak.contract": "~0.0.1"
+  },
+  "peerDependencies": {
+    "@vnejs/module": "~0.0.1",
+    "@vnejs/plugins.canvas.sprite.contract": "~0.0.1",
+    "@vnejs/plugins.core.vendors.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 { PLUGIN_NAME } from "@vnejs/plugins.canvas.sprite.speak.contract";
+
+import { LayerSpriteSpeak } from "./modules/speak.js";
+
+regPlugin(PLUGIN_NAME, {}, [LayerSpriteSpeak]);

package/src/modules/speak.ts

@@ -0,0 +1,68 @@
+import { Module } from "@vnejs/module";
+
+import type { SpriteSpeakPluginConstants, SpriteSpeakPluginEvents, SpriteSpeakPluginParams, SpriteSpeakPluginSettings } from "../types.js";
+import type { SpriteSpeakArgs, SpriteSpeakPreloadPayload, SpriteSpeakRecord, TextEmitPayload } from "../utils/speak.js";
+
+export class LayerSpriteSpeak extends Module<SpriteSpeakPluginEvents, SpriteSpeakPluginConstants, SpriteSpeakPluginSettings, SpriteSpeakPluginParams> {
+  name = "layer.sprite.speak";
+
+  inProcessSpeaker: string | null = null;
+
+  subscribe = () => {
+    this.on(this.EVENTS.TEXT.EMIT, this.onText);
+    this.on(this.EVENTS.TEXT.CICLE, this.onTextCicle);
+    this.on(this.EVENTS.TEXT.EMIT_END, this.onTextEndAnimation);
+
+    this.on(this.EVENTS.LAYER_SPRITE.PRELOAD, this.onSpritePreload);
+  };
+
+  onText = ({ speaker = "" }: TextEmitPayload = {}) => {
+    if (speaker && !this.shared.textNoAnimationSources.length) this.inProcessSpeaker = speaker;
+  };
+
+  onTextCicle = async () => {
+    const sprite = await this.getSpeakerSprite();
+
+    return sprite && this.setSpeakOption(sprite, true);
+  };
+
+  onTextEndAnimation = async () => {
+    if (!this.inProcessSpeaker || this.shared.textNoAnimationSources.length) return;
+
+    const sprite = await this.getSpeakerSprite();
+
+    this.inProcessSpeaker = null;
+
+    return sprite?.args?.options?.speak && this.setSpeakOption(sprite, false);
+  };
+
+  onSpritePreload = ({ variation = "", args = {}, priority }: SpriteSpeakPreloadPayload = {}) =>
+    !args.options &&
+    Promise.all([
+      this.emit(this.EVENTS.LAYER_SPRITE.PRELOAD, { variation, priority, args: { ...args, options: { speak: true } } }),
+      this.emit(this.EVENTS.LAYER_SPRITE.PRELOAD, { variation, priority, args: { ...args, options: { speak: false } } }),
+    ]);
+
+  setSpeakOption = async (sprite: SpriteSpeakRecord, value: boolean) => {
+    const args = (await this.emitOne(this.EVENTS.VENDORS.CLONE, sprite.args)) as SpriteSpeakArgs;
+
+    if (!args.options) args.options = {};
+    args.options.speak = value;
+
+    await this.emit(this.EVENTS.LAYER_SPRITE.CHANGE, { ...sprite, args });
+  };
+
+  getSpeakerSprite = async () => {
+    for (let i = 0; i < 5; i++) {
+      const sprite = (await this.emitOne(this.EVENTS.LAYER_SPRITE.STATE_GET, { id: this.inProcessSpeaker! })) as SpriteSpeakRecord | undefined;
+
+      if (sprite) {
+        await this.waitRerender();
+
+        return this.emitOne(this.EVENTS.LAYER_SPRITE.STATE_GET, { id: this.inProcessSpeaker! }) as Promise<SpriteSpeakRecord | undefined>;
+      }
+
+      await this.waitRerender();
+    }
+  };
+}

package/src/types.ts

@@ -0,0 +1,17 @@
+import "@vnejs/plugins.text.contract";
+
+import type { VnePluginConstantsMapRegistry, VnePluginEventsMapRegistry, VnePluginParamsMapRegistry, VnePluginSettingsMapRegistry } from "@vnejs/shared";
+import type { PluginName as SpritePluginName, SubscribeEvents as SpriteSubscribeEvents } from "@vnejs/plugins.canvas.sprite.contract";
+import type { PluginName as TextPluginName, SubscribeEvents as TextSubscribeEvents } from "@vnejs/plugins.text.contract";
+import type { PluginName as VendorsPluginName, SubscribeEvents as VendorsSubscribeEvents } from "@vnejs/plugins.core.vendors.contract";
+
+export type SpriteSpeakPluginEvents = VnePluginEventsMapRegistry &
+  Record<SpritePluginName, SpriteSubscribeEvents> &
+  Record<TextPluginName, TextSubscribeEvents> &
+  Record<VendorsPluginName, VendorsSubscribeEvents>;
+
+export type SpriteSpeakPluginConstants = VnePluginConstantsMapRegistry;
+
+export type SpriteSpeakPluginSettings = VnePluginSettingsMapRegistry;
+
+export type SpriteSpeakPluginParams = VnePluginParamsMapRegistry;

package/src/utils/speak.ts

@@ -0,0 +1,26 @@
+export type TextEmitPayload = {
+  speaker?: string;
+};
+
+export type SpriteSpeakArgs = Record<string, unknown> & {
+  parts?: Record<string, string>;
+  options?: {
+    speak?: boolean;
+  };
+};
+
+export type SpriteSpeakRecord = {
+  id: string;
+  variation?: string;
+  layer?: string;
+  mediaType?: string;
+  position?: string;
+  duration?: number;
+  args?: SpriteSpeakArgs;
+};
+
+export type SpriteSpeakPreloadPayload = {
+  variation?: string;
+  args?: SpriteSpeakArgs;
+  priority?: string;
+};

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/index.js

@@ -1,5 +0,0 @@
-import { regPlugin } from "@vnejs/shared";
-
-import { LayerSpriteSpeak } from "./modules/speak";
-
-regPlugin("LAYER_SPRITE_SPEAK", {}, [LayerSpriteSpeak]);

package/modules/speak.js

@@ -1,53 +0,0 @@
-import { Module } from "@vnejs/module";
-
-export class LayerSpriteSpeak extends Module {
-  name = "layer.sprite.speak";
-
-  inProcessSpeaker = null;
-
-  subscribe = () => {
-    this.on(this.EVENTS.TEXT.EMIT, this.onText);
-    this.on(this.EVENTS.TEXT.CICLE, this.onTextCicle);
-    this.on(this.EVENTS.TEXT.EMIT_END, this.onTextEndAnimation);
-  };
-
-  onText = ({ speaker = "" } = {}) => {
-    if (speaker && !this.shared.textNoAnimationSources.length) this.inProcessSpeaker = speaker;
-  };
-  onTextCicle = async () => {
-    const sprite = await this.getSpeakerSprite();
-
-    return sprite && this.setSpeakOption(sprite, true);
-  };
-  onTextEndAnimation = async () => {
-    if (!this.inProcessSpeaker || this.shared.textNoAnimationSources.length) return;
-
-    const sprite = await this.getSpeakerSprite();
-
-    this.inProcessSpeaker = null;
-
-    return sprite?.args?.options?.speak && this.setSpeakOption(sprite, false);
-  };
-
-  setSpeakOption = async (sprite, value) => {
-    const args = await this.emitOne(this.EVENTS.VENDORS.CLONE, sprite.args);
-
-    if (!args.options) args.options = {};
-    args.options.speak = value;
-
-    await this.emit(this.EVENTS.LAYER_SPRITE.CHANGE, { ...sprite, args });
-  };
-  getSpeakerSprite = async () => {
-    for (let i = 0; i < 5; i++) {
-      const sprite = await this.emitOne(this.EVENTS.LAYER_SPRITE.STATE_GET, { id: this.inProcessSpeaker });
-
-      if (sprite) {
-        await this.waitRerender();
-
-        return this.emitOne(this.EVENTS.LAYER_SPRITE.STATE_GET, { id: this.inProcessSpeaker });
-      }
-
-      await this.waitRerender();
-    }
-  };
-}