@osdk/client 2.4.2 → 2.5.0-beta.10

package/build/browser/observable/internal/links/SpecificLinkQuery.js

@@ -0,0 +1,185 @@
+/*
+ * Copyright 2025 Palantir Technologies, Inc. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import deepEqual from "fast-deep-equal";
+import { additionalContext } from "../../../Client.js";
+import { BaseListQuery } from "../base-list/BaseListQuery.js";
+import { OrderBySortingStrategy } from "../sorting/SortingStrategy.js";
+import { tombstone } from "../tombstone.js";
+/**
+ * Query implementation for retrieving linked objects from a specific object.
+ * - Stores links as ObjectCacheKey[] references
+ * - Creates indirect dependencies on linked objects
+ * - Supports filtering and sorting of linked collections
+ * - Handles proper invalidation of related objects
+ */
+export class SpecificLinkQuery extends BaseListQuery {
+  #sourceApiName;
+  #sourcePk;
+  #linkName;
+  #whereClause;
+  #orderBy;
+
+  /**
+   * Register changes to the cache specific to SpecificLinkQuery
+   */
+  registerCacheChanges(batch) {
+    batch.changes.modified.add(this.cacheKey);
+  }
+  constructor(store, subject, cacheKey, opts) {
+    super(store, subject, opts, cacheKey, process.env.NODE_ENV !== "production" ? store.client[additionalContext].logger?.child({}, {
+      msgPrefix: `SpecificLinkQuery<${cacheKey.otherKeys.map(x => JSON.stringify(x)).join(", ")}>`
+    }) : undefined);
+
+    // Extract the necessary parameters from the cache key
+    [this.#sourceApiName, this.#sourcePk, this.#linkName, this.#whereClause, this.#orderBy] = cacheKey.otherKeys;
+    this.sortingStrategy = new OrderBySortingStrategy(this.#linkName, this.#orderBy);
+  }
+
+  // _fetchAndStore is now implemented in BaseCollectionQuery
+
+  /**
+   * Implements fetchPageData from the BaseCollectionQuery template method pattern
+   * Fetches a page of linked objects
+   */
+  async fetchPageData(signal) {
+    // Use the client API to create a query that pivots to linked objects
+    const client = this.store.client;
+
+    // First, get metadata for the source object to know the primary key field name
+    const sourceObjectDef = {
+      type: "object",
+      apiName: this.#sourceApiName
+    };
+
+    // Use the client's ontologyProvider to get metadata, which has built-in caching
+    const sourceMetadata = await client[additionalContext].ontologyProvider.getObjectDefinition(this.#sourceApiName);
+
+    // Query for the specific source object
+    const sourceQuery = client(sourceObjectDef).where({
+      [sourceMetadata.primaryKeyApiName]: this.#sourcePk
+    });
+
+    // Pivot to the linked objects
+    const linkQuery = sourceQuery.pivotTo(this.#linkName);
+
+    // Check for abort signal again before fetching
+    if (signal?.aborted) {
+      throw new Error("Aborted");
+    }
+
+    // Fetch the linked objects with pagination
+    // Add orderBy to the query parameters if specified
+    const queryParams = {
+      $pageSize: this.options.pageSize || 100,
+      $nextPageToken: this.nextPageToken
+    };
+
+    // Include orderBy if it has entries
+    if (this.#orderBy && Object.keys(this.#orderBy).length > 0) {
+      queryParams.$orderBy = this.#orderBy;
+    }
+
+    // Include whereClause if it has entries
+    if (this.#whereClause && Object.keys(this.#whereClause).length > 0) {
+      queryParams.$where = this.#whereClause;
+    }
+    const response = await linkQuery.fetchPage(queryParams);
+
+    // Store the next page token for pagination
+    this.nextPageToken = response.nextPageToken;
+    return response;
+  }
+
+  /**
+   * Removes a link query from the store
+   */
+  deleteFromStore(status, batch) {
+    const entry = batch.read(this.cacheKey);
+    if (entry && deepEqual(tombstone, entry.value)) {
+      if (process.env.NODE_ENV !== "production") {
+        this.logger?.child({
+          methodName: "deleteFromStore"
+        }).debug(`Links were already deleted, just setting status`);
+      }
+      return batch.write(this.cacheKey, entry.value, status);
+    }
+    if (process.env.NODE_ENV !== "production") {
+      this.logger?.child({
+        methodName: "deleteFromStore"
+      }).debug(JSON.stringify({
+        status
+      }));
+    }
+
+    // If there is no entry then there is nothing to do
+    if (!entry || !entry.value) {
+      return;
+    }
+    const ret = batch.delete(this.cacheKey, status);
+    batch.changes.deleted.add(this.cacheKey);
+    return ret;
+  }
+
+  /**
+   * Implements Query.maybeUpdateAndRevalidate to handle cache invalidation
+   */
+  maybeUpdateAndRevalidate = async changes => {
+    // TODO: Implement proper invalidation logic for linked objects
+    // This would check if any of the linked objects have changed,
+    // or if the source object's links might have changed
+
+    // For now, simply check if this specific link cache key was modified
+    if (changes.modified.has(this.cacheKey)) {
+      return this.revalidate(true);
+    }
+
+    // No relevant changes were detected
+    return Promise.resolve();
+  };
+  invalidateObjectType = (objectType, changes) => {
+    // We need to invalidate links in two cases:
+    // 1. When the source object type matches the apiName (direct invalidation)
+    // 2. When the target object type might be the invalidated type (affected by target changes)
+
+    // For case 1 - direct source object type match
+    if (this.#sourceApiName === objectType) {
+      changes?.modified.add(this.cacheKey);
+      return this.revalidate(true);
+    } else {
+      // For case 2 - check if the link's target type matches the invalidated type
+      // We need to use the ontology provider to get the link metadata
+      // Since this is async, we'll collect all the metadata check promises
+      return (async () => {
+        // Get the source object metadata to determine link target type
+        const sourceMetadata = await this.store.client[additionalContext].ontologyProvider.getObjectDefinition(this.#sourceApiName);
+        const linkDef = sourceMetadata.links?.[this.#linkName];
+        if (!linkDef || linkDef.targetType !== objectType) return;
+        const promise = this.revalidate(true);
+        changes?.modified.add(this.cacheKey);
+        return promise;
+      })();
+    }
+  };
+}
+
+/**
+ * Type guard to check if a cache key is a SpecificLinkCacheKey
+ */
+export function isSpecificLinkCacheKey(key) {
+  return key.type === "specificLink";
+}
+//# sourceMappingURL=SpecificLinkQuery.js.map

package/build/browser/observable/internal/links/SpecificLinkQuery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SpecificLinkQuery.js","names":["deepEqual","additionalContext","BaseListQuery","OrderBySortingStrategy","tombstone","SpecificLinkQuery","sourceApiName","sourcePk","linkName","whereClause","orderBy","registerCacheChanges","batch","changes","modified","add","cacheKey","constructor","store","subject","opts","process","env","NODE_ENV","client","logger","child","msgPrefix","otherKeys","map","x","JSON","stringify","join","undefined","sortingStrategy","fetchPageData","signal","sourceObjectDef","type","apiName","sourceMetadata","ontologyProvider","getObjectDefinition","sourceQuery","where","primaryKeyApiName","linkQuery","pivotTo","aborted","Error","queryParams","$pageSize","options","pageSize","$nextPageToken","nextPageToken","Object","keys","length","$orderBy","$where","response","fetchPage","deleteFromStore","status","entry","read","value","methodName","debug","write","ret","delete","deleted","maybeUpdateAndRevalidate","has","revalidate","Promise","resolve","invalidateObjectType","objectType","linkDef","links","targetType","promise","isSpecificLinkCacheKey","key"],"sources":["SpecificLinkQuery.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n  ObjectTypeDefinition,\n  Osdk,\n  PageResult,\n  PrimaryKeyType,\n  WhereClause,\n} from \"@osdk/api\";\nimport deepEqual from \"fast-deep-equal\";\nimport { type Subject } from \"rxjs\";\nimport { additionalContext } from \"../../../Client.js\";\nimport type { SpecificLinkPayload } from \"../../LinkPayload.js\";\nimport type { Status } from \"../../ObservableClient/common.js\";\nimport type { ObserveLinks } from \"../../ObservableClient/ObserveLink.js\";\nimport { BaseListQuery } from \"../base-list/BaseListQuery.js\";\nimport type { BatchContext } from \"../BatchContext.js\";\nimport type { CacheKey } from \"../CacheKey.js\";\nimport type { Canonical } from \"../Canonical.js\";\nimport type { Changes } from \"../Changes.js\";\nimport type { Entry } from \"../Layer.js\";\nimport type { OptimisticId } from \"../OptimisticId.js\";\nimport type { SimpleWhereClause } from \"../SimpleWhereClause.js\";\nimport { OrderBySortingStrategy } from \"../sorting/SortingStrategy.js\";\nimport type { Store } from \"../Store.js\";\nimport type { SubjectPayload } from \"../SubjectPayload.js\";\nimport { tombstone } from \"../tombstone.js\";\nimport type { SpecificLinkCacheKey } from \"./SpecificLinkCacheKey.js\";\n\n/**\n * Query implementation for retrieving linked objects from a specific object.\n * - Stores links as ObjectCacheKey[] references\n * - Creates indirect dependencies on linked objects\n * - Supports filtering and sorting of linked collections\n * - Handles proper invalidation of related objects\n */\nexport class SpecificLinkQuery extends BaseListQuery<\n  SpecificLinkCacheKey,\n  SpecificLinkPayload,\n  ObserveLinks.Options<ObjectTypeDefinition, string>\n> {\n  #sourceApiName: string;\n  #sourcePk: PrimaryKeyType<ObjectTypeDefinition>;\n  #linkName: string;\n  #whereClause: Canonical<SimpleWhereClause>;\n  #orderBy: Canonical<Record<string, \"asc\" | \"desc\" | undefined>>;\n\n  /**\n   * Register changes to the cache specific to SpecificLinkQuery\n   */\n  protected registerCacheChanges(batch: BatchContext): void {\n    batch.changes.modified.add(this.cacheKey);\n  }\n\n  constructor(\n    store: Store,\n    subject: Subject<SubjectPayload<SpecificLinkCacheKey>>,\n    cacheKey: SpecificLinkCacheKey,\n    opts: ObserveLinks.Options<\n      ObjectTypeDefinition,\n      string\n    >,\n  ) {\n    super(\n      store,\n      subject,\n      opts,\n      cacheKey,\n      process.env.NODE_ENV !== \"production\"\n        ? (\n          store.client[additionalContext].logger?.child({}, {\n            msgPrefix: `SpecificLinkQuery<${\n              cacheKey.otherKeys.map(x => JSON.stringify(x)).join(\", \")\n            }>`,\n          })\n        )\n        : undefined,\n    );\n\n    // Extract the necessary parameters from the cache key\n    [\n      this.#sourceApiName,\n      this.#sourcePk,\n      this.#linkName,\n      this.#whereClause,\n      this.#orderBy,\n    ] = cacheKey.otherKeys;\n\n    this.sortingStrategy = new OrderBySortingStrategy(\n      this.#linkName,\n      this.#orderBy,\n    );\n  }\n\n  // _fetchAndStore is now implemented in BaseCollectionQuery\n\n  /**\n   * Implements fetchPageData from the BaseCollectionQuery template method pattern\n   * Fetches a page of linked objects\n   */\n  protected async fetchPageData(\n    signal: AbortSignal | undefined,\n  ): Promise<PageResult<Osdk.Instance<any>>> {\n    // Use the client API to create a query that pivots to linked objects\n    const client = this.store.client;\n\n    // First, get metadata for the source object to know the primary key field name\n    const sourceObjectDef = {\n      type: \"object\",\n      apiName: this.#sourceApiName,\n    } as ObjectTypeDefinition;\n\n    // Use the client's ontologyProvider to get metadata, which has built-in caching\n    const sourceMetadata = await client[additionalContext].ontologyProvider\n      .getObjectDefinition(this.#sourceApiName);\n\n    // Query for the specific source object\n    const sourceQuery = client(sourceObjectDef).where({\n      [sourceMetadata.primaryKeyApiName]: this.#sourcePk,\n    } as WhereClause<any>);\n\n    // Pivot to the linked objects\n    const linkQuery = sourceQuery.pivotTo(this.#linkName);\n\n    // Check for abort signal again before fetching\n    if (signal?.aborted) {\n      throw new Error(\"Aborted\");\n    }\n\n    // Fetch the linked objects with pagination\n    // Add orderBy to the query parameters if specified\n    const queryParams: any = {\n      $pageSize: this.options.pageSize || 100,\n      $nextPageToken: this.nextPageToken,\n    };\n\n    // Include orderBy if it has entries\n    if (this.#orderBy && Object.keys(this.#orderBy).length > 0) {\n      queryParams.$orderBy = this.#orderBy;\n    }\n\n    // Include whereClause if it has entries\n    if (this.#whereClause && Object.keys(this.#whereClause).length > 0) {\n      queryParams.$where = this.#whereClause;\n    }\n\n    const response = await linkQuery.fetchPage(queryParams);\n\n    // Store the next page token for pagination\n    this.nextPageToken = response.nextPageToken;\n\n    return response;\n  }\n\n  /**\n   * Removes a link query from the store\n   */\n  deleteFromStore(\n    status: Status,\n    batch: BatchContext,\n  ): Entry<SpecificLinkCacheKey> | undefined {\n    const entry = batch.read(this.cacheKey);\n\n    if (entry && deepEqual(tombstone, entry.value)) {\n      if (process.env.NODE_ENV !== \"production\") {\n        this.logger?.child({ methodName: \"deleteFromStore\" }).debug(\n          `Links were already deleted, just setting status`,\n        );\n      }\n      return batch.write(this.cacheKey, entry.value, status);\n    }\n\n    if (process.env.NODE_ENV !== \"production\") {\n      this.logger?.child({ methodName: \"deleteFromStore\" }).debug(\n        JSON.stringify({ status }),\n      );\n    }\n\n    // If there is no entry then there is nothing to do\n    if (!entry || !entry.value) {\n      return;\n    }\n\n    const ret = batch.delete(this.cacheKey, status);\n    batch.changes.deleted.add(this.cacheKey);\n\n    return ret;\n  }\n\n  /**\n   * Implements Query.maybeUpdateAndRevalidate to handle cache invalidation\n   */\n  maybeUpdateAndRevalidate = async (\n    changes: Changes,\n    _optimisticId: OptimisticId | undefined,\n  ): Promise<void> => {\n    // TODO: Implement proper invalidation logic for linked objects\n    // This would check if any of the linked objects have changed,\n    // or if the source object's links might have changed\n\n    // For now, simply check if this specific link cache key was modified\n    if (changes.modified.has(this.cacheKey)) {\n      return this.revalidate(true);\n    }\n\n    // No relevant changes were detected\n    return Promise.resolve();\n  };\n\n  invalidateObjectType = (\n    objectType: string,\n    changes: Changes | undefined,\n  ): Promise<void> => {\n    // We need to invalidate links in two cases:\n    // 1. When the source object type matches the apiName (direct invalidation)\n    // 2. When the target object type might be the invalidated type (affected by target changes)\n\n    // For case 1 - direct source object type match\n    if (this.#sourceApiName === objectType) {\n      changes?.modified.add(this.cacheKey);\n      return this.revalidate(true);\n    } else {\n      // For case 2 - check if the link's target type matches the invalidated type\n      // We need to use the ontology provider to get the link metadata\n      // Since this is async, we'll collect all the metadata check promises\n      return (async () => {\n        // Get the source object metadata to determine link target type\n        const sourceMetadata = await this.store.client[additionalContext]\n          .ontologyProvider\n          .getObjectDefinition(this.#sourceApiName);\n\n        const linkDef = sourceMetadata.links?.[this.#linkName];\n        if (!linkDef || linkDef.targetType !== objectType) return;\n\n        const promise = this.revalidate(true);\n        changes?.modified.add(this.cacheKey);\n        return promise;\n      })();\n    }\n  };\n}\n\n/**\n * Type guard to check if a cache key is a SpecificLinkCacheKey\n */\nexport function isSpecificLinkCacheKey(\n  key: CacheKey,\n): key is SpecificLinkCacheKey {\n  return key.type === \"specificLink\";\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AASA,OAAOA,SAAS,MAAM,iBAAiB;AAEvC,SAASC,iBAAiB,QAAQ,oBAAoB;AAItD,SAASC,aAAa,QAAQ,+BAA+B;AAQ7D,SAASC,sBAAsB,QAAQ,+BAA+B;AAGtE,SAASC,SAAS,QAAQ,iBAAiB;AAG3C;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,iBAAiB,SAASH,aAAa,CAIlD;EACA,CAACI,aAAa;EACd,CAACC,QAAQ;EACT,CAACC,QAAQ;EACT,CAACC,WAAW;EACZ,CAACC,OAAO;;EAER;AACF;AACA;EACYC,oBAAoBA,CAACC,KAAmB,EAAQ;IACxDA,KAAK,CAACC,OAAO,CAACC,QAAQ,CAACC,GAAG,CAAC,IAAI,CAACC,QAAQ,CAAC;EAC3C;EAEAC,WAAWA,CACTC,KAAY,EACZC,OAAsD,EACtDH,QAA8B,EAC9BI,IAGC,EACD;IACA,KAAK,CACHF,KAAK,EACLC,OAAO,EACPC,IAAI,EACJJ,QAAQ,EACRK,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,GAEjCL,KAAK,CAACM,MAAM,CAACvB,iBAAiB,CAAC,CAACwB,MAAM,EAAEC,KAAK,CAAC,CAAC,CAAC,EAAE;MAChDC,SAAS,EAAE,qBACTX,QAAQ,CAACY,SAAS,CAACC,GAAG,CAACC,CAAC,IAAIC,IAAI,CAACC,SAAS,CAACF,CAAC,CAAC,CAAC,CAACG,IAAI,CAAC,IAAI,CAAC;IAE7D,CAAC,CAAC,GAEFC,SACN,CAAC;;IAED;IACA,CACE,IAAI,CAAC,CAAC5B,aAAa,EACnB,IAAI,CAAC,CAACC,QAAQ,EACd,IAAI,CAAC,CAACC,QAAQ,EACd,IAAI,CAAC,CAACC,WAAW,EACjB,IAAI,CAAC,CAACC,OAAO,CACd,GAAGM,QAAQ,CAACY,SAAS;IAEtB,IAAI,CAACO,eAAe,GAAG,IAAIhC,sBAAsB,CAC/C,IAAI,CAAC,CAACK,QAAQ,EACd,IAAI,CAAC,CAACE,OACR,CAAC;EACH;;EAEA;;EAEA;AACF;AACA;AACA;EACE,MAAgB0B,aAAaA,CAC3BC,MAA+B,EACU;IACzC;IACA,MAAMb,MAAM,GAAG,IAAI,CAACN,KAAK,CAACM,MAAM;;IAEhC;IACA,MAAMc,eAAe,GAAG;MACtBC,IAAI,EAAE,QAAQ;MACdC,OAAO,EAAE,IAAI,CAAC,CAAClC;IACjB,CAAyB;;IAEzB;IACA,MAAMmC,cAAc,GAAG,MAAMjB,MAAM,CAACvB,iBAAiB,CAAC,CAACyC,gBAAgB,CACpEC,mBAAmB,CAAC,IAAI,CAAC,CAACrC,aAAa,CAAC;;IAE3C;IACA,MAAMsC,WAAW,GAAGpB,MAAM,CAACc,eAAe,CAAC,CAACO,KAAK,CAAC;MAChD,CAACJ,cAAc,CAACK,iBAAiB,GAAG,IAAI,CAAC,CAACvC;IAC5C,CAAqB,CAAC;;IAEtB;IACA,MAAMwC,SAAS,GAAGH,WAAW,CAACI,OAAO,CAAC,IAAI,CAAC,CAACxC,QAAQ,CAAC;;IAErD;IACA,IAAI6B,MAAM,EAAEY,OAAO,EAAE;MACnB,MAAM,IAAIC,KAAK,CAAC,SAAS,CAAC;IAC5B;;IAEA;IACA;IACA,MAAMC,WAAgB,GAAG;MACvBC,SAAS,EAAE,IAAI,CAACC,OAAO,CAACC,QAAQ,IAAI,GAAG;MACvCC,cAAc,EAAE,IAAI,CAACC;IACvB,CAAC;;IAED;IACA,IAAI,IAAI,CAAC,CAAC9C,OAAO,IAAI+C,MAAM,CAACC,IAAI,CAAC,IAAI,CAAC,CAAChD,OAAO,CAAC,CAACiD,MAAM,GAAG,CAAC,EAAE;MAC1DR,WAAW,CAACS,QAAQ,GAAG,IAAI,CAAC,CAAClD,OAAO;IACtC;;IAEA;IACA,IAAI,IAAI,CAAC,CAACD,WAAW,IAAIgD,MAAM,CAACC,IAAI,CAAC,IAAI,CAAC,CAACjD,WAAW,CAAC,CAACkD,MAAM,GAAG,CAAC,EAAE;MAClER,WAAW,CAACU,MAAM,GAAG,IAAI,CAAC,CAACpD,WAAW;IACxC;IAEA,MAAMqD,QAAQ,GAAG,MAAMf,SAAS,CAACgB,SAAS,CAACZ,WAAW,CAAC;;IAEvD;IACA,IAAI,CAACK,aAAa,GAAGM,QAAQ,CAACN,aAAa;IAE3C,OAAOM,QAAQ;EACjB;;EAEA;AACF;AACA;EACEE,eAAeA,CACbC,MAAc,EACdrD,KAAmB,EACsB;IACzC,MAAMsD,KAAK,GAAGtD,KAAK,CAACuD,IAAI,CAAC,IAAI,CAACnD,QAAQ,CAAC;IAEvC,IAAIkD,KAAK,IAAIlE,SAAS,CAACI,SAAS,EAAE8D,KAAK,CAACE,KAAK,CAAC,EAAE;MAC9C,IAAI/C,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,EAAE;QACzC,IAAI,CAACE,MAAM,EAAEC,KAAK,CAAC;UAAE2C,UAAU,EAAE;QAAkB,CAAC,CAAC,CAACC,KAAK,CACzD,iDACF,CAAC;MACH;MACA,OAAO1D,KAAK,CAAC2D,KAAK,CAAC,IAAI,CAACvD,QAAQ,EAAEkD,KAAK,CAACE,KAAK,EAAEH,MAAM,CAAC;IACxD;IAEA,IAAI5C,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,EAAE;MACzC,IAAI,CAACE,MAAM,EAAEC,KAAK,CAAC;QAAE2C,UAAU,EAAE;MAAkB,CAAC,CAAC,CAACC,KAAK,CACzDvC,IAAI,CAACC,SAAS,CAAC;QAAEiC;MAAO,CAAC,CAC3B,CAAC;IACH;;IAEA;IACA,IAAI,CAACC,KAAK,IAAI,CAACA,KAAK,CAACE,KAAK,EAAE;MAC1B;IACF;IAEA,MAAMI,GAAG,GAAG5D,KAAK,CAAC6D,MAAM,CAAC,IAAI,CAACzD,QAAQ,EAAEiD,MAAM,CAAC;IAC/CrD,KAAK,CAACC,OAAO,CAAC6D,OAAO,CAAC3D,GAAG,CAAC,IAAI,CAACC,QAAQ,CAAC;IAExC,OAAOwD,GAAG;EACZ;;EAEA;AACF;AACA;EACEG,wBAAwB,GAAG,MACzB9D,OAAgB,IAEE;IAClB;IACA;IACA;;IAEA;IACA,IAAIA,OAAO,CAACC,QAAQ,CAAC8D,GAAG,CAAC,IAAI,CAAC5D,QAAQ,CAAC,EAAE;MACvC,OAAO,IAAI,CAAC6D,UAAU,CAAC,IAAI,CAAC;IAC9B;;IAEA;IACA,OAAOC,OAAO,CAACC,OAAO,CAAC,CAAC;EAC1B,CAAC;EAEDC,oBAAoB,GAAGA,CACrBC,UAAkB,EAClBpE,OAA4B,KACV;IAClB;IACA;IACA;;IAEA;IACA,IAAI,IAAI,CAAC,CAACP,aAAa,KAAK2E,UAAU,EAAE;MACtCpE,OAAO,EAAEC,QAAQ,CAACC,GAAG,CAAC,IAAI,CAACC,QAAQ,CAAC;MACpC,OAAO,IAAI,CAAC6D,UAAU,CAAC,IAAI,CAAC;IAC9B,CAAC,MAAM;MACL;MACA;MACA;MACA,OAAO,CAAC,YAAY;QAClB;QACA,MAAMpC,cAAc,GAAG,MAAM,IAAI,CAACvB,KAAK,CAACM,MAAM,CAACvB,iBAAiB,CAAC,CAC9DyC,gBAAgB,CAChBC,mBAAmB,CAAC,IAAI,CAAC,CAACrC,aAAa,CAAC;QAE3C,MAAM4E,OAAO,GAAGzC,cAAc,CAAC0C,KAAK,GAAG,IAAI,CAAC,CAAC3E,QAAQ,CAAC;QACtD,IAAI,CAAC0E,OAAO,IAAIA,OAAO,CAACE,UAAU,KAAKH,UAAU,EAAE;QAEnD,MAAMI,OAAO,GAAG,IAAI,CAACR,UAAU,CAAC,IAAI,CAAC;QACrChE,OAAO,EAAEC,QAAQ,CAACC,GAAG,CAAC,IAAI,CAACC,QAAQ,CAAC;QACpC,OAAOqE,OAAO;MAChB,CAAC,EAAE,CAAC;IACN;EACF,CAAC;AACH;;AAEA;AACA;AACA;AACA,OAAO,SAASC,sBAAsBA,CACpCC,GAAa,EACgB;EAC7B,OAAOA,GAAG,CAAChD,IAAI,KAAK,cAAc;AACpC","ignoreList":[]}

package/build/browser/observable/internal/list/InterfaceListQuery.js

@@ -0,0 +1,83 @@
+/*
+ * Copyright 2025 Palantir Technologies, Inc. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import groupBy from "object.groupby";
+import invariant from "tiny-invariant";
+import { ObjectDefRef, UnderlyingOsdkObject } from "../../../object/convertWireToOsdkObjects/InternalSymbols.js";
+import { ListQuery } from "./ListQuery.js";
+export class InterfaceListQuery extends ListQuery {
+  createObjectSet(store) {
+    return store.client({
+      type: "interface",
+      apiName: this.apiName
+    }).where(this.canonicalWhere);
+  }
+  async revalidateObjectType(apiName) {
+    const objectMetadata = await this.store.client.fetchMetadata({
+      type: "object",
+      apiName
+    });
+    if (this.apiName in objectMetadata.interfaceMap) {
+      await this.revalidate(/* force */true);
+    }
+  }
+  async postProcessFetchedData(data) {
+    return reloadDataAsFullObjects(this.store.client, data);
+  }
+  extractRelevantObjects(changes) {
+    const matchesApiName = ([, object]) => {
+      return this.apiName in object[ObjectDefRef].interfaceMap;
+    };
+    const added = Array.from(changes.addedObjects).filter(matchesApiName).map(([, object]) => object.$as(this.apiName));
+    const modified = Array.from(changes.modifiedObjects).filter(matchesApiName).map(([, object]) => object.$as(this.apiName));
+    return {
+      added: {
+        all: added,
+        strictMatches: new Set(),
+        sortaMatches: new Set()
+      },
+      modified: {
+        all: modified,
+        strictMatches: new Set(),
+        sortaMatches: new Set()
+      }
+    };
+  }
+}
+
+// Hopefully this can go away when we can just request the full object properties on first load
+async function reloadDataAsFullObjects(client, data) {
+  const groups = groupBy(data, x => x.$objectType);
+  const objectTypeToPrimaryKeyToObject = Object.fromEntries(await Promise.all(Object.entries(groups).map(async ([apiName, objects]) => {
+    // to keep InternalSimpleOsdkInstance simple, we make both the `ObjectDefRef` and
+    // the `InterfaceDefRef` optional but we know that the right one is on there
+    // thus we can `!`
+    const objectDef = objects[0][UnderlyingOsdkObject][ObjectDefRef];
+    const where = {
+      [objectDef.primaryKeyApiName]: {
+        $in: objects.map(x => x.$primaryKey)
+      }
+    };
+    const result = await client(objectDef).where(where).fetchPage();
+    return [apiName, Object.fromEntries(result.data.map(x => [x.$primaryKey, x]))];
+  })));
+  data = data.map(obj => {
+    !objectTypeToPrimaryKeyToObject[obj.$objectType][obj.$primaryKey] ? process.env.NODE_ENV !== "production" ? invariant(false, `Could not find object ${obj.$objectType} ${obj.$primaryKey}`) : invariant(false) : void 0;
+    return objectTypeToPrimaryKeyToObject[obj.$objectType][obj.$primaryKey];
+  });
+  return data;
+}
+//# sourceMappingURL=InterfaceListQuery.js.map

package/build/browser/observable/internal/list/InterfaceListQuery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"InterfaceListQuery.js","names":["groupBy","invariant","ObjectDefRef","UnderlyingOsdkObject","ListQuery","InterfaceListQuery","createObjectSet","store","client","type","apiName","where","canonicalWhere","revalidateObjectType","objectMetadata","fetchMetadata","interfaceMap","revalidate","postProcessFetchedData","data","reloadDataAsFullObjects","extractRelevantObjects","changes","matchesApiName","object","added","Array","from","addedObjects","filter","map","$as","modified","modifiedObjects","all","strictMatches","Set","sortaMatches","groups","x","$objectType","objectTypeToPrimaryKeyToObject","Object","fromEntries","Promise","entries","objects","objectDef","primaryKeyApiName","$in","$primaryKey","result","fetchPage","obj","process","env","NODE_ENV"],"sources":["InterfaceListQuery.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n  ObjectOrInterfaceDefinition,\n  ObjectSet,\n  ObjectTypeDefinition,\n  Osdk,\n} from \"@osdk/api\";\nimport groupBy from \"object.groupby\";\nimport invariant from \"tiny-invariant\";\nimport type { Client } from \"../../../Client.js\";\nimport type { InterfaceHolder } from \"../../../object/convertWireToOsdkObjects/InterfaceHolder.js\";\nimport {\n  ObjectDefRef,\n  UnderlyingOsdkObject,\n} from \"../../../object/convertWireToOsdkObjects/InternalSymbols.js\";\nimport type { ObjectHolder } from \"../../../object/convertWireToOsdkObjects/ObjectHolder.js\";\nimport type { Changes } from \"../Changes.js\";\nimport type { SimpleWhereClause } from \"../SimpleWhereClause.js\";\nimport type { Store } from \"../Store.js\";\nimport { ListQuery } from \"./ListQuery.js\";\n\ntype ExtractRelevantObjectsResult = Record<\"added\" | \"modified\", {\n  all: (ObjectHolder | InterfaceHolder)[];\n  strictMatches: Set<(ObjectHolder | InterfaceHolder)>;\n  sortaMatches: Set<(ObjectHolder | InterfaceHolder)>;\n}>;\n\nexport class InterfaceListQuery extends ListQuery {\n  protected createObjectSet(store: Store): ObjectSet<ObjectTypeDefinition> {\n    return store.client({\n      type: \"interface\" as const,\n      apiName: this.apiName,\n    } as ObjectOrInterfaceDefinition as ObjectTypeDefinition)\n      .where(this.canonicalWhere);\n  }\n\n  async revalidateObjectType(apiName: string): Promise<void> {\n    const objectMetadata = await this.store.client.fetchMetadata({\n      type: \"object\",\n      apiName,\n    });\n\n    if (this.apiName in objectMetadata.interfaceMap) {\n      await this.revalidate(/* force */ true);\n    }\n  }\n\n  protected async postProcessFetchedData(\n    data: Osdk.Instance<any>[],\n  ): Promise<Osdk.Instance<any>[]> {\n    return reloadDataAsFullObjects(this.store.client, data);\n  }\n\n  protected extractRelevantObjects(\n    changes: Changes,\n  ): ExtractRelevantObjectsResult {\n    const matchesApiName = ([, object]: [unknown, ObjectHolder]) => {\n      return this.apiName in object[ObjectDefRef].interfaceMap;\n    };\n\n    const added = Array.from(changes.addedObjects).filter(matchesApiName).map((\n      [, object],\n    ) => object.$as(this.apiName));\n\n    const modified = Array.from(changes.modifiedObjects).filter(matchesApiName)\n      .map((\n        [, object],\n      ) => object.$as(this.apiName));\n\n    return {\n      added: {\n        all: added,\n        strictMatches: new Set(),\n        sortaMatches: new Set(),\n      },\n      modified: {\n        all: modified,\n        strictMatches: new Set(),\n        sortaMatches: new Set(),\n      },\n    };\n  }\n}\n\n// Hopefully this can go away when we can just request the full object properties on first load\nasync function reloadDataAsFullObjects(\n  client: Client,\n  data: Osdk.Instance<any>[],\n) {\n  const groups = groupBy(data, (x) => x.$objectType);\n  const objectTypeToPrimaryKeyToObject = Object.fromEntries(\n    await Promise.all(\n      Object.entries(groups).map<\n        Promise<\n          [\n            /** objectType **/ string,\n            Record<string | number, Osdk.Instance<ObjectTypeDefinition>>,\n          ]\n        >\n      >(async ([apiName, objects]) => {\n        // to keep InternalSimpleOsdkInstance simple, we make both the `ObjectDefRef` and\n        // the `InterfaceDefRef` optional but we know that the right one is on there\n        // thus we can `!`\n        const objectDef = (objects[0] as ObjectHolder)[UnderlyingOsdkObject][\n          ObjectDefRef\n        ]!;\n        const where: SimpleWhereClause = {\n          [objectDef.primaryKeyApiName]: {\n            $in: objects.map(x => x.$primaryKey),\n          },\n        };\n\n        const result = await client(\n          objectDef as ObjectTypeDefinition,\n        ).where(where).fetchPage();\n        return [\n          apiName,\n          Object.fromEntries(result.data.map(\n            x => [x.$primaryKey, x],\n          )),\n        ];\n      }),\n    ),\n  );\n\n  data = data.map((obj) => {\n    invariant(\n      objectTypeToPrimaryKeyToObject[obj.$objectType][obj.$primaryKey],\n      `Could not find object ${obj.$objectType} ${obj.$primaryKey}`,\n    );\n    return objectTypeToPrimaryKeyToObject[obj.$objectType][obj.$primaryKey];\n  });\n\n  return data;\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAQA,OAAOA,OAAO,MAAM,gBAAgB;AACpC,OAAOC,SAAS,MAAM,gBAAgB;AAGtC,SACEC,YAAY,EACZC,oBAAoB,QACf,6DAA6D;AAKpE,SAASC,SAAS,QAAQ,gBAAgB;AAQ1C,OAAO,MAAMC,kBAAkB,SAASD,SAAS,CAAC;EACtCE,eAAeA,CAACC,KAAY,EAAmC;IACvE,OAAOA,KAAK,CAACC,MAAM,CAAC;MAClBC,IAAI,EAAE,WAAoB;MAC1BC,OAAO,EAAE,IAAI,CAACA;IAChB,CAAwD,CAAC,CACtDC,KAAK,CAAC,IAAI,CAACC,cAAc,CAAC;EAC/B;EAEA,MAAMC,oBAAoBA,CAACH,OAAe,EAAiB;IACzD,MAAMI,cAAc,GAAG,MAAM,IAAI,CAACP,KAAK,CAACC,MAAM,CAACO,aAAa,CAAC;MAC3DN,IAAI,EAAE,QAAQ;MACdC;IACF,CAAC,CAAC;IAEF,IAAI,IAAI,CAACA,OAAO,IAAII,cAAc,CAACE,YAAY,EAAE;MAC/C,MAAM,IAAI,CAACC,UAAU,CAAC,WAAY,IAAI,CAAC;IACzC;EACF;EAEA,MAAgBC,sBAAsBA,CACpCC,IAA0B,EACK;IAC/B,OAAOC,uBAAuB,CAAC,IAAI,CAACb,KAAK,CAACC,MAAM,EAAEW,IAAI,CAAC;EACzD;EAEUE,sBAAsBA,CAC9BC,OAAgB,EACc;IAC9B,MAAMC,cAAc,GAAGA,CAAC,GAAGC,MAAM,CAA0B,KAAK;MAC9D,OAAO,IAAI,CAACd,OAAO,IAAIc,MAAM,CAACtB,YAAY,CAAC,CAACc,YAAY;IAC1D,CAAC;IAED,MAAMS,KAAK,GAAGC,KAAK,CAACC,IAAI,CAACL,OAAO,CAACM,YAAY,CAAC,CAACC,MAAM,CAACN,cAAc,CAAC,CAACO,GAAG,CAAC,CACxE,GAAGN,MAAM,CAAC,KACPA,MAAM,CAACO,GAAG,CAAC,IAAI,CAACrB,OAAO,CAAC,CAAC;IAE9B,MAAMsB,QAAQ,GAAGN,KAAK,CAACC,IAAI,CAACL,OAAO,CAACW,eAAe,CAAC,CAACJ,MAAM,CAACN,cAAc,CAAC,CACxEO,GAAG,CAAC,CACH,GAAGN,MAAM,CAAC,KACPA,MAAM,CAACO,GAAG,CAAC,IAAI,CAACrB,OAAO,CAAC,CAAC;IAEhC,OAAO;MACLe,KAAK,EAAE;QACLS,GAAG,EAAET,KAAK;QACVU,aAAa,EAAE,IAAIC,GAAG,CAAC,CAAC;QACxBC,YAAY,EAAE,IAAID,GAAG,CAAC;MACxB,CAAC;MACDJ,QAAQ,EAAE;QACRE,GAAG,EAAEF,QAAQ;QACbG,aAAa,EAAE,IAAIC,GAAG,CAAC,CAAC;QACxBC,YAAY,EAAE,IAAID,GAAG,CAAC;MACxB;IACF,CAAC;EACH;AACF;;AAEA;AACA,eAAehB,uBAAuBA,CACpCZ,MAAc,EACdW,IAA0B,EAC1B;EACA,MAAMmB,MAAM,GAAGtC,OAAO,CAACmB,IAAI,EAAGoB,CAAC,IAAKA,CAAC,CAACC,WAAW,CAAC;EAClD,MAAMC,8BAA8B,GAAGC,MAAM,CAACC,WAAW,CACvD,MAAMC,OAAO,CAACV,GAAG,CACfQ,MAAM,CAACG,OAAO,CAACP,MAAM,CAAC,CAACR,GAAG,CAOxB,OAAO,CAACpB,OAAO,EAAEoC,OAAO,CAAC,KAAK;IAC9B;IACA;IACA;IACA,MAAMC,SAAS,GAAID,OAAO,CAAC,CAAC,CAAC,CAAkB3C,oBAAoB,CAAC,CAClED,YAAY,CACZ;IACF,MAAMS,KAAwB,GAAG;MAC/B,CAACoC,SAAS,CAACC,iBAAiB,GAAG;QAC7BC,GAAG,EAAEH,OAAO,CAAChB,GAAG,CAACS,CAAC,IAAIA,CAAC,CAACW,WAAW;MACrC;IACF,CAAC;IAED,MAAMC,MAAM,GAAG,MAAM3C,MAAM,CACzBuC,SACF,CAAC,CAACpC,KAAK,CAACA,KAAK,CAAC,CAACyC,SAAS,CAAC,CAAC;IAC1B,OAAO,CACL1C,OAAO,EACPgC,MAAM,CAACC,WAAW,CAACQ,MAAM,CAAChC,IAAI,CAACW,GAAG,CAChCS,CAAC,IAAI,CAACA,CAAC,CAACW,WAAW,EAAEX,CAAC,CACxB,CAAC,CAAC,CACH;EACH,CAAC,CACH,CACF,CAAC;EAEDpB,IAAI,GAAGA,IAAI,CAACW,GAAG,CAAEuB,GAAG,IAAK;IACvB,CACEZ,8BAA8B,CAACY,GAAG,CAACb,WAAW,CAAC,CAACa,GAAG,CAACH,WAAW,CAAC,GAAAI,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBADlEvD,SAAS,QAEP,yBAAyBoD,GAAG,CAACb,WAAW,IAAIa,GAAG,CAACH,WAAW,EAAE,IAF/DjD,SAAS;IAIT,OAAOwC,8BAA8B,CAACY,GAAG,CAACb,WAAW,CAAC,CAACa,GAAG,CAACH,WAAW,CAAC;EACzE,CAAC,CAAC;EAEF,OAAO/B,IAAI;AACb","ignoreList":[]}

package/build/browser/observable/internal/list/ListCacheKey.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ListCacheKey.js.map

package/build/browser/observable/internal/list/ListCacheKey.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ListCacheKey.js","names":[],"sources":["ListCacheKey.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { CollectionStorageData } from \"../base-list/BaseCollectionQuery.js\";\nimport type { CacheKey } from \"../CacheKey.js\";\nimport type { Canonical } from \"../Canonical.js\";\nimport type { SimpleWhereClause } from \"../SimpleWhereClause.js\";\nimport type { ListQuery } from \"./ListQuery.js\";\n\nexport interface ListStorageData extends CollectionStorageData {}\n\nexport interface ListCacheKey extends\n  CacheKey<\n    \"list\",\n    ListStorageData,\n    ListQuery,\n    [\n      type: \"object\" | \"interface\",\n      apiName: string,\n      whereClause: Canonical<SimpleWhereClause>,\n      orderByClause: Canonical<Record<string, \"asc\" | \"desc\" | undefined>>,\n    ]\n  >\n{\n}\n"],"mappings":"","ignoreList":[]}