@osdk/api 1.2.0 → 1.4.0

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.
@@ -1,7 +1,7 @@
1
1
  export type { ActionDefinition, ActionModifiedEntity, ActionParameterDefinition, ObjectActionDataType, ObjectSetActionDataType, ValidActionParameterTypes, } from "./ontology/ActionDefinition";
2
2
  export type { InterfaceDefinition, InterfaceDefinitionFrom, InterfaceKeysFrom, InterfacePropertyDefinitionFrom, InterfacePropertyDefinitionsFrom, InterfacePropertyKeysFrom, InterfacePropertyKeysFrom2, } from "./ontology/InterfaceDefinition";
3
3
  export type { ObjectOrInterfaceDefinition, ObjectOrInterfaceDefinitionFrom, ObjectOrInterfaceKeysFrom, ObjectOrInterfacePropertyKeysFrom, ObjectOrInterfacePropertyKeysFrom2, } from "./ontology/ObjectOrInterface";
4
- export type { ObjectTypeDefinition, ObjectTypeDefinitionFrom, ObjectTypeKeysFrom, ObjectTypeLinkDefinition, ObjectTypeLinkDefinitionFrom, ObjectTypeLinkKeysFrom, ObjectTypeLinkKeysFrom2, ObjectTypeLinkTargetTypeFrom, ObjectTypePropertyDefinition, ObjectTypePropertyDefinitionFrom, ObjectTypePropertyDefinitionFrom2, ObjectTypePropertyDefinitionsFrom, ObjectTypePropertyKeysFrom, } from "./ontology/ObjectTypeDefinition";
4
+ export type { ObjectTypeDefinition, ObjectTypeDefinitionFrom, ObjectTypeKeysFrom, ObjectTypeLinkDefinition, ObjectTypeLinkDefinitionFrom, ObjectTypeLinkKeysFrom, ObjectTypeLinkKeysFrom2, ObjectTypeLinkTargetTypeFrom, ObjectTypePropertyDefinition, ObjectTypePropertyDefinitionFrom, ObjectTypePropertyDefinitionFrom2, ObjectTypePropertyDefinitionsFrom, ObjectTypePropertyKeysFrom, PropertyDef, } from "./ontology/ObjectTypeDefinition";
5
5
  export type { OntologyDefinition } from "./ontology/OntologyDefinition";
6
- export type { AggregationKeyDataType, ObjectQueryDataType, ObjectSetQueryDataType, PrimitiveDataType, QueryDataTypeDefinition, QueryDefinition, QueryParameterDefinition, RangeAggregationKeyDataType, SetQueryDataType, SimpleAggregationKeyDataType, StructQueryDataType, ThreeDimensionalAggregationDataType, ThreeDimensionalQueryAggregationDefinition, TwoDimensionalAggregationDataType, TwoDimensionalQueryAggregationDefinition, UnionQueryDataType, WireQueryDataTypes, } from "./ontology/QueryDefinition";
6
+ export type { AggregationKeyDataType, ObjectQueryDataType, ObjectSetQueryDataType, PrimitiveDataType, QueryDataTypeDefinition, QueryDefinition, QueryParameterDefinition, RangeAggregationKeyDataType, SetQueryDataType, SimpleAggregationKeyDataType, StructQueryDataType, ThreeDimensionalAggregationDataType, ThreeDimensionalQueryAggregationDefinition, TwoDimensionalAggregationDataType, TwoDimensionalQueryAggregationDefinition, UnionQueryDataType, } from "./ontology/QueryDefinition";
7
7
  export type { WirePropertyTypes } from "./ontology/WirePropertyTypes";
@@ -12,17 +12,7 @@ export interface ActionModifiedEntity {
12
12
  created: boolean;
13
13
  modified: boolean;
14
14
  }
15
- export interface ValidBaseActionParameterTypes {
16
- boolean: boolean;
17
- string: string;
18
- integer: number;
19
- long: number;
20
- double: number;
21
- datetime: Date;
22
- timestamp: Date;
23
- attachment: any;
24
- marking: string;
25
- }
15
+ export type ValidBaseActionParameterTypes = "boolean" | "string" | "integer" | "long" | "double" | "datetime" | "timestamp" | "attachment" | "marking";
26
16
  export interface ObjectActionDataType<K extends string, T_Target extends ObjectTypeDefinition<any> = never> {
27
17
  __OsdkTargetType?: T_Target;
28
18
  type: "object";
@@ -33,7 +23,7 @@ export interface ObjectSetActionDataType<K extends string, T_Target extends Obje
33
23
  type: "objectSet";
34
24
  objectSet: K;
35
25
  }
36
- export type ValidActionParameterTypes<K extends string = never, T_Target extends ObjectTypeDefinition<any> = never> = keyof ValidBaseActionParameterTypes | ObjectActionDataType<K, T_Target> | ObjectSetActionDataType<K, T_Target>;
26
+ export type ValidActionParameterTypes<K extends string = never, T_Target extends ObjectTypeDefinition<any> = never> = ValidBaseActionParameterTypes | ObjectActionDataType<K, T_Target> | ObjectSetActionDataType<K, T_Target>;
37
27
  export interface ActionParameterDefinition<K extends string = never, T_Target extends ObjectTypeDefinition<any> = never> {
38
28
  type: ValidActionParameterTypes<K, T_Target>;
39
29
  description?: string;
@@ -1,4 +1,4 @@
1
- import type { ObjectTypeLinkDefinition, ObjectTypePropertyDefinition } from "./ObjectTypeDefinition";
1
+ import type { ObjectInterfaceBaseDefinition } from "./ObjectTypeDefinition";
2
2
  import type { OntologyDefinition } from "./OntologyDefinition";
3
3
  export type InterfaceDefinitionFrom<O extends OntologyDefinition<any>, K extends InterfaceKeysFrom<O>> = O["interfaces"] extends {} ? O["interfaces"][K] : never;
4
4
  export type InterfaceKeysFrom<O extends OntologyDefinition<string>> = keyof O["interfaces"];
@@ -6,10 +6,6 @@ export type InterfacePropertyKeysFrom<O extends OntologyDefinition<any>, K exten
6
6
  export type InterfacePropertyKeysFrom2<I extends InterfaceDefinition<any, any>> = keyof I["properties"] & string;
7
7
  export type InterfacePropertyDefinitionsFrom<O extends OntologyDefinition<any>, K extends InterfaceKeysFrom<O>> = InterfaceDefinitionFrom<O, K>["properties"];
8
8
  export type InterfacePropertyDefinitionFrom<O extends OntologyDefinition<any>, K extends InterfaceKeysFrom<O>, P extends InterfacePropertyKeysFrom<O, K>> = InterfacePropertyDefinitionsFrom<O, K>[P];
9
- export interface InterfaceDefinition<K extends string, _L extends string> {
9
+ export interface InterfaceDefinition<K extends string, N = unknown> extends ObjectInterfaceBaseDefinition<K, N> {
10
10
  type: "interface";
11
- apiName: K;
12
- description?: string;
13
- properties: Record<string, ObjectTypePropertyDefinition>;
14
- links: Record<string, ObjectTypeLinkDefinition<any, any>>;
15
11
  }
@@ -4,5 +4,5 @@ import type { OntologyDefinition } from "./OntologyDefinition";
4
4
  export type ObjectOrInterfaceKeysFrom<O extends OntologyDefinition<any, any>> = ObjectTypeKeysFrom<O> | InterfaceKeysFrom<O>;
5
5
  export type ObjectOrInterfaceDefinition<K extends string = any, L extends string = any> = ObjectTypeDefinition<K> | InterfaceDefinition<K, L>;
6
6
  export type ObjectOrInterfacePropertyKeysFrom<O extends OntologyDefinition<any, any>, K extends ObjectOrInterfaceKeysFrom<O>> = K extends InterfaceKeysFrom<O> ? InterfacePropertyKeysFrom<O, K> : ObjectTypePropertyKeysFrom<O, K>;
7
- export type ObjectOrInterfacePropertyKeysFrom2<O extends ObjectTypeDefinition<any> | InterfaceDefinition<any, any>> = keyof O["properties"] & string;
7
+ export type ObjectOrInterfacePropertyKeysFrom2<O extends ObjectTypeDefinition<any, any> | InterfaceDefinition<any, any>> = keyof O["properties"] & string;
8
8
  export type ObjectOrInterfaceDefinitionFrom<O extends OntologyDefinition<any, any>, K extends ObjectOrInterfaceKeysFrom<O>> = K extends InterfaceKeysFrom<O> ? InterfaceDefinitionFrom<O, K> : ObjectTypeDefinitionFrom<O, K>;
@@ -7,18 +7,27 @@ export type ObjectTypePropertyKeysFrom<O extends OntologyDefinition<any>, K exte
7
7
  export type ObjectTypePropertyDefinitionsFrom<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>> = ObjectTypeDefinitionFrom<O, K>["properties"];
8
8
  export type ObjectTypePropertyDefinitionFrom<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>, P extends ObjectTypePropertyKeysFrom<O, K>> = ObjectTypePropertyDefinitionsFrom<O, K>[P];
9
9
  export type ObjectTypePropertyDefinitionFrom2<Q extends ObjectOrInterfaceDefinition<any, any>, P extends keyof Q["properties"] & string> = Q["properties"][P];
10
- export interface ObjectTypeDefinition<K extends string> {
11
- type: "object";
12
- apiName: K;
10
+ export interface ObjectInterfaceBaseDefinition<K extends string, N = unknown> {
11
+ type: "object" | "interface";
12
+ apiName: K & {
13
+ __OsdkType?: N;
14
+ };
13
15
  description?: string;
14
- primaryKeyType: keyof WirePropertyTypes;
15
16
  properties: Record<string, ObjectTypePropertyDefinition>;
16
17
  links: Record<string, ObjectTypeLinkDefinition<any, any>>;
17
18
  }
19
+ export interface ObjectTypeDefinition<K extends string, N = unknown> extends ObjectInterfaceBaseDefinition<K, N> {
20
+ type: "object";
21
+ primaryKeyApiName: keyof this["properties"];
22
+ primaryKeyType: WirePropertyTypes;
23
+ implements?: string[];
24
+ spts?: Record<string, string>;
25
+ inverseSpts?: Record<string, string>;
26
+ }
18
27
  export type ObjectTypeLinkKeysFrom<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>> = keyof ObjectTypeDefinitionFrom<O, K>["links"];
19
28
  export type ObjectTypeLinkKeysFrom2<O extends ObjectTypeDefinition<any>> = keyof O["links"] & string;
20
- export interface ObjectTypeLinkDefinition<O extends ObjectTypeDefinition<any>, M extends boolean> {
21
- __Mark?: O;
29
+ export interface ObjectTypeLinkDefinition<O extends ObjectTypeDefinition<any, any>, M extends boolean> {
30
+ __OsdkLinkTargetType?: O;
22
31
  targetType: O["apiName"];
23
32
  multiplicity: M;
24
33
  }
@@ -28,7 +37,12 @@ export interface ObjectTypePropertyDefinition {
28
37
  readonly?: boolean;
29
38
  displayName?: string;
30
39
  description?: string;
31
- type: keyof WirePropertyTypes;
40
+ type: WirePropertyTypes;
32
41
  multiplicity?: boolean;
33
42
  nullable?: boolean;
34
43
  }
44
+ export type PropertyDef<T extends WirePropertyTypes, N extends "nullable" | "non-nullable" = "nullable", M extends "array" | "single" = "single", E extends Record<string, any> = {}> = {
45
+ type: T;
46
+ multiplicity: M extends "array" ? true : false;
47
+ nullable: N extends "nullable" ? true : false;
48
+ } & E & ObjectTypePropertyDefinition;
@@ -16,18 +16,8 @@ export type BaseQueryDataTypeDefinition<T extends string> = {
16
16
  nullable?: boolean;
17
17
  type: T;
18
18
  };
19
- export interface WireQueryDataTypes {
20
- double: number;
21
- float: number;
22
- integer: number;
23
- long: number;
24
- boolean: boolean;
25
- string: string;
26
- date: Date;
27
- timestamp: Date;
28
- attachment: any;
29
- }
30
- export type PrimitiveDataType<Q extends keyof WireQueryDataTypes = keyof WireQueryDataTypes> = BaseQueryDataTypeDefinition<Q>;
19
+ export type WireQueryDataTypes = "double" | "float" | "integer" | "long" | "boolean" | "string" | "date" | "timestamp" | "attachment";
20
+ export type PrimitiveDataType<Q extends WireQueryDataTypes = WireQueryDataTypes> = BaseQueryDataTypeDefinition<Q>;
31
21
  export interface ObjectQueryDataType<K extends string> extends BaseQueryDataTypeDefinition<"object"> {
32
22
  object: K;
33
23
  }
@@ -1,20 +1 @@
1
- import type * as GeoJSON from "geojson";
2
- export interface WirePropertyTypes {
3
- string: string;
4
- datetime: string;
5
- double: number;
6
- boolean: boolean;
7
- integer: number;
8
- timestamp: string;
9
- short: number;
10
- long: number;
11
- float: number;
12
- decimal: number;
13
- byte: number;
14
- marking: string;
15
- numericTimeseries: any;
16
- stringTimeseries: any;
17
- attachment: any;
18
- geopoint: GeoJSON.Point;
19
- geoshape: GeoJSON.Geometry;
20
- }
1
+ export type WirePropertyTypes = "string" | "datetime" | "double" | "boolean" | "integer" | "timestamp" | "short" | "long" | "float" | "decimal" | "byte" | "marking" | "numericTimeseries" | "stringTimeseries" | "attachment" | "geopoint" | "geoshape";
@@ -4,5 +4,4 @@ export type { ObjectOrInterfaceDefinition, ObjectOrInterfaceDefinitionFrom, Obje
4
4
  export type { ObjectTypeDefinition, ObjectTypeDefinitionFrom, ObjectTypeKeysFrom as ObjectTypeKeysFrom, ObjectTypeLinkDefinition, ObjectTypeLinkDefinitionFrom, ObjectTypeLinkKeysFrom, ObjectTypeLinkTargetTypeFrom, ObjectTypePropertyDefinition, ObjectTypePropertyDefinitionFrom, ObjectTypePropertyDefinitionsFrom, ObjectTypePropertyKeysFrom, } from "./ObjectTypeDefinition";
5
5
  export type { OntologyDefinition } from "./OntologyDefinition";
6
6
  export type { OntologyMetadata } from "./OntologyMetadata";
7
- export type { AggregationKeyDataType, ObjectQueryDataType, ObjectSetQueryDataType, QueryDataTypeDefinition, QueryDefinition, QueryParameterDefinition, RangeAggregationKeyDataType, SetQueryDataType, SimpleAggregationKeyDataType, StructQueryDataType, ThreeDimensionalAggregationDataType, ThreeDimensionalQueryAggregationDefinition, TwoDimensionalAggregationDataType, TwoDimensionalQueryAggregationDefinition, UnionQueryDataType, WireQueryDataTypes, } from "./QueryDefinition";
8
- export type { WirePropertyTypes } from "./WirePropertyTypes";
7
+ export type { AggregationKeyDataType, ObjectQueryDataType, ObjectSetQueryDataType, QueryDataTypeDefinition, QueryDefinition, QueryParameterDefinition, RangeAggregationKeyDataType, SetQueryDataType, SimpleAggregationKeyDataType, StructQueryDataType, ThreeDimensionalAggregationDataType, ThreeDimensionalQueryAggregationDefinition, TwoDimensionalAggregationDataType, TwoDimensionalQueryAggregationDefinition, UnionQueryDataType, } from "./QueryDefinition";
@@ -0,0 +1,5 @@
1
+ type: improvement
2
+ improvement:
3
+ description: Finish future client types
4
+ links:
5
+ - https://github.com/palantir/osdk-ts/pull/67
@@ -0,0 +1,5 @@
1
+ type: feature
2
+ feature:
3
+ description: Add new client invocation syntax
4
+ links:
5
+ - https://github.com/palantir/osdk-ts/pull/83
@@ -0,0 +1,5 @@
1
+ type: improvement
2
+ improvement:
3
+ description: Add ObjectSet .get(pk) syntax for 2.0
4
+ links:
5
+ - https://github.com/palantir/osdk-ts/pull/88
@@ -0,0 +1,5 @@
1
+ type: improvement
2
+ improvement:
3
+ description: Initial Interfaces Support
4
+ links:
5
+ - https://github.com/palantir/osdk-ts/pull/101
@@ -0,0 +1,5 @@
1
+ type: improvement
2
+ improvement:
3
+ description: Partial interface down selection and conversion to object and back
4
+ links:
5
+ - https://github.com/palantir/osdk-ts/pull/107
@@ -0,0 +1,5 @@
1
+ type: fix
2
+ fix:
3
+ description: Fix long and decimal types to correctly be strings in legacy-client
4
+ links:
5
+ - https://github.com/palantir/osdk-ts/pull/113
@@ -0,0 +1,5 @@
1
+ type: improvement
2
+ improvement:
3
+ description: Bump TS and make writing test network mocks easier
4
+ links:
5
+ - https://github.com/palantir/osdk-ts/pull/120
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@osdk/api",
3
- "version": "1.2.0",
3
+ "version": "1.4.0",
4
4
  "description": "",
5
5
  "access": "public",
6
6
  "license": "Apache-2.0",
@@ -24,12 +24,12 @@
24
24
  "@types/geojson": "^7946.0.13",
25
25
  "fetch-retry": "^5.0.6",
26
26
  "tiny-invariant": "^1.3.1",
27
- "@osdk/gateway": "1.2.0",
28
- "@osdk/shared.net": "1.3.0"
27
+ "@osdk/gateway": "2.0.0",
28
+ "@osdk/shared.net": "1.7.0"
29
29
  },
30
30
  "devDependencies": {
31
31
  "ts-expect": "^1.3.0",
32
- "typescript": "^5.2.2"
32
+ "typescript": "^5.4.2"
33
33
  },
34
34
  "publishConfig": {
35
35
  "access": "public"
@@ -1,3 +0,0 @@
1
- export type OsdkObject<N extends string> = {
2
- __apiName: N;
3
- };