@osdk/client 2.5.0-beta.1 → 2.5.0-beta.2
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 +26 -0
- package/build/browser/Client.js +1 -1
- package/build/browser/Client.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/SimpleCache.js +1 -1
- package/build/browser/object/SimpleCache.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/fetchPage.js +8 -4
- package/build/browser/object/fetchPage.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/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 +50 -0
- package/build/browser/observable/internal/AbstractHelper.js.map +1 -0
- package/build/browser/observable/internal/BaseCollectionQuery.js +2 -0
- package/build/browser/observable/internal/BaseCollectionQuery.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 +17 -2
- 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.map +1 -1
- package/build/browser/observable/internal/ListCacheKey.js +2 -0
- package/build/browser/observable/internal/ListCacheKey.js.map +1 -0
- package/build/browser/observable/internal/ListQuery.js +399 -161
- package/build/browser/observable/internal/ListQuery.js.map +1 -1
- package/build/browser/observable/internal/ObjectQuery.js +27 -2
- package/build/browser/observable/internal/ObjectQuery.js.map +1 -1
- package/build/browser/observable/internal/ObservableClientImpl.js +42 -2
- package/build/browser/observable/internal/ObservableClientImpl.js.map +1 -1
- package/build/browser/observable/internal/OptimisticJob.js +12 -3
- package/build/browser/observable/internal/OptimisticJob.js.map +1 -1
- package/build/browser/observable/internal/Query.js +17 -3
- package/build/browser/observable/internal/Query.js.map +1 -1
- package/build/browser/observable/internal/QuerySubscription.js +41 -0
- package/build/browser/observable/internal/QuerySubscription.js.map +1 -0
- package/build/browser/observable/internal/Store.invalidation.test.js +481 -0
- package/build/browser/observable/internal/Store.invalidation.test.js.map +1 -0
- package/build/browser/observable/internal/Store.js +38 -91
- package/build/browser/observable/internal/Store.js.map +1 -1
- package/build/browser/observable/internal/Store.test.js +318 -63
- package/build/browser/observable/internal/Store.test.js.map +1 -1
- package/build/browser/observable/internal/UnsubscribableWrapper.js +30 -0
- package/build/browser/observable/internal/UnsubscribableWrapper.js.map +1 -0
- package/build/browser/observable/internal/createCollectionConnectable.js +50 -0
- package/build/browser/observable/internal/createCollectionConnectable.js.map +1 -0
- package/build/browser/observable/internal/createCollectionConnectable.test.js +599 -0
- package/build/browser/observable/internal/createCollectionConnectable.test.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/ListsHelper.js +49 -0
- package/build/browser/observable/internal/list/ListsHelper.js.map +1 -0
- package/build/browser/observable/internal/object/ObjectsHelper.js +34 -0
- package/build/browser/observable/internal/object/ObjectsHelper.js.map +1 -0
- package/build/browser/observable/internal/removeDuplicates.js +36 -0
- package/build/browser/observable/internal/removeDuplicates.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 +70 -7
- package/build/browser/observable/internal/testUtils.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/streamutils.js +1 -1
- package/build/browser/util/streamutils.js.map +1 -1
- package/build/cjs/{chunk-URDXPIRU.cjs → chunk-N5DMNYGH.cjs} +58 -54
- package/build/cjs/chunk-N5DMNYGH.cjs.map +1 -0
- package/build/cjs/{chunk-BJYCRD5Y.cjs → chunk-NWD33DSJ.cjs} +23 -19
- package/build/cjs/chunk-NWD33DSJ.cjs.map +1 -0
- package/build/cjs/index.cjs +7 -7
- package/build/cjs/public/internal.cjs +8 -8
- package/build/cjs/public/unstable-do-not-use.cjs +779 -268
- package/build/cjs/public/unstable-do-not-use.cjs.map +1 -1
- package/build/cjs/public/unstable-do-not-use.d.cts +161 -12
- package/build/esm/Client.js +1 -1
- package/build/esm/Client.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/SimpleCache.js +1 -1
- package/build/esm/object/SimpleCache.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/fetchPage.js +8 -4
- package/build/esm/object/fetchPage.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/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 +50 -0
- package/build/esm/observable/internal/AbstractHelper.js.map +1 -0
- package/build/esm/observable/internal/BaseCollectionQuery.js +2 -0
- package/build/esm/observable/internal/BaseCollectionQuery.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 +17 -2
- 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.map +1 -1
- package/build/esm/observable/internal/ListCacheKey.js +2 -0
- package/build/esm/observable/internal/ListCacheKey.js.map +1 -0
- package/build/esm/observable/internal/ListQuery.js +399 -161
- package/build/esm/observable/internal/ListQuery.js.map +1 -1
- package/build/esm/observable/internal/ObjectQuery.js +27 -2
- package/build/esm/observable/internal/ObjectQuery.js.map +1 -1
- package/build/esm/observable/internal/ObservableClientImpl.js +42 -2
- package/build/esm/observable/internal/ObservableClientImpl.js.map +1 -1
- package/build/esm/observable/internal/OptimisticJob.js +12 -3
- package/build/esm/observable/internal/OptimisticJob.js.map +1 -1
- package/build/esm/observable/internal/Query.js +17 -3
- package/build/esm/observable/internal/Query.js.map +1 -1
- package/build/esm/observable/internal/QuerySubscription.js +41 -0
- package/build/esm/observable/internal/QuerySubscription.js.map +1 -0
- package/build/esm/observable/internal/Store.invalidation.test.js +481 -0
- package/build/esm/observable/internal/Store.invalidation.test.js.map +1 -0
- package/build/esm/observable/internal/Store.js +38 -91
- package/build/esm/observable/internal/Store.js.map +1 -1
- package/build/esm/observable/internal/Store.test.js +318 -63
- package/build/esm/observable/internal/Store.test.js.map +1 -1
- package/build/esm/observable/internal/UnsubscribableWrapper.js +30 -0
- package/build/esm/observable/internal/UnsubscribableWrapper.js.map +1 -0
- package/build/esm/observable/internal/createCollectionConnectable.js +50 -0
- package/build/esm/observable/internal/createCollectionConnectable.js.map +1 -0
- package/build/esm/observable/internal/createCollectionConnectable.test.js +599 -0
- package/build/esm/observable/internal/createCollectionConnectable.test.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/ListsHelper.js +49 -0
- package/build/esm/observable/internal/list/ListsHelper.js.map +1 -0
- package/build/esm/observable/internal/object/ObjectsHelper.js +34 -0
- package/build/esm/observable/internal/object/ObjectsHelper.js.map +1 -0
- package/build/esm/observable/internal/removeDuplicates.js +36 -0
- package/build/esm/observable/internal/removeDuplicates.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 +70 -7
- package/build/esm/observable/internal/testUtils.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/streamutils.js +1 -1
- package/build/esm/util/streamutils.js.map +1 -1
- package/build/types/Client.d.ts +1 -1
- package/build/types/object/fetchPage.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 +82 -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 +15 -0
- package/build/types/observable/internal/AbstractHelper.d.ts.map +1 -0
- package/build/types/observable/internal/BaseCollectionQuery.d.ts +64 -0
- package/build/types/observable/internal/BaseCollectionQuery.d.ts.map +1 -0
- package/build/types/observable/internal/BulkObjectLoader.d.ts.map +1 -1
- package/build/types/observable/internal/CacheKeys.d.ts +10 -4
- package/build/types/observable/internal/CacheKeys.d.ts.map +1 -1
- package/build/types/observable/internal/Changes.d.ts +7 -4
- 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 +7 -7
- package/build/types/observable/internal/Layer.d.ts.map +1 -1
- package/build/types/observable/internal/ListCacheKey.d.ts +7 -0
- package/build/types/observable/internal/ListCacheKey.d.ts.map +1 -0
- package/build/types/observable/internal/ListQuery.d.ts +160 -21
- package/build/types/observable/internal/ListQuery.d.ts.map +1 -1
- package/build/types/observable/internal/ObjectQuery.d.ts +3 -1
- package/build/types/observable/internal/ObjectQuery.d.ts.map +1 -1
- package/build/types/observable/internal/OptimisticJob.d.ts.map +1 -1
- package/build/types/observable/internal/Query.d.ts +6 -5
- 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 +34 -31
- 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/UnsubscribableWrapper.d.ts +1 -0
- package/build/types/observable/internal/UnsubscribableWrapper.d.ts.map +1 -0
- package/build/types/observable/internal/createCollectionConnectable.d.ts +38 -0
- package/build/types/observable/internal/createCollectionConnectable.d.ts.map +1 -0
- package/build/types/observable/internal/createCollectionConnectable.test.d.ts +1 -0
- package/build/types/observable/internal/createCollectionConnectable.test.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 +29 -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 +45 -0
- package/build/types/observable/internal/links/SpecificLinkQuery.d.ts.map +1 -0
- package/build/types/observable/internal/list/ListsHelper.d.ts +17 -0
- package/build/types/observable/internal/list/ListsHelper.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/removeDuplicates.d.ts +11 -0
- package/build/types/observable/internal/removeDuplicates.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 +25 -3
- 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/package.json +10 -10
- package/build/cjs/chunk-BJYCRD5Y.cjs.map +0 -1
- package/build/cjs/chunk-URDXPIRU.cjs.map +0 -1
|
@@ -2,25 +2,17 @@ import type { ActionDefinition, ActionValidationResponse, InterfaceDefinition, O
|
|
|
2
2
|
import type { ActionSignatureFromDef } from "../actions/applyAction.js";
|
|
3
3
|
import { type Client } from "../Client.js";
|
|
4
4
|
import type { Canonical } from "./internal/Canonical.js";
|
|
5
|
+
import type { CommonObserveOptions, InvalidationMode, ObserveOptions, Observer, Status } from "./ObservableClient/common.js";
|
|
6
|
+
import type { ObserveLinks } from "./ObservableClient/ObserveLink.js";
|
|
5
7
|
import type { OptimisticBuilder } from "./OptimisticBuilder.js";
|
|
6
|
-
export type Status = "init" | "loading" | "loaded" | "error";
|
|
7
|
-
export interface Observer<T> {
|
|
8
|
-
next: (value: T) => void;
|
|
9
|
-
error: (err: any) => void;
|
|
10
|
-
complete: () => void;
|
|
11
|
-
}
|
|
12
8
|
export declare namespace ObservableClient {
|
|
13
9
|
interface ApplyActionOptions {
|
|
14
10
|
optimisticUpdate?: (ctx: OptimisticBuilder) => void;
|
|
15
11
|
}
|
|
16
12
|
}
|
|
17
|
-
export interface CommonObserveOptions {
|
|
18
|
-
dedupeInterval?: number;
|
|
19
|
-
}
|
|
20
|
-
export interface ObserveOptions {
|
|
21
|
-
mode?: "offline" | "force";
|
|
22
|
-
}
|
|
23
13
|
export interface ObserveObjectOptions<T extends ObjectTypeDefinition | InterfaceDefinition> extends ObserveOptions {
|
|
14
|
+
apiName: T["apiName"] | T;
|
|
15
|
+
pk: PrimaryKeyType<T>;
|
|
24
16
|
select?: PropertyKeys<T>[];
|
|
25
17
|
}
|
|
26
18
|
export type OrderBy<Q extends ObjectTypeDefinition | InterfaceDefinition> = { [K in PropertyKeys<Q>]? : "asc" | "desc" | undefined };
|
|
@@ -29,7 +21,7 @@ export interface ObserveListOptions<Q extends ObjectTypeDefinition | InterfaceDe
|
|
|
29
21
|
where?: WhereClause<Q>;
|
|
30
22
|
pageSize?: number;
|
|
31
23
|
orderBy?: OrderBy<Q>;
|
|
32
|
-
invalidationMode?:
|
|
24
|
+
invalidationMode?: InvalidationMode;
|
|
33
25
|
expectedLength?: number;
|
|
34
26
|
streamUpdates?: boolean;
|
|
35
27
|
}
|
|
@@ -43,14 +35,89 @@ export interface ObserveObjectsArgs<T extends ObjectTypeDefinition | InterfaceDe
|
|
|
43
35
|
resolvedList: Array<Osdk.Instance<T>>;
|
|
44
36
|
isOptimistic: boolean;
|
|
45
37
|
lastUpdated: number;
|
|
46
|
-
fetchMore: () => Promise<
|
|
38
|
+
fetchMore: () => Promise<void>;
|
|
39
|
+
hasMore: boolean;
|
|
40
|
+
status: Status;
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* User facing callback args for `observeLink`
|
|
44
|
+
*/
|
|
45
|
+
export interface ObserveLinkCallbackArgs<T extends ObjectTypeDefinition | InterfaceDefinition> {
|
|
46
|
+
resolvedList: Osdk.Instance<T>[];
|
|
47
|
+
isOptimistic: boolean;
|
|
48
|
+
lastUpdated: number;
|
|
49
|
+
fetchMore: () => Promise<void>;
|
|
47
50
|
hasMore: boolean;
|
|
48
51
|
status: Status;
|
|
49
52
|
}
|
|
50
|
-
|
|
53
|
+
/**
|
|
54
|
+
* Public interface for reactive data management with automatic updates.
|
|
55
|
+
*
|
|
56
|
+
* The ObservableClient provides a reactive data layer with:
|
|
57
|
+
* - Real-time object and collection observation
|
|
58
|
+
* - Automatic cache updates when data changes
|
|
59
|
+
* - Optimistic updates for immediate UI feedback
|
|
60
|
+
* - Pagination support for large collections
|
|
61
|
+
* - Link traversal for relationship navigation
|
|
62
|
+
*/
|
|
63
|
+
export interface ObservableClient extends ObserveLinks {
|
|
64
|
+
/**
|
|
65
|
+
* Observe a single object with automatic updates when it changes.
|
|
66
|
+
*
|
|
67
|
+
* @param apiName - The object type definition or name
|
|
68
|
+
* @param pk - The object's primary key
|
|
69
|
+
* @param options - Observation options including deduplication interval
|
|
70
|
+
* @param subFn - Observer that receives object state updates
|
|
71
|
+
* @returns Subscription that can be unsubscribed to stop updates
|
|
72
|
+
*
|
|
73
|
+
* The observer will receive:
|
|
74
|
+
* - Initial loading state if data not cached
|
|
75
|
+
* - Loaded state with the object data
|
|
76
|
+
* - Updates when the object changes
|
|
77
|
+
* - Error state if fetch fails
|
|
78
|
+
*/
|
|
51
79
|
observeObject<T extends ObjectTypeDefinition>(apiName: T["apiName"] | T, pk: PrimaryKeyType<T>, options: ObserveOptions, subFn: Observer<ObserveObjectArgs<T>>): Unsubscribable;
|
|
80
|
+
/**
|
|
81
|
+
* Observe a filtered and sorted collection of objects.
|
|
82
|
+
*
|
|
83
|
+
* @param options - Filter, sort, and pagination options
|
|
84
|
+
* @param subFn - Observer that receives collection state updates
|
|
85
|
+
* @returns Subscription that can be unsubscribed to stop updates
|
|
86
|
+
*
|
|
87
|
+
* Supports:
|
|
88
|
+
* - Filtering with where clauses
|
|
89
|
+
* - Sorting with orderBy
|
|
90
|
+
* - Pagination via fetchMore() in the payload
|
|
91
|
+
* - Automatic updates when any matching object changes
|
|
92
|
+
*/
|
|
52
93
|
observeList<T extends ObjectTypeDefinition | InterfaceDefinition>(options: ObserveListOptions<T>, subFn: Observer<ObserveObjectsArgs<T>>): Unsubscribable;
|
|
94
|
+
/**
|
|
95
|
+
* Execute an action with optional optimistic updates.
|
|
96
|
+
*
|
|
97
|
+
* @param action - Action definition to execute
|
|
98
|
+
* @param args - Arguments for the action
|
|
99
|
+
* @param opts - Options including optimistic updates
|
|
100
|
+
* @returns Promise that resolves when the action completes
|
|
101
|
+
*
|
|
102
|
+
* When providing optimistic updates:
|
|
103
|
+
* - Changes appear immediately in the UI
|
|
104
|
+
* - Server request still happens in background
|
|
105
|
+
* - On success, server data replaces optimistic data
|
|
106
|
+
* - On failure, optimistic changes automatically roll back
|
|
107
|
+
*/
|
|
53
108
|
applyAction: <Q extends ActionDefinition<any>>(action: Q, args: Parameters<ActionSignatureFromDef<Q>["applyAction"]>[0] | Array<Parameters<ActionSignatureFromDef<Q>["applyAction"]>[0]>, opts?: ObservableClient.ApplyActionOptions) => Promise<unknown>;
|
|
109
|
+
/**
|
|
110
|
+
* Validate action parameters without executing the action.
|
|
111
|
+
*
|
|
112
|
+
* @param action - Action definition to validate
|
|
113
|
+
* @param args - Arguments to validate
|
|
114
|
+
* @returns Promise with validation result
|
|
115
|
+
*
|
|
116
|
+
* Use this to:
|
|
117
|
+
* - Pre-validate forms before submission
|
|
118
|
+
* - Display warnings or errors in the UI
|
|
119
|
+
* - Enable/disable action buttons based on validity
|
|
120
|
+
*/
|
|
54
121
|
validateAction: <Q extends ActionDefinition<any>>(action: Q, args: Parameters<ActionSignatureFromDef<Q>["applyAction"]>[0]) => Promise<ActionValidationResponse>;
|
|
55
122
|
canonicalizeWhereClause: <T extends ObjectTypeDefinition | InterfaceDefinition>(where: WhereClause<T>) => Canonical<WhereClause<T>>;
|
|
56
123
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"mappings":"AAgBA,cACE,kBACA,0BACA,qBACA,sBACA,MACA,gBACA,cACA,mBACK,WAAY;AAEnB,cAAc,8BAA8B,2BAA4B;AACxE,cAAiC,cAAc,cAAe;AAG9D,cAAc,iBAAiB,yBAA0B;AAGzD,
|
|
1
|
+
{"mappings":"AAgBA,cACE,kBACA,0BACA,qBACA,sBACA,MACA,gBACA,cACA,mBACK,WAAY;AAEnB,cAAc,8BAA8B,2BAA4B;AACxE,cAAiC,cAAc,cAAe;AAG9D,cAAc,iBAAiB,yBAA0B;AAGzD,cACE,sBACA,kBACA,gBACA,UACA,cACK,8BAA+B;AACtC,cAAc,oBAAoB,mCAAoC;AACtE,cAAc,yBAAyB,wBAAyB;AAEhE,yBAAiB;WACE,mBAAmB;EAClC,oBAAoBA,KAAK;CAC1B;;AAGH,iBAAiB,qBACf,UAAU,uBAAuB,6BACzB,eAAe;CACvB,SAAS,EAAE,aAAa;CACxB,IAAI,eAAe;CACnB,SAAS,aAAa;AACvB;AAED,YAAY,QAAQ,UAAU,uBAAuB,0BAClD,KAAK,aAAa,OAAM,QAAQ;AAGnC,iBAAiB,mBACf,UAAU,uBAAuB,6BACzB,sBAAsB,eAAe;CAC7C,MAAM,KAAK,GAAG,YAAY;CAC1B,QAAQ,YAAY;CACpB;CACA,UAAU,QAAQ;CAClB,mBAAmB;CACnB;CACA;AACD;AAID,iBAAiB,kBAAkB,UAAU,sBAAsB;CACjE,QAAQ,KAAK,SAAS;CACtB;CACA,QAAQ;CACR;AACD;AAGD,iBAAiB,mBACf,UAAU,uBAAuB,qBACjC;CACA,cAAc,MAAM,KAAK,SAAS;CAClC;CACA;CACA,iBAAiB;CACjB;CACA,QAAQ;AACT;;;;AAKD,iBAAiB,wBACf,UAAU,uBAAuB,qBACjC;CACA,cAAc,KAAK,SAAS;CAC5B;CACA;CACA,iBAAiB;CACjB;CACA,QAAQ;AACT;;;;;;;;;;;AAYD,iBAAiB,yBAAyB,aAAa;;;;;;;;;;;;;;;;CAgBrD,cAAc,UAAU,sBACtBC,SAAS,EAAE,aAAa,GACxBC,IAAI,eAAe,IACnBC,SAAS,gBACTC,OAAO,SAAS,kBAAkB,MACjC;;;;;;;;;;;;;;CAeH,YAAY,UAAU,uBAAuB,qBAC3CC,SAAS,mBAAmB,IAC5BC,OAAO,SAAS,mBAAmB,MAClC;;;;;;;;;;;;;;;CAgBH,cAAc,UAAU,uBACtBC,QAAQ,GACRC,MACI,WAAW,uBAAuB,GAAG,gBAAgB,KACrD,MAAM,WAAW,uBAAuB,GAAG,gBAAgB,KAC/DC,OAAO,iBAAiB,uBACrB;;;;;;;;;;;;;CAcL,iBAAiB,UAAU,uBACzBF,QAAQ,GACRG,MAAM,WAAW,uBAAuB,GAAG,gBAAgB,OACxD,QAAQ;CAEb,0BACE,UAAU,uBAAuB,qBAEjCC,OAAO,YAAY,OAChB,UAAU,YAAY;AAC5B;AAED,OAAO,iBAAS,uBAAuBC,QAAQ,SAAS;AA0BxD,iBAAiB,eAAe;CAC9B;AACD","names":["ctx: OptimisticBuilder","apiName: T[\"apiName\"] | T","pk: PrimaryKeyType<T>","options: ObserveOptions","subFn: Observer<ObserveObjectArgs<T>>","options: ObserveListOptions<T>","subFn: Observer<ObserveObjectsArgs<T>>","action: Q","args:\n | Parameters<ActionSignatureFromDef<Q>[\"applyAction\"]>[0]\n | Array<Parameters<ActionSignatureFromDef<Q>[\"applyAction\"]>[0]>","opts?: ObservableClient.ApplyActionOptions","args: Parameters<ActionSignatureFromDef<Q>[\"applyAction\"]>[0]","where: WhereClause<T>","client: Client"],"sources":["../../../src/observable/ObservableClient.ts"],"version":3,"file":"ObservableClient.d.ts"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"mappings":"AAgBA,iBAAiB,eAAe;CAC9B;AACD","names":[],"sources":["../../../src/observable/Unsubscribable.ts"],"version":3,"file":"Unsubscribable.d.ts"}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { CommonObserveOptions, Observer } from "../ObservableClient/common.js";
|
|
2
|
+
import type { KnownCacheKey } from "./KnownCacheKey.js";
|
|
3
|
+
import type { Query } from "./Query.js";
|
|
4
|
+
import { QuerySubscription } from "./QuerySubscription.js";
|
|
5
|
+
import type { Store } from "./Store.js";
|
|
6
|
+
export declare abstract class AbstractHelper<
|
|
7
|
+
TQuery extends Query<KnownCacheKey, any, CommonObserveOptions>,
|
|
8
|
+
TObserveOptions extends CommonObserveOptions
|
|
9
|
+
> {
|
|
10
|
+
protected readonly store: Store;
|
|
11
|
+
constructor(store: Store);
|
|
12
|
+
observe(options: TObserveOptions, subFn: Observer<TQuery extends Query<any, infer PAYLOAD, any> ? PAYLOAD : never>): QuerySubscription<TQuery>;
|
|
13
|
+
abstract getQuery(options: TObserveOptions): TQuery;
|
|
14
|
+
protected _subscribe(query: TQuery, options: TObserveOptions, subFn: Observer<TQuery extends Query<any, infer PAYLOAD, any> ? PAYLOAD : never>): QuerySubscription<TQuery>;
|
|
15
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"mappings":"AAgBA,cACE,sBACA,gBACK,+BAAgC;AACvC,cAAc,qBAAqB,oBAAqB;AACxD,cAAc,aAAa,YAAa;AACxC,SAAS,yBAAyB,wBAAyB;AAC3D,cAAc,aAAa,YAAa;AAExC,OAAO,uBAAe;CACpB,eAAe,MAAM,oBAAoB;CACzC,wBAAwB;EACxB;CACA,mBAAmB,OAAO;CAE1B,YAAYA,OAAO;CAInB,QACEC,SAAS,iBACTC,OAAO,SACL,eAAe,iBAAiB,gBAAgB,mBAEjD,kBAAkB;CAKrB,SAAS,SAASD,SAAS,kBAAkB;CAE7C,UAAU,WACRE,OAAO,QACPF,SAAS,iBACTC,OAAO,SACL,eAAe,iBAAiB,gBAAgB,mBAEjD,kBAAkB;AAyBtB","names":["store: Store","options: TObserveOptions","subFn: Observer<\n TQuery extends Query<any, infer PAYLOAD, any> ? PAYLOAD : never\n >","query: TQuery"],"sources":["../../../../src/observable/internal/AbstractHelper.ts"],"version":3,"file":"AbstractHelper.d.ts"}
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
import type { InterfaceHolder } from "../../object/convertWireToOsdkObjects/InterfaceHolder.js";
|
|
2
|
+
import type { ObjectHolder } from "../../object/convertWireToOsdkObjects/ObjectHolder.js";
|
|
3
|
+
import type { Status } from "../ObservableClient/common.js";
|
|
4
|
+
import { type ObjectCacheKey } from "./ObjectQuery.js";
|
|
5
|
+
/**
|
|
6
|
+
* Abstract base for ListQuery and SpecificLinkQuery.
|
|
7
|
+
* - Stores object references, not duplicates
|
|
8
|
+
* - Implements shared pagination and reference counting
|
|
9
|
+
* - Template method pattern for collection operations
|
|
10
|
+
*/
|
|
11
|
+
export interface CollectionStorageData {
|
|
12
|
+
data: ObjectCacheKey[];
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* Base interface for collection-based payloads (lists and links)
|
|
16
|
+
* Contains the common properties shared by all collection payload types
|
|
17
|
+
*/
|
|
18
|
+
export interface BaseCollectionPayload {
|
|
19
|
+
/**
|
|
20
|
+
* The resolved collection of objects
|
|
21
|
+
*/
|
|
22
|
+
resolvedList: Array<ObjectHolder | InterfaceHolder>;
|
|
23
|
+
/**
|
|
24
|
+
* Whether the data is from an optimistic update
|
|
25
|
+
*/
|
|
26
|
+
isOptimistic: boolean;
|
|
27
|
+
/**
|
|
28
|
+
* Function to fetch more items when available
|
|
29
|
+
*/
|
|
30
|
+
fetchMore: () => Promise<void>;
|
|
31
|
+
/**
|
|
32
|
+
* Whether there are more items available to fetch
|
|
33
|
+
*/
|
|
34
|
+
hasMore: boolean;
|
|
35
|
+
/**
|
|
36
|
+
* Current loading status
|
|
37
|
+
*/
|
|
38
|
+
status: Status;
|
|
39
|
+
/**
|
|
40
|
+
* Timestamp of when the data was last updated
|
|
41
|
+
*/
|
|
42
|
+
lastUpdated: number;
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* Common parameters available for constructing a collection payload
|
|
46
|
+
*/
|
|
47
|
+
export interface CollectionConnectableParams {
|
|
48
|
+
/**
|
|
49
|
+
* Array of resolved objects
|
|
50
|
+
*/
|
|
51
|
+
resolvedData: any[];
|
|
52
|
+
/**
|
|
53
|
+
* Whether the data is from an optimistic update
|
|
54
|
+
*/
|
|
55
|
+
isOptimistic: boolean;
|
|
56
|
+
/**
|
|
57
|
+
* Current loading status
|
|
58
|
+
*/
|
|
59
|
+
status: Status;
|
|
60
|
+
/**
|
|
61
|
+
* Timestamp of the last update
|
|
62
|
+
*/
|
|
63
|
+
lastUpdated: number;
|
|
64
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"mappings":"AAgBA,cAAc,uBAAuB,0DAA2D;AAChG,cAAc,oBAAoB,uDAAwD;AAC1F,cAAc,cAAc,+BAAgC;AAC5D,cAAc,sBAAsB,kBAAmB;;;;;;;AAQvD,iBAAiB,sBAAsB;CACrC,MAAM;AACP;;;;;AAMD,iBAAiB,sBAAsB;;;;CAIrC,cAAc,MAAM,eAAe;;;;CAKnC;;;;CAKA,iBAAiB;;;;CAKjB;;;;CAKA,QAAQ;;;;CAKR;AACD;;;;AAKD,iBAAiB,4BAA4B;;;;CAI3C;;;;CAKA;;;;CAKA,QAAQ;;;;CAKR;AACD","names":[],"sources":["../../../../src/observable/internal/BaseCollectionQuery.ts"],"version":3,"file":"BaseCollectionQuery.d.ts"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"mappings":"AAqBA,cAAiC,cAAc,iBAAkB;AACjE,cACE,oBACK,uDAAwD;AAgB/D,OAAO,iBAAS,oBAAoBA,QAAQ,SAAS;AAIrD,OAAO,cAAM,iBAAiB;;CAW5B,YAAYA,QAAQ,QAAQ,kBAAc;CAO1C,
|
|
1
|
+
{"mappings":"AAqBA,cAAiC,cAAc,iBAAkB;AACjE,cACE,oBACK,uDAAwD;AAgB/D,OAAO,iBAAS,oBAAoBA,QAAQ,SAAS;AAIrD,OAAO,cAAM,iBAAiB;;CAW5B,YAAYA,QAAQ,QAAQ,kBAAc;CAO1C,AAAa,MACXC,iBACAC,wCACC,QAAQ;AAyDZ","names":["client: Client","apiName: string","primaryKey: string | number | boolean"],"sources":["../../../../src/observable/internal/BulkObjectLoader.ts"],"version":3,"file":"BulkObjectLoader.d.ts"}
|
|
@@ -1,9 +1,15 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { KnownCacheKey } from "./KnownCacheKey.js";
|
|
2
2
|
import type { OrderByCanonicalizer } from "./OrderByCanonicalizer.js";
|
|
3
3
|
import type { WhereClauseCanonicalizer } from "./WhereClauseCanonicalizer.js";
|
|
4
|
+
/**
|
|
5
|
+
* Cache key management with canonicalization.
|
|
6
|
+
* - Formats: {type}:{pk} | {type}:list:{where} | {source}:{pk}:{link}:{where}
|
|
7
|
+
* - Uses Trie structure for efficient storage and lookup
|
|
8
|
+
* - Ensures consistent keys through canonicalization
|
|
9
|
+
*/
|
|
4
10
|
export declare class CacheKeys {
|
|
5
11
|
#private;
|
|
6
|
-
constructor(whereCanonicalizer: WhereClauseCanonicalizer, orderByCanonicalizer: OrderByCanonicalizer, onCreate: (cacheKey:
|
|
7
|
-
get<K extends
|
|
8
|
-
remove<K extends
|
|
12
|
+
constructor(whereCanonicalizer: WhereClauseCanonicalizer, orderByCanonicalizer: OrderByCanonicalizer, onCreate: (cacheKey: KnownCacheKey) => void);
|
|
13
|
+
get<K extends KnownCacheKey>(type: K["type"], ...args: K["__cacheKey"]["args"]): K;
|
|
14
|
+
remove<K extends KnownCacheKey>(cacheKey: K): void;
|
|
9
15
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"mappings":"
|
|
1
|
+
{"mappings":"AAoBA,cAAc,qBAAqB,oBAAqB;AAIxD,cAAc,4BAA4B,2BAA4B;AACtE,cAAc,gCAAgC,+BAAgC;;;;;;;AAU9E,OAAO,cAAM,UAAU;;CAYrB,YACEA,oBAAoB,0BACpBC,sBAAsB,sBACtBC,WAAWC,UAAU;CAsFvB,IAAI,UAAU,eACZC,MAAM,EAAE,SACR,GAAG,MAAM,EAAE,cAAc,UACxB;CAMH,OAAO,UAAU,eACfC,UAAU;AAIb","names":["whereCanonicalizer: WhereClauseCanonicalizer","orderByCanonicalizer: OrderByCanonicalizer","onCreate: (cacheKey: KnownCacheKey) => void","cacheKey: KnownCacheKey","type: K[\"type\"]","cacheKey: K"],"sources":["../../../../src/observable/internal/CacheKeys.ts"],"version":3,"file":"CacheKeys.d.ts"}
|
|
@@ -1,16 +1,19 @@
|
|
|
1
1
|
import { MultiMap } from "mnemonist";
|
|
2
2
|
import type { ObjectHolder } from "../../object/convertWireToOsdkObjects/ObjectHolder.js";
|
|
3
|
-
import type {
|
|
3
|
+
import type { SpecificLinkCacheKey } from "./links/SpecificLinkCacheKey.js";
|
|
4
|
+
import type { ListCacheKey } from "./ListCacheKey.js";
|
|
4
5
|
import type { ObjectCacheKey } from "./ObjectQuery.js";
|
|
5
6
|
export declare class Changes {
|
|
6
7
|
modifiedObjects: MultiMap<string, ObjectHolder>;
|
|
7
8
|
addedObjects: MultiMap<string, ObjectHolder>;
|
|
8
|
-
added: Set<ListCacheKey | ObjectCacheKey>;
|
|
9
|
-
modified: Set<ListCacheKey | ObjectCacheKey>;
|
|
10
|
-
deleted: Set<ListCacheKey | ObjectCacheKey>;
|
|
9
|
+
added: Set<ListCacheKey | ObjectCacheKey | SpecificLinkCacheKey>;
|
|
10
|
+
modified: Set<ListCacheKey | ObjectCacheKey | SpecificLinkCacheKey>;
|
|
11
|
+
deleted: Set<ListCacheKey | ObjectCacheKey | SpecificLinkCacheKey>;
|
|
11
12
|
registerObject: (cacheKey: ObjectCacheKey, data: ObjectHolder, isNew: boolean) => void;
|
|
12
13
|
deleteObject: (cacheKey: ObjectCacheKey) => void;
|
|
13
14
|
registerList: (key: ListCacheKey) => void;
|
|
15
|
+
registerLink: (cacheKey: SpecificLinkCacheKey) => void;
|
|
16
|
+
deleteLink: (cacheKey: SpecificLinkCacheKey) => void;
|
|
14
17
|
isEmpty(): boolean;
|
|
15
18
|
}
|
|
16
19
|
export declare function createChangedObjects(): Changes;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"mappings":"AAgBA,SAAS,gBAAgB,WAAY;AACrC,cAAc,oBAAoB,uDAAwD;AAG1F,cAAc,oBAAoB,
|
|
1
|
+
{"mappings":"AAgBA,SAAS,gBAAgB,WAAY;AACrC,cAAc,oBAAoB,uDAAwD;AAG1F,cAAc,4BAA4B,iCAAkC;AAC5E,cAAc,oBAAoB,mBAAoB;AACtD,cAAc,sBAAsB,kBAAmB;AAEvD,OAAO,cAAM,QAAQ;CACnB,iBAAiB,iBAAiB;CAClC,cAAc,iBAAiB;CAE/B,OAAO,IAAI,eAAe,iBAAiB;CAC3C,UAAU,IAAI,eAAe,iBAAiB;CAE9C,SAAS,IAAI,eAAe,iBAAiB;CAG7C,iBACEA,UAAU,gBACVC,MAAM,cACNC;CAMF,eAAgBF,UAAU;CAI1B,eAAgBG,KAAK;CAIrB,eAAgBC,UAAU;CAI1B,aAAcA,UAAU;CAIxB;AASD;AAED,OAAO,iBAAS,wBAAwB;AAIxC,OAAO,iBAAS,4BAA4BC,SAAS","names":["cacheKey: ObjectCacheKey","data: ObjectHolder","isNew: boolean","key: ListCacheKey","cacheKey: SpecificLinkCacheKey","changes: Changes"],"sources":["../../../../src/observable/internal/Changes.ts"],"version":3,"file":"Changes.d.ts"}
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import type { SpecificLinkCacheKey } from "./links/SpecificLinkCacheKey.js";
|
|
2
|
+
import type { ListCacheKey } from "./ListCacheKey.js";
|
|
3
|
+
import type { ObjectCacheKey } from "./ObjectQuery.js";
|
|
4
|
+
export type KnownCacheKey = ObjectCacheKey | SpecificLinkCacheKey | ListCacheKey;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"mappings":"AAgBA,cAAc,4BAA4B,iCAAkC;AAC5E,cAAc,oBAAoB,mBAAoB;AACtD,cAAc,sBAAsB,kBAAmB;AAEvD,YAAY,gBACR,iBACA,uBACA","names":[],"sources":["../../../../src/observable/internal/KnownCacheKey.ts"],"version":3,"file":"KnownCacheKey.d.ts"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { KnownCacheKey } from "./KnownCacheKey.js";
|
|
2
2
|
export declare class Layer {
|
|
3
3
|
#private;
|
|
4
4
|
constructor(parent: Layer | undefined, layerId: unknown);
|
|
@@ -6,15 +6,15 @@ export declare class Layer {
|
|
|
6
6
|
get layerId(): unknown;
|
|
7
7
|
addLayer(layerId: unknown): Layer;
|
|
8
8
|
removeLayer(layerId: unknown): Layer;
|
|
9
|
-
entries(): IterableIterator<[
|
|
10
|
-
keys(): IterableIterator<
|
|
11
|
-
get<K extends
|
|
12
|
-
set<K extends
|
|
9
|
+
entries(): IterableIterator<[KnownCacheKey, Entry<any>]>;
|
|
10
|
+
keys(): IterableIterator<KnownCacheKey>;
|
|
11
|
+
get<K extends KnownCacheKey>(cacheKey: K): Entry<K> | undefined;
|
|
12
|
+
set<K extends KnownCacheKey>(cacheKey: K, value: Entry<K>): void;
|
|
13
13
|
}
|
|
14
|
-
export declare class Entry<K extends
|
|
14
|
+
export declare class Entry<K extends KnownCacheKey> {
|
|
15
15
|
readonly cacheKey: K;
|
|
16
16
|
value: K["__cacheKey"]["value"] | undefined;
|
|
17
17
|
lastUpdated: number;
|
|
18
18
|
status: "init" | "loading" | "loaded" | "error";
|
|
19
|
-
constructor(cacheKey: K, value: K["__cacheKey"]["value"], lastUpdated: number, status?: "init" | "loading" | "loaded" | "error");
|
|
19
|
+
constructor(cacheKey: K, value: K["__cacheKey"]["value"] | undefined, lastUpdated: number, status?: "init" | "loading" | "loaded" | "error");
|
|
20
20
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"mappings":"AAgBA,cAAc,
|
|
1
|
+
{"mappings":"AAgBA,cAAc,qBAAqB,oBAAqB;AAcxD,OAAO,cAAM,MAAM;;CAKjB,YAAYA,QAAQ,mBAAmBC;CAKvC,IAAI,eAAe;CAInB,IAAI;CAIJ,SAASA,mBAAmB;CAI5B,YAAYA,mBAAmB;CAc/B,WAAW,kBAAkB,eAAe;CAI5C,QAAQ,iBAAiB;CAIzB,AAAO,IAAI,UAAU,eACnBC,UAAU,IACT,MAAM;CAKT,AAAO,IAAI,UAAU,eACnBA,UAAU,GACVC,OAAO,MAAM;AAIhB;AAED,OAAO,cAAM,MAAM,UAAU,eAAe;CAC1C,SAAS,UAAU;CACnB,OAAO,EAAE,cAAc;CACvB;CACA,QAAQ,SAAS,YAAY,WAAW;CAExC,YACED,UAAU,GACVE,OAAO,EAAE,cAAc,sBACvBC,qBACAC,SAAQ,SAAS,YAAY,WAAW;AAO3C","names":["parent: Layer | undefined","layerId: unknown","cacheKey: K","value: Entry<K>","value: K[\"__cacheKey\"][\"value\"] | undefined","lastUpdated: number","status: \"init\" | \"loading\" | \"loaded\" | \"error\""],"sources":["../../../../src/observable/internal/Layer.ts"],"version":3,"file":"Layer.d.ts"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type { CollectionStorageData } from "./BaseCollectionQuery.js";
|
|
2
|
+
import type { CacheKey } from "./CacheKey.js";
|
|
3
|
+
import type { Canonical } from "./Canonical.js";
|
|
4
|
+
import type { ListQuery } from "./ListQuery.js";
|
|
5
|
+
import type { SimpleWhereClause } from "./SimpleWhereClause.js";
|
|
6
|
+
export interface ListStorageData extends CollectionStorageData {}
|
|
7
|
+
export interface ListCacheKey extends CacheKey<"list", ListStorageData, ListQuery, [type: "object" | "interface", apiName: string, whereClause: Canonical<SimpleWhereClause>, orderByClause: Canonical<Record<string, "asc" | "desc" | undefined>>]> {}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"mappings":"AAgBA,cAAc,6BAA6B,0BAA2B;AACtE,cAAc,gBAAgB,eAAgB;AAC9C,cAAc,iBAAiB,gBAAiB;AAChD,cAAc,iBAAiB,gBAAiB;AAChD,cAAc,yBAAyB,wBAAyB;AAEhE,iBAAiB,wBAAwB,sBAAsB,CAAE;AAEjE,iBAAiB,qBACf,SACE,QACA,iBACA,YAEE,MAAM,WAAW,aACjB,iBACA,aAAa,UAAU,oBACvB,eAAe,UAAU,eAAe,QAAQ,uBAGtD,CACC","names":[],"sources":["../../../../src/observable/internal/ListCacheKey.ts"],"version":3,"file":"ListCacheKey.d.ts"}
|
|
@@ -1,8 +1,10 @@
|
|
|
1
|
+
import type { Osdk, PageResult } from "@osdk/api";
|
|
1
2
|
import type { Connectable, Observable, Subscription } from "rxjs";
|
|
2
3
|
import type { InterfaceHolder } from "../../object/convertWireToOsdkObjects/InterfaceHolder.js";
|
|
3
4
|
import type { ObjectHolder } from "../../object/convertWireToOsdkObjects/ObjectHolder.js";
|
|
4
5
|
import type { ListPayload } from "../ListPayload.js";
|
|
5
|
-
import type { CommonObserveOptions, Status } from "../ObservableClient.js";
|
|
6
|
+
import type { CommonObserveOptions, Status } from "../ObservableClient/common.js";
|
|
7
|
+
import type { CollectionConnectableParams, CollectionStorageData } from "./BaseCollectionQuery.js";
|
|
6
8
|
import { type CacheKey } from "./CacheKey.js";
|
|
7
9
|
import type { Canonical } from "./Canonical.js";
|
|
8
10
|
import { type Changes } from "./Changes.js";
|
|
@@ -11,10 +13,9 @@ import { type ObjectCacheKey } from "./ObjectQuery.js";
|
|
|
11
13
|
import type { OptimisticId } from "./OptimisticId.js";
|
|
12
14
|
import { Query } from "./Query.js";
|
|
13
15
|
import type { SimpleWhereClause } from "./SimpleWhereClause.js";
|
|
16
|
+
import type { SortingStrategy } from "./sorting/SortingStrategy.js";
|
|
14
17
|
import type { BatchContext, Store, SubjectPayload } from "./Store.js";
|
|
15
|
-
interface ListStorageData {
|
|
16
|
-
data: ObjectCacheKey[];
|
|
17
|
-
}
|
|
18
|
+
export interface ListStorageData extends CollectionStorageData {}
|
|
18
19
|
export interface ListCacheKey extends CacheKey<"list", ListStorageData, ListQuery, [type: "object" | "interface", apiName: string, whereClause: Canonical<SimpleWhereClause>, orderByClause: Canonical<Record<string, "asc" | "desc" | undefined>>]> {}
|
|
19
20
|
export interface BaseListCacheKey<
|
|
20
21
|
T_Type extends string,
|
|
@@ -33,35 +34,173 @@ type ExtractRelevantObjectsResult = Record<"added" | "modified", {
|
|
|
33
34
|
strictMatches: Set<(ObjectHolder | InterfaceHolder)>
|
|
34
35
|
sortaMatches: Set<(ObjectHolder | InterfaceHolder)>
|
|
35
36
|
}>;
|
|
36
|
-
|
|
37
|
-
|
|
37
|
+
/**
|
|
38
|
+
* Base class for collection-based queries (lists and links)
|
|
39
|
+
* Provides common functionality for working with collections of objects
|
|
40
|
+
*/
|
|
41
|
+
export declare abstract class BaseListQuery<
|
|
42
|
+
KEY extends CacheKey<any, CollectionStorageData, any, any>,
|
|
38
43
|
PAYLOAD,
|
|
39
44
|
O extends CommonObserveOptions
|
|
40
45
|
> extends Query<KEY, PAYLOAD, O> {
|
|
41
46
|
#private;
|
|
42
|
-
protected abstract _sortCacheKeys(objectCacheKeys: ObjectCacheKey[], batch: BatchContext): ObjectCacheKey[];
|
|
43
47
|
/**
|
|
44
|
-
*
|
|
45
|
-
*
|
|
48
|
+
* The sorting strategy to use for this collection
|
|
49
|
+
* @protected
|
|
50
|
+
*/
|
|
51
|
+
protected sortingStrategy: SortingStrategy;
|
|
52
|
+
/**
|
|
53
|
+
* Token for the next page of results
|
|
54
|
+
* @protected
|
|
55
|
+
*/
|
|
56
|
+
protected nextPageToken?: string;
|
|
57
|
+
/**
|
|
58
|
+
* Promise tracking an in-progress page fetch
|
|
59
|
+
* @protected
|
|
60
|
+
*/
|
|
61
|
+
protected pendingPageFetch?: Promise<void>;
|
|
62
|
+
/**
|
|
63
|
+
* Standard method to update a list of objects
|
|
64
|
+
* Handles common list update patterns for both ListQuery and SpecificLinkQuery
|
|
46
65
|
*
|
|
47
|
-
* @param
|
|
48
|
-
* @param
|
|
49
|
-
* @param
|
|
50
|
-
* @param
|
|
51
|
-
* @returns
|
|
66
|
+
* @param items Objects or cache keys to add to the list
|
|
67
|
+
* @param status Status to set for the list
|
|
68
|
+
* @param batch Batch context to use
|
|
69
|
+
* @param append Whether to append to the existing list or replace it
|
|
70
|
+
* @returns The updated entry
|
|
71
|
+
*/
|
|
72
|
+
_updateList<T extends ObjectCacheKey | Osdk.Instance<any>>(items: T[], status: Status, batch: BatchContext, append?: boolean): Entry<KEY>;
|
|
73
|
+
/**
|
|
74
|
+
* Common implementation for writing to store for collection-based queries
|
|
75
|
+
* @param data The collection data to write to the store
|
|
76
|
+
* @param status The status to set
|
|
77
|
+
* @param batch The batch context
|
|
52
78
|
*/
|
|
53
|
-
|
|
54
|
-
|
|
79
|
+
writeToStore(data: CollectionStorageData, status: Status, batch: BatchContext): Entry<KEY>;
|
|
80
|
+
/**
|
|
81
|
+
* Register changes to the cache based on the specific collection type
|
|
82
|
+
* Implemented by subclasses to handle specific change registration
|
|
83
|
+
*/
|
|
84
|
+
protected abstract registerCacheChanges(batch: BatchContext): void;
|
|
85
|
+
/**
|
|
86
|
+
* Common method to store objects in the cache and return their cache keys
|
|
87
|
+
* Used by collection queries when storing object references
|
|
88
|
+
*
|
|
89
|
+
* @param objects Array of objects to store
|
|
90
|
+
* @param batch The batch context to use
|
|
91
|
+
* @returns Array of cache keys for the stored objects
|
|
92
|
+
*/
|
|
93
|
+
protected storeObjects(objects: Array<Osdk.Instance<any>>, batch: BatchContext): Array<ObjectCacheKey>;
|
|
55
94
|
_dispose(): void;
|
|
95
|
+
/**
|
|
96
|
+
* Creates a payload from collection parameters
|
|
97
|
+
* Default implementation that covers common fields for all collection types
|
|
98
|
+
* Subclasses may override to add type-specific fields if needed
|
|
99
|
+
*
|
|
100
|
+
* @param params Common collection parameters
|
|
101
|
+
* @returns A typed payload for the specific collection type
|
|
102
|
+
*/
|
|
103
|
+
protected createPayload(params: CollectionConnectableParams): PAYLOAD;
|
|
104
|
+
/**
|
|
105
|
+
* Creates a connectable observable for this collection
|
|
106
|
+
* Common implementation shared by all collection types
|
|
107
|
+
*
|
|
108
|
+
* @param subject The subject to connect to
|
|
109
|
+
* @returns A connectable observable of the collection's payload type
|
|
110
|
+
*/
|
|
111
|
+
protected _createConnectable(subject: Observable<SubjectPayload<KEY>>): Connectable<PAYLOAD>;
|
|
112
|
+
/**
|
|
113
|
+
* @override Reset pagination state before a fetch
|
|
114
|
+
*/
|
|
115
|
+
protected _preFetch(): void;
|
|
116
|
+
/**
|
|
117
|
+
* Common fetchMore implementation for pagination
|
|
118
|
+
* Handles pending request management and loading states
|
|
119
|
+
*/
|
|
120
|
+
fetchMore: () => Promise<void>;
|
|
121
|
+
/**
|
|
122
|
+
* Minimum number of results to load initially
|
|
123
|
+
* May be overridden by subclasses for specific collection types
|
|
124
|
+
* @protected
|
|
125
|
+
*/
|
|
126
|
+
protected minResultsToLoad: number;
|
|
127
|
+
/**
|
|
128
|
+
* Common _fetchAndStore implementation for pagination
|
|
129
|
+
* Uses fetchPageAndUpdate to load the initial set of data
|
|
130
|
+
* Will load multiple pages if necessary to reach minResultsToLoad
|
|
131
|
+
*/
|
|
132
|
+
protected _fetchAndStore(): Promise<void>;
|
|
133
|
+
/**
|
|
134
|
+
* Template method for fetching a page of data and updating the store
|
|
135
|
+
* Provides common error handling and abort signal checking
|
|
136
|
+
*
|
|
137
|
+
* @param status The status to set for the entry
|
|
138
|
+
* @param signal Optional AbortSignal for cancellation
|
|
139
|
+
* @returns A promise that resolves to the updated entry or undefined if aborted
|
|
140
|
+
*/
|
|
141
|
+
protected fetchPageAndUpdate(status: Status, signal: AbortSignal | undefined): Promise<Entry<KEY> | undefined>;
|
|
142
|
+
/**
|
|
143
|
+
* Abstract method that subclasses implement for their specific data fetching logic
|
|
144
|
+
*
|
|
145
|
+
* @param signal Optional AbortSignal for cancellation
|
|
146
|
+
* @returns A promise that resolves to the fetched data
|
|
147
|
+
*/
|
|
148
|
+
protected abstract fetchPageData(signal: AbortSignal | undefined): Promise<PageResult<Osdk.Instance<any>>>;
|
|
149
|
+
/**
|
|
150
|
+
* Handle fetch errors by setting appropriate error state
|
|
151
|
+
* Default implementation that subclasses can override
|
|
152
|
+
*
|
|
153
|
+
* @param error The error that occurred
|
|
154
|
+
* @param status The intended status if successful
|
|
155
|
+
* @param batch The batch context to use
|
|
156
|
+
* @returns The updated entry with error status
|
|
157
|
+
*/
|
|
158
|
+
protected handleFetchError(_error: unknown, _status: Status, batch: BatchContext): Entry<KEY>;
|
|
159
|
+
/**
|
|
160
|
+
* Sort the collection items using the configured sorting strategy
|
|
161
|
+
* @param objectCacheKeys - The cache keys to sort
|
|
162
|
+
* @param batch - The batch context
|
|
163
|
+
* @returns Sorted array of cache keys
|
|
164
|
+
*/
|
|
165
|
+
protected _sortCacheKeys(objectCacheKeys: ObjectCacheKey[], batch: BatchContext): ObjectCacheKey[];
|
|
166
|
+
/**
|
|
167
|
+
* Unified method for updating collection data in the store
|
|
168
|
+
* Handles storing, sorting, deduplication, and reference counting
|
|
169
|
+
*
|
|
170
|
+
* @param items - Either object cache keys or object instances to update
|
|
171
|
+
* @param options - Configuration options for the update
|
|
172
|
+
* @param batch - The batch context to use
|
|
173
|
+
* @returns The updated entry
|
|
174
|
+
*/
|
|
175
|
+
protected updateCollection<T extends ObjectCacheKey | Osdk.Instance<any>>(items: T[], options: {
|
|
176
|
+
append?: boolean
|
|
177
|
+
status: Status
|
|
178
|
+
}, batch: BatchContext): Entry<KEY>;
|
|
56
179
|
}
|
|
180
|
+
/**
|
|
181
|
+
* Implements filtered and sorted object collection queries.
|
|
182
|
+
* - Handles where clause filtering and orderBy sorting
|
|
183
|
+
* - Manages pagination through fetchMore
|
|
184
|
+
* - Auto-updates when matching objects change
|
|
185
|
+
* - Uses canonicalized cache keys for consistency
|
|
186
|
+
*/
|
|
57
187
|
export declare class ListQuery extends BaseListQuery<ListCacheKey, ListPayload, ListQueryOptions> {
|
|
58
188
|
#private;
|
|
189
|
+
/**
|
|
190
|
+
* Register changes to the cache specific to ListQuery
|
|
191
|
+
*/
|
|
192
|
+
protected registerCacheChanges(batch: BatchContext): void;
|
|
59
193
|
constructor(store: Store, subject: Observable<SubjectPayload<ListCacheKey>>, apiType: "object" | "interface", apiName: string, whereClause: Canonical<SimpleWhereClause>, orderBy: Canonical<Record<string, "asc" | "desc" | undefined>>, cacheKey: ListCacheKey, opts: ListQueryOptions);
|
|
60
194
|
get canonicalWhere(): Canonical<SimpleWhereClause>;
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
195
|
+
/**
|
|
196
|
+
* Implements fetchPageData from BaseCollectionQuery template method
|
|
197
|
+
* Fetches a page of data
|
|
198
|
+
*/
|
|
199
|
+
protected fetchPageData(signal: AbortSignal | undefined): Promise<PageResult<Osdk.Instance<any>>>;
|
|
200
|
+
/**
|
|
201
|
+
* Handle fetch errors by setting appropriate error state and notifying subscribers
|
|
202
|
+
*/
|
|
203
|
+
protected handleFetchError(error: unknown, _status: Status, batch: BatchContext): Entry<ListCacheKey>;
|
|
65
204
|
/**
|
|
66
205
|
* Will revalidate the list if its query is affected by invalidating the
|
|
67
206
|
* apiName of the object type passed in.
|
|
@@ -70,6 +209,7 @@ export declare class ListQuery extends BaseListQuery<ListCacheKey, ListPayload,
|
|
|
70
209
|
* @returns
|
|
71
210
|
*/
|
|
72
211
|
revalidateObjectType: (apiName: string) => Promise<void>;
|
|
212
|
+
invalidateObjectType: (objectType: string, changes: Changes | undefined) => Promise<void>;
|
|
73
213
|
/**
|
|
74
214
|
* Note: This method is not async because I want it to return right after it
|
|
75
215
|
* finishes the synchronous updates. The promise that is returned
|
|
@@ -81,7 +221,6 @@ export declare class ListQuery extends BaseListQuery<ListCacheKey, ListPayload,
|
|
|
81
221
|
*/
|
|
82
222
|
maybeUpdateAndRevalidate: (changes: Changes, optimisticId: OptimisticId | undefined) => Promise<void> | undefined;
|
|
83
223
|
protected _extractRelevantObjects(changes: Changes): ExtractRelevantObjectsResult;
|
|
84
|
-
_sortCacheKeys(objectCacheKeys: ObjectCacheKey[], batch: BatchContext): ObjectCacheKey[];
|
|
85
224
|
registerStreamUpdates(sub: Subscription): void;
|
|
86
225
|
}
|
|
87
226
|
export declare function isListCacheKey(cacheKey: CacheKey): cacheKey is ListCacheKey;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"mappings":"
|
|
1
|
+
{"mappings":"AAgBA,cAKE,MACA,kBAEK,WAAY;AAGnB,cAAc,aAAa,YAAY,oBAAoB,MAAO;AAGlE,cAAc,uBAAuB,0DAA2D;AAKhG,cACE,oBACK,uDAAwD;AAC/D,cAAc,mBAAmB,mBAAoB;AACrD,cACE,sBACA,cACK,+BAAgC;AACvC,cACE,6BACA,6BACK,0BAA2B;AAClC,cAAc,gBAA+C,eAAgB;AAC7E,cAAc,iBAAiB,gBAAiB;AAChD,cAAc,eAA4C,cAAe;AAGzE,cAAc,aAAa,YAAa;AAExC,cAAc,sBAA0C,kBAAmB;AAC3E,cAAc,oBAAoB,mBAAoB;AACtD,SAAS,aAAa,YAAa;AAEnC,cAAc,yBAAyB,wBAAyB;AAChE,cAAc,uBAAuB,8BAA+B;AAKpE,cAAc,cAAc,OAAO,sBAAsB,YAAa;AAEtE,iBAAiB,wBAAwB,sBAAsB,CAAE;AAEjE,iBAAiB,qBACf,SACE,QACA,iBACA,YAEE,MAAM,WAAW,aACjB,iBACA,aAAa,UAAU,oBACvB,eAAe,UAAU,eAAe,QAAQ,uBAGtD,CAAE;AAEF,iBAAiB;CACf;CACA,gBAAgB;CAChB;UACQ,SAAS,QAAQ,iBAAiB,SAAS,kBAAkB,CACtE;AAED,OAAO,cAAM,eAAe;AAC5B,OAAO,cAAM,WAAW;AACxB,OAAO,cAAM,YAAY;AACzB,OAAO,cAAM,eAAe;AAE5B,iBAAiB,yBAAyB,qBAAqB;CAC7D;AACD;KAEI,+BAA+B,OAAO,UAAU,YAAY;CAC/D,MAAM,eAAe;CACrB,eAAe,KAAK,eAAe;CACnC,cAAc,KAAK,eAAe;AACnC;;;;;AAMD,OAAO,uBAAe;CACpB,YAAY,cAAc;CAC1B;CACA,UAAU;UACF,MAAM,KAAK,SAAS,GAAG;;;;;;CAK/B,UAAU,iBAAiB;;;;;CAO3B,UAAU;;;;;CAMV,UAAU,mBAAmB;;;;;;;;;;;CAgB7B,AAAO,YAAY,UAAU,iBAAiB,KAAK,eACjDA,OAAO,KACPC,QAAQ,QACRC,OAAO,cACPC,mBACC,MAAM;;;;;;;CAwCT,aACEC,MAAM,uBACNH,QAAQ,QACRC,OAAO,eACN,MAAM;;;;;CAwCT,mBAAmB,qBAAqBA,OAAO;;;;;;;;;CAU/C,UAAU,aACRG,SAAS,MAAM,KAAK,gBACpBH,OAAO,eACN,MAAM;CAgDT;;;;;;;;;CAqBA,UAAU,cACRI,QAAQ,8BACP;;;;;;;;CAkBH,UAAU,mBACRC,SAAS,WAAW,eAAe,QAClC,YAAY;;;;CAWf,UAAU;;;;;CASV,iBAAgB;;;;;;CAmChB,UAAU;;;;;;CAOV,UAAgB,kBAAkB;;;;;;;;;CAyClC,UAAgB,mBACdN,QAAQ,QACRO,QAAQ,0BACP,QAAQ,MAAM;;;;;;;CA+DjB,mBAAmB,cACjBA,QAAQ,0BACP,QAAQ,WAAW,KAAK;;;;;;;;;;CAW3B,UAAU,iBACRC,iBACAC,SAAS,QACTR,OAAO,eACN,MAAM;;;;;;;CAYT,UAAU,eACRS,iBAAiB,kBACjBT,OAAO,eACN;;;;;;;;;;CAaH,UAAU,iBAAiB,UAAU,iBAAiB,KAAK,eACzDF,OAAO,KACPY,SAAS;EACP;EACA,QAAQ;CACT,GACDV,OAAO,eACN,MAAM;AA4CV;;;;;;;;AASD,OAAO,cAAM,kBAAkB,cAC7B,cACA,aACA,kBACA;;;;;CAcA,UAAU,qBAAqBA,OAAO;CAItC,YACEW,OAAO,OACPC,SAAS,WAAW,eAAe,gBACnCC,SAAS,WAAW,aACpBC,iBACAC,aAAa,UAAU,oBACvBC,SAAS,UAAU,eAAe,QAAQ,sBAC1CC,UAAU,cACVC,MAAM;CAoCR,IAAI,kBAAkB,UAAU;;;;;CAQhC,UAAgB,cACdZ,QAAQ,0BACP,QAAQ,WAAW,KAAK;;;;CAqC3B,UAAU,iBACRa,gBACAX,SAAS,QACTR,OAAO,eACN,MAAM;;;;;;;;CAgBT,uBACEc,oBACC;CAqBH,uBACEM,oBACAC,SAAS,wBACR;;;;;;;;;;CAkBH,2BACEC,SAAS,SACTC,cAAc,6BACb;CAiIH,UAAU,wBACRD,SAAS,UACR;CAoEH,sBAAsBE,KAAK;AAqJ5B;AAsDD,OAAO,iBAAS,eACdC,UAAU,WACT,YAAY","names":["items: T[]","status: Status","batch: BatchContext","append: boolean","data: CollectionStorageData","objects: Array<Osdk.Instance<any>>","params: CollectionConnectableParams","subject: Observable<SubjectPayload<KEY>>","signal: AbortSignal | undefined","_error: unknown","_status: Status","objectCacheKeys: ObjectCacheKey[]","options: {\n append?: boolean;\n status: Status;\n }","store: Store","subject: Observable<SubjectPayload<ListCacheKey>>","apiType: \"object\" | \"interface\"","apiName: string","whereClause: Canonical<SimpleWhereClause>","orderBy: Canonical<Record<string, \"asc\" | \"desc\" | undefined>>","cacheKey: ListCacheKey","opts: ListQueryOptions","error: unknown","objectType: string","changes: Changes | undefined","changes: Changes","optimisticId: OptimisticId | undefined","sub: Subscription","cacheKey: CacheKey"],"sources":["../../../../src/observable/internal/ListQuery.ts"],"version":3,"file":"ListQuery.d.ts"}
|
|
@@ -2,8 +2,9 @@ import type { ObjectTypeDefinition, PrimaryKeyType } from "@osdk/api";
|
|
|
2
2
|
import type { Connectable, Observable, Subject } from "rxjs";
|
|
3
3
|
import type { ObjectHolder } from "../../object/convertWireToOsdkObjects/ObjectHolder.js";
|
|
4
4
|
import type { ObjectPayload } from "../ObjectPayload.js";
|
|
5
|
-
import type { CommonObserveOptions, Status } from "../ObservableClient.js";
|
|
5
|
+
import type { CommonObserveOptions, Status } from "../ObservableClient/common.js";
|
|
6
6
|
import type { CacheKey } from "./CacheKey.js";
|
|
7
|
+
import type { Changes } from "./Changes.js";
|
|
7
8
|
import type { Entry } from "./Layer.js";
|
|
8
9
|
import { Query } from "./Query.js";
|
|
9
10
|
import type { BatchContext, Store, SubjectPayload } from "./Store.js";
|
|
@@ -16,4 +17,5 @@ export declare class ObjectQuery extends Query<ObjectCacheKey, ObjectPayload, Co
|
|
|
16
17
|
_fetchAndStore(): Promise<void>;
|
|
17
18
|
writeToStore(data: ObjectHolder, status: Status, batch: BatchContext): Entry<ObjectCacheKey>;
|
|
18
19
|
deleteFromStore(status: Status, batch: BatchContext): Entry<ObjectCacheKey> | undefined;
|
|
20
|
+
invalidateObjectType: (objectType: string, changes: Changes | undefined) => Promise<void>;
|
|
19
21
|
}
|