@drincs/pixi-vn 0.6.5 → 0.6.7

package/dist/types/ChoiceMenuOptionsType.d.mts

@@ -1,10 +1,12 @@
 import ChoiceMenuOption, { ChoiceMenuOptionClose } from '../classes/ChoiceMenuOption.mjs';
 import './LabelIdType.mjs';
 import './StorageElementType.mjs';
-import '../LabelProps-CmRpvUJm.mjs';
+import '../classes/Label.mjs';
 import './StepLabelType.mjs';
 import '@drincs/pixi-vn/dist/override';
+import '../classes/LabelAbstract.mjs';
 import './StepHistoryDataType.mjs';
+import '../interface/LabelProps.mjs';
 import './CloseType.mjs';
 import './LabelRunModeType.mjs';
 

package/dist/types/ChoiceMenuOptionsType.d.ts

@@ -1,10 +1,12 @@
 import ChoiceMenuOption, { ChoiceMenuOptionClose } from '../classes/ChoiceMenuOption.js';
 import './LabelIdType.js';
 import './StorageElementType.js';
-import '../LabelProps-CFV-zRjG.js';
+import '../classes/Label.js';
 import './StepLabelType.js';
 import '@drincs/pixi-vn/dist/override';
+import '../classes/LabelAbstract.js';
 import './StepHistoryDataType.js';
+import '../interface/LabelProps.js';
 import './CloseType.js';
 import './LabelRunModeType.js';
 

package/dist/types/LabelJsonType.d.mts

@@ -0,0 +1,22 @@
+import StepLabelJsonType from './StepLabelJsonType.mjs';
+import './ChoiceMenuOptionsType.mjs';
+import '../classes/ChoiceMenuOption.mjs';
+import './LabelIdType.mjs';
+import './StorageElementType.mjs';
+import '../classes/Label.mjs';
+import './StepLabelType.mjs';
+import '@drincs/pixi-vn/dist/override';
+import '../classes/LabelAbstract.mjs';
+import './StepHistoryDataType.mjs';
+import '../interface/LabelProps.mjs';
+import './CloseType.mjs';
+import './LabelRunModeType.mjs';
+
+/**
+ * Label JSON type
+ */
+type LabelJsonType = {
+    [labelId: string]: StepLabelJsonType[];
+};
+
+export type { LabelJsonType as default };

package/dist/types/LabelJsonType.d.ts

@@ -0,0 +1,22 @@
+import StepLabelJsonType from './StepLabelJsonType.js';
+import './ChoiceMenuOptionsType.js';
+import '../classes/ChoiceMenuOption.js';
+import './LabelIdType.js';
+import './StorageElementType.js';
+import '../classes/Label.js';
+import './StepLabelType.js';
+import '@drincs/pixi-vn/dist/override';
+import '../classes/LabelAbstract.js';
+import './StepHistoryDataType.js';
+import '../interface/LabelProps.js';
+import './CloseType.js';
+import './LabelRunModeType.js';
+
+/**
+ * Label JSON type
+ */
+type LabelJsonType = {
+    [labelId: string]: StepLabelJsonType[];
+};
+
+export type { LabelJsonType as default };

package/dist/types/LabelJsonType.js

@@ -0,0 +1,4 @@
+'use strict';
+
+//# sourceMappingURL=LabelJsonType.js.map
+//# sourceMappingURL=LabelJsonType.js.map

package/dist/types/LabelJsonType.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"LabelJsonType.js"}

package/dist/types/LabelJsonType.mjs

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=LabelJsonType.mjs.map
+//# sourceMappingURL=LabelJsonType.mjs.map

package/dist/types/LabelJsonType.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"LabelJsonType.mjs"}

package/dist/types/StepLabelJsonType.d.mts

@@ -0,0 +1,30 @@
+import { ChoiceMenuOptionsType } from './ChoiceMenuOptionsType.mjs';
+import '../classes/ChoiceMenuOption.mjs';
+import './LabelIdType.mjs';
+import './StorageElementType.mjs';
+import '../classes/Label.mjs';
+import './StepLabelType.mjs';
+import '@drincs/pixi-vn/dist/override';
+import '../classes/LabelAbstract.mjs';
+import './StepHistoryDataType.mjs';
+import '../interface/LabelProps.mjs';
+import './CloseType.mjs';
+import './LabelRunModeType.mjs';
+
+/**
+ * Step label JSON type
+ */
+type StepLabelJsonType = {
+    currentChoiceMenuOptions?: ChoiceMenuOptionsType<{}>;
+    dialog?: {
+        character: string;
+        text: string;
+    } | string;
+    labelToOpen?: {
+        labelId: string;
+        type: "jump" | "call";
+    };
+    end?: "game_end" | "label_end";
+};
+
+export type { StepLabelJsonType as default };

package/dist/types/StepLabelJsonType.d.ts

@@ -0,0 +1,30 @@
+import { ChoiceMenuOptionsType } from './ChoiceMenuOptionsType.js';
+import '../classes/ChoiceMenuOption.js';
+import './LabelIdType.js';
+import './StorageElementType.js';
+import '../classes/Label.js';
+import './StepLabelType.js';
+import '@drincs/pixi-vn/dist/override';
+import '../classes/LabelAbstract.js';
+import './StepHistoryDataType.js';
+import '../interface/LabelProps.js';
+import './CloseType.js';
+import './LabelRunModeType.js';
+
+/**
+ * Step label JSON type
+ */
+type StepLabelJsonType = {
+    currentChoiceMenuOptions?: ChoiceMenuOptionsType<{}>;
+    dialog?: {
+        character: string;
+        text: string;
+    } | string;
+    labelToOpen?: {
+        labelId: string;
+        type: "jump" | "call";
+    };
+    end?: "game_end" | "label_end";
+};
+
+export type { StepLabelJsonType as default };

package/dist/types/StepLabelJsonType.js

@@ -0,0 +1,4 @@
+'use strict';
+
+//# sourceMappingURL=StepLabelJsonType.js.map
+//# sourceMappingURL=StepLabelJsonType.js.map

package/dist/types/StepLabelJsonType.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"StepLabelJsonType.js"}

package/dist/types/StepLabelJsonType.mjs

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=StepLabelJsonType.mjs.map
+//# sourceMappingURL=StepLabelJsonType.mjs.map

package/dist/types/StepLabelJsonType.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"StepLabelJsonType.mjs"}

package/dist/types/index.d.mts

@@ -2,13 +2,17 @@ export { default as CanvasEventNamesType } from './CanvasEventNamesType.mjs';
 export { ChoiceMenuOptionsType } from './ChoiceMenuOptionsType.mjs';
 export { Close, CloseType } from './CloseType.mjs';
 export { default as HistoryChoiceMenuOption } from './HistoryChoiceMenuOption.mjs';
+export { default as LabelJsonType } from './LabelJsonType.mjs';
 export { default as LabelRunModeType } from './LabelRunModeType.mjs';
 export { PauseType } from './PauseType.mjs';
 export { RepeatType } from './RepeatType.mjs';
+export { default as StepLabelJsonType } from './StepLabelJsonType.mjs';
 export { StepLabelPropsType, StepLabelResultType, StepLabelType } from './StepLabelType.mjs';
 export { StorageElementType, StorageObjectType } from './StorageElementType.mjs';
 import '../classes/ChoiceMenuOption.mjs';
 import './LabelIdType.mjs';
-import '../LabelProps-CmRpvUJm.mjs';
+import '../classes/Label.mjs';
+import '../classes/LabelAbstract.mjs';
 import './StepHistoryDataType.mjs';
+import '../interface/LabelProps.mjs';
 import '@drincs/pixi-vn/dist/override';

package/dist/types/index.d.ts

@@ -2,13 +2,17 @@ export { default as CanvasEventNamesType } from './CanvasEventNamesType.js';
 export { ChoiceMenuOptionsType } from './ChoiceMenuOptionsType.js';
 export { Close, CloseType } from './CloseType.js';
 export { default as HistoryChoiceMenuOption } from './HistoryChoiceMenuOption.js';
+export { default as LabelJsonType } from './LabelJsonType.js';
 export { default as LabelRunModeType } from './LabelRunModeType.js';
 export { PauseType } from './PauseType.js';
 export { RepeatType } from './RepeatType.js';
+export { default as StepLabelJsonType } from './StepLabelJsonType.js';
 export { StepLabelPropsType, StepLabelResultType, StepLabelType } from './StepLabelType.js';
 export { StorageElementType, StorageObjectType } from './StorageElementType.js';
 import '../classes/ChoiceMenuOption.js';
 import './LabelIdType.js';
-import '../LabelProps-CFV-zRjG.js';
+import '../classes/Label.js';
+import '../classes/LabelAbstract.js';
 import './StepHistoryDataType.js';
+import '../interface/LabelProps.js';
 import '@drincs/pixi-vn/dist/override';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@drincs/pixi-vn",
-  "version": "0.6.5",
+  "version": "0.6.7",
   "description": "Pixi'VN is a npm package that provides various features for creating visual novels.",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -22,8 +22,9 @@
     "url": "https://github.com/DRincs-Productions/pixi-vn/issues"
   },
   "homepage": "https://pixi-vn.web.app/",
+  "funding": "https://github.com/DRincs-Productions/pixi-vn?sponsor=1",
   "devDependencies": {
-    "@drincs/pixi-vn": "^0.6.4",
+    "@drincs/pixi-vn": "^0.6.6",
     "@types/crypto-js": "^4.2.2",
     "@types/css-font-loading-module": "^0.0.13",
     "@types/deep-diff": "^1.0.5",

package/dist/LabelProps-CFV-zRjG.d.ts

@@ -1,113 +0,0 @@
-import { LabelIdType } from './types/LabelIdType.js';
-import { StepLabelType } from './types/StepLabelType.js';
-import { StepHistoryDataType } from './types/StepHistoryDataType.js';
-
-/**
- * Label is a class that contains a list of steps, which will be performed as the game continues.
- * For Ren'py this is the equivalent of a label.
- * @example
- * ```typescript
- * const START_LABEL_ID = "StartLabel"
- *
- * export const startLabel = newLabel(START_LABEL_ID,
- *     [
- *         (props) => {
- *             GameWindowManager.clear()
- *             setDialogue({ character: liam, text: "Which test do you want to perform?" })
- *             setChoiceMenuOptions([
- *                 new ChoiceMenuOption("Events Test", eventsTestLabel),
- *                 new ChoiceMenuOption("Show Image Test", showImageTest),
- *             ])
- *         },
- *         (props) => GameStepManager.jumpLabel(START_LABEL_ID, props),
- *     ]
- * )
- *
- * GameStepManager.callLabel(StartLabel)
- * ```
- */
-declare class Label<T extends {} = {}> {
-    /**
-     * @param id is the id of the label
-     * @param steps is the list of steps that the label will perform
-     * @param props is the properties of the label
-     */
-    constructor(id: LabelIdType, steps: StepLabelType<T>[] | (() => StepLabelType<T>[]), props?: LabelProps<T>);
-    private _id;
-    /**
-     * Get the id of the label. This variable is used in the system to get the label by id, {@link getLabelById}
-     */
-    get id(): LabelIdType;
-    private _steps;
-    /**
-     * Get the steps of the label.
-     * This class should be extended and the steps method should be overridden.
-     * Every time you update this list will also be updated when the other game versions load.
-     */
-    get steps(): StepLabelType<T>[];
-    /**
-     * Get the corresponding steps number
-     * @param externalSteps
-     * @returns Numer of corresponding steps, for example, if externalSteps is [ABC, DEF, GHI] and the steps of the label is [ABC, GHT], the result will be 1
-     */
-    getCorrespondingStepsNumber(externalSteps: StepHistoryDataType[] | StepLabelType[]): number;
-    private _onStepStart;
-    /**
-     * Is a function that will be executed in {@link Label#onStepStart} and when the user goes back to it or when the user laods a save file.
-     * @returns Promise<void> or void
-     */
-    get onStepStart(): ((stepIndex: number, label: Label<T>) => void | Promise<void>) | undefined;
-    private _onLoadStep;
-    /**
-     * Get the function that will be executed a old step is reloaded. A step is reloaded when the user goes back to it or when the user laods a save file.
-     * @returns Promise<void> or void
-     */
-    get onLoadStep(): ((stepIndex: number, label: Label<T>) => void | Promise<void>) | undefined;
-    private _onStepEnd;
-    /**
-     * Is a function that will be executed when the step ends.
-     * @returns Promise<void> or void
-     */
-    get onStepEnd(): ((stepIndex: number, label: Label<T>) => void | Promise<void>) | undefined;
-    private _choiseIndex;
-    get choiseIndex(): number | undefined;
-}
-
-interface LabelProps<T extends {}> {
-    /**
-     * Is a function that will be executed before any step is executed, is useful for example to make sure all images used have been cached.
-     * @param stepIndex Step index
-     * @param label Label
-     * @returns
-     * @example
-     * ```typescript
-     * newLabel("id", [], {
-     *     onStepStart: async (stepIndex, label) => {
-     *         await Assets.load('path/to/image1.png')
-     *         await Assets.load('path/to/image2.png')
-     *     }
-     * })
-     * ```
-     */
-    onStepStart?: (stepIndex: number, label: Label<T>) => void | Promise<void>;
-    /**
-     * Is a function that will be executed in {@link Label#onStepStart} and when the user goes back to it or when the user laods a save file.
-     * @param stepIndex Step index
-     * @param label Label
-     * @returns
-     */
-    onLoadStep?: (stepIndex: number, label: Label<T>) => void | Promise<void>;
-    /**
-     * Is a function that will be executed when the step ends.
-     * @param stepIndex Step index
-     * @param label Label
-     * @returns
-     */
-    onStepEnd?: (stepIndex: number, label: Label<T>) => void | Promise<void>;
-    /**
-     * Is the index of the choice that the label will perform. This variable is used in the system.
-     */
-    choiseIndex?: number;
-}
-
-export { Label as L, type LabelProps as a };

package/dist/LabelProps-CmRpvUJm.d.mts

@@ -1,113 +0,0 @@
-import { LabelIdType } from './types/LabelIdType.mjs';
-import { StepLabelType } from './types/StepLabelType.mjs';
-import { StepHistoryDataType } from './types/StepHistoryDataType.mjs';
-
-/**
- * Label is a class that contains a list of steps, which will be performed as the game continues.
- * For Ren'py this is the equivalent of a label.
- * @example
- * ```typescript
- * const START_LABEL_ID = "StartLabel"
- *
- * export const startLabel = newLabel(START_LABEL_ID,
- *     [
- *         (props) => {
- *             GameWindowManager.clear()
- *             setDialogue({ character: liam, text: "Which test do you want to perform?" })
- *             setChoiceMenuOptions([
- *                 new ChoiceMenuOption("Events Test", eventsTestLabel),
- *                 new ChoiceMenuOption("Show Image Test", showImageTest),
- *             ])
- *         },
- *         (props) => GameStepManager.jumpLabel(START_LABEL_ID, props),
- *     ]
- * )
- *
- * GameStepManager.callLabel(StartLabel)
- * ```
- */
-declare class Label<T extends {} = {}> {
-    /**
-     * @param id is the id of the label
-     * @param steps is the list of steps that the label will perform
-     * @param props is the properties of the label
-     */
-    constructor(id: LabelIdType, steps: StepLabelType<T>[] | (() => StepLabelType<T>[]), props?: LabelProps<T>);
-    private _id;
-    /**
-     * Get the id of the label. This variable is used in the system to get the label by id, {@link getLabelById}
-     */
-    get id(): LabelIdType;
-    private _steps;
-    /**
-     * Get the steps of the label.
-     * This class should be extended and the steps method should be overridden.
-     * Every time you update this list will also be updated when the other game versions load.
-     */
-    get steps(): StepLabelType<T>[];
-    /**
-     * Get the corresponding steps number
-     * @param externalSteps
-     * @returns Numer of corresponding steps, for example, if externalSteps is [ABC, DEF, GHI] and the steps of the label is [ABC, GHT], the result will be 1
-     */
-    getCorrespondingStepsNumber(externalSteps: StepHistoryDataType[] | StepLabelType[]): number;
-    private _onStepStart;
-    /**
-     * Is a function that will be executed in {@link Label#onStepStart} and when the user goes back to it or when the user laods a save file.
-     * @returns Promise<void> or void
-     */
-    get onStepStart(): ((stepIndex: number, label: Label<T>) => void | Promise<void>) | undefined;
-    private _onLoadStep;
-    /**
-     * Get the function that will be executed a old step is reloaded. A step is reloaded when the user goes back to it or when the user laods a save file.
-     * @returns Promise<void> or void
-     */
-    get onLoadStep(): ((stepIndex: number, label: Label<T>) => void | Promise<void>) | undefined;
-    private _onStepEnd;
-    /**
-     * Is a function that will be executed when the step ends.
-     * @returns Promise<void> or void
-     */
-    get onStepEnd(): ((stepIndex: number, label: Label<T>) => void | Promise<void>) | undefined;
-    private _choiseIndex;
-    get choiseIndex(): number | undefined;
-}
-
-interface LabelProps<T extends {}> {
-    /**
-     * Is a function that will be executed before any step is executed, is useful for example to make sure all images used have been cached.
-     * @param stepIndex Step index
-     * @param label Label
-     * @returns
-     * @example
-     * ```typescript
-     * newLabel("id", [], {
-     *     onStepStart: async (stepIndex, label) => {
-     *         await Assets.load('path/to/image1.png')
-     *         await Assets.load('path/to/image2.png')
-     *     }
-     * })
-     * ```
-     */
-    onStepStart?: (stepIndex: number, label: Label<T>) => void | Promise<void>;
-    /**
-     * Is a function that will be executed in {@link Label#onStepStart} and when the user goes back to it or when the user laods a save file.
-     * @param stepIndex Step index
-     * @param label Label
-     * @returns
-     */
-    onLoadStep?: (stepIndex: number, label: Label<T>) => void | Promise<void>;
-    /**
-     * Is a function that will be executed when the step ends.
-     * @param stepIndex Step index
-     * @param label Label
-     * @returns
-     */
-    onStepEnd?: (stepIndex: number, label: Label<T>) => void | Promise<void>;
-    /**
-     * Is the index of the choice that the label will perform. This variable is used in the system.
-     */
-    choiseIndex?: number;
-}
-
-export { Label as L, type LabelProps as a };