@osdk/client 2.5.0-beta.10 → 2.5.0-beta.12

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.
Files changed (99) hide show
  1. package/CHANGELOG.md +25 -0
  2. package/build/browser/definitions/LinkDefinitions.test.js.map +1 -1
  3. package/build/browser/fetchMetadata.test.js +4 -0
  4. package/build/browser/fetchMetadata.test.js.map +1 -1
  5. package/build/browser/object/convertWireToOsdkObjects.test.js +5 -1
  6. package/build/browser/object/convertWireToOsdkObjects.test.js.map +1 -1
  7. package/build/browser/object/fetchPage.js +3 -2
  8. package/build/browser/object/fetchPage.js.map +1 -1
  9. package/build/browser/observable/ObjectSetPayload.js +2 -0
  10. package/build/browser/observable/ObjectSetPayload.js.map +1 -0
  11. package/build/browser/observable/ObservableClient.js.map +1 -1
  12. package/build/browser/observable/computeObjectSetCacheKey.js +64 -0
  13. package/build/browser/observable/computeObjectSetCacheKey.js.map +1 -0
  14. package/build/browser/observable/internal/Changes.js +3 -0
  15. package/build/browser/observable/internal/Changes.js.map +1 -1
  16. package/build/browser/observable/internal/KnownCacheKey.js.map +1 -1
  17. package/build/browser/observable/internal/ObservableClientImpl.js +8 -0
  18. package/build/browser/observable/internal/ObservableClientImpl.js.map +1 -1
  19. package/build/browser/observable/internal/Query.js +18 -1
  20. package/build/browser/observable/internal/Query.js.map +1 -1
  21. package/build/browser/observable/internal/Store.js +2 -0
  22. package/build/browser/observable/internal/Store.js.map +1 -1
  23. package/build/browser/observable/internal/objectset/ObjectSetCacheKey.js +2 -0
  24. package/build/browser/observable/internal/objectset/ObjectSetCacheKey.js.map +1 -0
  25. package/build/browser/observable/internal/objectset/ObjectSetHelper.js +69 -0
  26. package/build/browser/observable/internal/objectset/ObjectSetHelper.js.map +1 -0
  27. package/build/browser/observable/internal/objectset/ObjectSetQuery.js +151 -0
  28. package/build/browser/observable/internal/objectset/ObjectSetQuery.js.map +1 -0
  29. package/build/browser/observable/internal/objectset/ObjectSetQueryOptions.js +2 -0
  30. package/build/browser/observable/internal/objectset/ObjectSetQueryOptions.js.map +1 -0
  31. package/build/browser/public/unstable-do-not-use.js +1 -0
  32. package/build/browser/public/unstable-do-not-use.js.map +1 -1
  33. package/build/browser/util/UserAgent.js +2 -2
  34. package/build/cjs/{chunk-GVGP7T5P.cjs → chunk-2YVNXAHH.cjs} +4 -3
  35. package/build/cjs/chunk-2YVNXAHH.cjs.map +1 -0
  36. package/build/cjs/{chunk-YADG7KA6.cjs → chunk-DQKB6WZY.cjs} +54 -54
  37. package/build/cjs/{chunk-YADG7KA6.cjs.map → chunk-DQKB6WZY.cjs.map} +1 -1
  38. package/build/cjs/index.cjs +7 -7
  39. package/build/cjs/public/internal.cjs +8 -8
  40. package/build/cjs/public/unstable-do-not-use.cjs +402 -156
  41. package/build/cjs/public/unstable-do-not-use.cjs.map +1 -1
  42. package/build/cjs/public/unstable-do-not-use.d.cts +57 -6
  43. package/build/esm/definitions/LinkDefinitions.test.js.map +1 -1
  44. package/build/esm/fetchMetadata.test.js +4 -0
  45. package/build/esm/fetchMetadata.test.js.map +1 -1
  46. package/build/esm/object/convertWireToOsdkObjects.test.js +5 -1
  47. package/build/esm/object/convertWireToOsdkObjects.test.js.map +1 -1
  48. package/build/esm/object/fetchPage.js +3 -2
  49. package/build/esm/object/fetchPage.js.map +1 -1
  50. package/build/esm/observable/ObjectSetPayload.js +2 -0
  51. package/build/esm/observable/ObjectSetPayload.js.map +1 -0
  52. package/build/esm/observable/ObservableClient.js.map +1 -1
  53. package/build/esm/observable/computeObjectSetCacheKey.js +64 -0
  54. package/build/esm/observable/computeObjectSetCacheKey.js.map +1 -0
  55. package/build/esm/observable/internal/Changes.js +3 -0
  56. package/build/esm/observable/internal/Changes.js.map +1 -1
  57. package/build/esm/observable/internal/KnownCacheKey.js.map +1 -1
  58. package/build/esm/observable/internal/ObservableClientImpl.js +8 -0
  59. package/build/esm/observable/internal/ObservableClientImpl.js.map +1 -1
  60. package/build/esm/observable/internal/Query.js +18 -1
  61. package/build/esm/observable/internal/Query.js.map +1 -1
  62. package/build/esm/observable/internal/Store.js +2 -0
  63. package/build/esm/observable/internal/Store.js.map +1 -1
  64. package/build/esm/observable/internal/objectset/ObjectSetCacheKey.js +2 -0
  65. package/build/esm/observable/internal/objectset/ObjectSetCacheKey.js.map +1 -0
  66. package/build/esm/observable/internal/objectset/ObjectSetHelper.js +69 -0
  67. package/build/esm/observable/internal/objectset/ObjectSetHelper.js.map +1 -0
  68. package/build/esm/observable/internal/objectset/ObjectSetQuery.js +151 -0
  69. package/build/esm/observable/internal/objectset/ObjectSetQuery.js.map +1 -0
  70. package/build/esm/observable/internal/objectset/ObjectSetQueryOptions.js +2 -0
  71. package/build/esm/observable/internal/objectset/ObjectSetQueryOptions.js.map +1 -0
  72. package/build/esm/public/unstable-do-not-use.js +1 -0
  73. package/build/esm/public/unstable-do-not-use.js.map +1 -1
  74. package/build/esm/util/UserAgent.js +2 -2
  75. package/build/types/observable/ObjectSetPayload.d.ts +5 -0
  76. package/build/types/observable/ObjectSetPayload.d.ts.map +1 -0
  77. package/build/types/observable/ObservableClient.d.ts +33 -1
  78. package/build/types/observable/ObservableClient.d.ts.map +1 -1
  79. package/build/types/observable/computeObjectSetCacheKey.d.ts +16 -0
  80. package/build/types/observable/computeObjectSetCacheKey.d.ts.map +1 -0
  81. package/build/types/observable/internal/Changes.d.ts +5 -3
  82. package/build/types/observable/internal/Changes.d.ts.map +1 -1
  83. package/build/types/observable/internal/KnownCacheKey.d.ts +2 -1
  84. package/build/types/observable/internal/KnownCacheKey.d.ts.map +1 -1
  85. package/build/types/observable/internal/Query.d.ts.map +1 -1
  86. package/build/types/observable/internal/Store.d.ts +2 -0
  87. package/build/types/observable/internal/Store.d.ts.map +1 -1
  88. package/build/types/observable/internal/objectset/ObjectSetCacheKey.d.ts +16 -0
  89. package/build/types/observable/internal/objectset/ObjectSetCacheKey.d.ts.map +1 -0
  90. package/build/types/observable/internal/objectset/ObjectSetHelper.d.ts +19 -0
  91. package/build/types/observable/internal/objectset/ObjectSetHelper.d.ts.map +1 -0
  92. package/build/types/observable/internal/objectset/ObjectSetQuery.d.ts +34 -0
  93. package/build/types/observable/internal/objectset/ObjectSetQuery.d.ts.map +1 -0
  94. package/build/types/observable/internal/objectset/ObjectSetQueryOptions.d.ts +18 -0
  95. package/build/types/observable/internal/objectset/ObjectSetQueryOptions.d.ts.map +1 -0
  96. package/build/types/public/unstable-do-not-use.d.ts +2 -1
  97. package/build/types/public/unstable-do-not-use.d.ts.map +1 -1
  98. package/package.json +7 -7
  99. package/build/cjs/chunk-GVGP7T5P.cjs.map +0 -1
@@ -0,0 +1,16 @@
1
+ import type { CollectionStorageData } from "../base-list/BaseCollectionQuery.js";
2
+ import type { CacheKey } from "../CacheKey.js";
3
+ import type { Canonical } from "../Canonical.js";
4
+ import type { ObjectSetQuery } from "./ObjectSetQuery.js";
5
+ export interface ObjectSetStorageData extends CollectionStorageData {}
6
+ export interface ObjectSetOperations {
7
+ where?: Canonical<any>;
8
+ withProperties?: string[];
9
+ union?: string[];
10
+ intersect?: string[];
11
+ subtract?: string[];
12
+ pivotTo?: string;
13
+ orderBy?: Canonical<Record<string, "asc" | "desc" | undefined>>;
14
+ pageSize?: number;
15
+ }
16
+ export interface ObjectSetCacheKey extends CacheKey<"objectSet", ObjectSetStorageData, ObjectSetQuery, [baseObjectSetWire: string, operations: Canonical<ObjectSetOperations>]> {}
@@ -0,0 +1 @@
1
+ {"mappings":"AAgBA,cAAc,6BAA6B,qCAAsC;AACjF,cAAc,gBAAgB,gBAAiB;AAC/C,cAAc,iBAAiB,iBAAkB;AACjD,cAAc,sBAAsB,qBAAsB;AAE1D,iBAAiB,6BAA6B,sBAAsB,CAAE;AAEtE,iBAAiB,oBAAoB;CACnC,QAAQ;CACR;CACA;CACA;CACA;CACA;CACA,UAAU,UAAU,eAAe,QAAQ;CAC3C;AACD;AAED,iBAAiB,0BACf,SACE,aACA,sBACA,iBAEE,2BACA,YAAY,UAAU,uBAG5B,CACC","names":[],"sources":["../../../../../src/observable/internal/objectset/ObjectSetCacheKey.ts"],"version":3,"file":"ObjectSetCacheKey.d.ts"}
@@ -0,0 +1,19 @@
1
+ import type { ObjectSetPayload } from "../../ObjectSetPayload.js";
2
+ import type { Observer } from "../../ObservableClient/common.js";
3
+ import { AbstractHelper } from "../AbstractHelper.js";
4
+ import type { CacheKeys } from "../CacheKeys.js";
5
+ import type { KnownCacheKey } from "../KnownCacheKey.js";
6
+ import type { OrderByCanonicalizer } from "../OrderByCanonicalizer.js";
7
+ import type { QuerySubscription } from "../QuerySubscription.js";
8
+ import type { Store } from "../Store.js";
9
+ import type { WhereClauseCanonicalizer } from "../WhereClauseCanonicalizer.js";
10
+ import { ObjectSetQuery } from "./ObjectSetQuery.js";
11
+ import type { ObjectSetQueryOptions } from "./ObjectSetQueryOptions.js";
12
+ export declare class ObjectSetHelper extends AbstractHelper<ObjectSetQuery, ObjectSetQueryOptions> {
13
+ whereCanonicalizer: WhereClauseCanonicalizer;
14
+ orderByCanonicalizer: OrderByCanonicalizer;
15
+ constructor(store: Store, cacheKeys: CacheKeys<KnownCacheKey>, whereCanonicalizer: WhereClauseCanonicalizer, orderByCanonicalizer: OrderByCanonicalizer);
16
+ observe(options: ObjectSetQueryOptions, subFn: Observer<ObjectSetPayload>): QuerySubscription<ObjectSetQuery>;
17
+ getQuery(options: ObjectSetQueryOptions): ObjectSetQuery;
18
+ private buildCanonicalizedOperations;
19
+ }
@@ -0,0 +1 @@
1
+ {"mappings":"AAiBA,cAAc,wBAAwB,2BAA4B;AAClE,cAAc,gBAAgB,kCAAmC;AACjE,SAAS,sBAAsB,sBAAuB;AACtD,cAAc,iBAAiB,iBAAkB;AAEjD,cAAc,qBAAqB,qBAAsB;AACzD,cAAc,4BAA4B,4BAA6B;AACvE,cAAc,yBAAyB,yBAA0B;AACjE,cAAc,aAAa,aAAc;AACzC,cAAc,gCAAgC,gCAAiC;AAK/E,SAAS,sBAAsB,qBAAsB;AACrD,cAAc,6BAA6B,4BAA6B;AAExE,OAAO,cAAM,wBAAwB,eACnC,gBACA,uBACA;CACA,oBAAoB;CACpB,sBAAsB;CAEtB,YACEA,OAAO,OACPC,WAAW,UAAU,gBACrBC,oBAAoB,0BACpBC,sBAAsB;CAQxB,QACEC,SAAS,uBACTC,OAAO,SAAS,oBACf,kBAAkB;CAIrB,SAASD,SAAS,wBAAwB;CAuB1C,QAAQ;AA+CT","names":["store: Store","cacheKeys: CacheKeys<KnownCacheKey>","whereCanonicalizer: WhereClauseCanonicalizer","orderByCanonicalizer: OrderByCanonicalizer","options: ObjectSetQueryOptions","subFn: Observer<ObjectSetPayload>"],"sources":["../../../../../src/observable/internal/objectset/ObjectSetHelper.ts"],"version":3,"file":"ObjectSetHelper.d.ts"}
@@ -0,0 +1,34 @@
1
+ import type { Osdk, PageResult } from "@osdk/api";
2
+ import type { Observable } from "rxjs";
3
+ import type { ObjectSetPayload } from "../../ObjectSetPayload.js";
4
+ import type { Status } from "../../ObservableClient/common.js";
5
+ import { BaseListQuery } from "../base-list/BaseListQuery.js";
6
+ import type { BatchContext } from "../BatchContext.js";
7
+ import type { Canonical } from "../Canonical.js";
8
+ import type { Changes } from "../Changes.js";
9
+ import type { Entry } from "../Layer.js";
10
+ import type { Store } from "../Store.js";
11
+ import type { SubjectPayload } from "../SubjectPayload.js";
12
+ import type { ObjectSetCacheKey, ObjectSetOperations } from "./ObjectSetCacheKey.js";
13
+ import type { ObjectSetQueryOptions } from "./ObjectSetQueryOptions.js";
14
+ export declare class ObjectSetQuery extends BaseListQuery<ObjectSetCacheKey, ObjectSetPayload, ObjectSetQueryOptions> {
15
+ #private;
16
+ constructor(store: Store, subject: Observable<SubjectPayload<ObjectSetCacheKey>>, baseObjectSetWire: string, operations: Canonical<ObjectSetOperations>, cacheKey: ObjectSetCacheKey, opts: ObjectSetQueryOptions);
17
+ /**
18
+ * Register changes to the cache specific to ObjectSetQuery
19
+ */
20
+ protected registerCacheChanges(batch: BatchContext): void;
21
+ /**
22
+ * Implements fetchPageData from BaseListQuery template method
23
+ * Fetches a page of data from the composed ObjectSet
24
+ */
25
+ protected fetchPageData(signal: AbortSignal | undefined): Promise<PageResult<Osdk.Instance<any>>>;
26
+ protected handleFetchError(error: unknown, _status: Status, batch: BatchContext): Entry<ObjectSetCacheKey>;
27
+ invalidateObjectType: (objectType: string, changes: Changes | undefined) => Promise<void>;
28
+ protected createPayload(params: {
29
+ resolvedData: any[]
30
+ isOptimistic: boolean
31
+ status: Status
32
+ lastUpdated: number
33
+ }): ObjectSetPayload;
34
+ }
@@ -0,0 +1 @@
1
+ {"mappings":"AAgBA,cAAyB,MAAM,kBAAkB,WAAY;AAC7D,cAAc,kBAAkB,MAAO;AAGvC,cAAc,wBAAwB,2BAA4B;AAClE,cAAc,cAAc,kCAAmC;AAC/D,SAAS,qBAAqB,+BAAgC;AAC9D,cAAc,oBAAoB,oBAAqB;AACvD,cAAc,iBAAiB,iBAAkB;AACjD,cAAc,eAAe,eAAgB;AAC7C,cAAc,aAAa,aAAc;AAEzC,cAAc,aAAa,aAAc;AACzC,cAAc,sBAAsB,sBAAuB;AAC3D,cACE,mBACA,2BACK,wBAAyB;AAChC,cAAc,6BAA6B,4BAA6B;AAExE,OAAO,cAAM,uBAAuB,cAClC,mBACA,kBACA,uBACA;;CAMA,YACEA,OAAO,OACPC,SAAS,WAAW,eAAe,qBACnCC,2BACAC,YAAY,UAAU,sBACtBC,UAAU,mBACVC,MAAM;;;;CAqGR,UAAU,qBAAqBC,OAAO;;;;;CAQtC,UAAgB,cACdC,QAAQ,0BACP,QAAQ,WAAW,KAAK;CAqB3B,UAAU,iBACRC,gBACAC,SAAS,QACTH,OAAO,eACN,MAAM;CAOT,uBACEI,oBACAC,SAAS,wBACR;CAQH,UAAU,cACRC,QAAQ;EACN;EACA;EACA,QAAQ;EACR;CACD,IACA;AAWJ","names":["store: Store","subject: Observable<SubjectPayload<ObjectSetCacheKey>>","baseObjectSetWire: string","operations: Canonical<ObjectSetOperations>","cacheKey: ObjectSetCacheKey","opts: ObjectSetQueryOptions","batch: BatchContext","signal: AbortSignal | undefined","error: unknown","_status: Status","objectType: string","changes: Changes | undefined","params: {\n resolvedData: any[];\n isOptimistic: boolean;\n status: Status;\n lastUpdated: number;\n }"],"sources":["../../../../../src/observable/internal/objectset/ObjectSetQuery.ts"],"version":3,"file":"ObjectSetQuery.d.ts"}
@@ -0,0 +1,18 @@
1
+ import type { DerivedProperty, LinkNames, ObjectSet, ObjectTypeDefinition, PropertyKeys, WhereClause, WirePropertyTypes } from "@osdk/api";
2
+ import type { CommonObserveOptions } from "../../ObservableClient/common.js";
3
+ export interface ObserveObjectSetOptions<
4
+ Q extends ObjectTypeDefinition,
5
+ RDPs extends Record<string, WirePropertyTypes | undefined | Array<WirePropertyTypes>> = {}
6
+ > extends CommonObserveOptions {
7
+ where?: WhereClause<Q>;
8
+ withProperties?: { [K in keyof RDPs] : DerivedProperty.Creator<Q, RDPs[K]> };
9
+ union?: ObjectSet<Q>[];
10
+ intersect?: ObjectSet<Q>[];
11
+ subtract?: ObjectSet<Q>[];
12
+ pivotTo?: LinkNames<Q>;
13
+ pageSize?: number;
14
+ orderBy?: { [K in PropertyKeys<Q>]? : "asc" | "desc" };
15
+ }
16
+ export interface ObjectSetQueryOptions extends ObserveObjectSetOptions<any, any> {
17
+ baseObjectSet: ObjectSet<any>;
18
+ }
@@ -0,0 +1 @@
1
+ {"mappings":"AAgBA,cACE,iBACA,WACA,WACA,sBACA,cACA,aACA,yBACK,WAAY;AACnB,cAAc,4BAA4B,kCAAmC;AAE7E,iBAAiB;CACf,UAAU;CACV,aAAa,eAEX,gCAAgC,MAAM,sBACpC,CAAE;UACE,qBAAqB;CAC7B,QAAQ,YAAY;CACpB,oBAAoB,WAAW,QAAO,gBAAgB,QAAQ,GAAG,KAAK;CACtE,QAAQ,UAAU;CAClB,YAAY,UAAU;CACtB,WAAW,UAAU;CACrB,UAAU,UAAU;CACpB;CACA,aAAa,KAAK,aAAa,OAAM,QAAQ;AAC9C;AAED,iBAAiB,8BACP,kCACV;CACE,eAAe;AAChB","names":[],"sources":["../../../../../src/observable/internal/objectset/ObjectSetQueryOptions.ts"],"version":3,"file":"ObjectSetQueryOptions.d.ts"}
@@ -1,7 +1,8 @@
1
1
  export { augment } from "../object/fetchPage.js";
2
2
  export type { ActionSignatureFromDef } from "../actions/applyAction.js";
3
+ export { computeObjectSetCacheKey } from "../observable/computeObjectSetCacheKey.js";
3
4
  export { createObservableClient } from "../observable/ObservableClient.js";
4
- export type { ObservableClient, ObserveObjectArgs, ObserveObjectsArgs, Unsubscribable } from "../observable/ObservableClient.js";
5
+ export type { ObservableClient, ObserveObjectArgs, ObserveObjectsArgs, ObserveObjectSetArgs, Unsubscribable } from "../observable/ObservableClient.js";
5
6
  export type { Observer } from "../observable/ObservableClient/common.js";
6
7
  export type { ObserveLinks } from "../observable/ObservableClient/ObserveLink.js";
7
8
  export { getMetaTagContent, getOsdkConfig } from "../public-utils/osdkConfig.js";
@@ -1 +1 @@
1
- {"mappings":"AAgBA,SAAS,eAAe;AAGxB,cAAc,8BAA8B;AAC5C,SAAS,8BAA8B;AACvC,cACE,kBACA,mBACA,oBACA,sBACK;AACP,cAAc,gBAAgB;AAC9B,cAAc,oBAAoB;AAClC,SACE,mBACA,qBACK;AACP,cAAc,kBAAkB;AAEhC,SAAS,mCAAmC","names":[],"sources":["../../../src/public/unstable-do-not-use.ts"],"version":3,"file":"unstable-do-not-use.d.ts"}
1
+ {"mappings":"AAgBA,SAAS,eAAe;AAGxB,cAAc,8BAA8B;AAC5C,SAAS,gCAAgC;AACzC,SAAS,8BAA8B;AACvC,cACE,kBACA,mBACA,oBACA,sBACA,sBACK;AACP,cAAc,gBAAgB;AAC9B,cAAc,oBAAoB;AAClC,SACE,mBACA,qBACK;AACP,cAAc,kBAAkB;AAEhC,SAAS,mCAAmC","names":[],"sources":["../../../src/public/unstable-do-not-use.ts"],"version":3,"file":"unstable-do-not-use.d.ts"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@osdk/client",
3
- "version": "2.5.0-beta.10",
3
+ "version": "2.5.0-beta.12",
4
4
  "description": "",
5
5
  "access": "public",
6
6
  "license": "Apache-2.0",
@@ -65,12 +65,12 @@
65
65
  "tiny-invariant": "^1.3.3",
66
66
  "type-fest": "^4.41.0",
67
67
  "ws": "^8.18.3",
68
- "@osdk/api": "2.5.0-beta.10",
68
+ "@osdk/api": "2.5.0-beta.12",
69
+ "@osdk/client.unstable": "2.5.0-beta.12",
70
+ "@osdk/generator-converters": "2.5.0-beta.12",
69
71
  "@osdk/shared.client.impl": "~1.5.0-beta.2",
70
- "@osdk/client.unstable": "2.5.0-beta.10",
71
- "@osdk/generator-converters": "2.5.0-beta.10",
72
- "@osdk/shared.net.fetch": "~1.5.0-beta.2",
73
- "@osdk/shared.net.errors": "~2.5.0-beta.2"
72
+ "@osdk/shared.net.errors": "~2.5.0-beta.2",
73
+ "@osdk/shared.net.fetch": "~1.5.0-beta.2"
74
74
  },
75
75
  "devDependencies": {
76
76
  "@microsoft/api-documenter": "^7.26.32",
@@ -91,8 +91,8 @@
91
91
  "ts-expect": "^1.3.0",
92
92
  "typescript": "~5.5.4",
93
93
  "zod": "^3.25.76",
94
+ "@osdk/client.test.ontology": "~2.5.0-beta.12",
94
95
  "@osdk/monorepo.api-extractor": "~0.4.0-beta.1",
95
- "@osdk/client.test.ontology": "~2.5.0-beta.10",
96
96
  "@osdk/monorepo.tsconfig": "~0.4.0-beta.1",
97
97
  "@osdk/shared.test": "~2.5.0-beta.5"
98
98
  },