@vived/host 4.9.1 → 4.11.0

package/dist/types/VivedAPI/UCs/PostNewAssetUC.d.ts

@@ -1,18 +1,70 @@
+/**
+ * PostNewAssetUC.ts
+ *
+ * This file defines the Use Case for creating new assets via the VIVED API.
+ * PostNewAssetUC handles the complete workflow of uploading asset files and
+ * creating asset metadata records through API requests.
+ *
+ * Key concepts:
+ * - Orchestrates file upload and metadata creation for new assets
+ * - Handles multipart file uploads with asset information
+ * - Manages authentication tokens and API endpoints
+ * - Coordinates between multiple UCs (JsonRequest, FileUpload, SignedAuthToken)
+ * - Returns asset creation response with generated IDs
+ *
+ * Usage pattern:
+ * 1. Get a UC instance using PostNewAssetUC.get(appObjects) or makePostNewAssetUC
+ * 2. Call doPost with asset data including file and metadata
+ * 3. Handle the returned Promise with asset creation response
+ * 4. UC will coordinate authentication, file upload, and API requests
+ */
 import { AppObject, AppObjectRepo, AppObjectUC } from "@vived/core";
+/**
+ * Data transfer object for new asset creation requests
+ */
 export interface NewAssetApiDto {
+    /** Display name for the new asset */
     name: string;
+    /** Description text for the asset */
     description: string;
+    /** ID of the user who will own this asset */
     ownerID: string;
+    /** File object containing the asset data */
     file: File;
 }
+/**
+ * Response data transfer object for successful asset creation
+ */
 export interface NewAssetResponseDTO {
+    /** Unique identifier assigned to the new asset */
     id: string;
+    /** Final filename used for the stored asset file */
     filename: string;
 }
+/**
+ * PostNewAssetUC provides functionality for creating new assets via API.
+ * Abstract class that defines the interface for asset creation operations.
+ */
 export declare abstract class PostNewAssetUC extends AppObjectUC {
+    /** Unique type identifier for this component */
     static type: string;
+    /**
+     * Creates a new asset by uploading file and metadata to the API
+     * @param data The asset creation data including file and metadata
+     * @returns Promise resolving to the new asset response with ID and filename
+     */
     abstract doPost(data: NewAssetApiDto): Promise<NewAssetResponseDTO>;
+    /**
+     * Retrieves a PostNewAssetUC component from an AppObject
+     * @param appObjects The AppObjectRepo to get the component from
+     * @returns The PostNewAssetUC component or undefined if not found
+     */
     static get(appObjects: AppObjectRepo): PostNewAssetUC | undefined;
 }
+/**
+ * Factory function to create a new PostNewAssetUC instance
+ * @param appObject The AppObject to attach the UC to
+ * @returns A new PostNewAssetUC instance
+ */
 export declare function makePostNewAssetUC(appObject: AppObject): PostNewAssetUC;
 //# sourceMappingURL=PostNewAssetUC.d.ts.map

package/dist/types/VivedAPI/UCs/PostNewAssetUC.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PostNewAssetUC.d.ts","sourceRoot":"","sources":["../../../../src/VivedAPI/UCs/PostNewAssetUC.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,aAAa,EACb,WAAW,EAGZ,MAAM,aAAa,CAAC;AAMrB,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,IAAI,CAAC;CACZ;AAED,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,8BAAsB,cAAe,SAAQ,WAAW;IACtD,MAAM,CAAC,IAAI,SAAoB;IAE/B,QAAQ,CAAC,MAAM,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAEnE,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,aAAa,GAAG,cAAc,GAAG,SAAS;CAGlE;AAED,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,SAAS,GAAG,cAAc,CAEvE"}
+{"version":3,"file":"PostNewAssetUC.d.ts","sourceRoot":"","sources":["../../../../src/VivedAPI/UCs/PostNewAssetUC.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,EACL,SAAS,EACT,aAAa,EACb,WAAW,EAGZ,MAAM,aAAa,CAAC;AAMrB;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,qCAAqC;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,qCAAqC;IACrC,WAAW,EAAE,MAAM,CAAC;IACpB,6CAA6C;IAC7C,OAAO,EAAE,MAAM,CAAC;IAChB,4CAA4C;IAC5C,IAAI,EAAE,IAAI,CAAC;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,kDAAkD;IAClD,EAAE,EAAE,MAAM,CAAC;IACX,oDAAoD;IACpD,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,8BAAsB,cAAe,SAAQ,WAAW;IACtD,gDAAgD;IAChD,MAAM,CAAC,IAAI,SAAoB;IAE/B;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAEnE;;;;OAIG;IACH,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,aAAa,GAAG,cAAc,GAAG,SAAS;CAGlE;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,SAAS,GAAG,cAAc,CAEvE"}

package/dist/types/VivedAPI/UCs/SignedAuthTokenUC.d.ts

@@ -1,7 +1,41 @@
+/**
+ * SignedAuthTokenUC.ts
+ *
+ * This file defines the Use Case for retrieving signed authentication tokens.
+ * SignedAuthTokenUC provides functionality for obtaining JWT or signed tokens
+ * used to authenticate API requests with the VIVED backend services.
+ *
+ * Key concepts:
+ * - Abstract UC defining the interface for authentication token retrieval
+ * - Handles token generation, validation, and renewal workflows
+ * - Provides secure access to authentication credentials
+ * - Implements singleton pattern for system-wide token management
+ * - Returns promises for async token operations
+ *
+ * Usage pattern:
+ * 1. Get the singleton UC using SignedAuthTokenUC.get(appObjects)
+ * 2. Call getAuthToken to retrieve current valid authentication token
+ * 3. Handle the returned Promise with token string or errors
+ * 4. Use token for authorizing subsequent API requests
+ */
 import { AppObjectRepo, AppObjectUC } from "@vived/core";
+/**
+ * SignedAuthTokenUC provides functionality for retrieving authentication tokens.
+ * Abstract class that defines the interface for authentication token operations.
+ */
 export declare abstract class SignedAuthTokenUC extends AppObjectUC {
+    /** Unique type identifier for this component */
     static type: string;
+    /**
+     * Retrieves a valid signed authentication token
+     * @returns Promise resolving to the authentication token string
+     */
     abstract getAuthToken(): Promise<string>;
+    /**
+     * Retrieves the singleton SignedAuthTokenUC from the app objects repository
+     * @param appObjects The AppObjectRepo to get the singleton from
+     * @returns The SignedAuthTokenUC singleton or undefined if not found
+     */
     static get(appObjects: AppObjectRepo): SignedAuthTokenUC | undefined;
 }
 //# sourceMappingURL=SignedAuthTokenUC.d.ts.map

package/dist/types/VivedAPI/UCs/SignedAuthTokenUC.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SignedAuthTokenUC.d.ts","sourceRoot":"","sources":["../../../../src/VivedAPI/UCs/SignedAuthTokenUC.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,WAAW,EAAyB,MAAM,aAAa,CAAC;AAEhF,8BAAsB,iBAAkB,SAAQ,WAAW;IACzD,MAAM,CAAC,IAAI,SAAuB;IAElC,QAAQ,CAAC,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC;IAExC,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,aAAa,GAAG,iBAAiB,GAAG,SAAS;CAGrE"}
+{"version":3,"file":"SignedAuthTokenUC.d.ts","sourceRoot":"","sources":["../../../../src/VivedAPI/UCs/SignedAuthTokenUC.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,EAAE,aAAa,EAAE,WAAW,EAAyB,MAAM,aAAa,CAAC;AAEhF;;;GAGG;AACH,8BAAsB,iBAAkB,SAAQ,WAAW;IACzD,gDAAgD;IAChD,MAAM,CAAC,IAAI,SAAuB;IAElC;;;OAGG;IACH,QAAQ,CAAC,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC;IAExC;;;;OAIG;IACH,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,aAAa,GAAG,iBAAiB,GAAG,SAAS;CAGrE"}

package/dist/types/VivedAPI/UCs/UserAuthUC.d.ts

@@ -1,9 +1,54 @@
+/**
+ * UserAuthUC.ts
+ *
+ * This file defines the Use Case for user authentication operations.
+ * UserAuthUC provides functionality for managing user login, logout, and
+ * authentication refresh workflows with the VIVED API services.
+ *
+ * Key concepts:
+ * - Abstract UC defining the interface for user authentication operations
+ * - Handles login with username/password credentials
+ * - Manages logout and session termination
+ * - Provides authentication refresh for token renewal
+ * - Implements singleton pattern for system-wide authentication management
+ * - Coordinates with VivedAPIEntity for token storage
+ *
+ * Usage pattern:
+ * 1. Get the singleton UC using UserAuthUC.get(appObjects)
+ * 2. Call login with user credentials for authentication
+ * 3. Use logout to terminate user sessions
+ * 4. Call refreshAuthenticatedUser to renew authentication tokens
+ */
 import { AppObjectRepo, AppObjectUC } from "@vived/core";
+/**
+ * UserAuthUC provides functionality for user authentication operations.
+ * Abstract class that defines the interface for login, logout, and token refresh operations.
+ */
 export declare abstract class UserAuthUC extends AppObjectUC {
+    /** Unique type identifier for this component */
     static type: string;
+    /**
+     * Authenticates a user with username and password credentials
+     * @param username The user's login username
+     * @param password The user's login password
+     * @returns Promise that resolves when login is complete
+     */
     abstract login(username: string, password: string): Promise<void>;
+    /**
+     * Logs out the current user and terminates the session
+     * @returns Promise that resolves when logout is complete
+     */
     abstract logout(): Promise<void>;
+    /**
+     * Refreshes the current user's authentication token
+     * @returns Promise that resolves when token refresh is complete
+     */
     abstract refreshAuthenticatedUser(): Promise<void>;
+    /**
+     * Retrieves the singleton UserAuthUC from the app objects repository
+     * @param appObjects The AppObjectRepo to get the singleton from
+     * @returns The UserAuthUC singleton or undefined if not found
+     */
     static get(appObjects: AppObjectRepo): UserAuthUC | undefined;
 }
 //# sourceMappingURL=UserAuthUC.d.ts.map

package/dist/types/VivedAPI/UCs/UserAuthUC.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UserAuthUC.d.ts","sourceRoot":"","sources":["../../../../src/VivedAPI/UCs/UserAuthUC.ts"],"names":[],"mappings":"AAAA,OAAO,EAAyB,aAAa,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAEhF,8BAAsB,UAAW,SAAQ,WAAW;IAClD,MAAM,CAAC,IAAI,SAAgB;IAE3B,QAAQ,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IACjE,QAAQ,CAAC,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAChC,QAAQ,CAAC,wBAAwB,IAAI,OAAO,CAAC,IAAI,CAAC;IAElD,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,aAAa,GAAG,UAAU,GAAG,SAAS;CAG9D"}
+{"version":3,"file":"UserAuthUC.d.ts","sourceRoot":"","sources":["../../../../src/VivedAPI/UCs/UserAuthUC.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,OAAO,EAAyB,aAAa,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAEhF;;;GAGG;AACH,8BAAsB,UAAW,SAAQ,WAAW;IAClD,gDAAgD;IAChD,MAAM,CAAC,IAAI,SAAgB;IAE3B;;;;;OAKG;IACH,QAAQ,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAEjE;;;OAGG;IACH,QAAQ,CAAC,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAEhC;;;OAGG;IACH,QAAQ,CAAC,wBAAwB,IAAI,OAAO,CAAC,IAAI,CAAC;IAElD;;;;OAIG;IACH,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,aAAa,GAAG,UAAU,GAAG,SAAS;CAG9D"}

package/dist/types/VivedAPI/UCs/index.d.ts

@@ -1,17 +1,40 @@
-export * from './BasicFetchUC';
-export * from './BlobRequestUC';
-export * from './DeleteAssetOnAPIUC';
-export * from './FetchAssetFileFromAPIUC';
-export * from './FetchAssetMetaFromAPIUC';
-export * from './FileUploadUC';
-export * from './GetAppFromAPIUC';
-export * from './GetAssetsForOwnerFromAPIUC';
-export * from './JsonRequestUC';
-export * from './PatchAssetFileUC';
-export * from './PatchAssetIsArchivedUC';
-export * from './PatchAssetMetaUC';
-export * from './PatchAssetUC';
-export * from './PostNewAssetUC';
-export * from './SignedAuthTokenUC';
-export * from './UserAuthUC';
+/**
+ * VivedAPI Use Cases Index
+ *
+ * This module exports all use case classes for the VivedAPI feature.
+ * Use cases contain the business logic for API operations and coordinate
+ * between entities, external services, and user interface components.
+ *
+ * Key Concepts:
+ * - Use cases implement specific API operations and workflows
+ * - They coordinate between entities, HTTP requests, and authentication
+ * - Each UC handles validation, error management, and API communication
+ * - Some UCs manage singleton operations, others handle per-request workflows
+ * - UCs provide clean interfaces for controllers and other components
+ *
+ * Available Use Cases:
+ * - HTTP Operations: BasicFetchUC, JsonRequestUC, BlobRequestUC
+ * - Authentication: SignedAuthTokenUC, UserAuthUC
+ * - File Management: FileUploadUC, FetchAssetFileFromAPIUC, PatchAssetFileUC
+ * - Asset Operations: PostNewAssetUC, DeleteAssetOnAPIUC, GetAssetsForOwnerFromAPIUC
+ * - Asset Metadata: FetchAssetMetaFromAPIUC, PatchAssetMetaUC, PatchAssetIsArchivedUC
+ * - App Management: GetAppFromAPIUC
+ * - Asset Updates: PatchAssetUC
+ */
+export * from "./BasicFetchUC";
+export * from "./BlobRequestUC";
+export * from "./DeleteAssetOnAPIUC";
+export * from "./FetchAssetFileFromAPIUC";
+export * from "./FetchAssetMetaFromAPIUC";
+export * from "./FileUploadUC";
+export * from "./GetAppFromAPIUC";
+export * from "./GetAssetsForOwnerFromAPIUC";
+export * from "./JsonRequestUC";
+export * from "./PatchAssetFileUC";
+export * from "./PatchAssetIsArchivedUC";
+export * from "./PatchAssetMetaUC";
+export * from "./PatchAssetUC";
+export * from "./PostNewAssetUC";
+export * from "./SignedAuthTokenUC";
+export * from "./UserAuthUC";
 //# sourceMappingURL=index.d.ts.map

package/dist/types/VivedAPI/UCs/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/VivedAPI/UCs/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,0BAA0B,CAAC;AACzC,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/VivedAPI/UCs/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,0BAA0B,CAAC;AACzC,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,cAAc,CAAC"}

package/dist/types/VivedAPI/index.d.ts

@@ -1,3 +1,28 @@
+/**
+ * VivedAPI Feature Index
+ *
+ * This module serves as the main entry point for the VivedAPI feature, providing
+ * centralized access to all API-related components and functionality.
+ *
+ * The VivedAPI feature handles communication with VIVED backend services,
+ * including authentication, asset management, and application data synchronization.
+ *
+ * Key Concepts:
+ * - Provides unified API communication infrastructure for the host application
+ * - Manages authentication tokens and user sessions
+ * - Handles file uploads, downloads, and asset operations
+ * - Supports multiple API environments (Production, Staging, Development, Local)
+ * - Implements clean architecture patterns with separation of concerns
+ *
+ * Architecture Components:
+ * - Entities: Core business objects for API configuration and state management
+ * - Use Cases: Business logic for API operations and workflows
+ * - Presentation Managers: Bridge between domain logic and UI components
+ * - Controllers: Handle user inputs and coordinate feature operations
+ * - Adapters: Interface with external UI frameworks and libraries
+ * - Factories: Component creation and feature setup utilities
+ * - Mocks: Test doubles for development and testing scenarios
+ */
 export * from "./Adapters";
 export * from "./Controllers";
 export * from "./Entities";

package/dist/types/VivedAPI/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/VivedAPI/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,OAAO,CAAC;AACtB,cAAc,OAAO,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/VivedAPI/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAEH,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,OAAO,CAAC;AACtB,cAAc,OAAO,CAAC"}

package/dist/types/ZSpaceHost/Entities/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/ZSpaceHost/Entities/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/ZSpaceHost/Entities/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC"}

package/dist/types/ZSpaceHost/Factories/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/ZSpaceHost/Factories/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/ZSpaceHost/Factories/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC"}

package/dist/types/ZSpaceHost/Mocks/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/ZSpaceHost/Mocks/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,wBAAwB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/ZSpaceHost/Mocks/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,wBAAwB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vived/host",
-  "version": "4.9.1",
+  "version": "4.11.0",
   "description": "Public Host package for the VIVED Learning App system",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
@@ -22,7 +22,8 @@
     "build": "npm run build:esm && npm run build:cjs",
     "build:esm": "tsc",
     "build:cjs": "tsc -p tsconfig.cjs.json",
-    "format": "prettier --write \"src/**/*.ts\" \"src/**/*.js\"",
+    "format": "prettier --write",
+    "format:all": "prettier --write \"src/**/*.ts\" \"src/**/*.js\"",
     "lint": "tslint -p tsconfig.json",
     "prepare": "npm run build",
     "prepublishOnly": "npm run test:once && npm run test:integration:once && npm run lint",
@@ -61,6 +62,6 @@
     "@types/webxr": "^0.5.20"
   },
   "peerDependencies": {
-    "@vived/core": "^1.4.5"
+    "@vived/core": "^1.5.1"
   }
 }

package/dist/cjs/Handler/UCs/SubmitExpectedResultHandler.js

@@ -1,66 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SubmitExpectedResultHandler = void 0;
-exports.makeSubmitExpectedResultHandler = makeSubmitExpectedResultHandler;
-const core_1 = require("@vived/core");
-const Entities_1 = require("../Entities");
-const HostStateMachine_1 = require("../../StateMachine/Entities/HostStateMachine");
-class SubmitExpectedResultHandler extends core_1.AppObjectUC {
-    constructor() {
-        super(...arguments);
-        this.requestType = "SUBMIT_EXPECTED_RESULT";
-    }
-}
-exports.SubmitExpectedResultHandler = SubmitExpectedResultHandler;
-SubmitExpectedResultHandler.type = "SubmitExpectedResultHandler";
-function makeSubmitExpectedResultHandler(appObject) {
-    return new SubmitExpectedResultHandlerImp(appObject);
-}
-class SubmitExpectedResultHandlerImp extends SubmitExpectedResultHandler {
-    castPayloadV1(payload) {
-        const castPayload = payload;
-        if (!castPayload.responseType) {
-            throw new Entities_1.UnableToParsePayload(this.requestType, 1, JSON.stringify(payload));
-        }
-        return castPayload;
-    }
-    constructor(appObject) {
-        super(appObject, SubmitExpectedResultHandler.type);
-        this.action = (responseType) => {
-            const stateMachine = HostStateMachine_1.HostStateMachine.get(this.appObjects);
-            if (!stateMachine) {
-                this.error("Unable to get HostStateMachine");
-                return;
-            }
-            const activeStateId = stateMachine.activeState;
-            if (!activeStateId) {
-                this.warn("No active state to set expected response on");
-                return;
-            }
-            const stateEntity = stateMachine.getStateByID(activeStateId);
-            if (!stateEntity) {
-                this.error(`Unable to get state entity for ID: ${activeStateId}`);
-                return;
-            }
-            if (stateEntity.expectedResponse === undefined) {
-                stateEntity.expectedResponse = responseType;
-            }
-        };
-        this.handleRequest = (version, payload) => {
-            if (version === 1) {
-                const { responseType } = this.castPayloadV1(payload);
-                this.action(responseType);
-            }
-            else {
-                throw new Entities_1.UnsupportedRequestVersion(this.requestType, version);
-            }
-        };
-        const hostHandler = Entities_1.HostHandlerEntity.get(appObject);
-        if (!hostHandler) {
-            this.error("UC added to an entity that does not have HostHandlerEntity");
-            return;
-        }
-        hostHandler.registerRequestHandler(this);
-    }
-}
-//# sourceMappingURL=SubmitExpectedResultHandler.js.map

package/dist/cjs/Handler/UCs/SubmitExpectedResultHandler.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"SubmitExpectedResultHandler.js","sourceRoot":"","sources":["../../../../src/Handler/UCs/SubmitExpectedResultHandler.ts"],"names":[],"mappings":";;;AAyBA,0EAIC;AA7BD,sCAAqD;AACrD,0CAMqB;AACrB,mFAAgF;AAKhF,MAAsB,2BACpB,SAAQ,kBAAW;IADrB;;QAMW,gBAAW,GAAG,wBAAwB,CAAC;IAIlD,CAAC;;AAVD,kEAUC;AANiB,gCAAI,GAAG,6BAA6B,AAAhC,CAAiC;AAQvD,SAAgB,+BAA+B,CAC7C,SAAoB;IAEpB,OAAO,IAAI,8BAA8B,CAAC,SAAS,CAAC,CAAC;AACvD,CAAC;AAED,MAAM,8BAA+B,SAAQ,2BAA2B;IAkC9D,aAAa,CAAC,OAAgB;QACpC,MAAM,WAAW,GAAG,OAAqB,CAAC;QAC1C,IAAI,CAAC,WAAW,CAAC,YAAY,EAAE,CAAC;YAC9B,MAAM,IAAI,+BAAoB,CAC5B,IAAI,CAAC,WAAW,EAChB,CAAC,EACD,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CACxB,CAAC;QACJ,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,YAAY,SAAoB;QAC9B,KAAK,CAAC,SAAS,EAAE,2BAA2B,CAAC,IAAI,CAAC,CAAC;QA/CrD,WAAM,GAA+B,CAAC,YAAoB,EAAE,EAAE;YAC5D,MAAM,YAAY,GAAG,mCAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAC3D,IAAI,CAAC,YAAY,EAAE,CAAC;gBAClB,IAAI,CAAC,KAAK,CAAC,gCAAgC,CAAC,CAAC;gBAC7C,OAAO;YACT,CAAC;YAED,MAAM,aAAa,GAAG,YAAY,CAAC,WAAW,CAAC;YAC/C,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,IAAI,CAAC,IAAI,CAAC,6CAA6C,CAAC,CAAC;gBACzD,OAAO;YACT,CAAC;YAED,MAAM,WAAW,GAAG,YAAY,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;YAC7D,IAAI,CAAC,WAAW,EAAE,CAAC;gBACjB,IAAI,CAAC,KAAK,CAAC,sCAAsC,aAAa,EAAE,CAAC,CAAC;gBAClE,OAAO;YACT,CAAC;YAEH,IAAG,WAAW,CAAC,gBAAgB,KAAK,SAAS,EAAE,CAAC;gBAC/C,WAAW,CAAC,gBAAgB,GAAG,YAAiC,CAAC;YAClE,CAAC;QACD,CAAC,CAAC;QAEF,kBAAa,GAAG,CAAC,OAAe,EAAE,OAAgB,EAAE,EAAE;YACpD,IAAI,OAAO,KAAK,CAAC,EAAE,CAAC;gBAClB,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;gBACrD,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;YAC5B,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,oCAAyB,CAAC,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;YACjE,CAAC;QACH,CAAC,CAAC;QAkBA,MAAM,WAAW,GAAG,4BAAiB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACrD,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,IAAI,CAAC,KAAK,CAAC,4DAA4D,CAAC,CAAC;YACzE,OAAO;QACT,CAAC;QAED,WAAW,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;IAC3C,CAAC;CACF","sourcesContent":["import { AppObject, AppObjectUC } from \"@vived/core\";\r\nimport {\r\n  ActionNotImplemented,\r\n  HostHandlerEntity,\r\n  RequestHandler,\r\n  UnableToParsePayload,\r\n  UnsupportedRequestVersion\r\n} from \"../Entities\";\r\nimport { HostStateMachine } from \"../../StateMachine/Entities/HostStateMachine\";\r\nimport { ChallengeResponse } from \"../../StateMachine/Entities/HostStateEntity\";\r\n\r\nexport type SubmitExpectedResultAction = (responseType: string) => void;\r\n\r\nexport abstract class SubmitExpectedResultHandler\r\n  extends AppObjectUC\r\n  implements RequestHandler\r\n{\r\n  static readonly type = \"SubmitExpectedResultHandler\";\r\n\r\n  readonly requestType = \"SUBMIT_EXPECTED_RESULT\";\r\n\r\n  abstract action: SubmitExpectedResultAction;\r\n  abstract handleRequest: (version: number, payload?: unknown) => void;\r\n}\r\n\r\nexport function makeSubmitExpectedResultHandler(\r\n  appObject: AppObject\r\n): SubmitExpectedResultHandler {\r\n  return new SubmitExpectedResultHandlerImp(appObject);\r\n}\r\n\r\nclass SubmitExpectedResultHandlerImp extends SubmitExpectedResultHandler {\r\n  action: SubmitExpectedResultAction = (responseType: string) => {\r\n    const stateMachine = HostStateMachine.get(this.appObjects);\r\n    if (!stateMachine) {\r\n      this.error(\"Unable to get HostStateMachine\");\r\n      return;\r\n    }\r\n\r\n    const activeStateId = stateMachine.activeState;\r\n    if (!activeStateId) {\r\n      this.warn(\"No active state to set expected response on\");\r\n      return;\r\n    }\r\n\r\n    const stateEntity = stateMachine.getStateByID(activeStateId);\r\n    if (!stateEntity) {\r\n      this.error(`Unable to get state entity for ID: ${activeStateId}`);\r\n      return;\r\n    }\r\n\r\n\t\tif(stateEntity.expectedResponse === undefined) {\r\n\t\t\tstateEntity.expectedResponse = responseType as ChallengeResponse;\r\n\t\t}\r\n  };\r\n\r\n  handleRequest = (version: number, payload: unknown) => {\r\n    if (version === 1) {\r\n      const { responseType } = this.castPayloadV1(payload);\r\n      this.action(responseType);\r\n    } else {\r\n      throw new UnsupportedRequestVersion(this.requestType, version);\r\n    }\r\n  };\r\n\r\n  private castPayloadV1(payload: unknown): Payload_V1 {\r\n    const castPayload = payload as Payload_V1;\r\n    if (!castPayload.responseType) {\r\n      throw new UnableToParsePayload(\r\n        this.requestType,\r\n        1,\r\n        JSON.stringify(payload)\r\n      );\r\n    }\r\n\r\n    return castPayload;\r\n  }\r\n\r\n  constructor(appObject: AppObject) {\r\n    super(appObject, SubmitExpectedResultHandler.type);\r\n\r\n    const hostHandler = HostHandlerEntity.get(appObject);\r\n    if (!hostHandler) {\r\n      this.error(\"UC added to an entity that does not have HostHandlerEntity\");\r\n      return;\r\n    }\r\n\r\n    hostHandler.registerRequestHandler(this);\r\n  }\r\n}\r\n\r\ntype Payload_V1 = {\r\n  responseType: string;\r\n};\r\n"]}

package/dist/esm/Handler/UCs/SubmitExpectedResultHandler.js

@@ -1,61 +0,0 @@
-import { AppObjectUC } from "@vived/core";
-import { HostHandlerEntity, UnableToParsePayload, UnsupportedRequestVersion } from "../Entities";
-import { HostStateMachine } from "../../StateMachine/Entities/HostStateMachine";
-export class SubmitExpectedResultHandler extends AppObjectUC {
-    constructor() {
-        super(...arguments);
-        this.requestType = "SUBMIT_EXPECTED_RESULT";
-    }
-}
-SubmitExpectedResultHandler.type = "SubmitExpectedResultHandler";
-export function makeSubmitExpectedResultHandler(appObject) {
-    return new SubmitExpectedResultHandlerImp(appObject);
-}
-class SubmitExpectedResultHandlerImp extends SubmitExpectedResultHandler {
-    castPayloadV1(payload) {
-        const castPayload = payload;
-        if (!castPayload.responseType) {
-            throw new UnableToParsePayload(this.requestType, 1, JSON.stringify(payload));
-        }
-        return castPayload;
-    }
-    constructor(appObject) {
-        super(appObject, SubmitExpectedResultHandler.type);
-        this.action = (responseType) => {
-            const stateMachine = HostStateMachine.get(this.appObjects);
-            if (!stateMachine) {
-                this.error("Unable to get HostStateMachine");
-                return;
-            }
-            const activeStateId = stateMachine.activeState;
-            if (!activeStateId) {
-                this.warn("No active state to set expected response on");
-                return;
-            }
-            const stateEntity = stateMachine.getStateByID(activeStateId);
-            if (!stateEntity) {
-                this.error(`Unable to get state entity for ID: ${activeStateId}`);
-                return;
-            }
-            if (stateEntity.expectedResponse === undefined) {
-                stateEntity.expectedResponse = responseType;
-            }
-        };
-        this.handleRequest = (version, payload) => {
-            if (version === 1) {
-                const { responseType } = this.castPayloadV1(payload);
-                this.action(responseType);
-            }
-            else {
-                throw new UnsupportedRequestVersion(this.requestType, version);
-            }
-        };
-        const hostHandler = HostHandlerEntity.get(appObject);
-        if (!hostHandler) {
-            this.error("UC added to an entity that does not have HostHandlerEntity");
-            return;
-        }
-        hostHandler.registerRequestHandler(this);
-    }
-}
-//# sourceMappingURL=SubmitExpectedResultHandler.js.map

package/dist/esm/Handler/UCs/SubmitExpectedResultHandler.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"SubmitExpectedResultHandler.js","sourceRoot":"","sources":["../../../../src/Handler/UCs/SubmitExpectedResultHandler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,WAAW,EAAE,MAAM,aAAa,CAAC;AACrD,OAAO,EAEL,iBAAiB,EAEjB,oBAAoB,EACpB,yBAAyB,EAC1B,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,gBAAgB,EAAE,MAAM,8CAA8C,CAAC;AAKhF,MAAM,OAAgB,2BACpB,SAAQ,WAAW;IADrB;;QAMW,gBAAW,GAAG,wBAAwB,CAAC;IAIlD,CAAC;;AANiB,gCAAI,GAAG,6BAA6B,AAAhC,CAAiC;AAQvD,MAAM,UAAU,+BAA+B,CAC7C,SAAoB;IAEpB,OAAO,IAAI,8BAA8B,CAAC,SAAS,CAAC,CAAC;AACvD,CAAC;AAED,MAAM,8BAA+B,SAAQ,2BAA2B;IAkC9D,aAAa,CAAC,OAAgB;QACpC,MAAM,WAAW,GAAG,OAAqB,CAAC;QAC1C,IAAI,CAAC,WAAW,CAAC,YAAY,EAAE,CAAC;YAC9B,MAAM,IAAI,oBAAoB,CAC5B,IAAI,CAAC,WAAW,EAChB,CAAC,EACD,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CACxB,CAAC;QACJ,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,YAAY,SAAoB;QAC9B,KAAK,CAAC,SAAS,EAAE,2BAA2B,CAAC,IAAI,CAAC,CAAC;QA/CrD,WAAM,GAA+B,CAAC,YAAoB,EAAE,EAAE;YAC5D,MAAM,YAAY,GAAG,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAC3D,IAAI,CAAC,YAAY,EAAE,CAAC;gBAClB,IAAI,CAAC,KAAK,CAAC,gCAAgC,CAAC,CAAC;gBAC7C,OAAO;YACT,CAAC;YAED,MAAM,aAAa,GAAG,YAAY,CAAC,WAAW,CAAC;YAC/C,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,IAAI,CAAC,IAAI,CAAC,6CAA6C,CAAC,CAAC;gBACzD,OAAO;YACT,CAAC;YAED,MAAM,WAAW,GAAG,YAAY,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;YAC7D,IAAI,CAAC,WAAW,EAAE,CAAC;gBACjB,IAAI,CAAC,KAAK,CAAC,sCAAsC,aAAa,EAAE,CAAC,CAAC;gBAClE,OAAO;YACT,CAAC;YAEH,IAAG,WAAW,CAAC,gBAAgB,KAAK,SAAS,EAAE,CAAC;gBAC/C,WAAW,CAAC,gBAAgB,GAAG,YAAiC,CAAC;YAClE,CAAC;QACD,CAAC,CAAC;QAEF,kBAAa,GAAG,CAAC,OAAe,EAAE,OAAgB,EAAE,EAAE;YACpD,IAAI,OAAO,KAAK,CAAC,EAAE,CAAC;gBAClB,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;gBACrD,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;YAC5B,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,yBAAyB,CAAC,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;YACjE,CAAC;QACH,CAAC,CAAC;QAkBA,MAAM,WAAW,GAAG,iBAAiB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACrD,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,IAAI,CAAC,KAAK,CAAC,4DAA4D,CAAC,CAAC;YACzE,OAAO;QACT,CAAC;QAED,WAAW,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;IAC3C,CAAC;CACF","sourcesContent":["import { AppObject, AppObjectUC } from \"@vived/core\";\r\nimport {\r\n  ActionNotImplemented,\r\n  HostHandlerEntity,\r\n  RequestHandler,\r\n  UnableToParsePayload,\r\n  UnsupportedRequestVersion\r\n} from \"../Entities\";\r\nimport { HostStateMachine } from \"../../StateMachine/Entities/HostStateMachine\";\r\nimport { ChallengeResponse } from \"../../StateMachine/Entities/HostStateEntity\";\r\n\r\nexport type SubmitExpectedResultAction = (responseType: string) => void;\r\n\r\nexport abstract class SubmitExpectedResultHandler\r\n  extends AppObjectUC\r\n  implements RequestHandler\r\n{\r\n  static readonly type = \"SubmitExpectedResultHandler\";\r\n\r\n  readonly requestType = \"SUBMIT_EXPECTED_RESULT\";\r\n\r\n  abstract action: SubmitExpectedResultAction;\r\n  abstract handleRequest: (version: number, payload?: unknown) => void;\r\n}\r\n\r\nexport function makeSubmitExpectedResultHandler(\r\n  appObject: AppObject\r\n): SubmitExpectedResultHandler {\r\n  return new SubmitExpectedResultHandlerImp(appObject);\r\n}\r\n\r\nclass SubmitExpectedResultHandlerImp extends SubmitExpectedResultHandler {\r\n  action: SubmitExpectedResultAction = (responseType: string) => {\r\n    const stateMachine = HostStateMachine.get(this.appObjects);\r\n    if (!stateMachine) {\r\n      this.error(\"Unable to get HostStateMachine\");\r\n      return;\r\n    }\r\n\r\n    const activeStateId = stateMachine.activeState;\r\n    if (!activeStateId) {\r\n      this.warn(\"No active state to set expected response on\");\r\n      return;\r\n    }\r\n\r\n    const stateEntity = stateMachine.getStateByID(activeStateId);\r\n    if (!stateEntity) {\r\n      this.error(`Unable to get state entity for ID: ${activeStateId}`);\r\n      return;\r\n    }\r\n\r\n\t\tif(stateEntity.expectedResponse === undefined) {\r\n\t\t\tstateEntity.expectedResponse = responseType as ChallengeResponse;\r\n\t\t}\r\n  };\r\n\r\n  handleRequest = (version: number, payload: unknown) => {\r\n    if (version === 1) {\r\n      const { responseType } = this.castPayloadV1(payload);\r\n      this.action(responseType);\r\n    } else {\r\n      throw new UnsupportedRequestVersion(this.requestType, version);\r\n    }\r\n  };\r\n\r\n  private castPayloadV1(payload: unknown): Payload_V1 {\r\n    const castPayload = payload as Payload_V1;\r\n    if (!castPayload.responseType) {\r\n      throw new UnableToParsePayload(\r\n        this.requestType,\r\n        1,\r\n        JSON.stringify(payload)\r\n      );\r\n    }\r\n\r\n    return castPayload;\r\n  }\r\n\r\n  constructor(appObject: AppObject) {\r\n    super(appObject, SubmitExpectedResultHandler.type);\r\n\r\n    const hostHandler = HostHandlerEntity.get(appObject);\r\n    if (!hostHandler) {\r\n      this.error(\"UC added to an entity that does not have HostHandlerEntity\");\r\n      return;\r\n    }\r\n\r\n    hostHandler.registerRequestHandler(this);\r\n  }\r\n}\r\n\r\ntype Payload_V1 = {\r\n  responseType: string;\r\n};\r\n"]}

package/dist/types/Handler/UCs/SubmitExpectedResultHandler.d.ts

@@ -1,11 +0,0 @@
-import { AppObject, AppObjectUC } from "@vived/core";
-import { RequestHandler } from "../Entities";
-export type SubmitExpectedResultAction = (responseType: string) => void;
-export declare abstract class SubmitExpectedResultHandler extends AppObjectUC implements RequestHandler {
-    static readonly type = "SubmitExpectedResultHandler";
-    readonly requestType = "SUBMIT_EXPECTED_RESULT";
-    abstract action: SubmitExpectedResultAction;
-    abstract handleRequest: (version: number, payload?: unknown) => void;
-}
-export declare function makeSubmitExpectedResultHandler(appObject: AppObject): SubmitExpectedResultHandler;
-//# sourceMappingURL=SubmitExpectedResultHandler.d.ts.map

package/dist/types/Handler/UCs/SubmitExpectedResultHandler.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"SubmitExpectedResultHandler.d.ts","sourceRoot":"","sources":["../../../../src/Handler/UCs/SubmitExpectedResultHandler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AACrD,OAAO,EAGL,cAAc,EAGf,MAAM,aAAa,CAAC;AAIrB,MAAM,MAAM,0BAA0B,GAAG,CAAC,YAAY,EAAE,MAAM,KAAK,IAAI,CAAC;AAExE,8BAAsB,2BACpB,SAAQ,WACR,YAAW,cAAc;IAEzB,MAAM,CAAC,QAAQ,CAAC,IAAI,iCAAiC;IAErD,QAAQ,CAAC,WAAW,4BAA4B;IAEhD,QAAQ,CAAC,MAAM,EAAE,0BAA0B,CAAC;IAC5C,QAAQ,CAAC,aAAa,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;CACtE;AAED,wBAAgB,+BAA+B,CAC7C,SAAS,EAAE,SAAS,GACnB,2BAA2B,CAE7B"}