@opfr/services 1.6.0 → 1.7.0

package/dist/services/user-story/definition/schema.d.ts

@@ -0,0 +1,13 @@
+import { Schema } from 'mongoose';
+import type { UserStoryDocument } from '../types';
+declare const userStorySchema: Schema<UserStoryDocument, import("mongoose").Model<UserStoryDocument, any, any, any, import("mongoose").Document<unknown, any, UserStoryDocument, any, {}> & UserStoryDocument & Required<{
+    _id: import("mongoose").Types.ObjectId;
+}> & {
+    __v: number;
+}, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, UserStoryDocument, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<UserStoryDocument>, {}, import("mongoose").ResolveSchemaOptions<import("mongoose").DefaultSchemaOptions>> & import("mongoose").FlatRecord<UserStoryDocument> & Required<{
+    _id: import("mongoose").Types.ObjectId;
+}> & {
+    __v: number;
+}>;
+export { userStorySchema };
+//# sourceMappingURL=schema.d.ts.map

package/dist/services/user-story/definition/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../../src/services/user-story/definition/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAYlD,QAAA,MAAM,eAAe;;;;;;;;EAqBnB,CAAC;AAIH,OAAO,EAAE,eAAe,EAAE,CAAC"}

package/dist/services/user-story/helper.d.ts

@@ -0,0 +1,31 @@
+import type { Types } from 'mongoose';
+import type { ChapterId, SceneId } from '@opfr/definitions';
+import { AbstractCachedServiceWithFetchMany } from '../AbstractCachedService';
+import type { AdvanceResult, ResolvedSceneStep, UserStory, UserStoryDocument, UserStoryFilter } from './types';
+export declare abstract class UserStoryHelper extends AbstractCachedServiceWithFetchMany<UserStory, UserStoryDocument, UserStoryFilter> {
+    getCurrentStep(user: Types.ObjectId, storyId: string): Promise<import("@opfr/definitions").StoryStep | null>;
+    getSceneSteps(user: Types.ObjectId, storyId: string, chapterId: ChapterId, sceneId: SceneId): Promise<ResolvedSceneStep[] | null>;
+    start(user: Types.ObjectId, storyId: string): Promise<(import("mongoose").FlattenMaps<UserStoryDocument> & Required<{
+        _id: Types.ObjectId;
+    }> & {
+        __v: number;
+    }) | null>;
+    advanceToNext(user: Types.ObjectId, storyId: string): Promise<AdvanceResult>;
+    advanceToNextScene(user: Types.ObjectId, storyId: string): Promise<(import("mongoose").FlattenMaps<UserStoryDocument> & Required<{
+        _id: Types.ObjectId;
+    }> & {
+        __v: number;
+    }) | null>;
+    validateCommandAndAdvance(user: Types.ObjectId, storyId: string, commandId: string): Promise<(import("mongoose").FlattenMaps<UserStoryDocument> & Required<{
+        _id: Types.ObjectId;
+    }> & {
+        __v: number;
+    }) | null>;
+    validateActionAndAdvance(user: Types.ObjectId, storyId: string, actionId: string): Promise<(import("mongoose").FlattenMaps<UserStoryDocument> & Required<{
+        _id: Types.ObjectId;
+    }> & {
+        __v: number;
+    }) | null>;
+    private advanceTo;
+}
+//# sourceMappingURL=helper.d.ts.map

package/dist/services/user-story/helper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helper.d.ts","sourceRoot":"","sources":["../../../src/services/user-story/helper.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAEtC,OAAO,KAAK,EAAE,SAAS,EAAE,OAAO,EAAU,MAAM,mBAAmB,CAAC;AAEpE,OAAO,EAAE,kCAAkC,EAAE,MAAM,0BAA0B,CAAC;AAO9E,OAAO,KAAK,EACV,aAAa,EACb,iBAAiB,EACjB,SAAS,EAET,iBAAiB,EACjB,eAAe,EAChB,MAAM,SAAS,CAAC;AAGjB,8BAAsB,eAAgB,SAAQ,kCAAkC,CAC9E,SAAS,EACT,iBAAiB,EACjB,eAAe,CAChB;IACc,cAAc,CAAC,IAAI,EAAE,KAAK,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM;IAUpD,aAAa,CACxB,IAAI,EAAE,KAAK,CAAC,QAAQ,EACpB,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,SAAS,EACpB,OAAO,EAAE,OAAO,GACf,OAAO,CAAC,iBAAiB,EAAE,GAAG,IAAI,CAAC;IA2BzB,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM;;;;;IA0B3C,aAAa,CACxB,IAAI,EAAE,KAAK,CAAC,QAAQ,EACpB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,aAAa,CAAC;IAqCZ,kBAAkB,CAAC,IAAI,EAAE,KAAK,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM;;;;;IA2BxD,yBAAyB,CACpC,IAAI,EAAE,KAAK,CAAC,QAAQ,EACpB,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,MAAM;;;;;IAyBN,wBAAwB,CACnC,IAAI,EAAE,KAAK,CAAC,QAAQ,EACpB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM;;;;;YA8BJ,SAAS;CAiCxB"}

package/dist/services/user-story/index.d.ts

@@ -0,0 +1,3 @@
+export type * from './types';
+export * from './service';
+//# sourceMappingURL=index.d.ts.map

package/dist/services/user-story/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/services/user-story/index.ts"],"names":[],"mappings":"AAAA,mBAAmB,SAAS,CAAC;AAE7B,cAAc,WAAW,CAAC"}

package/dist/services/user-story/process/create.d.ts

@@ -0,0 +1,4 @@
+import type { Types } from 'mongoose';
+import type { UserStoryDocument } from '../types';
+export declare const createUserStory: (user: Types.ObjectId, storyId: string, entryChapterId: string, entrySceneId: string, entryStepId: string) => Promise<UserStoryDocument>;
+//# sourceMappingURL=create.d.ts.map

package/dist/services/user-story/process/create.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create.d.ts","sourceRoot":"","sources":["../../../../src/services/user-story/process/create.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAGtC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAElD,eAAO,MAAM,eAAe,GAC1B,MAAM,KAAK,CAAC,QAAQ,EACpB,SAAS,MAAM,EACf,gBAAgB,MAAM,EACtB,cAAc,MAAM,EACpB,aAAa,MAAM,KAClB,OAAO,CAAC,iBAAiB,CAS3B,CAAC"}

package/dist/services/user-story/process/deleteOne.d.ts

@@ -0,0 +1,3 @@
+import type { Types } from 'mongoose';
+export declare const deleteUserStory: (user: Types.ObjectId, storyId: string) => Promise<void>;
+//# sourceMappingURL=deleteOne.d.ts.map

package/dist/services/user-story/process/deleteOne.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deleteOne.d.ts","sourceRoot":"","sources":["../../../../src/services/user-story/process/deleteOne.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAItC,eAAO,MAAM,eAAe,GAC1B,MAAM,KAAK,CAAC,QAAQ,EACpB,SAAS,MAAM,KACd,OAAO,CAAC,IAAI,CAEd,CAAC"}

package/dist/services/user-story/process/findMany.d.ts

@@ -0,0 +1,5 @@
+import type { QueryOptions, RootFilterQuery } from 'mongoose';
+import type { Lean } from '../../types';
+import type { UserStoryDocument } from '../types';
+export declare const findUserStories: (filter: RootFilterQuery<UserStoryDocument>, options?: QueryOptions<UserStoryDocument>) => Promise<Lean<UserStoryDocument>[]>;
+//# sourceMappingURL=findMany.d.ts.map

package/dist/services/user-story/process/findMany.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"findMany.d.ts","sourceRoot":"","sources":["../../../../src/services/user-story/process/findMany.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAE9D,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAExC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAElD,eAAO,MAAM,eAAe,GAC1B,QAAQ,eAAe,CAAC,iBAAiB,CAAC,EAC1C,UAAS,YAAY,CAAC,iBAAiB,CAAM,KAC5C,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAEnC,CAAC"}

package/dist/services/user-story/process/findOne.d.ts

@@ -0,0 +1,5 @@
+import type { Types } from 'mongoose';
+import type { Lean } from '../../types';
+import type { UserStoryDocument } from '../types';
+export declare const findUserStory: (user: Types.ObjectId, storyId: string) => Promise<Lean<UserStoryDocument> | null>;
+//# sourceMappingURL=findOne.d.ts.map

package/dist/services/user-story/process/findOne.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"findOne.d.ts","sourceRoot":"","sources":["../../../../src/services/user-story/process/findOne.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAEtC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAExC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAElD,eAAO,MAAM,aAAa,GACxB,MAAM,KAAK,CAAC,QAAQ,EACpB,SAAS,MAAM,KACd,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAExC,CAAC"}

package/dist/services/user-story/process/updateOne.d.ts

@@ -0,0 +1,5 @@
+import type { RootFilterQuery } from 'mongoose';
+import type { Lean, MongooseUpdate } from '../../types';
+import type { UserStoryDocument } from '../types';
+export declare const updateUserStory: (filter: RootFilterQuery<UserStoryDocument>, update: MongooseUpdate<UserStoryDocument>) => Promise<Lean<UserStoryDocument> | null>;
+//# sourceMappingURL=updateOne.d.ts.map

package/dist/services/user-story/process/updateOne.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"updateOne.d.ts","sourceRoot":"","sources":["../../../../src/services/user-story/process/updateOne.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAEhD,OAAO,KAAK,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAExD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAElD,eAAO,MAAM,eAAe,GAC1B,QAAQ,eAAe,CAAC,iBAAiB,CAAC,EAC1C,QAAQ,cAAc,CAAC,iBAAiB,CAAC,KACxC,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAMxC,CAAC"}

package/dist/services/user-story/service.d.ts

@@ -0,0 +1,15 @@
+import type { QueryOptions, RootFilterQuery } from 'mongoose';
+import type { Lean, MongooseUpdate } from '../types';
+import { UserStoryHelper } from './helper';
+import type { UserStoryDocument, UserStoryFilter } from './types';
+declare class UserStoryService extends UserStoryHelper {
+    constructor();
+    protected normalizeKey(key: UserStoryFilter): string;
+    protected getKey(e: Lean<UserStoryDocument>): UserStoryFilter;
+    protected fetchFromDb(filter: UserStoryFilter): Promise<Lean<UserStoryDocument> | null>;
+    protected fetchManyFromDb(filter: RootFilterQuery<UserStoryDocument>, options: QueryOptions<UserStoryDocument>): Promise<Lean<UserStoryDocument>[]>;
+    protected updateInDb(filter: RootFilterQuery<UserStoryDocument>, update: MongooseUpdate<UserStoryDocument>): Promise<Lean<UserStoryDocument> | null>;
+}
+export declare const userStoryService: UserStoryService;
+export {};
+//# sourceMappingURL=service.d.ts.map

package/dist/services/user-story/service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../../src/services/user-story/service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAE9D,OAAO,KAAK,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AACrD,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAI3C,OAAO,KAAK,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAElE,cAAM,gBAAiB,SAAQ,eAAe;;IAK5C,SAAS,CAAC,YAAY,CAAC,GAAG,EAAE,eAAe,GAAG,MAAM;IAIpD,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,iBAAiB,CAAC,GAAG,eAAe;IAI7D,SAAS,CAAC,WAAW,CACnB,MAAM,EAAE,eAAe,GACtB,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC;IAI1C,SAAS,CAAC,eAAe,CACvB,MAAM,EAAE,eAAe,CAAC,iBAAiB,CAAC,EAC1C,OAAO,EAAE,YAAY,CAAC,iBAAiB,CAAC,GACvC,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC;IAIrC,SAAS,CAAC,UAAU,CAClB,MAAM,EAAE,eAAe,CAAC,iBAAiB,CAAC,EAC1C,MAAM,EAAE,cAAc,CAAC,iBAAiB,CAAC,GACxC,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC;CAG3C;AAED,eAAO,MAAM,gBAAgB,kBAAyB,CAAC"}

package/dist/services/user-story/types.d.ts

@@ -0,0 +1,43 @@
+import type { Document, Types } from 'mongoose';
+import type { ChapterId, SceneId, StepId, StoryButtonAction, StoryButtonChoiceActionStep, StoryStep } from '@opfr/definitions';
+export type UserStoryStatus = 'in_progress' | 'completed';
+export type ResolvedSceneStep = {
+    step: StoryStep;
+} | {
+    step: StoryButtonChoiceActionStep;
+    selectedAction: StoryButtonAction;
+};
+export interface UserStoryChoice {
+    chapterId: ChapterId;
+    sceneId: SceneId;
+    stepId: StepId;
+    value: string;
+}
+export interface UserStory {
+    user: Types.ObjectId;
+    storyId: string;
+    currentChapterId: ChapterId;
+    currentSceneId: SceneId;
+    currentStepId: StepId;
+    status: UserStoryStatus;
+    choices: UserStoryChoice[];
+}
+export interface UserStoryDocument extends Document, UserStory {
+}
+export type UserStoryFilter = {
+    user: Types.ObjectId;
+    storyId: string;
+};
+export type AdvanceResult = {
+    status: 'advanced';
+    data: UserStory;
+} | {
+    status: 'action_required';
+} | {
+    status: 'scene_ended';
+} | {
+    status: 'completed';
+} | {
+    status: 'error';
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/services/user-story/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/services/user-story/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAEhD,OAAO,KAAK,EACV,SAAS,EACT,OAAO,EACP,MAAM,EACN,iBAAiB,EACjB,2BAA2B,EAC3B,SAAS,EACV,MAAM,mBAAmB,CAAC;AAE3B,MAAM,MAAM,eAAe,GAAG,aAAa,GAAG,WAAW,CAAC;AAE1D,MAAM,MAAM,iBAAiB,GACzB;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,GACnB;IAAE,IAAI,EAAE,2BAA2B,CAAC;IAAC,cAAc,EAAE,iBAAiB,CAAA;CAAE,CAAC;AAE7E,MAAM,WAAW,eAAe;IAC9B,SAAS,EAAE,SAAS,CAAC;IACrB,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,gBAAgB,EAAE,SAAS,CAAC;IAC5B,cAAc,EAAE,OAAO,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,eAAe,CAAC;IACxB,OAAO,EAAE,eAAe,EAAE,CAAC;CAC5B;AAED,MAAM,WAAW,iBAAkB,SAAQ,QAAQ,EAAE,SAAS;CAAG;AAEjE,MAAM,MAAM,eAAe,GAAG;IAAE,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC;AAExE,MAAM,MAAM,aAAa,GACrB;IAAE,MAAM,EAAE,UAAU,CAAC;IAAC,IAAI,EAAE,SAAS,CAAA;CAAE,GACvC;IAAE,MAAM,EAAE,iBAAiB,CAAA;CAAE,GAC7B;IAAE,MAAM,EAAE,aAAa,CAAA;CAAE,GACzB;IAAE,MAAM,EAAE,WAAW,CAAA;CAAE,GACvB;IAAE,MAAM,EAAE,OAAO,CAAA;CAAE,CAAC"}

package/dist/services/user-story/utils.d.ts

@@ -0,0 +1,8 @@
+import type { ChapterId, SceneId, StepId, StoryScene, StoryStep } from '@opfr/definitions';
+import type { StoryDocument } from '../story';
+import type { Lean } from '../types';
+import type { ResolvedSceneStep, UserStoryChoice, UserStoryDocument } from './types';
+export declare const resolveNextPosition: (story: Lean<StoryDocument>, chapterId: ChapterId, sceneId: SceneId, nextStepId: StepId) => Omit<UserStoryChoice, "value"> | null;
+export declare const getCurrentStep: (story: Lean<StoryDocument>, userStory: Lean<UserStoryDocument>) => StoryStep | null;
+export declare const walkSceneSteps: (scene: StoryScene, choices: UserStoryChoice[], chapterId: ChapterId, sceneId: SceneId, stopAtStepId?: StepId) => ResolvedSceneStep[];
+//# sourceMappingURL=utils.d.ts.map

package/dist/services/user-story/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/services/user-story/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,SAAS,EACT,OAAO,EACP,MAAM,EACN,UAAU,EACV,SAAS,EACV,MAAM,mBAAmB,CAAC;AAE3B,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAC9C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC;AACrC,OAAO,KAAK,EACV,iBAAiB,EACjB,eAAe,EACf,iBAAiB,EAClB,MAAM,SAAS,CAAC;AAEjB,eAAO,MAAM,mBAAmB,GAC9B,OAAO,IAAI,CAAC,aAAa,CAAC,EAC1B,WAAW,SAAS,EACpB,SAAS,OAAO,EAChB,YAAY,MAAM,KACjB,IAAI,CAAC,eAAe,EAAE,OAAO,CAAC,GAAG,IAqCnC,CAAC;AAEF,eAAO,MAAM,cAAc,GACzB,OAAO,IAAI,CAAC,aAAa,CAAC,EAC1B,WAAW,IAAI,CAAC,iBAAiB,CAAC,KACjC,SAAS,GAAG,IAQd,CAAC;AAEF,eAAO,MAAM,cAAc,GACzB,OAAO,UAAU,EACjB,SAAS,eAAe,EAAE,EAC1B,WAAW,SAAS,EACpB,SAAS,OAAO,EAChB,eAAe,MAAM,KACpB,iBAAiB,EAqDnB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opfr/services",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "private": false,
   "description": "OPFR services",
   "author": "Matthieu VEIGA",
@@ -20,7 +20,7 @@
   },
   "devDependencies": {
     "@faker-js/faker": "10.1.0",
-    "@opfr/definitions": "^1.7.0",
+    "@opfr/definitions": "^1.8.0",
     "@opfr/utils-lang": "^1.1.1",
     "@opfr/utils-type": "^1.1.0",
     "mongodb-memory-server": "11.0.1",
@@ -46,5 +46,5 @@
     "node_modules",
     "dist"
   ],
-  "gitHead": "415ffc7bbbf05e8f88f7f87296c9dd81a227edbd"
+  "gitHead": "de020619b61917c338996a67c13a8bb2d11c8e59"
 }

package/dist/services/user-cooldown/constants.d.ts

@@ -1,2 +0,0 @@
-export declare const COOLDOWN_COMMANDS: readonly ["work", "dice", "rps", "doubleOrQuit", "blackJack", "priceIsRight"];
-//# sourceMappingURL=constants.d.ts.map

package/dist/services/user-cooldown/constants.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/services/user-cooldown/constants.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,iBAAiB,+EAAmC,CAAC"}