@osdk/api 1.3.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.
- package/build/types/index.d.ts +1 -1
- package/build/types/ontology/ActionDefinition.d.ts +2 -12
- package/build/types/ontology/ObjectTypeDefinition.d.ts +6 -3
- package/build/types/ontology/QueryDefinition.d.ts +2 -12
- package/build/types/ontology/WirePropertyTypes.d.ts +1 -20
- package/build/types/ontology/index.d.ts +1 -2
- package/changelog/1.4.0/pr-101.v2.yml +5 -0
- package/changelog/1.4.0/pr-107.v2.yml +5 -0
- package/changelog/1.4.0/pr-113.v2.yml +5 -0
- package/changelog/1.4.0/pr-120.v2.yml +5 -0
- package/package.json +4 -4
package/build/types/index.d.ts
CHANGED
|
@@ -3,5 +3,5 @@ export type { InterfaceDefinition, InterfaceDefinitionFrom, InterfaceKeysFrom, I
|
|
|
3
3
|
export type { ObjectOrInterfaceDefinition, ObjectOrInterfaceDefinitionFrom, ObjectOrInterfaceKeysFrom, ObjectOrInterfacePropertyKeysFrom, ObjectOrInterfacePropertyKeysFrom2, } from "./ontology/ObjectOrInterface";
|
|
4
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,
|
|
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
|
|
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> =
|
|
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;
|
|
@@ -19,7 +19,10 @@ export interface ObjectInterfaceBaseDefinition<K extends string, N = unknown> {
|
|
|
19
19
|
export interface ObjectTypeDefinition<K extends string, N = unknown> extends ObjectInterfaceBaseDefinition<K, N> {
|
|
20
20
|
type: "object";
|
|
21
21
|
primaryKeyApiName: keyof this["properties"];
|
|
22
|
-
primaryKeyType:
|
|
22
|
+
primaryKeyType: WirePropertyTypes;
|
|
23
|
+
implements?: string[];
|
|
24
|
+
spts?: Record<string, string>;
|
|
25
|
+
inverseSpts?: Record<string, string>;
|
|
23
26
|
}
|
|
24
27
|
export type ObjectTypeLinkKeysFrom<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>> = keyof ObjectTypeDefinitionFrom<O, K>["links"];
|
|
25
28
|
export type ObjectTypeLinkKeysFrom2<O extends ObjectTypeDefinition<any>> = keyof O["links"] & string;
|
|
@@ -34,11 +37,11 @@ export interface ObjectTypePropertyDefinition {
|
|
|
34
37
|
readonly?: boolean;
|
|
35
38
|
displayName?: string;
|
|
36
39
|
description?: string;
|
|
37
|
-
type:
|
|
40
|
+
type: WirePropertyTypes;
|
|
38
41
|
multiplicity?: boolean;
|
|
39
42
|
nullable?: boolean;
|
|
40
43
|
}
|
|
41
|
-
export type PropertyDef<T extends
|
|
44
|
+
export type PropertyDef<T extends WirePropertyTypes, N extends "nullable" | "non-nullable" = "nullable", M extends "array" | "single" = "single", E extends Record<string, any> = {}> = {
|
|
42
45
|
type: T;
|
|
43
46
|
multiplicity: M extends "array" ? true : false;
|
|
44
47
|
nullable: N extends "nullable" ? true : false;
|
|
@@ -16,18 +16,8 @@ export type BaseQueryDataTypeDefinition<T extends string> = {
|
|
|
16
16
|
nullable?: boolean;
|
|
17
17
|
type: T;
|
|
18
18
|
};
|
|
19
|
-
export
|
|
20
|
-
|
|
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
|
-
|
|
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,
|
|
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";
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@osdk/api",
|
|
3
|
-
"version": "1.
|
|
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": "
|
|
28
|
-
"@osdk/shared.net": "1.
|
|
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.
|
|
32
|
+
"typescript": "^5.4.2"
|
|
33
33
|
},
|
|
34
34
|
"publishConfig": {
|
|
35
35
|
"access": "public"
|