@kosdev-code/kos-ui-sdk 0.1.0-next.807 → 0.1.0-next.808

package/core/util/kos-model-utils.d.ts

@@ -1,4 +1,5 @@
 import { IKosDataModel, IKosModel } from '../core/kosModel';
+import { KosModelState } from '../core/lifecycle';
 /**
  * Asynchronously destroys a KOS data model.
  *
@@ -143,4 +144,46 @@ export declare const isKosModel: <T extends IKosDataModel>(type: string) => (mod
  * @kosApiLevel 2
  */
 export declare const isKosModelReady: (model: IKosDataModel) => boolean;
+/**
+ * An observable, read-only view of a model's activation lifecycle.
+ *
+ * Models that fetch lazily do so in `activate()`, so activation state — not
+ * `loaded`, which tracks the `load()` lifecycle — is what tells a consumer
+ * whether that fetch has settled and whether it succeeded. Exposing just this
+ * lets a view react to activation without taking a dependency on the whole
+ * {@link IKosModel}.
+ */
+export interface KosModelActivationState {
+    /** The model's current activation state. */
+    readonly activeStatus: KosModelState;
+    /** Activation is in flight — nothing conclusive to render yet. */
+    readonly isActivating: boolean;
+    /** Activation completed; the model's activate() work is done. */
+    readonly isActive: boolean;
+    /** Activation threw — the model's data is absent, not empty. */
+    readonly isFailed: boolean;
+}
+/**
+ * Retrieves an observable view of a model's activation state.
+ *
+ * Every member is a getter, so reads happen at access time and stay tracked —
+ * call this once and read its properties inside a `kosComponent` (or any MobX
+ * reaction) to re-render as the model activates, succeeds, or fails.
+ *
+ * @param model - The KOS data model to observe.
+ * @returns The activation view, or `undefined` when the model has no wrapper
+ *          yet (not created, or already destroyed).
+ *
+ * @example Distinguishing "still loading" from "empty" from "failed"
+ * ```tsx
+ * const activation = getKosModelActivationState(container);
+ * if (!activation || activation.isActivating) return <Blank />;
+ * if (activation.isFailed) return <LoadError />;
+ * return <Versions items={container.items} />;
+ * ```
+ *
+ * @kosService core.utils
+ * @kosApiLevel 15
+ */
+export declare const getKosModelActivationState: (model: IKosDataModel | undefined) => KosModelActivationState | undefined;
 //# sourceMappingURL=kos-model-utils.d.ts.map

package/core/util/kos-model-utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"kos-model-utils.d.ts","sourceRoot":"","sources":["../../../../../packages/kos-ui-sdk/src/core/util/kos-model-utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,KAAK,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAKjE;;;;;;;;;GASG;AACH,eAAO,MAAM,eAAe,GAAU,OAAO,aAAa,kBAGzD,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,cAAc,GAAU,WAAW,aAAa,kBAS5D,CAAC;AACF;;;;;;;;;GASG;AACH,eAAO,MAAM,aAAa,GAAU,OAAO,aAAa,kBAevD,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,eAAe,GAAU,SAAS,MAAM,gCAQpD,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,WAAW,GAAU,CAAC,SAAS,aAAa,GAAG,aAAa,EACvE,SAAS,MAAM;WAQqB,CAAC;;EACtC,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,eAAe,GAAI,CAAC,SAAS,aAAa,GAAG,aAAa,EACrE,SAAS,MAAM;WAOqB,CAAC;;CACtC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,SAAS,aAAa,EAChD,WAAW,MAAM,EACjB,WAAW;IAAE,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,KASZ,CAAC,EACrB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,SAAS,GAAI,CAAC,SAAS,aAAa,EAC/C,WAAW,MAAM,EACjB,WAAW;IAAE,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,MACU,CAAC;AAE5C;;;;;;;;;;GAUG;AACH,eAAO,MAAM,oBAAoB,GAAI,CAAC,SAAS,aAAa,EAC1D,OAAO,aAAa,EACpB,MAAM,MAAM,KAWwB,CACrC,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,wBAAwB,GAAI,OAAO,aAAa,oBAc5D,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,uBAAuB,GAAI,SAAS,MAAM,mEAYtD,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,mBAAmB,GAAI,CAAC,SAAS,aAAa,EACzD,SAAS,MAAM,EACf,UAAU,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,KAC9B,SAAS,GAAG,SAWd,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,UAAU,GACpB,CAAC,SAAS,aAAa,EAAE,MAAM,MAAM,MACrC,OAAO,GAAG,KAAG,KAAK,IAAI,CAC4B,CAAC;AAEtD;;;GAGG;AACH,eAAO,MAAM,eAAe,GAAI,OAAO,aAAa,YAMnD,CAAC"}
+{"version":3,"file":"kos-model-utils.d.ts","sourceRoot":"","sources":["../../../../../packages/kos-ui-sdk/src/core/util/kos-model-utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,KAAK,SAAS,EAAE,MAAM,kBAAkB,CAAC;AACjE,OAAO,EAAkB,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAIlE;;;;;;;;;GASG;AACH,eAAO,MAAM,eAAe,GAAU,OAAO,aAAa,kBAGzD,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,cAAc,GAAU,WAAW,aAAa,kBAS5D,CAAC;AACF;;;;;;;;;GASG;AACH,eAAO,MAAM,aAAa,GAAU,OAAO,aAAa,kBAevD,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,eAAe,GAAU,SAAS,MAAM,gCAQpD,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,WAAW,GAAU,CAAC,SAAS,aAAa,GAAG,aAAa,EACvE,SAAS,MAAM;WAQqB,CAAC;;EACtC,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,eAAe,GAAI,CAAC,SAAS,aAAa,GAAG,aAAa,EACrE,SAAS,MAAM;WAOqB,CAAC;;CACtC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,SAAS,aAAa,EAChD,WAAW,MAAM,EACjB,WAAW;IAAE,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,KASZ,CAAC,EACrB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,SAAS,GAAI,CAAC,SAAS,aAAa,EAC/C,WAAW,MAAM,EACjB,WAAW;IAAE,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,MACU,CAAC;AAE5C;;;;;;;;;;GAUG;AACH,eAAO,MAAM,oBAAoB,GAAI,CAAC,SAAS,aAAa,EAC1D,OAAO,aAAa,EACpB,MAAM,MAAM,KAWwB,CACrC,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,wBAAwB,GAAI,OAAO,aAAa,oBAc5D,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,uBAAuB,GAAI,SAAS,MAAM,mEAYtD,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,mBAAmB,GAAI,CAAC,SAAS,aAAa,EACzD,SAAS,MAAM,EACf,UAAU,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,KAC9B,SAAS,GAAG,SAWd,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,UAAU,GACpB,CAAC,SAAS,aAAa,EAAE,MAAM,MAAM,MACrC,OAAO,GAAG,KAAG,KAAK,IAAI,CAC4B,CAAC;AAEtD;;;GAGG;AACH,eAAO,MAAM,eAAe,GAAI,OAAO,aAAa,YAMnD,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,WAAW,uBAAuB;IACtC,4CAA4C;IAC5C,QAAQ,CAAC,YAAY,EAAE,aAAa,CAAC;IACrC,kEAAkE;IAClE,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC;IAC/B,iEAAiE;IACjE,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,gEAAgE;IAChE,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;CAC5B;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,0BAA0B,GACrC,OAAO,aAAa,GAAG,SAAS,KAC/B,uBAAuB,GAAG,SAuB5B,CAAC"}

package/index.cjs

@@ -2915,6 +2915,29 @@ const isKosModelReady = (model) => {
   }
   return kosModel2.isReady();
 };
+const getKosModelActivationState = (model) => {
+  if (!model?.id) {
+    return void 0;
+  }
+  const kosModel2 = KosCore.getInstance().modelManager.getModelById(model.id);
+  if (!kosModel2) {
+    return void 0;
+  }
+  return {
+    get activeStatus() {
+      return kosModel2.activeStatus;
+    },
+    get isActivating() {
+      return kosModel2.activeStatus === KosModelState.ACTIVATING;
+    },
+    get isActive() {
+      return kosModel2.activeStatus === KosModelState.ACTIVE;
+    },
+    get isFailed() {
+      return kosModel2.activeStatus === KosModelState.FAILED;
+    }
+  };
+};
 const log$L = KosLog.createLogger({ name: "kos-model-factory" });
 const KosModelFactory = {
   byModelType: (modelType) => KosCore.getInstance().modelManager.getModelFactory(
@@ -27220,6 +27243,7 @@ exports.getKosConnectionId = getKosConnectionId;
 exports.getKosLocalizationDescriptor = getKosLocalizationDescriptor;
 exports.getKosMessageLogging = getKosMessageLogging;
 exports.getKosModel = getKosModel$1;
+exports.getKosModelActivationState = getKosModelActivationState;
 exports.getKosModelSync = getKosModelSync;
 exports.getKosModelType = getKosModelType;
 exports.getKosServiceApi = getKosServiceApi;