@osdk/api 2.0.0-beta.11 → 2.0.0-beta.13

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,20 @@
1
1
  # @osdk/api
2
2
 
3
+ ## 2.0.0-beta.13
4
+
5
+ ### Minor Changes
6
+
7
+ - 1488144: Renamed definition types to metadata
8
+ - c28792e: Modified return type of fetchMetadata to return Object/Interface Definitions
9
+ - 26ee3bd: Updates return types of fetchMetadata to be Action and Query Definitions
10
+ - 6ab5d2e: Renamed Min_Definition to \_Definition
11
+
12
+ ### Patch Changes
13
+
14
+ - @osdk/shared.net@2.0.0-beta.4
15
+
16
+ ## 2.0.0-beta.12
17
+
3
18
  ## 2.0.0-beta.11
4
19
 
5
20
  ## 2.0.0-beta.10
@@ -1,10 +1,10 @@
1
- export type { ActionDefinition, ActionModifiedEntity, ActionParameterDefinition, MinActionDef, ObjectActionDataType, ObjectSetActionDataType, ValidActionParameterTypes, } from "./ontology/ActionDefinition.js";
2
- export type { InterfaceDefinition, MinInterfaceDef, } from "./ontology/InterfaceDefinition.js";
1
+ export type { ActionDefinition, ActionMetadata, ActionModifiedEntity, ActionParameterDefinition, ObjectActionDataType, ObjectSetActionDataType, ValidActionParameterTypes, } from "./ontology/ActionDefinition.js";
2
+ export type { InterfaceDefinition, InterfaceMetadata, } from "./ontology/InterfaceDefinition.js";
3
3
  export type { ObjectOrInterfaceDefinition, ObjectOrInterfacePropertyKeysFrom2, PropertyKeys, } from "./ontology/ObjectOrInterface.js";
4
- export type { BrandedApiName, CompileTimeMetadata, MinObjectDef, ObjectTypeDefinition, ObjectTypeLinkDefinition, ObjectTypeLinkKeysFrom2, ObjectTypePropertyDefinition, ObjectTypePropertyDefinitionFrom2, PropertyDef, VersionBound, } from "./ontology/ObjectTypeDefinition.js";
4
+ export type { BrandedApiName, CompileTimeMetadata, ObjectMetadata, ObjectTypeDefinition, ObjectTypeLinkDefinition, ObjectTypeLinkKeysFrom2, ObjectTypePropertyDefinition, ObjectTypePropertyDefinitionFrom2, PropertyDef, VersionBound, } from "./ontology/ObjectTypeDefinition.js";
5
5
  export type { OntologyMetadata } from "./ontology/OntologyMetadata.js";
6
6
  export type { PrimaryKeyTypes } from "./ontology/PrimaryKeyTypes.js";
7
- export type { AggregationKeyDataType, MinQueryDef, ObjectQueryDataType, ObjectSetQueryDataType, PrimitiveDataType, QueryDataTypeDefinition, QueryDefinition, QueryParameterDefinition, RangeAggregationKeyDataType, SetQueryDataType, SimpleAggregationKeyDataType, StructQueryDataType, ThreeDimensionalAggregationDataType, ThreeDimensionalQueryAggregationDefinition, TwoDimensionalAggregationDataType, TwoDimensionalQueryAggregationDefinition, UnionQueryDataType, } from "./ontology/QueryDefinition.js";
7
+ export type { AggregationKeyDataType, ObjectQueryDataType, ObjectSetQueryDataType, PrimitiveDataType, QueryDataTypeDefinition, QueryDefinition, QueryMetadata, QueryParameterDefinition, RangeAggregationKeyDataType, SetQueryDataType, SimpleAggregationKeyDataType, StructQueryDataType, ThreeDimensionalAggregationDataType, ThreeDimensionalQueryAggregationDefinition, TwoDimensionalAggregationDataType, TwoDimensionalQueryAggregationDefinition, UnionQueryDataType, } from "./ontology/QueryDefinition.js";
8
8
  export type { WirePropertyTypes } from "./ontology/WirePropertyTypes.js";
9
9
  export type { OsdkMetadata } from "./OsdkMetadata.js";
10
10
  export {};
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAgBA,YAAY,EACV,gBAAgB,EAChB,oBAAoB,EACpB,yBAAyB,EACzB,YAAY,EACZ,oBAAoB,EACpB,uBAAuB,EACvB,yBAAyB,GAC1B,MAAM,gCAAgC,CAAC;AACxC,YAAY,EACV,mBAAmB,EACnB,eAAe,GAChB,MAAM,mCAAmC,CAAC;AAC3C,YAAY,EACV,2BAA2B,EAC3B,kCAAkC,EAClC,YAAY,GACb,MAAM,iCAAiC,CAAC;AACzC,YAAY,EACV,cAAc,EACd,mBAAmB,EACnB,YAAY,EACZ,oBAAoB,EACpB,wBAAwB,EACxB,uBAAuB,EACvB,4BAA4B,EAC5B,iCAAiC,EACjC,WAAW,EACX,YAAY,GACb,MAAM,oCAAoC,CAAC;AAC5C,YAAY,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AACvE,YAAY,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AACrE,YAAY,EACV,sBAAsB,EACtB,WAAW,EACX,mBAAmB,EACnB,sBAAsB,EACtB,iBAAiB,EACjB,uBAAuB,EACvB,eAAe,EACf,wBAAwB,EACxB,2BAA2B,EAC3B,gBAAgB,EAChB,4BAA4B,EAC5B,mBAAmB,EACnB,mCAAmC,EACnC,0CAA0C,EAC1C,iCAAiC,EACjC,wCAAwC,EACxC,kBAAkB,GACnB,MAAM,+BAA+B,CAAC;AACvC,YAAY,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACzE,YAAY,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEtD,OAAO,EAAE,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAgBA,YAAY,EACV,gBAAgB,EAChB,cAAc,EACd,oBAAoB,EACpB,yBAAyB,EACzB,oBAAoB,EACpB,uBAAuB,EACvB,yBAAyB,GAC1B,MAAM,gCAAgC,CAAC;AACxC,YAAY,EACV,mBAAmB,EACnB,iBAAiB,GAClB,MAAM,mCAAmC,CAAC;AAC3C,YAAY,EACV,2BAA2B,EAC3B,kCAAkC,EAClC,YAAY,GACb,MAAM,iCAAiC,CAAC;AACzC,YAAY,EACV,cAAc,EACd,mBAAmB,EACnB,cAAc,EACd,oBAAoB,EACpB,wBAAwB,EACxB,uBAAuB,EACvB,4BAA4B,EAC5B,iCAAiC,EACjC,WAAW,EACX,YAAY,GACb,MAAM,oCAAoC,CAAC;AAC5C,YAAY,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AACvE,YAAY,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AACrE,YAAY,EACV,sBAAsB,EACtB,mBAAmB,EACnB,sBAAsB,EACtB,iBAAiB,EACjB,uBAAuB,EACvB,eAAe,EACf,aAAa,EACb,wBAAwB,EACxB,2BAA2B,EAC3B,gBAAgB,EAChB,4BAA4B,EAC5B,mBAAmB,EACnB,mCAAmC,EACnC,0CAA0C,EAC1C,iCAAiC,EACjC,wCAAwC,EACxC,kBAAkB,GACnB,MAAM,+BAA+B,CAAC;AACvC,YAAY,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACzE,YAAY,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEtD,OAAO,EAAE,CAAC"}
@@ -1,39 +1,41 @@
1
1
  import type { OsdkMetadata } from "../OsdkMetadata.js";
2
- import type { MinObjectDef } from "./ObjectTypeDefinition.js";
3
- export interface ActionDefinition<A extends string, K extends string> {
2
+ import type { ObjectTypeDefinition, ReleaseStatus } from "./ObjectTypeDefinition.js";
3
+ export interface ActionMetadata<A extends string, K extends string> {
4
4
  type: "action";
5
5
  apiName: A;
6
6
  description?: string;
7
7
  displayName?: string;
8
8
  parameters: Record<any, ActionParameterDefinition<K, any>>;
9
9
  modifiedEntities?: Partial<Record<K, ActionModifiedEntity>>;
10
+ status: ReleaseStatus;
11
+ rid: string;
10
12
  }
11
- export interface ActionDefMetadata<A extends string, K extends string, T> extends ActionDefinition<A, K> {
13
+ export interface ActionCompileTimeMetadata<T> {
12
14
  signatures: T;
13
15
  }
14
- export interface MinActionDef<A extends string, K extends string, T_signatures = never> {
16
+ export interface ActionDefinition<A extends string, K extends string, T_signatures = never> {
15
17
  type: "action";
16
18
  apiName: A;
17
19
  osdkMetadata?: OsdkMetadata;
18
- __DefinitionMetadata?: ActionDefMetadata<A, K, T_signatures>;
20
+ __DefinitionMetadata?: ActionCompileTimeMetadata<T_signatures> & ActionMetadata<A, K>;
19
21
  }
20
22
  export interface ActionModifiedEntity {
21
23
  created: boolean;
22
24
  modified: boolean;
23
25
  }
24
26
  export type ValidBaseActionParameterTypes = "boolean" | "string" | "integer" | "long" | "double" | "datetime" | "timestamp" | "attachment" | "marking";
25
- export interface ObjectActionDataType<K extends string, T_Target extends MinObjectDef<any> = never> {
27
+ export interface ObjectActionDataType<K extends string, T_Target extends ObjectTypeDefinition<any> = never> {
26
28
  __OsdkTargetType?: T_Target;
27
29
  type: "object";
28
30
  object: K;
29
31
  }
30
- export interface ObjectSetActionDataType<K extends string, T_Target extends MinObjectDef<any> = never> {
32
+ export interface ObjectSetActionDataType<K extends string, T_Target extends ObjectTypeDefinition<any> = never> {
31
33
  __OsdkTargetType?: T_Target;
32
34
  type: "objectSet";
33
35
  objectSet: K;
34
36
  }
35
- export type ValidActionParameterTypes<K extends string = never, T_Target extends MinObjectDef<any> = never> = ValidBaseActionParameterTypes | ObjectActionDataType<K, T_Target> | ObjectSetActionDataType<K, T_Target>;
36
- export interface ActionParameterDefinition<K extends string = never, T_Target extends MinObjectDef<any> = never> {
37
+ export type ValidActionParameterTypes<K extends string = never, T_Target extends ObjectTypeDefinition<any> = never> = ValidBaseActionParameterTypes | ObjectActionDataType<K, T_Target> | ObjectSetActionDataType<K, T_Target>;
38
+ export interface ActionParameterDefinition<K extends string = never, T_Target extends ObjectTypeDefinition<any> = never> {
37
39
  type: ValidActionParameterTypes<K, T_Target>;
38
40
  description?: string;
39
41
  multiplicity?: boolean;
@@ -1 +1 @@
1
- {"version":3,"file":"ActionDefinition.d.ts","sourceRoot":"","sources":["../../../src/ontology/ActionDefinition.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAE9D,MAAM,WAAW,gBAAgB,CAC/B,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,MAAM;IAEhB,IAAI,EAAE,QAAQ,CAAC;IACf,OAAO,EAAE,CAAC,CAAC;IACX,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC,GAAG,EAAE,yBAAyB,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;IAC3D,gBAAgB,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,oBAAoB,CAAC,CAAC,CAAC;CAC7D;AAED,MAAM,WAAW,iBAAiB,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,EAAE,CAAC,CACtE,SAAQ,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC;IAE9B,UAAU,EAAE,CAAC,CAAC;CACf;AAED,MAAM,WAAW,YAAY,CAC3B,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,MAAM,EAChB,YAAY,GAAG,KAAK;IAEpB,IAAI,EAAE,QAAQ,CAAC;IACf,OAAO,EAAE,CAAC,CAAC;IACX,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,oBAAoB,CAAC,EAAE,iBAAiB,CAAC,CAAC,EAAE,CAAC,EAAE,YAAY,CAAC,CAAC;CAC9D;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,MAAM,6BAA6B,GACrC,SAAS,GACT,QAAQ,GACR,SAAS,GACT,MAAM,GACN,QAAQ,GACR,UAAU,GACV,WAAW,GACX,YAAY,GACZ,SAAS,CAAC;AAEd,MAAM,WAAW,oBAAoB,CACnC,CAAC,SAAS,MAAM,EAChB,QAAQ,SAAS,YAAY,CAAC,GAAG,CAAC,GAAG,KAAK;IAE1C,gBAAgB,CAAC,EAAE,QAAQ,CAAC;IAC5B,IAAI,EAAE,QAAQ,CAAC;IACf,MAAM,EAAE,CAAC,CAAC;CACX;AAED,MAAM,WAAW,uBAAuB,CACtC,CAAC,SAAS,MAAM,EAChB,QAAQ,SAAS,YAAY,CAAC,GAAG,CAAC,GAAG,KAAK;IAE1C,gBAAgB,CAAC,EAAE,QAAQ,CAAC;IAC5B,IAAI,EAAE,WAAW,CAAC;IAClB,SAAS,EAAE,CAAC,CAAC;CACd;AAED,MAAM,MAAM,yBAAyB,CACnC,CAAC,SAAS,MAAM,GAAG,KAAK,EACxB,QAAQ,SAAS,YAAY,CAAC,GAAG,CAAC,GAAG,KAAK,IAExC,6BAA6B,GAC7B,oBAAoB,CAAC,CAAC,EAAE,QAAQ,CAAC,GACjC,uBAAuB,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;AAEzC,MAAM,WAAW,yBAAyB,CACxC,CAAC,SAAS,MAAM,GAAG,KAAK,EACxB,QAAQ,SAAS,YAAY,CAAC,GAAG,CAAC,GAAG,KAAK;IAE1C,IAAI,EAAE,yBAAyB,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC7C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB"}
1
+ {"version":3,"file":"ActionDefinition.d.ts","sourceRoot":"","sources":["../../../src/ontology/ActionDefinition.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,KAAK,EACV,oBAAoB,EACpB,aAAa,EACd,MAAM,2BAA2B,CAAC;AAEnC,MAAM,WAAW,cAAc,CAC7B,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,MAAM;IAEhB,IAAI,EAAE,QAAQ,CAAC;IACf,OAAO,EAAE,CAAC,CAAC;IACX,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC,GAAG,EAAE,yBAAyB,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;IAC3D,gBAAgB,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,oBAAoB,CAAC,CAAC,CAAC;IAC5D,MAAM,EAAE,aAAa,CAAC;IACtB,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,yBAAyB,CAAC,CAAC;IAC1C,UAAU,EAAE,CAAC,CAAC;CACf;AAED,MAAM,WAAW,gBAAgB,CAC/B,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,MAAM,EAChB,YAAY,GAAG,KAAK;IAEpB,IAAI,EAAE,QAAQ,CAAC;IACf,OAAO,EAAE,CAAC,CAAC;IACX,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,oBAAoB,CAAC,EACjB,yBAAyB,CAAC,YAAY,CAAC,GACvC,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;CAC1B;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,MAAM,6BAA6B,GACrC,SAAS,GACT,QAAQ,GACR,SAAS,GACT,MAAM,GACN,QAAQ,GACR,UAAU,GACV,WAAW,GACX,YAAY,GACZ,SAAS,CAAC;AAEd,MAAM,WAAW,oBAAoB,CACnC,CAAC,SAAS,MAAM,EAChB,QAAQ,SAAS,oBAAoB,CAAC,GAAG,CAAC,GAAG,KAAK;IAElD,gBAAgB,CAAC,EAAE,QAAQ,CAAC;IAC5B,IAAI,EAAE,QAAQ,CAAC;IACf,MAAM,EAAE,CAAC,CAAC;CACX;AAED,MAAM,WAAW,uBAAuB,CACtC,CAAC,SAAS,MAAM,EAChB,QAAQ,SAAS,oBAAoB,CAAC,GAAG,CAAC,GAAG,KAAK;IAElD,gBAAgB,CAAC,EAAE,QAAQ,CAAC;IAC5B,IAAI,EAAE,WAAW,CAAC;IAClB,SAAS,EAAE,CAAC,CAAC;CACd;AAED,MAAM,MAAM,yBAAyB,CACnC,CAAC,SAAS,MAAM,GAAG,KAAK,EACxB,QAAQ,SAAS,oBAAoB,CAAC,GAAG,CAAC,GAAG,KAAK,IAEhD,6BAA6B,GAC7B,oBAAoB,CAAC,CAAC,EAAE,QAAQ,CAAC,GACjC,uBAAuB,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;AAEzC,MAAM,WAAW,yBAAyB,CACxC,CAAC,SAAS,MAAM,GAAG,KAAK,EACxB,QAAQ,SAAS,oBAAoB,CAAC,GAAG,CAAC,GAAG,KAAK;IAElD,IAAI,EAAE,yBAAyB,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC7C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB"}
@@ -1,12 +1,12 @@
1
1
  import type { OsdkMetadata } from "../OsdkMetadata.js";
2
- import type { ObjectInterfaceBaseDefinition } from "./ObjectTypeDefinition.js";
3
- export interface InterfaceDefinition<K extends string, N = unknown> extends ObjectInterfaceBaseDefinition<K, N> {
2
+ import type { ObjectInterfaceBaseDefinition, ObjectInterfaceCompileDefinition } from "./ObjectTypeDefinition.js";
3
+ export interface InterfaceMetadata<K extends string, N = unknown> extends ObjectInterfaceBaseDefinition<K, N> {
4
4
  type: "interface";
5
5
  }
6
- export interface MinInterfaceDef<K extends string, N = unknown> {
6
+ export interface InterfaceDefinition<K extends string, N = unknown> {
7
7
  type: "interface";
8
8
  apiName: K;
9
9
  osdkMetadata?: OsdkMetadata;
10
- __DefinitionMetadata?: InterfaceDefinition<K, N>;
10
+ __DefinitionMetadata?: InterfaceMetadata<K, N> & ObjectInterfaceCompileDefinition;
11
11
  }
12
12
  //# sourceMappingURL=InterfaceDefinition.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"InterfaceDefinition.d.ts","sourceRoot":"","sources":["../../../src/ontology/InterfaceDefinition.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,2BAA2B,CAAC;AAE/E,MAAM,WAAW,mBAAmB,CAClC,CAAC,SAAS,MAAM,EAChB,CAAC,GAAG,OAAO,CACX,SAAQ,6BAA6B,CAAC,CAAC,EAAE,CAAC,CAAC;IAC3C,IAAI,EAAE,WAAW,CAAC;CACnB;AAED,MAAM,WAAW,eAAe,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,GAAG,OAAO;IAC5D,IAAI,EAAE,WAAW,CAAC;IAClB,OAAO,EAAE,CAAC,CAAC;IACX,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,oBAAoB,CAAC,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;CAClD"}
1
+ {"version":3,"file":"InterfaceDefinition.d.ts","sourceRoot":"","sources":["../../../src/ontology/InterfaceDefinition.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,KAAK,EACV,6BAA6B,EAC7B,gCAAgC,EACjC,MAAM,2BAA2B,CAAC;AAEnC,MAAM,WAAW,iBAAiB,CAChC,CAAC,SAAS,MAAM,EAChB,CAAC,GAAG,OAAO,CACX,SAAQ,6BAA6B,CAAC,CAAC,EAAE,CAAC,CAAC;IAC3C,IAAI,EAAE,WAAW,CAAC;CACnB;AAED,MAAM,WAAW,mBAAmB,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,GAAG,OAAO;IAChE,IAAI,EAAE,WAAW,CAAC;IAClB,OAAO,EAAE,CAAC,CAAC;IACX,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,oBAAoB,CAAC,EACjB,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,GACvB,gCAAgC,CAAC;CACtC"}
@@ -1,6 +1,6 @@
1
- import type { MinInterfaceDef } from "./InterfaceDefinition.js";
2
- import type { MinObjectDef } from "./ObjectTypeDefinition.js";
3
- export type ObjectOrInterfaceDefinition<K extends string = any, L extends string = any> = MinObjectDef<K, L> | MinInterfaceDef<K, L>;
1
+ import type { InterfaceDefinition } from "./InterfaceDefinition.js";
2
+ import type { ObjectTypeDefinition } from "./ObjectTypeDefinition.js";
3
+ export type ObjectOrInterfaceDefinition<K extends string = any, L extends string = any> = ObjectTypeDefinition<K, L> | InterfaceDefinition<K, L>;
4
4
  /** @deprecated use `PropertyKeys` */
5
5
  export type ObjectOrInterfacePropertyKeysFrom2<O extends ObjectOrInterfaceDefinition> = keyof NonNullable<O["__DefinitionMetadata"]>["properties"] & string;
6
6
  export type PropertyKeys<O extends ObjectOrInterfaceDefinition> = keyof NonNullable<O["__DefinitionMetadata"]>["properties"] & string;
@@ -1 +1 @@
1
- {"version":3,"file":"ObjectOrInterface.d.ts","sourceRoot":"","sources":["../../../src/ontology/ObjectOrInterface.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAE9D,MAAM,MAAM,2BAA2B,CACrC,CAAC,SAAS,MAAM,GAAG,GAAG,EACtB,CAAC,SAAS,MAAM,GAAG,GAAG,IAEpB,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,GAClB,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAE1B,qCAAqC;AACrC,MAAM,MAAM,kCAAkC,CAC5C,CAAC,SAAS,2BAA2B,IACnC,MAAM,WAAW,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,MAAM,CAAC;AAExE,MAAM,MAAM,YAAY,CACtB,CAAC,SAAS,2BAA2B,IACnC,MAAM,WAAW,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,MAAM,CAAC"}
1
+ {"version":3,"file":"ObjectOrInterface.d.ts","sourceRoot":"","sources":["../../../src/ontology/ObjectOrInterface.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AACpE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAEtE,MAAM,MAAM,2BAA2B,CACrC,CAAC,SAAS,MAAM,GAAG,GAAG,EACtB,CAAC,SAAS,MAAM,GAAG,GAAG,IAEpB,oBAAoB,CAAC,CAAC,EAAE,CAAC,CAAC,GAC1B,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAE9B,qCAAqC;AACrC,MAAM,MAAM,kCAAkC,CAC5C,CAAC,SAAS,2BAA2B,IACnC,MAAM,WAAW,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,MAAM,CAAC;AAExE,MAAM,MAAM,YAAY,CACtB,CAAC,SAAS,2BAA2B,IACnC,MAAM,WAAW,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,MAAM,CAAC"}
@@ -10,15 +10,11 @@ export type ObjectTypePropertyDefinitionFrom2<Q extends ObjectOrInterfaceDefinit
10
10
  export interface ObjectInterfaceBaseDefinition<K extends string, N = unknown> {
11
11
  type: "object" | "interface";
12
12
  apiName: K;
13
- displayName?: string;
13
+ displayName: string;
14
14
  description?: string;
15
15
  properties: Record<string, ObjectTypePropertyDefinition>;
16
16
  links: Record<string, ObjectTypeLinkDefinition<any, any>>;
17
- osdkMetadata?: OsdkMetadata;
18
- objectSet?: any;
19
- props?: any;
20
- strictProps?: any;
21
- linksType?: any;
17
+ rid: string;
22
18
  /**
23
19
  * Represents the "super interfaces" of this object.
24
20
  *
@@ -26,32 +22,36 @@ export interface ObjectInterfaceBaseDefinition<K extends string, N = unknown> {
26
22
  */
27
23
  implements?: ReadonlyArray<string>;
28
24
  }
25
+ export interface ObjectInterfaceCompileDefinition {
26
+ type: "object" | "interface";
27
+ objectSet?: any;
28
+ props?: any;
29
+ strictProps?: any;
30
+ linksType?: any;
31
+ }
29
32
  export interface VersionBound<V extends VersionString<any, any, any>> {
30
33
  __expectedClientVersion?: V;
31
34
  }
32
- export interface ObjectTypeDefinition<K extends string, N = unknown> extends ObjectInterfaceBaseDefinition<K, N> {
35
+ export interface ObjectMetadata<K extends string, N = unknown> extends ObjectInterfaceBaseDefinition<K, N> {
33
36
  type: "object";
34
37
  primaryKeyApiName: keyof this["properties"];
38
+ titleProperty: keyof this["properties"];
35
39
  primaryKeyType: PrimaryKeyTypes;
36
- /**
37
- * Optional because they may not exist on legacy.
38
- */
39
- interfaceMap?: Record<string, Record<string, string>>;
40
- /**
41
- * Optional because they may not exist on legacy.
42
- */
43
- inverseInterfaceMap?: Record<string, Record<string, string>>;
44
- spts?: Record<string, string>;
45
- inverseSpts?: Record<string, string>;
40
+ icon?: Icon;
41
+ visibility?: ObjectTypeVisibility;
42
+ pluralDisplayName: string;
43
+ status: ReleaseStatus;
44
+ interfaceMap: Record<string, Record<string, string>>;
45
+ inverseInterfaceMap: Record<string, Record<string, string>>;
46
46
  }
47
- export interface MinObjectDef<K extends string, N = unknown> {
47
+ export interface ObjectTypeDefinition<K extends string, N = unknown> {
48
48
  type: "object";
49
49
  apiName: K;
50
50
  osdkMetadata?: OsdkMetadata;
51
- __DefinitionMetadata?: ObjectTypeDefinition<K, N>;
51
+ __DefinitionMetadata?: ObjectMetadata<K, N> & ObjectInterfaceCompileDefinition;
52
52
  }
53
- export type ObjectTypeLinkKeysFrom2<Q extends MinObjectDef<any, any>> = keyof CompileTimeMetadata<Q>["links"] & string;
54
- export interface ObjectTypeLinkDefinition<Q extends MinObjectDef<any, any>, M extends boolean> {
53
+ export type ObjectTypeLinkKeysFrom2<Q extends ObjectTypeDefinition<any, any>> = keyof CompileTimeMetadata<Q>["links"] & string;
54
+ export interface ObjectTypeLinkDefinition<Q extends ObjectTypeDefinition<any, any>, M extends boolean> {
55
55
  __OsdkLinkTargetType?: Q;
56
56
  targetType: Q["apiName"];
57
57
  multiplicity: M;
@@ -73,4 +73,13 @@ export type PropertyDef<T extends WirePropertyTypes, N extends "nullable" | "non
73
73
  multiplicity: M extends "array" ? true : false;
74
74
  nullable: N extends "nullable" ? true : false;
75
75
  } & E & ObjectTypePropertyDefinition;
76
+ export type ReleaseStatus = "ACTIVE" | "EXPERIMENTAL" | "DEPRECATED";
77
+ type ObjectTypeVisibility = "NORMAL" | "PROMINENT" | "HIDDEN";
78
+ type BlueprintIcon = {
79
+ type: "blueprint";
80
+ color: string;
81
+ name: string;
82
+ };
83
+ type Icon = BlueprintIcon;
84
+ export {};
76
85
  //# sourceMappingURL=ObjectTypeDefinition.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"ObjectTypeDefinition.d.ts","sourceRoot":"","sources":["../../../src/ontology/ObjectTypeDefinition.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,2BAA2B,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC7E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAEhE,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS;IAAE,oBAAoB,CAAC,EAAE,EAAE,CAAA;CAAE,IACrE,WAAW,CACT,CAAC,CAAC,sBAAsB,CAAC,CAC1B,CAAC;AAEJ,MAAM,MAAM,iCAAiC,CAC3C,CAAC,SAAS,2BAA2B,CAAC,GAAG,EAAE,GAAG,CAAC,EAC/C,CAAC,SAAS,YAAY,CAAC,CAAC,CAAC,IACvB,mBAAmB,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;AAE5C,MAAM,WAAW,6BAA6B,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,GAAG,OAAO;IAC1E,IAAI,EAAE,QAAQ,GAAG,WAAW,CAAC;IAC7B,OAAO,EAAE,CAAC,CAAC;IACX,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,4BAA4B,CAAC,CAAC;IACzD,KAAK,EAAE,MAAM,CACX,MAAM,EACN,wBAAwB,CAAC,GAAG,EAAE,GAAG,CAAC,CACnC,CAAC;IACF,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,SAAS,CAAC,EAAE,GAAG,CAAC;IAChB,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,WAAW,CAAC,EAAE,GAAG,CAAC;IAClB,SAAS,CAAC,EAAE,GAAG,CAAC;IAEhB;;;;OAIG;IACH,UAAU,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC;IAClE,uBAAuB,CAAC,EAAE,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,oBAAoB,CACnC,CAAC,SAAS,MAAM,EAChB,CAAC,GAAG,OAAO,CACX,SAAQ,6BAA6B,CAAC,CAAC,EAAE,CAAC,CAAC;IAC3C,IAAI,EAAE,QAAQ,CAAC;IACf,iBAAiB,EAAE,MAAM,IAAI,CAAC,YAAY,CAAC,CAAC;IAC5C,cAAc,EAAE,eAAe,CAAC;IAEhC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CACU,MAAM,EACnC,MAAM,CACkC,MAAM,EACT,MAAM,CAC1C,CACF,CAAC;IAEF;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CACG,MAAM,EACnC,MAAM,CAC+B,MAAM,EACH,MAAM,CAC7C,CACF,CAAC;IAGF,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAG9B,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,GAAG,OAAO;IACzD,IAAI,EAAE,QAAQ,CAAC;IACf,OAAO,EAAE,CAAC,CAAC;IACX,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,oBAAoB,CAAC,EAAE,oBAAoB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;CACnD;AAED,MAAM,MAAM,uBAAuB,CACjC,CAAC,SAAS,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,IAE9B,MAAM,mBAAmB,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GACrC,MAAM,CAAC;AAEX,MAAM,WAAW,wBAAwB,CACvC,CAAC,SAAS,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,EAChC,CAAC,SAAS,OAAO;IAEjB,oBAAoB,CAAC,EAAE,CAAC,CAAC;IACzB,UAAU,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC;IACzB,YAAY,EAAE,CAAC,CAAC;CACjB;AAED,MAAM,MAAM,cAAc,CACxB,CAAC,SAAS,MAAM,EAChB,CAAC,IAEC,CAAC,GACD;IACA,UAAU,CAAC,EAAE,CAAC,CAAC;IACf,WAAW,CAAC,EAAE,CAAC,CAAC;CACjB,CAAC;AAEJ,MAAM,WAAW,4BAA4B;IAC3C,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,iBAAiB,CAAC;IACxB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,MAAM,WAAW,CACrB,CAAC,SAAS,iBAAiB,EAC3B,CAAC,SAAS,UAAU,GAAG,cAAc,GAAG,UAAU,EAClD,CAAC,SAAS,OAAO,GAAG,QAAQ,GAAG,QAAQ,EACvC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,EAAE,IAEhC;IACA,IAAI,EAAE,CAAC,CAAC;IACR,YAAY,EAAE,CAAC,SAAS,OAAO,GAAG,IAAI,GAAG,KAAK,CAAC;IAC/C,QAAQ,EAAE,CAAC,SAAS,UAAU,GAAG,IAAI,GAAG,KAAK,CAAC;CAC/C,GACC,CAAC,GACD,4BAA4B,CAAC"}
1
+ {"version":3,"file":"ObjectTypeDefinition.d.ts","sourceRoot":"","sources":["../../../src/ontology/ObjectTypeDefinition.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,2BAA2B,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC7E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAEhE,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS;IAAE,oBAAoB,CAAC,EAAE,EAAE,CAAA;CAAE,IACrE,WAAW,CACT,CAAC,CAAC,sBAAsB,CAAC,CAC1B,CAAC;AAEJ,MAAM,MAAM,iCAAiC,CAC3C,CAAC,SAAS,2BAA2B,CAAC,GAAG,EAAE,GAAG,CAAC,EAC/C,CAAC,SAAS,YAAY,CAAC,CAAC,CAAC,IACvB,mBAAmB,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;AAE5C,MAAM,WAAW,6BAA6B,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,GAAG,OAAO;IAC1E,IAAI,EAAE,QAAQ,GAAG,WAAW,CAAC;IAC7B,OAAO,EAAE,CAAC,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,4BAA4B,CAAC,CAAC;IACzD,KAAK,EAAE,MAAM,CACX,MAAM,EACN,wBAAwB,CAAC,GAAG,EAAE,GAAG,CAAC,CACnC,CAAC;IACF,GAAG,EAAE,MAAM,CAAC;IACZ;;;;OAIG;IACH,UAAU,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,gCAAgC;IAC/C,IAAI,EAAE,QAAQ,GAAG,WAAW,CAAC;IAC7B,SAAS,CAAC,EAAE,GAAG,CAAC;IAChB,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,WAAW,CAAC,EAAE,GAAG,CAAC;IAClB,SAAS,CAAC,EAAE,GAAG,CAAC;CACjB;AAED,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC;IAClE,uBAAuB,CAAC,EAAE,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,cAAc,CAC7B,CAAC,SAAS,MAAM,EAChB,CAAC,GAAG,OAAO,CACX,SAAQ,6BAA6B,CAAC,CAAC,EAAE,CAAC,CAAC;IAC3C,IAAI,EAAE,QAAQ,CAAC;IACf,iBAAiB,EAAE,MAAM,IAAI,CAAC,YAAY,CAAC,CAAC;IAC5C,aAAa,EAAE,MAAM,IAAI,CAAC,YAAY,CAAC,CAAC;IACxC,cAAc,EAAE,eAAe,CAAC;IAChC,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,UAAU,CAAC,EAAE,oBAAoB,CAAC;IAClC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,MAAM,EAAE,aAAa,CAAC;IACtB,YAAY,EAAE,MAAM,CACW,MAAM,EACnC,MAAM,CACkC,MAAM,EACT,MAAM,CAC1C,CACF,CAAC;IACF,mBAAmB,EAAE,MAAM,CACI,MAAM,EACnC,MAAM,CAC+B,MAAM,EACH,MAAM,CAC7C,CACF,CAAC;CACH;AAED,MAAM,WAAW,oBAAoB,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,GAAG,OAAO;IACjE,IAAI,EAAE,QAAQ,CAAC;IACf,OAAO,EAAE,CAAC,CAAC;IACX,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,oBAAoB,CAAC,EACjB,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,GACpB,gCAAgC,CAAC;CACtC;AAED,MAAM,MAAM,uBAAuB,CACjC,CAAC,SAAS,oBAAoB,CAAC,GAAG,EAAE,GAAG,CAAC,IAEtC,MAAM,mBAAmB,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GACrC,MAAM,CAAC;AAEX,MAAM,WAAW,wBAAwB,CACvC,CAAC,SAAS,oBAAoB,CAAC,GAAG,EAAE,GAAG,CAAC,EACxC,CAAC,SAAS,OAAO;IAEjB,oBAAoB,CAAC,EAAE,CAAC,CAAC;IACzB,UAAU,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC;IACzB,YAAY,EAAE,CAAC,CAAC;CACjB;AAED,MAAM,MAAM,cAAc,CACxB,CAAC,SAAS,MAAM,EAChB,CAAC,IAEC,CAAC,GACD;IACA,UAAU,CAAC,EAAE,CAAC,CAAC;IACf,WAAW,CAAC,EAAE,CAAC,CAAC;CACjB,CAAC;AAEJ,MAAM,WAAW,4BAA4B;IAC3C,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,iBAAiB,CAAC;IACxB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,MAAM,WAAW,CACrB,CAAC,SAAS,iBAAiB,EAC3B,CAAC,SAAS,UAAU,GAAG,cAAc,GAAG,UAAU,EAClD,CAAC,SAAS,OAAO,GAAG,QAAQ,GAAG,QAAQ,EACvC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,EAAE,IAEhC;IACA,IAAI,EAAE,CAAC,CAAC;IACR,YAAY,EAAE,CAAC,SAAS,OAAO,GAAG,IAAI,GAAG,KAAK,CAAC;IAC/C,QAAQ,EAAE,CAAC,SAAS,UAAU,GAAG,IAAI,GAAG,KAAK,CAAC;CAC/C,GACC,CAAC,GACD,4BAA4B,CAAC;AAEjC,MAAM,MAAM,aAAa,GAAG,QAAQ,GAAG,cAAc,GAAG,YAAY,CAAC;AAErE,KAAK,oBAAoB,GAAG,QAAQ,GAAG,WAAW,GAAG,QAAQ,CAAC;AAE9D,KAAK,aAAa,GAAG;IACnB,IAAI,EAAE,WAAW,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,KAAK,IAAI,GAAG,aAAa,CAAC"}
@@ -1,6 +1,6 @@
1
1
  import type { OsdkMetadata } from "../OsdkMetadata.js";
2
- import type { MinObjectDef } from "./ObjectTypeDefinition.js";
3
- export interface QueryDefinition<A extends string, K extends string> {
2
+ import type { ObjectTypeDefinition } from "./ObjectTypeDefinition.js";
3
+ export interface QueryMetadata<A extends string, K extends string> {
4
4
  type: "query";
5
5
  apiName: A;
6
6
  description?: string;
@@ -8,20 +8,21 @@ export interface QueryDefinition<A extends string, K extends string> {
8
8
  version: string;
9
9
  parameters: Record<string, QueryParameterDefinition<K, any>>;
10
10
  output: QueryDataTypeDefinition<K, any>;
11
+ rid: string;
11
12
  }
12
- export interface QueryDefMetadata<A extends string, K extends string, T> extends QueryDefinition<A, K> {
13
+ export interface QueryCompileTimeMetadata<T> {
13
14
  signature: T;
14
15
  }
15
- export interface MinQueryDef<A extends string, K extends string, T = never> {
16
+ export interface QueryDefinition<A extends string, K extends string, T = never> {
16
17
  type: "query";
17
18
  apiName: A;
18
19
  osdkMetadata?: OsdkMetadata;
19
- __DefinitionMetadata?: QueryDefMetadata<A, K, T>;
20
+ __DefinitionMetadata?: QueryCompileTimeMetadata<T> & QueryMetadata<A, K>;
20
21
  }
21
- export type QueryParameterDefinition<K extends string, T_Target extends MinObjectDef<any> = never> = {
22
+ export type QueryParameterDefinition<K extends string, T_Target extends ObjectTypeDefinition<any> = never> = {
22
23
  description?: string;
23
24
  } & QueryDataTypeDefinition<K, T_Target>;
24
- export type QueryDataTypeDefinition<K extends string, T_Target extends MinObjectDef<any> = never> = PrimitiveDataType | ObjectQueryDataType<K, T_Target> | ObjectSetQueryDataType<K, T_Target> | SetQueryDataType<K> | UnionQueryDataType<K> | StructQueryDataType<K> | TwoDimensionalAggregationDataType | ThreeDimensionalAggregationDataType;
25
+ export type QueryDataTypeDefinition<K extends string, T_Target extends ObjectTypeDefinition<any> = never> = PrimitiveDataType | ObjectQueryDataType<K, T_Target> | ObjectSetQueryDataType<K, T_Target> | SetQueryDataType<K> | UnionQueryDataType<K> | StructQueryDataType<K> | TwoDimensionalAggregationDataType | ThreeDimensionalAggregationDataType;
25
26
  export type BaseQueryDataTypeDefinition<T extends string> = {
26
27
  multiplicity?: boolean;
27
28
  nullable?: boolean;
@@ -29,11 +30,11 @@ export type BaseQueryDataTypeDefinition<T extends string> = {
29
30
  };
30
31
  export type WireQueryDataTypes = "double" | "float" | "integer" | "long" | "boolean" | "string" | "date" | "timestamp" | "attachment";
31
32
  export type PrimitiveDataType<Q extends WireQueryDataTypes = WireQueryDataTypes> = BaseQueryDataTypeDefinition<Q>;
32
- export interface ObjectQueryDataType<K extends string, T_Target extends MinObjectDef<any> = never> extends BaseQueryDataTypeDefinition<"object"> {
33
+ export interface ObjectQueryDataType<K extends string, T_Target extends ObjectTypeDefinition<any> = never> extends BaseQueryDataTypeDefinition<"object"> {
33
34
  object: K;
34
35
  __OsdkTargetType?: T_Target;
35
36
  }
36
- export interface ObjectSetQueryDataType<K extends string, T_Target extends MinObjectDef<any> = never> extends BaseQueryDataTypeDefinition<"objectSet"> {
37
+ export interface ObjectSetQueryDataType<K extends string, T_Target extends ObjectTypeDefinition<any> = never> extends BaseQueryDataTypeDefinition<"objectSet"> {
37
38
  objectSet: K;
38
39
  __OsdkTargetType?: T_Target;
39
40
  }
@@ -1 +1 @@
1
- {"version":3,"file":"QueryDefinition.d.ts","sourceRoot":"","sources":["../../../src/ontology/QueryDefinition.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAE9D,MAAM,WAAW,eAAe,CAC9B,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,MAAM;IAEhB,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,CAAC,CAAC;IACX,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;IAC7D,MAAM,EAAE,uBAAuB,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;CACzC;AAED,MAAM,WAAW,gBAAgB,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,EAAE,CAAC,CACrE,SAAQ,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC;IAE7B,SAAS,EAAE,CAAC,CAAC;CACd;AAED,MAAM,WAAW,WAAW,CAC1B,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,MAAM,EAChB,CAAC,GAAG,KAAK;IAET,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,CAAC,CAAC;IACX,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,oBAAoB,CAAC,EAAE,gBAAgB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;CAClD;AAED,MAAM,MAAM,wBAAwB,CAClC,CAAC,SAAS,MAAM,EAChB,QAAQ,SAAS,YAAY,CAAC,GAAG,CAAC,GAAG,KAAK,IACxC;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,GAAG,uBAAuB,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;AAEzC,MAAM,MAAM,uBAAuB,CACjC,CAAC,SAAS,MAAM,EAChB,QAAQ,SAAS,YAAY,CAAC,GAAG,CAAC,GAAG,KAAK,IAExC,iBAAiB,GACjB,mBAAmB,CAAC,CAAC,EAAE,QAAQ,CAAC,GAChC,sBAAsB,CAAC,CAAC,EAAE,QAAQ,CAAC,GACnC,gBAAgB,CAAC,CAAC,CAAC,GACnB,kBAAkB,CAAC,CAAC,CAAC,GACrB,mBAAmB,CAAC,CAAC,CAAC,GACtB,iCAAiC,GACjC,mCAAmC,CAAC;AAExC,MAAM,MAAM,2BAA2B,CAAC,CAAC,SAAS,MAAM,IAAI;IAC1D,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,IAAI,EAAE,CAAC,CAAC;CACT,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAC1B,QAAQ,GACR,OAAO,GACP,SAAS,GACT,MAAM,GACN,SAAS,GACT,QAAQ,GACR,MAAM,GACN,WAAW,GACX,YAAY,CAAC;AAEjB,MAAM,MAAM,iBAAiB,CAC3B,CAAC,SAAS,kBAAkB,GAAG,kBAAkB,IAC/C,2BAA2B,CAAC,CAAC,CAAC,CAAC;AAEnC,MAAM,WAAW,mBAAmB,CAClC,CAAC,SAAS,MAAM,EAChB,QAAQ,SAAS,YAAY,CAAC,GAAG,CAAC,GAAG,KAAK,CAC1C,SAAQ,2BAA2B,CAAC,QAAQ,CAAC;IAC7C,MAAM,EAAE,CAAC,CAAC;IACV,gBAAgB,CAAC,EAAE,QAAQ,CAAC;CAC7B;AAED,MAAM,WAAW,sBAAsB,CACrC,CAAC,SAAS,MAAM,EAChB,QAAQ,SAAS,YAAY,CAAC,GAAG,CAAC,GAAG,KAAK,CAC1C,SAAQ,2BAA2B,CAAC,WAAW,CAAC;IAChD,SAAS,EAAE,CAAC,CAAC;IACb,gBAAgB,CAAC,EAAE,QAAQ,CAAC;CAC7B;AAED,MAAM,WAAW,gBAAgB,CAAC,CAAC,SAAS,MAAM,CAChD,SAAQ,2BAA2B,CAAC,KAAK,CAAC;IAE1C,GAAG,EAAE,uBAAuB,CAAC,CAAC,CAAC,CAAC;CACjC;AAED,MAAM,WAAW,kBAAkB,CAAC,CAAC,SAAS,MAAM,CAClD,SAAQ,2BAA2B,CAAC,OAAO,CAAC;IAE5C,KAAK,EAAE,aAAa,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC,CAAC;CAClD;AAED,MAAM,WAAW,mBAAmB,CAAC,CAAC,SAAS,MAAM,CACnD,SAAQ,2BAA2B,CAAC,QAAQ,CAAC;IAE7C,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,uBAAuB,CAAC,CAAC,CAAC,CAAC,CAAC;CACpD;AAED,MAAM,WAAW,iCACf,SAAQ,2BAA2B,CAAC,2BAA2B,CAAC;IAEhE,yBAAyB,EAAE,wCAAwC,CAAC;CACrE;AAED,MAAM,WAAW,mCACf,SAAQ,2BAA2B,CAAC,6BAA6B,CAAC;IAElE,2BAA2B,EAAE,0CAA0C,CAAC;CACzE;AAED,MAAM,MAAM,sBAAsB,CAAC,CAAC,GAAG,GAAG,IACtC,4BAA4B,CAAC,CAAC,CAAC,GAC/B,2BAA2B,CAAC,CAAC,CAAC,CAAC;AAEnC,MAAM,WAAW,4BAA4B,CAAC,CAAC,GAAG,GAAG;IACnD,OAAO,EAAE,SAAS,GAAG,QAAQ,CAAC;IAC9B,SAAS,EAAE,CAAC,CAAC;CACd;AAED,MAAM,WAAW,2BAA2B,CAAC,CAAC,GAAG,GAAG;IAClD,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,GAAG,WAAW,CAAC;IACxD,SAAS,EAAE,CAAC,CAAC;CACd;AAED,MAAM,MAAM,wCAAwC,GAAG,sBAAsB,CAC3E,MAAM,GAAG,QAAQ,GAAG,WAAW,CAChC,CAAC;AAEF,MAAM,MAAM,0CAA0C,GAAG,sBAAsB,CAC7E,wCAAwC,CACzC,CAAC"}
1
+ {"version":3,"file":"QueryDefinition.d.ts","sourceRoot":"","sources":["../../../src/ontology/QueryDefinition.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,KAAK,EACV,oBAAoB,EAErB,MAAM,2BAA2B,CAAC;AAEnC,MAAM,WAAW,aAAa,CAC5B,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,MAAM;IAEhB,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,CAAC,CAAC;IACX,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;IAC7D,MAAM,EAAE,uBAAuB,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IACxC,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,wBAAwB,CAAC,CAAC;IACzC,SAAS,EAAE,CAAC,CAAC;CACd;AAED,MAAM,WAAW,eAAe,CAC9B,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,MAAM,EAChB,CAAC,GAAG,KAAK;IAET,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,CAAC,CAAC;IACX,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,oBAAoB,CAAC,EAAE,wBAAwB,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;CAC1E;AAED,MAAM,MAAM,wBAAwB,CAClC,CAAC,SAAS,MAAM,EAChB,QAAQ,SAAS,oBAAoB,CAAC,GAAG,CAAC,GAAG,KAAK,IAChD;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,GAAG,uBAAuB,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;AAEzC,MAAM,MAAM,uBAAuB,CACjC,CAAC,SAAS,MAAM,EAChB,QAAQ,SAAS,oBAAoB,CAAC,GAAG,CAAC,GAAG,KAAK,IAEhD,iBAAiB,GACjB,mBAAmB,CAAC,CAAC,EAAE,QAAQ,CAAC,GAChC,sBAAsB,CAAC,CAAC,EAAE,QAAQ,CAAC,GACnC,gBAAgB,CAAC,CAAC,CAAC,GACnB,kBAAkB,CAAC,CAAC,CAAC,GACrB,mBAAmB,CAAC,CAAC,CAAC,GACtB,iCAAiC,GACjC,mCAAmC,CAAC;AAExC,MAAM,MAAM,2BAA2B,CAAC,CAAC,SAAS,MAAM,IAAI;IAC1D,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,IAAI,EAAE,CAAC,CAAC;CACT,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAC1B,QAAQ,GACR,OAAO,GACP,SAAS,GACT,MAAM,GACN,SAAS,GACT,QAAQ,GACR,MAAM,GACN,WAAW,GACX,YAAY,CAAC;AAEjB,MAAM,MAAM,iBAAiB,CAC3B,CAAC,SAAS,kBAAkB,GAAG,kBAAkB,IAC/C,2BAA2B,CAAC,CAAC,CAAC,CAAC;AAEnC,MAAM,WAAW,mBAAmB,CAClC,CAAC,SAAS,MAAM,EAChB,QAAQ,SAAS,oBAAoB,CAAC,GAAG,CAAC,GAAG,KAAK,CAClD,SAAQ,2BAA2B,CAAC,QAAQ,CAAC;IAC7C,MAAM,EAAE,CAAC,CAAC;IACV,gBAAgB,CAAC,EAAE,QAAQ,CAAC;CAC7B;AAED,MAAM,WAAW,sBAAsB,CACrC,CAAC,SAAS,MAAM,EAChB,QAAQ,SAAS,oBAAoB,CAAC,GAAG,CAAC,GAAG,KAAK,CAClD,SAAQ,2BAA2B,CAAC,WAAW,CAAC;IAChD,SAAS,EAAE,CAAC,CAAC;IACb,gBAAgB,CAAC,EAAE,QAAQ,CAAC;CAC7B;AAED,MAAM,WAAW,gBAAgB,CAAC,CAAC,SAAS,MAAM,CAChD,SAAQ,2BAA2B,CAAC,KAAK,CAAC;IAE1C,GAAG,EAAE,uBAAuB,CAAC,CAAC,CAAC,CAAC;CACjC;AAED,MAAM,WAAW,kBAAkB,CAAC,CAAC,SAAS,MAAM,CAClD,SAAQ,2BAA2B,CAAC,OAAO,CAAC;IAE5C,KAAK,EAAE,aAAa,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC,CAAC;CAClD;AAED,MAAM,WAAW,mBAAmB,CAAC,CAAC,SAAS,MAAM,CACnD,SAAQ,2BAA2B,CAAC,QAAQ,CAAC;IAE7C,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,uBAAuB,CAAC,CAAC,CAAC,CAAC,CAAC;CACpD;AAED,MAAM,WAAW,iCACf,SAAQ,2BAA2B,CAAC,2BAA2B,CAAC;IAEhE,yBAAyB,EAAE,wCAAwC,CAAC;CACrE;AAED,MAAM,WAAW,mCACf,SAAQ,2BAA2B,CAAC,6BAA6B,CAAC;IAElE,2BAA2B,EAAE,0CAA0C,CAAC;CACzE;AAED,MAAM,MAAM,sBAAsB,CAAC,CAAC,GAAG,GAAG,IACtC,4BAA4B,CAAC,CAAC,CAAC,GAC/B,2BAA2B,CAAC,CAAC,CAAC,CAAC;AAEnC,MAAM,WAAW,4BAA4B,CAAC,CAAC,GAAG,GAAG;IACnD,OAAO,EAAE,SAAS,GAAG,QAAQ,CAAC;IAC9B,SAAS,EAAE,CAAC,CAAC;CACd;AAED,MAAM,WAAW,2BAA2B,CAAC,CAAC,GAAG,GAAG;IAClD,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,GAAG,WAAW,CAAC;IACxD,SAAS,EAAE,CAAC,CAAC;CACd;AAED,MAAM,MAAM,wCAAwC,GAAG,sBAAsB,CAC3E,MAAM,GAAG,QAAQ,GAAG,WAAW,CAChC,CAAC;AAEF,MAAM,MAAM,0CAA0C,GAAG,sBAAsB,CAC7E,wCAAwC,CACzC,CAAC"}
@@ -1,7 +1,7 @@
1
- export type { ActionModifiedEntity, ActionParameterDefinition, MinActionDef, ObjectActionDataType, ObjectSetActionDataType, ValidActionParameterTypes, ValidBaseActionParameterTypes, } from "./ActionDefinition.js";
2
- export type { InterfaceDefinition, MinInterfaceDef, } from "./InterfaceDefinition.js";
1
+ export type { ActionDefinition, ActionModifiedEntity, ActionParameterDefinition, ObjectActionDataType, ObjectSetActionDataType, ValidActionParameterTypes, ValidBaseActionParameterTypes, } from "./ActionDefinition.js";
2
+ export type { InterfaceDefinition, InterfaceMetadata, } from "./InterfaceDefinition.js";
3
3
  export type { ObjectOrInterfaceDefinition } from "./ObjectOrInterface.js";
4
- export type { MinObjectDef, ObjectTypeDefinition, ObjectTypeLinkDefinition, ObjectTypePropertyDefinition, } from "./ObjectTypeDefinition.js";
4
+ export type { ObjectMetadata, ObjectTypeDefinition, ObjectTypeLinkDefinition, ObjectTypePropertyDefinition, } from "./ObjectTypeDefinition.js";
5
5
  export type { OntologyMetadata } from "./OntologyMetadata.js";
6
- export type { AggregationKeyDataType, ObjectQueryDataType, ObjectSetQueryDataType, QueryDataTypeDefinition, QueryDefinition, QueryParameterDefinition, RangeAggregationKeyDataType, SetQueryDataType, SimpleAggregationKeyDataType, StructQueryDataType, ThreeDimensionalAggregationDataType, ThreeDimensionalQueryAggregationDefinition, TwoDimensionalAggregationDataType, TwoDimensionalQueryAggregationDefinition, UnionQueryDataType, } from "./QueryDefinition.js";
6
+ export type { AggregationKeyDataType, ObjectQueryDataType, ObjectSetQueryDataType, QueryDataTypeDefinition, QueryMetadata, QueryParameterDefinition, RangeAggregationKeyDataType, SetQueryDataType, SimpleAggregationKeyDataType, StructQueryDataType, ThreeDimensionalAggregationDataType, ThreeDimensionalQueryAggregationDefinition, TwoDimensionalAggregationDataType, TwoDimensionalQueryAggregationDefinition, UnionQueryDataType, } from "./QueryDefinition.js";
7
7
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/ontology/index.ts"],"names":[],"mappings":"AAgBA,YAAY,EACV,oBAAoB,EACpB,yBAAyB,EACzB,YAAY,EACZ,oBAAoB,EACpB,uBAAuB,EACvB,yBAAyB,EACzB,6BAA6B,GAC9B,MAAM,uBAAuB,CAAC;AAC/B,YAAY,EACV,mBAAmB,EACnB,eAAe,GAChB,MAAM,0BAA0B,CAAC;AAClC,YAAY,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAC;AAC1E,YAAY,EACV,YAAY,EACZ,oBAAoB,EACpB,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,2BAA2B,CAAC;AACnC,YAAY,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,YAAY,EACV,sBAAsB,EACtB,mBAAmB,EACnB,sBAAsB,EACtB,uBAAuB,EACvB,eAAe,EACf,wBAAwB,EACxB,2BAA2B,EAC3B,gBAAgB,EAChB,4BAA4B,EAC5B,mBAAmB,EACnB,mCAAmC,EACnC,0CAA0C,EAC1C,iCAAiC,EACjC,wCAAwC,EACxC,kBAAkB,GACnB,MAAM,sBAAsB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/ontology/index.ts"],"names":[],"mappings":"AAgBA,YAAY,EACV,gBAAgB,EAChB,oBAAoB,EACpB,yBAAyB,EACzB,oBAAoB,EACpB,uBAAuB,EACvB,yBAAyB,EACzB,6BAA6B,GAC9B,MAAM,uBAAuB,CAAC;AAC/B,YAAY,EACV,mBAAmB,EACnB,iBAAiB,GAClB,MAAM,0BAA0B,CAAC;AAClC,YAAY,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAC;AAC1E,YAAY,EACV,cAAc,EACd,oBAAoB,EACpB,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,2BAA2B,CAAC;AACnC,YAAY,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,YAAY,EACV,sBAAsB,EACtB,mBAAmB,EACnB,sBAAsB,EACtB,uBAAuB,EACvB,aAAa,EACb,wBAAwB,EACxB,2BAA2B,EAC3B,gBAAgB,EAChB,4BAA4B,EAC5B,mBAAmB,EACnB,mCAAmC,EACnC,0CAA0C,EAC1C,iCAAiC,EACjC,wCAAwC,EACxC,kBAAkB,GACnB,MAAM,sBAAsB,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@osdk/api",
3
- "version": "2.0.0-beta.11",
3
+ "version": "2.0.0-beta.13",
4
4
  "description": "",
5
5
  "access": "public",
6
6
  "license": "Apache-2.0",
@@ -22,14 +22,14 @@
22
22
  "@types/geojson": "^7946.0.13",
23
23
  "fetch-retry": "^6.0.0",
24
24
  "tiny-invariant": "^1.3.1",
25
- "@osdk/shared.net": "~2.0.0-beta.3"
25
+ "@osdk/shared.net": "~2.0.0-beta.4"
26
26
  },
27
27
  "devDependencies": {
28
28
  "ts-expect": "^1.3.0",
29
29
  "typescript": "^5.5.4",
30
30
  "@osdk/monorepo.api-extractor": "~0.0.0",
31
- "@osdk/monorepo.tsconfig": "~0.0.0",
32
- "@osdk/monorepo.tsup": "~0.0.0"
31
+ "@osdk/monorepo.tsup": "~0.0.0",
32
+ "@osdk/monorepo.tsconfig": "~0.0.0"
33
33
  },
34
34
  "publishConfig": {
35
35
  "access": "public"