@osdk/client 2.4.2 → 2.5.0-beta.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +106 -93
- package/build/browser/Client.js +1 -1
- package/build/browser/Client.js.map +1 -1
- package/build/browser/MinimalClientContext.js.map +1 -1
- package/build/browser/actions/applyAction.js +4 -0
- package/build/browser/actions/applyAction.js.map +1 -1
- package/build/browser/createClient.js +6 -2
- package/build/browser/createClient.js.map +1 -1
- package/build/browser/createMinimalClient.js +2 -1
- package/build/browser/createMinimalClient.js.map +1 -1
- package/build/browser/derivedProperties/createWithPropertiesObjectSet.js +17 -0
- package/build/browser/derivedProperties/createWithPropertiesObjectSet.js.map +1 -1
- package/build/browser/fetchMetadata.test.js +11 -0
- package/build/browser/fetchMetadata.test.js.map +1 -1
- package/build/browser/index.js +3 -1
- package/build/browser/index.js.map +1 -1
- package/build/browser/intellisense.test.helpers/orderBySuggestionIsRight.js +8 -1
- package/build/browser/intellisense.test.helpers/orderBySuggestionIsRight.js.map +1 -1
- package/build/browser/intellisense.test.js +14 -4
- package/build/browser/intellisense.test.js.map +1 -1
- package/build/browser/object/Cache.js +1 -1
- package/build/browser/object/Cache.js.map +1 -1
- package/build/browser/object/Cache.test.js +1 -1
- package/build/browser/object/Cache.test.js.map +1 -1
- package/build/browser/object/SimpleCache.js +1 -1
- package/build/browser/object/SimpleCache.js.map +1 -1
- package/build/browser/object/aggregate.js +2 -0
- package/build/browser/object/aggregate.js.map +1 -1
- package/build/browser/object/aggregate.test.js +30 -0
- package/build/browser/object/aggregate.test.js.map +1 -1
- package/build/browser/object/convertWireToOsdkObjects/OsdkCustomInspectPrototype.js +1 -0
- package/build/browser/object/convertWireToOsdkObjects/OsdkCustomInspectPrototype.js.map +1 -1
- package/build/browser/object/convertWireToOsdkObjects/createOsdkInterface.js +6 -0
- package/build/browser/object/convertWireToOsdkObjects/createOsdkInterface.js.map +1 -1
- package/build/browser/object/convertWireToOsdkObjects/getDollarLink.js +20 -1
- package/build/browser/object/convertWireToOsdkObjects/getDollarLink.js.map +1 -1
- package/build/browser/object/convertWireToOsdkObjects.js +4 -0
- package/build/browser/object/convertWireToOsdkObjects.js.map +1 -1
- package/build/browser/object/convertWireToOsdkObjects.test.js +14 -0
- package/build/browser/object/convertWireToOsdkObjects.test.js.map +1 -1
- package/build/browser/object/fetchPage.js +96 -21
- package/build/browser/object/fetchPage.js.map +1 -1
- package/build/browser/object/fetchPage.test.js +35 -1
- package/build/browser/object/fetchPage.test.js.map +1 -1
- package/build/browser/object/geotimeseriesreference.test.js +0 -2
- package/build/browser/object/geotimeseriesreference.test.js.map +1 -1
- package/build/browser/object/mediaUpload.js +3 -0
- package/build/browser/object/mediaUpload.js.map +1 -1
- package/build/browser/objectSet/ObjectSet.test.js +6 -0
- package/build/browser/objectSet/ObjectSet.test.js.map +1 -1
- package/build/browser/objectSet/ObjectSetListenerWebsocket.js +31 -9
- package/build/browser/objectSet/ObjectSetListenerWebsocket.js.map +1 -1
- package/build/browser/objectSet/ObjectSetListenerWebsocket.test.js +69 -4
- package/build/browser/objectSet/ObjectSetListenerWebsocket.test.js.map +1 -1
- package/build/browser/objectSet/createObjectSet.js +3 -1
- package/build/browser/objectSet/createObjectSet.js.map +1 -1
- package/build/browser/observable/LinkPayload.js +2 -0
- package/build/browser/observable/LinkPayload.js.map +1 -0
- package/build/browser/observable/ObjectPayload.js.map +1 -1
- package/build/browser/observable/ObservableClient/ObserveLink.js +17 -0
- package/build/browser/observable/ObservableClient/ObserveLink.js.map +1 -0
- package/build/browser/observable/ObservableClient/common.js +2 -0
- package/build/browser/observable/ObservableClient/common.js.map +1 -0
- package/build/browser/observable/ObservableClient.js +20 -0
- package/build/browser/observable/ObservableClient.js.map +1 -1
- package/build/browser/observable/Unsubscribable.js +2 -0
- package/build/browser/observable/Unsubscribable.js.map +1 -0
- package/build/browser/observable/internal/AbstractHelper.js +54 -0
- package/build/browser/observable/internal/AbstractHelper.js.map +1 -0
- package/build/browser/observable/internal/BatchContext.js +2 -0
- package/build/browser/observable/internal/BatchContext.js.map +1 -0
- package/build/browser/observable/internal/BulkObjectLoader.js +3 -3
- package/build/browser/observable/internal/BulkObjectLoader.js.map +1 -1
- package/build/browser/observable/internal/CacheKeys.js +65 -25
- package/build/browser/observable/internal/CacheKeys.js.map +1 -1
- package/build/browser/observable/internal/Changes.js +6 -0
- package/build/browser/observable/internal/Changes.js.map +1 -1
- package/build/browser/observable/internal/KnownCacheKey.js +2 -0
- package/build/browser/observable/internal/KnownCacheKey.js.map +1 -0
- package/build/browser/observable/internal/Layer.js +0 -8
- package/build/browser/observable/internal/Layer.js.map +1 -1
- package/build/browser/observable/internal/Layers.js +151 -0
- package/build/browser/observable/internal/Layers.js.map +1 -0
- package/build/browser/observable/internal/ObservableClientImpl.js +54 -3
- package/build/browser/observable/internal/ObservableClientImpl.js.map +1 -1
- package/build/browser/observable/internal/OrderByCanonicalizer.js +1 -37
- package/build/browser/observable/internal/OrderByCanonicalizer.js.map +1 -1
- package/build/browser/observable/internal/Queries.js +40 -0
- package/build/browser/observable/internal/Queries.js.map +1 -0
- package/build/browser/observable/internal/Query.js +45 -4
- package/build/browser/observable/internal/Query.js.map +1 -1
- package/build/browser/observable/internal/QuerySubscription.js +48 -0
- package/build/browser/observable/internal/QuerySubscription.js.map +1 -0
- package/build/browser/observable/internal/Store.invalidation.test.js +646 -0
- package/build/browser/observable/internal/Store.invalidation.test.js.map +1 -0
- package/build/browser/observable/internal/Store.js +87 -308
- package/build/browser/observable/internal/Store.js.map +1 -1
- package/build/browser/observable/internal/Store.test.js +330 -73
- package/build/browser/observable/internal/Store.test.js.map +1 -1
- package/build/browser/observable/internal/SubjectPayload.js +2 -0
- package/build/browser/observable/internal/SubjectPayload.js.map +1 -0
- package/build/browser/observable/internal/Subjects.js +55 -0
- package/build/browser/observable/internal/Subjects.js.map +1 -0
- package/build/browser/observable/internal/UnsubscribableWrapper.js +30 -0
- package/build/browser/observable/internal/UnsubscribableWrapper.js.map +1 -0
- package/build/browser/observable/internal/WeakRefTrie.js +61 -0
- package/build/browser/observable/internal/WeakRefTrie.js.map +1 -0
- package/build/browser/observable/internal/{ActionApplication.js → actions/ActionApplication.js} +2 -2
- package/build/browser/observable/internal/actions/ActionApplication.js.map +1 -0
- package/build/{esm/observable/internal → browser/observable/internal/actions}/OptimisticJob.js +15 -6
- package/build/browser/observable/internal/actions/OptimisticJob.js.map +1 -0
- package/build/browser/observable/internal/base-list/BaseCollectionQuery.js +2 -0
- package/build/browser/observable/internal/base-list/BaseCollectionQuery.js.map +1 -0
- package/build/browser/observable/internal/base-list/BaseListQuery.js +411 -0
- package/build/browser/observable/internal/base-list/BaseListQuery.js.map +1 -0
- package/build/browser/observable/internal/base-list/createCollectionConnectable.js +50 -0
- package/build/browser/observable/internal/base-list/createCollectionConnectable.js.map +1 -0
- package/build/browser/observable/internal/base-list/createCollectionConnectable.test.js +597 -0
- package/build/browser/observable/internal/base-list/createCollectionConnectable.test.js.map +1 -0
- package/build/browser/observable/internal/base-list/removeDuplicates.js +36 -0
- package/build/browser/observable/internal/base-list/removeDuplicates.js.map +1 -0
- package/build/browser/observable/internal/createInitEntry.js +25 -0
- package/build/browser/observable/internal/createInitEntry.js.map +1 -0
- package/build/browser/observable/internal/getObjectTypesThatInvalidate.js +216 -0
- package/build/browser/observable/internal/getObjectTypesThatInvalidate.js.map +1 -0
- package/build/browser/observable/internal/getObjectTypesThatInvalidate.test.js +382 -0
- package/build/browser/observable/internal/getObjectTypesThatInvalidate.test.js.map +1 -0
- package/build/browser/observable/internal/isObjectInstance.js +23 -0
- package/build/browser/observable/internal/isObjectInstance.js.map +1 -0
- package/build/browser/observable/internal/links/LinksHelper.js +37 -0
- package/build/browser/observable/internal/links/LinksHelper.js.map +1 -0
- package/build/browser/observable/internal/links/SpecificLinkCacheKey.js +2 -0
- package/build/browser/observable/internal/links/SpecificLinkCacheKey.js.map +1 -0
- package/build/browser/observable/internal/links/SpecificLinkQuery.js +185 -0
- package/build/browser/observable/internal/links/SpecificLinkQuery.js.map +1 -0
- package/build/browser/observable/internal/list/InterfaceListQuery.js +83 -0
- package/build/browser/observable/internal/list/InterfaceListQuery.js.map +1 -0
- package/build/browser/observable/internal/list/ListCacheKey.js +2 -0
- package/build/browser/observable/internal/list/ListCacheKey.js.map +1 -0
- package/build/browser/observable/internal/list/ListQuery.js +372 -0
- package/build/browser/observable/internal/list/ListQuery.js.map +1 -0
- package/build/browser/observable/internal/list/ListQueryOptions.js +2 -0
- package/build/browser/observable/internal/list/ListQueryOptions.js.map +1 -0
- package/build/browser/observable/internal/list/ListsHelper.js +51 -0
- package/build/browser/observable/internal/list/ListsHelper.js.map +1 -0
- package/build/browser/observable/internal/list/ObjectListQuery.js +48 -0
- package/build/browser/observable/internal/list/ObjectListQuery.js.map +1 -0
- package/build/browser/observable/internal/object/ObjectCacheKey.js +2 -0
- package/build/browser/observable/internal/object/ObjectCacheKey.js.map +1 -0
- package/build/browser/observable/internal/{ObjectQuery.js → object/ObjectQuery.js} +27 -18
- package/build/browser/observable/internal/object/ObjectQuery.js.map +1 -0
- package/build/browser/observable/internal/object/ObjectsHelper.js +48 -0
- package/build/browser/observable/internal/object/ObjectsHelper.js.map +1 -0
- package/build/browser/observable/internal/sorting/SortingStrategy.js +78 -0
- package/build/browser/observable/internal/sorting/SortingStrategy.js.map +1 -0
- package/build/browser/observable/internal/testUtils/invalidateList.js +23 -0
- package/build/browser/observable/internal/testUtils/invalidateList.js.map +1 -0
- package/build/browser/observable/internal/testUtils/observeLink/expectStandardObserveLink.js +69 -0
- package/build/browser/observable/internal/testUtils/observeLink/expectStandardObserveLink.js.map +1 -0
- package/build/browser/observable/internal/testUtils/observeObject/expectStandardObserveObject.js +56 -0
- package/build/browser/observable/internal/testUtils/observeObject/expectStandardObserveObject.js.map +1 -0
- package/build/browser/observable/internal/testUtils.js +72 -10
- package/build/browser/observable/internal/testUtils.js.map +1 -1
- package/build/browser/ontology/loadActionMetadata.js +3 -1
- package/build/browser/ontology/loadActionMetadata.js.map +1 -1
- package/build/browser/ontology/loadFullObjectMetadata.js +2 -1
- package/build/browser/ontology/loadFullObjectMetadata.js.map +1 -1
- package/build/browser/ontology/loadInterfaceMetadata.js +2 -1
- package/build/browser/ontology/loadInterfaceMetadata.js.map +1 -1
- package/build/browser/public/unstable-do-not-use.js.map +1 -1
- package/build/browser/util/UserAgent.js +2 -2
- package/build/browser/util/UserAgent.js.map +1 -1
- package/build/browser/util/exponentialBackoff.js +51 -0
- package/build/browser/util/exponentialBackoff.js.map +1 -0
- package/build/browser/util/exponentialBackoff.test.js +81 -0
- package/build/browser/util/exponentialBackoff.test.js.map +1 -0
- package/build/browser/util/extractObjectOrInterfaceType.js +9 -1
- package/build/browser/util/extractObjectOrInterfaceType.js.map +1 -1
- package/build/browser/util/extractObjectOrInterfaceType.test.js +2 -2
- package/build/browser/util/extractObjectOrInterfaceType.test.js.map +1 -1
- package/build/browser/util/streamutils.js +1 -1
- package/build/browser/util/streamutils.js.map +1 -1
- package/build/browser/util/toDataValue.js +15 -1
- package/build/browser/util/toDataValue.js.map +1 -1
- package/build/browser/util/toDataValue.test.js +42 -2
- package/build/browser/util/toDataValue.test.js.map +1 -1
- package/build/cjs/{chunk-633AI7EA.cjs → chunk-GVGP7T5P.cjs} +407 -257
- package/build/cjs/chunk-GVGP7T5P.cjs.map +1 -0
- package/build/cjs/{chunk-26WFEZQO.cjs → chunk-YADG7KA6.cjs} +136 -84
- package/build/cjs/chunk-YADG7KA6.cjs.map +1 -0
- package/build/cjs/{createClient-BJo8T7Js.d.cts → createClient-mOlFts15.d.cts} +1 -0
- package/build/cjs/index.cjs +11 -7
- package/build/cjs/index.d.cts +2 -2
- package/build/cjs/public/internal.cjs +8 -8
- package/build/cjs/public/unstable-do-not-use.cjs +1502 -851
- package/build/cjs/public/unstable-do-not-use.cjs.map +1 -1
- package/build/cjs/public/unstable-do-not-use.d.cts +183 -13
- package/build/esm/Client.js +1 -1
- package/build/esm/Client.js.map +1 -1
- package/build/esm/MinimalClientContext.js.map +1 -1
- package/build/esm/actions/applyAction.js +4 -0
- package/build/esm/actions/applyAction.js.map +1 -1
- package/build/esm/createClient.js +6 -2
- package/build/esm/createClient.js.map +1 -1
- package/build/esm/createMinimalClient.js +2 -1
- package/build/esm/createMinimalClient.js.map +1 -1
- package/build/esm/derivedProperties/createWithPropertiesObjectSet.js +17 -0
- package/build/esm/derivedProperties/createWithPropertiesObjectSet.js.map +1 -1
- package/build/esm/fetchMetadata.test.js +11 -0
- package/build/esm/fetchMetadata.test.js.map +1 -1
- package/build/esm/index.js +3 -1
- package/build/esm/index.js.map +1 -1
- package/build/esm/intellisense.test.helpers/orderBySuggestionIsRight.js +8 -1
- package/build/esm/intellisense.test.helpers/orderBySuggestionIsRight.js.map +1 -1
- package/build/esm/intellisense.test.js +14 -4
- package/build/esm/intellisense.test.js.map +1 -1
- package/build/esm/object/Cache.js +1 -1
- package/build/esm/object/Cache.js.map +1 -1
- package/build/esm/object/Cache.test.js +1 -1
- package/build/esm/object/Cache.test.js.map +1 -1
- package/build/esm/object/SimpleCache.js +1 -1
- package/build/esm/object/SimpleCache.js.map +1 -1
- package/build/esm/object/aggregate.js +2 -0
- package/build/esm/object/aggregate.js.map +1 -1
- package/build/esm/object/aggregate.test.js +30 -0
- package/build/esm/object/aggregate.test.js.map +1 -1
- package/build/esm/object/convertWireToOsdkObjects/OsdkCustomInspectPrototype.js +1 -0
- package/build/esm/object/convertWireToOsdkObjects/OsdkCustomInspectPrototype.js.map +1 -1
- package/build/esm/object/convertWireToOsdkObjects/createOsdkInterface.js +6 -0
- package/build/esm/object/convertWireToOsdkObjects/createOsdkInterface.js.map +1 -1
- package/build/esm/object/convertWireToOsdkObjects/getDollarLink.js +20 -1
- package/build/esm/object/convertWireToOsdkObjects/getDollarLink.js.map +1 -1
- package/build/esm/object/convertWireToOsdkObjects.js +4 -0
- package/build/esm/object/convertWireToOsdkObjects.js.map +1 -1
- package/build/esm/object/convertWireToOsdkObjects.test.js +14 -0
- package/build/esm/object/convertWireToOsdkObjects.test.js.map +1 -1
- package/build/esm/object/fetchPage.js +96 -21
- package/build/esm/object/fetchPage.js.map +1 -1
- package/build/esm/object/fetchPage.test.js +35 -1
- package/build/esm/object/fetchPage.test.js.map +1 -1
- package/build/esm/object/geotimeseriesreference.test.js +0 -2
- package/build/esm/object/geotimeseriesreference.test.js.map +1 -1
- package/build/esm/object/mediaUpload.js +3 -0
- package/build/esm/object/mediaUpload.js.map +1 -1
- package/build/esm/objectSet/ObjectSet.test.js +6 -0
- package/build/esm/objectSet/ObjectSet.test.js.map +1 -1
- package/build/esm/objectSet/ObjectSetListenerWebsocket.js +31 -9
- package/build/esm/objectSet/ObjectSetListenerWebsocket.js.map +1 -1
- package/build/esm/objectSet/ObjectSetListenerWebsocket.test.js +69 -4
- package/build/esm/objectSet/ObjectSetListenerWebsocket.test.js.map +1 -1
- package/build/esm/objectSet/createObjectSet.js +3 -1
- package/build/esm/objectSet/createObjectSet.js.map +1 -1
- package/build/esm/observable/LinkPayload.js +2 -0
- package/build/esm/observable/LinkPayload.js.map +1 -0
- package/build/esm/observable/ObjectPayload.js.map +1 -1
- package/build/esm/observable/ObservableClient/ObserveLink.js +17 -0
- package/build/esm/observable/ObservableClient/ObserveLink.js.map +1 -0
- package/build/esm/observable/ObservableClient/common.js +2 -0
- package/build/esm/observable/ObservableClient/common.js.map +1 -0
- package/build/esm/observable/ObservableClient.js +20 -0
- package/build/esm/observable/ObservableClient.js.map +1 -1
- package/build/esm/observable/Unsubscribable.js +2 -0
- package/build/esm/observable/Unsubscribable.js.map +1 -0
- package/build/esm/observable/internal/AbstractHelper.js +54 -0
- package/build/esm/observable/internal/AbstractHelper.js.map +1 -0
- package/build/esm/observable/internal/BatchContext.js +2 -0
- package/build/esm/observable/internal/BatchContext.js.map +1 -0
- package/build/esm/observable/internal/BulkObjectLoader.js +3 -3
- package/build/esm/observable/internal/BulkObjectLoader.js.map +1 -1
- package/build/esm/observable/internal/CacheKeys.js +65 -25
- package/build/esm/observable/internal/CacheKeys.js.map +1 -1
- package/build/esm/observable/internal/Changes.js +6 -0
- package/build/esm/observable/internal/Changes.js.map +1 -1
- package/build/esm/observable/internal/KnownCacheKey.js +2 -0
- package/build/esm/observable/internal/KnownCacheKey.js.map +1 -0
- package/build/esm/observable/internal/Layer.js +0 -8
- package/build/esm/observable/internal/Layer.js.map +1 -1
- package/build/esm/observable/internal/Layers.js +151 -0
- package/build/esm/observable/internal/Layers.js.map +1 -0
- package/build/esm/observable/internal/ObservableClientImpl.js +54 -3
- package/build/esm/observable/internal/ObservableClientImpl.js.map +1 -1
- package/build/esm/observable/internal/OrderByCanonicalizer.js +1 -37
- package/build/esm/observable/internal/OrderByCanonicalizer.js.map +1 -1
- package/build/esm/observable/internal/Queries.js +40 -0
- package/build/esm/observable/internal/Queries.js.map +1 -0
- package/build/esm/observable/internal/Query.js +45 -4
- package/build/esm/observable/internal/Query.js.map +1 -1
- package/build/esm/observable/internal/QuerySubscription.js +48 -0
- package/build/esm/observable/internal/QuerySubscription.js.map +1 -0
- package/build/esm/observable/internal/Store.invalidation.test.js +646 -0
- package/build/esm/observable/internal/Store.invalidation.test.js.map +1 -0
- package/build/esm/observable/internal/Store.js +87 -308
- package/build/esm/observable/internal/Store.js.map +1 -1
- package/build/esm/observable/internal/Store.test.js +330 -73
- package/build/esm/observable/internal/Store.test.js.map +1 -1
- package/build/esm/observable/internal/SubjectPayload.js +2 -0
- package/build/esm/observable/internal/SubjectPayload.js.map +1 -0
- package/build/esm/observable/internal/Subjects.js +55 -0
- package/build/esm/observable/internal/Subjects.js.map +1 -0
- package/build/esm/observable/internal/UnsubscribableWrapper.js +30 -0
- package/build/esm/observable/internal/UnsubscribableWrapper.js.map +1 -0
- package/build/esm/observable/internal/WeakRefTrie.js +61 -0
- package/build/esm/observable/internal/WeakRefTrie.js.map +1 -0
- package/build/esm/observable/internal/{ActionApplication.js → actions/ActionApplication.js} +2 -2
- package/build/esm/observable/internal/actions/ActionApplication.js.map +1 -0
- package/build/{browser/observable/internal → esm/observable/internal/actions}/OptimisticJob.js +15 -6
- package/build/esm/observable/internal/actions/OptimisticJob.js.map +1 -0
- package/build/esm/observable/internal/base-list/BaseCollectionQuery.js +2 -0
- package/build/esm/observable/internal/base-list/BaseCollectionQuery.js.map +1 -0
- package/build/esm/observable/internal/base-list/BaseListQuery.js +411 -0
- package/build/esm/observable/internal/base-list/BaseListQuery.js.map +1 -0
- package/build/esm/observable/internal/base-list/createCollectionConnectable.js +50 -0
- package/build/esm/observable/internal/base-list/createCollectionConnectable.js.map +1 -0
- package/build/esm/observable/internal/base-list/createCollectionConnectable.test.js +597 -0
- package/build/esm/observable/internal/base-list/createCollectionConnectable.test.js.map +1 -0
- package/build/esm/observable/internal/base-list/removeDuplicates.js +36 -0
- package/build/esm/observable/internal/base-list/removeDuplicates.js.map +1 -0
- package/build/esm/observable/internal/createInitEntry.js +25 -0
- package/build/esm/observable/internal/createInitEntry.js.map +1 -0
- package/build/esm/observable/internal/getObjectTypesThatInvalidate.js +216 -0
- package/build/esm/observable/internal/getObjectTypesThatInvalidate.js.map +1 -0
- package/build/esm/observable/internal/getObjectTypesThatInvalidate.test.js +382 -0
- package/build/esm/observable/internal/getObjectTypesThatInvalidate.test.js.map +1 -0
- package/build/esm/observable/internal/isObjectInstance.js +23 -0
- package/build/esm/observable/internal/isObjectInstance.js.map +1 -0
- package/build/esm/observable/internal/links/LinksHelper.js +37 -0
- package/build/esm/observable/internal/links/LinksHelper.js.map +1 -0
- package/build/esm/observable/internal/links/SpecificLinkCacheKey.js +2 -0
- package/build/esm/observable/internal/links/SpecificLinkCacheKey.js.map +1 -0
- package/build/esm/observable/internal/links/SpecificLinkQuery.js +185 -0
- package/build/esm/observable/internal/links/SpecificLinkQuery.js.map +1 -0
- package/build/esm/observable/internal/list/InterfaceListQuery.js +83 -0
- package/build/esm/observable/internal/list/InterfaceListQuery.js.map +1 -0
- package/build/esm/observable/internal/list/ListCacheKey.js +2 -0
- package/build/esm/observable/internal/list/ListCacheKey.js.map +1 -0
- package/build/esm/observable/internal/list/ListQuery.js +372 -0
- package/build/esm/observable/internal/list/ListQuery.js.map +1 -0
- package/build/esm/observable/internal/list/ListQueryOptions.js +2 -0
- package/build/esm/observable/internal/list/ListQueryOptions.js.map +1 -0
- package/build/esm/observable/internal/list/ListsHelper.js +51 -0
- package/build/esm/observable/internal/list/ListsHelper.js.map +1 -0
- package/build/esm/observable/internal/list/ObjectListQuery.js +48 -0
- package/build/esm/observable/internal/list/ObjectListQuery.js.map +1 -0
- package/build/esm/observable/internal/object/ObjectCacheKey.js +2 -0
- package/build/esm/observable/internal/object/ObjectCacheKey.js.map +1 -0
- package/build/esm/observable/internal/{ObjectQuery.js → object/ObjectQuery.js} +27 -18
- package/build/esm/observable/internal/object/ObjectQuery.js.map +1 -0
- package/build/esm/observable/internal/object/ObjectsHelper.js +48 -0
- package/build/esm/observable/internal/object/ObjectsHelper.js.map +1 -0
- package/build/esm/observable/internal/sorting/SortingStrategy.js +78 -0
- package/build/esm/observable/internal/sorting/SortingStrategy.js.map +1 -0
- package/build/esm/observable/internal/testUtils/invalidateList.js +23 -0
- package/build/esm/observable/internal/testUtils/invalidateList.js.map +1 -0
- package/build/esm/observable/internal/testUtils/observeLink/expectStandardObserveLink.js +69 -0
- package/build/esm/observable/internal/testUtils/observeLink/expectStandardObserveLink.js.map +1 -0
- package/build/esm/observable/internal/testUtils/observeObject/expectStandardObserveObject.js +56 -0
- package/build/esm/observable/internal/testUtils/observeObject/expectStandardObserveObject.js.map +1 -0
- package/build/esm/observable/internal/testUtils.js +72 -10
- package/build/esm/observable/internal/testUtils.js.map +1 -1
- package/build/esm/ontology/loadActionMetadata.js +3 -1
- package/build/esm/ontology/loadActionMetadata.js.map +1 -1
- package/build/esm/ontology/loadFullObjectMetadata.js +2 -1
- package/build/esm/ontology/loadFullObjectMetadata.js.map +1 -1
- package/build/esm/ontology/loadInterfaceMetadata.js +2 -1
- package/build/esm/ontology/loadInterfaceMetadata.js.map +1 -1
- package/build/esm/public/unstable-do-not-use.js.map +1 -1
- package/build/esm/util/UserAgent.js +2 -2
- package/build/esm/util/UserAgent.js.map +1 -1
- package/build/esm/util/exponentialBackoff.js +51 -0
- package/build/esm/util/exponentialBackoff.js.map +1 -0
- package/build/esm/util/exponentialBackoff.test.js +81 -0
- package/build/esm/util/exponentialBackoff.test.js.map +1 -0
- package/build/esm/util/extractObjectOrInterfaceType.js +9 -1
- package/build/esm/util/extractObjectOrInterfaceType.js.map +1 -1
- package/build/esm/util/extractObjectOrInterfaceType.test.js +2 -2
- package/build/esm/util/extractObjectOrInterfaceType.test.js.map +1 -1
- package/build/esm/util/streamutils.js +1 -1
- package/build/esm/util/streamutils.js.map +1 -1
- package/build/esm/util/toDataValue.js +15 -1
- package/build/esm/util/toDataValue.js.map +1 -1
- package/build/esm/util/toDataValue.test.js +42 -2
- package/build/esm/util/toDataValue.test.js.map +1 -1
- package/build/types/Client.d.ts +1 -1
- package/build/types/MinimalClientContext.d.ts +1 -0
- package/build/types/MinimalClientContext.d.ts.map +1 -1
- package/build/types/actions/applyAction.d.ts.map +1 -1
- package/build/types/createClient.d.ts +1 -0
- package/build/types/createClient.d.ts.map +1 -1
- package/build/types/index.d.ts +1 -1
- package/build/types/index.d.ts.map +1 -1
- package/build/types/object/fetchPage.d.ts.map +1 -1
- package/build/types/object/mediaUpload.d.ts +2 -1
- package/build/types/object/mediaUpload.d.ts.map +1 -1
- package/build/types/observable/LinkPayload.d.ts +9 -0
- package/build/types/observable/LinkPayload.d.ts.map +1 -0
- package/build/types/observable/ObjectPayload.d.ts +4 -0
- package/build/types/observable/ObjectPayload.d.ts.map +1 -1
- package/build/types/observable/ObservableClient/ObserveLink.d.ts +32 -0
- package/build/types/observable/ObservableClient/ObserveLink.d.ts.map +1 -0
- package/build/types/observable/ObservableClient/common.d.ts +67 -0
- package/build/types/observable/ObservableClient/common.d.ts.map +1 -0
- package/build/types/observable/ObservableClient.d.ts +103 -15
- package/build/types/observable/ObservableClient.d.ts.map +1 -1
- package/build/types/observable/Unsubscribable.d.ts +3 -0
- package/build/types/observable/Unsubscribable.d.ts.map +1 -0
- package/build/types/observable/internal/AbstractHelper.d.ts +17 -0
- package/build/types/observable/internal/AbstractHelper.d.ts.map +1 -0
- package/build/types/observable/internal/BatchContext.d.ts +11 -0
- package/build/types/observable/internal/BatchContext.d.ts.map +1 -0
- package/build/types/observable/internal/BulkObjectLoader.d.ts.map +1 -1
- package/build/types/observable/internal/CacheKeys.d.ts +12 -6
- package/build/types/observable/internal/CacheKeys.d.ts.map +1 -1
- package/build/types/observable/internal/Changes.d.ts +8 -5
- package/build/types/observable/internal/Changes.d.ts.map +1 -1
- package/build/types/observable/internal/KnownCacheKey.d.ts +4 -0
- package/build/types/observable/internal/KnownCacheKey.d.ts.map +1 -0
- package/build/types/observable/internal/Layer.d.ts +6 -7
- package/build/types/observable/internal/Layer.d.ts.map +1 -1
- package/build/types/observable/internal/Layers.d.ts +26 -0
- package/build/types/observable/internal/Layers.d.ts.map +1 -0
- package/build/types/observable/internal/OrderByCanonicalizer.d.ts +0 -7
- package/build/types/observable/internal/OrderByCanonicalizer.d.ts.map +1 -1
- package/build/types/observable/internal/Queries.d.ts +9 -0
- package/build/types/observable/internal/Queries.d.ts.map +1 -0
- package/build/types/observable/internal/Query.d.ts +23 -6
- package/build/types/observable/internal/Query.d.ts.map +1 -1
- package/build/types/observable/internal/QuerySubscription.d.ts +1 -0
- package/build/types/observable/internal/QuerySubscription.d.ts.map +1 -0
- package/build/types/observable/internal/Store.d.ts +41 -51
- package/build/types/observable/internal/Store.d.ts.map +1 -1
- package/build/types/observable/internal/Store.invalidation.test.d.ts +1 -0
- package/build/types/observable/internal/Store.invalidation.test.d.ts.map +1 -0
- package/build/types/observable/internal/Store.test.d.ts +4 -1
- package/build/types/observable/internal/Store.test.d.ts.map +1 -1
- package/build/types/observable/internal/SubjectPayload.d.ts +5 -0
- package/build/types/observable/internal/SubjectPayload.d.ts.map +1 -0
- package/build/types/observable/internal/Subjects.d.ts +16 -0
- package/build/types/observable/internal/Subjects.d.ts.map +1 -0
- package/build/types/observable/internal/UnsubscribableWrapper.d.ts +1 -0
- package/build/types/observable/internal/UnsubscribableWrapper.d.ts.map +1 -0
- package/build/types/observable/internal/WeakRefTrie.d.ts +13 -0
- package/build/types/observable/internal/WeakRefTrie.d.ts.map +1 -0
- package/build/types/observable/internal/{ActionApplication.d.ts → actions/ActionApplication.d.ts} +2 -2
- package/build/types/observable/internal/{ActionApplication.d.ts.map → actions/ActionApplication.d.ts.map} +1 -1
- package/build/types/observable/internal/{OptimisticJob.d.ts → actions/OptimisticJob.d.ts} +4 -4
- package/build/types/observable/internal/actions/OptimisticJob.d.ts.map +1 -0
- package/build/types/observable/internal/base-list/BaseCollectionQuery.d.ts +64 -0
- package/build/types/observable/internal/base-list/BaseCollectionQuery.d.ts.map +1 -0
- package/build/types/observable/internal/base-list/BaseListQuery.d.ts +145 -0
- package/build/types/observable/internal/base-list/BaseListQuery.d.ts.map +1 -0
- package/build/types/observable/internal/base-list/createCollectionConnectable.d.ts +39 -0
- package/build/types/observable/internal/base-list/createCollectionConnectable.d.ts.map +1 -0
- package/build/types/observable/internal/base-list/createCollectionConnectable.test.d.ts +1 -0
- package/build/types/observable/internal/base-list/createCollectionConnectable.test.d.ts.map +1 -0
- package/build/types/observable/internal/base-list/removeDuplicates.d.ts +11 -0
- package/build/types/observable/internal/base-list/removeDuplicates.d.ts.map +1 -0
- package/build/types/observable/internal/createInitEntry.d.ts +3 -0
- package/build/types/observable/internal/createInitEntry.d.ts.map +1 -0
- package/build/types/observable/internal/getObjectTypesThatInvalidate.d.ts +9 -0
- package/build/types/observable/internal/getObjectTypesThatInvalidate.d.ts.map +1 -0
- package/build/types/observable/internal/getObjectTypesThatInvalidate.test.d.ts +1 -0
- package/build/types/observable/internal/getObjectTypesThatInvalidate.test.d.ts.map +1 -0
- package/build/types/observable/internal/isObjectInstance.d.ts +5 -0
- package/build/types/observable/internal/isObjectInstance.d.ts.map +1 -0
- package/build/types/observable/internal/links/LinksHelper.d.ts +31 -0
- package/build/types/observable/internal/links/LinksHelper.d.ts.map +1 -0
- package/build/types/observable/internal/links/SpecificLinkCacheKey.d.ts +17 -0
- package/build/types/observable/internal/links/SpecificLinkCacheKey.d.ts.map +1 -0
- package/build/types/observable/internal/links/SpecificLinkQuery.d.ts +47 -0
- package/build/types/observable/internal/links/SpecificLinkQuery.d.ts.map +1 -0
- package/build/types/observable/internal/list/InterfaceListQuery.d.ts +18 -0
- package/build/types/observable/internal/list/InterfaceListQuery.d.ts.map +1 -0
- package/build/types/observable/internal/list/ListCacheKey.d.ts +7 -0
- package/build/types/observable/internal/list/ListCacheKey.d.ts.map +1 -0
- package/build/types/observable/internal/list/ListQuery.d.ts +106 -0
- package/build/types/observable/internal/list/ListQuery.d.ts.map +1 -0
- package/build/types/observable/internal/list/ListQueryOptions.d.ts +4 -0
- package/build/types/observable/internal/list/ListQueryOptions.d.ts.map +1 -0
- package/build/types/observable/internal/list/ListsHelper.d.ts +19 -0
- package/build/types/observable/internal/list/ListsHelper.d.ts.map +1 -0
- package/build/types/observable/internal/list/ObjectListQuery.d.ts +18 -0
- package/build/types/observable/internal/list/ObjectListQuery.d.ts.map +1 -0
- package/build/types/observable/internal/object/ObjectCacheKey.d.ts +5 -0
- package/build/types/observable/internal/object/ObjectCacheKey.d.ts.map +1 -0
- package/build/types/observable/internal/{ObjectQuery.d.ts → object/ObjectQuery.d.ts} +11 -9
- package/build/types/observable/internal/object/ObjectQuery.d.ts.map +1 -0
- package/build/types/observable/internal/object/ObjectsHelper.d.ts +11 -0
- package/build/types/observable/internal/object/ObjectsHelper.d.ts.map +1 -0
- package/build/types/observable/internal/sorting/SortingStrategy.d.ts +41 -0
- package/build/types/observable/internal/sorting/SortingStrategy.d.ts.map +1 -0
- package/build/types/observable/internal/testUtils/invalidateList.d.ts +9 -0
- package/build/types/observable/internal/testUtils/invalidateList.d.ts.map +1 -0
- package/build/types/observable/internal/testUtils/observeLink/expectStandardObserveLink.d.ts +46 -0
- package/build/types/observable/internal/testUtils/observeLink/expectStandardObserveLink.d.ts.map +1 -0
- package/build/types/observable/internal/testUtils/observeObject/expectStandardObserveObject.d.ts +26 -0
- package/build/types/observable/internal/testUtils/observeObject/expectStandardObserveObject.d.ts.map +1 -0
- package/build/types/observable/internal/testUtils.d.ts +26 -4
- package/build/types/observable/internal/testUtils.d.ts.map +1 -1
- package/build/types/public/unstable-do-not-use.d.ts +4 -2
- package/build/types/public/unstable-do-not-use.d.ts.map +1 -1
- package/build/types/util/exponentialBackoff.d.ts +14 -0
- package/build/types/util/exponentialBackoff.d.ts.map +1 -0
- package/build/types/util/exponentialBackoff.test.d.ts +1 -0
- package/build/types/util/exponentialBackoff.test.d.ts.map +1 -0
- package/package.json +27 -27
- package/build/browser/observable/internal/ActionApplication.js.map +0 -1
- package/build/browser/observable/internal/ListQuery.js +0 -618
- package/build/browser/observable/internal/ListQuery.js.map +0 -1
- package/build/browser/observable/internal/ObjectQuery.js.map +0 -1
- package/build/browser/observable/internal/OptimisticJob.js.map +0 -1
- package/build/cjs/chunk-26WFEZQO.cjs.map +0 -1
- package/build/cjs/chunk-633AI7EA.cjs.map +0 -1
- package/build/esm/observable/internal/ActionApplication.js.map +0 -1
- package/build/esm/observable/internal/ListQuery.js +0 -618
- package/build/esm/observable/internal/ListQuery.js.map +0 -1
- package/build/esm/observable/internal/ObjectQuery.js.map +0 -1
- package/build/esm/observable/internal/OptimisticJob.js.map +0 -1
- package/build/types/observable/internal/ListQuery.d.ts +0 -88
- package/build/types/observable/internal/ListQuery.d.ts.map +0 -1
- package/build/types/observable/internal/ObjectQuery.d.ts.map +0 -1
- package/build/types/observable/internal/OptimisticJob.d.ts.map +0 -1
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Copyright 2025 Palantir Technologies, Inc. All rights reserved.
|
|
3
|
+
*
|
|
4
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
* you may not use this file except in compliance with the License.
|
|
6
|
+
* You may obtain a copy of the License at
|
|
7
|
+
*
|
|
8
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
*
|
|
10
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
* See the License for the specific language governing permissions and
|
|
14
|
+
* limitations under the License.
|
|
15
|
+
*/
|
|
16
|
+
|
|
17
|
+
import { Trie } from "@wry/trie";
|
|
18
|
+
const defaultMakeData = () => Object.create(null);
|
|
19
|
+
|
|
20
|
+
/**
|
|
21
|
+
* The `WeakRefTrie` class uses weak references to store data, allowing for automatic garbage collection
|
|
22
|
+
* of entries that are no longer in use.
|
|
23
|
+
*
|
|
24
|
+
* The original trie from @wry/trie does not do automatic cleanup of old entries.
|
|
25
|
+
*/
|
|
26
|
+
export class WeakRefTrie {
|
|
27
|
+
#finalizer = new FinalizationRegistry(orderBy => {
|
|
28
|
+
this.#trie.removeArray(Object.entries(orderBy).flat());
|
|
29
|
+
});
|
|
30
|
+
#trie;
|
|
31
|
+
constructor(makeData = defaultMakeData) {
|
|
32
|
+
this.#trie = new Trie(false, array => {
|
|
33
|
+
const data = makeData(array);
|
|
34
|
+
this.#finalizer.register(data, array);
|
|
35
|
+
return new WeakRef(data);
|
|
36
|
+
});
|
|
37
|
+
}
|
|
38
|
+
lookupArray(array) {
|
|
39
|
+
const maybe = this.#trie.lookupArray(array);
|
|
40
|
+
let ret = maybe.deref();
|
|
41
|
+
if (maybe && !ret) {
|
|
42
|
+
// in case finalizer hasn't run
|
|
43
|
+
this.#trie.removeArray(array);
|
|
44
|
+
ret = this.#trie.lookupArray(array).deref();
|
|
45
|
+
}
|
|
46
|
+
return ret;
|
|
47
|
+
}
|
|
48
|
+
peekArray(array) {
|
|
49
|
+
const maybe = this.#trie.peekArray(array);
|
|
50
|
+
const ret = maybe?.deref();
|
|
51
|
+
if (maybe && !ret) {
|
|
52
|
+
// in case finalizer hasn't run
|
|
53
|
+
this.#trie.removeArray(array);
|
|
54
|
+
}
|
|
55
|
+
return ret;
|
|
56
|
+
}
|
|
57
|
+
removeArray(array) {
|
|
58
|
+
return this.#trie.removeArray(array)?.deref();
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
//# sourceMappingURL=WeakRefTrie.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"WeakRefTrie.js","names":["Trie","defaultMakeData","Object","create","WeakRefTrie","finalizer","FinalizationRegistry","orderBy","trie","removeArray","entries","flat","constructor","makeData","array","data","register","WeakRef","lookupArray","maybe","ret","deref","peekArray"],"sources":["WeakRefTrie.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 { Trie } from \"@wry/trie\";\n\nconst defaultMakeData = () => Object.create(null);\n\n/**\n * The `WeakRefTrie` class uses weak references to store data, allowing for automatic garbage collection\n * of entries that are no longer in use.\n *\n * The original trie from @wry/trie does not do automatic cleanup of old entries.\n */\nexport class WeakRefTrie<X extends object> {\n #finalizer = new FinalizationRegistry<\n Array<string>\n >((orderBy) => {\n this.#trie.removeArray(\n Object.entries(orderBy).flat(),\n );\n });\n\n #trie: Trie<WeakRef<X>>;\n\n constructor(makeData: (array: any[]) => X = defaultMakeData) {\n this.#trie = new Trie<WeakRef<X>>(\n false,\n (array) => {\n const data = makeData(array);\n this.#finalizer.register(data, array);\n return new WeakRef(data);\n },\n );\n }\n\n lookupArray<T extends IArguments | any[]>(array: T): X {\n const maybe = this.#trie.lookupArray(array);\n let ret = maybe.deref();\n if (maybe && !ret) {\n // in case finalizer hasn't run\n this.#trie.removeArray(array);\n ret = this.#trie.lookupArray(array).deref();\n }\n return ret!;\n }\n\n peekArray<T extends IArguments | any[]>(array: T): X | undefined {\n const maybe = this.#trie.peekArray(array);\n const ret = maybe?.deref();\n if (maybe && !ret) {\n // in case finalizer hasn't run\n this.#trie.removeArray(array);\n }\n return ret;\n }\n\n removeArray<T extends IArguments | any[]>(array: T): X | undefined {\n return this.#trie.removeArray(array)?.deref();\n }\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAASA,IAAI,QAAQ,WAAW;AAEhC,MAAMC,eAAe,GAAGA,CAAA,KAAMC,MAAM,CAACC,MAAM,CAAC,IAAI,CAAC;;AAEjD;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,WAAW,CAAmB;EACzC,CAACC,SAAS,GAAG,IAAIC,oBAAoB,CAElCC,OAAO,IAAK;IACb,IAAI,CAAC,CAACC,IAAI,CAACC,WAAW,CACpBP,MAAM,CAACQ,OAAO,CAACH,OAAO,CAAC,CAACI,IAAI,CAAC,CAC/B,CAAC;EACH,CAAC,CAAC;EAEF,CAACH,IAAI;EAELI,WAAWA,CAACC,QAA6B,GAAGZ,eAAe,EAAE;IAC3D,IAAI,CAAC,CAACO,IAAI,GAAG,IAAIR,IAAI,CACnB,KAAK,EACJc,KAAK,IAAK;MACT,MAAMC,IAAI,GAAGF,QAAQ,CAACC,KAAK,CAAC;MAC5B,IAAI,CAAC,CAACT,SAAS,CAACW,QAAQ,CAACD,IAAI,EAAED,KAAK,CAAC;MACrC,OAAO,IAAIG,OAAO,CAACF,IAAI,CAAC;IAC1B,CACF,CAAC;EACH;EAEAG,WAAWA,CAA+BJ,KAAQ,EAAK;IACrD,MAAMK,KAAK,GAAG,IAAI,CAAC,CAACX,IAAI,CAACU,WAAW,CAACJ,KAAK,CAAC;IAC3C,IAAIM,GAAG,GAAGD,KAAK,CAACE,KAAK,CAAC,CAAC;IACvB,IAAIF,KAAK,IAAI,CAACC,GAAG,EAAE;MACjB;MACA,IAAI,CAAC,CAACZ,IAAI,CAACC,WAAW,CAACK,KAAK,CAAC;MAC7BM,GAAG,GAAG,IAAI,CAAC,CAACZ,IAAI,CAACU,WAAW,CAACJ,KAAK,CAAC,CAACO,KAAK,CAAC,CAAC;IAC7C;IACA,OAAOD,GAAG;EACZ;EAEAE,SAASA,CAA+BR,KAAQ,EAAiB;IAC/D,MAAMK,KAAK,GAAG,IAAI,CAAC,CAACX,IAAI,CAACc,SAAS,CAACR,KAAK,CAAC;IACzC,MAAMM,GAAG,GAAGD,KAAK,EAAEE,KAAK,CAAC,CAAC;IAC1B,IAAIF,KAAK,IAAI,CAACC,GAAG,EAAE;MACjB;MACA,IAAI,CAAC,CAACZ,IAAI,CAACC,WAAW,CAACK,KAAK,CAAC;IAC/B;IACA,OAAOM,GAAG;EACZ;EAEAX,WAAWA,CAA+BK,KAAQ,EAAiB;IACjE,OAAO,IAAI,CAAC,CAACN,IAAI,CAACC,WAAW,CAACK,KAAK,CAAC,EAAEO,KAAK,CAAC,CAAC;EAC/C;AACF","ignoreList":[]}
|
|
@@ -86,8 +86,8 @@ export class ActionApplication {
|
|
|
86
86
|
objectType,
|
|
87
87
|
primaryKey
|
|
88
88
|
} of deletedObjects ?? []) {
|
|
89
|
-
const cacheKey = this.store.
|
|
90
|
-
this.store.
|
|
89
|
+
const cacheKey = this.store.cacheKeys.get("object", objectType, primaryKey);
|
|
90
|
+
this.store.queries.peek(cacheKey)?.deleteFromStore("loaded",
|
|
91
91
|
// this is probably not the best value to use
|
|
92
92
|
batch);
|
|
93
93
|
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ActionApplication.js","names":["runOptimisticJob","ACTION_DELAY","process","env","NODE_ENV","ActionApplication","constructor","store","applyAction","action","args","optimisticUpdate","logger","child","methodName","removeOptimisticResult","Array","isArray","debug","results","client","batchApplyAction","$returnEdits","invalidateActionEditResponse","actionResults","delay","default","#invalidateActionEditResponse","deletedObjects","modifiedObjects","addedObjects","editedObjectTypes","type","changes","promisesToWait","list","obj","push","invalidateObject","objectType","primaryKey","batch","cacheKey","cacheKeys","get","queries","peek","deleteFromStore","Promise","all","apiName","invalidateObjectType"],"sources":["ActionApplication.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 ActionDefinition,\n ActionEditResponse,\n ActionReturnTypeForOptions,\n} from \"@osdk/api\";\nimport type { ActionSignatureFromDef } from \"../../../actions/applyAction.js\";\nimport { type Changes } from \"../Changes.js\";\nimport type { ObjectCacheKey } from \"../object/ObjectCacheKey.js\";\nimport type { Store } from \"../Store.js\";\nimport { runOptimisticJob } from \"./OptimisticJob.js\";\n\nconst ACTION_DELAY = process.env.NODE_ENV === \"production\" ? 0 : 1000;\n\nexport class ActionApplication {\n constructor(private store: Store) {}\n\n applyAction: <Q extends ActionDefinition<any>>(\n action: Q,\n args:\n | Parameters<ActionSignatureFromDef<Q>[\"applyAction\"]>[0]\n | Array<Parameters<ActionSignatureFromDef<Q>[\"applyAction\"]>[0]>,\n opts?: Store.ApplyActionOptions,\n ) => Promise<ActionEditResponse> = async (\n action,\n args,\n { optimisticUpdate } = {},\n ) => {\n const logger = process.env.NODE_ENV !== \"production\"\n ? this.store.logger?.child({ methodName: \"applyAction\" })\n : this.store.logger;\n const removeOptimisticResult = runOptimisticJob(\n this.store,\n optimisticUpdate,\n );\n\n return await (async () => {\n try {\n if (Array.isArray(args)) {\n if (process.env.NODE_ENV !== \"production\") {\n logger?.debug(\"applying action to multiple args\", args);\n }\n\n const results: ActionReturnTypeForOptions<{ $returnEdits: true }> =\n await this.store\n .client(action).batchApplyAction(\n args,\n { $returnEdits: true },\n );\n\n await this.#invalidateActionEditResponse(results);\n\n return results;\n }\n\n // The types for client get confused when we dynamically applyAction so we\n // have to deal with the `any` here and force cast it to what it should be.\n // TODO: Update the types so this doesn't happen!\n\n const actionResults: ActionEditResponse = await this.store.client(\n action,\n ).applyAction(args as any, { $returnEdits: true });\n\n if (process.env.NODE_ENV !== \"production\") {\n if (ACTION_DELAY > 0) {\n logger?.debug(\"action done, pausing\", actionResults);\n const delay = (await import(\"delay\")).default;\n await delay(ACTION_DELAY);\n logger?.debug(\"action done, pausing done\");\n }\n }\n await this.#invalidateActionEditResponse(actionResults);\n return actionResults;\n } finally {\n if (process.env.NODE_ENV !== \"production\") {\n logger?.debug(\n \"optimistic action complete; remove the results\",\n );\n }\n // make sure this happens even if the action fails\n await removeOptimisticResult();\n }\n })();\n };\n\n #invalidateActionEditResponse = async (\n { deletedObjects, modifiedObjects, addedObjects, editedObjectTypes, type }:\n ActionEditResponse,\n ): Promise<void> => {\n let changes: Changes | undefined;\n if (type === \"edits\") {\n const promisesToWait: Promise<any>[] = [];\n\n for (const list of [deletedObjects, modifiedObjects, addedObjects]) {\n for (const obj of list ?? []) {\n promisesToWait.push(\n this.store.invalidateObject(obj.objectType, obj.primaryKey),\n );\n }\n }\n\n this.store.batch({}, (batch) => {\n for (const { objectType, primaryKey } of deletedObjects ?? []) {\n const cacheKey = this.store.cacheKeys.get<ObjectCacheKey>(\n \"object\",\n objectType,\n primaryKey,\n );\n this.store.queries.peek(cacheKey)?.deleteFromStore(\n \"loaded\", // this is probably not the best value to use\n batch,\n );\n }\n });\n await Promise.all(promisesToWait);\n } else {\n for (const apiName of editedObjectTypes) {\n await this.store.invalidateObjectType(apiName as string, changes);\n }\n }\n };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAWA,SAASA,gBAAgB,QAAQ,oBAAoB;AAErD,MAAMC,YAAY,GAAGC,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,GAAG,CAAC,GAAG,IAAI;AAErE,OAAO,MAAMC,iBAAiB,CAAC;EAC7BC,WAAWA,CAASC,KAAY,EAAE;IAAA,KAAdA,KAAY,GAAZA,KAAY;EAAG;EAEnCC,WAAW,GAMwB,MAAAA,CACjCC,MAAM,EACNC,IAAI,EACJ;IAAEC;EAAiB,CAAC,GAAG,CAAC,CAAC,KACtB;IACH,MAAMC,MAAM,GAAGV,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,GAChD,IAAI,CAACG,KAAK,CAACK,MAAM,EAAEC,KAAK,CAAC;MAAEC,UAAU,EAAE;IAAc,CAAC,CAAC,GACvD,IAAI,CAACP,KAAK,CAACK,MAAM;IACrB,MAAMG,sBAAsB,GAAGf,gBAAgB,CAC7C,IAAI,CAACO,KAAK,EACVI,gBACF,CAAC;IAED,OAAO,MAAM,CAAC,YAAY;MACxB,IAAI;QACF,IAAIK,KAAK,CAACC,OAAO,CAACP,IAAI,CAAC,EAAE;UACvB,IAAIR,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,EAAE;YACzCQ,MAAM,EAAEM,KAAK,CAAC,kCAAkC,EAAER,IAAI,CAAC;UACzD;UAEA,MAAMS,OAA2D,GAC/D,MAAM,IAAI,CAACZ,KAAK,CACba,MAAM,CAACX,MAAM,CAAC,CAACY,gBAAgB,CAC9BX,IAAI,EACJ;YAAEY,YAAY,EAAE;UAAK,CACvB,CAAC;UAEL,MAAM,IAAI,CAAC,CAACC,4BAA4B,CAACJ,OAAO,CAAC;UAEjD,OAAOA,OAAO;QAChB;;QAEA;QACA;QACA;;QAEA,MAAMK,aAAiC,GAAG,MAAM,IAAI,CAACjB,KAAK,CAACa,MAAM,CAC/DX,MACF,CAAC,CAACD,WAAW,CAACE,IAAI,EAAS;UAAEY,YAAY,EAAE;QAAK,CAAC,CAAC;QAElD,IAAIpB,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,EAAE;UACzC,IAAIH,YAAY,GAAG,CAAC,EAAE;YACpBW,MAAM,EAAEM,KAAK,CAAC,sBAAsB,EAAEM,aAAa,CAAC;YACpD,MAAMC,KAAK,GAAG,CAAC,MAAM,MAAM,CAAC,OAAO,CAAC,EAAEC,OAAO;YAC7C,MAAMD,KAAK,CAACxB,YAAY,CAAC;YACzBW,MAAM,EAAEM,KAAK,CAAC,2BAA2B,CAAC;UAC5C;QACF;QACA,MAAM,IAAI,CAAC,CAACK,4BAA4B,CAACC,aAAa,CAAC;QACvD,OAAOA,aAAa;MACtB,CAAC,SAAS;QACR,IAAItB,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,EAAE;UACzCQ,MAAM,EAAEM,KAAK,CACX,gDACF,CAAC;QACH;QACA;QACA,MAAMH,sBAAsB,CAAC,CAAC;MAChC;IACF,CAAC,EAAE,CAAC;EACN,CAAC;EAED,CAACQ,4BAA4B,GAAG,MAAAI,CAC9B;IAAEC,cAAc;IAAEC,eAAe;IAAEC,YAAY;IAAEC,iBAAiB;IAAEC;EACjD,CAAC,KACF;IAClB,IAAIC,OAA4B;IAChC,IAAID,IAAI,KAAK,OAAO,EAAE;MACpB,MAAME,cAA8B,GAAG,EAAE;MAEzC,KAAK,MAAMC,IAAI,IAAI,CAACP,cAAc,EAAEC,eAAe,EAAEC,YAAY,CAAC,EAAE;QAClE,KAAK,MAAMM,GAAG,IAAID,IAAI,IAAI,EAAE,EAAE;UAC5BD,cAAc,CAACG,IAAI,CACjB,IAAI,CAAC9B,KAAK,CAAC+B,gBAAgB,CAACF,GAAG,CAACG,UAAU,EAAEH,GAAG,CAACI,UAAU,CAC5D,CAAC;QACH;MACF;MAEA,IAAI,CAACjC,KAAK,CAACkC,KAAK,CAAC,CAAC,CAAC,EAAGA,KAAK,IAAK;QAC9B,KAAK,MAAM;UAAEF,UAAU;UAAEC;QAAW,CAAC,IAAIZ,cAAc,IAAI,EAAE,EAAE;UAC7D,MAAMc,QAAQ,GAAG,IAAI,CAACnC,KAAK,CAACoC,SAAS,CAACC,GAAG,CACvC,QAAQ,EACRL,UAAU,EACVC,UACF,CAAC;UACD,IAAI,CAACjC,KAAK,CAACsC,OAAO,CAACC,IAAI,CAACJ,QAAQ,CAAC,EAAEK,eAAe,CAChD,QAAQ;UAAE;UACVN,KACF,CAAC;QACH;MACF,CAAC,CAAC;MACF,MAAMO,OAAO,CAACC,GAAG,CAACf,cAAc,CAAC;IACnC,CAAC,MAAM;MACL,KAAK,MAAMgB,OAAO,IAAInB,iBAAiB,EAAE;QACvC,MAAM,IAAI,CAACxB,KAAK,CAAC4C,oBAAoB,CAACD,OAAO,EAAYjB,OAAO,CAAC;MACnE;IACF;EACF,CAAC;AACH","ignoreList":[]}
|
package/build/{browser/observable/internal → esm/observable/internal/actions}/OptimisticJob.js
RENAMED
|
@@ -14,8 +14,8 @@
|
|
|
14
14
|
* limitations under the License.
|
|
15
15
|
*/
|
|
16
16
|
|
|
17
|
-
import { additionalContext } from "
|
|
18
|
-
import { createOptimisticId } from "
|
|
17
|
+
import { additionalContext } from "../../../Client.js";
|
|
18
|
+
import { createOptimisticId } from "../OptimisticId.js";
|
|
19
19
|
export class OptimisticJob {
|
|
20
20
|
#result;
|
|
21
21
|
constructor(store, optimisticId) {
|
|
@@ -41,17 +41,26 @@ export class OptimisticJob {
|
|
|
41
41
|
}, batch => {
|
|
42
42
|
for (const obj of addedObjects) {
|
|
43
43
|
if (obj.status === "fulfilled") {
|
|
44
|
-
store.
|
|
44
|
+
store.objects.getQuery({
|
|
45
|
+
apiName: obj.value.$objectType,
|
|
46
|
+
pk: obj.value.$primaryKey
|
|
47
|
+
}).writeToStore(obj.value, "loading", batch);
|
|
45
48
|
} else {
|
|
46
49
|
// TODO FIXME
|
|
47
50
|
throw obj;
|
|
48
51
|
}
|
|
49
52
|
}
|
|
50
53
|
for (const obj of updatedObjects) {
|
|
51
|
-
store.
|
|
54
|
+
store.objects.getQuery({
|
|
55
|
+
apiName: obj.$objectType,
|
|
56
|
+
pk: obj.$primaryKey
|
|
57
|
+
}).writeToStore(obj, "loading", batch);
|
|
52
58
|
}
|
|
53
59
|
for (const obj of deletedObjects) {
|
|
54
|
-
store.
|
|
60
|
+
store.objects.getQuery({
|
|
61
|
+
apiName: obj.$objectType,
|
|
62
|
+
pk: obj.$primaryKey
|
|
63
|
+
}).deleteFromStore("loading", batch);
|
|
55
64
|
}
|
|
56
65
|
});
|
|
57
66
|
return batchResult.changes;
|
|
@@ -93,7 +102,7 @@ export function runOptimisticJob(store, optimisticUpdate) {
|
|
|
93
102
|
return optimisticApplicationDone.then(
|
|
94
103
|
// we don't want to leak the result
|
|
95
104
|
() => undefined).finally(() => {
|
|
96
|
-
store.
|
|
105
|
+
store.layers.remove(optimisticId);
|
|
97
106
|
});
|
|
98
107
|
};
|
|
99
108
|
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"OptimisticJob.js","names":["additionalContext","createOptimisticId","OptimisticJob","result","constructor","store","optimisticId","updatedObjects","addedObjectPromises","deletedObjects","getResult","addedObjects","Promise","allSettled","batchResult","batch","obj","status","objects","getQuery","apiName","value","$objectType","pk","$primaryKey","writeToStore","deleteFromStore","changes","context","updateObject","push","createObject","type","properties","create","client","objectFactory2","$apiName","undefined","then","objs","deleteObject","runOptimisticJob","optimisticUpdate","resolve","job","optimisticApplicationDone","finally","layers","remove"],"sources":["OptimisticJob.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 { additionalContext } from \"../../../Client.js\";\nimport type { ObjectHolder } from \"../../../object/convertWireToOsdkObjects/ObjectHolder.js\";\nimport type { OptimisticBuilder } from \"../../OptimisticBuilder.js\";\nimport { type Changes } from \"../Changes.js\";\nimport { createOptimisticId, type OptimisticId } from \"../OptimisticId.js\";\nimport type { Store } from \"../Store.js\";\n\nexport class OptimisticJob {\n context: OptimisticBuilder;\n getResult: () => Promise<Changes>;\n #result!: Promise<Changes>;\n\n constructor(store: Store, optimisticId: OptimisticId) {\n const updatedObjects: Array<\n ObjectHolder\n > = [];\n\n // due to potentially needing to fetch the object metadata,\n // the creation of objects needs to be async. In practice, the\n // metadata is cached.\n const addedObjectPromises: Array<\n Promise<ObjectHolder>\n > = [];\n\n const deletedObjects: Array<ObjectHolder> = [];\n\n // TODO, this code needs to be refactored. its weird right now\n // but the contract for `runOptimisticJob` is good.\n\n // todo memoize this\n this.getResult = () => {\n return this.#result ??= (async () => {\n const addedObjects = await Promise.allSettled(\n addedObjectPromises,\n );\n\n const { batchResult } = store.batch({ optimisticId }, (batch) => {\n for (const obj of addedObjects) {\n if (obj.status === \"fulfilled\") {\n store.objects.getQuery({\n apiName: obj.value.$objectType,\n pk: obj.value.$primaryKey,\n }).writeToStore(obj.value, \"loading\", batch);\n } else {\n // TODO FIXME\n throw obj;\n }\n }\n\n for (const obj of updatedObjects) {\n store.objects.getQuery({\n apiName: obj.$objectType,\n pk: obj.$primaryKey,\n }).writeToStore(obj, \"loading\", batch);\n }\n\n for (const obj of deletedObjects) {\n store.objects.getQuery({\n apiName: obj.$objectType,\n pk: obj.$primaryKey,\n }).deleteFromStore(\"loading\", batch);\n }\n });\n\n return batchResult.changes;\n })();\n };\n\n this.context = {\n updateObject(value) {\n updatedObjects.push(value as unknown as ObjectHolder<typeof value>);\n return this;\n },\n createObject(type, pk, properties) {\n const create = store.client[additionalContext].objectFactory2(\n store.client[additionalContext],\n [{\n $primaryKey: pk,\n $apiName: type.apiName,\n $objectType: type.apiName,\n ...properties,\n }],\n undefined,\n {},\n ).then(objs => {\n return objs[0];\n });\n\n addedObjectPromises.push(create);\n return this;\n },\n deleteObject(value) {\n deletedObjects.push(value as unknown as ObjectHolder<typeof value>);\n return this;\n },\n };\n }\n}\n\nexport function runOptimisticJob(\n store: Store,\n optimisticUpdate: undefined | ((ctx: OptimisticBuilder) => void),\n): () => Promise<void> {\n if (!optimisticUpdate) {\n return () => Promise.resolve();\n }\n\n const optimisticId = createOptimisticId();\n const job = new OptimisticJob(store, optimisticId);\n optimisticUpdate(job.context);\n const optimisticApplicationDone = job.getResult();\n\n return () => {\n return optimisticApplicationDone.then(\n // we don't want to leak the result\n () => undefined,\n ).finally(() => {\n store.layers.remove(optimisticId);\n });\n };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAASA,iBAAiB,QAAQ,oBAAoB;AAItD,SAASC,kBAAkB,QAA2B,oBAAoB;AAG1E,OAAO,MAAMC,aAAa,CAAC;EAGzB,CAACC,MAAM;EAEPC,WAAWA,CAACC,KAAY,EAAEC,YAA0B,EAAE;IACpD,MAAMC,cAEL,GAAG,EAAE;;IAEN;IACA;IACA;IACA,MAAMC,mBAEL,GAAG,EAAE;IAEN,MAAMC,cAAmC,GAAG,EAAE;;IAE9C;IACA;;IAEA;IACA,IAAI,CAACC,SAAS,GAAG,MAAM;MACrB,OAAO,IAAI,CAAC,CAACP,MAAM,KAAK,CAAC,YAAY;QACnC,MAAMQ,YAAY,GAAG,MAAMC,OAAO,CAACC,UAAU,CAC3CL,mBACF,CAAC;QAED,MAAM;UAAEM;QAAY,CAAC,GAAGT,KAAK,CAACU,KAAK,CAAC;UAAET;QAAa,CAAC,EAAGS,KAAK,IAAK;UAC/D,KAAK,MAAMC,GAAG,IAAIL,YAAY,EAAE;YAC9B,IAAIK,GAAG,CAACC,MAAM,KAAK,WAAW,EAAE;cAC9BZ,KAAK,CAACa,OAAO,CAACC,QAAQ,CAAC;gBACrBC,OAAO,EAAEJ,GAAG,CAACK,KAAK,CAACC,WAAW;gBAC9BC,EAAE,EAAEP,GAAG,CAACK,KAAK,CAACG;cAChB,CAAC,CAAC,CAACC,YAAY,CAACT,GAAG,CAACK,KAAK,EAAE,SAAS,EAAEN,KAAK,CAAC;YAC9C,CAAC,MAAM;cACL;cACA,MAAMC,GAAG;YACX;UACF;UAEA,KAAK,MAAMA,GAAG,IAAIT,cAAc,EAAE;YAChCF,KAAK,CAACa,OAAO,CAACC,QAAQ,CAAC;cACrBC,OAAO,EAAEJ,GAAG,CAACM,WAAW;cACxBC,EAAE,EAAEP,GAAG,CAACQ;YACV,CAAC,CAAC,CAACC,YAAY,CAACT,GAAG,EAAE,SAAS,EAAED,KAAK,CAAC;UACxC;UAEA,KAAK,MAAMC,GAAG,IAAIP,cAAc,EAAE;YAChCJ,KAAK,CAACa,OAAO,CAACC,QAAQ,CAAC;cACrBC,OAAO,EAAEJ,GAAG,CAACM,WAAW;cACxBC,EAAE,EAAEP,GAAG,CAACQ;YACV,CAAC,CAAC,CAACE,eAAe,CAAC,SAAS,EAAEX,KAAK,CAAC;UACtC;QACF,CAAC,CAAC;QAEF,OAAOD,WAAW,CAACa,OAAO;MAC5B,CAAC,EAAE,CAAC;IACN,CAAC;IAED,IAAI,CAACC,OAAO,GAAG;MACbC,YAAYA,CAACR,KAAK,EAAE;QAClBd,cAAc,CAACuB,IAAI,CAACT,KAA8C,CAAC;QACnE,OAAO,IAAI;MACb,CAAC;MACDU,YAAYA,CAACC,IAAI,EAAET,EAAE,EAAEU,UAAU,EAAE;QACjC,MAAMC,MAAM,GAAG7B,KAAK,CAAC8B,MAAM,CAACnC,iBAAiB,CAAC,CAACoC,cAAc,CAC3D/B,KAAK,CAAC8B,MAAM,CAACnC,iBAAiB,CAAC,EAC/B,CAAC;UACCwB,WAAW,EAAED,EAAE;UACfc,QAAQ,EAAEL,IAAI,CAACZ,OAAO;UACtBE,WAAW,EAAEU,IAAI,CAACZ,OAAO;UACzB,GAAGa;QACL,CAAC,CAAC,EACFK,SAAS,EACT,CAAC,CACH,CAAC,CAACC,IAAI,CAACC,IAAI,IAAI;UACb,OAAOA,IAAI,CAAC,CAAC,CAAC;QAChB,CAAC,CAAC;QAEFhC,mBAAmB,CAACsB,IAAI,CAACI,MAAM,CAAC;QAChC,OAAO,IAAI;MACb,CAAC;MACDO,YAAYA,CAACpB,KAAK,EAAE;QAClBZ,cAAc,CAACqB,IAAI,CAACT,KAA8C,CAAC;QACnE,OAAO,IAAI;MACb;IACF,CAAC;EACH;AACF;AAEA,OAAO,SAASqB,gBAAgBA,CAC9BrC,KAAY,EACZsC,gBAAgE,EAC3C;EACrB,IAAI,CAACA,gBAAgB,EAAE;IACrB,OAAO,MAAM/B,OAAO,CAACgC,OAAO,CAAC,CAAC;EAChC;EAEA,MAAMtC,YAAY,GAAGL,kBAAkB,CAAC,CAAC;EACzC,MAAM4C,GAAG,GAAG,IAAI3C,aAAa,CAACG,KAAK,EAAEC,YAAY,CAAC;EAClDqC,gBAAgB,CAACE,GAAG,CAACjB,OAAO,CAAC;EAC7B,MAAMkB,yBAAyB,GAAGD,GAAG,CAACnC,SAAS,CAAC,CAAC;EAEjD,OAAO,MAAM;IACX,OAAOoC,yBAAyB,CAACP,IAAI;IACnC;IACA,MAAMD,SACR,CAAC,CAACS,OAAO,CAAC,MAAM;MACd1C,KAAK,CAAC2C,MAAM,CAACC,MAAM,CAAC3C,YAAY,CAAC;IACnC,CAAC,CAAC;EACJ,CAAC;AACH","ignoreList":[]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"BaseCollectionQuery.js","names":[],"sources":["BaseCollectionQuery.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 { InterfaceHolder } from \"../../../object/convertWireToOsdkObjects/InterfaceHolder.js\";\nimport type { ObjectHolder } from \"../../../object/convertWireToOsdkObjects/ObjectHolder.js\";\nimport type { Status } from \"../../ObservableClient/common.js\";\nimport { type ObjectCacheKey } from \"../object/ObjectCacheKey.js\";\n\n/**\n * Abstract base for ListQuery and SpecificLinkQuery.\n * - Stores object references, not duplicates\n * - Implements shared pagination and reference counting\n * - Template method pattern for collection operations\n */\nexport interface CollectionStorageData {\n data: ObjectCacheKey[];\n}\n\n/**\n * Base interface for collection-based payloads (lists and links)\n * Contains the common properties shared by all collection payload types\n */\nexport interface BaseCollectionPayload {\n /**\n * The resolved collection of objects\n */\n resolvedList: Array<ObjectHolder | InterfaceHolder>;\n\n /**\n * Whether the data is from an optimistic update\n */\n isOptimistic: boolean;\n\n /**\n * Function to fetch more items when available\n */\n fetchMore: () => Promise<void>;\n\n /**\n * Whether there are more items available to fetch\n */\n hasMore: boolean;\n\n /**\n * Current loading status\n */\n status: Status;\n\n /**\n * Timestamp of when the data was last updated\n */\n lastUpdated: number;\n}\n\n/**\n * Common parameters available for constructing a collection payload\n */\nexport interface CollectionConnectableParams {\n /**\n * Array of resolved objects\n */\n resolvedData: any[];\n\n /**\n * Whether the data is from an optimistic update\n */\n isOptimistic: boolean;\n\n /**\n * Current loading status\n */\n status: Status;\n\n /**\n * Timestamp of the last update\n */\n lastUpdated: number;\n}\n"],"mappings":"","ignoreList":[]}
|
|
@@ -0,0 +1,411 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Copyright 2025 Palantir Technologies, Inc. All rights reserved.
|
|
3
|
+
*
|
|
4
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
* you may not use this file except in compliance with the License.
|
|
6
|
+
* You may obtain a copy of the License at
|
|
7
|
+
*
|
|
8
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
*
|
|
10
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
* See the License for the specific language governing permissions and
|
|
14
|
+
* limitations under the License.
|
|
15
|
+
*/
|
|
16
|
+
|
|
17
|
+
import deepEqual from "fast-deep-equal";
|
|
18
|
+
import { DEBUG_ONLY__cacheKeysToString } from "../CacheKey.js";
|
|
19
|
+
import { isObjectInstance } from "../isObjectInstance.js";
|
|
20
|
+
import { Query } from "../Query.js";
|
|
21
|
+
import { NoOpSortingStrategy } from "../sorting/SortingStrategy.js";
|
|
22
|
+
import { createCollectionConnectable } from "./createCollectionConnectable.js";
|
|
23
|
+
import { removeDuplicates } from "./removeDuplicates.js";
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* Base class for collection-based queries (lists and links)
|
|
27
|
+
* Provides common functionality for working with collections of objects
|
|
28
|
+
*/
|
|
29
|
+
export class BaseListQuery extends Query {
|
|
30
|
+
/**
|
|
31
|
+
* The sorting strategy to use for this collection
|
|
32
|
+
* @protected
|
|
33
|
+
*/
|
|
34
|
+
sortingStrategy = new NoOpSortingStrategy();
|
|
35
|
+
|
|
36
|
+
// Collection-specific behavior is implemented by subclasses
|
|
37
|
+
/**
|
|
38
|
+
* Token for the next page of results
|
|
39
|
+
* @protected
|
|
40
|
+
*/
|
|
41
|
+
|
|
42
|
+
/**
|
|
43
|
+
* Promise tracking an in-progress page fetch
|
|
44
|
+
* @protected
|
|
45
|
+
*/
|
|
46
|
+
|
|
47
|
+
//
|
|
48
|
+
// Shared Implementations
|
|
49
|
+
//
|
|
50
|
+
|
|
51
|
+
/**
|
|
52
|
+
* Standard method to update a list of objects
|
|
53
|
+
* Handles common list update patterns for both ListQuery and SpecificLinkQuery
|
|
54
|
+
*
|
|
55
|
+
* @param items Objects or cache keys to add to the list
|
|
56
|
+
* @param status Status to set for the list
|
|
57
|
+
* @param batch Batch context to use
|
|
58
|
+
* @param append Whether to append to the existing list or replace it
|
|
59
|
+
* @returns The updated entry
|
|
60
|
+
*/
|
|
61
|
+
_updateList(items, status, batch, append = false) {
|
|
62
|
+
if (process.env.NODE_ENV !== "production") {
|
|
63
|
+
this.logger?.child({
|
|
64
|
+
methodName: "updateList"
|
|
65
|
+
}).debug(`{status: ${status}, append: ${append}}`, JSON.stringify(items, null, 2));
|
|
66
|
+
}
|
|
67
|
+
let objectCacheKeys;
|
|
68
|
+
if (items.length === 0) {
|
|
69
|
+
objectCacheKeys = [];
|
|
70
|
+
} else if (isObjectInstance(items[0])) {
|
|
71
|
+
// Items are object instances, need to store them first
|
|
72
|
+
objectCacheKeys = this.store.objects.storeOsdkInstances(items, batch);
|
|
73
|
+
} else {
|
|
74
|
+
// Items are already cache keys
|
|
75
|
+
objectCacheKeys = items;
|
|
76
|
+
}
|
|
77
|
+
objectCacheKeys = this.#retainReleaseAppend(batch, append, objectCacheKeys);
|
|
78
|
+
objectCacheKeys = this._sortCacheKeys(objectCacheKeys, batch);
|
|
79
|
+
objectCacheKeys = removeDuplicates(objectCacheKeys, batch);
|
|
80
|
+
return this.writeToStore({
|
|
81
|
+
data: objectCacheKeys
|
|
82
|
+
}, status, batch);
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
/**
|
|
86
|
+
* Common implementation for writing to store for collection-based queries
|
|
87
|
+
* @param data The collection data to write to the store
|
|
88
|
+
* @param status The status to set
|
|
89
|
+
* @param batch The batch context
|
|
90
|
+
*/
|
|
91
|
+
writeToStore(data, status, batch) {
|
|
92
|
+
const entry = batch.read(this.cacheKey);
|
|
93
|
+
if (entry && deepEqual(data, entry.value)) {
|
|
94
|
+
// Check if both data AND status are the same
|
|
95
|
+
if (entry.status === status) {
|
|
96
|
+
if (process.env.NODE_ENV !== "production") {
|
|
97
|
+
this.logger?.child({
|
|
98
|
+
methodName: "writeToStore"
|
|
99
|
+
}).debug(`Collection data was deep equal and status unchanged (${status}), skipping update`);
|
|
100
|
+
}
|
|
101
|
+
// Return the existing entry without writing to avoid unnecessary notifications
|
|
102
|
+
return entry;
|
|
103
|
+
}
|
|
104
|
+
if (process.env.NODE_ENV !== "production") {
|
|
105
|
+
this.logger?.child({
|
|
106
|
+
methodName: "writeToStore"
|
|
107
|
+
}).debug(`Collection data was deep equal, just updating status from ${entry.status} to ${status}`);
|
|
108
|
+
}
|
|
109
|
+
// Keep the same value but update status and lastUpdated
|
|
110
|
+
return batch.write(this.cacheKey, entry.value, status);
|
|
111
|
+
}
|
|
112
|
+
if (process.env.NODE_ENV !== "production") {
|
|
113
|
+
this.logger?.child({
|
|
114
|
+
methodName: "writeToStore"
|
|
115
|
+
}).debug(`{status: ${status}},`, DEBUG_ONLY__cacheKeysToString(data.data));
|
|
116
|
+
}
|
|
117
|
+
const ret = batch.write(this.cacheKey, data, status);
|
|
118
|
+
this.registerCacheChanges(batch);
|
|
119
|
+
return ret;
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
/**
|
|
123
|
+
* Register changes to the cache based on the specific collection type
|
|
124
|
+
* Implemented by subclasses to handle specific change registration
|
|
125
|
+
*/
|
|
126
|
+
|
|
127
|
+
/**
|
|
128
|
+
* Common method for managing object reference counting and appending results
|
|
129
|
+
* Used by collection queries when updating object references
|
|
130
|
+
*
|
|
131
|
+
* @param batch The batch context to use
|
|
132
|
+
* @param append Whether to append to existing objects or replace them
|
|
133
|
+
* @param objectCacheKeys Array of object cache keys to process
|
|
134
|
+
* @returns The final array of object cache keys after retain/release/append
|
|
135
|
+
*/
|
|
136
|
+
#retainReleaseAppend(batch, append, objectCacheKeys) {
|
|
137
|
+
const existingList = batch.read(this.cacheKey);
|
|
138
|
+
|
|
139
|
+
// whether its append or update we need to retain all the new objects
|
|
140
|
+
if (!batch.optimisticWrite) {
|
|
141
|
+
if (!append) {
|
|
142
|
+
// we need to release all the old objects
|
|
143
|
+
// N.B. the store keeps the cache keys around for a bit so we don't
|
|
144
|
+
// need to worry about them being GC'd before we re-retain them
|
|
145
|
+
for (const objectCacheKey of existingList?.value?.data ?? []) {
|
|
146
|
+
this.store.cacheKeys.release(objectCacheKey);
|
|
147
|
+
}
|
|
148
|
+
}
|
|
149
|
+
for (const objectCacheKey of objectCacheKeys) {
|
|
150
|
+
this.store.cacheKeys.retain(objectCacheKey);
|
|
151
|
+
}
|
|
152
|
+
}
|
|
153
|
+
if (append) {
|
|
154
|
+
objectCacheKeys = [...(existingList?.value?.data ?? []), ...objectCacheKeys];
|
|
155
|
+
}
|
|
156
|
+
return objectCacheKeys;
|
|
157
|
+
}
|
|
158
|
+
_dispose() {
|
|
159
|
+
this.store.batch({}, batch => {
|
|
160
|
+
const entry = batch.read(this.cacheKey);
|
|
161
|
+
if (entry) {
|
|
162
|
+
for (const objectCacheKey of entry.value?.data ?? []) {
|
|
163
|
+
this.store.cacheKeys.release(objectCacheKey);
|
|
164
|
+
}
|
|
165
|
+
}
|
|
166
|
+
});
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
/**
|
|
170
|
+
* Creates a payload from collection parameters
|
|
171
|
+
* Default implementation that covers common fields for all collection types
|
|
172
|
+
* Subclasses may override to add type-specific fields if needed
|
|
173
|
+
*
|
|
174
|
+
* @param params Common collection parameters
|
|
175
|
+
* @returns A typed payload for the specific collection type
|
|
176
|
+
*/
|
|
177
|
+
createPayload(params) {
|
|
178
|
+
return {
|
|
179
|
+
resolvedList: params.resolvedData,
|
|
180
|
+
isOptimistic: params.isOptimistic,
|
|
181
|
+
fetchMore: this.fetchMore,
|
|
182
|
+
hasMore: this.nextPageToken != null,
|
|
183
|
+
status: params.status,
|
|
184
|
+
lastUpdated: params.lastUpdated
|
|
185
|
+
}; // Type assertion needed since we don't know exact subtype
|
|
186
|
+
}
|
|
187
|
+
|
|
188
|
+
/**
|
|
189
|
+
* Creates a connectable observable for this collection
|
|
190
|
+
* Common implementation shared by all collection types
|
|
191
|
+
*
|
|
192
|
+
* @param subject The subject to connect to
|
|
193
|
+
* @returns A connectable observable of the collection's payload type
|
|
194
|
+
*/
|
|
195
|
+
_createConnectable(subject) {
|
|
196
|
+
return createCollectionConnectable(subject, this.store.subjects, params => this.createPayload(params));
|
|
197
|
+
}
|
|
198
|
+
|
|
199
|
+
/**
|
|
200
|
+
* @override Reset pagination state before a fetch
|
|
201
|
+
*/
|
|
202
|
+
_preFetch() {
|
|
203
|
+
this.nextPageToken = undefined;
|
|
204
|
+
super._preFetch();
|
|
205
|
+
}
|
|
206
|
+
|
|
207
|
+
/**
|
|
208
|
+
* Common fetchMore implementation for pagination
|
|
209
|
+
* Handles pending request management and loading states
|
|
210
|
+
*/
|
|
211
|
+
fetchMore = () => {
|
|
212
|
+
if (this.pendingPageFetch) {
|
|
213
|
+
return this.pendingPageFetch;
|
|
214
|
+
}
|
|
215
|
+
if (this.pendingFetch) {
|
|
216
|
+
this.pendingPageFetch = new Promise(async res => {
|
|
217
|
+
await this.pendingFetch;
|
|
218
|
+
res(this.fetchMore());
|
|
219
|
+
});
|
|
220
|
+
return this.pendingPageFetch;
|
|
221
|
+
}
|
|
222
|
+
if (this.nextPageToken == null) {
|
|
223
|
+
return Promise.resolve(undefined);
|
|
224
|
+
}
|
|
225
|
+
this.store.batch({}, batch => {
|
|
226
|
+
this.setStatus("loading", batch);
|
|
227
|
+
});
|
|
228
|
+
this.pendingFetch = this.fetchPageAndUpdate("loaded", this.abortController?.signal).then(() => void 0).finally(() => {
|
|
229
|
+
this.pendingPageFetch = undefined;
|
|
230
|
+
});
|
|
231
|
+
return this.pendingFetch;
|
|
232
|
+
};
|
|
233
|
+
|
|
234
|
+
/**
|
|
235
|
+
* Minimum number of results to load initially
|
|
236
|
+
* May be overridden by subclasses for specific collection types
|
|
237
|
+
* @protected
|
|
238
|
+
*/
|
|
239
|
+
minResultsToLoad = 0;
|
|
240
|
+
|
|
241
|
+
/**
|
|
242
|
+
* Common _fetchAndStore implementation for pagination
|
|
243
|
+
* Uses fetchPageAndUpdate to load the initial set of data
|
|
244
|
+
* Will load multiple pages if necessary to reach minResultsToLoad
|
|
245
|
+
*/
|
|
246
|
+
async _fetchAndStore() {
|
|
247
|
+
if (process.env.NODE_ENV !== "production") {
|
|
248
|
+
this.logger?.child({
|
|
249
|
+
methodName: "_fetchAndStore"
|
|
250
|
+
}).debug("fetching pages");
|
|
251
|
+
}
|
|
252
|
+
|
|
253
|
+
// Keep fetching pages until we have the minimum number of results or no more pages
|
|
254
|
+
while (true) {
|
|
255
|
+
const entry = await this.fetchPageAndUpdate("loading", this.abortController?.signal);
|
|
256
|
+
if (!entry) {
|
|
257
|
+
// we were aborted
|
|
258
|
+
return;
|
|
259
|
+
}
|
|
260
|
+
|
|
261
|
+
// Check if we have enough results or no more pages
|
|
262
|
+
const count = entry.value?.data.length || 0;
|
|
263
|
+
if (count >= this.minResultsToLoad || this.nextPageToken == null) {
|
|
264
|
+
break;
|
|
265
|
+
}
|
|
266
|
+
}
|
|
267
|
+
this.store.batch({}, batch => {
|
|
268
|
+
this.setStatus("loaded", batch);
|
|
269
|
+
});
|
|
270
|
+
return Promise.resolve();
|
|
271
|
+
}
|
|
272
|
+
|
|
273
|
+
/**
|
|
274
|
+
* Template method for fetching a page of data and updating the store
|
|
275
|
+
* Provides common error handling and abort signal checking
|
|
276
|
+
*
|
|
277
|
+
* @param status The status to set for the entry
|
|
278
|
+
* @param signal Optional AbortSignal for cancellation
|
|
279
|
+
* @returns A promise that resolves to the updated entry or undefined if aborted
|
|
280
|
+
*/
|
|
281
|
+
async fetchPageAndUpdate(status, signal) {
|
|
282
|
+
if (process.env.NODE_ENV !== "production") {
|
|
283
|
+
this.logger?.child({
|
|
284
|
+
methodName: "fetchPageAndUpdate"
|
|
285
|
+
}).debug(`Fetching data with status: ${status}`);
|
|
286
|
+
}
|
|
287
|
+
|
|
288
|
+
// Early abort check
|
|
289
|
+
if (signal?.aborted) {
|
|
290
|
+
return undefined;
|
|
291
|
+
}
|
|
292
|
+
try {
|
|
293
|
+
// Call the subclass-specific implementation to fetch data
|
|
294
|
+
const result = await this.fetchPageData(signal);
|
|
295
|
+
|
|
296
|
+
// Check for abort again after fetch
|
|
297
|
+
if (signal?.aborted) {
|
|
298
|
+
return undefined;
|
|
299
|
+
}
|
|
300
|
+
|
|
301
|
+
// Store the fetched data using batch operations
|
|
302
|
+
const {
|
|
303
|
+
retVal
|
|
304
|
+
} = this.store.batch({}, batch => {
|
|
305
|
+
const append = this.nextPageToken != null;
|
|
306
|
+
const finalStatus = result.nextPageToken ? status : "loaded";
|
|
307
|
+
return this._updateList(this.store.objects.storeOsdkInstances(result.data, batch), finalStatus, batch, append);
|
|
308
|
+
});
|
|
309
|
+
return retVal;
|
|
310
|
+
} catch (error) {
|
|
311
|
+
// Log any errors that occur
|
|
312
|
+
if (process.env.NODE_ENV !== "production") {
|
|
313
|
+
this.logger?.child({
|
|
314
|
+
methodName: "fetchPageAndUpdate"
|
|
315
|
+
}).error("Error fetching data", error);
|
|
316
|
+
}
|
|
317
|
+
|
|
318
|
+
// For unexpected errors, write error status if not aborted
|
|
319
|
+
if (!signal?.aborted) {
|
|
320
|
+
const {
|
|
321
|
+
retVal
|
|
322
|
+
} = this.store.batch({}, batch => {
|
|
323
|
+
return this.handleFetchError(error, status, batch);
|
|
324
|
+
});
|
|
325
|
+
return retVal;
|
|
326
|
+
}
|
|
327
|
+
|
|
328
|
+
// If aborted, just return undefined
|
|
329
|
+
return undefined;
|
|
330
|
+
}
|
|
331
|
+
}
|
|
332
|
+
|
|
333
|
+
/**
|
|
334
|
+
* Abstract method that subclasses implement for their specific data fetching logic
|
|
335
|
+
*
|
|
336
|
+
* @param signal Optional AbortSignal for cancellation
|
|
337
|
+
* @returns A promise that resolves to the fetched data
|
|
338
|
+
*/
|
|
339
|
+
|
|
340
|
+
/**
|
|
341
|
+
* Handle fetch errors by setting appropriate error state
|
|
342
|
+
* Default implementation that subclasses can override
|
|
343
|
+
*
|
|
344
|
+
* @param error The error that occurred
|
|
345
|
+
* @param status The intended status if successful
|
|
346
|
+
* @param batch The batch context to use
|
|
347
|
+
* @returns The updated entry with error status
|
|
348
|
+
*/
|
|
349
|
+
handleFetchError(_error, _status, batch) {
|
|
350
|
+
// Default implementation writes an empty list with error status
|
|
351
|
+
// Most subclasses should be able to use this
|
|
352
|
+
return this.writeToStore({
|
|
353
|
+
data: []
|
|
354
|
+
}, "error", batch);
|
|
355
|
+
}
|
|
356
|
+
|
|
357
|
+
/**
|
|
358
|
+
* Sort the collection items using the configured sorting strategy
|
|
359
|
+
* @param objectCacheKeys - The cache keys to sort
|
|
360
|
+
* @param batch - The batch context
|
|
361
|
+
* @returns Sorted array of cache keys
|
|
362
|
+
*/
|
|
363
|
+
_sortCacheKeys(objectCacheKeys, batch) {
|
|
364
|
+
return this.sortingStrategy.sortCacheKeys(objectCacheKeys, batch);
|
|
365
|
+
}
|
|
366
|
+
|
|
367
|
+
/**
|
|
368
|
+
* Unified method for updating collection data in the store
|
|
369
|
+
* Handles storing, sorting, deduplication, and reference counting
|
|
370
|
+
*
|
|
371
|
+
* @param items - Either object cache keys or object instances to update
|
|
372
|
+
* @param options - Configuration options for the update
|
|
373
|
+
* @param batch - The batch context to use
|
|
374
|
+
* @returns The updated entry
|
|
375
|
+
*/
|
|
376
|
+
updateCollection(items, options, batch) {
|
|
377
|
+
if (process.env.NODE_ENV !== "production") {
|
|
378
|
+
const logger = process.env.NODE_ENV !== "production" ? this.logger?.child({
|
|
379
|
+
methodName: "updateCollection"
|
|
380
|
+
}) : this.logger;
|
|
381
|
+
logger?.debug(`{status: ${options.status}, append: ${options.append}}`, JSON.stringify(items, null, 2));
|
|
382
|
+
}
|
|
383
|
+
|
|
384
|
+
// Step 1: Convert items to object cache keys if needed
|
|
385
|
+
let objectCacheKeys;
|
|
386
|
+
if (items.length === 0) {
|
|
387
|
+
objectCacheKeys = [];
|
|
388
|
+
} else if (isObjectInstance(items[0])) {
|
|
389
|
+
// Items are object instances, need to store them first
|
|
390
|
+
objectCacheKeys = this.store.objects.storeOsdkInstances(items, batch);
|
|
391
|
+
} else {
|
|
392
|
+
// Items are already cache keys
|
|
393
|
+
objectCacheKeys = items;
|
|
394
|
+
}
|
|
395
|
+
|
|
396
|
+
// Step 2: Handle retain/release/append logic
|
|
397
|
+
objectCacheKeys = this.#retainReleaseAppend(batch, options.append ?? false, objectCacheKeys);
|
|
398
|
+
|
|
399
|
+
// Step 3: Sort using the configured sorting strategy
|
|
400
|
+
objectCacheKeys = this._sortCacheKeys(objectCacheKeys, batch);
|
|
401
|
+
|
|
402
|
+
// Step 4: Remove duplicates
|
|
403
|
+
objectCacheKeys = removeDuplicates(objectCacheKeys, batch);
|
|
404
|
+
|
|
405
|
+
// Step 5: Write to store
|
|
406
|
+
return this.writeToStore({
|
|
407
|
+
data: objectCacheKeys
|
|
408
|
+
}, options.status, batch);
|
|
409
|
+
}
|
|
410
|
+
}
|
|
411
|
+
//# sourceMappingURL=BaseListQuery.js.map
|