@vnejs/contracts.canvas.child.sprite 0.1.2 → 0.2.0

package/dist/events.d.ts

@@ -9,6 +9,5 @@ export declare const SUBSCRIBE_EVENTS: {
     readonly STATE_GET: "vne:layer_sprite:state_get";
     readonly STATE_ADD: "vne:layer_sprite:state_add";
     readonly STATE_RM: "vne:layer_sprite:state_rm";
-    readonly STATE_SETTED: "vne:layer_sprite:state_setted";
 };
 export type SubscribeEvents = typeof SUBSCRIBE_EVENTS;

package/dist/events.js

@@ -9,5 +9,4 @@ export const SUBSCRIBE_EVENTS = {
     STATE_GET: "vne:layer_sprite:state_get",
     STATE_ADD: "vne:layer_sprite:state_add",
     STATE_RM: "vne:layer_sprite:state_rm",
-    STATE_SETTED: "vne:layer_sprite:state_setted",
 };

package/dist/index.d.ts

@@ -8,8 +8,9 @@ export { CONSTANTS, ACTIONS, LAYER_CHILD_TYPE } from "./const.js";
 export type { Constants } from "./const.js";
 export { SUBSCRIBE_EVENTS };
 export type { SubscribeEvents } from "./events.js";
-export { PARAMS, TRANSITIONS_SHOW, TRANSITIONS_HIDE, POSITIONS, SPRITE_INFO } from "./params.js";
+export { PARAMS, TRANSITIONS_SHOW, TRANSITIONS_HIDE, TRANSITION_SHOW_NAMES, TRANSITION_HIDE_NAMES, POSITIONS, POSITION_NAMES, SPRITE_INFO, } from "./params.js";
 export type { Params, SpriteBoxProps, SpriteInfo, SpriteTransitionProps } from "./params.js";
+export { SPRITE_LINE_COMMAND } from "./scenario-command.js";
 declare module "@vnejs/shared" {
     interface VnePluginEventsMap extends Record<typeof PLUGIN_NAME, typeof SUBSCRIBE_EVENTS> {
     }

package/dist/index.js

@@ -3,4 +3,5 @@ import { SUBSCRIBE_EVENTS } from "./events.js";
 export const PLUGIN_NAME = "LAYER_SPRITE";
 export { CONSTANTS, ACTIONS, LAYER_CHILD_TYPE } from "./const.js";
 export { SUBSCRIBE_EVENTS };
-export { PARAMS, TRANSITIONS_SHOW, TRANSITIONS_HIDE, POSITIONS, SPRITE_INFO } from "./params.js";
+export { PARAMS, TRANSITIONS_SHOW, TRANSITIONS_HIDE, TRANSITION_SHOW_NAMES, TRANSITION_HIDE_NAMES, POSITIONS, POSITION_NAMES, SPRITE_INFO, } from "./params.js";
+export { SPRITE_LINE_COMMAND } from "./scenario-command.js";

package/dist/params.d.ts

@@ -15,11 +15,11 @@ export type SpriteTransitionProps = {
 };
 export type SpriteInfo = {
     mapParts?: (parts: Record<string, string>) => Record<string, string>;
-    getSrc?: (variation: string, realParts: Record<string, string>, options: Record<string, unknown>, otherArgs: Record<string, unknown>) => Array<string | {
+    getSrc?: (variation: string, realParts: Record<string, string>, options: Record<string, unknown>, otherArgs: Record<string, unknown>) => Array<string | ({
         src?: Array<{
             url: string;
         } & Record<string, unknown>>;
-    } & Record<string, unknown>>;
+    } & Record<string, unknown>)>;
 };
 export declare const TRANSITIONS_SHOW: Record<string, (boxProps: SpriteBoxProps) => SpriteTransitionProps>;
 export declare const TRANSITIONS_HIDE: Record<string, (boxProps: SpriteBoxProps) => SpriteTransitionProps>;
@@ -67,6 +67,27 @@ export declare const POSITIONS: {
         readonly transformOriginY: "100%";
     };
 };
+/** Scenario literals for sprite position tokens (keys of POSITIONS). */
+export declare const POSITION_NAMES: {
+    readonly LEFT: "left";
+    readonly LEFT10: "left10";
+    readonly CENTER_LEFT: "centerLeft";
+    readonly CENTER: "center";
+    readonly CENTER_RIGHT: "centerRight";
+    readonly RIGHT: "right";
+};
+/** Scenario literals for show transitions (keys of TRANSITIONS_SHOW). */
+export declare const TRANSITION_SHOW_NAMES: {
+    readonly OPACITY: "opacity";
+    readonly LEFT_OPACITY: "leftOpacity";
+    readonly RIGHT_OPACITY: "rightOpacity";
+};
+/** Scenario literals for hide transitions (keys of TRANSITIONS_HIDE). */
+export declare const TRANSITION_HIDE_NAMES: {
+    readonly OPACITY: "opacity";
+    readonly LEFT_OPACITY: "leftOpacity";
+    readonly RIGHT_OPACITY: "rightOpacity";
+};
 export declare const SPRITE_INFO: Record<string, SpriteInfo>;
 declare const PARAMS_DEFAULT: {
     TRANSITIONS_SHOW: Record<string, (boxProps: SpriteBoxProps) => SpriteTransitionProps>;

package/dist/params.js

@@ -28,6 +28,27 @@ export const POSITIONS = {
     centerRight: { left: "75%", bottom: 0, translateX: "-50%", transformOriginX: "50%", transformOriginY: "100%" },
     right: { left: "100%", bottom: 0, translateX: "-100%", transformOriginX: "100%", transformOriginY: "100%" },
 };
+/** Scenario literals for sprite position tokens (keys of POSITIONS). */
+export const POSITION_NAMES = {
+    LEFT: "left",
+    LEFT10: "left10",
+    CENTER_LEFT: "centerLeft",
+    CENTER: "center",
+    CENTER_RIGHT: "centerRight",
+    RIGHT: "right",
+};
+/** Scenario literals for show transitions (keys of TRANSITIONS_SHOW). */
+export const TRANSITION_SHOW_NAMES = {
+    OPACITY: "opacity",
+    LEFT_OPACITY: "leftOpacity",
+    RIGHT_OPACITY: "rightOpacity",
+};
+/** Scenario literals for hide transitions (keys of TRANSITIONS_HIDE). */
+export const TRANSITION_HIDE_NAMES = {
+    OPACITY: "opacity",
+    LEFT_OPACITY: "leftOpacity",
+    RIGHT_OPACITY: "rightOpacity",
+};
 export const SPRITE_INFO = {};
 const PARAMS_DEFAULT = {
     TRANSITIONS_SHOW,

package/dist/scenario-command.d.ts

@@ -0,0 +1,86 @@
+/** Shared `$ <layer>.sprite` command surface for layer contracts. */
+export declare const SPRITE_LINE_COMMAND: {
+    readonly actions: {
+        readonly SHOW: "show";
+        readonly HIDE: "hide";
+        readonly CHANGE: "change";
+        readonly MOVE: "move";
+    };
+    readonly argsByAction: {
+        readonly show: readonly [{
+            readonly kind: "id";
+        }, {
+            readonly kind: "enum";
+            readonly values: {
+                readonly LEFT: "left";
+                readonly LEFT10: "left10";
+                readonly CENTER_LEFT: "centerLeft";
+                readonly CENTER: "center";
+                readonly CENTER_RIGHT: "centerRight";
+                readonly RIGHT: "right";
+            };
+        }, {
+            readonly kind: "id";
+            readonly optional: true;
+            readonly delimited: true;
+        }, {
+            readonly kind: "enum";
+            readonly values: {
+                readonly OPACITY: "opacity";
+                readonly LEFT_OPACITY: "leftOpacity";
+                readonly RIGHT_OPACITY: "rightOpacity";
+            };
+            readonly optional: true;
+        }, {
+            readonly kind: "number";
+            readonly optional: true;
+        }];
+        readonly hide: readonly [{
+            readonly kind: "id";
+        }, {
+            readonly kind: "enum";
+            readonly values: {
+                readonly OPACITY: "opacity";
+                readonly LEFT_OPACITY: "leftOpacity";
+                readonly RIGHT_OPACITY: "rightOpacity";
+            };
+            readonly optional: true;
+        }, {
+            readonly kind: "number";
+            readonly optional: true;
+        }];
+        readonly change: readonly [{
+            readonly kind: "id";
+        }, {
+            readonly kind: "id";
+            readonly delimited: true;
+        }, {
+            readonly kind: "number";
+            readonly optional: true;
+        }];
+        readonly move: readonly [{
+            readonly kind: "id";
+        }, {
+            readonly kind: "enum";
+            readonly values: {
+                readonly LEFT: "left";
+                readonly LEFT10: "left10";
+                readonly CENTER_LEFT: "centerLeft";
+                readonly CENTER: "center";
+                readonly CENTER_RIGHT: "centerRight";
+                readonly RIGHT: "right";
+            };
+        }, {
+            readonly kind: "enum";
+            readonly values: {
+                readonly OPACITY: "opacity";
+                readonly LEFT_OPACITY: "leftOpacity";
+                readonly RIGHT_OPACITY: "rightOpacity";
+            };
+            readonly optional: true;
+        }, {
+            readonly kind: "number";
+            readonly optional: true;
+        }];
+    };
+};

package/dist/scenario-command.js

@@ -0,0 +1,18 @@
+import { ACTIONS } from "./const.js";
+import { POSITION_NAMES, TRANSITION_HIDE_NAMES, TRANSITION_SHOW_NAMES } from "./params.js";
+const ID = { kind: "id" };
+const VARIATION = { kind: "id", optional: true, delimited: true };
+const POSITION = { kind: "enum", values: POSITION_NAMES };
+const SHOW_TRANSITION = { kind: "enum", values: TRANSITION_SHOW_NAMES, optional: true };
+const HIDE_TRANSITION = { kind: "enum", values: TRANSITION_HIDE_NAMES, optional: true };
+const DURATION = { kind: "number", optional: true };
+/** Shared `$ <layer>.sprite` command surface for layer contracts. */
+export const SPRITE_LINE_COMMAND = {
+    actions: ACTIONS,
+    argsByAction: {
+        [ACTIONS.SHOW]: [ID, POSITION, VARIATION, SHOW_TRANSITION, DURATION],
+        [ACTIONS.HIDE]: [ID, HIDE_TRANSITION, DURATION],
+        [ACTIONS.CHANGE]: [ID, { kind: "id", delimited: true }, DURATION],
+        [ACTIONS.MOVE]: [ID, POSITION, SHOW_TRANSITION, DURATION],
+    },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vnejs/contracts.canvas.child.sprite",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "description": "Contracts for @vnejs/plugins.canvas.child.sprite",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -26,9 +26,11 @@
   "author": "",
   "license": "ISC",
   "peerDependencies": {
-    "@vnejs/shared": "~0.1.0"
+    "@vnejs/contracts.core.scenario": "~0.2.0",
+    "@vnejs/shared": "~0.2.0"
   },
   "devDependencies": {
-    "@vnejs/configs.ts-common": "~0.1.0"
+    "@vnejs/configs.ts-common": "~0.2.0",
+    "@vnejs/contracts.core.scenario": "~0.2.0"
   }
 }

package/src/events.ts

@@ -12,7 +12,6 @@ export const SUBSCRIBE_EVENTS = {
   STATE_GET: "vne:layer_sprite:state_get",
   STATE_ADD: "vne:layer_sprite:state_add",
   STATE_RM: "vne:layer_sprite:state_rm",
-  STATE_SETTED: "vne:layer_sprite:state_setted",
 } as const;
 
 export type SubscribeEvents = typeof SUBSCRIBE_EVENTS;

package/src/index.ts

@@ -11,8 +11,18 @@ export { CONSTANTS, ACTIONS, LAYER_CHILD_TYPE } from "./const.js";
 export type { Constants } from "./const.js";
 export { SUBSCRIBE_EVENTS };
 export type { SubscribeEvents } from "./events.js";
-export { PARAMS, TRANSITIONS_SHOW, TRANSITIONS_HIDE, POSITIONS, SPRITE_INFO } from "./params.js";
+export {
+  PARAMS,
+  TRANSITIONS_SHOW,
+  TRANSITIONS_HIDE,
+  TRANSITION_SHOW_NAMES,
+  TRANSITION_HIDE_NAMES,
+  POSITIONS,
+  POSITION_NAMES,
+  SPRITE_INFO,
+} from "./params.js";
 export type { Params, SpriteBoxProps, SpriteInfo, SpriteTransitionProps } from "./params.js";
+export { SPRITE_LINE_COMMAND } from "./scenario-command.js";
 
 declare module "@vnejs/shared" {
   interface VnePluginEventsMap extends Record<typeof PLUGIN_NAME, typeof SUBSCRIBE_EVENTS> {}

package/src/params.ts

@@ -59,6 +59,30 @@ export const POSITIONS = {
   right: { left: "100%", bottom: 0, translateX: "-100%", transformOriginX: "100%", transformOriginY: "100%" },
 } as const;
 
+/** Scenario literals for sprite position tokens (keys of POSITIONS). */
+export const POSITION_NAMES = {
+  LEFT: "left",
+  LEFT10: "left10",
+  CENTER_LEFT: "centerLeft",
+  CENTER: "center",
+  CENTER_RIGHT: "centerRight",
+  RIGHT: "right",
+} as const satisfies Record<string, keyof typeof POSITIONS>;
+
+/** Scenario literals for show transitions (keys of TRANSITIONS_SHOW). */
+export const TRANSITION_SHOW_NAMES = {
+  OPACITY: "opacity",
+  LEFT_OPACITY: "leftOpacity",
+  RIGHT_OPACITY: "rightOpacity",
+} as const satisfies Record<string, keyof typeof TRANSITIONS_SHOW>;
+
+/** Scenario literals for hide transitions (keys of TRANSITIONS_HIDE). */
+export const TRANSITION_HIDE_NAMES = {
+  OPACITY: "opacity",
+  LEFT_OPACITY: "leftOpacity",
+  RIGHT_OPACITY: "rightOpacity",
+} as const satisfies Record<string, keyof typeof TRANSITIONS_HIDE>;
+
 export const SPRITE_INFO: Record<string, SpriteInfo> = {};
 
 const PARAMS_DEFAULT = {

package/src/scenario-command.ts

@@ -0,0 +1,22 @@
+import type { ScenarioCommandEntry } from "@vnejs/contracts.core.scenario";
+
+import { ACTIONS } from "./const.js";
+import { POSITION_NAMES, TRANSITION_HIDE_NAMES, TRANSITION_SHOW_NAMES } from "./params.js";
+
+const ID = { kind: "id" } as const;
+const VARIATION = { kind: "id", optional: true, delimited: true } as const;
+const POSITION = { kind: "enum", values: POSITION_NAMES } as const;
+const SHOW_TRANSITION = { kind: "enum", values: TRANSITION_SHOW_NAMES, optional: true } as const;
+const HIDE_TRANSITION = { kind: "enum", values: TRANSITION_HIDE_NAMES, optional: true } as const;
+const DURATION = { kind: "number", optional: true } as const;
+
+/** Shared `$ <layer>.sprite` command surface for layer contracts. */
+export const SPRITE_LINE_COMMAND = {
+  actions: ACTIONS,
+  argsByAction: {
+    [ACTIONS.SHOW]: [ID, POSITION, VARIATION, SHOW_TRANSITION, DURATION],
+    [ACTIONS.HIDE]: [ID, HIDE_TRANSITION, DURATION],
+    [ACTIONS.CHANGE]: [ID, { kind: "id", delimited: true }, DURATION],
+    [ACTIONS.MOVE]: [ID, POSITION, SHOW_TRANSITION, DURATION],
+  },
+} as const satisfies ScenarioCommandEntry;