@vived/host 4.10.0 → 4.11.0

package/dist/types/VivedAPI/Adapters/apiStageAdapter.d.ts

@@ -1,4 +1,28 @@
+/**
+ * apiStageAdapter.ts
+ *
+ * This file defines an adapter for connecting API stage presentation logic to UI frameworks.
+ * The apiStageAdapter provides a standardized interface for binding API stage configuration
+ * to view components, handling subscriptions and view model updates.
+ *
+ * Key concepts:
+ * - Adapter implements SingletonPmAdapter interface for UI framework integration
+ * - Manages subscription lifecycle for view components
+ * - Provides default view model values for initialization
+ * - Handles error cases when presentation manager is unavailable
+ * - Enables reactive UI updates when API stage configuration changes
+ *
+ * Usage pattern:
+ * 1. UI frameworks use this adapter to bind to API stage state
+ * 2. Adapter manages PM subscriptions and view function callbacks
+ * 3. View components receive API stage updates automatically
+ * 4. Proper cleanup handled through unsubscribe mechanism
+ */
 import { SingletonPmAdapter } from "@vived/core";
 import { APIStage } from "../Entities";
+/**
+ * Adapter for connecting API stage presentation logic to UI frameworks.
+ * Implements SingletonPmAdapter to provide standardized view binding for API stage configuration.
+ */
 export declare const apiStageAdapter: SingletonPmAdapter<APIStage>;
 //# sourceMappingURL=apiStageAdapter.d.ts.map

package/dist/types/VivedAPI/Adapters/apiStageAdapter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"apiStageAdapter.d.ts","sourceRoot":"","sources":["../../../../src/VivedAPI/Adapters/apiStageAdapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAChE,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAGvC,eAAO,MAAM,eAAe,EAAE,kBAAkB,CAAC,QAAQ,CAkBxD,CAAC"}
+{"version":3,"file":"apiStageAdapter.d.ts","sourceRoot":"","sources":["../../../../src/VivedAPI/Adapters/apiStageAdapter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,EAAiB,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAChE,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAGvC;;;GAGG;AACH,eAAO,MAAM,eAAe,EAAE,kBAAkB,CAAC,QAAQ,CA+BxD,CAAC"}

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

@@ -1,3 +1,22 @@
+/**
+ * VivedAPI Adapters Index
+ *
+ * This module exports all adapter objects for the VivedAPI feature.
+ * Adapters provide standardized interfaces for connecting presentation managers
+ * to various UI frameworks and libraries, handling subscription lifecycles
+ * and view model synchronization.
+ *
+ * Key Concepts:
+ * - Adapters implement framework-specific integration patterns
+ * - They manage subscription and unsubscription to presentation manager updates
+ * - Adapters provide default view model values for initialization
+ * - They handle error cases when presentation managers are unavailable
+ * - Adapters enable reactive UI updates across different frontend technologies
+ *
+ * Available Adapters:
+ * - apiStageAdapter: Connects API stage configuration to UI components
+ * - userTokenAdapter: Connects user authentication token state to UI displays
+ */
 export * from "./apiStageAdapter";
 export * from "./userTokenAdapter";
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/VivedAPI/Adapters/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/VivedAPI/Adapters/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC"}

package/dist/types/VivedAPI/Adapters/userTokenAdapter.d.ts

@@ -1,3 +1,27 @@
+/**
+ * userTokenAdapter.ts
+ *
+ * This file defines an adapter for connecting user token presentation logic to UI frameworks.
+ * The userTokenAdapter provides a standardized interface for binding user authentication
+ * token state to view components, handling subscriptions and view model updates.
+ *
+ * Key concepts:
+ * - Adapter implements SingletonPmAdapter interface for UI framework integration
+ * - Manages subscription lifecycle for view components displaying user tokens
+ * - Provides default view model values for initialization (empty string)
+ * - Handles error cases when presentation manager is unavailable
+ * - Enables reactive UI updates when user authentication token changes
+ *
+ * Usage pattern:
+ * 1. UI frameworks use this adapter to bind to user token state
+ * 2. Adapter manages PM subscriptions and view function callbacks
+ * 3. View components receive token updates automatically
+ * 4. Proper cleanup handled through unsubscribe mechanism
+ */
 import { SingletonPmAdapter } from "@vived/core";
+/**
+ * Adapter for connecting user token presentation logic to UI frameworks.
+ * Implements SingletonPmAdapter to provide standardized view binding for user authentication tokens.
+ */
 export declare const userTokenAdapter: SingletonPmAdapter<string>;
 //# sourceMappingURL=userTokenAdapter.d.ts.map

package/dist/types/VivedAPI/Adapters/userTokenAdapter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"userTokenAdapter.d.ts","sourceRoot":"","sources":["../../../../src/VivedAPI/Adapters/userTokenAdapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAGhE,eAAO,MAAM,gBAAgB,EAAE,kBAAkB,CAAC,MAAM,CAkBvD,CAAC"}
+{"version":3,"file":"userTokenAdapter.d.ts","sourceRoot":"","sources":["../../../../src/VivedAPI/Adapters/userTokenAdapter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,EAAiB,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAGhE;;;GAGG;AACH,eAAO,MAAM,gBAAgB,EAAE,kBAAkB,CAAC,MAAM,CA+BvD,CAAC"}

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

@@ -1,3 +1,21 @@
+/**
+ * VivedAPI Controllers Index
+ *
+ * This module exports all controller functions for the VivedAPI feature.
+ * Controllers handle user input and coordinate operations between UI components
+ * and the underlying business logic components.
+ *
+ * Key Concepts:
+ * - Controllers provide simple function interfaces for common operations
+ * - They validate inputs and handle error cases appropriately
+ * - Controllers coordinate between use cases, entities, and external systems
+ * - They serve as the primary interface for UI framework integration
+ * - Error handling and logging are managed at the controller level
+ *
+ * Available Controllers:
+ * - User Authentication: loginUser, logoutUser, refreshAuthenticatedUser
+ * - API Configuration: setApiStage
+ */
 export * from "./loginUser";
 export * from "./logoutUser";
 export * from "./refreshAuthenticatedUser";

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/VivedAPI/Controllers/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,4BAA4B,CAAC;AAC3C,cAAc,eAAe,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/VivedAPI/Controllers/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,4BAA4B,CAAC;AAC3C,cAAc,eAAe,CAAC"}

package/dist/types/VivedAPI/Controllers/loginUser.d.ts

@@ -1,3 +1,30 @@
+/**
+ * loginUser.ts
+ *
+ * This file defines a controller function for user authentication login operations.
+ * The loginUser controller provides a simple interface for authenticating users
+ * with username and password credentials through the VIVED API.
+ *
+ * Key concepts:
+ * - Controller functions handle user input and direct authentication operations
+ * - Validates UserAuthUC existence before performing login operations
+ * - Provides error handling and warning messages for missing components
+ * - Returns promises for async authentication workflows
+ * - Coordinates with UserAuthUC for actual authentication logic
+ *
+ * Usage pattern:
+ * 1. Call loginUser with credentials and appObjects repository
+ * 2. Controller validates UC existence and initiates login workflow
+ * 3. Handle returned Promise for authentication success or failure
+ * 4. Error handling provides feedback if authentication UC is unavailable
+ */
 import { AppObjectRepo } from "@vived/core";
+/**
+ * Authenticates a user with username and password credentials
+ * @param userName The user's login username
+ * @param password The user's login password
+ * @param appObjects The AppObjectRepo containing the UserAuthUC
+ * @returns Promise that resolves when login is complete or rejects on error
+ */
 export declare function loginUser(userName: string, password: string, appObjects: AppObjectRepo): Promise<void>;
 //# sourceMappingURL=loginUser.d.ts.map

package/dist/types/VivedAPI/Controllers/loginUser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"loginUser.d.ts","sourceRoot":"","sources":["../../../../src/VivedAPI/Controllers/loginUser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAG5C,wBAAgB,SAAS,CACvB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,aAAa,GACxB,OAAO,CAAC,IAAI,CAAC,CASf"}
+{"version":3,"file":"loginUser.d.ts","sourceRoot":"","sources":["../../../../src/VivedAPI/Controllers/loginUser.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAG5C;;;;;;GAMG;AACH,wBAAgB,SAAS,CACvB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,aAAa,GACxB,OAAO,CAAC,IAAI,CAAC,CASf"}

package/dist/types/VivedAPI/Controllers/logoutUser.d.ts

@@ -1,3 +1,28 @@
+/**
+ * logoutUser.ts
+ *
+ * This file defines a controller function for user logout operations.
+ * The logoutUser controller provides a simple interface for terminating user
+ * sessions and clearing authentication state through the VIVED API.
+ *
+ * Key concepts:
+ * - Controller functions handle user input and direct logout operations
+ * - Validates UserAuthUC existence before performing logout operations
+ * - Provides error handling and warning messages for missing components
+ * - Returns promises for async logout workflows
+ * - Coordinates with UserAuthUC for actual logout logic
+ *
+ * Usage pattern:
+ * 1. Call logoutUser with appObjects repository
+ * 2. Controller validates UC existence and initiates logout workflow
+ * 3. Handle returned Promise for logout success or failure
+ * 4. Error handling provides feedback if authentication UC is unavailable
+ */
 import { AppObjectRepo } from "@vived/core";
+/**
+ * Logs out the current user and terminates the session
+ * @param appObjects The AppObjectRepo containing the UserAuthUC
+ * @returns Promise that resolves when logout is complete or rejects on error
+ */
 export declare function logoutUser(appObjects: AppObjectRepo): Promise<void>;
 //# sourceMappingURL=logoutUser.d.ts.map

package/dist/types/VivedAPI/Controllers/logoutUser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"logoutUser.d.ts","sourceRoot":"","sources":["../../../../src/VivedAPI/Controllers/logoutUser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAG5C,wBAAgB,UAAU,CAAC,UAAU,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CASnE"}
+{"version":3,"file":"logoutUser.d.ts","sourceRoot":"","sources":["../../../../src/VivedAPI/Controllers/logoutUser.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAG5C;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,UAAU,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CASnE"}

package/dist/types/VivedAPI/Controllers/setApiStage.d.ts

@@ -1,4 +1,29 @@
+/**
+ * setApiStage.ts
+ *
+ * This file defines a controller function for setting the API stage configuration.
+ * The setApiStage controller provides a simple interface for changing the API environment
+ * that the application communicates with.
+ *
+ * Key concepts:
+ * - Controller functions handle user input and direct operations
+ * - Validates entity existence before performing operations
+ * - Provides error handling and warning messages for missing components
+ * - Updates the VivedAPIEntity singleton with new stage configuration
+ * - Triggers change notifications to update dependent components
+ *
+ * Usage pattern:
+ * 1. Call setApiStage with desired stage and appObjects repository
+ * 2. Controller validates entity existence and updates configuration
+ * 3. Change notifications propagate to PMs and UI components
+ * 4. Error handling provides feedback if entity is not available
+ */
 import { AppObjectRepo } from "@vived/core";
 import { APIStage } from "../Entities";
+/**
+ * Sets the API stage configuration for the application
+ * @param stage The APIStage to set as the current environment
+ * @param appObjects The AppObjectRepo containing the VivedAPIEntity singleton
+ */
 export declare function setApiStage(stage: APIStage, appObjects: AppObjectRepo): void;
 //# sourceMappingURL=setApiStage.d.ts.map

package/dist/types/VivedAPI/Controllers/setApiStage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"setApiStage.d.ts","sourceRoot":"","sources":["../../../../src/VivedAPI/Controllers/setApiStage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAkB,MAAM,aAAa,CAAC;AAEvD,wBAAgB,WAAW,CAAC,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,aAAa,QAOrE"}
+{"version":3,"file":"setApiStage.d.ts","sourceRoot":"","sources":["../../../../src/VivedAPI/Controllers/setApiStage.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAkB,MAAM,aAAa,CAAC;AAEvD;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,aAAa,QAOrE"}

package/dist/types/VivedAPI/Entities/VivedAPIEntity.d.ts

@@ -1,25 +1,98 @@
+/**
+ * VivedAPIEntity.ts
+ *
+ * This file defines the core entity for managing VIVED API configuration and authentication.
+ * The VivedAPIEntity acts as a singleton component that centralizes API communication settings,
+ * including environment-specific base URLs and user authentication tokens.
+ *
+ * Key concepts:
+ * - Manages API stage configuration (Production, Staging, Development, Local)
+ * - Stores and tracks user authentication tokens
+ * - Provides environment-specific base URLs for API requests
+ * - Notifies observers when API settings change
+ * - Implements singleton pattern for system-wide API configuration
+ *
+ * Usage pattern:
+ * 1. Get the singleton entity using VivedAPIEntity.get(appObjects)
+ * 2. Configure API stage and user token as needed
+ * 3. Use baseUrl and getEndpointURL for API requests
+ * 4. Register change observers to react to configuration updates
+ */
 import { AppObject, AppObjectEntity, AppObjectRepo } from "@vived/core";
+/**
+ * Enum representing different API environment stages
+ */
 export declare enum APIStage {
+    /** Production environment with live data */
     PRODUCTION = "Production",
+    /** Staging environment for pre-production testing */
     STAGING = "Staging",
+    /** Development environment for testing */
     DEVELOPMENT = "Development",
+    /** Local development environment */
     LOCAL = "LOCAL"
 }
+/**
+ * VivedAPIEntity manages API configuration and authentication state.
+ * This singleton entity provides centralized access to API settings including
+ * environment-specific URLs and user authentication tokens.
+ */
 export declare class VivedAPIEntity extends AppObjectEntity {
+    /** Unique type identifier for this component */
     static type: string;
+    /**
+     * Retrieves the singleton VivedAPIEntity from the app objects repository
+     * @param appObjects The AppObjectRepo to get the singleton from
+     * @returns The VivedAPIEntity singleton or undefined if not found
+     */
     static get(appObjects: AppObjectRepo): VivedAPIEntity | undefined;
+    /** Production API base URL */
     productionURL: string;
+    /** Staging API base URL */
     stagingURL: string;
+    /** Development API base URL */
     developmentURL: string;
+    /** Local development API base URL */
     localURL: string;
+    /** Memoized API stage that notifies on changes */
     private memoizedApiState;
+    /**
+     * Gets the current API stage
+     * @returns The current APIStage
+     */
     get apiStage(): APIStage;
+    /**
+     * Sets the API stage and notifies observers of the change
+     * @param apiState The new APIStage to set
+     */
     set apiStage(apiState: APIStage);
+    /**
+     * Gets the base URL for the current API stage
+     * @returns The base URL string for the current environment
+     */
     get baseUrl(): string;
+    /**
+     * Constructs a complete endpoint URL using the current base URL
+     * @param endpoint The endpoint path to append to the base URL
+     * @returns A URL object representing the complete endpoint URL
+     */
     getEndpointURL: (endpoint: string) => URL;
+    /** Memoized user authentication token that notifies on changes */
     private memoizedUserToken;
+    /**
+     * Gets the current user authentication token
+     * @returns The current user token string
+     */
     get userToken(): string;
+    /**
+     * Sets the user authentication token and notifies observers
+     * @param val The new user token to set
+     */
     set userToken(val: string);
+    /**
+     * Constructs a new VivedAPIEntity and registers it as a singleton
+     * @param appObject The AppObject this entity belongs to
+     */
     constructor(appObject: AppObject);
 }
 //# sourceMappingURL=VivedAPIEntity.d.ts.map

package/dist/types/VivedAPI/Entities/VivedAPIEntity.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"VivedAPIEntity.d.ts","sourceRoot":"","sources":["../../../../src/VivedAPI/Entities/VivedAPIEntity.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,SAAS,EACT,eAAe,EACf,aAAa,EACd,MAAM,aAAa,CAAC;AAErB,oBAAY,QAAQ;IAClB,UAAU,eAAe;IACzB,OAAO,YAAY;IACnB,WAAW,gBAAgB;IAC3B,KAAK,UAAU;CAChB;AAED,qBAAa,cAAe,SAAQ,eAAe;IACjD,MAAM,CAAC,IAAI,SAAoB;IAE/B,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,aAAa,GAAG,cAAc,GAAG,SAAS;IAIjE,aAAa,SAAmC;IAChD,UAAU,SAA2C;IACrD,cAAc,SAAwC;IACtD,QAAQ,SAA2B;IAEnC,OAAO,CAAC,gBAAgB,CAGtB;IAEF,IAAI,QAAQ,IAGW,QAAQ,CAD9B;IACD,IAAI,QAAQ,CAAC,QAAQ,EAAE,QAAQ,EAE9B;IAED,IAAI,OAAO,IAAI,MAAM,CAWpB;IAED,cAAc,GAAI,UAAU,MAAM,KAAG,GAAG,CAEtC;IAEF,OAAO,CAAC,iBAAiB,CAA+C;IACxE,IAAI,SAAS,IAAI,MAAM,CAEtB;IACD,IAAI,SAAS,CAAC,GAAG,EAAE,MAAM,EAExB;gBAEW,SAAS,EAAE,SAAS;CAIjC"}
+{"version":3,"file":"VivedAPIEntity.d.ts","sourceRoot":"","sources":["../../../../src/VivedAPI/Entities/VivedAPIEntity.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAGH,OAAO,EAEL,SAAS,EACT,eAAe,EACf,aAAa,EACd,MAAM,aAAa,CAAC;AAErB;;GAEG;AACH,oBAAY,QAAQ;IAClB,4CAA4C;IAC5C,UAAU,eAAe;IACzB,qDAAqD;IACrD,OAAO,YAAY;IACnB,0CAA0C;IAC1C,WAAW,gBAAgB;IAC3B,oCAAoC;IACpC,KAAK,UAAU;CAChB;AAED;;;;GAIG;AACH,qBAAa,cAAe,SAAQ,eAAe;IACjD,gDAAgD;IAChD,MAAM,CAAC,IAAI,SAAoB;IAE/B;;;;OAIG;IACH,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,aAAa,GAAG,cAAc,GAAG,SAAS;IAIjE,8BAA8B;IAC9B,aAAa,SAAmC;IAChD,2BAA2B;IAC3B,UAAU,SAA2C;IACrD,+BAA+B;IAC/B,cAAc,SAAwC;IACtD,qCAAqC;IACrC,QAAQ,SAA2B;IAEnC,kDAAkD;IAClD,OAAO,CAAC,gBAAgB,CAGtB;IAEF;;;OAGG;IACH,IAAI,QAAQ,IAQW,QAAQ,CAN9B;IAED;;;OAGG;IACH,IAAI,QAAQ,CAAC,QAAQ,EAAE,QAAQ,EAE9B;IAED;;;OAGG;IACH,IAAI,OAAO,IAAI,MAAM,CAWpB;IAED;;;;OAIG;IACH,cAAc,GAAI,UAAU,MAAM,KAAG,GAAG,CAEtC;IAEF,kEAAkE;IAClE,OAAO,CAAC,iBAAiB,CAA+C;IAExE;;;OAGG;IACH,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED;;;OAGG;IACH,IAAI,SAAS,CAAC,GAAG,EAAE,MAAM,EAExB;IAED;;;OAGG;gBACS,SAAS,EAAE,SAAS;CAIjC"}

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

@@ -1,2 +1,18 @@
+/**
+ * VivedAPI Entities Index
+ *
+ * This module exports all entity classes for the VivedAPI feature.
+ * Entities represent the core business objects and data models that store state,
+ * track changes, and notify observers when modifications occur.
+ *
+ * Key Concepts:
+ * - Entities extend AppObjectEntity and manage domain-specific data
+ * - They use Memoized types to track changes and trigger notifications
+ * - Singleton entities provide system-wide access to shared configuration
+ * - Entities form the foundation for API communication and authentication
+ *
+ * Available Entities:
+ * - VivedAPIEntity: Manages API configuration, authentication, and environment settings
+ */
 export * from "./VivedAPIEntity";
 //# sourceMappingURL=index.d.ts.map

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

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

package/dist/types/VivedAPI/Factories/VivedAPIFactory.d.ts

@@ -0,0 +1,42 @@
+import { DomainFactory } from "@vived/core";
+/**
+ * Factory responsible for setting up the VIVED API domain components.
+ *
+ * This factory initializes all entities, use cases, and presentation models
+ * required for the VIVED API functionality. It follows the domain-driven
+ * design pattern by organizing components into their respective layers.
+ *
+ * @extends DomainFactory
+ */
+export declare class VivedAPIFactory extends DomainFactory {
+    factoryName: string;
+    /**
+     * Sets up all entities required for the VIVED API system.
+     *
+     * Initializes singleton entities that maintain the state and business
+     * logic for the VIVED API functionality.
+     */
+    setupEntities(): void;
+    /**
+     * Sets up all use cases for the VIVED API system.
+     *
+     * Initializes use cases that define the business operations and
+     * workflows available in the VIVED API.
+     */
+    setupUCs(): void;
+    /**
+     * Sets up all presentation managers for the VIVED API system.
+     *
+     * Initializes presentation managers that handle the view logic and
+     * state management for UI components related to the VIVED API.
+     */
+    setupPMs(): void;
+    /**
+     * Performs any final setup operations after all components are initialized.
+     *
+     * This method is called after entities, use cases, and presentation models
+     * have been set up. Currently no additional setup is required for the VIVED API.
+     */
+    finalSetup(): void;
+}
+//# sourceMappingURL=VivedAPIFactory.d.ts.map

package/dist/types/VivedAPI/Factories/VivedAPIFactory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"VivedAPIFactory.d.ts","sourceRoot":"","sources":["../../../../src/VivedAPI/Factories/VivedAPIFactory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAiB5C;;;;;;;;GAQG;AACH,qBAAa,eAAgB,SAAQ,aAAa;IAChD,WAAW,SAAqB;IAEhC;;;;;OAKG;IACH,aAAa,IAAI,IAAI;IAIrB;;;;;OAKG;IACH,QAAQ,IAAI,IAAI;IAchB;;;;;OAKG;IACH,QAAQ,IAAI,IAAI;IAIhB;;;;;OAKG;IACH,UAAU,IAAI,IAAI;CAGnB"}

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

@@ -1,2 +1,21 @@
-export * from "./VivedApiFactory";
+/**
+ * VivedAPI Factories Index
+ *
+ * This module exports all factory functions for the VivedAPI feature.
+ * Factory functions provide centralized component creation and feature setup,
+ * ensuring proper initialization and component wiring for different environments.
+ *
+ * Key Concepts:
+ * - Factory functions encapsulate complex component creation workflows
+ * - They establish proper dependencies and relationships between components
+ * - Factories provide environment-specific setup (sandbox, production, testing)
+ * - They ensure singleton registration and component availability
+ * - Factory functions serve as entry points for feature initialization
+ *
+ * Available Factories:
+ * - setupVivedAPIForSandbox: Complete feature setup for sandbox environments
+ */
+export * from "./setupVivedAPIForSandbox";
+export * from "./VivedAPIFactory";
+export * from "./setupAPI";
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/VivedAPI/Factories/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/VivedAPI/Factories/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mBAAmB,CAAC;AAClC,cAAc,YAAY,CAAC"}

package/dist/types/VivedAPI/Factories/setupAPI.d.ts

@@ -0,0 +1,8 @@
+import { AppObjectRepo } from "@vived/core";
+/**
+ * Sets up the VIVED API system using the domain factory pattern
+ *
+ * @param appObjects The application's object repository
+ */
+export declare function setupAPI(appObjects: AppObjectRepo): void;
+//# sourceMappingURL=setupAPI.d.ts.map

package/dist/types/VivedAPI/Factories/setupAPI.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setupAPI.d.ts","sourceRoot":"","sources":["../../../../src/VivedAPI/Factories/setupAPI.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAqB,MAAM,aAAa,CAAC;AAG/D;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,UAAU,EAAE,aAAa,QAejD"}

package/dist/types/VivedAPI/Factories/setupVivedAPIForSandbox.d.ts

@@ -1,3 +1,28 @@
+/**
+ * setupVivedAPIForSandbox.ts
+ *
+ * This file defines the factory function for setting up the complete VivedAPI feature
+ * in a sandbox environment. It initializes all necessary components including entities,
+ * use cases, and presentation managers required for API communication.
+ *
+ * Key concepts:
+ * - Factory function creates and wires up all VivedAPI components
+ * - Creates a dedicated AppObject for organizing API-related components
+ * - Initializes singleton entities for API configuration management
+ * - Sets up all use cases for various API operations (assets, apps, auth)
+ * - Establishes presentation managers for UI integration
+ * - Provides a single entry point for complete feature setup
+ *
+ * Usage pattern:
+ * 1. Call setupVivedAPIForSandbox with AppObjectRepo during initialization
+ * 2. Function creates all necessary components and registers them
+ * 3. Components become available through standard AppObject retrieval methods
+ * 4. Use in sandbox environments for development and testing
+ */
 import { AppObjectRepo } from "@vived/core";
+/**
+ * Sets up the complete VivedAPI feature for sandbox environments
+ * @param appObjects The AppObjectRepo to register all VivedAPI components in
+ */
 export declare function setupVivedAPIForSandbox(appObjects: AppObjectRepo): void;
 //# sourceMappingURL=setupVivedAPIForSandbox.d.ts.map

package/dist/types/VivedAPI/Factories/setupVivedAPIForSandbox.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"setupVivedAPIForSandbox.d.ts","sourceRoot":"","sources":["../../../../src/VivedAPI/Factories/setupVivedAPIForSandbox.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAiB5C,wBAAgB,uBAAuB,CAAC,UAAU,EAAE,aAAa,QAqBhE"}
+{"version":3,"file":"setupVivedAPIForSandbox.d.ts","sourceRoot":"","sources":["../../../../src/VivedAPI/Factories/setupVivedAPIForSandbox.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAiB5C;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,UAAU,EAAE,aAAa,QAqBhE"}

package/dist/types/VivedAPI/Mocks/MockJsonRequestUC.d.ts

@@ -1,8 +1,42 @@
+/**
+ * MockJsonRequestUC.ts
+ *
+ * This file provides a mock implementation of JsonRequestUC for testing and development.
+ * MockJsonRequestUC replaces real HTTP request functionality with Jest mock functions,
+ * enabling controlled testing scenarios and development without live API dependencies.
+ *
+ * Key concepts:
+ * - Mock extends the real JsonRequestUC class to maintain interface compatibility
+ * - Uses Jest mock functions to provide controllable request behavior
+ * - Enables testing of components that depend on JSON HTTP requests
+ * - Allows simulation of various response scenarios (success, failure, delays)
+ * - Supports isolated unit testing without external API dependencies
+ *
+ * Usage pattern:
+ * 1. Use makeMockJsonRequestUC to create and register the mock
+ * 2. Configure mock behavior using Jest mock function methods
+ * 3. Test components can verify request calls and control responses
+ * 4. Replace with real implementation for integration testing
+ */
 import { AppObject, AppObjectRepo } from "@vived/core";
 import { JsonRequestUC } from "../UCs/JsonRequestUC";
+/**
+ * Mock implementation of JsonRequestUC for testing and development
+ * Provides Jest mock functions instead of real HTTP request functionality
+ */
 export declare class MockJsonRequestUC extends JsonRequestUC {
+    /** Jest mock function for the doRequest method */
     doRequest: jest.Mock<any, any, any>;
+    /**
+     * Constructs a new MockJsonRequestUC
+     * @param appObject The AppObject this mock UC belongs to
+     */
     constructor(appObject: AppObject);
 }
+/**
+ * Factory function to create and register a MockJsonRequestUC
+ * @param appObjects The AppObjectRepo to create the mock in
+ * @returns A new MockJsonRequestUC instance
+ */
 export declare function makeMockJsonRequestUC(appObjects: AppObjectRepo): MockJsonRequestUC;
 //# sourceMappingURL=MockJsonRequestUC.d.ts.map

package/dist/types/VivedAPI/Mocks/MockJsonRequestUC.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MockJsonRequestUC.d.ts","sourceRoot":"","sources":["../../../../src/VivedAPI/Mocks/MockJsonRequestUC.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAErD,qBAAa,iBAAkB,SAAQ,aAAa;IAClD,SAAS,2BAAa;gBAEV,SAAS,EAAE,SAAS;CAGjC;AAED,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,aAAa,qBAE9D"}
+{"version":3,"file":"MockJsonRequestUC.d.ts","sourceRoot":"","sources":["../../../../src/VivedAPI/Mocks/MockJsonRequestUC.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAErD;;;GAGG;AACH,qBAAa,iBAAkB,SAAQ,aAAa;IAClD,kDAAkD;IAClD,SAAS,2BAAa;IAEtB;;;OAGG;gBACS,SAAS,EAAE,SAAS;CAGjC;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,aAAa,qBAE9D"}

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

@@ -1,3 +1,27 @@
+/**
+ * VivedAPI Mocks Index
+ *
+ * This module exports all mock implementations for the VivedAPI feature.
+ * Mocks provide test doubles and stub implementations for development and testing
+ * scenarios where real API communication is not desired or available.
+ *
+ * Key Concepts:
+ * - Mocks implement the same interfaces as production components
+ * - They provide predictable, controllable behavior for testing
+ * - Mocks can simulate various success and failure scenarios
+ * - They enable development without requiring live API connections
+ * - Mock implementations support isolated unit testing
+ *
+ * Available Mock Components:
+ * - Presentation Manager Mocks: ApiStagePMMock, UserTokenPMMock
+ * - HTTP Request Mocks: MockBasicFetchUC, MockJsonRequestUC, MockBlobRequestUC
+ * - Authentication Mocks: MockSignedAuthToken, MockUserLoginUC
+ * - File Operation Mocks: MockFileUpload, MockFetchAssetFileFromAPIUC, MockPatchAssetFileUC
+ * - Asset Management Mocks: MockPostNewAssetUC, MockDeleteAssetOnAPIUC, MockGetAssetsForOwnerUC
+ * - Asset Metadata Mocks: MockFetchAssetMetaFromAPIUC, MockPatchAssetMetaUC, MockPatchAssetIsArchivedUC
+ * - App Management Mocks: MockGetAppFromAPIUC
+ * - Asset Update Mocks: MockPatchAssetUC
+ */
 export * from "./ApiStagePMMock";
 export * from "./MockBasicFetchUC";
 export * from "./MockBlobRequestUC";

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/VivedAPI/Mocks/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC;AACtC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,qBAAqB,CAAC;AACpC,cAAc,wBAAwB,CAAC;AACvC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/VivedAPI/Mocks/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC;AACtC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,qBAAqB,CAAC;AACpC,cAAc,wBAAwB,CAAC;AACvC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC"}

package/dist/types/VivedAPI/PMs/ApiStagePM.d.ts

@@ -1,8 +1,43 @@
+/**
+ * ApiStagePM.ts
+ *
+ * This file defines the Presentation Manager for API stage configuration.
+ * ApiStagePM bridges the VivedAPIEntity domain logic with UI components,
+ * managing the display and interaction of API environment settings.
+ *
+ * Key concepts:
+ * - PM extends AppObjectPM and manages view model state for API stage
+ * - Observes VivedAPIEntity changes and updates UI accordingly
+ * - Provides value comparison logic for efficient view updates
+ * - Implements singleton pattern for system-wide stage management
+ * - Handles API stage transitions and notifications
+ *
+ * Usage pattern:
+ * 1. Get the singleton PM using ApiStagePM.get(appObjects)
+ * 2. Connect to UI components that display/edit API stage
+ * 3. PM automatically updates views when entity state changes
+ * 4. Use with adapters to bind to specific UI frameworks
+ */
 import { AppObject, AppObjectPM, AppObjectRepo } from "@vived/core";
 import { APIStage } from "../Entities";
+/**
+ * ApiStagePM provides presentation logic for API stage configuration.
+ * Abstract class that manages the view model for API environment settings.
+ */
 export declare abstract class ApiStagePM extends AppObjectPM<APIStage> {
+    /** Unique type identifier for this component */
     static type: string;
+    /**
+     * Retrieves the singleton ApiStagePM from the app objects repository
+     * @param appObjects The AppObjectRepo to get the singleton from
+     * @returns The ApiStagePM singleton or undefined if not found
+     */
     static get(appObjects: AppObjectRepo): ApiStagePM | undefined;
 }
+/**
+ * Factory function to create a new ApiStagePM instance
+ * @param appObject The AppObject to attach the PM to
+ * @returns A new ApiStagePM instance
+ */
 export declare function makeApiStagePM(appObject: AppObject): ApiStagePM;
 //# sourceMappingURL=ApiStagePM.d.ts.map

package/dist/types/VivedAPI/PMs/ApiStagePM.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ApiStagePM.d.ts","sourceRoot":"","sources":["../../../../src/VivedAPI/PMs/ApiStagePM.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,SAAS,EACT,WAAW,EACX,aAAa,EACd,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,QAAQ,EAAkB,MAAM,aAAa,CAAC;AAEvD,8BAAsB,UAAW,SAAQ,WAAW,CAAC,QAAQ,CAAC;IAC5D,MAAM,CAAC,IAAI,SAAgB;IAE3B,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,aAAa;CAGrC;AAED,wBAAgB,cAAc,CAAC,SAAS,EAAE,SAAS,GAAG,UAAU,CAE/D"}
+{"version":3,"file":"ApiStagePM.d.ts","sourceRoot":"","sources":["../../../../src/VivedAPI/PMs/ApiStagePM.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,EAEL,SAAS,EACT,WAAW,EACX,aAAa,EACd,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,QAAQ,EAAkB,MAAM,aAAa,CAAC;AAEvD;;;GAGG;AACH,8BAAsB,UAAW,SAAQ,WAAW,CAAC,QAAQ,CAAC;IAC5D,gDAAgD;IAChD,MAAM,CAAC,IAAI,SAAgB;IAE3B;;;;OAIG;IACH,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,aAAa;CAGrC;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,SAAS,EAAE,SAAS,GAAG,UAAU,CAE/D"}