@vived/host 4.10.0 → 4.11.0

package/dist/esm/ThemeColors/Mocks/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/ThemeColors/Mocks/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC","sourcesContent":["export * from \"./MockThemeColorPM\";\r\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/ThemeColors/Mocks/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC","sourcesContent":["export * from \"./MockThemeColorPM\";\n"]}

package/dist/esm/ThemeColors/PM/ThemeColorsPM.js.map

@@ -1 +1 @@
-{"version":3,"file":"ThemeColorsPM.js","sourceRoot":"","sources":["../../../../src/ThemeColors/PM/ThemeColorsPM.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EAErB,WAAW,EAEZ,MAAM,aAAa,CAAC;AACrB,OAAO,EAEL,aAAa,EACb,eAAe,EAChB,MAAM,6BAA6B,CAAC;AAOrC,MAAM,CAAC,MAAM,oBAAoB,GAAkB;IACjD,SAAS,EAAE,EAAE;IACb,MAAM,EAAE,aAAa;CACtB,CAAC;AAEF,MAAM,OAAgB,aAAc,SAAQ,WAA0B;IAGpE,MAAM,CAAC,GAAG,CAAC,UAAyB;QAClC,OAAO,qBAAqB,CAAgB,aAAa,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IAC9E,CAAC;;AAJe,kBAAI,GAAG,eAAe,CAAC;AAOzC,MAAM,UAAU,iBAAiB,CAAC,SAAoB;IACpD,OAAO,IAAI,gBAAgB,CAAC,SAAS,CAAC,CAAC;AACzC,CAAC;AAED,MAAM,gBAAiB,SAAQ,aAAa;IAG1C,WAAW,CAAC,CAAgB,EAAE,CAAgB;QAC5C,OAAO,CAAC,CAAC,SAAS,KAAK,CAAC,CAAC,SAAS,CAAC;IACrC,CAAC;IAUD,YAAY,SAAoB;QAC9B,KAAK,CAAC,SAAS,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC;QATvC,kBAAa,GAAG,GAAG,EAAE;YACnB,IAAI,CAAC,IAAI,CAAC,WAAW;gBAAE,OAAO;YAC9B,IAAI,CAAC,YAAY,CAAC;gBAChB,SAAS,EAAE,IAAI,CAAC,WAAW,CAAC,gBAAgB;gBAC5C,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,YAAY;aACtC,CAAC,CAAC;QACL,CAAC,CAAC;QAKA,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAExC,IAAI,CAAC,WAAW,GAAG,eAAe,CAAC,GAAG,CAAC,SAAS,CAAC,aAAa,CAAE,CAAC;QACjE,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YACtB,IAAI,CAAC,KAAK,CAAC,gCAAgC,CAAC,CAAC;YAC7C,OAAO;QACT,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,WAAW,CAAC,iBAAiB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YACvD,IAAI,CAAC,aAAa,EAAE,CAAC;QACvB,CAAC;IACH,CAAC;CACF","sourcesContent":["import {\r\n  getSingletonComponent,\r\n  AppObject,\r\n  AppObjectPM,\r\n  AppObjectRepo\r\n} from \"@vived/core\";\r\nimport {\r\n  ColorScheme,\r\n  defaultScheme,\r\n  HostThemeEntity\r\n} from \"../Entities/HostThemeEntity\";\r\n\r\nexport interface ThemeColorsVM {\r\n  themeName: string;\r\n  scheme: ColorScheme;\r\n}\r\n\r\nexport const defaultThemeColorsVM: ThemeColorsVM = {\r\n  themeName: \"\",\r\n  scheme: defaultScheme\r\n};\r\n\r\nexport abstract class ThemeColorsPM extends AppObjectPM<ThemeColorsVM> {\r\n  static readonly type = \"ThemeColorsPM\";\r\n\r\n  static get(appObjects: AppObjectRepo) {\r\n    return getSingletonComponent<ThemeColorsPM>(ThemeColorsPM.type, appObjects);\r\n  }\r\n}\r\n\r\nexport function makeThemeColorsPM(appObject: AppObject): ThemeColorsPM {\r\n  return new ThemeColorsPMImp(appObject);\r\n}\r\n\r\nclass ThemeColorsPMImp extends ThemeColorsPM {\r\n  private themeColors?: HostThemeEntity;\r\n\r\n  vmsAreEqual(a: ThemeColorsVM, b: ThemeColorsVM): boolean {\r\n    return a.themeName === b.themeName;\r\n  }\r\n\r\n  onThemeChange = () => {\r\n    if (!this.themeColors) return;\r\n    this.doUpdateView({\r\n      themeName: this.themeColors.activeSchemeName,\r\n      scheme: this.themeColors.activeScheme\r\n    });\r\n  };\r\n\r\n  constructor(appObject: AppObject) {\r\n    super(appObject, ThemeColorsPM.type);\r\n\r\n    this.appObjects.registerSingleton(this);\r\n\r\n    this.themeColors = HostThemeEntity.get(appObject.appObjectRepo)!;\r\n    if (!this.themeColors) {\r\n      this.error(\"Unable to find HostThemeEntity\");\r\n      return;\r\n    } else {\r\n      this.themeColors.addChangeObserver(this.onThemeChange);\r\n      this.onThemeChange();\r\n    }\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"ThemeColorsPM.js","sourceRoot":"","sources":["../../../../src/ThemeColors/PM/ThemeColorsPM.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EAErB,WAAW,EAEZ,MAAM,aAAa,CAAC;AACrB,OAAO,EAEL,aAAa,EACb,eAAe,EAChB,MAAM,6BAA6B,CAAC;AAOrC,MAAM,CAAC,MAAM,oBAAoB,GAAkB;IACjD,SAAS,EAAE,EAAE;IACb,MAAM,EAAE,aAAa;CACtB,CAAC;AAEF,MAAM,OAAgB,aAAc,SAAQ,WAA0B;IAGpE,MAAM,CAAC,GAAG,CAAC,UAAyB;QAClC,OAAO,qBAAqB,CAAgB,aAAa,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IAC9E,CAAC;;AAJe,kBAAI,GAAG,eAAe,CAAC;AAOzC,MAAM,UAAU,iBAAiB,CAAC,SAAoB;IACpD,OAAO,IAAI,gBAAgB,CAAC,SAAS,CAAC,CAAC;AACzC,CAAC;AAED,MAAM,gBAAiB,SAAQ,aAAa;IAG1C,WAAW,CAAC,CAAgB,EAAE,CAAgB;QAC5C,OAAO,CAAC,CAAC,SAAS,KAAK,CAAC,CAAC,SAAS,CAAC;IACrC,CAAC;IAUD,YAAY,SAAoB;QAC9B,KAAK,CAAC,SAAS,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC;QATvC,kBAAa,GAAG,GAAG,EAAE;YACnB,IAAI,CAAC,IAAI,CAAC,WAAW;gBAAE,OAAO;YAC9B,IAAI,CAAC,YAAY,CAAC;gBAChB,SAAS,EAAE,IAAI,CAAC,WAAW,CAAC,gBAAgB;gBAC5C,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,YAAY;aACtC,CAAC,CAAC;QACL,CAAC,CAAC;QAKA,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAExC,IAAI,CAAC,WAAW,GAAG,eAAe,CAAC,GAAG,CAAC,SAAS,CAAC,aAAa,CAAE,CAAC;QACjE,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YACtB,IAAI,CAAC,KAAK,CAAC,gCAAgC,CAAC,CAAC;YAC7C,OAAO;QACT,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,WAAW,CAAC,iBAAiB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YACvD,IAAI,CAAC,aAAa,EAAE,CAAC;QACvB,CAAC;IACH,CAAC;CACF","sourcesContent":["import {\n  getSingletonComponent,\n  AppObject,\n  AppObjectPM,\n  AppObjectRepo\n} from \"@vived/core\";\nimport {\n  ColorScheme,\n  defaultScheme,\n  HostThemeEntity\n} from \"../Entities/HostThemeEntity\";\n\nexport interface ThemeColorsVM {\n  themeName: string;\n  scheme: ColorScheme;\n}\n\nexport const defaultThemeColorsVM: ThemeColorsVM = {\n  themeName: \"\",\n  scheme: defaultScheme\n};\n\nexport abstract class ThemeColorsPM extends AppObjectPM<ThemeColorsVM> {\n  static readonly type = \"ThemeColorsPM\";\n\n  static get(appObjects: AppObjectRepo) {\n    return getSingletonComponent<ThemeColorsPM>(ThemeColorsPM.type, appObjects);\n  }\n}\n\nexport function makeThemeColorsPM(appObject: AppObject): ThemeColorsPM {\n  return new ThemeColorsPMImp(appObject);\n}\n\nclass ThemeColorsPMImp extends ThemeColorsPM {\n  private themeColors?: HostThemeEntity;\n\n  vmsAreEqual(a: ThemeColorsVM, b: ThemeColorsVM): boolean {\n    return a.themeName === b.themeName;\n  }\n\n  onThemeChange = () => {\n    if (!this.themeColors) return;\n    this.doUpdateView({\n      themeName: this.themeColors.activeSchemeName,\n      scheme: this.themeColors.activeScheme\n    });\n  };\n\n  constructor(appObject: AppObject) {\n    super(appObject, ThemeColorsPM.type);\n\n    this.appObjects.registerSingleton(this);\n\n    this.themeColors = HostThemeEntity.get(appObject.appObjectRepo)!;\n    if (!this.themeColors) {\n      this.error(\"Unable to find HostThemeEntity\");\n      return;\n    } else {\n      this.themeColors.addChangeObserver(this.onThemeChange);\n      this.onThemeChange();\n    }\n  }\n}\n"]}

package/dist/esm/ThemeColors/PM/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/ThemeColors/PM/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC","sourcesContent":["export * from \"./ThemeColorsPM\";\r\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/ThemeColors/PM/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC","sourcesContent":["export * from \"./ThemeColorsPM\";\n"]}

package/dist/esm/ThemeColors/UCs/SetThemeUC.js.map

@@ -1 +1 @@
-{"version":3,"file":"SetThemeUC.js","sourceRoot":"","sources":["../../../../src/ThemeColors/UCs/SetThemeUC.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EAGrB,WAAW,EACZ,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAE9C,MAAM,OAAgB,UAAW,SAAQ,WAAW;IASlD,MAAM,CAAC,GAAG,CAAC,UAAyB;QAClC,OAAO,qBAAqB,CAAa,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IACxE,CAAC;;AAVM,eAAI,GAAG,YAAY,CAAC;AAa7B,MAAM,UAAU,cAAc,CAAC,SAAoB;IACjD,OAAO,IAAI,aAAa,CAAC,SAAS,CAAC,CAAC;AACtC,CAAC;AAED,MAAM,aAAc,SAAQ,UAAU;IAIpC,IAAY,KAAK;QACf,OAAO,IAAI,CAAC,kBAAkB,CAAkB,eAAe,CAAC,IAAI,CAAC,CAAC;IACxE,CAAC;IAED,cAAc,CAAC,IAAY;QACzB,IAAI,CAAC,IAAI,CAAC,KAAK;YAAE,OAAO;QAExB,IAAI,CAAC,KAAK,CAAC,gBAAgB,GAAG,IAAI,CAAC;IACrC,CAAC;IAED,cAAc;QACZ,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,UAAU;YAAE,OAAO;QAE9C,MAAM,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC,8BAA8B,CAAC,CAAC;QACtE,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;YACxB,IAAI,CAAC,KAAK,CAAC,gBAAgB,GAAG,IAAI,CAAC,aAAa,CAAC;QACnD,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,KAAK,CAAC,gBAAgB,GAAG,IAAI,CAAC,aAAa,CAAC;QACnD,CAAC;IACH,CAAC;IAED,YAAY,SAAoB;QAC9B,KAAK,CAAC,SAAS,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;QAzBpC,mBAAc,GAAG,OAAO,CAAC;QACzB,kBAAa,GAAG,MAAM,CAAC;QAyBrB,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;CACF","sourcesContent":["import {\r\n  getSingletonComponent,\r\n  AppObject,\r\n  AppObjectRepo,\r\n  AppObjectUC\r\n} from \"@vived/core\";\r\nimport { HostThemeEntity } from \"../Entities\";\r\n\r\nexport abstract class SetThemeUC extends AppObjectUC {\r\n  static type = \"SetThemeUC\";\r\n\r\n  abstract lightThemeName: string;\r\n  abstract darkThemeName: string;\r\n\r\n  abstract setThemeByName(name: string): void;\r\n  abstract tryDetectTheme(): void;\r\n\r\n  static get(appObjects: AppObjectRepo) {\r\n    return getSingletonComponent<SetThemeUC>(SetThemeUC.type, appObjects);\r\n  }\r\n}\r\n\r\nexport function makeSetThemeUC(appObject: AppObject): SetThemeUC {\r\n  return new SetThemeUCImp(appObject);\r\n}\r\n\r\nclass SetThemeUCImp extends SetThemeUC {\r\n  lightThemeName = \"light\";\r\n  darkThemeName = \"dark\";\r\n\r\n  private get theme() {\r\n    return this.getCachedSingleton<HostThemeEntity>(HostThemeEntity.type);\r\n  }\r\n\r\n  setThemeByName(name: string): void {\r\n    if (!this.theme) return;\r\n\r\n    this.theme.activeSchemeName = name;\r\n  }\r\n\r\n  tryDetectTheme(): void {\r\n    if (!this.theme || !window.matchMedia) return;\r\n\r\n    const darkThemeMq = window.matchMedia(\"(prefers-color-scheme: dark)\");\r\n    if (darkThemeMq.matches) {\r\n      this.theme.activeSchemeName = this.darkThemeName;\r\n    } else {\r\n      this.theme.activeSchemeName = this.darkThemeName;\r\n    }\r\n  }\r\n\r\n  constructor(appObject: AppObject) {\r\n    super(appObject, SetThemeUC.type);\r\n    this.appObjects.registerSingleton(this);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"SetThemeUC.js","sourceRoot":"","sources":["../../../../src/ThemeColors/UCs/SetThemeUC.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EAGrB,WAAW,EACZ,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAE9C,MAAM,OAAgB,UAAW,SAAQ,WAAW;IASlD,MAAM,CAAC,GAAG,CAAC,UAAyB;QAClC,OAAO,qBAAqB,CAAa,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IACxE,CAAC;;AAVM,eAAI,GAAG,YAAY,CAAC;AAa7B,MAAM,UAAU,cAAc,CAAC,SAAoB;IACjD,OAAO,IAAI,aAAa,CAAC,SAAS,CAAC,CAAC;AACtC,CAAC;AAED,MAAM,aAAc,SAAQ,UAAU;IAIpC,IAAY,KAAK;QACf,OAAO,IAAI,CAAC,kBAAkB,CAAkB,eAAe,CAAC,IAAI,CAAC,CAAC;IACxE,CAAC;IAED,cAAc,CAAC,IAAY;QACzB,IAAI,CAAC,IAAI,CAAC,KAAK;YAAE,OAAO;QAExB,IAAI,CAAC,KAAK,CAAC,gBAAgB,GAAG,IAAI,CAAC;IACrC,CAAC;IAED,cAAc;QACZ,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,UAAU;YAAE,OAAO;QAE9C,MAAM,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC,8BAA8B,CAAC,CAAC;QACtE,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;YACxB,IAAI,CAAC,KAAK,CAAC,gBAAgB,GAAG,IAAI,CAAC,aAAa,CAAC;QACnD,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,KAAK,CAAC,gBAAgB,GAAG,IAAI,CAAC,aAAa,CAAC;QACnD,CAAC;IACH,CAAC;IAED,YAAY,SAAoB;QAC9B,KAAK,CAAC,SAAS,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;QAzBpC,mBAAc,GAAG,OAAO,CAAC;QACzB,kBAAa,GAAG,MAAM,CAAC;QAyBrB,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;CACF","sourcesContent":["import {\n  getSingletonComponent,\n  AppObject,\n  AppObjectRepo,\n  AppObjectUC\n} from \"@vived/core\";\nimport { HostThemeEntity } from \"../Entities\";\n\nexport abstract class SetThemeUC extends AppObjectUC {\n  static type = \"SetThemeUC\";\n\n  abstract lightThemeName: string;\n  abstract darkThemeName: string;\n\n  abstract setThemeByName(name: string): void;\n  abstract tryDetectTheme(): void;\n\n  static get(appObjects: AppObjectRepo) {\n    return getSingletonComponent<SetThemeUC>(SetThemeUC.type, appObjects);\n  }\n}\n\nexport function makeSetThemeUC(appObject: AppObject): SetThemeUC {\n  return new SetThemeUCImp(appObject);\n}\n\nclass SetThemeUCImp extends SetThemeUC {\n  lightThemeName = \"light\";\n  darkThemeName = \"dark\";\n\n  private get theme() {\n    return this.getCachedSingleton<HostThemeEntity>(HostThemeEntity.type);\n  }\n\n  setThemeByName(name: string): void {\n    if (!this.theme) return;\n\n    this.theme.activeSchemeName = name;\n  }\n\n  tryDetectTheme(): void {\n    if (!this.theme || !window.matchMedia) return;\n\n    const darkThemeMq = window.matchMedia(\"(prefers-color-scheme: dark)\");\n    if (darkThemeMq.matches) {\n      this.theme.activeSchemeName = this.darkThemeName;\n    } else {\n      this.theme.activeSchemeName = this.darkThemeName;\n    }\n  }\n\n  constructor(appObject: AppObject) {\n    super(appObject, SetThemeUC.type);\n    this.appObjects.registerSingleton(this);\n  }\n}\n"]}

package/dist/esm/ThemeColors/UCs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/ThemeColors/UCs/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC","sourcesContent":["export * from \"./SetThemeUC\";\r\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/ThemeColors/UCs/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC","sourcesContent":["export * from \"./SetThemeUC\";\n"]}

package/dist/esm/ThemeColors/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/ThemeColors/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,eAAe,CAAC;AAC9B,cAAc,QAAQ,CAAC;AACvB,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,MAAM,CAAC;AACrB,cAAc,OAAO,CAAC","sourcesContent":["export * from \"./Adapter\";\r\nexport * from \"./Controllers\";\r\nexport * from \"./Data\";\r\nexport * from \"./Entities\";\r\nexport * from \"./Factories\";\r\nexport * from \"./Mocks\";\r\nexport * from \"./PM\";\r\nexport * from \"./UCs\";\r\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/ThemeColors/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,eAAe,CAAC;AAC9B,cAAc,QAAQ,CAAC;AACvB,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,MAAM,CAAC;AACrB,cAAc,OAAO,CAAC","sourcesContent":["export * from \"./Adapter\";\nexport * from \"./Controllers\";\nexport * from \"./Data\";\nexport * from \"./Entities\";\nexport * from \"./Factories\";\nexport * from \"./Mocks\";\nexport * from \"./PM\";\nexport * from \"./UCs\";\n"]}

package/dist/esm/VivedAPI/Adapters/apiStageAdapter.js

@@ -1,7 +1,37 @@
+/**
+ * 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 { APIStage } from "../Entities";
 import { ApiStagePM } from "../PMs/ApiStagePM";
+/**
+ * Adapter for connecting API stage presentation logic to UI frameworks.
+ * Implements SingletonPmAdapter to provide standardized view binding for API stage configuration.
+ */
 export const apiStageAdapter = {
+    /** Default view model value used when PM is not available */
     defaultVM: APIStage.PRODUCTION,
+    /**
+     * Subscribes a view function to receive API stage updates
+     * @param appObjects The AppObjectRepo containing the ApiStagePM
+     * @param setVM Callback function to update the view with new API stage values
+     */
     subscribe: (appObjects, setVM) => {
         const pm = ApiStagePM.get(appObjects);
         if (!pm) {
@@ -10,6 +40,11 @@ export const apiStageAdapter = {
         }
         pm.addView(setVM);
     },
+    /**
+     * Unsubscribes a view function from API stage updates
+     * @param appObjects The AppObjectRepo containing the ApiStagePM
+     * @param setVM Callback function to remove from view updates
+     */
     unsubscribe: (appObjects, setVM) => {
         const pm = ApiStagePM.get(appObjects);
         if (!pm) {

package/dist/esm/VivedAPI/Adapters/apiStageAdapter.js.map

@@ -1 +1 @@
-{"version":3,"file":"apiStageAdapter.js","sourceRoot":"","sources":["../../../../src/VivedAPI/Adapters/apiStageAdapter.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAE/C,MAAM,CAAC,MAAM,eAAe,GAAiC;IAC3D,SAAS,EAAE,QAAQ,CAAC,UAAU;IAC9B,SAAS,EAAE,CAAC,UAAyB,EAAE,KAA6B,EAAE,EAAE;QACtE,MAAM,EAAE,GAAG,UAAU,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,KAA6B,EAAE,EAAE;QACxE,MAAM,EAAE,GAAG,UAAU,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 { APIStage } from \"../Entities\";\r\nimport { ApiStagePM } from \"../PMs/ApiStagePM\";\r\n\r\nexport const apiStageAdapter: SingletonPmAdapter<APIStage> = {\r\n  defaultVM: APIStage.PRODUCTION,\r\n  subscribe: (appObjects: AppObjectRepo, setVM: (vm: APIStage) => void) => {\r\n    const pm = ApiStagePM.get(appObjects);\r\n    if (!pm) {\r\n      appObjects.submitError(\"apiStageAdapter\", \"Unable to find ApiStagePM\");\r\n      return;\r\n    }\r\n    pm.addView(setVM);\r\n  },\r\n  unsubscribe: (appObjects: AppObjectRepo, setVM: (vm: APIStage) => void) => {\r\n    const pm = ApiStagePM.get(appObjects);\r\n    if (!pm) {\r\n      appObjects.submitError(\"apiStageAdapter\", \"Unable to find ApiStagePM\");\r\n      return;\r\n    }\r\n    pm.removeView(setVM);\r\n  }\r\n};\r\n"]}
+{"version":3,"file":"apiStageAdapter.js","sourceRoot":"","sources":["../../../../src/VivedAPI/Adapters/apiStageAdapter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAGH,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAE/C;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAiC;IAC3D,6DAA6D;IAC7D,SAAS,EAAE,QAAQ,CAAC,UAAU;IAE9B;;;;OAIG;IACH,SAAS,EAAE,CAAC,UAAyB,EAAE,KAA6B,EAAE,EAAE;QACtE,MAAM,EAAE,GAAG,UAAU,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,KAA6B,EAAE,EAAE;QACxE,MAAM,EAAE,GAAG,UAAU,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":["/**\r\n * apiStageAdapter.ts\r\n * \r\n * This file defines an adapter for connecting API stage presentation logic to UI frameworks.\r\n * The apiStageAdapter provides a standardized interface for binding API stage configuration\r\n * to view components, handling subscriptions and view model updates.\r\n * \r\n * Key concepts:\r\n * - Adapter implements SingletonPmAdapter interface for UI framework integration\r\n * - Manages subscription lifecycle for view components\r\n * - Provides default view model values for initialization\r\n * - Handles error cases when presentation manager is unavailable\r\n * - Enables reactive UI updates when API stage configuration changes\r\n * \r\n * Usage pattern:\r\n * 1. UI frameworks use this adapter to bind to API stage state\r\n * 2. Adapter manages PM subscriptions and view function callbacks\r\n * 3. View components receive API stage updates automatically\r\n * 4. Proper cleanup handled through unsubscribe mechanism\r\n */\r\n\r\nimport { AppObjectRepo, SingletonPmAdapter } from \"@vived/core\";\r\nimport { APIStage } from \"../Entities\";\r\nimport { ApiStagePM } from \"../PMs/ApiStagePM\";\r\n\r\n/**\r\n * Adapter for connecting API stage presentation logic to UI frameworks.\r\n * Implements SingletonPmAdapter to provide standardized view binding for API stage configuration.\r\n */\r\nexport const apiStageAdapter: SingletonPmAdapter<APIStage> = {\r\n  /** Default view model value used when PM is not available */\r\n  defaultVM: APIStage.PRODUCTION,\r\n  \r\n  /**\r\n   * Subscribes a view function to receive API stage updates\r\n   * @param appObjects The AppObjectRepo containing the ApiStagePM\r\n   * @param setVM Callback function to update the view with new API stage values\r\n   */\r\n  subscribe: (appObjects: AppObjectRepo, setVM: (vm: APIStage) => void) => {\r\n    const pm = ApiStagePM.get(appObjects);\r\n    if (!pm) {\r\n      appObjects.submitError(\"apiStageAdapter\", \"Unable to find ApiStagePM\");\r\n      return;\r\n    }\r\n    pm.addView(setVM);\r\n  },\r\n  \r\n  /**\r\n   * Unsubscribes a view function from API stage updates\r\n   * @param appObjects The AppObjectRepo containing the ApiStagePM\r\n   * @param setVM Callback function to remove from view updates\r\n   */\r\n  unsubscribe: (appObjects: AppObjectRepo, setVM: (vm: APIStage) => void) => {\r\n    const pm = ApiStagePM.get(appObjects);\r\n    if (!pm) {\r\n      appObjects.submitError(\"apiStageAdapter\", \"Unable to find ApiStagePM\");\r\n      return;\r\n    }\r\n    pm.removeView(setVM);\r\n  }\r\n};\r\n"]}

package/dist/esm/VivedAPI/Adapters/index.js

@@ -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.js.map

package/dist/esm/VivedAPI/Adapters/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/VivedAPI/Adapters/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC","sourcesContent":["export * from \"./apiStageAdapter\";\r\nexport * from \"./userTokenAdapter\";\r\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/VivedAPI/Adapters/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC","sourcesContent":["/**\r\n * VivedAPI Adapters Index\r\n * \r\n * This module exports all adapter objects for the VivedAPI feature.\r\n * Adapters provide standardized interfaces for connecting presentation managers\r\n * to various UI frameworks and libraries, handling subscription lifecycles\r\n * and view model synchronization.\r\n * \r\n * Key Concepts:\r\n * - Adapters implement framework-specific integration patterns\r\n * - They manage subscription and unsubscription to presentation manager updates\r\n * - Adapters provide default view model values for initialization\r\n * - They handle error cases when presentation managers are unavailable\r\n * - Adapters enable reactive UI updates across different frontend technologies\r\n * \r\n * Available Adapters:\r\n * - apiStageAdapter: Connects API stage configuration to UI components\r\n * - userTokenAdapter: Connects user authentication token state to UI displays\r\n */\r\n\r\nexport * from \"./apiStageAdapter\";\r\nexport * from \"./userTokenAdapter\";\r\n"]}

package/dist/esm/VivedAPI/Adapters/userTokenAdapter.js

@@ -1,6 +1,36 @@
+/**
+ * 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 { UserTokenPM } from "../PMs/UserTokenPM";
+/**
+ * Adapter for connecting user token presentation logic to UI frameworks.
+ * Implements SingletonPmAdapter to provide standardized view binding for user authentication tokens.
+ */
 export const userTokenAdapter = {
+    /** Default view model value used when PM is not available */
     defaultVM: "",
+    /**
+     * Subscribes a view function to receive user token updates
+     * @param appObjects The AppObjectRepo containing the UserTokenPM
+     * @param setVM Callback function to update the view with new token values
+     */
     subscribe: (appObjects, setVM) => {
         const pm = UserTokenPM.get(appObjects);
         if (!pm) {
@@ -9,6 +39,11 @@ export const userTokenAdapter = {
         }
         pm.addView(setVM);
     },
+    /**
+     * Unsubscribes a view function from user token updates
+     * @param appObjects The AppObjectRepo containing the UserTokenPM
+     * @param setVM Callback function to remove from view updates
+     */
     unsubscribe: (appObjects, setVM) => {
         const pm = UserTokenPM.get(appObjects);
         if (!pm) {

package/dist/esm/VivedAPI/Adapters/userTokenAdapter.js.map

@@ -1 +1 @@
-{"version":3,"file":"userTokenAdapter.js","sourceRoot":"","sources":["../../../../src/VivedAPI/Adapters/userTokenAdapter.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,MAAM,CAAC,MAAM,gBAAgB,GAA+B;IAC1D,SAAS,EAAE,EAAE;IACb,SAAS,EAAE,CAAC,UAAyB,EAAE,KAA2B,EAAE,EAAE;QACpE,MAAM,EAAE,GAAG,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACvC,IAAI,CAAC,EAAE,EAAE,CAAC;YACR,UAAU,CAAC,WAAW,CAAC,kBAAkB,EAAE,4BAA4B,CAAC,CAAC;YACzE,OAAO;QACT,CAAC;QACD,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IACD,WAAW,EAAE,CAAC,UAAyB,EAAE,KAA2B,EAAE,EAAE;QACtE,MAAM,EAAE,GAAG,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACvC,IAAI,CAAC,EAAE,EAAE,CAAC;YACR,UAAU,CAAC,WAAW,CAAC,kBAAkB,EAAE,4BAA4B,CAAC,CAAC;YACzE,OAAO;QACT,CAAC;QACD,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC;CACF,CAAC","sourcesContent":["import { AppObjectRepo, SingletonPmAdapter } from \"@vived/core\";\r\nimport { UserTokenPM } from \"../PMs/UserTokenPM\";\r\n\r\nexport const userTokenAdapter: SingletonPmAdapter<string> = {\r\n  defaultVM: \"\",\r\n  subscribe: (appObjects: AppObjectRepo, setVM: (vm: string) => void) => {\r\n    const pm = UserTokenPM.get(appObjects);\r\n    if (!pm) {\r\n      appObjects.submitError(\"userTokenAdapter\", \"Unable to find UserTokenPM\");\r\n      return;\r\n    }\r\n    pm.addView(setVM);\r\n  },\r\n  unsubscribe: (appObjects: AppObjectRepo, setVM: (vm: string) => void) => {\r\n    const pm = UserTokenPM.get(appObjects);\r\n    if (!pm) {\r\n      appObjects.submitError(\"userTokenAdapter\", \"Unable to find UserTokenPM\");\r\n      return;\r\n    }\r\n    pm.removeView(setVM);\r\n  }\r\n};\r\n"]}
+{"version":3,"file":"userTokenAdapter.js","sourceRoot":"","sources":["../../../../src/VivedAPI/Adapters/userTokenAdapter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAGH,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAA+B;IAC1D,6DAA6D;IAC7D,SAAS,EAAE,EAAE;IAEb;;;;OAIG;IACH,SAAS,EAAE,CAAC,UAAyB,EAAE,KAA2B,EAAE,EAAE;QACpE,MAAM,EAAE,GAAG,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACvC,IAAI,CAAC,EAAE,EAAE,CAAC;YACR,UAAU,CAAC,WAAW,CAAC,kBAAkB,EAAE,4BAA4B,CAAC,CAAC;YACzE,OAAO;QACT,CAAC;QACD,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,WAAW,EAAE,CAAC,UAAyB,EAAE,KAA2B,EAAE,EAAE;QACtE,MAAM,EAAE,GAAG,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACvC,IAAI,CAAC,EAAE,EAAE,CAAC;YACR,UAAU,CAAC,WAAW,CAAC,kBAAkB,EAAE,4BAA4B,CAAC,CAAC;YACzE,OAAO;QACT,CAAC;QACD,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC;CACF,CAAC","sourcesContent":["/**\r\n * userTokenAdapter.ts\r\n * \r\n * This file defines an adapter for connecting user token presentation logic to UI frameworks.\r\n * The userTokenAdapter provides a standardized interface for binding user authentication\r\n * token state to view components, handling subscriptions and view model updates.\r\n * \r\n * Key concepts:\r\n * - Adapter implements SingletonPmAdapter interface for UI framework integration\r\n * - Manages subscription lifecycle for view components displaying user tokens\r\n * - Provides default view model values for initialization (empty string)\r\n * - Handles error cases when presentation manager is unavailable\r\n * - Enables reactive UI updates when user authentication token changes\r\n * \r\n * Usage pattern:\r\n * 1. UI frameworks use this adapter to bind to user token state\r\n * 2. Adapter manages PM subscriptions and view function callbacks\r\n * 3. View components receive token updates automatically\r\n * 4. Proper cleanup handled through unsubscribe mechanism\r\n */\r\n\r\nimport { AppObjectRepo, SingletonPmAdapter } from \"@vived/core\";\r\nimport { UserTokenPM } from \"../PMs/UserTokenPM\";\r\n\r\n/**\r\n * Adapter for connecting user token presentation logic to UI frameworks.\r\n * Implements SingletonPmAdapter to provide standardized view binding for user authentication tokens.\r\n */\r\nexport const userTokenAdapter: SingletonPmAdapter<string> = {\r\n  /** Default view model value used when PM is not available */\r\n  defaultVM: \"\",\r\n  \r\n  /**\r\n   * Subscribes a view function to receive user token updates\r\n   * @param appObjects The AppObjectRepo containing the UserTokenPM\r\n   * @param setVM Callback function to update the view with new token values\r\n   */\r\n  subscribe: (appObjects: AppObjectRepo, setVM: (vm: string) => void) => {\r\n    const pm = UserTokenPM.get(appObjects);\r\n    if (!pm) {\r\n      appObjects.submitError(\"userTokenAdapter\", \"Unable to find UserTokenPM\");\r\n      return;\r\n    }\r\n    pm.addView(setVM);\r\n  },\r\n  \r\n  /**\r\n   * Unsubscribes a view function from user token updates\r\n   * @param appObjects The AppObjectRepo containing the UserTokenPM\r\n   * @param setVM Callback function to remove from view updates\r\n   */\r\n  unsubscribe: (appObjects: AppObjectRepo, setVM: (vm: string) => void) => {\r\n    const pm = UserTokenPM.get(appObjects);\r\n    if (!pm) {\r\n      appObjects.submitError(\"userTokenAdapter\", \"Unable to find UserTokenPM\");\r\n      return;\r\n    }\r\n    pm.removeView(setVM);\r\n  }\r\n};\r\n"]}

package/dist/esm/VivedAPI/Controllers/index.js

@@ -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/esm/VivedAPI/Controllers/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","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","sourcesContent":["export * from \"./loginUser\";\r\nexport * from \"./logoutUser\";\r\nexport * from \"./refreshAuthenticatedUser\";\r\nexport * from \"./setApiStage\";\r\n"]}
+{"version":3,"file":"index.js","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","sourcesContent":["/**\r\n * VivedAPI Controllers Index\r\n * \r\n * This module exports all controller functions for the VivedAPI feature.\r\n * Controllers handle user input and coordinate operations between UI components\r\n * and the underlying business logic components.\r\n * \r\n * Key Concepts:\r\n * - Controllers provide simple function interfaces for common operations\r\n * - They validate inputs and handle error cases appropriately\r\n * - Controllers coordinate between use cases, entities, and external systems\r\n * - They serve as the primary interface for UI framework integration\r\n * - Error handling and logging are managed at the controller level\r\n * \r\n * Available Controllers:\r\n * - User Authentication: loginUser, logoutUser, refreshAuthenticatedUser\r\n * - API Configuration: setApiStage\r\n */\r\n\r\nexport * from \"./loginUser\";\r\nexport * from \"./logoutUser\";\r\nexport * from \"./refreshAuthenticatedUser\";\r\nexport * from \"./setApiStage\";\r\n"]}

package/dist/esm/VivedAPI/Controllers/loginUser.js

@@ -1,4 +1,31 @@
+/**
+ * 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 { UserAuthUC } from "../UCs";
+/**
+ * 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 function loginUser(userName, password, appObjects) {
     const uc = UserAuthUC.get(appObjects);
     if (uc) {

package/dist/esm/VivedAPI/Controllers/loginUser.js.map

@@ -1 +1 @@
-{"version":3,"file":"loginUser.js","sourceRoot":"","sources":["../../../../src/VivedAPI/Controllers/loginUser.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAEpC,MAAM,UAAU,SAAS,CACvB,QAAgB,EAChB,QAAgB,EAChB,UAAyB;IAEzB,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAEtC,IAAI,EAAE,EAAE,CAAC;QACP,OAAO,EAAE,CAAC,KAAK,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACtC,CAAC;SAAM,CAAC;QACN,UAAU,CAAC,aAAa,CAAC,WAAW,EAAE,2BAA2B,CAAC,CAAC;QACnE,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC,CAAC;IAChE,CAAC;AACH,CAAC","sourcesContent":["import { AppObjectRepo } from \"@vived/core\";\r\nimport { UserAuthUC } from \"../UCs\";\r\n\r\nexport function loginUser(\r\n  userName: string,\r\n  password: string,\r\n  appObjects: AppObjectRepo\r\n): Promise<void> {\r\n  const uc = UserAuthUC.get(appObjects);\r\n\r\n  if (uc) {\r\n    return uc.login(userName, password);\r\n  } else {\r\n    appObjects.submitWarning(\"loginUser\", \"Unable to find UserAuthUC\");\r\n    return Promise.reject(new Error(\"Unable to find UserAuthUC\"));\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"loginUser.js","sourceRoot":"","sources":["../../../../src/VivedAPI/Controllers/loginUser.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAGH,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAEpC;;;;;;GAMG;AACH,MAAM,UAAU,SAAS,CACvB,QAAgB,EAChB,QAAgB,EAChB,UAAyB;IAEzB,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAEtC,IAAI,EAAE,EAAE,CAAC;QACP,OAAO,EAAE,CAAC,KAAK,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACtC,CAAC;SAAM,CAAC;QACN,UAAU,CAAC,aAAa,CAAC,WAAW,EAAE,2BAA2B,CAAC,CAAC;QACnE,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC,CAAC;IAChE,CAAC;AACH,CAAC","sourcesContent":["/**\r\n * loginUser.ts\r\n * \r\n * This file defines a controller function for user authentication login operations.\r\n * The loginUser controller provides a simple interface for authenticating users\r\n * with username and password credentials through the VIVED API.\r\n * \r\n * Key concepts:\r\n * - Controller functions handle user input and direct authentication operations\r\n * - Validates UserAuthUC existence before performing login operations\r\n * - Provides error handling and warning messages for missing components\r\n * - Returns promises for async authentication workflows\r\n * - Coordinates with UserAuthUC for actual authentication logic\r\n * \r\n * Usage pattern:\r\n * 1. Call loginUser with credentials and appObjects repository\r\n * 2. Controller validates UC existence and initiates login workflow\r\n * 3. Handle returned Promise for authentication success or failure\r\n * 4. Error handling provides feedback if authentication UC is unavailable\r\n */\r\n\r\nimport { AppObjectRepo } from \"@vived/core\";\r\nimport { UserAuthUC } from \"../UCs\";\r\n\r\n/**\r\n * Authenticates a user with username and password credentials\r\n * @param userName The user's login username\r\n * @param password The user's login password\r\n * @param appObjects The AppObjectRepo containing the UserAuthUC\r\n * @returns Promise that resolves when login is complete or rejects on error\r\n */\r\nexport function loginUser(\r\n  userName: string,\r\n  password: string,\r\n  appObjects: AppObjectRepo\r\n): Promise<void> {\r\n  const uc = UserAuthUC.get(appObjects);\r\n\r\n  if (uc) {\r\n    return uc.login(userName, password);\r\n  } else {\r\n    appObjects.submitWarning(\"loginUser\", \"Unable to find UserAuthUC\");\r\n    return Promise.reject(new Error(\"Unable to find UserAuthUC\"));\r\n  }\r\n}\r\n"]}

package/dist/esm/VivedAPI/Controllers/logoutUser.js

@@ -1,4 +1,29 @@
+/**
+ * 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 { UserAuthUC } from "../UCs";
+/**
+ * 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 function logoutUser(appObjects) {
     const uc = UserAuthUC.get(appObjects);
     if (uc) {

package/dist/esm/VivedAPI/Controllers/logoutUser.js.map

@@ -1 +1 @@
-{"version":3,"file":"logoutUser.js","sourceRoot":"","sources":["../../../../src/VivedAPI/Controllers/logoutUser.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAEpC,MAAM,UAAU,UAAU,CAAC,UAAyB;IAClD,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAEtC,IAAI,EAAE,EAAE,CAAC;QACP,OAAO,EAAE,CAAC,MAAM,EAAE,CAAC;IACrB,CAAC;SAAM,CAAC;QACN,UAAU,CAAC,aAAa,CAAC,YAAY,EAAE,2BAA2B,CAAC,CAAC;QACpE,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC,CAAC;IAChE,CAAC;AACH,CAAC","sourcesContent":["import { AppObjectRepo } from \"@vived/core\";\r\nimport { UserAuthUC } from \"../UCs\";\r\n\r\nexport function logoutUser(appObjects: AppObjectRepo): Promise<void> {\r\n  const uc = UserAuthUC.get(appObjects);\r\n\r\n  if (uc) {\r\n    return uc.logout();\r\n  } else {\r\n    appObjects.submitWarning(\"logoutUser\", \"Unable to find UserAuthUC\");\r\n    return Promise.reject(new Error(\"Unable to find UserAuthUC\"));\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"logoutUser.js","sourceRoot":"","sources":["../../../../src/VivedAPI/Controllers/logoutUser.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAGH,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAEpC;;;;GAIG;AACH,MAAM,UAAU,UAAU,CAAC,UAAyB;IAClD,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAEtC,IAAI,EAAE,EAAE,CAAC;QACP,OAAO,EAAE,CAAC,MAAM,EAAE,CAAC;IACrB,CAAC;SAAM,CAAC;QACN,UAAU,CAAC,aAAa,CAAC,YAAY,EAAE,2BAA2B,CAAC,CAAC;QACpE,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC,CAAC;IAChE,CAAC;AACH,CAAC","sourcesContent":["/**\r\n * logoutUser.ts\r\n * \r\n * This file defines a controller function for user logout operations.\r\n * The logoutUser controller provides a simple interface for terminating user\r\n * sessions and clearing authentication state through the VIVED API.\r\n * \r\n * Key concepts:\r\n * - Controller functions handle user input and direct logout operations\r\n * - Validates UserAuthUC existence before performing logout operations\r\n * - Provides error handling and warning messages for missing components\r\n * - Returns promises for async logout workflows\r\n * - Coordinates with UserAuthUC for actual logout logic\r\n * \r\n * Usage pattern:\r\n * 1. Call logoutUser with appObjects repository\r\n * 2. Controller validates UC existence and initiates logout workflow\r\n * 3. Handle returned Promise for logout success or failure\r\n * 4. Error handling provides feedback if authentication UC is unavailable\r\n */\r\n\r\nimport { AppObjectRepo } from \"@vived/core\";\r\nimport { UserAuthUC } from \"../UCs\";\r\n\r\n/**\r\n * Logs out the current user and terminates the session\r\n * @param appObjects The AppObjectRepo containing the UserAuthUC\r\n * @returns Promise that resolves when logout is complete or rejects on error\r\n */\r\nexport function logoutUser(appObjects: AppObjectRepo): Promise<void> {\r\n  const uc = UserAuthUC.get(appObjects);\r\n\r\n  if (uc) {\r\n    return uc.logout();\r\n  } else {\r\n    appObjects.submitWarning(\"logoutUser\", \"Unable to find UserAuthUC\");\r\n    return Promise.reject(new Error(\"Unable to find UserAuthUC\"));\r\n  }\r\n}\r\n"]}

package/dist/esm/VivedAPI/Controllers/refreshAuthenticatedUser.js.map

@@ -1 +1 @@
-{"version":3,"file":"refreshAuthenticatedUser.js","sourceRoot":"","sources":["../../../../src/VivedAPI/Controllers/refreshAuthenticatedUser.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAEpC,MAAM,UAAU,wBAAwB,CACtC,UAAyB;IAEzB,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAEtC,IAAI,EAAE,EAAE,CAAC;QACP,OAAO,EAAE,CAAC,wBAAwB,EAAE,CAAC;IACvC,CAAC;SAAM,CAAC;QACN,UAAU,CAAC,WAAW,CACpB,0BAA0B,EAC1B,2BAA2B,CAC5B,CAAC;QACF,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC,CAAC;IAChE,CAAC;AACH,CAAC","sourcesContent":["import { AppObjectRepo } from \"@vived/core\";\r\nimport { UserAuthUC } from \"../UCs\";\r\n\r\nexport function refreshAuthenticatedUser(\r\n  appObjects: AppObjectRepo\r\n): Promise<void> {\r\n  const uc = UserAuthUC.get(appObjects);\r\n\r\n  if (uc) {\r\n    return uc.refreshAuthenticatedUser();\r\n  } else {\r\n    appObjects.submitError(\r\n      \"refreshAuthenticatedUser\",\r\n      \"Unable to find UserAuthUC\"\r\n    );\r\n    return Promise.reject(new Error(\"Unable to find UserAuthUC\"));\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"refreshAuthenticatedUser.js","sourceRoot":"","sources":["../../../../src/VivedAPI/Controllers/refreshAuthenticatedUser.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAEpC,MAAM,UAAU,wBAAwB,CACtC,UAAyB;IAEzB,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAEtC,IAAI,EAAE,EAAE,CAAC;QACP,OAAO,EAAE,CAAC,wBAAwB,EAAE,CAAC;IACvC,CAAC;SAAM,CAAC;QACN,UAAU,CAAC,WAAW,CACpB,0BAA0B,EAC1B,2BAA2B,CAC5B,CAAC;QACF,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC,CAAC;IAChE,CAAC;AACH,CAAC","sourcesContent":["import { AppObjectRepo } from \"@vived/core\";\nimport { UserAuthUC } from \"../UCs\";\n\nexport function refreshAuthenticatedUser(\n  appObjects: AppObjectRepo\n): Promise<void> {\n  const uc = UserAuthUC.get(appObjects);\n\n  if (uc) {\n    return uc.refreshAuthenticatedUser();\n  } else {\n    appObjects.submitError(\n      \"refreshAuthenticatedUser\",\n      \"Unable to find UserAuthUC\"\n    );\n    return Promise.reject(new Error(\"Unable to find UserAuthUC\"));\n  }\n}\n"]}

package/dist/esm/VivedAPI/Controllers/setApiStage.js

@@ -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 { VivedAPIEntity } 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 function setApiStage(stage, appObjects) {
     const sandbox = VivedAPIEntity.get(appObjects);
     if (sandbox) {

package/dist/esm/VivedAPI/Controllers/setApiStage.js.map

@@ -1 +1 @@
-{"version":3,"file":"setApiStage.js","sourceRoot":"","sources":["../../../../src/VivedAPI/Controllers/setApiStage.ts"],"names":[],"mappings":"AACA,OAAO,EAAY,cAAc,EAAE,MAAM,aAAa,CAAC;AAEvD,MAAM,UAAU,WAAW,CAAC,KAAe,EAAE,UAAyB;IACpE,MAAM,OAAO,GAAG,cAAc,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAC/C,IAAI,OAAO,EAAE,CAAC;QACZ,OAAO,CAAC,QAAQ,GAAG,KAAK,CAAC;IAC3B,CAAC;SAAM,CAAC;QACN,UAAU,CAAC,aAAa,CAAC,aAAa,EAAE,+BAA+B,CAAC,CAAC;IAC3E,CAAC;AACH,CAAC","sourcesContent":["import { AppObjectRepo } from \"@vived/core\";\r\nimport { APIStage, VivedAPIEntity } from \"../Entities\";\r\n\r\nexport function setApiStage(stage: APIStage, appObjects: AppObjectRepo) {\r\n  const sandbox = VivedAPIEntity.get(appObjects);\r\n  if (sandbox) {\r\n    sandbox.apiStage = stage;\r\n  } else {\r\n    appObjects.submitWarning(\"setApiStage\", \"Unable to find VivedAPIEntity\");\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"setApiStage.js","sourceRoot":"","sources":["../../../../src/VivedAPI/Controllers/setApiStage.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAGH,OAAO,EAAY,cAAc,EAAE,MAAM,aAAa,CAAC;AAEvD;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,KAAe,EAAE,UAAyB;IACpE,MAAM,OAAO,GAAG,cAAc,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAC/C,IAAI,OAAO,EAAE,CAAC;QACZ,OAAO,CAAC,QAAQ,GAAG,KAAK,CAAC;IAC3B,CAAC;SAAM,CAAC;QACN,UAAU,CAAC,aAAa,CAAC,aAAa,EAAE,+BAA+B,CAAC,CAAC;IAC3E,CAAC;AACH,CAAC","sourcesContent":["/**\r\n * setApiStage.ts\r\n * \r\n * This file defines a controller function for setting the API stage configuration.\r\n * The setApiStage controller provides a simple interface for changing the API environment\r\n * that the application communicates with.\r\n * \r\n * Key concepts:\r\n * - Controller functions handle user input and direct operations\r\n * - Validates entity existence before performing operations\r\n * - Provides error handling and warning messages for missing components\r\n * - Updates the VivedAPIEntity singleton with new stage configuration\r\n * - Triggers change notifications to update dependent components\r\n * \r\n * Usage pattern:\r\n * 1. Call setApiStage with desired stage and appObjects repository\r\n * 2. Controller validates entity existence and updates configuration\r\n * 3. Change notifications propagate to PMs and UI components\r\n * 4. Error handling provides feedback if entity is not available\r\n */\r\n\r\nimport { AppObjectRepo } from \"@vived/core\";\r\nimport { APIStage, VivedAPIEntity } from \"../Entities\";\r\n\r\n/**\r\n * Sets the API stage configuration for the application\r\n * @param stage The APIStage to set as the current environment\r\n * @param appObjects The AppObjectRepo containing the VivedAPIEntity singleton\r\n */\r\nexport function setApiStage(stage: APIStage, appObjects: AppObjectRepo) {\r\n  const sandbox = VivedAPIEntity.get(appObjects);\r\n  if (sandbox) {\r\n    sandbox.apiStage = stage;\r\n  } else {\r\n    appObjects.submitWarning(\"setApiStage\", \"Unable to find VivedAPIEntity\");\r\n  }\r\n}\r\n"]}

package/dist/esm/VivedAPI/Entities/VivedAPIEntity.js

@@ -1,22 +1,71 @@
+/**
+ * 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 { MemoizedString } from "@vived/core";
 import { getSingletonComponent, AppObjectEntity } from "@vived/core";
+/**
+ * Enum representing different API environment stages
+ */
 export var APIStage;
 (function (APIStage) {
+    /** Production environment with live data */
     APIStage["PRODUCTION"] = "Production";
+    /** Staging environment for pre-production testing */
     APIStage["STAGING"] = "Staging";
+    /** Development environment for testing */
     APIStage["DEVELOPMENT"] = "Development";
+    /** Local development environment */
     APIStage["LOCAL"] = "LOCAL";
 })(APIStage || (APIStage = {}));
+/**
+ * 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 class VivedAPIEntity extends AppObjectEntity {
+    /**
+     * 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) {
         return getSingletonComponent(VivedAPIEntity.type, appObjects);
     }
+    /**
+     * Gets the current API stage
+     * @returns The current APIStage
+     */
     get apiStage() {
         return this.memoizedApiState.val;
     }
+    /**
+     * Sets the API stage and notifies observers of the change
+     * @param apiState The new APIStage to set
+     */
     set apiStage(apiState) {
         this.memoizedApiState.val = apiState;
     }
+    /**
+     * Gets the base URL for the current API stage
+     * @returns The base URL string for the current environment
+     */
     get baseUrl() {
         if (this.memoizedApiState.val === APIStage.PRODUCTION) {
             return "https://api.vivedlearning.com";
@@ -29,25 +78,49 @@ export class VivedAPIEntity extends AppObjectEntity {
         }
         return "http://localhost:3001";
     }
+    /**
+     * Gets the current user authentication token
+     * @returns The current user token string
+     */
     get userToken() {
         return this.memoizedUserToken.val;
     }
+    /**
+     * Sets the user authentication token and notifies observers
+     * @param val The new user token to set
+     */
     set userToken(val) {
         this.memoizedUserToken.val = val;
     }
+    /**
+     * Constructs a new VivedAPIEntity and registers it as a singleton
+     * @param appObject The AppObject this entity belongs to
+     */
     constructor(appObject) {
         super(appObject, VivedAPIEntity.type);
+        /** Production API base URL */
         this.productionURL = "https://api.vivedlearning.com";
+        /** Staging API base URL */
         this.stagingURL = "https://api-staging.vivedlearning.com";
+        /** Development API base URL */
         this.developmentURL = "https://api-test.vivedlearning.com";
+        /** Local development API base URL */
         this.localURL = "http://localhost:3001";
+        /** Memoized API stage that notifies on changes */
         this.memoizedApiState = new MemoizedString(APIStage.PRODUCTION, this.notifyOnChange);
+        /**
+         * 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
+         */
         this.getEndpointURL = (endpoint) => {
             return new URL(endpoint, this.baseUrl);
         };
+        /** Memoized user authentication token that notifies on changes */
         this.memoizedUserToken = new MemoizedString("", this.notifyOnChange);
         this.appObjects.registerSingleton(this);
     }
 }
+/** Unique type identifier for this component */
 VivedAPIEntity.type = "VivedAPIEntity";
 //# sourceMappingURL=VivedAPIEntity.js.map

package/dist/esm/VivedAPI/Entities/VivedAPIEntity.js.map

@@ -1 +1 @@
-{"version":3,"file":"VivedAPIEntity.js","sourceRoot":"","sources":["../../../../src/VivedAPI/Entities/VivedAPIEntity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EACL,qBAAqB,EAErB,eAAe,EAEhB,MAAM,aAAa,CAAC;AAErB,MAAM,CAAN,IAAY,QAKX;AALD,WAAY,QAAQ;IAClB,qCAAyB,CAAA;IACzB,+BAAmB,CAAA;IACnB,uCAA2B,CAAA;IAC3B,2BAAe,CAAA;AACjB,CAAC,EALW,QAAQ,KAAR,QAAQ,QAKnB;AAED,MAAM,OAAO,cAAe,SAAQ,eAAe;IAGjD,MAAM,CAAC,GAAG,CAAC,UAAyB;QAClC,OAAO,qBAAqB,CAAC,cAAc,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IAChE,CAAC;IAYD,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAe,CAAC;IAC/C,CAAC;IACD,IAAI,QAAQ,CAAC,QAAkB;QAC7B,IAAI,CAAC,gBAAgB,CAAC,GAAG,GAAG,QAAQ,CAAC;IACvC,CAAC;IAED,IAAI,OAAO;QACT,IAAI,IAAI,CAAC,gBAAgB,CAAC,GAAG,KAAK,QAAQ,CAAC,UAAU,EAAE,CAAC;YACtD,OAAO,+BAA+B,CAAC;QACzC,CAAC;QACD,IAAI,IAAI,CAAC,gBAAgB,CAAC,GAAG,KAAK,QAAQ,CAAC,OAAO,EAAE,CAAC;YACnD,OAAO,uCAAuC,CAAC;QACjD,CAAC;QACD,IAAI,IAAI,CAAC,gBAAgB,CAAC,GAAG,KAAK,QAAQ,CAAC,WAAW,EAAE,CAAC;YACvD,OAAO,oCAAoC,CAAC;QAC9C,CAAC;QACD,OAAO,uBAAuB,CAAC;IACjC,CAAC;IAOD,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC;IACpC,CAAC;IACD,IAAI,SAAS,CAAC,GAAW;QACvB,IAAI,CAAC,iBAAiB,CAAC,GAAG,GAAG,GAAG,CAAC;IACnC,CAAC;IAED,YAAY,SAAoB;QAC9B,KAAK,CAAC,SAAS,EAAE,cAAc,CAAC,IAAI,CAAC,CAAC;QA3CxC,kBAAa,GAAG,+BAA+B,CAAC;QAChD,eAAU,GAAG,uCAAuC,CAAC;QACrD,mBAAc,GAAG,oCAAoC,CAAC;QACtD,aAAQ,GAAG,uBAAuB,CAAC;QAE3B,qBAAgB,GAAG,IAAI,cAAc,CAC3C,QAAQ,CAAC,UAAU,EACnB,IAAI,CAAC,cAAc,CACpB,CAAC;QAsBF,mBAAc,GAAG,CAAC,QAAgB,EAAO,EAAE;YACzC,OAAO,IAAI,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACzC,CAAC,CAAC;QAEM,sBAAiB,GAAG,IAAI,cAAc,CAAC,EAAE,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAUtE,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;;AAnDM,mBAAI,GAAG,gBAAgB,AAAnB,CAAoB","sourcesContent":["import { MemoizedString } from \"@vived/core\";\r\nimport {\r\n  getSingletonComponent,\r\n  AppObject,\r\n  AppObjectEntity,\r\n  AppObjectRepo\r\n} from \"@vived/core\";\r\n\r\nexport enum APIStage {\r\n  PRODUCTION = \"Production\",\r\n  STAGING = \"Staging\",\r\n  DEVELOPMENT = \"Development\",\r\n  LOCAL = \"LOCAL\"\r\n}\r\n\r\nexport class VivedAPIEntity extends AppObjectEntity {\r\n  static type = \"VivedAPIEntity\";\r\n\r\n  static get(appObjects: AppObjectRepo): VivedAPIEntity | undefined {\r\n    return getSingletonComponent(VivedAPIEntity.type, appObjects);\r\n  }\r\n\r\n  productionURL = \"https://api.vivedlearning.com\";\r\n  stagingURL = \"https://api-staging.vivedlearning.com\";\r\n  developmentURL = \"https://api-test.vivedlearning.com\";\r\n  localURL = \"http://localhost:3001\";\r\n\r\n  private memoizedApiState = new MemoizedString(\r\n    APIStage.PRODUCTION,\r\n    this.notifyOnChange\r\n  );\r\n\r\n  get apiStage() {\r\n    return this.memoizedApiState.val as APIStage;\r\n  }\r\n  set apiStage(apiState: APIStage) {\r\n    this.memoizedApiState.val = apiState;\r\n  }\r\n\r\n  get baseUrl(): string {\r\n    if (this.memoizedApiState.val === APIStage.PRODUCTION) {\r\n      return \"https://api.vivedlearning.com\";\r\n    }\r\n    if (this.memoizedApiState.val === APIStage.STAGING) {\r\n      return \"https://api-staging.vivedlearning.com\";\r\n    }\r\n    if (this.memoizedApiState.val === APIStage.DEVELOPMENT) {\r\n      return \"https://api-test.vivedlearning.com\";\r\n    }\r\n    return \"http://localhost:3001\";\r\n  }\r\n\r\n  getEndpointURL = (endpoint: string): URL => {\r\n    return new URL(endpoint, this.baseUrl);\r\n  };\r\n\r\n  private memoizedUserToken = new MemoizedString(\"\", this.notifyOnChange);\r\n  get userToken(): string {\r\n    return this.memoizedUserToken.val;\r\n  }\r\n  set userToken(val: string) {\r\n    this.memoizedUserToken.val = val;\r\n  }\r\n\r\n  constructor(appObject: AppObject) {\r\n    super(appObject, VivedAPIEntity.type);\r\n    this.appObjects.registerSingleton(this);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"VivedAPIEntity.js","sourceRoot":"","sources":["../../../../src/VivedAPI/Entities/VivedAPIEntity.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EACL,qBAAqB,EAErB,eAAe,EAEhB,MAAM,aAAa,CAAC;AAErB;;GAEG;AACH,MAAM,CAAN,IAAY,QASX;AATD,WAAY,QAAQ;IAClB,4CAA4C;IAC5C,qCAAyB,CAAA;IACzB,qDAAqD;IACrD,+BAAmB,CAAA;IACnB,0CAA0C;IAC1C,uCAA2B,CAAA;IAC3B,oCAAoC;IACpC,2BAAe,CAAA;AACjB,CAAC,EATW,QAAQ,KAAR,QAAQ,QASnB;AAED;;;;GAIG;AACH,MAAM,OAAO,cAAe,SAAQ,eAAe;IAIjD;;;;OAIG;IACH,MAAM,CAAC,GAAG,CAAC,UAAyB;QAClC,OAAO,qBAAqB,CAAC,cAAc,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IAChE,CAAC;IAiBD;;;OAGG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAe,CAAC;IAC/C,CAAC;IAED;;;OAGG;IACH,IAAI,QAAQ,CAAC,QAAkB;QAC7B,IAAI,CAAC,gBAAgB,CAAC,GAAG,GAAG,QAAQ,CAAC;IACvC,CAAC;IAED;;;OAGG;IACH,IAAI,OAAO;QACT,IAAI,IAAI,CAAC,gBAAgB,CAAC,GAAG,KAAK,QAAQ,CAAC,UAAU,EAAE,CAAC;YACtD,OAAO,+BAA+B,CAAC;QACzC,CAAC;QACD,IAAI,IAAI,CAAC,gBAAgB,CAAC,GAAG,KAAK,QAAQ,CAAC,OAAO,EAAE,CAAC;YACnD,OAAO,uCAAuC,CAAC;QACjD,CAAC;QACD,IAAI,IAAI,CAAC,gBAAgB,CAAC,GAAG,KAAK,QAAQ,CAAC,WAAW,EAAE,CAAC;YACvD,OAAO,oCAAoC,CAAC;QAC9C,CAAC;QACD,OAAO,uBAAuB,CAAC;IACjC,CAAC;IAcD;;;OAGG;IACH,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC;IACpC,CAAC;IAED;;;OAGG;IACH,IAAI,SAAS,CAAC,GAAW;QACvB,IAAI,CAAC,iBAAiB,CAAC,GAAG,GAAG,GAAG,CAAC;IACnC,CAAC;IAED;;;OAGG;IACH,YAAY,SAAoB;QAC9B,KAAK,CAAC,SAAS,EAAE,cAAc,CAAC,IAAI,CAAC,CAAC;QAjFxC,8BAA8B;QAC9B,kBAAa,GAAG,+BAA+B,CAAC;QAChD,2BAA2B;QAC3B,eAAU,GAAG,uCAAuC,CAAC;QACrD,+BAA+B;QAC/B,mBAAc,GAAG,oCAAoC,CAAC;QACtD,qCAAqC;QACrC,aAAQ,GAAG,uBAAuB,CAAC;QAEnC,kDAAkD;QAC1C,qBAAgB,GAAG,IAAI,cAAc,CAC3C,QAAQ,CAAC,UAAU,EACnB,IAAI,CAAC,cAAc,CACpB,CAAC;QAmCF;;;;WAIG;QACH,mBAAc,GAAG,CAAC,QAAgB,EAAO,EAAE;YACzC,OAAO,IAAI,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACzC,CAAC,CAAC;QAEF,kEAAkE;QAC1D,sBAAiB,GAAG,IAAI,cAAc,CAAC,EAAE,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAwBtE,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;;AA/FD,gDAAgD;AACzC,mBAAI,GAAG,gBAAgB,AAAnB,CAAoB","sourcesContent":["/**\r\n * VivedAPIEntity.ts\r\n * \r\n * This file defines the core entity for managing VIVED API configuration and authentication.\r\n * The VivedAPIEntity acts as a singleton component that centralizes API communication settings,\r\n * including environment-specific base URLs and user authentication tokens.\r\n * \r\n * Key concepts:\r\n * - Manages API stage configuration (Production, Staging, Development, Local)\r\n * - Stores and tracks user authentication tokens\r\n * - Provides environment-specific base URLs for API requests\r\n * - Notifies observers when API settings change\r\n * - Implements singleton pattern for system-wide API configuration\r\n * \r\n * Usage pattern:\r\n * 1. Get the singleton entity using VivedAPIEntity.get(appObjects)\r\n * 2. Configure API stage and user token as needed\r\n * 3. Use baseUrl and getEndpointURL for API requests\r\n * 4. Register change observers to react to configuration updates\r\n */\r\n\r\nimport { MemoizedString } from \"@vived/core\";\r\nimport {\r\n  getSingletonComponent,\r\n  AppObject,\r\n  AppObjectEntity,\r\n  AppObjectRepo\r\n} from \"@vived/core\";\r\n\r\n/**\r\n * Enum representing different API environment stages\r\n */\r\nexport enum APIStage {\r\n  /** Production environment with live data */\r\n  PRODUCTION = \"Production\",\r\n  /** Staging environment for pre-production testing */\r\n  STAGING = \"Staging\",\r\n  /** Development environment for testing */\r\n  DEVELOPMENT = \"Development\",\r\n  /** Local development environment */\r\n  LOCAL = \"LOCAL\"\r\n}\r\n\r\n/**\r\n * VivedAPIEntity manages API configuration and authentication state.\r\n * This singleton entity provides centralized access to API settings including\r\n * environment-specific URLs and user authentication tokens.\r\n */\r\nexport class VivedAPIEntity extends AppObjectEntity {\r\n  /** Unique type identifier for this component */\r\n  static type = \"VivedAPIEntity\";\r\n\r\n  /**\r\n   * Retrieves the singleton VivedAPIEntity from the app objects repository\r\n   * @param appObjects The AppObjectRepo to get the singleton from\r\n   * @returns The VivedAPIEntity singleton or undefined if not found\r\n   */\r\n  static get(appObjects: AppObjectRepo): VivedAPIEntity | undefined {\r\n    return getSingletonComponent(VivedAPIEntity.type, appObjects);\r\n  }\r\n\r\n  /** Production API base URL */\r\n  productionURL = \"https://api.vivedlearning.com\";\r\n  /** Staging API base URL */\r\n  stagingURL = \"https://api-staging.vivedlearning.com\";\r\n  /** Development API base URL */\r\n  developmentURL = \"https://api-test.vivedlearning.com\";\r\n  /** Local development API base URL */\r\n  localURL = \"http://localhost:3001\";\r\n\r\n  /** Memoized API stage that notifies on changes */\r\n  private memoizedApiState = new MemoizedString(\r\n    APIStage.PRODUCTION,\r\n    this.notifyOnChange\r\n  );\r\n\r\n  /**\r\n   * Gets the current API stage\r\n   * @returns The current APIStage\r\n   */\r\n  get apiStage() {\r\n    return this.memoizedApiState.val as APIStage;\r\n  }\r\n  \r\n  /**\r\n   * Sets the API stage and notifies observers of the change\r\n   * @param apiState The new APIStage to set\r\n   */\r\n  set apiStage(apiState: APIStage) {\r\n    this.memoizedApiState.val = apiState;\r\n  }\r\n\r\n  /**\r\n   * Gets the base URL for the current API stage\r\n   * @returns The base URL string for the current environment\r\n   */\r\n  get baseUrl(): string {\r\n    if (this.memoizedApiState.val === APIStage.PRODUCTION) {\r\n      return \"https://api.vivedlearning.com\";\r\n    }\r\n    if (this.memoizedApiState.val === APIStage.STAGING) {\r\n      return \"https://api-staging.vivedlearning.com\";\r\n    }\r\n    if (this.memoizedApiState.val === APIStage.DEVELOPMENT) {\r\n      return \"https://api-test.vivedlearning.com\";\r\n    }\r\n    return \"http://localhost:3001\";\r\n  }\r\n\r\n  /**\r\n   * Constructs a complete endpoint URL using the current base URL\r\n   * @param endpoint The endpoint path to append to the base URL\r\n   * @returns A URL object representing the complete endpoint URL\r\n   */\r\n  getEndpointURL = (endpoint: string): URL => {\r\n    return new URL(endpoint, this.baseUrl);\r\n  };\r\n\r\n  /** Memoized user authentication token that notifies on changes */\r\n  private memoizedUserToken = new MemoizedString(\"\", this.notifyOnChange);\r\n  \r\n  /**\r\n   * Gets the current user authentication token\r\n   * @returns The current user token string\r\n   */\r\n  get userToken(): string {\r\n    return this.memoizedUserToken.val;\r\n  }\r\n  \r\n  /**\r\n   * Sets the user authentication token and notifies observers\r\n   * @param val The new user token to set\r\n   */\r\n  set userToken(val: string) {\r\n    this.memoizedUserToken.val = val;\r\n  }\r\n\r\n  /**\r\n   * Constructs a new VivedAPIEntity and registers it as a singleton\r\n   * @param appObject The AppObject this entity belongs to\r\n   */\r\n  constructor(appObject: AppObject) {\r\n    super(appObject, VivedAPIEntity.type);\r\n    this.appObjects.registerSingleton(this);\r\n  }\r\n}\r\n"]}

package/dist/esm/VivedAPI/Entities/index.js

@@ -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.js.map

package/dist/esm/VivedAPI/Entities/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/VivedAPI/Entities/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAA","sourcesContent":["export * from \"./VivedAPIEntity\""]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/VivedAPI/Entities/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,cAAc,kBAAkB,CAAC","sourcesContent":["/**\r\n * VivedAPI Entities Index\r\n * \r\n * This module exports all entity classes for the VivedAPI feature.\r\n * Entities represent the core business objects and data models that store state,\r\n * track changes, and notify observers when modifications occur.\r\n * \r\n * Key Concepts:\r\n * - Entities extend AppObjectEntity and manage domain-specific data\r\n * - They use Memoized types to track changes and trigger notifications\r\n * - Singleton entities provide system-wide access to shared configuration\r\n * - Entities form the foundation for API communication and authentication\r\n * \r\n * Available Entities:\r\n * - VivedAPIEntity: Manages API configuration, authentication, and environment settings\r\n */\r\n\r\nexport * from \"./VivedAPIEntity\";\r\n"]}