@osdk/api 2.1.0-beta.2 → 2.1.0-beta.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 CHANGED
@@ -1,5 +1,12 @@
1
1
  # @osdk/api
2
2
 
3
+ ## 2.1.0-beta.3
4
+
5
+ ### Minor Changes
6
+
7
+ - 05febf4: Adds Reference Update support in subscribe
8
+ - b79becf: Modify return type for fetch single on links.
9
+
3
10
  ## 2.1.0-beta.2
4
11
 
5
12
  ## 2.1.0-beta.1
@@ -1,9 +1,9 @@
1
- import type { SelectArg, SelectArgToKeys } from "../object/FetchPageArgs.js";
1
+ import type { FetchPageArgs, SelectArg } from "../object/FetchPageArgs.js";
2
2
  import type { Result } from "../object/Result.js";
3
3
  import type { ObjectSet } from "../objectSet/ObjectSet.js";
4
4
  import type { PropertyKeys } from "../ontology/ObjectOrInterface.js";
5
5
  import type { CompileTimeMetadata, ObjectMetadata, ObjectTypeDefinition, ObjectTypeLinkKeysFrom2 } from "../ontology/ObjectTypeDefinition.js";
6
- import type { Osdk } from "../OsdkObjectFrom.js";
6
+ import type { ExtractOptions, Osdk } from "../OsdkObjectFrom.js";
7
7
  /** The $link container to get from one object type to its linked objects */
8
8
  export type OsdkObjectLinksObject<O extends ObjectTypeDefinition> = ObjectTypeLinkKeysFrom2<O> extends never ? never : {
9
9
  readonly [L in ObjectTypeLinkKeysFrom2<O>]: OsdkObjectLinksEntry<O, L>;
@@ -13,9 +13,9 @@ export type DefaultToFalse<B extends boolean | undefined> = false extends B ? fa
13
13
  export interface SingleLinkAccessor<T extends ObjectTypeDefinition> {
14
14
  /** Load the linked object
15
15
  */
16
- fetchOne: <const A extends SelectArg<T, PropertyKeys<T>, boolean>>(options?: A) => Promise<DefaultToFalse<A["$includeRid"]> extends false ? Osdk<T, SelectArgToKeys<T, A>> : Osdk<T, SelectArgToKeys<T, A> | "$rid">>;
16
+ fetchOne: <const A extends SelectArg<T, PropertyKeys<T>, boolean>>(options?: A) => Promise<A extends FetchPageArgs<T, infer L, infer R, any, infer S> ? Osdk.Instance<T, ExtractOptions<R, S>, L> : Osdk.Instance<T>>;
17
17
  /** Load the linked object, with a result wrapper
18
18
  */
19
- fetchOneWithErrors: <const A extends SelectArg<T, PropertyKeys<T>, boolean>>(options?: A) => Promise<Result<DefaultToFalse<A["$includeRid"]> extends false ? Osdk<T, SelectArgToKeys<T, A>> : Osdk<T, SelectArgToKeys<T, A> | "$rid">>>;
19
+ fetchOneWithErrors: <const A extends SelectArg<T, PropertyKeys<T>, boolean>>(options?: A) => Promise<Result<A extends FetchPageArgs<T, infer L, infer R, any, infer S> ? Osdk.Instance<T, ExtractOptions<R, S>, L> : Osdk.Instance<T>>>;
20
20
  }
21
21
  //# sourceMappingURL=LinkDefinitions.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"LinkDefinitions.d.ts","sourceRoot":"","sources":["../../../src/definitions/LinkDefinitions.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAC7E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,KAAK,EACV,mBAAmB,EACnB,cAAc,EACd,oBAAoB,EACpB,uBAAuB,EACxB,MAAM,qCAAqC,CAAC;AAC7C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAEjD,4EAA4E;AAC5E,MAAM,MAAM,qBAAqB,CAC/B,CAAC,SAAS,oBAAoB,IAC5B,uBAAuB,CAAC,CAAC,CAAC,SAAS,KAAK,GAAG,KAAK,GAAG;IACrD,QAAQ,EAAE,CAAC,IAAI,uBAAuB,CAAC,CAAC,CAAC,GAAG,oBAAoB,CAAC,CAAC,EAAE,CAAC,CAAC;CACvE,CAAC;AAEF,MAAM,MAAM,oBAAoB,CAC9B,CAAC,SAAS,oBAAoB,EAC9B,CAAC,SAAS,uBAAuB,CAAC,CAAC,CAAC,IAClC,mBAAmB,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SACpC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,CACtC,CAAC,SAAS,KAAK,GAAG,kBAAkB,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CACvD,GACC,KAAK,CAAC;AAEV,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,OAAO,GAAG,SAAS,IAAI,KAAK,SAAS,CAAC,GACvE,KAAK,GACL,SAAS,SAAS,CAAC,GAAG,KAAK,GAC3B,IAAI,CAAC;AAET,MAAM,WAAW,kBAAkB,CACjC,CAAC,SAAS,oBAAoB;IAE9B;OACG;IACH,QAAQ,EAAE,CACR,KAAK,CAAC,CAAC,SAAS,SAAS,CACvB,CAAC,EACD,YAAY,CAAC,CAAC,CAAC,EACf,OAAO,CACR,EAED,OAAO,CAAC,EAAE,CAAC,KACR,OAAO,CACV,cAAc,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,SAAS,KAAK,GAC1C,IAAI,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAC9B,IAAI,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,CAC5C,CAAC;IAEF;OACG;IACH,kBAAkB,EAAE,CAClB,KAAK,CAAC,CAAC,SAAS,SAAS,CACvB,CAAC,EACD,YAAY,CAAC,CAAC,CAAC,EACf,OAAO,CACR,EAED,OAAO,CAAC,EAAE,CAAC,KACR,OAAO,CACV,MAAM,CACJ,cAAc,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,SAAS,KAAK,GAC1C,IAAI,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAC9B,IAAI,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,CAC5C,CACF,CAAC;CACH"}
1
+ {"version":3,"file":"LinkDefinitions.d.ts","sourceRoot":"","sources":["../../../src/definitions/LinkDefinitions.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EACV,aAAa,EACb,SAAS,EAEV,MAAM,4BAA4B,CAAC;AAEpC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,KAAK,EACV,mBAAmB,EACnB,cAAc,EACd,oBAAoB,EACpB,uBAAuB,EACxB,MAAM,qCAAqC,CAAC;AAC7C,OAAO,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAEjE,4EAA4E;AAC5E,MAAM,MAAM,qBAAqB,CAC/B,CAAC,SAAS,oBAAoB,IAC5B,uBAAuB,CAAC,CAAC,CAAC,SAAS,KAAK,GAAG,KAAK,GAAG;IACrD,QAAQ,EAAE,CAAC,IAAI,uBAAuB,CAAC,CAAC,CAAC,GAAG,oBAAoB,CAAC,CAAC,EAAE,CAAC,CAAC;CACvE,CAAC;AAEF,MAAM,MAAM,oBAAoB,CAC9B,CAAC,SAAS,oBAAoB,EAC9B,CAAC,SAAS,uBAAuB,CAAC,CAAC,CAAC,IAClC,mBAAmB,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SACpC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,CACtC,CAAC,SAAS,KAAK,GAAG,kBAAkB,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CACvD,GACC,KAAK,CAAC;AAEV,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,OAAO,GAAG,SAAS,IAAI,KAAK,SAAS,CAAC,GACvE,KAAK,GACL,SAAS,SAAS,CAAC,GAAG,KAAK,GAC3B,IAAI,CAAC;AAET,MAAM,WAAW,kBAAkB,CACjC,CAAC,SAAS,oBAAoB;IAE9B;OACG;IACH,QAAQ,EAAE,CACR,KAAK,CAAC,CAAC,SAAS,SAAS,CACvB,CAAC,EACD,YAAY,CAAC,CAAC,CAAC,EACf,OAAO,CACR,EAED,OAAO,CAAC,EAAE,CAAC,KACR,OAAO,CACV,CAAC,SAAS,aAAa,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC,GACtD,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,GACzC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CACrB,CAAC;IAEF;OACG;IACH,kBAAkB,EAAE,CAClB,KAAK,CAAC,CAAC,SAAS,SAAS,CACvB,CAAC,EACD,YAAY,CAAC,CAAC,CAAC,EACf,OAAO,CACR,EAED,OAAO,CAAC,EAAE,CAAC,KACR,OAAO,CACV,MAAM,CACJ,CAAC,SAAS,aAAa,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC,GACtD,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,GACzC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CACrB,CACF,CAAC;CACH"}
@@ -1,9 +1,9 @@
1
- import type { SelectArg, SelectArgToKeys } from "../object/FetchPageArgs.js";
1
+ import type { FetchPageArgs, SelectArg } from "../object/FetchPageArgs.js";
2
2
  import type { Result } from "../object/Result.js";
3
3
  import type { ObjectSet } from "../objectSet/ObjectSet.js";
4
4
  import type { PropertyKeys } from "../ontology/ObjectOrInterface.js";
5
5
  import type { CompileTimeMetadata, ObjectMetadata, ObjectTypeDefinition, ObjectTypeLinkKeysFrom2 } from "../ontology/ObjectTypeDefinition.js";
6
- import type { Osdk } from "../OsdkObjectFrom.js";
6
+ import type { ExtractOptions, Osdk } from "../OsdkObjectFrom.js";
7
7
  /** The $link container to get from one object type to its linked objects */
8
8
  export type OsdkObjectLinksObject<O extends ObjectTypeDefinition> = ObjectTypeLinkKeysFrom2<O> extends never ? never : {
9
9
  readonly [L in ObjectTypeLinkKeysFrom2<O>]: OsdkObjectLinksEntry<O, L>;
@@ -13,9 +13,9 @@ export type DefaultToFalse<B extends boolean | undefined> = false extends B ? fa
13
13
  export interface SingleLinkAccessor<T extends ObjectTypeDefinition> {
14
14
  /** Load the linked object
15
15
  */
16
- fetchOne: <const A extends SelectArg<T, PropertyKeys<T>, boolean>>(options?: A) => Promise<DefaultToFalse<A["$includeRid"]> extends false ? Osdk<T, SelectArgToKeys<T, A>> : Osdk<T, SelectArgToKeys<T, A> | "$rid">>;
16
+ fetchOne: <const A extends SelectArg<T, PropertyKeys<T>, boolean>>(options?: A) => Promise<A extends FetchPageArgs<T, infer L, infer R, any, infer S> ? Osdk.Instance<T, ExtractOptions<R, S>, L> : Osdk.Instance<T>>;
17
17
  /** Load the linked object, with a result wrapper
18
18
  */
19
- fetchOneWithErrors: <const A extends SelectArg<T, PropertyKeys<T>, boolean>>(options?: A) => Promise<Result<DefaultToFalse<A["$includeRid"]> extends false ? Osdk<T, SelectArgToKeys<T, A>> : Osdk<T, SelectArgToKeys<T, A> | "$rid">>>;
19
+ fetchOneWithErrors: <const A extends SelectArg<T, PropertyKeys<T>, boolean>>(options?: A) => Promise<Result<A extends FetchPageArgs<T, infer L, infer R, any, infer S> ? Osdk.Instance<T, ExtractOptions<R, S>, L> : Osdk.Instance<T>>>;
20
20
  }
21
21
  //# sourceMappingURL=LinkDefinitions.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"LinkDefinitions.d.ts","sourceRoot":"","sources":["../../../src/definitions/LinkDefinitions.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAC7E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,KAAK,EACV,mBAAmB,EACnB,cAAc,EACd,oBAAoB,EACpB,uBAAuB,EACxB,MAAM,qCAAqC,CAAC;AAC7C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAEjD,4EAA4E;AAC5E,MAAM,MAAM,qBAAqB,CAC/B,CAAC,SAAS,oBAAoB,IAC5B,uBAAuB,CAAC,CAAC,CAAC,SAAS,KAAK,GAAG,KAAK,GAAG;IACrD,QAAQ,EAAE,CAAC,IAAI,uBAAuB,CAAC,CAAC,CAAC,GAAG,oBAAoB,CAAC,CAAC,EAAE,CAAC,CAAC;CACvE,CAAC;AAEF,MAAM,MAAM,oBAAoB,CAC9B,CAAC,SAAS,oBAAoB,EAC9B,CAAC,SAAS,uBAAuB,CAAC,CAAC,CAAC,IAClC,mBAAmB,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SACpC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,CACtC,CAAC,SAAS,KAAK,GAAG,kBAAkB,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CACvD,GACC,KAAK,CAAC;AAEV,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,OAAO,GAAG,SAAS,IAAI,KAAK,SAAS,CAAC,GACvE,KAAK,GACL,SAAS,SAAS,CAAC,GAAG,KAAK,GAC3B,IAAI,CAAC;AAET,MAAM,WAAW,kBAAkB,CACjC,CAAC,SAAS,oBAAoB;IAE9B;OACG;IACH,QAAQ,EAAE,CACR,KAAK,CAAC,CAAC,SAAS,SAAS,CACvB,CAAC,EACD,YAAY,CAAC,CAAC,CAAC,EACf,OAAO,CACR,EAED,OAAO,CAAC,EAAE,CAAC,KACR,OAAO,CACV,cAAc,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,SAAS,KAAK,GAC1C,IAAI,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAC9B,IAAI,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,CAC5C,CAAC;IAEF;OACG;IACH,kBAAkB,EAAE,CAClB,KAAK,CAAC,CAAC,SAAS,SAAS,CACvB,CAAC,EACD,YAAY,CAAC,CAAC,CAAC,EACf,OAAO,CACR,EAED,OAAO,CAAC,EAAE,CAAC,KACR,OAAO,CACV,MAAM,CACJ,cAAc,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,SAAS,KAAK,GAC1C,IAAI,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAC9B,IAAI,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,CAC5C,CACF,CAAC;CACH"}
1
+ {"version":3,"file":"LinkDefinitions.d.ts","sourceRoot":"","sources":["../../../src/definitions/LinkDefinitions.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EACV,aAAa,EACb,SAAS,EAEV,MAAM,4BAA4B,CAAC;AAEpC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,KAAK,EACV,mBAAmB,EACnB,cAAc,EACd,oBAAoB,EACpB,uBAAuB,EACxB,MAAM,qCAAqC,CAAC;AAC7C,OAAO,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAEjE,4EAA4E;AAC5E,MAAM,MAAM,qBAAqB,CAC/B,CAAC,SAAS,oBAAoB,IAC5B,uBAAuB,CAAC,CAAC,CAAC,SAAS,KAAK,GAAG,KAAK,GAAG;IACrD,QAAQ,EAAE,CAAC,IAAI,uBAAuB,CAAC,CAAC,CAAC,GAAG,oBAAoB,CAAC,CAAC,EAAE,CAAC,CAAC;CACvE,CAAC;AAEF,MAAM,MAAM,oBAAoB,CAC9B,CAAC,SAAS,oBAAoB,EAC9B,CAAC,SAAS,uBAAuB,CAAC,CAAC,CAAC,IAClC,mBAAmB,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SACpC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,CACtC,CAAC,SAAS,KAAK,GAAG,kBAAkB,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CACvD,GACC,KAAK,CAAC;AAEV,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,OAAO,GAAG,SAAS,IAAI,KAAK,SAAS,CAAC,GACvE,KAAK,GACL,SAAS,SAAS,CAAC,GAAG,KAAK,GAC3B,IAAI,CAAC;AAET,MAAM,WAAW,kBAAkB,CACjC,CAAC,SAAS,oBAAoB;IAE9B;OACG;IACH,QAAQ,EAAE,CACR,KAAK,CAAC,CAAC,SAAS,SAAS,CACvB,CAAC,EACD,YAAY,CAAC,CAAC,CAAC,EACf,OAAO,CACR,EAED,OAAO,CAAC,EAAE,CAAC,KACR,OAAO,CACV,CAAC,SAAS,aAAa,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC,GACtD,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,GACzC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CACrB,CAAC;IAEF;OACG;IACH,kBAAkB,EAAE,CAClB,KAAK,CAAC,CAAC,SAAS,SAAS,CACvB,CAAC,EACD,YAAY,CAAC,CAAC,CAAC,EACf,OAAO,CACR,EAED,OAAO,CAAC,EAAE,CAAC,KACR,OAAO,CACV,MAAM,CACJ,CAAC,SAAS,aAAa,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC,GACtD,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,GACzC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CACrB,CACF,CAAC;CACH"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@osdk/api",
3
- "version": "2.1.0-beta.2",
3
+ "version": "2.1.0-beta.3",
4
4
  "description": "",
5
5
  "access": "public",
6
6
  "license": "Apache-2.0",
@@ -29,9 +29,9 @@
29
29
  "@microsoft/api-extractor": "^7.47.0",
30
30
  "ts-expect": "^1.3.0",
31
31
  "typescript": "^5.5.4",
32
+ "@osdk/monorepo.tsconfig": "~0.0.0",
32
33
  "@osdk/monorepo.api-extractor": "~0.0.0",
33
- "@osdk/monorepo.tsup": "~0.0.0",
34
- "@osdk/monorepo.tsconfig": "~0.0.0"
34
+ "@osdk/monorepo.tsup": "~0.0.0"
35
35
  },
36
36
  "publishConfig": {
37
37
  "access": "public"