@kosdev-code/kos-ui-sdk 3.0.2 → 3.0.4

package/index.js

@@ -2127,6 +2127,22 @@ class PluginExtensionManager {
     return this.extensions;
   }
 }
+var KosContainerIndexEvents = /* @__PURE__ */ ((KosContainerIndexEvents2) => {
+  KosContainerIndexEvents2["ADDED"] = "kos/model/container/index/added";
+  KosContainerIndexEvents2["REMOVED"] = "kos/model/container/index/removed";
+  KosContainerIndexEvents2["CHANGED"] = "kos/model/container/index/changed";
+  KosContainerIndexEvents2["SEED"] = "kos/model/container/index/seed";
+  KosContainerIndexEvents2["PURGE"] = "kos/model/container/index/purge";
+  KosContainerIndexEvents2["REQUEST_SEED"] = "kos/model/container/index/request-seed";
+  return KosContainerIndexEvents2;
+})(KosContainerIndexEvents || {});
+const INDEX_RECORD_SYMBOL = /* @__PURE__ */ Symbol.for(
+  "@kosdev-code/kos-ui-sdk.indexRecord"
+);
+const INDEX_COLLECTION_KEY = "@kosdev-code/kos-ui-sdk.collection";
+function isIndexableItem(value) {
+  return typeof value === "object" && value !== null && INDEX_RECORD_SYMBOL in value;
+}
 function arraysAreEqual(arr1, arr2) {
   if (arr1.length !== arr2.length) return false;
   return arr1.every((item1) => arr2.includes(item1));
@@ -2407,6 +2423,7 @@ class KosModelContainer {
     this._establishModelRelationships(model);
     this._enforceCapacityLimits();
     this._configureModelMonitoring(model);
+    this._publishIndexAdded(model);
     if (!defer) {
       this.increment();
     }
@@ -2483,7 +2500,44 @@ class KosModelContainer {
       () => [disposer, ...computedDisposers].forEach((d) => d())
     );
   }
+  /**
+   * Publish KosContainerIndexEvents.ADDED for an indexable item.
+   * No-op when the model carries no INDEX_RECORD_SYMBOL (not opted
+   * into indexing) or when the record has no resolvable collection
+   * (item has no own tag and no inheritable container context).
+   *
+   * @private
+   */
+  _publishIndexAdded(model) {
+    if (!isIndexableItem(model)) return;
+    const contribution = model[INDEX_RECORD_SYMBOL];
+    if (!contribution.collection) return;
+    const payload = {
+      record: contribution
+    };
+    publish(KosContainerIndexEvents.ADDED, payload);
+  }
+  /**
+   * Publish KosContainerIndexEvents.REMOVED for an indexable item.
+   * Called with the model BEFORE it's deleted from the container so
+   * the payload can carry modelType + collection.
+   *
+   * @private
+   */
+  _publishIndexRemoved(model) {
+    if (!model || !isIndexableItem(model)) return;
+    const contribution = model[INDEX_RECORD_SYMBOL];
+    if (!contribution.collection) return;
+    const payload = {
+      id: contribution.id,
+      modelType: contribution.modelType,
+      collection: contribution.collection
+    };
+    publish(KosContainerIndexEvents.REMOVED, payload);
+  }
   removeModel(id, defer) {
+    const removedModel = this._data.get(id);
+    this._publishIndexRemoved(removedModel);
     this._data.delete(id);
     const orderIndex = this._insertionOrder.indexOf(id);
     if (orderIndex !== -1) {
@@ -11543,6 +11597,135 @@ const KosContextManager = {
 };
 KosContextManager.createContext("root");
 const resolveKosContext = (model) => KosContextManager.getContext(model.id);
+function kosIndexAware(options) {
+  return (target) => {
+    const collection = options?.collection;
+    const fields = options?.fields ?? [];
+    installRecordAccessor(target, collection, fields);
+    if (fields.length > 0) {
+      installChangeEffect(target, fields);
+    }
+    return target;
+  };
+}
+function installRecordAccessor(target, collection, fields) {
+  Object.defineProperty(target.prototype, INDEX_RECORD_SYMBOL, {
+    get() {
+      const record = {
+        id: this.id,
+        modelType: this.modelTypeId
+      };
+      const resolved = typeof collection === "function" ? collection(this) : collection;
+      const inherited = resolved === void 0 ? KosContextManager.getContext(this.id)?.get(
+        INDEX_COLLECTION_KEY
+      ) : void 0;
+      const finalCollection = resolved ?? inherited;
+      if (finalCollection !== void 0) {
+        record.collection = finalCollection;
+      }
+      for (const field of fields) {
+        record[field] = this[field];
+      }
+      return record;
+    },
+    enumerable: false,
+    configurable: true
+  });
+}
+function installChangeEffect(target, fields) {
+  target.prototype[ModelEffects] = target.prototype[ModelEffects] || {};
+  target.prototype[ModelEffects].handleIndexFieldChange = {
+    dependencies: (model) => fields.map((field) => model[field]),
+    value: function() {
+      const record = this[INDEX_RECORD_SYMBOL];
+      if (!record.collection) {
+        return;
+      }
+      const payload = {
+        record
+      };
+      publish(KosContainerIndexEvents.CHANGED, payload);
+    }
+  };
+}
+function kosContainerIndexAware(options) {
+  return (target) => {
+    const itemsProperty = options.itemsProperty;
+    const declaredCollection = options.collection;
+    installContextWriter(target, declaredCollection);
+    installRequestSeedHandler(target, itemsProperty);
+    installPurgeOnUnload(target, itemsProperty);
+    return target;
+  };
+}
+function installContextWriter(target, declaredCollection) {
+  if (declaredCollection === void 0) return;
+  const originalInit = target.prototype.init;
+  target.prototype.init = async function(context) {
+    context?.set(INDEX_COLLECTION_KEY, declaredCollection);
+    if (originalInit) {
+      await originalInit.call(this, context);
+    }
+  };
+}
+function installRequestSeedHandler(target, itemsProperty) {
+  target.prototype[SubscriptionHandlers] = target.prototype[SubscriptionHandlers] || {};
+  target.prototype[SubscriptionHandlers][KosContainerIndexEvents.REQUEST_SEED] = {
+    websocket: false,
+    skipParse: true,
+    // The subscription manager calls transform(body) before
+    // condition/handler. For an internal EventBus event with a
+    // plain object payload we just want to pass it through
+    // untouched.
+    transform: (payload) => payload,
+    condition: () => true,
+    handler: function() {
+      const items = this[itemsProperty] ?? [];
+      const records = collectRecords(items);
+      if (records.size === 0) return;
+      const payload = {
+        modelType: this.modelTypeId,
+        items: Array.from(records.values())
+      };
+      publish(KosContainerIndexEvents.SEED, payload);
+    }
+  };
+}
+function installPurgeOnUnload(target, itemsProperty) {
+  const originalUnload = target.prototype.unload;
+  target.prototype.unload = function(context) {
+    const items = this[itemsProperty] ?? [];
+    const collections = /* @__PURE__ */ new Set();
+    for (const item of items) {
+      if (!isIndexableItem(item)) continue;
+      const contribution = item[INDEX_RECORD_SYMBOL];
+      if (contribution.collection) {
+        collections.add(contribution.collection);
+      }
+    }
+    for (const collection of collections) {
+      const payload = {
+        modelType: this.modelTypeId,
+        collection
+      };
+      publish(KosContainerIndexEvents.PURGE, payload);
+    }
+    if (originalUnload) {
+      return originalUnload.call(this, context);
+    }
+    return void 0;
+  };
+}
+function collectRecords(items) {
+  const result = /* @__PURE__ */ new Map();
+  for (const item of items) {
+    if (!isIndexableItem(item)) continue;
+    const contribution = item[INDEX_RECORD_SYMBOL];
+    if (!contribution.collection) continue;
+    result.set(contribution.id, contribution);
+  }
+  return result;
+}
 const log$s = KosLog.createLogger({ name: "kos-data-container" });
 class KosDataContainer {
   _data;
@@ -26471,6 +26654,8 @@ export {
   HEADER_URL,
   HEADER_WORK_TRACKER,
   HttpRouteHandlers,
+  INDEX_COLLECTION_KEY,
+  INDEX_RECORD_SYMBOL,
   KOS_EXECUTION_CONTEXT,
   KOS_MODEL_ID,
   KOS_RECOVERING_SESSION_KEY,
@@ -26483,6 +26668,7 @@ export {
   Kos,
   Registration as KosConfigPropertySpec,
   KosContainerIndex,
+  KosContainerIndexEvents,
   KosContextBean,
   KosContextManager,
   KosCore,
@@ -26737,6 +26923,7 @@ export {
   injectStateMachineSupport,
   isBoolean,
   isDisposable,
+  isIndexableItem,
   isKosCompanionTypeFactory,
   isKosDataModel,
   isKosExecutionContext,
@@ -26759,12 +26946,14 @@ export {
   kosConfigBean,
   kosConfigProperty,
   kosContainerAware,
+  kosContainerIndexAware,
   kosContext,
   kosDependency,
   kosEffect,
   kosFetch,
   kosFuture,
   kosFutureAware,
+  kosIndexAware,
   kosLogger,
   kosLoggerAware,
   kosModel,