@osdk/api 2.0.2-rc.3 → 2.0.3
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 +9 -0
- package/build/browser/OsdkObject.d.ts +3 -0
- package/build/browser/OsdkObject.d.ts.map +1 -1
- package/build/browser/OsdkObjectFrom.d.ts +23 -12
- package/build/browser/OsdkObjectFrom.d.ts.map +1 -1
- package/build/browser/PageResult.d.ts.map +1 -1
- package/build/browser/object/FetchPageResult.d.ts +9 -4
- package/build/browser/object/FetchPageResult.d.ts.map +1 -1
- package/build/browser/objectSet/EXPERIMENTAL_ObjectSetListener.d.ts +2 -2
- package/build/browser/objectSet/EXPERIMENTAL_ObjectSetListener.d.ts.map +1 -1
- package/build/browser/objectSet/ObjectSet.d.ts +7 -5
- package/build/browser/objectSet/ObjectSet.d.ts.map +1 -1
- package/build/esm/OsdkObject.d.ts +3 -0
- package/build/esm/OsdkObject.d.ts.map +1 -1
- package/build/esm/OsdkObjectFrom.d.ts +23 -12
- package/build/esm/OsdkObjectFrom.d.ts.map +1 -1
- package/build/esm/PageResult.d.ts.map +1 -1
- package/build/esm/object/FetchPageResult.d.ts +9 -4
- package/build/esm/object/FetchPageResult.d.ts.map +1 -1
- package/build/esm/objectSet/EXPERIMENTAL_ObjectSetListener.d.ts +2 -2
- package/build/esm/objectSet/EXPERIMENTAL_ObjectSetListener.d.ts.map +1 -1
- package/build/esm/objectSet/ObjectSet.d.ts +7 -5
- package/build/esm/objectSet/ObjectSet.d.ts.map +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
import type { PropertyValueWireToClient } from "./mapping/PropertyValueMapping.js";
|
|
2
2
|
import type { PrimaryKeyTypes } from "./ontology/PrimaryKeyTypes.js";
|
|
3
|
+
/**
|
|
4
|
+
* @deprecated Use OsdkBase
|
|
5
|
+
*/
|
|
3
6
|
export type OsdkObject<N extends string> = {
|
|
4
7
|
readonly $apiName: N;
|
|
5
8
|
readonly $objectType: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OsdkObject.d.ts","sourceRoot":"","sources":["../../src/OsdkObject.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,mCAAmC,CAAC;AACnF,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAErE,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,MAAM,IAAI;IACzC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;IACrB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,WAAW,EAAE,yBAAyB,CAAC,eAAe,CAAC,CAAC;CAClE,CAAC"}
|
|
1
|
+
{"version":3,"file":"OsdkObject.d.ts","sourceRoot":"","sources":["../../src/OsdkObject.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,mCAAmC,CAAC;AACnF,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,MAAM,IAAI;IACzC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;IACrB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,WAAW,EAAE,yBAAyB,CAAC,eAAe,CAAC,CAAC;CAClE,CAAC"}
|
|
@@ -1,4 +1,6 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { IsAny } from "type-fest";
|
|
2
|
+
import type { DefaultToFalse, OsdkObjectLinksObject } from "./definitions/LinkDefinitions.js";
|
|
3
|
+
import type { NullabilityAdherence } from "./object/FetchPageArgs.js";
|
|
2
4
|
import type { UnionIfTrue } from "./object/FetchPageResult.js";
|
|
3
5
|
import type { InterfaceDefinition } from "./ontology/InterfaceDefinition.js";
|
|
4
6
|
import type { ObjectOrInterfaceDefinition, PropertyKeys } from "./ontology/ObjectOrInterface.js";
|
|
@@ -21,16 +23,25 @@ export type ConvertProps<FROM extends ObjectOrInterfaceDefinition, TO extends Va
|
|
|
21
23
|
/** DO NOT EXPORT FROM PACKAGE */
|
|
22
24
|
export type ValidToFrom<FROM extends ObjectOrInterfaceDefinition> = FROM extends InterfaceDefinition ? ObjectOrInterfaceDefinition : InterfaceDefinition;
|
|
23
25
|
export type IsNever<T> = [T] extends [never] ? true : false;
|
|
24
|
-
type
|
|
25
|
-
type
|
|
26
|
-
export type
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
26
|
+
type ExtractPropsKeysFromOldPropsStyle<Q extends ObjectOrInterfaceDefinition, P extends ValidOsdkPropParams<Q>> = P extends "$all" ? PropertyKeys<Q> : Exclude<P, "$strict" | "$notStrict" | "$rid">;
|
|
27
|
+
export type GetPropsKeys<Q extends ObjectOrInterfaceDefinition, P extends PropertyKeys<Q>> = IsNever<P> extends true ? PropertyKeys<Q> : IsAny<P> extends true ? PropertyKeys<Q> : P;
|
|
28
|
+
export type GetProps<Q extends ObjectOrInterfaceDefinition, OPTIONS extends never | "$notStrict" | "$rid" = never> = IsNever<OPTIONS> extends true ? CompileTimeMetadata<Q>["strictProps"] : (OPTIONS extends "$notStrict" ? CompileTimeMetadata<Q>["props"] : CompileTimeMetadata<Q>["strictProps"]);
|
|
29
|
+
/**
|
|
30
|
+
* Use `Osdk.Instance` or `YourType.OsdkInstance`
|
|
31
|
+
*/
|
|
32
|
+
export type Osdk<Q extends ObjectOrInterfaceDefinition, OPTIONS extends string = never, P extends PropertyKeys<Q> = PropertyKeys<Q>> = IsNever<OPTIONS> extends true ? Osdk.Instance<Q, never, P> : IsNever<Exclude<OPTIONS, "$notStrict" | "$rid">> extends true ? Osdk.Instance<Q, OPTIONS & ("$notStrict" | "$rid"), P> : Osdk.Instance<Q, ("$notStrict" extends OPTIONS ? "$notStrict" : never) | ("$rid" extends OPTIONS ? "$rid" : never), ExtractPropsKeysFromOldPropsStyle<Q, OPTIONS>>;
|
|
33
|
+
export declare namespace Osdk {
|
|
34
|
+
type Instance<Q extends ObjectOrInterfaceDefinition, OPTIONS extends never | "$notStrict" | "$rid" = never, P extends PropertyKeys<Q> = PropertyKeys<Q>> = OsdkBase<Q> & Pick<GetProps<Q, OPTIONS>, GetPropsKeys<Q, P>> & {
|
|
35
|
+
readonly $link: Q extends {
|
|
36
|
+
linksType?: any;
|
|
37
|
+
} ? Q["linksType"] : Q extends ObjectTypeDefinition ? OsdkObjectLinksObject<Q> : never;
|
|
38
|
+
readonly $as: <NEW_Q extends ValidToFrom<Q>>(type: NEW_Q | string) => Osdk.Instance<NEW_Q, OPTIONS, ConvertProps<Q, NEW_Q, P>>;
|
|
39
|
+
} & (IsNever<OPTIONS> extends true ? {} : "$rid" extends OPTIONS ? {
|
|
40
|
+
readonly $rid: string;
|
|
41
|
+
} : {});
|
|
42
|
+
}
|
|
43
|
+
export type ExtractStrictOption<S extends NullabilityAdherence> = S extends false ? "$notStrict" : never;
|
|
44
|
+
export type ExtractRidOption<R extends boolean> = DefaultToFalse<R> extends false ? never : "$rid";
|
|
45
|
+
export type ExtractOptions<R extends boolean, S extends NullabilityAdherence = NullabilityAdherence.Default> = ExtractStrictOption<S> | ExtractRidOption<R>;
|
|
35
46
|
export {};
|
|
36
47
|
//# sourceMappingURL=OsdkObjectFrom.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OsdkObjectFrom.d.ts","sourceRoot":"","sources":["../../src/OsdkObjectFrom.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,
|
|
1
|
+
{"version":3,"file":"OsdkObjectFrom.d.ts","sourceRoot":"","sources":["../../src/OsdkObjectFrom.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,KAAK,EACV,cAAc,EACd,qBAAqB,EACtB,MAAM,kCAAkC,CAAC;AAC1C,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACtE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AAC7E,OAAO,KAAK,EACV,2BAA2B,EAC3B,YAAY,EACb,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EACV,mBAAmB,EACnB,oBAAoB,EACrB,MAAM,oCAAoC,CAAC;AAC5C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAY9C,KAAK,qBAAqB,GACtB,MAAM,GACN,MAAM,GACN,SAAS,GACT,YAAY,CAAC;AAEjB,KAAK,mBAAmB,CAAC,CAAC,SAAS,2BAA2B,IAC1D,qBAAqB,GACrB,YAAY,CAAC,CAAC,CAAC,CAAC;AAEpB,MAAM,MAAM,eAAe,CACzB,CAAC,SAAS,2BAA2B,IACnC,mBAAmB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;AAEtC,MAAM,MAAM,SAAS,CACnB,CAAC,SAAS,2BAA2B,EACrC,CAAC,SAAS,mBAAmB,CAAC,CAAC,CAAC,IAC9B,CAAC,SAAS,MAAM,GAAG,YAAY,CAAC,CAAC,CAAC,GAClC,OAAO,CAAC,CAAC,EAAE,qBAAqB,CAAC,CAAC;AAEtC,MAAM,MAAM,eAAe,CACzB,IAAI,SAAS,2BAA2B,EACxC,EAAE,SAAS,oBAAoB,IAC7B,WAAW,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC;AAEhF,MAAM,MAAM,wBAAwB,CAClC,IAAI,SAAS,2BAA2B,EACxC,EAAE,SAAS,oBAAoB,EAC/B,CAAC,SAAS,mBAAmB,CAAC,IAAI,CAAC,IACjC,eAAe,CACjB,IAAI,EACJ,EAAE,CACH,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,MAAM,eAAe,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;AAExD,MAAM,MAAM,kBAAkB,CAC5B,IAAI,SAAS,oBAAoB,EACjC,EAAE,SAAS,mBAAmB,IAC5B,WAAW,CACb,mBAAmB,CAAC,IAAI,CAAC,CAAC,qBAAqB,CAAC,CACjD,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC;AAEvB,MAAM,MAAM,uBAAuB,CACjC,IAAI,SAAS,oBAAoB,EACjC,EAAE,SAAS,mBAAmB,EAC9B,CAAC,SAAS,mBAAmB,CAAC,IAAI,CAAC,IACjC,kBAAkB,CACpB,IAAI,EACJ,EAAE,CACH,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,MAAM,kBAAkB,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;AAC3D;;;;GAIG;AACH,MAAM,MAAM,YAAY,CACtB,IAAI,SAAS,2BAA2B,EACxC,EAAE,SAAS,WAAW,CAAC,IAAI,CAAC,EAC5B,CAAC,SAAS,mBAAmB,CAAC,IAAI,CAAC,IACjC,EAAE,SAAS,IAAI,GAAG,CAAC,GACnB,EAAE,SAAS,oBAAoB,GAAG,CAChC,WAAW,CACT,wBAAwB,CAAC,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC,EACrC,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,KAAK,EAC/B,MAAM,CACP,CACF,GACD,EAAE,SAAS,mBAAmB,GAAG,IAAI,SAAS,oBAAoB,GAAG,CACjE,WAAW,CACT,uBAAuB,CAAC,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC,EACpC,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,KAAK,EAC/B,MAAM,CACP,CACF,GACD,KAAK,GACP,KAAK,CAAC;AAEV,iCAAiC;AACjC,MAAM,MAAM,WAAW,CACrB,IAAI,SAAS,2BAA2B,IACtC,IAAI,SAAS,mBAAmB,GAAG,2BAA2B,GAC9D,mBAAmB,CAAC;AAkBxB,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC;AAE5D,KAAK,iCAAiC,CACpC,CAAC,SAAS,2BAA2B,EACrC,CAAC,SAAS,mBAAmB,CAAC,CAAC,CAAC,IAC9B,CAAC,SAAS,MAAM,GAAG,YAAY,CAAC,CAAC,CAAC,GAClC,OAAO,CAAC,CAAC,EAAE,SAAS,GAAG,YAAY,GAAG,MAAM,CAAC,CAAC;AAElD,MAAM,MAAM,YAAY,CACtB,CAAC,SAAS,2BAA2B,EACrC,CAAC,SAAS,YAAY,CAAC,CAAC,CAAC,IACvB,OAAO,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,YAAY,CAAC,CAAC,CAAC,GACzC,KAAK,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,YAAY,CAAC,CAAC,CAAC,GACvC,CAAC,CAAC;AAEN,MAAM,MAAM,QAAQ,CAClB,CAAC,SAAS,2BAA2B,EACrC,OAAO,SAAS,KAAK,GAAG,YAAY,GAAG,MAAM,GAAG,KAAK,IACnD,OAAO,CAAC,OAAO,CAAC,SAAS,IAAI,GAAG,mBAAmB,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,GACrE,CAAC,OAAO,SAAS,YAAY,GAAG,mBAAmB,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAC7D,mBAAmB,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC;AAE7C;;GAEG;AACH,MAAM,MAAM,IAAI,CACd,CAAC,SAAS,2BAA2B,EACrC,OAAO,SAAS,MAAM,GAAG,KAAK,EAC9B,CAAC,SAAS,YAAY,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,IAG3C,OAAO,CAAC,OAAO,CAAC,SAAS,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,GAEtD,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,YAAY,GAAG,MAAM,CAAC,CAAC,SAAS,IAAI,GAC3D,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,YAAY,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC,GAGxD,IAAI,CAAC,QAAQ,CACb,CAAC,EACC,CAAC,YAAY,SAAS,OAAO,GAAG,YAAY,GAAG,KAAK,CAAC,GACrD,CAAC,MAAM,SAAS,OAAO,GAAG,MAAM,GAAG,KAAK,CAAC,EAC3C,iCAAiC,CAAC,CAAC,EAAE,OAAO,CAAC,CAC9C,CAAC;AAEN,yBAAiB,IAAI,CAAC;IACpB,KAAY,QAAQ,CAClB,CAAC,SAAS,2BAA2B,EACrC,OAAO,SAAS,KAAK,GAAG,YAAY,GAAG,MAAM,GAAG,KAAK,EACrD,CAAC,SAAS,YAAY,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,IAEzC,QAAQ,CAAC,CAAC,CAAC,GACX,IAAI,CACJ,QAAQ,CAAC,CAAC,EAAE,OAAO,CAAC,EACpB,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,CACnB,GACC;QACA,QAAQ,CAAC,KAAK,EAAE,CAAC,SAAS;YAAE,SAAS,CAAC,EAAE,GAAG,CAAA;SAAE,GAAG,CAAC,CAAC,WAAW,CAAC,GAC1D,CAAC,SAAS,oBAAoB,GAAG,qBAAqB,CAAC,CAAC,CAAC,GACzD,KAAK,CAAC;QAEV,QAAQ,CAAC,GAAG,EAAE,CAAC,KAAK,SAAS,WAAW,CAAC,CAAC,CAAC,EACzC,IAAI,EAAE,KAAK,GAAG,MAAM,KACjB,IAAI,CAAC,QAAQ,CAChB,KAAK,EACL,OAAO,EACP,YAAY,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAC1B,CAAC;KACH,GAEC,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,IAAI,GAAG,EAAE,GACjC,MAAM,SAAS,OAAO,GAAG;QAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAClD,EAAE,CAAC,CAAC;CACX;AAGD,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,oBAAoB,IAAI,CAAC,SACjE,KAAK,GAAG,YAAY,GAClB,KAAK,CAAC;AAGV,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,OAAO,IAAI,cAAc,CAAC,CAAC,CAAC,SACjE,KAAK,GAAG,KAAK,GACX,MAAM,CAAC;AAGX,MAAM,MAAM,cAAc,CACxB,CAAC,SAAS,OAAO,EACjB,CAAC,SAAS,oBAAoB,GAAG,oBAAoB,CAAC,OAAO,IAC3D,mBAAmB,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PageResult.d.ts","sourceRoot":"","sources":["../../src/PageResult.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"PageResult.d.ts","sourceRoot":"","sources":["../../src/PageResult.ts"],"names":[],"mappings":"AAgBA,MAAM,WAAW,UAAU,CAAC,CAAC;IAC3B,IAAI,EAAE,CAAC,EAAE,CAAC;IACV,aAAa,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,UAAU,EAAE,MAAM,CAAC;CACpB"}
|
|
@@ -1,6 +1,5 @@
|
|
|
1
|
-
import type { DefaultToFalse } from "../definitions/LinkDefinitions.js";
|
|
2
1
|
import type { ObjectOrInterfaceDefinition, PropertyKeys } from "../ontology/ObjectOrInterface.js";
|
|
3
|
-
import type { IsNever, Osdk } from "../OsdkObjectFrom.js";
|
|
2
|
+
import type { ExtractOptions, IsNever, Osdk } from "../OsdkObjectFrom.js";
|
|
4
3
|
import type { PageResult } from "../PageResult.js";
|
|
5
4
|
import type { NullabilityAdherence } from "./FetchPageArgs.js";
|
|
6
5
|
/** exposed for a test */
|
|
@@ -9,7 +8,13 @@ export type RespectNullability<S extends NullabilityAdherence> = S extends false
|
|
|
9
8
|
export type UnionIfFalse<S extends string, JUST_S_IF_TRUE extends boolean, E> = IsNever<S> extends true ? never : JUST_S_IF_TRUE extends true ? S : S | E;
|
|
10
9
|
/** exposed for a test */
|
|
11
10
|
export type UnionIfTrue<S extends string, UNION_IF_TRUE extends boolean, E extends string> = IsNever<S> extends true ? never : UNION_IF_TRUE extends true ? S | E : S;
|
|
12
|
-
|
|
13
|
-
|
|
11
|
+
/**
|
|
12
|
+
* Helper type for converting fetch options into an Osdk object
|
|
13
|
+
*/
|
|
14
|
+
export type FetchPageResult<Q extends ObjectOrInterfaceDefinition, L extends PropertyKeys<Q>, R extends boolean, S extends NullabilityAdherence> = PageResult<PropertyKeys<Q> extends L ? Osdk.Instance<Q, ExtractOptions<R, S>> : Osdk.Instance<Q, ExtractOptions<R, S>, L>>;
|
|
15
|
+
/**
|
|
16
|
+
* Helper type for converting fetch options into an Osdk object
|
|
17
|
+
*/
|
|
18
|
+
export type SingleOsdkResult<Q extends ObjectOrInterfaceDefinition, L extends PropertyKeys<Q>, R extends boolean, S extends NullabilityAdherence> = Osdk.Instance<Q, ExtractOptions<R, S>, L>;
|
|
14
19
|
export type IsAny<T> = unknown extends T ? [keyof T] extends [never] ? false : true : false;
|
|
15
20
|
//# sourceMappingURL=FetchPageResult.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"FetchPageResult.d.ts","sourceRoot":"","sources":["../../../src/object/FetchPageResult.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"FetchPageResult.d.ts","sourceRoot":"","sources":["../../../src/object/FetchPageResult.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EACV,2BAA2B,EAC3B,YAAY,EACb,MAAM,kCAAkC,CAAC;AAC1C,OAAO,KAAK,EAAE,cAAc,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAC1E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAE/D,yBAAyB;AACzB,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,oBAAoB,IAAI,CAAC,SAAS,KAAK,GAC5E,KAAK,GACL,IAAI,CAAC;AAET,yBAAyB;AACzB,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,MAAM,EAAE,cAAc,SAAS,OAAO,EAAE,CAAC,IAC1E,OAAO,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,KAAK,GAC3B,cAAc,SAAS,IAAI,GAAG,CAAC,GAC/B,CAAC,GAAG,CAAC,CAAC;AAEZ,yBAAyB;AACzB,MAAM,MAAM,WAAW,CACrB,CAAC,SAAS,MAAM,EAChB,aAAa,SAAS,OAAO,EAC7B,CAAC,SAAS,MAAM,IACd,OAAO,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,KAAK,GAC/B,aAAa,SAAS,IAAI,GAAG,CAAC,GAAG,CAAC,GAClC,CAAC,CAAC;AAEN;;GAEG;AACH,MAAM,MAAM,eAAe,CACzB,CAAC,SAAS,2BAA2B,EACrC,CAAC,SAAS,YAAY,CAAC,CAAC,CAAC,EACzB,CAAC,SAAS,OAAO,EACjB,CAAC,SAAS,oBAAoB,IAC5B,UAAU,CACZ,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAC9D,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAC9C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,CAC1B,CAAC,SAAS,2BAA2B,EACrC,CAAC,SAAS,YAAY,CAAC,CAAC,CAAC,EACzB,CAAC,SAAS,OAAO,EACjB,CAAC,SAAS,oBAAoB,IAC5B,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAE9C,MAAM,MAAM,KAAK,CAAC,CAAC,IAAI,OAAO,SAAS,CAAC,GACpC,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,KAAK,GAAG,IAAI,GACxC,KAAK,CAAC"}
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
import type { ObjectOrInterfaceDefinition } from "../ontology/ObjectOrInterface.js";
|
|
2
|
-
import type {
|
|
2
|
+
import type { Osdk } from "../OsdkObjectFrom.js";
|
|
3
3
|
export interface EXPERIMENTAL_ObjectSetListener<O extends ObjectOrInterfaceDefinition> {
|
|
4
4
|
/**
|
|
5
5
|
* Specific objects have changed and can be immediately updated
|
|
6
6
|
*/
|
|
7
|
-
onChange?: (objects: Array<
|
|
7
|
+
onChange?: (objects: Array<Osdk.Instance<O>>) => void;
|
|
8
8
|
/**
|
|
9
9
|
* The ObjectSet has become outdated and should be re-fetched in its entirety.
|
|
10
10
|
* This is also sent when the subscription is first initialized.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"EXPERIMENTAL_ObjectSetListener.d.ts","sourceRoot":"","sources":["../../../src/objectSet/EXPERIMENTAL_ObjectSetListener.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAC;AACpF,OAAO,KAAK,EAAE,
|
|
1
|
+
{"version":3,"file":"EXPERIMENTAL_ObjectSetListener.d.ts","sourceRoot":"","sources":["../../../src/objectSet/EXPERIMENTAL_ObjectSetListener.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAC;AACpF,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAEjD,MAAM,WAAW,8BAA8B,CAC7C,CAAC,SAAS,2BAA2B;IAErC;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;IAEtD;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,IAAI,CAAC;IAEzB;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;CACpC"}
|
|
@@ -3,12 +3,14 @@ import type { AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy } f
|
|
|
3
3
|
import type { AggregationsResults } from "../aggregate/AggregationsResults.js";
|
|
4
4
|
import type { WhereClause } from "../aggregate/WhereClause.js";
|
|
5
5
|
import type { AsyncIterArgs, Augments, FetchPageArgs, NullabilityAdherence, SelectArg } from "../object/FetchPageArgs.js";
|
|
6
|
-
import type {
|
|
6
|
+
import type { SingleOsdkResult } from "../object/FetchPageResult.js";
|
|
7
7
|
import type { Result } from "../object/Result.js";
|
|
8
8
|
import type { InterfaceDefinition } from "../ontology/InterfaceDefinition.js";
|
|
9
9
|
import type { ObjectOrInterfaceDefinition, PropertyKeys } from "../ontology/ObjectOrInterface.js";
|
|
10
10
|
import type { CompileTimeMetadata, ObjectTypeDefinition } from "../ontology/ObjectTypeDefinition.js";
|
|
11
11
|
import type { PrimaryKeyType } from "../OsdkBase.js";
|
|
12
|
+
import type { ExtractOptions, Osdk } from "../OsdkObjectFrom.js";
|
|
13
|
+
import type { PageResult } from "../PageResult.js";
|
|
12
14
|
import type { __EXPERIMENTAL__NOT_SUPPORTED_YET_subscribe, EXPERIMENTAL_ObjectSetListener } from "../public/unstable.js";
|
|
13
15
|
import type { LinkedType, LinkNames } from "../util/LinkUtils.js";
|
|
14
16
|
import type { BaseObjectSet } from "./BaseObjectSet.js";
|
|
@@ -25,7 +27,7 @@ export interface MinimalObjectSet<Q extends ObjectOrInterfaceDefinition> extends
|
|
|
25
27
|
|
|
26
28
|
* @returns a page of objects
|
|
27
29
|
*/
|
|
28
|
-
readonly fetchPage: <L extends PropertyKeys<Q>, R extends boolean, const A extends Augments, S extends NullabilityAdherence = NullabilityAdherence.Default>(args?: FetchPageArgs<Q, L, R, A, S>) => Promise<
|
|
30
|
+
readonly fetchPage: <L extends PropertyKeys<Q>, R extends boolean, const A extends Augments, S extends NullabilityAdherence = NullabilityAdherence.Default>(args?: FetchPageArgs<Q, L, R, A, S>) => Promise<PageResult<PropertyKeys<Q> extends L ? Osdk.Instance<Q, ExtractOptions<R, S>> : Osdk.Instance<Q, ExtractOptions<R, S>, L>>>;
|
|
29
31
|
/**
|
|
30
32
|
* Gets a page of objects of this type, with a result wrapper
|
|
31
33
|
* @param args - Args to specify next page token and page size, if applicable
|
|
@@ -40,7 +42,7 @@ export interface MinimalObjectSet<Q extends ObjectOrInterfaceDefinition> extends
|
|
|
40
42
|
}
|
|
41
43
|
* @returns a page of objects, wrapped in a result wrapper
|
|
42
44
|
*/
|
|
43
|
-
readonly fetchPageWithErrors: <L extends PropertyKeys<Q>, R extends boolean, const A extends Augments, S extends NullabilityAdherence = NullabilityAdherence.Default>(args?: FetchPageArgs<Q, L, R, A, S>) => Promise<Result<
|
|
45
|
+
readonly fetchPageWithErrors: <L extends PropertyKeys<Q>, R extends boolean, const A extends Augments, S extends NullabilityAdherence = NullabilityAdherence.Default>(args?: FetchPageArgs<Q, L, R, A, S>) => Promise<Result<PageResult<Osdk.Instance<Q, ExtractOptions<R, S>, L>>>>;
|
|
44
46
|
/**
|
|
45
47
|
* Allows you to filter an object set with a given clause
|
|
46
48
|
* @param clause - Takes a filter clause
|
|
@@ -128,11 +130,11 @@ export interface ObjectSet<Q extends ObjectOrInterfaceDefinition = any, _UNUSED
|
|
|
128
130
|
/**
|
|
129
131
|
* Fetches one object with the specified primary key, without a result wrapper
|
|
130
132
|
*/
|
|
131
|
-
readonly fetchOne: Q extends ObjectTypeDefinition ? <const L extends PropertyKeys<Q>, const R extends boolean, const S extends false | "throw" = NullabilityAdherence.Default>(primaryKey: PrimaryKeyType<Q>, options?: SelectArg<Q, L, R, S>) => Promise<
|
|
133
|
+
readonly fetchOne: Q extends ObjectTypeDefinition ? <const L extends PropertyKeys<Q>, const R extends boolean, const S extends false | "throw" = NullabilityAdherence.Default>(primaryKey: PrimaryKeyType<Q>, options?: SelectArg<Q, L, R, S>) => Promise<Osdk.Instance<Q, ExtractOptions<R, S>, L>> : never;
|
|
132
134
|
/**
|
|
133
135
|
* Fetches one object with the specified primary key, with a result wrapper
|
|
134
136
|
*/
|
|
135
|
-
readonly fetchOneWithErrors: Q extends ObjectTypeDefinition ? <L extends PropertyKeys<Q>, R extends boolean, S extends false | "throw" = NullabilityAdherence.Default>(primaryKey: PrimaryKeyType<Q>, options?: SelectArg<Q, L, R, S>) => Promise<Result<
|
|
137
|
+
readonly fetchOneWithErrors: Q extends ObjectTypeDefinition ? <L extends PropertyKeys<Q>, R extends boolean, S extends false | "throw" = NullabilityAdherence.Default>(primaryKey: PrimaryKeyType<Q>, options?: SelectArg<Q, L, R, S>) => Promise<Result<Osdk.Instance<Q, ExtractOptions<R, S>, L>>> : never;
|
|
136
138
|
/**
|
|
137
139
|
* WARNING. THIS METHOD IS EXPERIMENTAL AND NOT SUPPORTED YET.
|
|
138
140
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ObjectSet.d.ts","sourceRoot":"","sources":["../../../src/objectSet/ObjectSet.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,KAAK,EAAE,8DAA8D,EAAE,MAAM,yCAAyC,CAAC;AAC9H,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAC;AAC/E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,KAAK,EACV,aAAa,EACb,QAAQ,EACR,aAAa,EACb,oBAAoB,EACpB,SAAS,EACV,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"ObjectSet.d.ts","sourceRoot":"","sources":["../../../src/objectSet/ObjectSet.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,KAAK,EAAE,8DAA8D,EAAE,MAAM,yCAAyC,CAAC;AAC9H,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAC;AAC/E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,KAAK,EACV,aAAa,EACb,QAAQ,EACR,aAAa,EACb,oBAAoB,EACpB,SAAS,EACV,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AACrE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AAC9E,OAAO,KAAK,EACV,2BAA2B,EAC3B,YAAY,EACb,MAAM,kCAAkC,CAAC;AAC1C,OAAO,KAAK,EACV,mBAAmB,EACnB,oBAAoB,EACrB,MAAM,qCAAqC,CAAC;AAC7C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AACjE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,KAAK,EACV,2CAA2C,EAC3C,8BAA8B,EAC/B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAClE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAExD,MAAM,WAAW,gBAAgB,CAAC,CAAC,SAAS,2BAA2B,CACrE,SAAQ,aAAa,CAAC,CAAC,CAAC;IAExB;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,SAAS,EAAE,CAClB,CAAC,SAAS,YAAY,CAAC,CAAC,CAAC,EACzB,CAAC,SAAS,OAAO,EACjB,KAAK,CAAC,CAAC,SAAS,QAAQ,EACxB,CAAC,SAAS,oBAAoB,GAAG,oBAAoB,CAAC,OAAO,EAE7D,IAAI,CAAC,EAAE,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAChC,OAAO,CACV,UAAU,CACR,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAC9D,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAC9C,CACF,CAAC;IAEF;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,mBAAmB,EAAE,CAC5B,CAAC,SAAS,YAAY,CAAC,CAAC,CAAC,EACzB,CAAC,SAAS,OAAO,EACjB,KAAK,CAAC,CAAC,SAAS,QAAQ,EACxB,CAAC,SAAS,oBAAoB,GAAG,oBAAoB,CAAC,OAAO,EAE7D,IAAI,CAAC,EAAE,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAChC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAE5E;;;;;;;;;OASG;IACH,QAAQ,CAAC,KAAK,EAAE,CACd,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,KACnB,IAAI,CAAC;IAEV;;;;;;;OAOG;IACH,QAAQ,CAAC,SAAS,EAAE,CAClB,CAAC,SAAS,YAAY,CAAC,CAAC,CAAC,EACzB,CAAC,SAAS,OAAO,EACjB,KAAK,CAAC,CAAC,SAAS,QAAQ,EACxB,CAAC,SAAS,oBAAoB,GAAG,oBAAoB,CAAC,OAAO,EAE7D,IAAI,CAAC,EAAE,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAChC,qBAAqB,CAAC,gBAAgB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;CAC1D;AAED,MAAM,WAAW,kBAAkB,CACjC,CAAC,SAAS,mBAAmB,CAC7B,SAAQ,gBAAgB,CAAC,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,SAAS,CACxB,CAAC,SAAS,2BAA2B,GAAG,GAAG,EAC3C,OAAO,GAAG,GAAG,CACb,SAAQ,gBAAgB,CAAC,CAAC,CAAC;IAC3B;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,QAAQ,CAAC,SAAS,EAAE,CAAC,EAAE,SAAS,aAAa,CAAC,CAAC,CAAC,EAC9C,GAAG,EAAE,8DAA8D,CAAC,CAAC,EAAE,EAAE,CAAC,KACvE,OAAO,CAAC,mBAAmB,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IAEzC;;;;;;;;OAQG;IACH,QAAQ,CAAC,KAAK,EAAE,CACd,GAAG,UAAU,EAAE,aAAa,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,KAC9D,IAAI,CAAC;IAEV;;;;;;;;OAQG;IACH,QAAQ,CAAC,SAAS,EAAE,CAClB,GAAG,UAAU,EAAE,aAAa,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,KAC9D,IAAI,CAAC;IAEV;;;;;;;;OAQG;IACH,QAAQ,CAAC,QAAQ,EAAE,CACjB,GAAG,UAAU,EAAE,aAAa,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,KAC9D,IAAI,CAAC;IAEV;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC,SAAS,SAAS,CAAC,CAAC,CAAC,EACvC,IAAI,EAAE,CAAC,KACJ,mBAAmB,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC;IAExD;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,CAAC,SAAS,oBAAoB,GAAG,CAChD,KAAK,CAAC,CAAC,SAAS,YAAY,CAAC,CAAC,CAAC,EAC/B,KAAK,CAAC,CAAC,SAAS,OAAO,EACvB,KAAK,CAAC,CAAC,SAAS,KAAK,GAAG,OAAO,GAAG,oBAAoB,CAAC,OAAO,EAE9D,UAAU,EAAE,cAAc,CAAC,CAAC,CAAC,EAC7B,OAAO,CAAC,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAC5B,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GACrD,KAAK,CAAC;IAEV;;OAEG;IACH,QAAQ,CAAC,kBAAkB,EAAE,CAAC,SAAS,oBAAoB,GAAG,CAC1D,CAAC,SAAS,YAAY,CAAC,CAAC,CAAC,EACzB,CAAC,SAAS,OAAO,EACjB,CAAC,SAAS,KAAK,GAAG,OAAO,GAAG,oBAAoB,CAAC,OAAO,EAExD,UAAU,EAAE,cAAc,CAAC,CAAC,CAAC,EAC7B,OAAO,CAAC,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAC5B,OAAO,CACV,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAClD,GACC,KAAK,CAAC;IAEV;;;;;;OAMG;IACH,QAAQ,CAAC,CAAC,2CAA2C,CAAC,EAAE,CACtD,QAAQ,EAAE,8BAA8B,CAAC,CAAC,CAAC,KACxC,MAAM,OAAO,CAAC;CACpB"}
|
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
import type { PropertyValueWireToClient } from "./mapping/PropertyValueMapping.js";
|
|
2
2
|
import type { PrimaryKeyTypes } from "./ontology/PrimaryKeyTypes.js";
|
|
3
|
+
/**
|
|
4
|
+
* @deprecated Use OsdkBase
|
|
5
|
+
*/
|
|
3
6
|
export type OsdkObject<N extends string> = {
|
|
4
7
|
readonly $apiName: N;
|
|
5
8
|
readonly $objectType: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OsdkObject.d.ts","sourceRoot":"","sources":["../../src/OsdkObject.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,mCAAmC,CAAC;AACnF,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAErE,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,MAAM,IAAI;IACzC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;IACrB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,WAAW,EAAE,yBAAyB,CAAC,eAAe,CAAC,CAAC;CAClE,CAAC"}
|
|
1
|
+
{"version":3,"file":"OsdkObject.d.ts","sourceRoot":"","sources":["../../src/OsdkObject.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,mCAAmC,CAAC;AACnF,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,MAAM,IAAI;IACzC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;IACrB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,WAAW,EAAE,yBAAyB,CAAC,eAAe,CAAC,CAAC;CAClE,CAAC"}
|
|
@@ -1,4 +1,6 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { IsAny } from "type-fest";
|
|
2
|
+
import type { DefaultToFalse, OsdkObjectLinksObject } from "./definitions/LinkDefinitions.js";
|
|
3
|
+
import type { NullabilityAdherence } from "./object/FetchPageArgs.js";
|
|
2
4
|
import type { UnionIfTrue } from "./object/FetchPageResult.js";
|
|
3
5
|
import type { InterfaceDefinition } from "./ontology/InterfaceDefinition.js";
|
|
4
6
|
import type { ObjectOrInterfaceDefinition, PropertyKeys } from "./ontology/ObjectOrInterface.js";
|
|
@@ -21,16 +23,25 @@ export type ConvertProps<FROM extends ObjectOrInterfaceDefinition, TO extends Va
|
|
|
21
23
|
/** DO NOT EXPORT FROM PACKAGE */
|
|
22
24
|
export type ValidToFrom<FROM extends ObjectOrInterfaceDefinition> = FROM extends InterfaceDefinition ? ObjectOrInterfaceDefinition : InterfaceDefinition;
|
|
23
25
|
export type IsNever<T> = [T] extends [never] ? true : false;
|
|
24
|
-
type
|
|
25
|
-
type
|
|
26
|
-
export type
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
26
|
+
type ExtractPropsKeysFromOldPropsStyle<Q extends ObjectOrInterfaceDefinition, P extends ValidOsdkPropParams<Q>> = P extends "$all" ? PropertyKeys<Q> : Exclude<P, "$strict" | "$notStrict" | "$rid">;
|
|
27
|
+
export type GetPropsKeys<Q extends ObjectOrInterfaceDefinition, P extends PropertyKeys<Q>> = IsNever<P> extends true ? PropertyKeys<Q> : IsAny<P> extends true ? PropertyKeys<Q> : P;
|
|
28
|
+
export type GetProps<Q extends ObjectOrInterfaceDefinition, OPTIONS extends never | "$notStrict" | "$rid" = never> = IsNever<OPTIONS> extends true ? CompileTimeMetadata<Q>["strictProps"] : (OPTIONS extends "$notStrict" ? CompileTimeMetadata<Q>["props"] : CompileTimeMetadata<Q>["strictProps"]);
|
|
29
|
+
/**
|
|
30
|
+
* Use `Osdk.Instance` or `YourType.OsdkInstance`
|
|
31
|
+
*/
|
|
32
|
+
export type Osdk<Q extends ObjectOrInterfaceDefinition, OPTIONS extends string = never, P extends PropertyKeys<Q> = PropertyKeys<Q>> = IsNever<OPTIONS> extends true ? Osdk.Instance<Q, never, P> : IsNever<Exclude<OPTIONS, "$notStrict" | "$rid">> extends true ? Osdk.Instance<Q, OPTIONS & ("$notStrict" | "$rid"), P> : Osdk.Instance<Q, ("$notStrict" extends OPTIONS ? "$notStrict" : never) | ("$rid" extends OPTIONS ? "$rid" : never), ExtractPropsKeysFromOldPropsStyle<Q, OPTIONS>>;
|
|
33
|
+
export declare namespace Osdk {
|
|
34
|
+
type Instance<Q extends ObjectOrInterfaceDefinition, OPTIONS extends never | "$notStrict" | "$rid" = never, P extends PropertyKeys<Q> = PropertyKeys<Q>> = OsdkBase<Q> & Pick<GetProps<Q, OPTIONS>, GetPropsKeys<Q, P>> & {
|
|
35
|
+
readonly $link: Q extends {
|
|
36
|
+
linksType?: any;
|
|
37
|
+
} ? Q["linksType"] : Q extends ObjectTypeDefinition ? OsdkObjectLinksObject<Q> : never;
|
|
38
|
+
readonly $as: <NEW_Q extends ValidToFrom<Q>>(type: NEW_Q | string) => Osdk.Instance<NEW_Q, OPTIONS, ConvertProps<Q, NEW_Q, P>>;
|
|
39
|
+
} & (IsNever<OPTIONS> extends true ? {} : "$rid" extends OPTIONS ? {
|
|
40
|
+
readonly $rid: string;
|
|
41
|
+
} : {});
|
|
42
|
+
}
|
|
43
|
+
export type ExtractStrictOption<S extends NullabilityAdherence> = S extends false ? "$notStrict" : never;
|
|
44
|
+
export type ExtractRidOption<R extends boolean> = DefaultToFalse<R> extends false ? never : "$rid";
|
|
45
|
+
export type ExtractOptions<R extends boolean, S extends NullabilityAdherence = NullabilityAdherence.Default> = ExtractStrictOption<S> | ExtractRidOption<R>;
|
|
35
46
|
export {};
|
|
36
47
|
//# sourceMappingURL=OsdkObjectFrom.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OsdkObjectFrom.d.ts","sourceRoot":"","sources":["../../src/OsdkObjectFrom.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,
|
|
1
|
+
{"version":3,"file":"OsdkObjectFrom.d.ts","sourceRoot":"","sources":["../../src/OsdkObjectFrom.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,KAAK,EACV,cAAc,EACd,qBAAqB,EACtB,MAAM,kCAAkC,CAAC;AAC1C,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACtE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AAC7E,OAAO,KAAK,EACV,2BAA2B,EAC3B,YAAY,EACb,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EACV,mBAAmB,EACnB,oBAAoB,EACrB,MAAM,oCAAoC,CAAC;AAC5C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAY9C,KAAK,qBAAqB,GACtB,MAAM,GACN,MAAM,GACN,SAAS,GACT,YAAY,CAAC;AAEjB,KAAK,mBAAmB,CAAC,CAAC,SAAS,2BAA2B,IAC1D,qBAAqB,GACrB,YAAY,CAAC,CAAC,CAAC,CAAC;AAEpB,MAAM,MAAM,eAAe,CACzB,CAAC,SAAS,2BAA2B,IACnC,mBAAmB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;AAEtC,MAAM,MAAM,SAAS,CACnB,CAAC,SAAS,2BAA2B,EACrC,CAAC,SAAS,mBAAmB,CAAC,CAAC,CAAC,IAC9B,CAAC,SAAS,MAAM,GAAG,YAAY,CAAC,CAAC,CAAC,GAClC,OAAO,CAAC,CAAC,EAAE,qBAAqB,CAAC,CAAC;AAEtC,MAAM,MAAM,eAAe,CACzB,IAAI,SAAS,2BAA2B,EACxC,EAAE,SAAS,oBAAoB,IAC7B,WAAW,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC;AAEhF,MAAM,MAAM,wBAAwB,CAClC,IAAI,SAAS,2BAA2B,EACxC,EAAE,SAAS,oBAAoB,EAC/B,CAAC,SAAS,mBAAmB,CAAC,IAAI,CAAC,IACjC,eAAe,CACjB,IAAI,EACJ,EAAE,CACH,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,MAAM,eAAe,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;AAExD,MAAM,MAAM,kBAAkB,CAC5B,IAAI,SAAS,oBAAoB,EACjC,EAAE,SAAS,mBAAmB,IAC5B,WAAW,CACb,mBAAmB,CAAC,IAAI,CAAC,CAAC,qBAAqB,CAAC,CACjD,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC;AAEvB,MAAM,MAAM,uBAAuB,CACjC,IAAI,SAAS,oBAAoB,EACjC,EAAE,SAAS,mBAAmB,EAC9B,CAAC,SAAS,mBAAmB,CAAC,IAAI,CAAC,IACjC,kBAAkB,CACpB,IAAI,EACJ,EAAE,CACH,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,MAAM,kBAAkB,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;AAC3D;;;;GAIG;AACH,MAAM,MAAM,YAAY,CACtB,IAAI,SAAS,2BAA2B,EACxC,EAAE,SAAS,WAAW,CAAC,IAAI,CAAC,EAC5B,CAAC,SAAS,mBAAmB,CAAC,IAAI,CAAC,IACjC,EAAE,SAAS,IAAI,GAAG,CAAC,GACnB,EAAE,SAAS,oBAAoB,GAAG,CAChC,WAAW,CACT,wBAAwB,CAAC,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC,EACrC,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,KAAK,EAC/B,MAAM,CACP,CACF,GACD,EAAE,SAAS,mBAAmB,GAAG,IAAI,SAAS,oBAAoB,GAAG,CACjE,WAAW,CACT,uBAAuB,CAAC,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC,EACpC,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,KAAK,EAC/B,MAAM,CACP,CACF,GACD,KAAK,GACP,KAAK,CAAC;AAEV,iCAAiC;AACjC,MAAM,MAAM,WAAW,CACrB,IAAI,SAAS,2BAA2B,IACtC,IAAI,SAAS,mBAAmB,GAAG,2BAA2B,GAC9D,mBAAmB,CAAC;AAkBxB,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC;AAE5D,KAAK,iCAAiC,CACpC,CAAC,SAAS,2BAA2B,EACrC,CAAC,SAAS,mBAAmB,CAAC,CAAC,CAAC,IAC9B,CAAC,SAAS,MAAM,GAAG,YAAY,CAAC,CAAC,CAAC,GAClC,OAAO,CAAC,CAAC,EAAE,SAAS,GAAG,YAAY,GAAG,MAAM,CAAC,CAAC;AAElD,MAAM,MAAM,YAAY,CACtB,CAAC,SAAS,2BAA2B,EACrC,CAAC,SAAS,YAAY,CAAC,CAAC,CAAC,IACvB,OAAO,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,YAAY,CAAC,CAAC,CAAC,GACzC,KAAK,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,YAAY,CAAC,CAAC,CAAC,GACvC,CAAC,CAAC;AAEN,MAAM,MAAM,QAAQ,CAClB,CAAC,SAAS,2BAA2B,EACrC,OAAO,SAAS,KAAK,GAAG,YAAY,GAAG,MAAM,GAAG,KAAK,IACnD,OAAO,CAAC,OAAO,CAAC,SAAS,IAAI,GAAG,mBAAmB,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,GACrE,CAAC,OAAO,SAAS,YAAY,GAAG,mBAAmB,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAC7D,mBAAmB,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC;AAE7C;;GAEG;AACH,MAAM,MAAM,IAAI,CACd,CAAC,SAAS,2BAA2B,EACrC,OAAO,SAAS,MAAM,GAAG,KAAK,EAC9B,CAAC,SAAS,YAAY,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,IAG3C,OAAO,CAAC,OAAO,CAAC,SAAS,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,GAEtD,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,YAAY,GAAG,MAAM,CAAC,CAAC,SAAS,IAAI,GAC3D,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,YAAY,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC,GAGxD,IAAI,CAAC,QAAQ,CACb,CAAC,EACC,CAAC,YAAY,SAAS,OAAO,GAAG,YAAY,GAAG,KAAK,CAAC,GACrD,CAAC,MAAM,SAAS,OAAO,GAAG,MAAM,GAAG,KAAK,CAAC,EAC3C,iCAAiC,CAAC,CAAC,EAAE,OAAO,CAAC,CAC9C,CAAC;AAEN,yBAAiB,IAAI,CAAC;IACpB,KAAY,QAAQ,CAClB,CAAC,SAAS,2BAA2B,EACrC,OAAO,SAAS,KAAK,GAAG,YAAY,GAAG,MAAM,GAAG,KAAK,EACrD,CAAC,SAAS,YAAY,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,IAEzC,QAAQ,CAAC,CAAC,CAAC,GACX,IAAI,CACJ,QAAQ,CAAC,CAAC,EAAE,OAAO,CAAC,EACpB,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,CACnB,GACC;QACA,QAAQ,CAAC,KAAK,EAAE,CAAC,SAAS;YAAE,SAAS,CAAC,EAAE,GAAG,CAAA;SAAE,GAAG,CAAC,CAAC,WAAW,CAAC,GAC1D,CAAC,SAAS,oBAAoB,GAAG,qBAAqB,CAAC,CAAC,CAAC,GACzD,KAAK,CAAC;QAEV,QAAQ,CAAC,GAAG,EAAE,CAAC,KAAK,SAAS,WAAW,CAAC,CAAC,CAAC,EACzC,IAAI,EAAE,KAAK,GAAG,MAAM,KACjB,IAAI,CAAC,QAAQ,CAChB,KAAK,EACL,OAAO,EACP,YAAY,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAC1B,CAAC;KACH,GAEC,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,IAAI,GAAG,EAAE,GACjC,MAAM,SAAS,OAAO,GAAG;QAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAClD,EAAE,CAAC,CAAC;CACX;AAGD,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,oBAAoB,IAAI,CAAC,SACjE,KAAK,GAAG,YAAY,GAClB,KAAK,CAAC;AAGV,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,OAAO,IAAI,cAAc,CAAC,CAAC,CAAC,SACjE,KAAK,GAAG,KAAK,GACX,MAAM,CAAC;AAGX,MAAM,MAAM,cAAc,CACxB,CAAC,SAAS,OAAO,EACjB,CAAC,SAAS,oBAAoB,GAAG,oBAAoB,CAAC,OAAO,IAC3D,mBAAmB,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PageResult.d.ts","sourceRoot":"","sources":["../../src/PageResult.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"PageResult.d.ts","sourceRoot":"","sources":["../../src/PageResult.ts"],"names":[],"mappings":"AAgBA,MAAM,WAAW,UAAU,CAAC,CAAC;IAC3B,IAAI,EAAE,CAAC,EAAE,CAAC;IACV,aAAa,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,UAAU,EAAE,MAAM,CAAC;CACpB"}
|
|
@@ -1,6 +1,5 @@
|
|
|
1
|
-
import type { DefaultToFalse } from "../definitions/LinkDefinitions.js";
|
|
2
1
|
import type { ObjectOrInterfaceDefinition, PropertyKeys } from "../ontology/ObjectOrInterface.js";
|
|
3
|
-
import type { IsNever, Osdk } from "../OsdkObjectFrom.js";
|
|
2
|
+
import type { ExtractOptions, IsNever, Osdk } from "../OsdkObjectFrom.js";
|
|
4
3
|
import type { PageResult } from "../PageResult.js";
|
|
5
4
|
import type { NullabilityAdherence } from "./FetchPageArgs.js";
|
|
6
5
|
/** exposed for a test */
|
|
@@ -9,7 +8,13 @@ export type RespectNullability<S extends NullabilityAdherence> = S extends false
|
|
|
9
8
|
export type UnionIfFalse<S extends string, JUST_S_IF_TRUE extends boolean, E> = IsNever<S> extends true ? never : JUST_S_IF_TRUE extends true ? S : S | E;
|
|
10
9
|
/** exposed for a test */
|
|
11
10
|
export type UnionIfTrue<S extends string, UNION_IF_TRUE extends boolean, E extends string> = IsNever<S> extends true ? never : UNION_IF_TRUE extends true ? S | E : S;
|
|
12
|
-
|
|
13
|
-
|
|
11
|
+
/**
|
|
12
|
+
* Helper type for converting fetch options into an Osdk object
|
|
13
|
+
*/
|
|
14
|
+
export type FetchPageResult<Q extends ObjectOrInterfaceDefinition, L extends PropertyKeys<Q>, R extends boolean, S extends NullabilityAdherence> = PageResult<PropertyKeys<Q> extends L ? Osdk.Instance<Q, ExtractOptions<R, S>> : Osdk.Instance<Q, ExtractOptions<R, S>, L>>;
|
|
15
|
+
/**
|
|
16
|
+
* Helper type for converting fetch options into an Osdk object
|
|
17
|
+
*/
|
|
18
|
+
export type SingleOsdkResult<Q extends ObjectOrInterfaceDefinition, L extends PropertyKeys<Q>, R extends boolean, S extends NullabilityAdherence> = Osdk.Instance<Q, ExtractOptions<R, S>, L>;
|
|
14
19
|
export type IsAny<T> = unknown extends T ? [keyof T] extends [never] ? false : true : false;
|
|
15
20
|
//# sourceMappingURL=FetchPageResult.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"FetchPageResult.d.ts","sourceRoot":"","sources":["../../../src/object/FetchPageResult.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"FetchPageResult.d.ts","sourceRoot":"","sources":["../../../src/object/FetchPageResult.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EACV,2BAA2B,EAC3B,YAAY,EACb,MAAM,kCAAkC,CAAC;AAC1C,OAAO,KAAK,EAAE,cAAc,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAC1E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAE/D,yBAAyB;AACzB,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,oBAAoB,IAAI,CAAC,SAAS,KAAK,GAC5E,KAAK,GACL,IAAI,CAAC;AAET,yBAAyB;AACzB,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,MAAM,EAAE,cAAc,SAAS,OAAO,EAAE,CAAC,IAC1E,OAAO,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,KAAK,GAC3B,cAAc,SAAS,IAAI,GAAG,CAAC,GAC/B,CAAC,GAAG,CAAC,CAAC;AAEZ,yBAAyB;AACzB,MAAM,MAAM,WAAW,CACrB,CAAC,SAAS,MAAM,EAChB,aAAa,SAAS,OAAO,EAC7B,CAAC,SAAS,MAAM,IACd,OAAO,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,KAAK,GAC/B,aAAa,SAAS,IAAI,GAAG,CAAC,GAAG,CAAC,GAClC,CAAC,CAAC;AAEN;;GAEG;AACH,MAAM,MAAM,eAAe,CACzB,CAAC,SAAS,2BAA2B,EACrC,CAAC,SAAS,YAAY,CAAC,CAAC,CAAC,EACzB,CAAC,SAAS,OAAO,EACjB,CAAC,SAAS,oBAAoB,IAC5B,UAAU,CACZ,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAC9D,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAC9C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,CAC1B,CAAC,SAAS,2BAA2B,EACrC,CAAC,SAAS,YAAY,CAAC,CAAC,CAAC,EACzB,CAAC,SAAS,OAAO,EACjB,CAAC,SAAS,oBAAoB,IAC5B,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAE9C,MAAM,MAAM,KAAK,CAAC,CAAC,IAAI,OAAO,SAAS,CAAC,GACpC,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,KAAK,GAAG,IAAI,GACxC,KAAK,CAAC"}
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
import type { ObjectOrInterfaceDefinition } from "../ontology/ObjectOrInterface.js";
|
|
2
|
-
import type {
|
|
2
|
+
import type { Osdk } from "../OsdkObjectFrom.js";
|
|
3
3
|
export interface EXPERIMENTAL_ObjectSetListener<O extends ObjectOrInterfaceDefinition> {
|
|
4
4
|
/**
|
|
5
5
|
* Specific objects have changed and can be immediately updated
|
|
6
6
|
*/
|
|
7
|
-
onChange?: (objects: Array<
|
|
7
|
+
onChange?: (objects: Array<Osdk.Instance<O>>) => void;
|
|
8
8
|
/**
|
|
9
9
|
* The ObjectSet has become outdated and should be re-fetched in its entirety.
|
|
10
10
|
* This is also sent when the subscription is first initialized.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"EXPERIMENTAL_ObjectSetListener.d.ts","sourceRoot":"","sources":["../../../src/objectSet/EXPERIMENTAL_ObjectSetListener.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAC;AACpF,OAAO,KAAK,EAAE,
|
|
1
|
+
{"version":3,"file":"EXPERIMENTAL_ObjectSetListener.d.ts","sourceRoot":"","sources":["../../../src/objectSet/EXPERIMENTAL_ObjectSetListener.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAC;AACpF,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAEjD,MAAM,WAAW,8BAA8B,CAC7C,CAAC,SAAS,2BAA2B;IAErC;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;IAEtD;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,IAAI,CAAC;IAEzB;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;CACpC"}
|
|
@@ -3,12 +3,14 @@ import type { AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy } f
|
|
|
3
3
|
import type { AggregationsResults } from "../aggregate/AggregationsResults.js";
|
|
4
4
|
import type { WhereClause } from "../aggregate/WhereClause.js";
|
|
5
5
|
import type { AsyncIterArgs, Augments, FetchPageArgs, NullabilityAdherence, SelectArg } from "../object/FetchPageArgs.js";
|
|
6
|
-
import type {
|
|
6
|
+
import type { SingleOsdkResult } from "../object/FetchPageResult.js";
|
|
7
7
|
import type { Result } from "../object/Result.js";
|
|
8
8
|
import type { InterfaceDefinition } from "../ontology/InterfaceDefinition.js";
|
|
9
9
|
import type { ObjectOrInterfaceDefinition, PropertyKeys } from "../ontology/ObjectOrInterface.js";
|
|
10
10
|
import type { CompileTimeMetadata, ObjectTypeDefinition } from "../ontology/ObjectTypeDefinition.js";
|
|
11
11
|
import type { PrimaryKeyType } from "../OsdkBase.js";
|
|
12
|
+
import type { ExtractOptions, Osdk } from "../OsdkObjectFrom.js";
|
|
13
|
+
import type { PageResult } from "../PageResult.js";
|
|
12
14
|
import type { __EXPERIMENTAL__NOT_SUPPORTED_YET_subscribe, EXPERIMENTAL_ObjectSetListener } from "../public/unstable.js";
|
|
13
15
|
import type { LinkedType, LinkNames } from "../util/LinkUtils.js";
|
|
14
16
|
import type { BaseObjectSet } from "./BaseObjectSet.js";
|
|
@@ -25,7 +27,7 @@ export interface MinimalObjectSet<Q extends ObjectOrInterfaceDefinition> extends
|
|
|
25
27
|
|
|
26
28
|
* @returns a page of objects
|
|
27
29
|
*/
|
|
28
|
-
readonly fetchPage: <L extends PropertyKeys<Q>, R extends boolean, const A extends Augments, S extends NullabilityAdherence = NullabilityAdherence.Default>(args?: FetchPageArgs<Q, L, R, A, S>) => Promise<
|
|
30
|
+
readonly fetchPage: <L extends PropertyKeys<Q>, R extends boolean, const A extends Augments, S extends NullabilityAdherence = NullabilityAdherence.Default>(args?: FetchPageArgs<Q, L, R, A, S>) => Promise<PageResult<PropertyKeys<Q> extends L ? Osdk.Instance<Q, ExtractOptions<R, S>> : Osdk.Instance<Q, ExtractOptions<R, S>, L>>>;
|
|
29
31
|
/**
|
|
30
32
|
* Gets a page of objects of this type, with a result wrapper
|
|
31
33
|
* @param args - Args to specify next page token and page size, if applicable
|
|
@@ -40,7 +42,7 @@ export interface MinimalObjectSet<Q extends ObjectOrInterfaceDefinition> extends
|
|
|
40
42
|
}
|
|
41
43
|
* @returns a page of objects, wrapped in a result wrapper
|
|
42
44
|
*/
|
|
43
|
-
readonly fetchPageWithErrors: <L extends PropertyKeys<Q>, R extends boolean, const A extends Augments, S extends NullabilityAdherence = NullabilityAdherence.Default>(args?: FetchPageArgs<Q, L, R, A, S>) => Promise<Result<
|
|
45
|
+
readonly fetchPageWithErrors: <L extends PropertyKeys<Q>, R extends boolean, const A extends Augments, S extends NullabilityAdherence = NullabilityAdherence.Default>(args?: FetchPageArgs<Q, L, R, A, S>) => Promise<Result<PageResult<Osdk.Instance<Q, ExtractOptions<R, S>, L>>>>;
|
|
44
46
|
/**
|
|
45
47
|
* Allows you to filter an object set with a given clause
|
|
46
48
|
* @param clause - Takes a filter clause
|
|
@@ -128,11 +130,11 @@ export interface ObjectSet<Q extends ObjectOrInterfaceDefinition = any, _UNUSED
|
|
|
128
130
|
/**
|
|
129
131
|
* Fetches one object with the specified primary key, without a result wrapper
|
|
130
132
|
*/
|
|
131
|
-
readonly fetchOne: Q extends ObjectTypeDefinition ? <const L extends PropertyKeys<Q>, const R extends boolean, const S extends false | "throw" = NullabilityAdherence.Default>(primaryKey: PrimaryKeyType<Q>, options?: SelectArg<Q, L, R, S>) => Promise<
|
|
133
|
+
readonly fetchOne: Q extends ObjectTypeDefinition ? <const L extends PropertyKeys<Q>, const R extends boolean, const S extends false | "throw" = NullabilityAdherence.Default>(primaryKey: PrimaryKeyType<Q>, options?: SelectArg<Q, L, R, S>) => Promise<Osdk.Instance<Q, ExtractOptions<R, S>, L>> : never;
|
|
132
134
|
/**
|
|
133
135
|
* Fetches one object with the specified primary key, with a result wrapper
|
|
134
136
|
*/
|
|
135
|
-
readonly fetchOneWithErrors: Q extends ObjectTypeDefinition ? <L extends PropertyKeys<Q>, R extends boolean, S extends false | "throw" = NullabilityAdherence.Default>(primaryKey: PrimaryKeyType<Q>, options?: SelectArg<Q, L, R, S>) => Promise<Result<
|
|
137
|
+
readonly fetchOneWithErrors: Q extends ObjectTypeDefinition ? <L extends PropertyKeys<Q>, R extends boolean, S extends false | "throw" = NullabilityAdherence.Default>(primaryKey: PrimaryKeyType<Q>, options?: SelectArg<Q, L, R, S>) => Promise<Result<Osdk.Instance<Q, ExtractOptions<R, S>, L>>> : never;
|
|
136
138
|
/**
|
|
137
139
|
* WARNING. THIS METHOD IS EXPERIMENTAL AND NOT SUPPORTED YET.
|
|
138
140
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ObjectSet.d.ts","sourceRoot":"","sources":["../../../src/objectSet/ObjectSet.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,KAAK,EAAE,8DAA8D,EAAE,MAAM,yCAAyC,CAAC;AAC9H,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAC;AAC/E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,KAAK,EACV,aAAa,EACb,QAAQ,EACR,aAAa,EACb,oBAAoB,EACpB,SAAS,EACV,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"ObjectSet.d.ts","sourceRoot":"","sources":["../../../src/objectSet/ObjectSet.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,KAAK,EAAE,8DAA8D,EAAE,MAAM,yCAAyC,CAAC;AAC9H,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAC;AAC/E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,KAAK,EACV,aAAa,EACb,QAAQ,EACR,aAAa,EACb,oBAAoB,EACpB,SAAS,EACV,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AACrE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AAC9E,OAAO,KAAK,EACV,2BAA2B,EAC3B,YAAY,EACb,MAAM,kCAAkC,CAAC;AAC1C,OAAO,KAAK,EACV,mBAAmB,EACnB,oBAAoB,EACrB,MAAM,qCAAqC,CAAC;AAC7C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AACjE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,KAAK,EACV,2CAA2C,EAC3C,8BAA8B,EAC/B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAClE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAExD,MAAM,WAAW,gBAAgB,CAAC,CAAC,SAAS,2BAA2B,CACrE,SAAQ,aAAa,CAAC,CAAC,CAAC;IAExB;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,SAAS,EAAE,CAClB,CAAC,SAAS,YAAY,CAAC,CAAC,CAAC,EACzB,CAAC,SAAS,OAAO,EACjB,KAAK,CAAC,CAAC,SAAS,QAAQ,EACxB,CAAC,SAAS,oBAAoB,GAAG,oBAAoB,CAAC,OAAO,EAE7D,IAAI,CAAC,EAAE,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAChC,OAAO,CACV,UAAU,CACR,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAC9D,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAC9C,CACF,CAAC;IAEF;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,mBAAmB,EAAE,CAC5B,CAAC,SAAS,YAAY,CAAC,CAAC,CAAC,EACzB,CAAC,SAAS,OAAO,EACjB,KAAK,CAAC,CAAC,SAAS,QAAQ,EACxB,CAAC,SAAS,oBAAoB,GAAG,oBAAoB,CAAC,OAAO,EAE7D,IAAI,CAAC,EAAE,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAChC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAE5E;;;;;;;;;OASG;IACH,QAAQ,CAAC,KAAK,EAAE,CACd,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,KACnB,IAAI,CAAC;IAEV;;;;;;;OAOG;IACH,QAAQ,CAAC,SAAS,EAAE,CAClB,CAAC,SAAS,YAAY,CAAC,CAAC,CAAC,EACzB,CAAC,SAAS,OAAO,EACjB,KAAK,CAAC,CAAC,SAAS,QAAQ,EACxB,CAAC,SAAS,oBAAoB,GAAG,oBAAoB,CAAC,OAAO,EAE7D,IAAI,CAAC,EAAE,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAChC,qBAAqB,CAAC,gBAAgB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;CAC1D;AAED,MAAM,WAAW,kBAAkB,CACjC,CAAC,SAAS,mBAAmB,CAC7B,SAAQ,gBAAgB,CAAC,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,SAAS,CACxB,CAAC,SAAS,2BAA2B,GAAG,GAAG,EAC3C,OAAO,GAAG,GAAG,CACb,SAAQ,gBAAgB,CAAC,CAAC,CAAC;IAC3B;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,QAAQ,CAAC,SAAS,EAAE,CAAC,EAAE,SAAS,aAAa,CAAC,CAAC,CAAC,EAC9C,GAAG,EAAE,8DAA8D,CAAC,CAAC,EAAE,EAAE,CAAC,KACvE,OAAO,CAAC,mBAAmB,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IAEzC;;;;;;;;OAQG;IACH,QAAQ,CAAC,KAAK,EAAE,CACd,GAAG,UAAU,EAAE,aAAa,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,KAC9D,IAAI,CAAC;IAEV;;;;;;;;OAQG;IACH,QAAQ,CAAC,SAAS,EAAE,CAClB,GAAG,UAAU,EAAE,aAAa,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,KAC9D,IAAI,CAAC;IAEV;;;;;;;;OAQG;IACH,QAAQ,CAAC,QAAQ,EAAE,CACjB,GAAG,UAAU,EAAE,aAAa,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,KAC9D,IAAI,CAAC;IAEV;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC,SAAS,SAAS,CAAC,CAAC,CAAC,EACvC,IAAI,EAAE,CAAC,KACJ,mBAAmB,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC;IAExD;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,CAAC,SAAS,oBAAoB,GAAG,CAChD,KAAK,CAAC,CAAC,SAAS,YAAY,CAAC,CAAC,CAAC,EAC/B,KAAK,CAAC,CAAC,SAAS,OAAO,EACvB,KAAK,CAAC,CAAC,SAAS,KAAK,GAAG,OAAO,GAAG,oBAAoB,CAAC,OAAO,EAE9D,UAAU,EAAE,cAAc,CAAC,CAAC,CAAC,EAC7B,OAAO,CAAC,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAC5B,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GACrD,KAAK,CAAC;IAEV;;OAEG;IACH,QAAQ,CAAC,kBAAkB,EAAE,CAAC,SAAS,oBAAoB,GAAG,CAC1D,CAAC,SAAS,YAAY,CAAC,CAAC,CAAC,EACzB,CAAC,SAAS,OAAO,EACjB,CAAC,SAAS,KAAK,GAAG,OAAO,GAAG,oBAAoB,CAAC,OAAO,EAExD,UAAU,EAAE,cAAc,CAAC,CAAC,CAAC,EAC7B,OAAO,CAAC,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAC5B,OAAO,CACV,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAClD,GACC,KAAK,CAAC;IAEV;;;;;;OAMG;IACH,QAAQ,CAAC,CAAC,2CAA2C,CAAC,EAAE,CACtD,QAAQ,EAAE,8BAA8B,CAAC,CAAC,CAAC,KACxC,MAAM,OAAO,CAAC;CACpB"}
|