@osdk/api 2.7.0-beta.9 → 2.8.0-beta.1
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 +27 -0
- package/build/browser/OsdkObjectFrom.js.map +1 -1
- package/build/browser/aggregate/WhereClause.js +1 -1
- package/build/browser/aggregate/WhereClause.js.map +1 -1
- package/build/browser/index.js +0 -1
- package/build/browser/index.js.map +1 -1
- package/build/browser/object/FetchPageArgs.js.map +1 -1
- package/build/browser/object/PropertySecurity.js +2 -0
- package/build/browser/object/PropertySecurity.js.map +1 -0
- package/build/browser/objectSet/ObjectSet.js.map +1 -1
- package/build/browser/objectSet/ObjectSetListener.js.map +1 -1
- package/build/browser/ontology/QueryDefinition.js.map +1 -1
- package/build/cjs/{ObjectSet-DgucGuIA.d.cts → ObjectSet-CqVqDXKn.d.cts} +114 -31
- package/build/cjs/index.cjs +0 -4
- package/build/cjs/index.cjs.map +1 -1
- package/build/cjs/index.d.cts +3 -7
- package/build/cjs/public/unstable.d.cts +2 -2
- package/build/esm/OsdkObjectFrom.js.map +1 -1
- package/build/esm/aggregate/WhereClause.js +1 -1
- package/build/esm/aggregate/WhereClause.js.map +1 -1
- package/build/esm/index.js +0 -1
- package/build/esm/index.js.map +1 -1
- package/build/esm/object/FetchPageArgs.js.map +1 -1
- package/build/esm/object/PropertySecurity.js +2 -0
- package/build/esm/object/PropertySecurity.js.map +1 -0
- package/build/esm/objectSet/ObjectSet.js.map +1 -1
- package/build/esm/objectSet/ObjectSetListener.js.map +1 -1
- package/build/esm/ontology/QueryDefinition.js.map +1 -1
- package/build/types/OsdkObjectFrom.d.ts +17 -8
- package/build/types/OsdkObjectFrom.d.ts.map +1 -1
- package/build/types/aggregate/WhereClause.d.ts +2 -5
- package/build/types/aggregate/WhereClause.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/FetchPageArgs.d.ts +9 -5
- package/build/types/object/FetchPageArgs.d.ts.map +1 -1
- package/build/types/object/PropertySecurity.d.ts +61 -0
- package/build/types/object/PropertySecurity.d.ts.map +1 -0
- package/build/types/objectSet/ObjectSet.d.ts +20 -12
- package/build/types/objectSet/ObjectSet.d.ts.map +1 -1
- package/build/types/objectSet/ObjectSetListener.d.ts +26 -5
- package/build/types/objectSet/ObjectSetListener.d.ts.map +1 -1
- package/build/types/ontology/QueryDefinition.d.ts +0 -4
- package/build/types/ontology/QueryDefinition.d.ts.map +1 -1
- package/package.json +3 -3
|
@@ -27,7 +27,7 @@ type SubSelectKeysHelper<
|
|
|
27
27
|
> = [L] extends [never] ? PropertyKeys<Q> : PropertyKeys<Q> extends L ? PropertyKeys<Q> : L & PropertyKeys<Q>;
|
|
28
28
|
type SubSelectKeys<
|
|
29
29
|
Q extends ObjectOrInterfaceDefinition,
|
|
30
|
-
X extends SelectArg<Q, PropertyKeys<Q>, any, any> = never
|
|
30
|
+
X extends SelectArg<Q, PropertyKeys<Q>, any, any, any, any> = never
|
|
31
31
|
> = SubSelectKeysHelper<Q, Extract$Select<X>>;
|
|
32
32
|
type NOOP<T> = T extends (...args: any[]) => any ? T : T extends abstract new (...args: any[]) => any ? T : { [K in keyof T] : T[K] };
|
|
33
33
|
type SubSelectRDPsHelper<
|
|
@@ -83,8 +83,9 @@ interface FetchPageSignature<
|
|
|
83
83
|
const A extends Augments,
|
|
84
84
|
S extends NullabilityAdherence = NullabilityAdherence.Default,
|
|
85
85
|
T extends boolean = false,
|
|
86
|
-
ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<L> = {}
|
|
87
|
-
|
|
86
|
+
ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<L> = {},
|
|
87
|
+
PROPERTY_SECURITIES extends boolean = false
|
|
88
|
+
>(args?: FetchPageArgs<Q, L, R, A, S, T, never, ORDER_BY_OPTIONS, PROPERTY_SECURITIES>): Promise<PageResult<MaybeScore<Osdk.Instance<Q, ExtractOptions<R, S, T, PROPERTY_SECURITIES>, NoInfer<SubSelectKeys<Q, NonNullable<typeof args>>>, SubSelectRDPs<RDPs, NonNullable<typeof args>>>, ORDER_BY_OPTIONS>>>;
|
|
88
89
|
}
|
|
89
90
|
interface NearestNeighbors<Q extends ObjectOrInterfaceDefinition> {
|
|
90
91
|
/**
|
|
@@ -103,7 +104,8 @@ interface NearestNeighbors<Q extends ObjectOrInterfaceDefinition> {
|
|
|
103
104
|
}
|
|
104
105
|
interface FetchPageWithErrorsSignature<
|
|
105
106
|
Q extends ObjectOrInterfaceDefinition,
|
|
106
|
-
RDPs extends Record<string, SimplePropertyDef> = {}
|
|
107
|
+
RDPs extends Record<string, SimplePropertyDef> = {},
|
|
108
|
+
PROPERTY_SECURITIES extends boolean = false
|
|
107
109
|
> {
|
|
108
110
|
/**
|
|
109
111
|
* Gets a page of objects of this type, with a result wrapper
|
|
@@ -126,7 +128,7 @@ interface FetchPageWithErrorsSignature<
|
|
|
126
128
|
S extends NullabilityAdherence = NullabilityAdherence.Default,
|
|
127
129
|
T extends boolean = false,
|
|
128
130
|
ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<L> = {}
|
|
129
|
-
>(args?: FetchPageArgs<Q, L, R, A, S, T, never, ORDER_BY_OPTIONS>): Promise<Result<PageResult<MaybeScore<Osdk.Instance<Q, ExtractOptions<R, S, T>, NoInfer<SubSelectKeys<Q, NonNullable<typeof args>>>, SubSelectRDPs<RDPs, NonNullable<typeof args>>>, ORDER_BY_OPTIONS>>>>;
|
|
131
|
+
>(args?: FetchPageArgs<Q, L, R, A, S, T, never, ORDER_BY_OPTIONS, PROPERTY_SECURITIES>): Promise<Result<PageResult<MaybeScore<Osdk.Instance<Q, ExtractOptions<R, S, T, PROPERTY_SECURITIES>, NoInfer<SubSelectKeys<Q, NonNullable<typeof args>>>, SubSelectRDPs<RDPs, NonNullable<typeof args>>>, ORDER_BY_OPTIONS>>>>;
|
|
130
132
|
}
|
|
131
133
|
interface Where<
|
|
132
134
|
Q extends ObjectOrInterfaceDefinition,
|
|
@@ -147,7 +149,8 @@ interface Where<
|
|
|
147
149
|
interface AsyncIterSignature<
|
|
148
150
|
Q extends ObjectOrInterfaceDefinition,
|
|
149
151
|
RDPs extends Record<string, SimplePropertyDef> = {},
|
|
150
|
-
ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<PropertyKeys<Q>> = {}
|
|
152
|
+
ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<PropertyKeys<Q>> = {},
|
|
153
|
+
PROPERTY_SECURITIES extends boolean = false
|
|
151
154
|
> {
|
|
152
155
|
/**
|
|
153
156
|
* Returns an async iterator to load all objects of this type
|
|
@@ -173,7 +176,7 @@ interface AsyncIterSignature<
|
|
|
173
176
|
S extends NullabilityAdherence = NullabilityAdherence.Default,
|
|
174
177
|
T extends boolean = false,
|
|
175
178
|
ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<PropertyKeys<Q>> = {}
|
|
176
|
-
>(args?: AsyncIterArgs<Q, L, R, A, S, T, never, ORDER_BY_OPTIONS>): AsyncIterableIterator<MaybeScore<Osdk.Instance<Q, ExtractOptions<R, S, T>, NoInfer<SubSelectKeys<Q, NonNullable<typeof args>>>, SubSelectRDPs<RDPs, NonNullable<typeof args>>>, ORDER_BY_OPTIONS>>;
|
|
179
|
+
>(args?: AsyncIterArgs<Q, L, R, A, S, T, never, ORDER_BY_OPTIONS, PROPERTY_SECURITIES>): AsyncIterableIterator<MaybeScore<Osdk.Instance<Q, ExtractOptions<R, S, T, PROPERTY_SECURITIES>, NoInfer<SubSelectKeys<Q, NonNullable<typeof args>>>, SubSelectRDPs<RDPs, NonNullable<typeof args>>>, ORDER_BY_OPTIONS>>;
|
|
177
180
|
}
|
|
178
181
|
interface AsyncIter<
|
|
179
182
|
Q extends ObjectOrInterfaceDefinition,
|
|
@@ -268,8 +271,9 @@ interface FetchOneSignature<
|
|
|
268
271
|
<
|
|
269
272
|
const L extends PropertyKeys<Q> | (string & keyof RDPs),
|
|
270
273
|
const R extends boolean,
|
|
271
|
-
const S extends false | "throw" = NullabilityAdherence.Default
|
|
272
|
-
|
|
274
|
+
const S extends false | "throw" = NullabilityAdherence.Default,
|
|
275
|
+
PROPERTY_SECURITIES extends boolean = false
|
|
276
|
+
>(primaryKey: PrimaryKeyType<Q>, options?: SelectArg<Q, L, R, S, never, PROPERTY_SECURITIES>): Promise<Osdk.Instance<Q, ExtractOptions<R, S, false, PROPERTY_SECURITIES>, NoInfer<SubSelectKeys<Q, {
|
|
273
277
|
$select: Array<L>
|
|
274
278
|
}>>, SubSelectRDPs<RDPs, {
|
|
275
279
|
$select: Array<L>
|
|
@@ -285,8 +289,9 @@ interface FetchOneWithErrorsSignature<
|
|
|
285
289
|
<
|
|
286
290
|
const L extends PropertyKeys<Q> | (string & keyof RDPs),
|
|
287
291
|
const R extends boolean,
|
|
288
|
-
const S extends false | "throw" = NullabilityAdherence.Default
|
|
289
|
-
|
|
292
|
+
const S extends false | "throw" = NullabilityAdherence.Default,
|
|
293
|
+
PROPERTY_SECURITIES extends boolean = false
|
|
294
|
+
>(primaryKey: PrimaryKeyType<Q>, options?: SelectArg<Q, L, R, S, never, PROPERTY_SECURITIES>): Promise<Result<Osdk.Instance<Q, ExtractOptions<R, S, false, PROPERTY_SECURITIES>, NoInfer<SubSelectKeys<Q, {
|
|
290
295
|
$select: Array<L>
|
|
291
296
|
}>>, SubSelectRDPs<RDPs, {
|
|
292
297
|
$select: Array<L>
|
|
@@ -306,7 +311,10 @@ interface Subscribe<Q extends ObjectOrInterfaceDefinition> {
|
|
|
306
311
|
* @param opts - Options to modify what properties are returned on subscription updates.
|
|
307
312
|
* @returns an object containing a function to unsubscribe.
|
|
308
313
|
*/
|
|
309
|
-
readonly subscribe: <
|
|
314
|
+
readonly subscribe: <
|
|
315
|
+
const P extends PropertyKeys<Q>,
|
|
316
|
+
const R extends boolean = false
|
|
317
|
+
>(listener: ObjectSetSubscription.Listener<Q, P, R>, opts?: ObjectSetSubscription.Options<Q, P, R>) => {
|
|
310
318
|
unsubscribe: () => void
|
|
311
319
|
};
|
|
312
320
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"mappings":"AAgBA,cAAc,qBAAqB,+BAAgC;AACnE,cAAc,sEAAsE,yCAA0C;AAC9H,cAAc,2BAA2B,qCAAsC;AAC/E,cAAc,mBAAmB,6BAA8B;AAC/D,cAAc,uBAAuB,yCAA0C;AAC/E,cACE,eACA,UACA,eACA,sBACA,eACA,iBACK,4BAA6B;AACpC,cAAc,cAAc,qBAAsB;AAClD,cAAc,2BAA2B,oCAAqC;AAC9E,cACE,oCACA,6BACA,oBACK,kCAAmC;AAC1C,cACE,qBACA,4BACK,qCAAsC;AAC7C,cAAc,yBAAyB,kCAAmC;AAC1E,cAAc,sBAAsB,gBAAiB;AACrD,cACE,4BACA,gBACA,kBACA,YACA,YACK,sBAAuB;AAC9B,cAAc,kBAAkB,kBAAmB;AACnD,cAAc,YAAY,iBAAiB,sBAAuB;AAClE,cAAc,qBAAqB,oBAAqB;AACxD,cACE,qBACA,yCACK,qBAAsB;AAC7B,cAAc,6BAA6B,wBAAyB;KAE/D;CACH,UAAU;CACV,UAAU,eAAe,qBAAqB,CAAE;IAC9C,mCAAmC,sBAAsB,GAAG;KAE3D,WACH,UACI,qBACA,eAAe,uBAChB,qBAAqB,CAAE,IACxB,UAAU,qBAAqB,CAAE,IACjC,UAAU,eAAe,qBAAqB,IAC9C,CAAE;KAOD;CACH,UAAU;CACV;KACG,qBAAqB,aAAa,KACnC,aAAa,WAAW,IAAI,aAAa,KACzC,IAAI,aAAa;KAEhB;CACH,UAAU;CACV,UAAU,UAAU,GAAG,aAAa;IAClC,oBAAoB,GAAG,eAAe;KAErC,KAAK,KAAK,WAAW,GAAG,sBAAsB,IAC/C,wBAAuB,GAAG,sBAAsB,OAC7C,WAAW,KAAI,EAAE;KAEnB;CACH,UAAU,oCAAoC;CAC9C;KACG,qBAAqB,WACrB,EAAE,iCAAiC;KAEnC;CACH,aAAa,eAAe;CAC5B,UAAU,wBAAwB,aAAa,wBAAwB;KACpE,gCACD,QAAQ,KAAK,oBAAoB,kBAAkB,SAAQ,KAAK;AAEpE,iBAAiB;CACf,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;CACnD,yBAAyB,cAAc,eAAe,aAAa,MAAM,CAAE;UAE3E,cAAc,IACd,UAAU,GAAG,OACb,UAAU,GAAG,MAAM,mBACnB,MAAM,GAAG,OACT,eAAe,GACjB,CACC;AAED,YAAY,gBACV,UAAU,qDACP,6BAEC,iBAAiB,EAAE,uBAAuB,OAAO,OAAO,SACxD,2BACA,EAAE,2CAA2C,OAAO,OAAO;KAG5D,eAAe,UAAU,2BAA2B,YACvD,EAAE;UAGM;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;EACnD;UACS,WAAW,mBAAmB,GAAG;UACjC,qBAAqB,6BAA6B,GAAG;AAC/D;KAEI;CACH,UAAU;CACV,aAAa,eAAe;CAC5B,yBAAyB,cAAc,eAAe,aAAa;IACjE,cAAc,UAChB,GACA,aAAa,4BAEE,MACf;KAGG;CACH,UAAU;CACV,aAAa,eAAe;IAE1B,cAAc,UACd,GACA,aAAa,IACb,sBACe,QAEf,cACA,yBAKA,qBACe;UAGT;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;EACnD;;;;;;;;;;;;;;EAcE,UAAU,aAAa,qBAAqB;EAC5C;QACM,UAAU;EAChB,UAAU,uBAAuB,qBAAqB;EACtD,oBAAoB;EACpB,yBAAyB,cAAc,eAAe,KAAK,CAAE;
|
|
1
|
+
{"mappings":"AAgBA,cAAc,qBAAqB,+BAAgC;AACnE,cAAc,sEAAsE,yCAA0C;AAC9H,cAAc,2BAA2B,qCAAsC;AAC/E,cAAc,mBAAmB,6BAA8B;AAC/D,cAAc,uBAAuB,yCAA0C;AAC/E,cACE,eACA,UACA,eACA,sBACA,eACA,iBACK,4BAA6B;AACpC,cAAc,cAAc,qBAAsB;AAClD,cAAc,2BAA2B,oCAAqC;AAC9E,cACE,oCACA,6BACA,oBACK,kCAAmC;AAC1C,cACE,qBACA,4BACK,qCAAsC;AAC7C,cAAc,yBAAyB,kCAAmC;AAC1E,cAAc,sBAAsB,gBAAiB;AACrD,cACE,4BACA,gBACA,kBACA,YACA,YACK,sBAAuB;AAC9B,cAAc,kBAAkB,kBAAmB;AACnD,cAAc,YAAY,iBAAiB,sBAAuB;AAClE,cAAc,qBAAqB,oBAAqB;AACxD,cACE,qBACA,yCACK,qBAAsB;AAC7B,cAAc,6BAA6B,wBAAyB;KAE/D;CACH,UAAU;CACV,UAAU,eAAe,qBAAqB,CAAE;IAC9C,mCAAmC,sBAAsB,GAAG;KAE3D,WACH,UACI,qBACA,eAAe,uBAChB,qBAAqB,CAAE,IACxB,UAAU,qBAAqB,CAAE,IACjC,UAAU,eAAe,qBAAqB,IAC9C,CAAE;KAOD;CACH,UAAU;CACV;KACG,qBAAqB,aAAa,KACnC,aAAa,WAAW,IAAI,aAAa,KACzC,IAAI,aAAa;KAEhB;CACH,UAAU;CACV,UAAU,UAAU,GAAG,aAAa;IAClC,oBAAoB,GAAG,eAAe;KAErC,KAAK,KAAK,WAAW,GAAG,sBAAsB,IAC/C,wBAAuB,GAAG,sBAAsB,OAC7C,WAAW,KAAI,EAAE;KAEnB;CACH,UAAU,oCAAoC;CAC9C;KACG,qBAAqB,WACrB,EAAE,iCAAiC;KAEnC;CACH,aAAa,eAAe;CAC5B,UAAU,wBAAwB,aAAa,wBAAwB;KACpE,gCACD,QAAQ,KAAK,oBAAoB,kBAAkB,SAAQ,KAAK;AAEpE,iBAAiB;CACf,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;CACnD,yBAAyB,cAAc,eAAe,aAAa,MAAM,CAAE;UAE3E,cAAc,IACd,UAAU,GAAG,OACb,UAAU,GAAG,MAAM,mBACnB,MAAM,GAAG,OACT,eAAe,GACjB,CACC;AAED,YAAY,gBACV,UAAU,qDACP,6BAEC,iBAAiB,EAAE,uBAAuB,OAAO,OAAO,SACxD,2BACA,EAAE,2CAA2C,OAAO,OAAO;KAG5D,eAAe,UAAU,2BAA2B,YACvD,EAAE;UAGM;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;EACnD;UACS,WAAW,mBAAmB,GAAG;UACjC,qBAAqB,6BAA6B,GAAG;AAC/D;KAEI;CACH,UAAU;CACV,aAAa,eAAe;CAC5B,yBAAyB,cAAc,eAAe,aAAa;IACjE,cAAc,UAChB,GACA,aAAa,4BAEE,MACf;KAGG;CACH,UAAU;CACV,aAAa,eAAe;IAE1B,cAAc,UACd,GACA,aAAa,IACb,sBACe,QAEf,cACA,yBAKA,qBACe;UAGT;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;EACnD;;;;;;;;;;;;;;EAcE,UAAU,aAAa,qBAAqB;EAC5C;QACM,UAAU;EAChB,UAAU,uBAAuB,qBAAqB;EACtD,oBAAoB;EACpB,yBAAyB,cAAc,eAAe,KAAK,CAAE;EAC7D,sCAAsC;GAEtCA,OAAO,cACL,GACA,GACA,GACA,GACA,GACA,UAEA,kBACA,uBAED,QACD,WACE,WACE,KAAK,SACH,GACA,eAAe,GAAG,GAAG,GAAG,sBACxB,QAAQ,cAAc,GAAG,mBAAmB,SAC5C,cAAc,MAAM,mBAAmB,SAEzC;AAIP;UAES,iBAAiB,UAAU,6BAA6B;;;;;;;;;;;;;UAcvD,mBACPC,0BACAC,sBACAC,UAAU,aAAa,SAAS,GAAG;AAEtC;UAES;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;CACnD,sCAAsC;EACtC;;;;;;;;;;;;;;;;EAgBE,UAAU,aAAa,qBAAqB;EAC5C;QACM,UAAU;EAChB,UAAU,uBAAuB,qBAAqB;EACtD,oBAAoB;EACpB,yBAAyB,cAAc,eAAe,KAAK,CAAE;GAE7DH,OAAO,cACL,GACA,GACA,GACA,GACA,GACA,UAEA,kBACA,uBAED,QACD,OACE,WACE,WACE,KAAK,SACH,GACA,eAAe,GAAG,GAAG,GAAG,sBACxB,QAAQ,cAAc,GAAG,mBAAmB,SAC5C,cAAc,MAAM,mBAAmB,SAEzC;AAKT;UAGS;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;EACnD;;;;;;;;;;;UAWS,QACPI,QAAQ,YAAY,eAAe,GAAG;AAEzC;UAES;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;CACnD,yBAAyB,cAAc,eAAe,aAAa,MAAM,CAAE;CAC3E,sCAAsC;EACtC;;;;;;;;;EASC,UAAU,mBAAmB,GAAG,eAC/BC,OAAO,IACN,sBACD,KAAK,SACH,GACA,gBAAgB,IAChB,cAAc,GAAG,IACjB,cAAc,MAAM;;;;;;;;;;EAatB,UAAU,aAAa,qBAAqB;EAC5C;QACM,UAAU;EAChB,UAAU,uBAAuB,qBAAqB;EACtD,oBAAoB;EACpB,yBAAyB,cAAc,eAAe,aAAa,MAAM,CAAE;GAE3EC,OAAO,cACL,GACA,GACA,GACA,GACA,GACA,UAEA,kBACA,uBAED,sBACD,WACE,KAAK,SACH,GACA,eAAe,GAAG,GAAG,GAAG,sBACxB,QAAQ,cAAc,GAAG,mBAAmB,SAC5C,cAAc,MAAM,mBAAmB,SAEzC;AAGL;UAES;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;CACnD,yBAAyB,cAAc,eAAe,aAAa,MAAM,CAAE;EAC3E;CACA,WAAW,mBAAmB,GAAG,MAAM;AACxC;UAES;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;EACnD;UACS,iBACP,YAAY,eAAe,oBAE3BC,WAAW,WAAW,OAAM,gBAAgB,QAAQ,GAAG,IAAI,UACxD,UACH,MAEG,YAAY,YAAY,QAAO,iBAAiB,MAAM,IAAI,MACvD,iBAAiB,OAAO,KAAK;AAItC;AAED,iBAAiB;CACf,UAAU;CAGV,sBACI,cAAc,KACd,eAAe;UAEnB,sBACE,GACA,WAAW,gBACX,eAAe,GAAG,WAAW,iBAEjC,CACC;UAGS,UACR,UAAU,6BACV;;;;;;;;;;;;;;;;;;;;;;;;UAwBS,YAAY,WAAW,cAAc,IAC5CC,KAAK,+DAA+D,GAAG,QACpE,QAAQ,oBAAoB,GAAG;AACrC;UAGS,cACR,UAAU,6BACV;;;;;;;;;;UAUS,QACP,GAAG,YAAY,cAAc,oBAAoB,GAAG;;;;;;;;;;UAY7C,YACP,GAAG,YAAY,cAAc,oBAAoB,GAAG;;;;;;;;;;UAY7C,WACP,GAAG,YAAY,cAAc,oBAAoB,GAAG;AAEvD;UAGS,QACR,UAAU,6BACV;;;;;;UAMS,UAAU,UAAU,UAAU,IACrCC,MAAM,MACH,UAAU,WAAW,GAAG;AAC9B;UAES;CACR,UAAU;CACV,aAAa,eAAe;EAC5B;;;;;QAKQ,UAAU,aAAa,qBAAqB;QAC5C;QACA,UAAU,QAAQ,UAAU,qBAAqB;EACvD,sCAAsC;GAEtCC,YAAY,eAAe,IAC3BC,UAAU,UAAU,GAAG,GAAG,GAAG,UAAU,uBACtC,QACD,KAAK,SACH,GACA,eAAe,GAAG,GAAG,OAAO,sBAC5B,QAAQ,cAAc,GAAG;EAAE,SAAS,MAAM;CAAI,KAC9C,cAAc,MAAM;EAAE,SAAS,MAAM;CAAI;AAG9C;UAES;CACR,UAAU;CACV,aAAa,eAAe;EAC5B;;;;;QAKQ,UAAU,aAAa,qBAAqB;QAC5C;QACA,UAAU,QAAQ,UAAU,qBAAqB;EACvD,sCAAsC;GAEtCD,YAAY,eAAe,IAC3BC,UAAU,UAAU,GAAG,GAAG,GAAG,UAAU,uBACtC,QACD,OACE,KAAK,SACH,GACA,eAAe,GAAG,GAAG,OAAO,sBAC5B,QAAQ,cAAc,GAAG;EAAE,SAAS,MAAM;CAAI,KAC9C,cAAc,MAAM;EAAE,SAAS,MAAM;CAAI;AAIhD;UAES;CACR,UAAU;CACV,aAAa,eAAe;EAC5B;CACA,UAAU,UAAU,uBAAuB,kBAAkB,GAAG;CAChE,oBAAoB,UAAU,uBAC1B,4BAA4B,GAAG;AAEpC;UAGS,UACR,UAAU,6BACV;;;;;;;UAOS;QACD,UAAU,aAAa;QACvB,oBAAoB;GAE1BC,UAAU,sBAAsB,SAAS,GAAG,GAAG,IAC/CC,OAAO,sBAAsB,QAAQ,GAAG,GAAG,OACxC;EAAE;CAAyB;AACjC;UAES,aAAa,UAAU,6BAA6B;;;;;;;;;UASnD,eACP,mBAAmB,kCAAkC,IAErDC,MAAM,eACH,UAAU;AAChB;KAEI,kCAAkC,UAAU,+BAC/C,UAAU,uBAAuB,6BAA6B,KAC1D,UAAU,sBAAsB,yBAAyB;KAG1D,6BAA6B,UAAU,wBAC1C,oBAAoB,WAAW;CAAE,YAAY,oBAAoB;AAAW,IACxE,0BAA0B,sBAAsB;CAAE,SAAS;AAAU;KAItE,yBAAyB,UAAU,uBACtC,oBAAoB,WAClB;CAAE,eAAe,oBAAoB;AAA0B,KAC5D,uBAAuB;CAAE,SAAS;AAAU,KAAI,sBACjD;UAEI,eAAe,UAAU,6BAA6B;;;;;;;;;;;;;UAarD,8BACP,2BAA2B,oBAAoB,IAE/CC,OAAO,yBACJ,sBACH,kCAAkC,GAAG;AAExC;UAES;CACR,UAAU;CACV,UAAU,eAAe;CACzB,eAAe,8BAA8B;CAC7C,yBAAyB,cAAc,eAAe,aAAa,MAAM,CAAE;UAE3E,iBAAiB,GAAG,GAAG,mBACvB,eAAe,GAAG,IAClB,UAAU,SACV,cAAc,SACd,QAAQ,IACR,SAAS,GAAG,IACZ,UAAU,SACV,iBAAiB,IACjB,aAAa,GACf,CACC","names":["args?: FetchPageArgs<\n Q,\n L,\n R,\n A,\n S,\n T,\n never,\n ORDER_BY_OPTIONS,\n PROPERTY_SECURITIES\n >","query: string | number[]","numNeighbors: number","property: PropertyKeys.Filtered<Q, \"vector\">","clause: WhereClause<MergeObjectSet<Q, RDPs>>","args?: X","args?: AsyncIterArgs<\n Q,\n L,\n R,\n A,\n S,\n T,\n never,\n ORDER_BY_OPTIONS,\n PROPERTY_SECURITIES\n >","clause: { [K in keyof NEW]: DerivedProperty.Creator<Q, NEW[K]> }","req: AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy<Q, AO>","type: L","primaryKey: PrimaryKeyType<Q>","options?: SelectArg<Q, L, R, S, never, PROPERTY_SECURITIES>","listener: ObjectSetSubscription.Listener<Q, P, R>","opts?: ObjectSetSubscription.Options<Q, P, R>","type: CONVERT_TO","links: LINK_TYPE_API_NAME[]"],"sources":["../../../src/objectSet/ObjectSet.ts"],"version":3,"file":"ObjectSet.d.ts"}
|
|
@@ -1,14 +1,17 @@
|
|
|
1
1
|
import type { ObjectOrInterfaceDefinition, PropertyKeys } from "../ontology/ObjectOrInterface.js";
|
|
2
|
+
import type { CompileTimeMetadata } from "../ontology/ObjectTypeDefinition.js";
|
|
3
|
+
import type { WirePropertyTypes } from "../ontology/WirePropertyTypes.js";
|
|
2
4
|
import type { Osdk } from "../OsdkObjectFrom.js";
|
|
3
5
|
export declare namespace ObjectSetSubscription {
|
|
4
6
|
interface Listener<
|
|
5
7
|
O extends ObjectOrInterfaceDefinition,
|
|
6
|
-
P extends PropertyKeys<O> = PropertyKeys<O
|
|
8
|
+
P extends PropertyKeys<O> = PropertyKeys<O>,
|
|
9
|
+
R extends boolean = false
|
|
7
10
|
> {
|
|
8
11
|
/**
|
|
9
12
|
* Specific objects have changed and can be immediately updated
|
|
10
13
|
*/
|
|
11
|
-
onChange?: (objectUpdate: ObjectUpdate<O, P>) => void;
|
|
14
|
+
onChange?: (objectUpdate: ObjectUpdate<O, P, R>) => void;
|
|
12
15
|
/**
|
|
13
16
|
* The subscription has been successfully established and updates can be expected to be received.
|
|
14
17
|
*/
|
|
@@ -28,16 +31,34 @@ export declare namespace ObjectSetSubscription {
|
|
|
28
31
|
}
|
|
29
32
|
interface Options<
|
|
30
33
|
O extends ObjectOrInterfaceDefinition,
|
|
31
|
-
P extends PropertyKeys<O> = PropertyKeys<O
|
|
34
|
+
P extends PropertyKeys<O> = PropertyKeys<O>,
|
|
35
|
+
R extends boolean = false
|
|
32
36
|
> {
|
|
37
|
+
/**
|
|
38
|
+
* The properties to request a subscription for. Requesting specific properties limits the possible properties
|
|
39
|
+
* that can be returned from the subscription. If not provided, all properties will be requested and potentially be returned on updates.
|
|
40
|
+
*/
|
|
33
41
|
properties?: Array<P>;
|
|
42
|
+
/**
|
|
43
|
+
* Whether to include the $rid property in the subscription. Defaults to false. RIDs will be returned on all updates unless the update
|
|
44
|
+
* contains a new value for a geotime series reference property, in which case the RID will be undefined. RIDs will not be included
|
|
45
|
+
* on the objects themselves.
|
|
46
|
+
*/
|
|
47
|
+
includeRid?: AllFalse<PropertyTypesOnDefMatchesType<O, P, "geotimeSeriesReference">> extends true ? R : false;
|
|
34
48
|
}
|
|
35
49
|
}
|
|
36
50
|
type ObjectUpdate<
|
|
37
51
|
O extends ObjectOrInterfaceDefinition,
|
|
38
|
-
P extends PropertyKeys<O
|
|
52
|
+
P extends PropertyKeys<O>,
|
|
53
|
+
R extends boolean = false
|
|
39
54
|
> = {
|
|
40
|
-
object: Osdk.Instance<O, never, P>
|
|
55
|
+
object: R extends false ? Osdk.Instance<O, never, P> : Osdk.Instance<O, "$rid", P>
|
|
41
56
|
state: "ADDED_OR_UPDATED" | "REMOVED"
|
|
42
57
|
};
|
|
58
|
+
type PropertyTypesOnDefMatchesType<
|
|
59
|
+
Q extends ObjectOrInterfaceDefinition,
|
|
60
|
+
P extends PropertyKeys<Q>,
|
|
61
|
+
T extends WirePropertyTypes
|
|
62
|
+
> = { [K in P] : CompileTimeMetadata<Q>["properties"][K]["type"] extends T ? true : false };
|
|
63
|
+
type AllFalse<T extends Record<string, boolean>> = Exclude<T[keyof T], false> extends never ? true : false;
|
|
43
64
|
export {};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"mappings":"AAgBA,cACE,6BACA,oBACK,kCAAmC;AAC1C,cAAc,YAAY,sBAAuB;AAEjD,yBAAiB;WACE;EACf,UAAU;EACV,UAAU,aAAa,KAAK,aAAa;
|
|
1
|
+
{"mappings":"AAgBA,cACE,6BACA,oBACK,kCAAmC;AAC1C,cAAc,2BAA2B,qCAAsC;AAC/E,cAAc,yBAAyB,kCAAmC;AAC1E,cAAc,YAAY,sBAAuB;AAEjD,yBAAiB;WACE;EACf,UAAU;EACV,UAAU,aAAa,KAAK,aAAa;EACzC,oBAAoB;GACpB;;;;EAIA,YACEA,cAAc,aAAa,GAAG,GAAG;;;;EAMnC;;;;;EAMA;;;;EAKA,WAAWC,QAAQ;GAAE;GAA6B;EAAY;CAC/D;WAWgB;EACf,UAAU;EACV,UAAU,aAAa,KAAK,aAAa;EACzC,oBAAoB;GACpB;;;;;EAKA,aAAa,MAAM;;;;;;EAOnB,aAAa,SACX,8BAA8B,GAAG,GAAG,mCAC5B,OAAO,IACb;CACL;;KAGE;CACH,UAAU;CACV,UAAU,aAAa;CACvB,oBAAoB;IAClB;CACF,QAAQ,UAAU,QAAQ,KAAK,SAAS,UAAU,KAC9C,KAAK,SAAS,GAAG,QAAQ;CAC7B,OAAO,qBAAqB;AAC7B;KAEI;CACH,UAAU;CACV,UAAU,aAAa;CACvB,UAAU;OAET,KAAK,KAAI,oBAAoB,GAAG,cAAc,GAC7C,gBACQ,IAAI,OACV;KAGD,SAAS,UAAU,2BACtB,QAAQ,QAAQ,IAAI,uBAAuB,OAAO","names":["objectUpdate: ObjectUpdate<O, P, R>","errors: { subscriptionClosed: boolean; error: any }"],"sources":["../../../src/objectSet/ObjectSetListener.ts"],"version":3,"file":"ObjectSetListener.d.ts"}
|
|
@@ -27,8 +27,6 @@ export type QueryParameterDefinition<T_Target extends ObjectTypeDefinition = any
|
|
|
27
27
|
} & QueryDataTypeDefinition<T_Target>;
|
|
28
28
|
export type QueryDataTypeDefinition<T_Target extends ObjectOrInterfaceDefinition = any> = PrimitiveDataType | ObjectQueryDataType<T_Target> | InterfaceQueryDataType<T_Target> | ObjectSetQueryDataType<T_Target> | InterfaceObjectSetQueryDataType<T_Target> | SetQueryDataType | UnionQueryDataType | StructQueryDataType | TwoDimensionalAggregationDataType | ThreeDimensionalAggregationDataType | MapDataType | ArrayQueryDataType;
|
|
29
29
|
export type BaseQueryDataTypeDefinition<T extends string> = {
|
|
30
|
-
/** @deprecated use T["type"] extends "array" instead */
|
|
31
|
-
multiplicity?: boolean
|
|
32
30
|
nullable?: boolean
|
|
33
31
|
type: T
|
|
34
32
|
};
|
|
@@ -55,8 +53,6 @@ export interface SetQueryDataType extends BaseQueryDataTypeDefinition<"set"> {
|
|
|
55
53
|
}
|
|
56
54
|
export interface ArrayQueryDataType extends BaseQueryDataTypeDefinition<"array"> {
|
|
57
55
|
array: QueryDataTypeDefinition;
|
|
58
|
-
/** @deprecated use T["type"] extends "array" instead */
|
|
59
|
-
multiplicity?: true;
|
|
60
56
|
}
|
|
61
57
|
export interface UnionQueryDataType extends BaseQueryDataTypeDefinition<"union"> {
|
|
62
58
|
union: ReadonlyArray<QueryDataTypeDefinition>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"mappings":"AAgBA,cAAc,oBAAoB,oBAAqB;AACvD,cAAc,mCAAmC,wBAAyB;AAC1E,cAAc,4BAA4B,2BAA4B;AAEtE,iBAAiB,cAAc;CAC7B,MAAM;CACN;CACA;CACA;CACA;CACA,YAAY,eAAe;CAC3B,QAAQ;CACR;AACD;AAED,iBAAiB,yBAAyB,GAAG;CAC3C,WAAW;AACZ;AAED,iBAAiB,gBAAgB,SAAS;CACxC,MAAM;CACN;CACA;CACA;CACA,eAAe;CACf,uBACI,yBAAyB,KACzB;AACL;AAED,YAAY,yBACV,iBAAiB,8BACf;CACF;AACD,IAAG,wBAAwB;AAE5B,YAAY,wBACV,iBAAiB,qCAEf,oBACA,oBAAoB,YACpB,uBAAuB,YACvB,uBAAuB,YACvB,gCAAgC,YAChC,mBACA,qBACA,sBACA,oCACA,sCACA,cACA;AAEJ,YAAY,4BAA4B,oBAAoB
|
|
1
|
+
{"mappings":"AAgBA,cAAc,oBAAoB,oBAAqB;AACvD,cAAc,mCAAmC,wBAAyB;AAC1E,cAAc,4BAA4B,2BAA4B;AAEtE,iBAAiB,cAAc;CAC7B,MAAM;CACN;CACA;CACA;CACA;CACA,YAAY,eAAe;CAC3B,QAAQ;CACR;AACD;AAED,iBAAiB,yBAAyB,GAAG;CAC3C,WAAW;AACZ;AAED,iBAAiB,gBAAgB,SAAS;CACxC,MAAM;CACN;CACA;CACA;CACA,eAAe;CACf,uBACI,yBAAyB,KACzB;AACL;AAED,YAAY,yBACV,iBAAiB,8BACf;CACF;AACD,IAAG,wBAAwB;AAE5B,YAAY,wBACV,iBAAiB,qCAEf,oBACA,oBAAoB,YACpB,uBAAuB,YACvB,uBAAuB,YACvB,gCAAgC,YAChC,mBACA,qBACA,sBACA,oCACA,sCACA,cACA;AAEJ,YAAY,4BAA4B,oBAAoB;CAC1D;CACA,MAAM;AACP;AAED,YAAY,qBACR,WACA,UACA,YACA,SACA,YACA,WACA,SACA,cACA;AAEJ,YAAY,kBACV,UAAU,qBAAqB,sBAC7B,4BAA4B;AAEhC,iBAAiB,oBACf,iBAAiB,6CACT,4BAA4B,UAAU;CAC9C;CACA,mBAAmB;AACpB;AAED,iBAAiB,uBACf,iBAAiB,6CACT,4BAA4B,aAAa;CACjD;CACA,mBAAmB;AACpB;AAED,iBAAiB,uBACf,iBAAiB,6CACT,4BAA4B,aAAa;CACjD;CACA,mBAAmB;AACpB;AAED,iBAAiB,gCACf,iBAAiB,6CACT,4BAA4B,sBAAsB;CAC1D;CACA,mBAAmB;AACpB;AAED,iBAAiB,yBAAyB,4BAA4B,OAAO;CAC3E,KAAK;AACN;AAED,iBAAiB,2BACP,4BAA4B,SACtC;CACE,OAAO;AACR;AACD,iBAAiB,2BACP,4BAA4B,SACtC;CACE,OAAO,cAAc;AACtB;AAED,iBAAiB,4BACP,4BAA4B,UACtC;CACE,QAAQ,eAAe;AACxB;AAED,iBAAiB,0CACP,4BAA4B,6BACtC;CACE,2BAA2B;AAC5B;AAED,iBAAiB,4CACP,4BAA4B,+BACtC;CACE,6BAA6B;AAC9B;AAED,iBAAiB,oBAAoB,4BAA4B,OAAO;CACtE,SAAS;CACT,WAAW;AACZ;AAED,YAAY,uBAAuB,WAC/B,6BAA6B,KAC7B,4BAA4B;AAEhC,iBAAiB,6BAA6B,SAAS;CACrD,SAAS,QAAQ,qBAAqB;CACtC,WAAW;AACZ;AACD,iBAAiB,4BAA4B,SAAS;CACpD,SAAS;CACT,YAAY;CACZ,WAAW;AACZ;AAED,YAAY,2CAA2C,uBACrD;AAGF,YAAY,6CAA6C,uBACvD;AAGF,YAAY,sBACR,YACA,WACA,SACA,WACA,YACA,cACA;AAEJ,YAAY,2BACR,SACA,WACA,YACA;AAEJ,YAAY,wBAAwB,SAAS,WAAW","names":[],"sources":["../../../src/ontology/QueryDefinition.ts"],"version":3,"file":"QueryDefinition.d.ts"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@osdk/api",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.8.0-beta.1",
|
|
4
4
|
"description": "",
|
|
5
5
|
"access": "public",
|
|
6
6
|
"license": "Apache-2.0",
|
|
@@ -48,8 +48,8 @@
|
|
|
48
48
|
"@microsoft/api-extractor": "^7.52.11",
|
|
49
49
|
"ts-expect": "^1.3.0",
|
|
50
50
|
"typescript": "~5.5.4",
|
|
51
|
-
"@osdk/monorepo.api-extractor": "~0.
|
|
52
|
-
"@osdk/monorepo.tsconfig": "~0.
|
|
51
|
+
"@osdk/monorepo.api-extractor": "~0.7.0-beta.1",
|
|
52
|
+
"@osdk/monorepo.tsconfig": "~0.7.0-beta.1"
|
|
53
53
|
},
|
|
54
54
|
"publishConfig": {
|
|
55
55
|
"access": "public"
|