npm - @vived/host - Versions diffs - 4.2.0 → 4.3.0 - Mend

@vived/host 4.2.0 → 4.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1621) hide show

package/dist/cjs/Apps/UCs/StartAppUC.js CHANGED Viewed

@@ -6,7 +6,27 @@ const core_1 = require("@vived/core");
 const AppSandbox_1 = require("../../AppSandbox");
 const Dispatcher_1 = require("../../Dispatcher");
 const Entities_1 = require("../../StateMachine/Entities");
+/**
+ * StartAppUC - Use case for starting an application in the host environment
+ *
+ * This use case is responsible for initializing and starting an application
+ * within the VIVED Learning platform. It handles setting up the application container,
+ * initializing the app with the appropriate state, and dispatching necessary configurations.
+ *
+ * The StartAppUC coordinates between several subsystems:
+ * - State Machine: Provides the current application state
+ * - Dispatcher: Communicates with the app via message passing
+ * - AppSandbox: Provides development features when enabled
+ *
+ * @extends AppObjectUC from @vived/core
+ */
 class StartAppUC extends core_1.AppObjectUC {
+    /**
+     * Gets a StartAppUC instance from an app object
+     *
+     * @param appObject - App object to get the StartAppUC from
+     * @returns StartAppUC instance if found, undefined otherwise
+     */
     static get(appObject) {
         const asset = appObject.getComponent(StartAppUC.type);
         if (!asset) {
@@ -14,6 +34,13 @@ class StartAppUC extends core_1.AppObjectUC {
         }
         return asset;
     }
+    /**
+     * Gets a StartAppUC instance by app ID
+     *
+     * @param id - ID of the app to start
+     * @param appObjects - Repository containing app objects
+     * @returns StartAppUC instance if found, undefined otherwise
+     */
     static getByID(id, appObjects) {
         const appObject = appObjects.get(id);
         if (!appObject) {
@@ -22,15 +49,34 @@ class StartAppUC extends core_1.AppObjectUC {
         }
         return StartAppUC.get(appObject);
     }
+    /**
+     * Convenience method to start an app by ID
+     *
+     * @param container - HTML element to mount the app in
+     * @param id - ID of the app to start
+     * @param appObjects - Repository containing app objects
+     */
     static startByID(container, id, appObjects) {
         StartAppUC.getByID(id, appObjects)?.start(container);
     }
 }
 exports.StartAppUC = StartAppUC;
+/** Type identifier for the StartAppUC component */
 StartAppUC.type = "StartAppUC";
+/**
+ * Factory function to create a new StartAppUC instance
+ *
+ * @param appObject - The app object to attach the use case to
+ * @returns A concrete implementation of StartAppUC
+ */
 function makeStartAppUC(appObject) {
     return new StartAppUCImp(appObject);
 }
+/**
+ * Concrete implementation of StartAppUC
+ * Uses dependency injection to access required components
+ * Handles the app starting process
+ */
 class StartAppUCImp extends StartAppUC {
     get stateMachine() {
         return this.getCachedSingleton(Entities_1.HostStateMachine.type);

package/dist/cjs/Apps/UCs/StartAppUC.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"StartAppUC.js","sourceRoot":"","sources":["../../../../src/Apps/UCs/StartAppUC.ts"],"names":[],"mappings":";;;~~AAyDA~~,wCAEC;~~AA3DD~~,sCAAoE;AACpE,iDAAoD;AACpD,iDAO0B;AAC1B,0DAGqC;AAErC,MAAsB,UAAW,SAAQ,kBAAW;~~IAKlD~~,MAAM,CAAC,GAAG,CAAC,SAAoB;QAC7B,MAAM,KAAK,GAAG,SAAS,CAAC,YAAY,CAAa,UAAU,CAAC,IAAI,CAAC,CAAC;QAClE,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,SAAS,CAAC,aAAa,CAAC,aAAa,CACnC,gBAAgB,EAChB,0CAA0C,GAAG,SAAS,CAAC,EAAE,CAC1D,CAAC;QACJ,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,CAAC,OAAO,CACZ,EAAU,EACV,UAAyB;QAEzB,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAErC,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,UAAU,CAAC,aAAa,CACtB,oBAAoB,EACpB,kCAAkC,GAAG,EAAE,CACxC,CAAC;YACF,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAED,MAAM,CAAC,SAAS,CACd,SAAsB,EACtB,EAAU,EACV,UAAyB;QAEzB,UAAU,CAAC,OAAO,CAAC,EAAE,EAAE,UAAU,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IACvD,CAAC;;~~AAvCH~~,~~gCAwCC~~;~~AAvCQ~~,eAAI,GAAG,YAAY,CAAC;~~AAyC7B~~,SAAgB,cAAc,CAAC,SAAoB;IACjD,OAAO,IAAI,aAAa,CAAC,SAAS,CAAC,CAAC;AACtC,CAAC;AAED,MAAM,aAAc,SAAQ,UAAU;IACpC,IAAY,YAAY;QACtB,OAAO,IAAI,CAAC,kBAAkB,CAAmB,2BAAgB,CAAC,IAAI,CAAC,CAAC;IAC1E,CAAC;IAED,IAAY,eAAe;QACzB,OAAO,IAAI,CAAC,kBAAkB,CAC5B,iCAAsB,CAAC,IAAI,CAC5B,CAAC;IACJ,CAAC;IAED,IAAY,aAAa;QACvB,OAAO,IAAI,CAAC,uBAAuB,CACjC,+BAAkB,CAAC,IAAI,CACxB,CAAC;IACJ,CAAC;IAED,IAAY,gBAAgB;QAC1B,OAAO,IAAI,CAAC,uBAAuB,CACjC,+BAAkB,CAAC,IAAI,CACxB,CAAC;IACJ,CAAC;IAED,IAAY,sBAAsB;QAChC,OAAO,IAAI,CAAC,uBAAuB,CACjC,kCAAqB,CAAC,IAAI,CAC3B,CAAC;IACJ,CAAC;IAED,IAAY,mBAAmB;QAC7B,OAAO,IAAI,CAAC,uBAAuB,CAAkB,4BAAe,CAAC,IAAI,CAAC,CAAC;IAC7E,CAAC;IAED,IAAY,qBAAqB;QAC/B,OAAO,IAAI,CAAC,uBAAuB,CACjC,oCAAuB,CAAC,IAAI,CAC7B,CAAC;IACJ,CAAC;IAED,IAAY,OAAO;QACjB,OAAO,IAAI,CAAC,kBAAkB,CAAmB,6BAAgB,CAAC,IAAI,CAAC,CAAC;IAC1E,CAAC;IA0CD,YAAY,SAAoB;QAC9B,KAAK,CAAC,SAAS,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;QAzCpC,UAAK,GAAG,CAAC,SAAsB,EAAE,EAAE;YACjC,IAAI,CAAC,IAAI,CAAC,YAAY;gBAAE,OAAO;YAC/B,IAAI,CAAC,IAAI,CAAC,aAAa;gBAAE,OAAO;YAChC,IAAI,CAAC,IAAI,CAAC,eAAe;gBAAE,OAAO;YAClC,IAAI,CAAC,IAAI,CAAC,OAAO;gBAAE,OAAO;YAE1B,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;YAEzC,IAAI,KAAK,CAAC;YACV,IAAI,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC;gBAClC,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC;oBACnE,EAAE,SAAS,CAAC;YAChB,CAAC;YAED,MAAM,cAAc,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,CAAC;YAC5D,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,SAAS,KAAK,SAAS,CAAC;YAC/D,MAAM,gBAAgB,GAAG,IAAI,CAAC,YAAY,CAAC,aAAa,KAAK,SAAS,CAAC;YACvE,MAAM,GAAG,GAAqB;gBAC5B,UAAU,EAAE,KAAK;gBACjB,cAAc;gBACd,YAAY;gBACZ,gBAAgB;aACjB,CAAC;YACF,IAAI,CAAC,gBAAgB,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC;YAEvC,IAAI,WAAW,GAAG,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC;YACjD,IAAI,IAAI,CAAC,YAAY,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;gBAChD,WAAW,GAAG,IAAI,CAAC;YACrB,CAAC;YACD,IAAI,CAAC,sBAAsB,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC;YAErD,IAAI,CAAC,mBAAmB,EAAE,UAAU,EAAE,CAAC;YAEvC,IAAI,IAAI,CAAC,OAAO,CAAC,iBAAiB,EAAE,CAAC;gBACnC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;oBAC3C,IAAI,CAAC,qBAAqB,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;gBAClD,CAAC,CAAC,CAAC;YACL,CAAC;QACH,CAAC,CAAC;IAIF,CAAC;CACF","sourcesContent":["import { AppObject, AppObjectRepo, AppObjectUC } from \"@vived/core\";\r\nimport { AppSandboxEntity } from \"../../AppSandbox\";\r\nimport {\r\n DispatchEnableFeatureUC,\r\n DispatchIsAuthoringUC,\r\n DispatchSetStateUC,\r\n DispatchStartAppUC,\r\n DispatchStateDTO,\r\n DispatchThemeUC\r\n} from \"../../Dispatcher\";\r\nimport {\r\n HostEditingStateEntity,\r\n HostStateMachine\r\n} from \"../../StateMachine/Entities\";\r\n\r\nexport abstract class StartAppUC extends AppObjectUC {\r\n static type = \"StartAppUC\";\r\n\r\n abstract start(container: HTMLElement): void;\r\n\r\n static get(appObject: AppObject): StartAppUC \| undefined {\r\n const asset = appObject.getComponent<StartAppUC>(StartAppUC.type);\r\n if (!asset) {\r\n appObject.appObjectRepo.submitWarning(\r\n \"StartAppUC.get\",\r\n \"Unable to find StartAppUC on app object \" + appObject.id\r\n );\r\n }\r\n return asset;\r\n }\r\n\r\n static getByID(\r\n id: string,\r\n appObjects: AppObjectRepo\r\n ): StartAppUC \| undefined {\r\n const appObject = appObjects.get(id);\r\n\r\n if (!appObject) {\r\n appObjects.submitWarning(\r\n \"StartAppUC.getByID\",\r\n \"Unable to find App Object by id \" + id\r\n );\r\n return undefined;\r\n }\r\n\r\n return StartAppUC.get(appObject);\r\n }\r\n\r\n static startByID(\r\n container: HTMLElement,\r\n id: string,\r\n appObjects: AppObjectRepo\r\n ) {\r\n StartAppUC.getByID(id, appObjects)?.start(container);\r\n }\r\n}\r\n\r\nexport function makeStartAppUC(appObject: AppObject): StartAppUC {\r\n return new StartAppUCImp(appObject);\r\n}\r\n\r\nclass StartAppUCImp extends StartAppUC {\r\n private get stateMachine() {\r\n return this.getCachedSingleton<HostStateMachine>(HostStateMachine.type);\r\n }\r\n\r\n private get editStateEntity() {\r\n return this.getCachedSingleton<HostEditingStateEntity>(\r\n HostEditingStateEntity.type\r\n );\r\n }\r\n\r\n private get dispatchStart() {\r\n return this.getCachedLocalComponent<DispatchStartAppUC>(\r\n DispatchStartAppUC.type\r\n );\r\n }\r\n\r\n private get dispatchSetState() {\r\n return this.getCachedLocalComponent<DispatchSetStateUC>(\r\n DispatchSetStateUC.type\r\n );\r\n }\r\n\r\n private get dispatchSetIsAuthoring() {\r\n return this.getCachedLocalComponent<DispatchIsAuthoringUC>(\r\n DispatchIsAuthoringUC.type\r\n );\r\n }\r\n\r\n private get dispatchThemeColors() {\r\n return this.getCachedLocalComponent<DispatchThemeUC>(DispatchThemeUC.type);\r\n }\r\n\r\n private get dispatchEnableFeature() {\r\n return this.getCachedLocalComponent<DispatchEnableFeatureUC>(\r\n DispatchEnableFeatureUC.type\r\n );\r\n }\r\n\r\n private get sandbox() {\r\n return this.getCachedSingleton<AppSandboxEntity>(AppSandboxEntity.type);\r\n }\r\n\r\n start = (container: HTMLElement) => {\r\n if (!this.stateMachine) return;\r\n if (!this.dispatchStart) return;\r\n if (!this.editStateEntity) return;\r\n if (!this.sandbox) return;\r\n\r\n this.dispatchStart.doDispatch(container);\r\n\r\n let state;\r\n if (this.stateMachine.activeState) {\r\n state = this.stateMachine.getStateByID(this.stateMachine.activeState)\r\n ?.stateData;\r\n }\r\n\r\n const hideNavigation = this.stateMachine.states.length <= 1;\r\n const hasNextSlide = this.stateMachine.nextState !== undefined;\r\n const hasPreviousSlide = this.stateMachine.previousState !== undefined;\r\n const dto: DispatchStateDTO = {\r\n finalState: state,\r\n hideNavigation,\r\n hasNextSlide,\r\n hasPreviousSlide\r\n };\r\n this.dispatchSetState?.doDispatch(dto);\r\n\r\n let isAuthoring = this.editStateEntity.isEditing;\r\n if (this.stateMachine.activeState === undefined) {\r\n isAuthoring = true;\r\n }\r\n this.dispatchSetIsAuthoring?.doDispatch(isAuthoring);\r\n\r\n this.dispatchThemeColors?.doDispatch();\r\n\r\n if (this.sandbox.enableDevFeatures) {\r\n this.sandbox.devFeatures.forEach((feature) => {\r\n this.dispatchEnableFeature?.doDispatch(feature);\r\n });\r\n }\r\n };\r\n\r\n constructor(appObject: AppObject) {\r\n super(appObject, StartAppUC.type);\r\n }\r\n}\r\n"]}
1	+ {"version":3,"file":"StartAppUC.js","sourceRoot":"","sources":["../../../../src/Apps/UCs/StartAppUC.ts"],"names":[],"mappings":";;;AAuGA,wCAEC;AAzGD,sCAAoE;AACpE,iDAAoD;AACpD,iDAO0B;AAC1B,0DAGqC;AAErC;;;;;;;;;;;;;GAaG;AACH,MAAsB,UAAW,SAAQ,kBAAW;IAWlD;;;;;OAKG;IACH,MAAM,CAAC,GAAG,CAAC,SAAoB;QAC7B,MAAM,KAAK,GAAG,SAAS,CAAC,YAAY,CAAa,UAAU,CAAC,IAAI,CAAC,CAAC;QAClE,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,SAAS,CAAC,aAAa,CAAC,aAAa,CACnC,gBAAgB,EAChB,0CAA0C,GAAG,SAAS,CAAC,EAAE,CAC1D,CAAC;QACJ,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,OAAO,CACZ,EAAU,EACV,UAAyB;QAEzB,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAErC,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,UAAU,CAAC,aAAa,CACtB,oBAAoB,EACpB,kCAAkC,GAAG,EAAE,CACxC,CAAC;YACF,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,SAAS,CACd,SAAsB,EACtB,EAAU,EACV,UAAyB;QAEzB,UAAU,CAAC,OAAO,CAAC,EAAE,EAAE,UAAU,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IACvD,CAAC;;AAjEH,gCAkEC;AAjEC,mDAAmD;AAC5C,eAAI,GAAG,YAAY,CAAC;AAkE7B;;;;;GAKG;AACH,SAAgB,cAAc,CAAC,SAAoB;IACjD,OAAO,IAAI,aAAa,CAAC,SAAS,CAAC,CAAC;AACtC,CAAC;AAED;;;;GAIG;AACH,MAAM,aAAc,SAAQ,UAAU;IACpC,IAAY,YAAY;QACtB,OAAO,IAAI,CAAC,kBAAkB,CAAmB,2BAAgB,CAAC,IAAI,CAAC,CAAC;IAC1E,CAAC;IAED,IAAY,eAAe;QACzB,OAAO,IAAI,CAAC,kBAAkB,CAC5B,iCAAsB,CAAC,IAAI,CAC5B,CAAC;IACJ,CAAC;IAED,IAAY,aAAa;QACvB,OAAO,IAAI,CAAC,uBAAuB,CACjC,+BAAkB,CAAC,IAAI,CACxB,CAAC;IACJ,CAAC;IAED,IAAY,gBAAgB;QAC1B,OAAO,IAAI,CAAC,uBAAuB,CACjC,+BAAkB,CAAC,IAAI,CACxB,CAAC;IACJ,CAAC;IAED,IAAY,sBAAsB;QAChC,OAAO,IAAI,CAAC,uBAAuB,CACjC,kCAAqB,CAAC,IAAI,CAC3B,CAAC;IACJ,CAAC;IAED,IAAY,mBAAmB;QAC7B,OAAO,IAAI,CAAC,uBAAuB,CAAkB,4BAAe,CAAC,IAAI,CAAC,CAAC;IAC7E,CAAC;IAED,IAAY,qBAAqB;QAC/B,OAAO,IAAI,CAAC,uBAAuB,CACjC,oCAAuB,CAAC,IAAI,CAC7B,CAAC;IACJ,CAAC;IAED,IAAY,OAAO;QACjB,OAAO,IAAI,CAAC,kBAAkB,CAAmB,6BAAgB,CAAC,IAAI,CAAC,CAAC;IAC1E,CAAC;IA0CD,YAAY,SAAoB;QAC9B,KAAK,CAAC,SAAS,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;QAzCpC,UAAK,GAAG,CAAC,SAAsB,EAAE,EAAE;YACjC,IAAI,CAAC,IAAI,CAAC,YAAY;gBAAE,OAAO;YAC/B,IAAI,CAAC,IAAI,CAAC,aAAa;gBAAE,OAAO;YAChC,IAAI,CAAC,IAAI,CAAC,eAAe;gBAAE,OAAO;YAClC,IAAI,CAAC,IAAI,CAAC,OAAO;gBAAE,OAAO;YAE1B,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;YAEzC,IAAI,KAAK,CAAC;YACV,IAAI,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC;gBAClC,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC;oBACnE,EAAE,SAAS,CAAC;YAChB,CAAC;YAED,MAAM,cAAc,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,CAAC;YAC5D,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,SAAS,KAAK,SAAS,CAAC;YAC/D,MAAM,gBAAgB,GAAG,IAAI,CAAC,YAAY,CAAC,aAAa,KAAK,SAAS,CAAC;YACvE,MAAM,GAAG,GAAqB;gBAC5B,UAAU,EAAE,KAAK;gBACjB,cAAc;gBACd,YAAY;gBACZ,gBAAgB;aACjB,CAAC;YACF,IAAI,CAAC,gBAAgB,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC;YAEvC,IAAI,WAAW,GAAG,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC;YACjD,IAAI,IAAI,CAAC,YAAY,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;gBAChD,WAAW,GAAG,IAAI,CAAC;YACrB,CAAC;YACD,IAAI,CAAC,sBAAsB,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC;YAErD,IAAI,CAAC,mBAAmB,EAAE,UAAU,EAAE,CAAC;YAEvC,IAAI,IAAI,CAAC,OAAO,CAAC,iBAAiB,EAAE,CAAC;gBACnC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;oBAC3C,IAAI,CAAC,qBAAqB,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;gBAClD,CAAC,CAAC,CAAC;YACL,CAAC;QACH,CAAC,CAAC;IAIF,CAAC;CACF","sourcesContent":["import { AppObject, AppObjectRepo, AppObjectUC } from \"@vived/core\";\r\nimport { AppSandboxEntity } from \"../../AppSandbox\";\r\nimport {\r\n DispatchEnableFeatureUC,\r\n DispatchIsAuthoringUC,\r\n DispatchSetStateUC,\r\n DispatchStartAppUC,\r\n DispatchStateDTO,\r\n DispatchThemeUC\r\n} from \"../../Dispatcher\";\r\nimport {\r\n HostEditingStateEntity,\r\n HostStateMachine\r\n} from \"../../StateMachine/Entities\";\r\n\r\n/*\r\n StartAppUC - Use case for starting an application in the host environment\r\n * \r\n * This use case is responsible for initializing and starting an application\r\n * within the VIVED Learning platform. It handles setting up the application container,\r\n * initializing the app with the appropriate state, and dispatching necessary configurations.\r\n * \r\n * The StartAppUC coordinates between several subsystems:\r\n * - State Machine: Provides the current application state\r\n * - Dispatcher: Communicates with the app via message passing\r\n * - AppSandbox: Provides development features when enabled\r\n * \r\n * @extends AppObjectUC from @vived/core\r\n /\r\nexport abstract class StartAppUC extends AppObjectUC {\r\n /* Type identifier for the StartAppUC component /\r\n static type = \"StartAppUC\";\r\n\r\n /\r\n Abstract method that starts the application\r\n * \r\n * @param container - HTML element that will contain the app\r\n /\r\n abstract start(container: HTMLElement): void;\r\n\r\n /\r\n Gets a StartAppUC instance from an app object\r\n * \r\n * @param appObject - App object to get the StartAppUC from\r\n * @returns StartAppUC instance if found, undefined otherwise\r\n /\r\n static get(appObject: AppObject): StartAppUC \| undefined {\r\n const asset = appObject.getComponent<StartAppUC>(StartAppUC.type);\r\n if (!asset) {\r\n appObject.appObjectRepo.submitWarning(\r\n \"StartAppUC.get\",\r\n \"Unable to find StartAppUC on app object \" + appObject.id\r\n );\r\n }\r\n return asset;\r\n }\r\n\r\n /\r\n Gets a StartAppUC instance by app ID\r\n * \r\n * @param id - ID of the app to start\r\n * @param appObjects - Repository containing app objects\r\n * @returns StartAppUC instance if found, undefined otherwise\r\n /\r\n static getByID(\r\n id: string,\r\n appObjects: AppObjectRepo\r\n ): StartAppUC \| undefined {\r\n const appObject = appObjects.get(id);\r\n\r\n if (!appObject) {\r\n appObjects.submitWarning(\r\n \"StartAppUC.getByID\",\r\n \"Unable to find App Object by id \" + id\r\n );\r\n return undefined;\r\n }\r\n\r\n return StartAppUC.get(appObject);\r\n }\r\n\r\n /\r\n Convenience method to start an app by ID\r\n * \r\n * @param container - HTML element to mount the app in\r\n * @param id - ID of the app to start\r\n * @param appObjects - Repository containing app objects\r\n /\r\n static startByID(\r\n container: HTMLElement,\r\n id: string,\r\n appObjects: AppObjectRepo\r\n ) {\r\n StartAppUC.getByID(id, appObjects)?.start(container);\r\n }\r\n}\r\n\r\n/\r\n Factory function to create a new StartAppUC instance\r\n * \r\n * @param appObject - The app object to attach the use case to\r\n * @returns A concrete implementation of StartAppUC\r\n /\r\nexport function makeStartAppUC(appObject: AppObject): StartAppUC {\r\n return new StartAppUCImp(appObject);\r\n}\r\n\r\n/\r\n Concrete implementation of StartAppUC\r\n * Uses dependency injection to access required components\r\n * Handles the app starting process\r\n */\r\nclass StartAppUCImp extends StartAppUC {\r\n private get stateMachine() {\r\n return this.getCachedSingleton<HostStateMachine>(HostStateMachine.type);\r\n }\r\n\r\n private get editStateEntity() {\r\n return this.getCachedSingleton<HostEditingStateEntity>(\r\n HostEditingStateEntity.type\r\n );\r\n }\r\n\r\n private get dispatchStart() {\r\n return this.getCachedLocalComponent<DispatchStartAppUC>(\r\n DispatchStartAppUC.type\r\n );\r\n }\r\n\r\n private get dispatchSetState() {\r\n return this.getCachedLocalComponent<DispatchSetStateUC>(\r\n DispatchSetStateUC.type\r\n );\r\n }\r\n\r\n private get dispatchSetIsAuthoring() {\r\n return this.getCachedLocalComponent<DispatchIsAuthoringUC>(\r\n DispatchIsAuthoringUC.type\r\n );\r\n }\r\n\r\n private get dispatchThemeColors() {\r\n return this.getCachedLocalComponent<DispatchThemeUC>(DispatchThemeUC.type);\r\n }\r\n\r\n private get dispatchEnableFeature() {\r\n return this.getCachedLocalComponent<DispatchEnableFeatureUC>(\r\n DispatchEnableFeatureUC.type\r\n );\r\n }\r\n\r\n private get sandbox() {\r\n return this.getCachedSingleton<AppSandboxEntity>(AppSandboxEntity.type);\r\n }\r\n\r\n start = (container: HTMLElement) => {\r\n if (!this.stateMachine) return;\r\n if (!this.dispatchStart) return;\r\n if (!this.editStateEntity) return;\r\n if (!this.sandbox) return;\r\n\r\n this.dispatchStart.doDispatch(container);\r\n\r\n let state;\r\n if (this.stateMachine.activeState) {\r\n state = this.stateMachine.getStateByID(this.stateMachine.activeState)\r\n ?.stateData;\r\n }\r\n\r\n const hideNavigation = this.stateMachine.states.length <= 1;\r\n const hasNextSlide = this.stateMachine.nextState !== undefined;\r\n const hasPreviousSlide = this.stateMachine.previousState !== undefined;\r\n const dto: DispatchStateDTO = {\r\n finalState: state,\r\n hideNavigation,\r\n hasNextSlide,\r\n hasPreviousSlide\r\n };\r\n this.dispatchSetState?.doDispatch(dto);\r\n\r\n let isAuthoring = this.editStateEntity.isEditing;\r\n if (this.stateMachine.activeState === undefined) {\r\n isAuthoring = true;\r\n }\r\n this.dispatchSetIsAuthoring?.doDispatch(isAuthoring);\r\n\r\n this.dispatchThemeColors?.doDispatch();\r\n\r\n if (this.sandbox.enableDevFeatures) {\r\n this.sandbox.devFeatures.forEach((feature) => {\r\n this.dispatchEnableFeature?.doDispatch(feature);\r\n });\r\n }\r\n };\r\n\r\n constructor(appObject: AppObject) {\r\n super(appObject, StartAppUC.type);\r\n }\r\n}\r\n"]}

package/dist/cjs/Apps/UCs/StopAppUC.js CHANGED Viewed

@@ -4,7 +4,21 @@ exports.StopAppUC = void 0;
 exports.makeStopAppUC = makeStopAppUC;
 const core_1 = require("@vived/core");
 const Dispatcher_1 = require("../../Dispatcher");
+/**
+ * Use Case for stopping an application.
+ *
+ * This class provides functionality to stop a running app through the dispatcher
+ * system. It acts as a bridge between controllers and the dispatch mechanism.
+ *
+ * @extends AppObjectUC from @vived/core
+ */
 class StopAppUC extends core_1.AppObjectUC {
+    /**
+     * Retrieves the StopAppUC component from a specific App Object.
+     *
+     * @param appObject - The App Object to get the component from
+     * @returns The StopAppUC component or undefined if not found
+     */
     static get(appObject) {
         const asset = appObject.getComponent(StopAppUC.type);
         if (!asset) {
@@ -12,6 +26,13 @@ class StopAppUC extends core_1.AppObjectUC {
         }
         return asset;
     }
+    /**
+     * Retrieves the StopAppUC component by App Object ID.
+     *
+     * @param id - The ID of the App Object
+     * @param appObjects - The App Object repository
+     * @returns The StopAppUC component or undefined if not found
+     */
     static getByID(id, appObjects) {
         const appObject = appObjects.get(id);
         if (!appObject) {
@@ -20,22 +41,48 @@ class StopAppUC extends core_1.AppObjectUC {
         }
         return StopAppUC.get(appObject);
     }
+    /**
+     * Convenience method to stop an app by its ID.
+     *
+     * @param id - The ID of the app to stop
+     * @param appObjects - The App Object repository
+     */
     static stopByID(id, appObjects) {
         StopAppUC.getByID(id, appObjects)?.stop();
     }
 }
 exports.StopAppUC = StopAppUC;
 StopAppUC.type = "StopAppUC";
+/**
+ * Factory function to create a new StopAppUC instance.
+ *
+ * @param appObject - The App Object to attach the component to
+ * @returns A new StopAppUC instance
+ */
 function makeStopAppUC(appObject) {
     return new StartAppUCImp(appObject);
 }
+/**
+ * Concrete implementation of the StopAppUC abstract class.
+ */
 class StartAppUCImp extends StopAppUC {
+    /**
+     * Gets the dispatch component that sends the stop command to the app.
+     */
     get dispatchStop() {
         return this.getCachedLocalComponent(Dispatcher_1.DispatchStopAppUC.type);
     }
+    /**
+     * Stops the app by triggering the dispatch mechanism.
+     */
     stop() {
         this.dispatchStop?.doDispatch();
     }
+    /**
+     * Creates a new instance of the StopAppUC implementation.
+     *
+     * @param appObject - The App Object to attach to
+     */
     constructor(appObject) {
         super(appObject, StopAppUC.type);
     }

package/dist/cjs/Apps/UCs/StopAppUC.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"StopAppUC.js","sourceRoot":"","sources":["../../../../src/Apps/UCs/StopAppUC.ts"],"names":[],"mappings":";;;~~AAsCA~~,sCAEC;~~AAxCD~~,sCAAoE;AACpE,iDAAqD;AAErD,MAAsB,SAAU,SAAQ,kBAAW;~~IAKjD~~,MAAM,CAAC,GAAG,CAAC,SAAoB;QAC7B,MAAM,KAAK,GAAG,SAAS,CAAC,YAAY,CAAY,SAAS,CAAC,IAAI,CAAC,CAAC;QAChE,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,SAAS,CAAC,aAAa,CAAC,aAAa,CACnC,eAAe,EACf,0CAA0C,GAAG,SAAS,CAAC,EAAE,CAC1D,CAAC;QACJ,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,CAAC,OAAO,CAAC,EAAU,EAAE,UAAyB;QAClD,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAErC,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,UAAU,CAAC,aAAa,CACtB,mBAAmB,EACnB,kCAAkC,GAAG,EAAE,CACxC,CAAC;YACF,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAClC,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,EAAU,EAAE,UAAyB;QACnD,SAAS,CAAC,OAAO,CAAC,EAAE,EAAE,UAAU,CAAC,EAAE,IAAI,EAAE,CAAC;IAC5C,CAAC;;~~AAhCH~~,~~8BAiCC~~;~~AAhCQ~~,cAAI,GAAG,WAAW,CAAC;~~AAkC5B~~,SAAgB,aAAa,CAAC,SAAoB;IAChD,OAAO,IAAI,aAAa,CAAC,SAAS,CAAC,CAAC;AACtC,CAAC;AAED,MAAM,aAAc,SAAQ,SAAS;IACnC,IAAY,YAAY;QACtB,OAAO,IAAI,CAAC,uBAAuB,CACjC,8BAAiB,CAAC,IAAI,CACvB,CAAC;IACJ,CAAC;IAED,IAAI;QACF,IAAI,CAAC,YAAY,EAAE,UAAU,EAAE,CAAC;IAClC,CAAC;IAED,YAAY,SAAoB;QAC9B,KAAK,CAAC,SAAS,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;CACF","sourcesContent":["import { AppObject, AppObjectRepo, AppObjectUC } from \"@vived/core\";\r\nimport { DispatchStopAppUC } from \"../../Dispatcher\";\r\n\r\nexport abstract class StopAppUC extends AppObjectUC {\r\n static type = \"StopAppUC\";\r\n\r\n abstract stop(): void;\r\n\r\n static get(appObject: AppObject): StopAppUC \| undefined {\r\n const asset = appObject.getComponent<StopAppUC>(StopAppUC.type);\r\n if (!asset) {\r\n appObject.appObjectRepo.submitWarning(\r\n \"StopAppUC.get\",\r\n \"Unable to find StartAppUC on app object \" + appObject.id\r\n );\r\n }\r\n return asset;\r\n }\r\n\r\n static getByID(id: string, appObjects: AppObjectRepo): StopAppUC \| undefined {\r\n const appObject = appObjects.get(id);\r\n\r\n if (!appObject) {\r\n appObjects.submitWarning(\r\n \"StopAppUC.getByID\",\r\n \"Unable to find App Object by id \" + id\r\n );\r\n return undefined;\r\n }\r\n\r\n return StopAppUC.get(appObject);\r\n }\r\n\r\n static stopByID(id: string, appObjects: AppObjectRepo) {\r\n StopAppUC.getByID(id, appObjects)?.stop();\r\n }\r\n}\r\n\r\nexport function makeStopAppUC(appObject: AppObject): StopAppUC {\r\n return new StartAppUCImp(appObject);\r\n}\r\n\r\nclass StartAppUCImp extends StopAppUC {\r\n private get dispatchStop() {\r\n return this.getCachedLocalComponent<DispatchStopAppUC>(\r\n DispatchStopAppUC.type\r\n );\r\n }\r\n\r\n stop(): void {\r\n this.dispatchStop?.doDispatch();\r\n }\r\n\r\n constructor(appObject: AppObject) {\r\n super(appObject, StopAppUC.type);\r\n }\r\n}\r\n"]}
1	+ {"version":3,"file":"StopAppUC.js","sourceRoot":"","sources":["../../../../src/Apps/UCs/StopAppUC.ts"],"names":[],"mappings":";;;AA0EA,sCAEC;AA5ED,sCAAoE;AACpE,iDAAqD;AAErD;;;;;;;GAOG;AACH,MAAsB,SAAU,SAAQ,kBAAW;IAQjD;;;;;OAKG;IACH,MAAM,CAAC,GAAG,CAAC,SAAoB;QAC7B,MAAM,KAAK,GAAG,SAAS,CAAC,YAAY,CAAY,SAAS,CAAC,IAAI,CAAC,CAAC;QAChE,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,SAAS,CAAC,aAAa,CAAC,aAAa,CACnC,eAAe,EACf,0CAA0C,GAAG,SAAS,CAAC,EAAE,CAC1D,CAAC;QACJ,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,OAAO,CAAC,EAAU,EAAE,UAAyB;QAClD,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAErC,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,UAAU,CAAC,aAAa,CACtB,mBAAmB,EACnB,kCAAkC,GAAG,EAAE,CACxC,CAAC;YACF,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAClC,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAC,EAAU,EAAE,UAAyB;QACnD,SAAS,CAAC,OAAO,CAAC,EAAE,EAAE,UAAU,CAAC,EAAE,IAAI,EAAE,CAAC;IAC5C,CAAC;;AAtDH,8BAuDC;AAtDQ,cAAI,GAAG,WAAW,CAAC;AAwD5B;;;;;GAKG;AACH,SAAgB,aAAa,CAAC,SAAoB;IAChD,OAAO,IAAI,aAAa,CAAC,SAAS,CAAC,CAAC;AACtC,CAAC;AAED;;GAEG;AACH,MAAM,aAAc,SAAQ,SAAS;IACnC;;OAEG;IACH,IAAY,YAAY;QACtB,OAAO,IAAI,CAAC,uBAAuB,CACjC,8BAAiB,CAAC,IAAI,CACvB,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,IAAI;QACF,IAAI,CAAC,YAAY,EAAE,UAAU,EAAE,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACH,YAAY,SAAoB;QAC9B,KAAK,CAAC,SAAS,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;CACF","sourcesContent":["import { AppObject, AppObjectRepo, AppObjectUC } from \"@vived/core\";\r\nimport { DispatchStopAppUC } from \"../../Dispatcher\";\r\n\r\n/*\r\n Use Case for stopping an application.\r\n \r\n This class provides functionality to stop a running app through the dispatcher\r\n * system. It acts as a bridge between controllers and the dispatch mechanism.\r\n \r\n @extends AppObjectUC from @vived/core\r\n /\r\nexport abstract class StopAppUC extends AppObjectUC {\r\n static type = \"StopAppUC\";\r\n\r\n /\r\n Stops the application associated with this Use Case.\r\n /\r\n abstract stop(): void;\r\n\r\n /\r\n Retrieves the StopAppUC component from a specific App Object.\r\n \r\n @param appObject - The App Object to get the component from\r\n * @returns The StopAppUC component or undefined if not found\r\n /\r\n static get(appObject: AppObject): StopAppUC \| undefined {\r\n const asset = appObject.getComponent<StopAppUC>(StopAppUC.type);\r\n if (!asset) {\r\n appObject.appObjectRepo.submitWarning(\r\n \"StopAppUC.get\",\r\n \"Unable to find StartAppUC on app object \" + appObject.id\r\n );\r\n }\r\n return asset;\r\n }\r\n\r\n /\r\n Retrieves the StopAppUC component by App Object ID.\r\n \r\n @param id - The ID of the App Object\r\n * @param appObjects - The App Object repository\r\n * @returns The StopAppUC component or undefined if not found\r\n /\r\n static getByID(id: string, appObjects: AppObjectRepo): StopAppUC \| undefined {\r\n const appObject = appObjects.get(id);\r\n\r\n if (!appObject) {\r\n appObjects.submitWarning(\r\n \"StopAppUC.getByID\",\r\n \"Unable to find App Object by id \" + id\r\n );\r\n return undefined;\r\n }\r\n\r\n return StopAppUC.get(appObject);\r\n }\r\n\r\n /\r\n Convenience method to stop an app by its ID.\r\n \r\n @param id - The ID of the app to stop\r\n * @param appObjects - The App Object repository\r\n /\r\n static stopByID(id: string, appObjects: AppObjectRepo) {\r\n StopAppUC.getByID(id, appObjects)?.stop();\r\n }\r\n}\r\n\r\n/\r\n Factory function to create a new StopAppUC instance.\r\n \r\n @param appObject - The App Object to attach the component to\r\n * @returns A new StopAppUC instance\r\n /\r\nexport function makeStopAppUC(appObject: AppObject): StopAppUC {\r\n return new StartAppUCImp(appObject);\r\n}\r\n\r\n/\r\n Concrete implementation of the StopAppUC abstract class.\r\n /\r\nclass StartAppUCImp extends StopAppUC {\r\n /\r\n Gets the dispatch component that sends the stop command to the app.\r\n /\r\n private get dispatchStop() {\r\n return this.getCachedLocalComponent<DispatchStopAppUC>(\r\n DispatchStopAppUC.type\r\n );\r\n }\r\n\r\n /\r\n Stops the app by triggering the dispatch mechanism.\r\n /\r\n stop(): void {\r\n this.dispatchStop?.doDispatch();\r\n }\r\n\r\n /\r\n Creates a new instance of the StopAppUC implementation.\r\n \r\n @param appObject - The App Object to attach to\r\n */\r\n constructor(appObject: AppObject) {\r\n super(appObject, StopAppUC.type);\r\n }\r\n}\r\n"]}

package/dist/cjs/Apps/UCs/formAppIDWithVersion.js CHANGED Viewed

@@ -1,6 +1,24 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.formAppIDWithVersion = formAppIDWithVersion;
+/**
+ * Creates a versioned ID for an app by combining the app ID with its version.
+ *
+ * This utility function forms a unique identifier that includes both the app ID
+ * and version information. This is used to identify specific versions of apps,
+ * particularly when loading scripts into the DOM or accessing app interfaces from
+ * the window object.
+ *
+ * The version is formatted by replacing periods with underscores to create a
+ * valid JavaScript identifier (e.g., "1.2.3" becomes "1_2_3").
+ *
+ * @param app - The app entity
+ * @param version - The version to include in the ID
+ * @returns A string in the format "{appId}-{version_with_underscores}"
+ * @example
+ * // Returns "myApp-1_2_3" for app.id="myApp" and version="1.2.3"
+ * formAppIDWithVersion(app, version)
+ */
 function formAppIDWithVersion(app, version) {
     const versionString = version.baseVersionString.split(".").join("_");
     return `${app.id}-${versionString}`;

package/dist/cjs/Apps/UCs/formAppIDWithVersion.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"formAppIDWithVersion.js","sourceRoot":"","sources":["../../../../src/Apps/UCs/formAppIDWithVersion.ts"],"names":[],"mappings":";;~~AAGA~~,oDAGC;~~AAHD~~,SAAgB,oBAAoB,CAAC,GAAc,EAAE,OAAgB;IACnE,MAAM,aAAa,GAAG,OAAO,CAAC,iBAAiB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACrE,OAAO,GAAG,GAAG,CAAC,EAAE,IAAI,aAAa,EAAE,CAAC;AACtC,CAAC","sourcesContent":["import { Version } from \"@vived/core\";\r\nimport { AppEntity } from \"../Entities\";\r\n\r\nexport function formAppIDWithVersion(app: AppEntity, version: Version) {\r\n const versionString = version.baseVersionString.split(\".\").join(\"_\");\r\n return `${app.id}-${versionString}`;\r\n}\r\n"]}
1	+ {"version":3,"file":"formAppIDWithVersion.js","sourceRoot":"","sources":["../../../../src/Apps/UCs/formAppIDWithVersion.ts"],"names":[],"mappings":";;AAqBA,oDAGC;AArBD;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,oBAAoB,CAAC,GAAc,EAAE,OAAgB;IACnE,MAAM,aAAa,GAAG,OAAO,CAAC,iBAAiB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACrE,OAAO,GAAG,GAAG,CAAC,EAAE,IAAI,aAAa,EAAE,CAAC;AACtC,CAAC","sourcesContent":["import { Version } from \"@vived/core\";\r\nimport { AppEntity } from \"../Entities\";\r\n\r\n/*\r\n Creates a versioned ID for an app by combining the app ID with its version.\r\n \r\n This utility function forms a unique identifier that includes both the app ID\r\n * and version information. This is used to identify specific versions of apps,\r\n * particularly when loading scripts into the DOM or accessing app interfaces from\r\n * the window object.\r\n \r\n The version is formatted by replacing periods with underscores to create a\r\n * valid JavaScript identifier (e.g., \"1.2.3\" becomes \"1_2_3\").\r\n \r\n @param app - The app entity\r\n * @param version - The version to include in the ID\r\n * @returns A string in the format \"{appId}-{version_with_underscores}\"\r\n * @example\r\n * // Returns \"myApp-1_2_3\" for app.id=\"myApp\" and version=\"1.2.3\"\r\n * formAppIDWithVersion(app, version)\r\n */\r\nexport function formAppIDWithVersion(app: AppEntity, version: Version) {\r\n const versionString = version.baseVersionString.split(\".\").join(\"_\");\r\n return `${app.id}-${versionString}`;\r\n}\r\n"]}

package/dist/cjs/Apps/index.js CHANGED Viewed

@@ -1,4 +1,23 @@
 "use strict";
+/**
+ * Apps Module - Core module for managing application lifecycle in the VIVED Learning platform
+ *
+ * This module handles app loading, mounting, starting, stopping, and state management.
+ * It follows a clean architecture pattern with the following layers:
+ *
+ * - Entities: Core domain models (AppEntity, AppRepo)
+ * - PMs (Presentation Models): Business logic and state management
+ * - UCs (Use Cases): Implementation of specific operations
+ * - Adapters: Connect PMs to UI components
+ * - Controllers: Entry points for UI interactions
+ *
+ * To use this module, typically you would:
+ * 1. Load an app using the AppEntity
+ * 2. Mount the app using MounterUC
+ * 3. Start the app using StartAppUC
+ * 4. Manage app state via the AppPM or ActiveAppPM
+ * 5. Stop the app using StopAppUC when done
+ */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);

package/dist/cjs/Apps/index.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Apps/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;~~AAAA~~,6CAA2B;AAC3B,gDAA8B;AAC9B,6CAA2B;AAC3B,0CAAwB;AACxB,wCAAsB;AACtB,wCAAsB","sourcesContent":["~~export~~ * from \"./Adapters\";\r\nexport * from \"./Controllers\";\r\nexport * from \"./Entities\";\r\nexport * from \"./Mocks\";\r\nexport * from \"./PMs\";\r\nexport * from \"./UCs\";\r\n"]}
1	+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Apps/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;GAkBG;;;;;;;;;;;;;;;;AAEH,6CAA2B;AAC3B,gDAA8B;AAC9B,6CAA2B;AAC3B,0CAAwB;AACxB,wCAAsB;AACtB,wCAAsB","sourcesContent":["/*\r\n Apps Module - Core module for managing application lifecycle in the VIVED Learning platform\r\n * \r\n * This module handles app loading, mounting, starting, stopping, and state management.\r\n * It follows a clean architecture pattern with the following layers:\r\n * \r\n * - Entities: Core domain models (AppEntity, AppRepo)\r\n * - PMs (Presentation Models): Business logic and state management\r\n * - UCs (Use Cases): Implementation of specific operations\r\n * - Adapters: Connect PMs to UI components\r\n * - Controllers: Entry points for UI interactions\r\n * \r\n * To use this module, typically you would:\r\n * 1. Load an app using the AppEntity\r\n * 2. Mount the app using MounterUC\r\n * 3. Start the app using StartAppUC\r\n * 4. Manage app state via the AppPM or ActiveAppPM\r\n * 5. Stop the app using StopAppUC when done\r\n /\r\n\r\nexport from \"./Adapters\";\r\nexport * from \"./Controllers\";\r\nexport * from \"./Entities\";\r\nexport * from \"./Mocks\";\r\nexport * from \"./PMs\";\r\nexport * from \"./UCs\";\r\n"]}

package/dist/cjs/Snackbar/Adapters/snackbarAdapter.js CHANGED Viewed

@@ -2,8 +2,20 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.snackbarAdapter = void 0;
 const SnackbarPM_1 = require("../PMs/SnackbarPM");
+/**
+ * Adapter for connecting UI components to the Snackbar system
+ * Follows the SingletonPmAdapter pattern for reactive state management
+ */
 exports.snackbarAdapter = {
+    /**
+     * Default view model used when no snackbar is active
+     */
     defaultVM: SnackbarPM_1.defaultSnackbarVM,
+    /**
+     * Subscribes a UI component to snackbar state changes
+     * @param appObjects The application object repository
+     * @param setVM Callback function to update the UI with the new view model
+     */
     subscribe: (appObjects, setVM) => {
         const pm = SnackbarPM_1.SnackbarPM.get(appObjects);
         if (!pm) {
@@ -12,6 +24,11 @@ exports.snackbarAdapter = {
         }
         pm.addView(setVM);
     },
+    /**
+     * Unsubscribes a UI component from snackbar state changes
+     * @param appObjects The application object repository
+     * @param setVM The same callback function used when subscribing
+     */
     unsubscribe: (appObjects, setVM) => {
         const pm = SnackbarPM_1.SnackbarPM.get(appObjects);
         if (!pm) {

package/dist/cjs/Snackbar/Adapters/snackbarAdapter.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"snackbarAdapter.js","sourceRoot":"","sources":["../../../../src/Snackbar/Adapters/snackbarAdapter.ts"],"names":[],"mappings":";;;AACA,kDAA8E;~~AAEjE~~,QAAA,eAAe,GAAmC;IAC7D,SAAS,EAAE,8BAAiB;~~IAC5B~~,SAAS,EAAE,CAAC,UAAyB,EAAE,KAA+B,~~EAAE~~,EAAE;~~QACxE~~,MAAM,EAAE,GAAG,uBAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACtC,IAAI,CAAC,EAAE,EAAE,CAAC;YACR,UAAU,CAAC,WAAW,CAAC,iBAAiB,EAAE,2BAA2B,CAAC,CAAC;YACvE,OAAO;QACT,CAAC;QACD,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;~~IACD~~,WAAW,EAAE,CAAC,UAAyB,EAAE,KAA+B,~~EAAE~~,EAAE;~~QAC1E~~,MAAM,EAAE,GAAG,uBAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACtC,IAAI,CAAC,EAAE,EAAE,CAAC;YACR,UAAU,CAAC,WAAW,CAAC,iBAAiB,EAAE,2BAA2B,CAAC,CAAC;YACvE,OAAO;QACT,CAAC;QACD,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC;CACF,CAAC","sourcesContent":["import { AppObjectRepo, SingletonPmAdapter } from \"@vived/core\";\r\nimport { SnackbarPM, SnackbarVM, defaultSnackbarVM } from \"../PMs/SnackbarPM\";\r\n\r\nexport const snackbarAdapter: SingletonPmAdapter<SnackbarVM> = {\r\n defaultVM: defaultSnackbarVM,\r\n subscribe: (appObjects: AppObjectRepo, setVM: (vm: SnackbarVM) => void) => {\r\n const pm = SnackbarPM.get(appObjects);\r\n if (!pm) {\r\n appObjects.submitError(\"snackbarAdapter\", \"Unable to find SnackbarPM\");\r\n return;\r\n }\r\n pm.addView(setVM);\r\n },\r\n unsubscribe: (appObjects: AppObjectRepo, setVM: (vm: SnackbarVM) => void) => {\r\n const pm = SnackbarPM.get(appObjects);\r\n if (!pm) {\r\n appObjects.submitError(\"snackbarAdapter\", \"Unable to find SnackbarPM\");\r\n return;\r\n }\r\n pm.removeView(setVM);\r\n }\r\n};\r\n"]}
1	+ {"version":3,"file":"snackbarAdapter.js","sourceRoot":"","sources":["../../../../src/Snackbar/Adapters/snackbarAdapter.ts"],"names":[],"mappings":";;;AACA,kDAA8E;AAE9E;;;GAGG;AACU,QAAA,eAAe,GAAmC;IAC7D;;OAEG;IACH,SAAS,EAAE,8BAAiB;IAE5B;;;;OAIG;IACH,SAAS,EAAE,CAAC,UAAyB,EAAE,KAA+B,EAAQ,EAAE;QAC9E,MAAM,EAAE,GAAG,uBAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACtC,IAAI,CAAC,EAAE,EAAE,CAAC;YACR,UAAU,CAAC,WAAW,CAAC,iBAAiB,EAAE,2BAA2B,CAAC,CAAC;YACvE,OAAO;QACT,CAAC;QACD,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,WAAW,EAAE,CAAC,UAAyB,EAAE,KAA+B,EAAQ,EAAE;QAChF,MAAM,EAAE,GAAG,uBAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACtC,IAAI,CAAC,EAAE,EAAE,CAAC;YACR,UAAU,CAAC,WAAW,CAAC,iBAAiB,EAAE,2BAA2B,CAAC,CAAC;YACvE,OAAO;QACT,CAAC;QACD,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC;CACF,CAAC","sourcesContent":["import { AppObjectRepo, SingletonPmAdapter } from \"@vived/core\";\r\nimport { SnackbarPM, SnackbarVM, defaultSnackbarVM } from \"../PMs/SnackbarPM\";\r\n\r\n/*\r\n Adapter for connecting UI components to the Snackbar system\r\n * Follows the SingletonPmAdapter pattern for reactive state management\r\n /\r\nexport const snackbarAdapter: SingletonPmAdapter<SnackbarVM> = {\r\n /\r\n Default view model used when no snackbar is active\r\n /\r\n defaultVM: defaultSnackbarVM,\r\n \r\n /\r\n Subscribes a UI component to snackbar state changes\r\n * @param appObjects The application object repository\r\n * @param setVM Callback function to update the UI with the new view model\r\n /\r\n subscribe: (appObjects: AppObjectRepo, setVM: (vm: SnackbarVM) => void): void => {\r\n const pm = SnackbarPM.get(appObjects);\r\n if (!pm) {\r\n appObjects.submitError(\"snackbarAdapter\", \"Unable to find SnackbarPM\");\r\n return;\r\n }\r\n pm.addView(setVM);\r\n },\r\n \r\n /\r\n Unsubscribes a UI component from snackbar state changes\r\n * @param appObjects The application object repository\r\n * @param setVM The same callback function used when subscribing\r\n */\r\n unsubscribe: (appObjects: AppObjectRepo, setVM: (vm: SnackbarVM) => void): void => {\r\n const pm = SnackbarPM.get(appObjects);\r\n if (!pm) {\r\n appObjects.submitError(\"snackbarAdapter\", \"Unable to find SnackbarPM\");\r\n return;\r\n }\r\n pm.removeView(setVM);\r\n }\r\n};\r\n"]}

package/dist/cjs/Snackbar/Controllers/callActiveSnackbarAction.js CHANGED Viewed

@@ -2,6 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.callActiveSnackbarAction = callActiveSnackbarAction;
 const SnackbarRepo_1 = require("../Entities/SnackbarRepo");
+/**
+ * Executes the action of the currently active snackbar, if it has one
+ * Also dismisses the snackbar after executing the action
+ *
+ * @param appObjects The application object repository
+ */
 function callActiveSnackbarAction(appObjects) {
     const repo = SnackbarRepo_1.SnackbarRepo.get(appObjects);
     if (repo) {

package/dist/cjs/Snackbar/Controllers/callActiveSnackbarAction.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"callActiveSnackbarAction.js","sourceRoot":"","sources":["../../../../src/Snackbar/Controllers/callActiveSnackbarAction.ts"],"names":[],"mappings":";;~~AAGA~~,4DAUC;~~AAZD~~,2DAAwD;AAExD,SAAgB,wBAAwB,CAAC,UAAyB;IAChE,MAAM,IAAI,GAAG,2BAAY,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAC1C,IAAI,IAAI,EAAE,CAAC;QACT,IAAI,CAAC,wBAAwB,EAAE,CAAC;IAClC,CAAC;SAAM,CAAC;QACN,UAAU,CAAC,WAAW,CACpB,0BAA0B,EAC1B,6BAA6B,CAC9B,CAAC;IACJ,CAAC;AACH,CAAC","sourcesContent":["import { AppObjectRepo } from \"@vived/core\";\r\nimport { SnackbarRepo } from \"../Entities/SnackbarRepo\";\r\n\r\nexport function callActiveSnackbarAction(appObjects: AppObjectRepo) {\r\n const repo = SnackbarRepo.get(appObjects);\r\n if (repo) {\r\n repo.callActiveSnackbarAction();\r\n } else {\r\n appObjects.submitError(\r\n \"callActiveSnackbarAction\",\r\n \"Unable to find SnackbarRepo\"\r\n );\r\n }\r\n}\r\n"]}
1	+ {"version":3,"file":"callActiveSnackbarAction.js","sourceRoot":"","sources":["../../../../src/Snackbar/Controllers/callActiveSnackbarAction.ts"],"names":[],"mappings":";;AASA,4DAUC;AAlBD,2DAAwD;AAExD;;;;;GAKG;AACH,SAAgB,wBAAwB,CAAC,UAAyB;IAChE,MAAM,IAAI,GAAG,2BAAY,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAC1C,IAAI,IAAI,EAAE,CAAC;QACT,IAAI,CAAC,wBAAwB,EAAE,CAAC;IAClC,CAAC;SAAM,CAAC;QACN,UAAU,CAAC,WAAW,CACpB,0BAA0B,EAC1B,6BAA6B,CAC9B,CAAC;IACJ,CAAC;AACH,CAAC","sourcesContent":["import { AppObjectRepo } from \"@vived/core\";\r\nimport { SnackbarRepo } from \"../Entities/SnackbarRepo\";\r\n\r\n/*\r\n Executes the action of the currently active snackbar, if it has one\r\n * Also dismisses the snackbar after executing the action\r\n * \r\n * @param appObjects The application object repository\r\n */\r\nexport function callActiveSnackbarAction(appObjects: AppObjectRepo): void {\r\n const repo = SnackbarRepo.get(appObjects);\r\n if (repo) {\r\n repo.callActiveSnackbarAction();\r\n } else {\r\n appObjects.submitError(\r\n \"callActiveSnackbarAction\",\r\n \"Unable to find SnackbarRepo\"\r\n );\r\n }\r\n}\r\n"]}

package/dist/cjs/Snackbar/Controllers/dismissActiveSnackbar.js CHANGED Viewed

@@ -2,6 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.dismissActiveSnackbar = dismissActiveSnackbar;
 const SnackbarRepo_1 = require("../Entities/SnackbarRepo");
+/**
+ * Dismisses the currently active snackbar, if any exists
+ *
+ * @param appObjects The application object repository
+ */
 function dismissActiveSnackbar(appObjects) {
     const repo = SnackbarRepo_1.SnackbarRepo.get(appObjects);
     if (repo) {

package/dist/cjs/Snackbar/Controllers/dismissActiveSnackbar.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"dismissActiveSnackbar.js","sourceRoot":"","sources":["../../../../src/Snackbar/Controllers/dismissActiveSnackbar.ts"],"names":[],"mappings":";;~~AAGA~~,sDAUC;~~AAZD~~,2DAAwD;AAExD,SAAgB,qBAAqB,CAAC,UAAyB;IAC7D,MAAM,IAAI,GAAG,2BAAY,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAC1C,IAAI,IAAI,EAAE,CAAC;QACT,IAAI,CAAC,qBAAqB,EAAE,CAAC;IAC/B,CAAC;SAAM,CAAC;QACN,UAAU,CAAC,WAAW,CACpB,uBAAuB,EACvB,6BAA6B,CAC9B,CAAC;IACJ,CAAC;AACH,CAAC","sourcesContent":["import { AppObjectRepo } from \"@vived/core\";\r\nimport { SnackbarRepo } from \"../Entities/SnackbarRepo\";\r\n\r\nexport function dismissActiveSnackbar(appObjects: AppObjectRepo) {\r\n const repo = SnackbarRepo.get(appObjects);\r\n if (repo) {\r\n repo.dismissActiveSnackbar();\r\n } else {\r\n appObjects.submitError(\r\n \"dismissActiveSnackbar\",\r\n \"Unable to find SnackbarRepo\"\r\n );\r\n }\r\n}\r\n"]}
1	+ {"version":3,"file":"dismissActiveSnackbar.js","sourceRoot":"","sources":["../../../../src/Snackbar/Controllers/dismissActiveSnackbar.ts"],"names":[],"mappings":";;AAQA,sDAUC;AAjBD,2DAAwD;AAExD;;;;GAIG;AACH,SAAgB,qBAAqB,CAAC,UAAyB;IAC7D,MAAM,IAAI,GAAG,2BAAY,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAC1C,IAAI,IAAI,EAAE,CAAC;QACT,IAAI,CAAC,qBAAqB,EAAE,CAAC;IAC/B,CAAC;SAAM,CAAC;QACN,UAAU,CAAC,WAAW,CACpB,uBAAuB,EACvB,6BAA6B,CAC9B,CAAC;IACJ,CAAC;AACH,CAAC","sourcesContent":["import { AppObjectRepo } from \"@vived/core\";\r\nimport { SnackbarRepo } from \"../Entities/SnackbarRepo\";\r\n\r\n/*\r\n Dismisses the currently active snackbar, if any exists\r\n * \r\n * @param appObjects The application object repository\r\n */\r\nexport function dismissActiveSnackbar(appObjects: AppObjectRepo): void {\r\n const repo = SnackbarRepo.get(appObjects);\r\n if (repo) {\r\n repo.dismissActiveSnackbar();\r\n } else {\r\n appObjects.submitError(\r\n \"dismissActiveSnackbar\",\r\n \"Unable to find SnackbarRepo\"\r\n );\r\n }\r\n}\r\n"]}

package/dist/cjs/Snackbar/Controllers/index.js CHANGED Viewed

@@ -16,4 +16,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./callActiveSnackbarAction"), exports);
 __exportStar(require("./dismissActiveSnackbar"), exports);
+__exportStar(require("./makeSnackbar"), exports);
 //# sourceMappingURL=index.js.map

package/dist/cjs/Snackbar/Controllers/index.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/Snackbar/Controllers/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6DAA2C;AAC3C,0DAAwC","sourcesContent":["export * from \"./callActiveSnackbarAction\";\r\nexport * from \"./dismissActiveSnackbar\";\r\n"]}
1	+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/Snackbar/Controllers/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6DAA2C;AAC3C,0DAAwC;AACxC,iDAA+B","sourcesContent":["export * from \"./callActiveSnackbarAction\";\r\nexport * from \"./dismissActiveSnackbar\";\r\nexport * from \"./makeSnackbar\";\r\n"]}

package/dist/cjs/Snackbar/Controllers/makeSnackbar.js ADDED Viewed

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeSnackbar = makeSnackbar;
+const SnackbarRepo_1 = require("../Entities/SnackbarRepo");
+/**
+ * Creates and displays a new snackbar notification
+ *
+ * @param appObjects The application object repository
+ * @param message The message to display in the snackbar
+ * @param snackbarAction Optional action button configuration with text and callback
+ * @param durationInSeconds Optional duration in seconds before auto-dismissing (defaults to 4 seconds)
+ */
+function makeSnackbar(appObjects, message, snackbarAction, durationInSeconds) {
+    const repo = SnackbarRepo_1.SnackbarRepo.get(appObjects);
+    if (repo) {
+        repo.makeSnackbar(message, snackbarAction, durationInSeconds);
+    }
+    else {
+        appObjects.submitError("makeSnackbar", "Unable to find SnackbarRepo");
+    }
+}
+//# sourceMappingURL=makeSnackbar.js.map

package/dist/cjs/Snackbar/Controllers/makeSnackbar.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"makeSnackbar.js","sourceRoot":"","sources":["../../../../src/Snackbar/Controllers/makeSnackbar.ts"],"names":[],"mappings":";;AAWA,oCAYC;AAtBD,2DAAwE;AAExE;;;;;;;GAOG;AACH,SAAgB,YAAY,CAC1B,UAAyB,EACzB,OAAe,EACf,cAA+B,EAC/B,iBAA0B;IAE1B,MAAM,IAAI,GAAG,2BAAY,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAC1C,IAAI,IAAI,EAAE,CAAC;QACT,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,cAAc,EAAE,iBAAiB,CAAC,CAAC;IAChE,CAAC;SAAM,CAAC;QACN,UAAU,CAAC,WAAW,CAAC,cAAc,EAAE,6BAA6B,CAAC,CAAC;IACxE,CAAC;AACH,CAAC","sourcesContent":["import { AppObjectRepo } from \"@vived/core\";\r\nimport { SnackbarAction, SnackbarRepo } from \"../Entities/SnackbarRepo\";\r\n\r\n/**\r\n * Creates and displays a new snackbar notification\r\n * \r\n * @param appObjects The application object repository\r\n * @param message The message to display in the snackbar\r\n * @param snackbarAction Optional action button configuration with text and callback\r\n * @param durationInSeconds Optional duration in seconds before auto-dismissing (defaults to 4 seconds)\r\n */\r\nexport function makeSnackbar(\r\n appObjects: AppObjectRepo,\r\n message: string,\r\n snackbarAction?: SnackbarAction,\r\n durationInSeconds?: number\r\n): void {\r\n const repo = SnackbarRepo.get(appObjects);\r\n if (repo) {\r\n repo.makeSnackbar(message, snackbarAction, durationInSeconds);\r\n } else {\r\n appObjects.submitError(\"makeSnackbar\", \"Unable to find SnackbarRepo\");\r\n }\r\n}\r\n"]}

package/dist/cjs/Snackbar/Entities/SnackbarRepo.js CHANGED Viewed

@@ -3,66 +3,111 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SnackbarRepo = void 0;
 exports.makeSnackbarRepo = makeSnackbarRepo;
 const core_1 = require("@vived/core");
+/**
+ * Repository for managing snackbar notifications
+ * Handles creating, displaying, and dismissing snackbars
+ */
 class SnackbarRepo extends core_1.AppObjectEntity {
+    /**
+     * Gets the singleton instance of SnackbarRepo
+     * @param appObjects The application object repository
+     * @returns The SnackbarRepo instance or undefined if not found
+     */
     static get(appObjects) {
         return (0, core_1.getSingletonComponent)(SnackbarRepo.type, appObjects);
     }
 }
 exports.SnackbarRepo = SnackbarRepo;
 SnackbarRepo.type = "SnackbarRepo";
+/**
+ * Creates a new SnackbarRepo instance
+ * @param appObject The application object
+ * @returns A new SnackbarRepo instance
+ */
 function makeSnackbarRepo(appObject) {
     return new SnackbarRepoImp(appObject);
 }
+/**
+ * Implementation of SnackbarRepo
+ * Handles the queue of snackbars and their timing
+ */
 class SnackbarRepoImp extends SnackbarRepo {
+    /**
+     * Creates a new SnackbarRepoImp instance
+     * @param appObject The application object
+     * @param defaultDurationInSeconds Default duration for snackbars (default: 4 seconds)
+     */
     constructor(appObject, defaultDurationInSeconds = 4) {
         super(appObject, SnackbarRepo.type);
+        /** Flag to prevent multiple timing loops from running */
         this.monitoringSnackbarTime = false;
-        this.makeSnackbar = (message, snackbarAction, durationInSeconds) => {
-            if (message.trim().length === 0) {
-                this.warn("Snackbar must have a message");
-                return;
-            }
-            if (snackbarAction && snackbarAction.actionButtonText.trim().length === 0) {
-                this.warn("If a Snackbar has an action then the action button text cannot be empty");
-                return;
-            }
-            const duration = durationInSeconds ?? this.defaultDurationInSeconds;
-            if (duration <= 0) {
-                this.warn(`${duration} is an invalid duration for a Snackbar`);
-                return;
-            }
-            const snackbar = {
-                message,
-                durationInSeconds: duration,
-                snackbarAction
-            };
-            this.snackbarQueue.push(snackbar);
-            this.notifyOnChange();
-            this.monitorSnackbarTime();
-            return;
-        };
-        this.getCurrentSnackbar = () => {
-            return this.snackbarQueue.length > 0 ? this.snackbarQueue[0] : undefined;
-        };
-        this.dismissActiveSnackbar = () => {
-            if (this.snackbarQueue.length > 0) {
-                this.snackbarQueue.splice(0, 1);
-                this.notifyOnChange();
-            }
-        };
-        this.callActiveSnackbarAction = () => {
-            const currentSnackbar = this.getCurrentSnackbar();
-            if (currentSnackbar) {
-                if (currentSnackbar.snackbarAction) {
-                    currentSnackbar.snackbarAction.action();
-                    this.dismissActiveSnackbar();
-                }
-            }
-        };
         this.snackbarQueue = [];
         this.defaultDurationInSeconds = defaultDurationInSeconds;
         this.appObjects.registerSingleton(this);
     }
+    /**
+     * Creates and displays a new snackbar notification
+     * @param message The message to display
+     * @param snackbarAction Optional action button and callback
+     * @param durationInSeconds Optional duration in seconds before auto-dismissing
+     */
+    makeSnackbar(message, snackbarAction, durationInSeconds) {
+        if (message.trim().length === 0) {
+            this.warn("Snackbar must have a message");
+            return;
+        }
+        if (snackbarAction && snackbarAction.actionButtonText.trim().length === 0) {
+            this.warn("If a Snackbar has an action then the action button text cannot be empty");
+            return;
+        }
+        const duration = durationInSeconds ?? this.defaultDurationInSeconds;
+        if (duration <= 0) {
+            this.warn(`${duration} is an invalid duration for a Snackbar`);
+            return;
+        }
+        const snackbar = {
+            message,
+            durationInSeconds: duration,
+            snackbarAction
+        };
+        this.snackbarQueue.push(snackbar);
+        this.notifyOnChange();
+        this.monitorSnackbarTime();
+        return;
+    }
+    /**
+     * Gets the currently active snackbar, if any
+     * @returns The current snackbar or undefined if none is active
+     */
+    getCurrentSnackbar() {
+        return this.snackbarQueue.length > 0 ? this.snackbarQueue[0] : undefined;
+    }
+    /**
+     * Dismisses the currently active snackbar, if any
+     */
+    dismissActiveSnackbar() {
+        if (this.snackbarQueue.length > 0) {
+            this.snackbarQueue.splice(0, 1);
+            this.notifyOnChange();
+        }
+    }
+    /**
+     * Executes the action of the currently active snackbar, if it has one
+     * Also dismisses the snackbar after executing the action
+     */
+    callActiveSnackbarAction() {
+        const currentSnackbar = this.getCurrentSnackbar();
+        if (currentSnackbar) {
+            if (currentSnackbar.snackbarAction) {
+                currentSnackbar.snackbarAction.action();
+                this.dismissActiveSnackbar();
+            }
+        }
+    }
+    /**
+     * Monitors the timing of snackbars to auto-dismiss them when their duration expires
+     * Uses a loop that checks each snackbar's remaining time
+     */
     async monitorSnackbarTime() {
         if (this.monitoringSnackbarTime) {
             return;

package/dist/cjs/Snackbar/Entities/SnackbarRepo.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"SnackbarRepo.js","sourceRoot":"","sources":["../../../../src/Snackbar/Entities/SnackbarRepo.ts"],"names":[],"mappings":";;;AAqCA,4CAEC;AAvCD,sCAKqB;AAerB,MAAsB,YAAa,SAAQ,sBAAe;IAGxD,MAAM,CAAC,GAAG,CAAC,UAAyB;QAClC,OAAO,IAAA,4BAAqB,EAAe,YAAY,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IAC5E,CAAC;;AALH,oCAeC;AAdQ,iBAAI,GAAG,cAAc,CAAC;AAgB/B,SAAgB,gBAAgB,CAAC,SAAoB;IACnD,OAAO,IAAI,eAAe,CAAC,SAAS,CAAC,CAAC;AACxC,CAAC;AAED,MAAM,eAAgB,SAAQ,YAAY;IAKxC,YAAY,SAAoB,EAAE,2BAAmC,CAAC;QACpE,KAAK,CAAC,SAAS,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC;QAH9B,2BAAsB,GAAY,KAAK,CAAC;QAShD,iBAAY,GAAG,CACb,OAAe,EACf,cAA2C,EAC3C,iBAAsC,EAChC,EAAE;YACR,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAChC,IAAI,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;gBAC1C,OAAO;YACT,CAAC;YAED,IAAI,cAAc,IAAI,cAAc,CAAC,gBAAgB,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC1E,IAAI,CAAC,IAAI,CACP,yEAAyE,CAC1E,CAAC;gBACF,OAAO;YACT,CAAC;YAED,MAAM,QAAQ,GAAG,iBAAiB,IAAI,IAAI,CAAC,wBAAwB,CAAC;YACpE,IAAI,QAAQ,IAAI,CAAC,EAAE,CAAC;gBAClB,IAAI,CAAC,IAAI,CAAC,GAAG,QAAQ,wCAAwC,CAAC,CAAC;gBAC/D,OAAO;YACT,CAAC;YAED,MAAM,QAAQ,GAAa;gBACzB,OAAO;gBACP,iBAAiB,EAAE,QAAQ;gBAC3B,cAAc;aACf,CAAC;YAEF,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAClC,IAAI,CAAC,cAAc,EAAE,CAAC;YACtB,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAE3B,OAAO;QACT,CAAC,CAAC;QAEF,uBAAkB,GAAG,GAAyB,EAAE;YAC9C,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC3E,CAAC,CAAC;QAEF,0BAAqB,GAAG,GAAG,EAAE;YAC3B,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAClC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBAChC,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,CAAC;QACH,CAAC,CAAC;QAEF,6BAAwB,GAAG,GAAG,EAAE;YAC9B,MAAM,eAAe,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAClD,IAAI,eAAe,EAAE,CAAC;gBACpB,IAAI,eAAe,CAAC,cAAc,EAAE,CAAC;oBACnC,eAAe,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC;oBACxC,IAAI,CAAC,qBAAqB,EAAE,CAAC;gBAC/B,CAAC;YACH,CAAC;QACH,CAAC,CAAC;QA5DA,IAAI,CAAC,aAAa,GAAG,EAAE,CAAC;QACxB,IAAI,CAAC,wBAAwB,GAAG,wBAAwB,CAAC;QACzD,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;IA2DO,KAAK,CAAC,mBAAmB;QAC/B,IAAI,IAAI,CAAC,sBAAsB,EAAE,CAAC;YAChC,OAAO;QACT,CAAC;QAED,MAAM,sBAAsB,GAAW,GAAG,CAAC;QAC3C,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC;QAEnC,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrC,MAAM,eAAe,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAClD,IAAI,eAAe,EAAE,CAAC;gBACpB,IAAI,cAAc,GAAG,eAAe,CAAC,iBAAiB,CAAC;gBACvD,OACE,IAAI,CAAC,kBAAkB,EAAE,KAAK,eAAe;oBAC7C,cAAc,GAAG,CAAC,EAClB,CAAC;oBACD,gDAAgD;oBAChD,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAC5B,UAAU,CAAC,OAAO,EAAE,sBAAsB,GAAG,IAAI,CAAC,CACnD,CAAC;oBACF,cAAc,IAAI,sBAAsB,CAAC;gBAC3C,CAAC;gBACD,IACE,IAAI,CAAC,kBAAkB,EAAE,KAAK,eAAe;oBAC7C,cAAc,IAAI,CAAC,EACnB,CAAC;oBACD,IAAI,CAAC,qBAAqB,EAAE,CAAC;gBAC/B,CAAC;YACH,CAAC;QACH,CAAC;QACD,IAAI,CAAC,sBAAsB,GAAG,KAAK,CAAC;IACtC,CAAC;CACF","sourcesContent":["import {\r\n AppObject,\r\n AppObjectEntity,\r\n AppObjectRepo,\r\n getSingletonComponent\r\n} from \"@vived/core\";\r\n\r\nexport interface Snackbar {\r\n message: string;\r\n durationInSeconds: number;\r\n snackbarAction?: SnackbarAction;\r\n}\r\n\r\nexport interface SnackbarAction {\r\n actionButtonText: string;\r\n action: () => void;\r\n}\r\n\r\nexport type SnackbarObserver = (snackbar: Snackbar \| undefined) => void;\r\n\r\nexport abstract class SnackbarRepo extends AppObjectEntity {\r\n static type = \"SnackbarRepo\";\r\n\r\n static get(appObjects: AppObjectRepo) {\r\n return getSingletonComponent<SnackbarRepo>(SnackbarRepo.type, appObjects);\r\n }\r\n\r\n abstract makeSnackbar(\r\n message: string,\r\n snackbarAction?: SnackbarAction,\r\n durationInSeconds?: number\r\n ): void;\r\n abstract getCurrentSnackbar(): Snackbar \| undefined;\r\n abstract dismissActiveSnackbar(): void;\r\n abstract callActiveSnackbarAction(): void;\r\n}\r\n\r\nexport function makeSnackbarRepo(appObject: AppObject): SnackbarRepo {\r\n return new SnackbarRepoImp(appObject);\r\n}\r\n\r\nclass SnackbarRepoImp extends SnackbarRepo {\r\n private snackbarQueue: Snackbar[];\r\n private defaultDurationInSeconds: number;\r\n private monitoringSnackbarTime: boolean = false;\r\n\r\n constructor(appObject: AppObject, defaultDurationInSeconds: number = 4) {\r\n super(appObject, SnackbarRepo.type);\r\n this.snackbarQueue = [];\r\n this.defaultDurationInSeconds = defaultDurationInSeconds;\r\n this.appObjects.registerSingleton(this);\r\n }\r\n\r\n makeSnackbar = (\r\n message: string,\r\n snackbarAction?: SnackbarAction \| undefined,\r\n durationInSeconds?: number \| undefined\r\n ): void => {\r\n if (message.trim().length === 0) {\r\n this.warn(\"Snackbar must have a message\");\r\n return;\r\n }\r\n\r\n if (snackbarAction && snackbarAction.actionButtonText.trim().length === 0) {\r\n this.warn(\r\n \"If a Snackbar has an action then the action button text cannot be empty\"\r\n );\r\n return;\r\n }\r\n\r\n const duration = durationInSeconds ?? this.defaultDurationInSeconds;\r\n if (duration <= 0) {\r\n this.warn(`${duration} is an invalid duration for a Snackbar`);\r\n return;\r\n }\r\n\r\n const snackbar: Snackbar = {\r\n message,\r\n durationInSeconds: duration,\r\n snackbarAction\r\n };\r\n\r\n this.snackbarQueue.push(snackbar);\r\n this.notifyOnChange();\r\n this.monitorSnackbarTime();\r\n\r\n return;\r\n };\r\n\r\n getCurrentSnackbar = (): Snackbar \| undefined => {\r\n return this.snackbarQueue.length > 0 ? this.snackbarQueue[0] : undefined;\r\n };\r\n\r\n dismissActiveSnackbar = () => {\r\n if (this.snackbarQueue.length > 0) {\r\n this.snackbarQueue.splice(0, 1);\r\n this.notifyOnChange();\r\n }\r\n };\r\n\r\n callActiveSnackbarAction = () => {\r\n const currentSnackbar = this.getCurrentSnackbar();\r\n if (currentSnackbar) {\r\n if (currentSnackbar.snackbarAction) {\r\n currentSnackbar.snackbarAction.action();\r\n this.dismissActiveSnackbar();\r\n }\r\n }\r\n };\r\n\r\n private async monitorSnackbarTime() {\r\n if (this.monitoringSnackbarTime) {\r\n return;\r\n }\r\n\r\n const loopFrequencyInSeconds: number = 0.1;\r\n this.monitoringSnackbarTime = true;\r\n\r\n while (this.snackbarQueue.length > 0) {\r\n const currentSnackbar = this.getCurrentSnackbar();\r\n if (currentSnackbar) {\r\n let currentTimeout = currentSnackbar.durationInSeconds;\r\n while (\r\n this.getCurrentSnackbar() === currentSnackbar &&\r\n currentTimeout > 0\r\n ) {\r\n // tslint:disable-next-line:no-shadowed-variable\r\n await new Promise((resolve) =>\r\n setTimeout(resolve, loopFrequencyInSeconds * 1000)\r\n );\r\n currentTimeout -= loopFrequencyInSeconds;\r\n }\r\n if (\r\n this.getCurrentSnackbar() === currentSnackbar &&\r\n currentTimeout <= 0\r\n ) {\r\n this.dismissActiveSnackbar();\r\n }\r\n }\r\n }\r\n this.monitoringSnackbarTime = false;\r\n }\r\n}\r\n"]}
1	+ {"version":3,"file":"SnackbarRepo.js","sourceRoot":"","sources":["../../../../src/Snackbar/Entities/SnackbarRepo.ts"],"names":[],"mappings":";;;AAqFA,4CAEC;AAvFD,sCAKqB;AA6BrB;;;GAGG;AACH,MAAsB,YAAa,SAAQ,sBAAe;IAGxD;;;;OAIG;IACH,MAAM,CAAC,GAAG,CAAC,UAAyB;QAClC,OAAO,IAAA,4BAAqB,EAAe,YAAY,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IAC5E,CAAC;;AAVH,oCAwCC;AAvCQ,iBAAI,GAAG,cAAc,CAAC;AAyC/B;;;;GAIG;AACH,SAAgB,gBAAgB,CAAC,SAAoB;IACnD,OAAO,IAAI,eAAe,CAAC,SAAS,CAAC,CAAC;AACxC,CAAC;AAED;;;GAGG;AACH,MAAM,eAAgB,SAAQ,YAAY;IAQxC;;;;OAIG;IACH,YAAY,SAAoB,EAAE,2BAAmC,CAAC;QACpE,KAAK,CAAC,SAAS,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC;QATtC,yDAAyD;QACjD,2BAAsB,GAAY,KAAK,CAAC;QAS9C,IAAI,CAAC,aAAa,GAAG,EAAE,CAAC;QACxB,IAAI,CAAC,wBAAwB,GAAG,wBAAwB,CAAC;QACzD,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;OAKG;IACH,YAAY,CACV,OAAe,EACf,cAA2C,EAC3C,iBAAsC;QAEtC,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAChC,IAAI,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;YAC1C,OAAO;QACT,CAAC;QAED,IAAI,cAAc,IAAI,cAAc,CAAC,gBAAgB,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC1E,IAAI,CAAC,IAAI,CACP,yEAAyE,CAC1E,CAAC;YACF,OAAO;QACT,CAAC;QAED,MAAM,QAAQ,GAAG,iBAAiB,IAAI,IAAI,CAAC,wBAAwB,CAAC;QACpE,IAAI,QAAQ,IAAI,CAAC,EAAE,CAAC;YAClB,IAAI,CAAC,IAAI,CAAC,GAAG,QAAQ,wCAAwC,CAAC,CAAC;YAC/D,OAAO;QACT,CAAC;QAED,MAAM,QAAQ,GAAa;YACzB,OAAO;YACP,iBAAiB,EAAE,QAAQ;YAC3B,cAAc;SACf,CAAC;QAEF,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAClC,IAAI,CAAC,cAAc,EAAE,CAAC;QACtB,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAE3B,OAAO;IACT,CAAC;IAED;;;OAGG;IACH,kBAAkB;QAChB,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC3E,CAAC;IAED;;OAEG;IACH,qBAAqB;QACnB,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAClC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YAChC,IAAI,CAAC,cAAc,EAAE,CAAC;QACxB,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,wBAAwB;QACtB,MAAM,eAAe,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAClD,IAAI,eAAe,EAAE,CAAC;YACpB,IAAI,eAAe,CAAC,cAAc,EAAE,CAAC;gBACnC,eAAe,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC;gBACxC,IAAI,CAAC,qBAAqB,EAAE,CAAC;YAC/B,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,mBAAmB;QAC/B,IAAI,IAAI,CAAC,sBAAsB,EAAE,CAAC;YAChC,OAAO;QACT,CAAC;QAED,MAAM,sBAAsB,GAAW,GAAG,CAAC;QAC3C,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC;QAEnC,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrC,MAAM,eAAe,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAClD,IAAI,eAAe,EAAE,CAAC;gBACpB,IAAI,cAAc,GAAG,eAAe,CAAC,iBAAiB,CAAC;gBACvD,OACE,IAAI,CAAC,kBAAkB,EAAE,KAAK,eAAe;oBAC7C,cAAc,GAAG,CAAC,EAClB,CAAC;oBACD,gDAAgD;oBAChD,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAC5B,UAAU,CAAC,OAAO,EAAE,sBAAsB,GAAG,IAAI,CAAC,CACnD,CAAC;oBACF,cAAc,IAAI,sBAAsB,CAAC;gBAC3C,CAAC;gBACD,IACE,IAAI,CAAC,kBAAkB,EAAE,KAAK,eAAe;oBAC7C,cAAc,IAAI,CAAC,EACnB,CAAC;oBACD,IAAI,CAAC,qBAAqB,EAAE,CAAC;gBAC/B,CAAC;YACH,CAAC;QACH,CAAC;QACD,IAAI,CAAC,sBAAsB,GAAG,KAAK,CAAC;IACtC,CAAC;CACF","sourcesContent":["import {\r\n AppObject,\r\n AppObjectEntity,\r\n AppObjectRepo,\r\n getSingletonComponent\r\n} from \"@vived/core\";\r\n\r\n/*\r\n Represents a snackbar notification with a message, duration, and optional action\r\n /\r\nexport interface Snackbar {\r\n /* The text message to display in the snackbar /\r\n message: string;\r\n /* How long the snackbar should be displayed before auto-dismissing (in seconds) /\r\n durationInSeconds: number;\r\n /* Optional action button and callback for the snackbar /\r\n snackbarAction?: SnackbarAction;\r\n}\r\n\r\n/\r\n Represents an action button for a snackbar\r\n /\r\nexport interface SnackbarAction {\r\n /* The text to display on the action button /\r\n actionButtonText: string;\r\n /* Callback function to execute when the action button is clicked /\r\n action: () => void;\r\n}\r\n\r\n/\r\n Observer type for snackbar state changes\r\n /\r\nexport type SnackbarObserver = (snackbar: Snackbar \| undefined) => void;\r\n\r\n/\r\n Repository for managing snackbar notifications\r\n * Handles creating, displaying, and dismissing snackbars\r\n /\r\nexport abstract class SnackbarRepo extends AppObjectEntity {\r\n static type = \"SnackbarRepo\";\r\n\r\n /\r\n Gets the singleton instance of SnackbarRepo\r\n * @param appObjects The application object repository\r\n * @returns The SnackbarRepo instance or undefined if not found\r\n /\r\n static get(appObjects: AppObjectRepo) {\r\n return getSingletonComponent<SnackbarRepo>(SnackbarRepo.type, appObjects);\r\n }\r\n\r\n /\r\n Creates and displays a new snackbar notification\r\n * @param message The message to display\r\n * @param snackbarAction Optional action button and callback\r\n * @param durationInSeconds Optional duration in seconds before auto-dismissing\r\n /\r\n abstract makeSnackbar(\r\n message: string,\r\n snackbarAction?: SnackbarAction,\r\n durationInSeconds?: number\r\n ): void;\r\n \r\n /\r\n Gets the currently active snackbar, if any\r\n * @returns The current snackbar or undefined if none is active\r\n /\r\n abstract getCurrentSnackbar(): Snackbar \| undefined;\r\n \r\n /\r\n Dismisses the currently active snackbar, if any\r\n /\r\n abstract dismissActiveSnackbar(): void;\r\n \r\n /\r\n Executes the action of the currently active snackbar, if it has one\r\n * Also dismisses the snackbar after executing the action\r\n /\r\n abstract callActiveSnackbarAction(): void;\r\n}\r\n\r\n/\r\n Creates a new SnackbarRepo instance\r\n * @param appObject The application object\r\n * @returns A new SnackbarRepo instance\r\n /\r\nexport function makeSnackbarRepo(appObject: AppObject): SnackbarRepo {\r\n return new SnackbarRepoImp(appObject);\r\n}\r\n\r\n/\r\n Implementation of SnackbarRepo\r\n * Handles the queue of snackbars and their timing\r\n /\r\nclass SnackbarRepoImp extends SnackbarRepo {\r\n /* Queue of snackbars to display /\r\n private snackbarQueue: Snackbar[];\r\n /* Default duration for snackbars if not specified /\r\n private defaultDurationInSeconds: number;\r\n /* Flag to prevent multiple timing loops from running /\r\n private monitoringSnackbarTime: boolean = false;\r\n\r\n /\r\n Creates a new SnackbarRepoImp instance\r\n * @param appObject The application object\r\n * @param defaultDurationInSeconds Default duration for snackbars (default: 4 seconds)\r\n /\r\n constructor(appObject: AppObject, defaultDurationInSeconds: number = 4) {\r\n super(appObject, SnackbarRepo.type);\r\n this.snackbarQueue = [];\r\n this.defaultDurationInSeconds = defaultDurationInSeconds;\r\n this.appObjects.registerSingleton(this);\r\n }\r\n\r\n /\r\n Creates and displays a new snackbar notification\r\n * @param message The message to display\r\n * @param snackbarAction Optional action button and callback\r\n * @param durationInSeconds Optional duration in seconds before auto-dismissing\r\n /\r\n makeSnackbar(\r\n message: string,\r\n snackbarAction?: SnackbarAction \| undefined,\r\n durationInSeconds?: number \| undefined\r\n ): void {\r\n if (message.trim().length === 0) {\r\n this.warn(\"Snackbar must have a message\");\r\n return;\r\n }\r\n\r\n if (snackbarAction && snackbarAction.actionButtonText.trim().length === 0) {\r\n this.warn(\r\n \"If a Snackbar has an action then the action button text cannot be empty\"\r\n );\r\n return;\r\n }\r\n\r\n const duration = durationInSeconds ?? this.defaultDurationInSeconds;\r\n if (duration <= 0) {\r\n this.warn(`${duration} is an invalid duration for a Snackbar`);\r\n return;\r\n }\r\n\r\n const snackbar: Snackbar = {\r\n message,\r\n durationInSeconds: duration,\r\n snackbarAction\r\n };\r\n\r\n this.snackbarQueue.push(snackbar);\r\n this.notifyOnChange();\r\n this.monitorSnackbarTime();\r\n\r\n return;\r\n }\r\n\r\n /\r\n Gets the currently active snackbar, if any\r\n * @returns The current snackbar or undefined if none is active\r\n /\r\n getCurrentSnackbar(): Snackbar \| undefined {\r\n return this.snackbarQueue.length > 0 ? this.snackbarQueue[0] : undefined;\r\n }\r\n\r\n /\r\n Dismisses the currently active snackbar, if any\r\n /\r\n dismissActiveSnackbar(): void {\r\n if (this.snackbarQueue.length > 0) {\r\n this.snackbarQueue.splice(0, 1);\r\n this.notifyOnChange();\r\n }\r\n }\r\n\r\n /\r\n Executes the action of the currently active snackbar, if it has one\r\n * Also dismisses the snackbar after executing the action\r\n /\r\n callActiveSnackbarAction(): void {\r\n const currentSnackbar = this.getCurrentSnackbar();\r\n if (currentSnackbar) {\r\n if (currentSnackbar.snackbarAction) {\r\n currentSnackbar.snackbarAction.action();\r\n this.dismissActiveSnackbar();\r\n }\r\n }\r\n }\r\n\r\n /\r\n Monitors the timing of snackbars to auto-dismiss them when their duration expires\r\n * Uses a loop that checks each snackbar's remaining time\r\n /\r\n private async monitorSnackbarTime() {\r\n if (this.monitoringSnackbarTime) {\r\n return;\r\n }\r\n\r\n const loopFrequencyInSeconds: number = 0.1;\r\n this.monitoringSnackbarTime = true;\r\n\r\n while (this.snackbarQueue.length > 0) {\r\n const currentSnackbar = this.getCurrentSnackbar();\r\n if (currentSnackbar) {\r\n let currentTimeout = currentSnackbar.durationInSeconds;\r\n while (\r\n this.getCurrentSnackbar() === currentSnackbar &&\r\n currentTimeout > 0\r\n ) {\r\n // tslint:disable-next-line:no-shadowed-variable\r\n await new Promise((resolve) =>\r\n setTimeout(resolve, loopFrequencyInSeconds 1000)\r\n );\r\n currentTimeout -= loopFrequencyInSeconds;\r\n }\r\n if (\r\n this.getCurrentSnackbar() === currentSnackbar &&\r\n currentTimeout <= 0\r\n ) {\r\n this.dismissActiveSnackbar();\r\n }\r\n }\r\n }\r\n this.monitoringSnackbarTime = false;\r\n }\r\n}\r\n"]}

package/dist/cjs/Snackbar/Factories/setupSnackbar.js CHANGED Viewed

@@ -3,6 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.setupSnackbar = setupSnackbar;
 const Entities_1 = require("../Entities");
 const PMs_1 = require("../PMs");
+/**
+ * Sets up the Snackbar feature by creating its entity and presentation manager
+ * This is the main entry point for initializing the Snackbar system
+ *
+ * @param appObjects The application object repository
+ */
 function setupSnackbar(appObjects) {
     const ao = appObjects.getOrCreate("Snackbar");
     // Entities