@drincs/nqtr 0.7.1 → 0.8.0

package/dist/registries.d.mts

@@ -2,20 +2,6 @@ import { OnRunProps as OnRunProps$1, ActivityInterface as ActivityInterface$1, C
 import { CharacterInterface, CachedMap } from '@drincs/pixi-vn';
 import { StoredClassModel } from '@drincs/pixi-vn/storage';
 
-type ExecutionType = "automatic" | "interaction";
-
-type OnRunProps = OnRunProps$1;
-/**
- * The function that is called when the class is runned.
- */
-type OnRunEvent<T> = (item: T, props: OnRunProps) => any | Promise<any>;
-type OnRunAsyncFunction = (props: OnRunProps) => Promise<any>;
-
-type QuestsRequiredType = {
-    quest: QuestInterface;
-    stageNumber: number;
-};
-
 interface DateSchedulingInterface {
     /**
      * The start date. If the item hasn't started yet, it will be hidden.
@@ -44,21 +30,38 @@ interface TimeSchedulingInterface {
     to?: number;
 }
 
-interface ActivityInterface extends ActivityBaseInternalInterface, ActivityInterface$1 {
-}
-interface ActivityBaseInternalInterface {
-    /**
-     * The id of the activity/commitment.
-     */
-    readonly id: string;
+interface ActiveScheduling {
     /**
      * Time slot in which activity/commitment will be active.
      */
-    readonly timeSlot: TimeSchedulingInterface | undefined;
+    readonly timeSlot?: TimeSchedulingInterface[] | TimeSchedulingInterface;
     /**
      * Used to schedule what date it will be added and removed.
      */
-    readonly dateScheduling: DateSchedulingInterface | undefined;
+    readonly dateScheduling?: DateSchedulingInterface;
+}
+
+type ExecutionType = "automatic" | "interaction";
+
+type OnRunProps = OnRunProps$1;
+/**
+ * The function that is called when the class is runned.
+ */
+type OnRunEvent<T> = (item: T, props: OnRunProps) => any | Promise<any>;
+type OnRunAsyncFunction = (props: OnRunProps) => Promise<any>;
+
+type QuestsRequiredType = {
+    quest: QuestInterface;
+    stageNumber: number;
+};
+
+interface ActivityInterface extends ActivityBaseInternalInterface, ActivityInterface$1 {
+}
+interface ActivityBaseInternalInterface extends ActiveScheduling {
+    /**
+     * The id of the activity/commitment.
+     */
+    readonly id: string;
     /**
      * The function that is called when the activity/commitment is runned.
      */
@@ -70,9 +73,10 @@ interface ActivityBaseInternalInterface {
      */
     readonly expired: boolean;
     /**
-     * Whether the activity/commitment is active.
+     * Whether the activity/commitment is active, so it will be shown in the routine and can be runned.
+     * @param options The options to check if the activity/commitment is active.
      */
-    readonly isActive: boolean;
+    isActive(options?: ActiveScheduling): boolean;
 }
 
 interface CommitmentInterface extends CommitmentBaseInternalInterface, CommitmentInterface$1 {
@@ -82,10 +86,6 @@ interface CommitmentBaseInternalInterface extends ActivityBaseInternalInterface
      * The character or characters that are in the commitment and so in the room.
      */
     readonly characters: CharacterInterface[];
-    /**
-     * The room where the commitment is.
-     */
-    readonly room: RoomInterface;
     /**
      * Execution type. If is "automatic" the onRun() runned automatically when the palayer is in the room. If is "interaction" the player must interact with the character to run the onRun() function.
      * If you set "automatic" remember to remove the commitment when it is no longer needed, because otherwise it repeats itself every time.
@@ -105,22 +105,13 @@ interface NavigationAbstractInterface extends StoredClassModel {
      * @param options
      * @returns
      */
-    addActivity(activity: ActivityInterface, options?: {
-        /**
-         * Time slot in which activity will be active.
-         */
-        timeSlot?: TimeSchedulingInterface;
-        /**
-         * Used to schedule what date it will be added and removed.
-         */
-        dateScheduling?: DateSchedulingInterface;
-    }): void;
+    addActivity(activity: ActivityInterface, options?: ActiveScheduling): void;
     /**
      * Disconnects the activity from the class.
      * @param activity The activity to disconnect from the class.
      * @param options
      */
-    removeActivity(activity: ActivityInterface | string, options?: Pick<DateSchedulingInterface, "to">): void;
+    removeActivity(activity: ActivityInterface | string): void;
     /**
      * Removes the useless activities.
      */
@@ -178,6 +169,19 @@ interface RoomBaseInternalInterface extends NavigationAbstractInterface {
      * The location where the room is.
      */
     readonly location: LocationInterface;
+    /**
+     * Connects the commitment to the class.
+     * @param commitment The commitment to connect to the class.
+     * @param options
+     * @returns
+     */
+    addCommitment(commitment: CommitmentInterface, options?: ActiveScheduling): void;
+    /**
+     * Disconnects the commitment from the class.
+     * @param commitment The commitment to disconnect from the class.
+     * @param options
+     */
+    removeCommitment(commitment: CommitmentInterface | string): void;
     /**
      * Get the character commitments of the room.
      */
@@ -381,7 +385,7 @@ declare namespace RegisteredActivities {
  * The key is the id of the commitment and the value is the commitment itself.
  */
 declare const registeredCommitments: CachedMap<string, CommitmentInterface>;
-declare const fixedCommitments: CachedMap<string, CommitmentInterface>;
+declare const fixedCommitments: CachedMap<string, [CommitmentInterface, string]>;
 declare namespace RegisteredCommitments {
     /**
      * Save a commitment in the registered commitments. If the commitment already exists, it will be overwritten.

package/dist/registries.d.ts

@@ -2,20 +2,6 @@ import { OnRunProps as OnRunProps$1, ActivityInterface as ActivityInterface$1, C
 import { CharacterInterface, CachedMap } from '@drincs/pixi-vn';
 import { StoredClassModel } from '@drincs/pixi-vn/storage';
 
-type ExecutionType = "automatic" | "interaction";
-
-type OnRunProps = OnRunProps$1;
-/**
- * The function that is called when the class is runned.
- */
-type OnRunEvent<T> = (item: T, props: OnRunProps) => any | Promise<any>;
-type OnRunAsyncFunction = (props: OnRunProps) => Promise<any>;
-
-type QuestsRequiredType = {
-    quest: QuestInterface;
-    stageNumber: number;
-};
-
 interface DateSchedulingInterface {
     /**
      * The start date. If the item hasn't started yet, it will be hidden.
@@ -44,21 +30,38 @@ interface TimeSchedulingInterface {
     to?: number;
 }
 
-interface ActivityInterface extends ActivityBaseInternalInterface, ActivityInterface$1 {
-}
-interface ActivityBaseInternalInterface {
-    /**
-     * The id of the activity/commitment.
-     */
-    readonly id: string;
+interface ActiveScheduling {
     /**
      * Time slot in which activity/commitment will be active.
      */
-    readonly timeSlot: TimeSchedulingInterface | undefined;
+    readonly timeSlot?: TimeSchedulingInterface[] | TimeSchedulingInterface;
     /**
      * Used to schedule what date it will be added and removed.
      */
-    readonly dateScheduling: DateSchedulingInterface | undefined;
+    readonly dateScheduling?: DateSchedulingInterface;
+}
+
+type ExecutionType = "automatic" | "interaction";
+
+type OnRunProps = OnRunProps$1;
+/**
+ * The function that is called when the class is runned.
+ */
+type OnRunEvent<T> = (item: T, props: OnRunProps) => any | Promise<any>;
+type OnRunAsyncFunction = (props: OnRunProps) => Promise<any>;
+
+type QuestsRequiredType = {
+    quest: QuestInterface;
+    stageNumber: number;
+};
+
+interface ActivityInterface extends ActivityBaseInternalInterface, ActivityInterface$1 {
+}
+interface ActivityBaseInternalInterface extends ActiveScheduling {
+    /**
+     * The id of the activity/commitment.
+     */
+    readonly id: string;
     /**
      * The function that is called when the activity/commitment is runned.
      */
@@ -70,9 +73,10 @@ interface ActivityBaseInternalInterface {
      */
     readonly expired: boolean;
     /**
-     * Whether the activity/commitment is active.
+     * Whether the activity/commitment is active, so it will be shown in the routine and can be runned.
+     * @param options The options to check if the activity/commitment is active.
      */
-    readonly isActive: boolean;
+    isActive(options?: ActiveScheduling): boolean;
 }
 
 interface CommitmentInterface extends CommitmentBaseInternalInterface, CommitmentInterface$1 {
@@ -82,10 +86,6 @@ interface CommitmentBaseInternalInterface extends ActivityBaseInternalInterface
      * The character or characters that are in the commitment and so in the room.
      */
     readonly characters: CharacterInterface[];
-    /**
-     * The room where the commitment is.
-     */
-    readonly room: RoomInterface;
     /**
      * Execution type. If is "automatic" the onRun() runned automatically when the palayer is in the room. If is "interaction" the player must interact with the character to run the onRun() function.
      * If you set "automatic" remember to remove the commitment when it is no longer needed, because otherwise it repeats itself every time.
@@ -105,22 +105,13 @@ interface NavigationAbstractInterface extends StoredClassModel {
      * @param options
      * @returns
      */
-    addActivity(activity: ActivityInterface, options?: {
-        /**
-         * Time slot in which activity will be active.
-         */
-        timeSlot?: TimeSchedulingInterface;
-        /**
-         * Used to schedule what date it will be added and removed.
-         */
-        dateScheduling?: DateSchedulingInterface;
-    }): void;
+    addActivity(activity: ActivityInterface, options?: ActiveScheduling): void;
     /**
      * Disconnects the activity from the class.
      * @param activity The activity to disconnect from the class.
      * @param options
      */
-    removeActivity(activity: ActivityInterface | string, options?: Pick<DateSchedulingInterface, "to">): void;
+    removeActivity(activity: ActivityInterface | string): void;
     /**
      * Removes the useless activities.
      */
@@ -178,6 +169,19 @@ interface RoomBaseInternalInterface extends NavigationAbstractInterface {
      * The location where the room is.
      */
     readonly location: LocationInterface;
+    /**
+     * Connects the commitment to the class.
+     * @param commitment The commitment to connect to the class.
+     * @param options
+     * @returns
+     */
+    addCommitment(commitment: CommitmentInterface, options?: ActiveScheduling): void;
+    /**
+     * Disconnects the commitment from the class.
+     * @param commitment The commitment to disconnect from the class.
+     * @param options
+     */
+    removeCommitment(commitment: CommitmentInterface | string): void;
     /**
      * Get the character commitments of the room.
      */
@@ -381,7 +385,7 @@ declare namespace RegisteredActivities {
  * The key is the id of the commitment and the value is the commitment itself.
  */
 declare const registeredCommitments: CachedMap<string, CommitmentInterface>;
-declare const fixedCommitments: CachedMap<string, CommitmentInterface>;
+declare const fixedCommitments: CachedMap<string, [CommitmentInterface, string]>;
 declare namespace RegisteredCommitments {
     /**
      * Save a commitment in the registered commitments. If the commitment already exists, it will be overwritten.

package/dist/registries.mjs

@@ -1 +1 @@
-import {CachedMap}from'@drincs/pixi-vn';var t;(n=>(n.log=(e,...r)=>console.log(`[NQTR] ${e}`,...r),n.warn=(e,...r)=>console.warn(`[NQTR] ${e}`,...r),n.error=(e,...r)=>console.error(`[NQTR] ${e}`,...r),n.info=(e,...r)=>console.info(`[NQTR] ${e}`,...r)))(t||(t={}));var s=new CachedMap({cacheSize:20}),l;(n=>{function o(e){if(Array.isArray(e)){e.forEach(r=>n.add(r));return}s.set(e.id,e);}n.add=o;function a(e){try{let r=s.get(e);if(!r){console.warn(`[NQTR] Activity ${e} not found, you should register it first`);return}return r}catch(r){t.error(`Error while getting Activity ${e}`,r);return}}n.get=a;function i(){return Array.from(s.values())}n.values=i;function f(e){return s.has(e)}n.has=f;})(l||(l={}));var M=l;var c=new CachedMap({cacheSize:20}),$=new CachedMap({cacheSize:20}),g;(n=>{function o(e){if(Array.isArray(e)){e.forEach(r=>n.add(r));return}c.set(e.id,e);}n.add=o;function a(e){try{let r=c.get(e);if(!r){console.warn(`[NQTR] Commitment ${e} not found, you should register it first`);return}return r}catch(r){t.error(`Error while getting Commitment ${e}`,r);return}}n.get=a;function i(){return Array.from(c.values())}n.values=i;function f(e){return c.has(e)}n.has=f;})(g||(g={}));var E=g;var u=new CachedMap({cacheSize:20}),y;(n=>{function o(e){if(Array.isArray(e)){e.forEach(r=>o(r));return}u.set(e.id,e);}n.add=o;function a(e){try{let r=u.get(e);if(!r){console.warn(`[NQTR] Location ${e} not found, you should register it first`);return}return r}catch(r){t.error(`Error while getting Location ${e}`,r);return}}n.get=a;function i(){return Array.from(u.values())}n.values=i;function f(e){return u.has(e)}n.has=f;})(y||(y={}));var h=y;var m=new CachedMap({cacheSize:20}),x;(n=>{function o(e){if(Array.isArray(e)){e.forEach(r=>o(r));return}m.set(e.id,e);}n.add=o;function a(e){try{let r=m.get(e);if(!r){console.warn(`[NQTR] Map ${e} not found, you should register it first`);return}return r}catch(r){t.error(`Error while getting Map ${e}`,r);return}}n.get=a;function i(){return Array.from(m.values())}n.values=i;function f(e){return m.has(e)}n.has=f;})(x||(x={}));var I=x;var p=new CachedMap({cacheSize:5}),A;(n=>{function o(e){if(Array.isArray(e)){e.forEach(r=>n.add(r));return}p.set(e.id,e);}n.add=o;function a(e){try{let r=p.get(e);if(!r){console.warn(`[NQTR] Quest ${e} not found, you should register it first`);return}return r}catch(r){t.error(`Error while getting Quest ${e}`,r);return}}n.get=a;function i(){return Array.from(p.values())}n.values=i;function f(e){return p.has(e)}n.has=f;})(A||(A={}));var z=A;var d=new CachedMap({cacheSize:20}),w;(n=>{function o(e){if(Array.isArray(e)){e.forEach(C=>o(C));return}d.set(e.id,e);let r=e.location;h.add(r);let R=r?.map;R&&I.add(R);}n.add=o;function a(e){try{let r=d.get(e);if(!r){console.warn(`[NQTR] Room ${e} not found, you should register it first`);return}return r}catch(r){t.error(`Error while getting Room ${e}`,r);return}}n.get=a;function i(){return Array.from(d.values())}n.values=i;function f(e){return d.has(e)}n.has=f;})(w||(w={}));var b=w;export{M as RegisteredActivities,E as RegisteredCommitments,h as RegisteredLocations,I as RegisteredMaps,z as RegisteredQuests,b as RegisteredRooms,$ as fixedCommitments,c as registeredCommitments};
+import {CachedMap}from'@drincs/pixi-vn';var t;(n=>(n.log=(e,...r)=>console.log(`[NQTR] ${e}`,...r),n.warn=(e,...r)=>console.warn(`[NQTR] ${e}`,...r),n.error=(e,...r)=>console.error(`[NQTR] ${e}`,...r),n.info=(e,...r)=>console.info(`[NQTR] ${e}`,...r)))(t||(t={}));var s=new CachedMap({cacheSize:20}),g;(n=>{function o(e){if(Array.isArray(e)){e.forEach(r=>n.add(r));return}s.set(e.id,e);}n.add=o;function a(e){try{let r=s.get(e);if(!r){console.warn(`[NQTR] Activity ${e} not found, you should register it first`);return}return r}catch(r){t.error(`Error while getting Activity ${e}`,r);return}}n.get=a;function i(){return Array.from(s.values())}n.values=i;function f(e){return s.has(e)}n.has=f;})(g||(g={}));var M=g;var c=new CachedMap({cacheSize:20}),$=new CachedMap({cacheSize:20}),l;(n=>{function o(e){if(Array.isArray(e)){e.forEach(r=>n.add(r));return}c.set(e.id,e);}n.add=o;function a(e){try{let r=c.get(e);if(!r){console.warn(`[NQTR] Commitment ${e} not found, you should register it first`);return}return r}catch(r){t.error(`Error while getting Commitment ${e}`,r);return}}n.get=a;function i(){return Array.from(c.values())}n.values=i;function f(e){return c.has(e)}n.has=f;})(l||(l={}));var E=l;var u=new CachedMap({cacheSize:20}),y;(n=>{function o(e){if(Array.isArray(e)){e.forEach(r=>o(r));return}u.set(e.id,e);}n.add=o;function a(e){try{let r=u.get(e);if(!r){console.warn(`[NQTR] Location ${e} not found, you should register it first`);return}return r}catch(r){t.error(`Error while getting Location ${e}`,r);return}}n.get=a;function i(){return Array.from(u.values())}n.values=i;function f(e){return u.has(e)}n.has=f;})(y||(y={}));var h=y;var m=new CachedMap({cacheSize:20}),x;(n=>{function o(e){if(Array.isArray(e)){e.forEach(r=>o(r));return}m.set(e.id,e);}n.add=o;function a(e){try{let r=m.get(e);if(!r){console.warn(`[NQTR] Map ${e} not found, you should register it first`);return}return r}catch(r){t.error(`Error while getting Map ${e}`,r);return}}n.get=a;function i(){return Array.from(m.values())}n.values=i;function f(e){return m.has(e)}n.has=f;})(x||(x={}));var I=x;var p=new CachedMap({cacheSize:5}),A;(n=>{function o(e){if(Array.isArray(e)){e.forEach(r=>n.add(r));return}p.set(e.id,e);}n.add=o;function a(e){try{let r=p.get(e);if(!r){console.warn(`[NQTR] Quest ${e} not found, you should register it first`);return}return r}catch(r){t.error(`Error while getting Quest ${e}`,r);return}}n.get=a;function i(){return Array.from(p.values())}n.values=i;function f(e){return p.has(e)}n.has=f;})(A||(A={}));var z=A;var d=new CachedMap({cacheSize:20}),w;(n=>{function o(e){if(Array.isArray(e)){e.forEach(C=>o(C));return}d.set(e.id,e);let r=e.location;h.add(r);let R=r?.map;R&&I.add(R);}n.add=o;function a(e){try{let r=d.get(e);if(!r){console.warn(`[NQTR] Room ${e} not found, you should register it first`);return}return r}catch(r){t.error(`Error while getting Room ${e}`,r);return}}n.get=a;function i(){return Array.from(d.values())}n.values=i;function f(e){return d.has(e)}n.has=f;})(w||(w={}));var b=w;export{M as RegisteredActivities,E as RegisteredCommitments,h as RegisteredLocations,I as RegisteredMaps,z as RegisteredQuests,b as RegisteredRooms,$ as fixedCommitments,c as registeredCommitments};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@drincs/nqtr",
-  "version": "0.7.1",
+  "version": "0.8.0",
   "description": "A complete system introducing the concepts of location, time and event, producing the framework of a not-quite-point-and-click adventure game.",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
@@ -62,7 +62,8 @@
   },
   "homepage": "https://pixi-vn.web.app/nqtr",
   "devDependencies": {
-    "@drincs/pixi-vn-ink": "^0.11.2",
+    "@drincs/pixi-vn-ink": "^0.12.2",
+    "@drincs/pixi-vn-json": "^1.10.1",
     "jsdom": "^28.0.0",
     "ts-node": "^10.9.2",
     "tsup": "^8.5.1",
@@ -71,7 +72,13 @@
     "vitest": "^4.0.18"
   },
   "peerDependencies": {
-    "@drincs/pixi-vn": ">=1.4.0"
+    "@drincs/pixi-vn": ">=1.5.17",
+    "@drincs/pixi-vn-ink": "^0.12.2"
+  },
+  "peerDependenciesMeta": {
+    "@drincs/pixi-vn-ink": {
+      "optional": true
+    }
   },
   "keywords": [
     "game",