@osdk/api 1.1.0 → 1.1.1

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,14 @@
1
1
  # @osdk/api
2
2
 
3
+ ## 1.1.1
4
+
5
+ ### Patch Changes
6
+
7
+ - e1a94f22: Revert change to how we generate the built package types
8
+ - Updated dependencies [e1a94f22]
9
+ - @osdk/shared.net@1.1.1
10
+ - @osdk/gateway@1.1.1
11
+
3
12
  ## 1.1.0
4
13
 
5
14
  ### Minor Changes
@@ -0,0 +1,7 @@
1
+ export type { ActionDefinition, ActionModifiedEntity, ActionParameterDefinition, ObjectActionDataType, ObjectSetActionDataType, ValidActionParameterTypes, } from "./ontology/ActionDefinition";
2
+ export type { InterfaceDefinition, InterfaceDefinitionFrom, InterfaceKeysFrom, InterfacePropertyDefinitionFrom, InterfacePropertyDefinitionsFrom, InterfacePropertyKeysFrom, } from "./ontology/InterfaceDefinition";
3
+ export type { ObjectOrInterfaceDefinition, ObjectOrInterfaceDefinitionFrom, ObjectOrInterfaceKeysFrom, ObjectOrInterfacePropertyKeysFrom, } from "./ontology/ObjectOrInterface";
4
+ export type { ObjectTypeDefinition, ObjectTypeDefinitionFrom, ObjectTypeKeysFrom, ObjectTypeLinkDefinition, ObjectTypeLinkDefinitionFrom, ObjectTypeLinkKeysFrom, ObjectTypeLinkTargetTypeFrom, ObjectTypePropertyDefinition, ObjectTypePropertyDefinitionFrom, ObjectTypePropertyDefinitionsFrom, ObjectTypePropertyKeysFrom, } from "./ontology/ObjectTypeDefinition";
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";
7
+ export type { WirePropertyTypes } from "./ontology/WirePropertyTypes";
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,36 @@
1
+ export interface ActionDefinition<A extends string, K extends string> {
2
+ apiName: A;
3
+ description?: string;
4
+ displayName?: string;
5
+ parameters: Record<string, ActionParameterDefinition<K>>;
6
+ modifiedEntities?: Partial<Record<K, ActionModifiedEntity>>;
7
+ }
8
+ export interface ActionModifiedEntity {
9
+ created: boolean;
10
+ modified: boolean;
11
+ }
12
+ export interface ValidBaseActionParameterTypes {
13
+ boolean: boolean;
14
+ string: string;
15
+ integer: number;
16
+ long: number;
17
+ double: number;
18
+ datetime: Date;
19
+ timestamp: Date;
20
+ attachment: any;
21
+ }
22
+ export interface ObjectActionDataType<K extends string> {
23
+ type: "object";
24
+ object: K;
25
+ }
26
+ export interface ObjectSetActionDataType<K extends string> {
27
+ type: "objectSet";
28
+ objectSet: K;
29
+ }
30
+ export type ValidActionParameterTypes<K extends string = never> = keyof ValidBaseActionParameterTypes | ObjectActionDataType<K> | ObjectSetActionDataType<K>;
31
+ export interface ActionParameterDefinition<K extends string = never> {
32
+ type: ValidActionParameterTypes<K>;
33
+ description?: string;
34
+ multiplicity?: boolean;
35
+ nullable?: boolean;
36
+ }
@@ -0,0 +1,12 @@
1
+ import type { ObjectTypePropertyDefinition } from "./ObjectTypeDefinition";
2
+ import type { OntologyDefinition } from "./OntologyDefinition";
3
+ export type InterfaceDefinitionFrom<O extends OntologyDefinition<any>, K extends InterfaceKeysFrom<O>> = O["interfaces"] extends {} ? O["interfaces"][K] : never;
4
+ export type InterfaceKeysFrom<O extends OntologyDefinition<string>> = keyof O["interfaces"];
5
+ export type InterfacePropertyKeysFrom<O extends OntologyDefinition<any>, K extends InterfaceKeysFrom<O>> = keyof InterfaceDefinitionFrom<O, K>["properties"] & string;
6
+ export type InterfacePropertyDefinitionsFrom<O extends OntologyDefinition<any>, K extends InterfaceKeysFrom<O>> = InterfaceDefinitionFrom<O, K>["properties"];
7
+ export type InterfacePropertyDefinitionFrom<O extends OntologyDefinition<any>, K extends InterfaceKeysFrom<O>, P extends InterfacePropertyKeysFrom<O, K>> = InterfacePropertyDefinitionsFrom<O, K>[P];
8
+ export interface InterfaceDefinition<K extends string, _L extends string> {
9
+ apiName: K;
10
+ description?: string;
11
+ properties: Record<string, ObjectTypePropertyDefinition>;
12
+ }
@@ -0,0 +1,7 @@
1
+ import type { InterfaceDefinition, InterfaceDefinitionFrom, InterfaceKeysFrom, InterfacePropertyKeysFrom } from "./InterfaceDefinition";
2
+ import type { ObjectTypeDefinition, ObjectTypeDefinitionFrom, ObjectTypeKeysFrom, ObjectTypePropertyKeysFrom } from "./ObjectTypeDefinition";
3
+ import type { OntologyDefinition } from "./OntologyDefinition";
4
+ export type ObjectOrInterfaceKeysFrom<O extends OntologyDefinition<any, any>> = ObjectTypeKeysFrom<O> | InterfaceKeysFrom<O>;
5
+ export type ObjectOrInterfaceDefinition<K extends string, L extends string> = ObjectTypeDefinition<K, L> | InterfaceDefinition<K, L>;
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 ObjectOrInterfaceDefinitionFrom<O extends OntologyDefinition<any, any>, K extends ObjectOrInterfaceKeysFrom<O>> = K extends InterfaceKeysFrom<O> ? InterfaceDefinitionFrom<O, K> : ObjectTypeDefinitionFrom<O, K>;
@@ -0,0 +1,29 @@
1
+ import type { OntologyDefinition } from "./OntologyDefinition";
2
+ import type { WirePropertyTypes } from "./WirePropertyTypes";
3
+ export type ObjectTypeDefinitionFrom<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>> = O["objects"][K];
4
+ export type ObjectTypeKeysFrom<O extends OntologyDefinition<string>> = keyof O["objects"];
5
+ export type ObjectTypePropertyKeysFrom<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>> = keyof ObjectTypeDefinitionFrom<O, K>["properties"] & string;
6
+ export type ObjectTypePropertyDefinitionsFrom<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>> = ObjectTypeDefinitionFrom<O, K>["properties"];
7
+ export type ObjectTypePropertyDefinitionFrom<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>, P extends ObjectTypePropertyKeysFrom<O, K>> = ObjectTypePropertyDefinitionsFrom<O, K>[P];
8
+ export interface ObjectTypeDefinition<K extends string, L extends string> {
9
+ apiName: K;
10
+ description?: string;
11
+ primaryKeyType: keyof WirePropertyTypes;
12
+ properties: Record<string, ObjectTypePropertyDefinition>;
13
+ links: Record<string, ObjectTypeLinkDefinition<L>>;
14
+ }
15
+ export type ObjectTypeLinkKeysFrom<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>> = keyof ObjectTypeDefinitionFrom<O, K>["links"];
16
+ export interface ObjectTypeLinkDefinition<K extends string> {
17
+ targetType: K;
18
+ multiplicity: boolean;
19
+ }
20
+ export type ObjectTypeLinkDefinitionFrom<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>, L extends ObjectTypeLinkKeysFrom<O, K>> = ObjectTypeDefinitionFrom<O, K>["links"][L];
21
+ export type ObjectTypeLinkTargetTypeFrom<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>, L extends ObjectTypeLinkKeysFrom<O, K>> = ObjectTypeLinkDefinitionFrom<O, K, L>["targetType"];
22
+ export interface ObjectTypePropertyDefinition {
23
+ readonly?: boolean;
24
+ displayName?: string;
25
+ description?: string;
26
+ type: keyof WirePropertyTypes;
27
+ multiplicity?: boolean;
28
+ nullable?: boolean;
29
+ }
@@ -0,0 +1,20 @@
1
+ import type { ActionDefinition } from "./ActionDefinition";
2
+ import type { InterfaceDefinition } from "./InterfaceDefinition";
3
+ import type { ObjectTypeDefinition } from "./ObjectTypeDefinition";
4
+ import type { OntologyMetadata } from "./OntologyMetadata";
5
+ import type { QueryDefinition } from "./QueryDefinition";
6
+ export interface OntologyDefinition<K extends string, A extends string = any, Q extends string = any, I extends string = any> {
7
+ metadata: OntologyMetadata;
8
+ objects: {
9
+ [KK in K]: ObjectTypeDefinition<KK, K>;
10
+ };
11
+ actions: {
12
+ [AA in A]: ActionDefinition<AA, K>;
13
+ };
14
+ queries: {
15
+ [QQ in Q]: QueryDefinition<QQ, K>;
16
+ };
17
+ interfaces?: {
18
+ [II in I]: InterfaceDefinition<II, K>;
19
+ };
20
+ }
@@ -0,0 +1,5 @@
1
+ export interface OntologyMetadata {
2
+ ontologyRid: string;
3
+ ontologyApiName: string;
4
+ userAgent: string;
5
+ }
@@ -0,0 +1,3 @@
1
+ export type OsdkObject<N extends string> = {
2
+ __apiName: N;
3
+ };
@@ -0,0 +1,62 @@
1
+ export interface QueryDefinition<Q extends string, K extends string> {
2
+ apiName: Q;
3
+ description?: string;
4
+ displayName?: string;
5
+ version: string;
6
+ parameters: Record<string, QueryParameterDefinition<K>>;
7
+ output: QueryDataTypeDefinition<K>;
8
+ }
9
+ export type QueryParameterDefinition<K extends string> = {
10
+ description?: string;
11
+ } & QueryDataTypeDefinition<K>;
12
+ export type QueryDataTypeDefinition<K extends string> = PrimitiveDataType | ObjectQueryDataType<K> | ObjectSetQueryDataType<K> | SetQueryDataType<K> | UnionQueryDataType<K> | StructQueryDataType<K> | TwoDimensionalAggregationDataType | ThreeDimensionalAggregationDataType;
13
+ export type BaseQueryDataTypeDefinition<T extends string> = {
14
+ multiplicity?: boolean;
15
+ nullable?: boolean;
16
+ type: T;
17
+ };
18
+ export interface WireQueryDataTypes {
19
+ double: number;
20
+ float: number;
21
+ integer: number;
22
+ long: number;
23
+ boolean: boolean;
24
+ string: string;
25
+ date: Date;
26
+ timestamp: Date;
27
+ attachment: any;
28
+ }
29
+ export type PrimitiveDataType<Q extends keyof WireQueryDataTypes = keyof WireQueryDataTypes> = BaseQueryDataTypeDefinition<Q>;
30
+ export interface ObjectQueryDataType<K extends string> extends BaseQueryDataTypeDefinition<"object"> {
31
+ object: K;
32
+ }
33
+ export interface ObjectSetQueryDataType<K extends string> extends BaseQueryDataTypeDefinition<"objectSet"> {
34
+ objectSet: K;
35
+ }
36
+ export interface SetQueryDataType<K extends string> extends BaseQueryDataTypeDefinition<"set"> {
37
+ set: QueryDataTypeDefinition<K>;
38
+ }
39
+ export interface UnionQueryDataType<K extends string> extends BaseQueryDataTypeDefinition<"union"> {
40
+ union: ReadonlyArray<QueryDataTypeDefinition<K>>;
41
+ }
42
+ export interface StructQueryDataType<K extends string> extends BaseQueryDataTypeDefinition<"struct"> {
43
+ struct: Record<string, QueryDataTypeDefinition<K>>;
44
+ }
45
+ export interface TwoDimensionalAggregationDataType extends BaseQueryDataTypeDefinition<"twoDimensionalAggregation"> {
46
+ twoDimensionalAggregation: TwoDimensionalQueryAggregationDefinition;
47
+ }
48
+ export interface ThreeDimensionalAggregationDataType extends BaseQueryDataTypeDefinition<"threeDimensionalAggregation"> {
49
+ threeDimensionalAggregation: ThreeDimensionalQueryAggregationDefinition;
50
+ }
51
+ export type AggregationKeyDataType<V = any> = SimpleAggregationKeyDataType<V> | RangeAggregationKeyDataType<V>;
52
+ export interface SimpleAggregationKeyDataType<V = any> {
53
+ keyType: "boolean" | "string";
54
+ valueType: V;
55
+ }
56
+ export interface RangeAggregationKeyDataType<V = any> {
57
+ keyType: "range";
58
+ keySubtype: "date" | "double" | "integer" | "timestamp";
59
+ valueType: V;
60
+ }
61
+ export type TwoDimensionalQueryAggregationDefinition = AggregationKeyDataType<"date" | "double" | "timestamp">;
62
+ export type ThreeDimensionalQueryAggregationDefinition = AggregationKeyDataType<TwoDimensionalQueryAggregationDefinition>;
@@ -0,0 +1,19 @@
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
+ numericTimeseries: any;
15
+ stringTimeseries: any;
16
+ attachment: any;
17
+ geopoint: GeoJSON.Point;
18
+ geoshape: GeoJSON.Geometry;
19
+ }
@@ -0,0 +1,8 @@
1
+ export type { ActionDefinition, ActionModifiedEntity, ActionParameterDefinition, ObjectActionDataType, ObjectSetActionDataType, ValidActionParameterTypes, ValidBaseActionParameterTypes, } from "./ActionDefinition";
2
+ export type { InterfaceDefinition, InterfaceDefinitionFrom, InterfaceKeysFrom, InterfacePropertyDefinitionFrom, InterfacePropertyDefinitionsFrom, InterfacePropertyKeysFrom, } from "./InterfaceDefinition";
3
+ export type { ObjectOrInterfaceDefinition, ObjectOrInterfaceDefinitionFrom, ObjectOrInterfaceKeysFrom, ObjectOrInterfacePropertyKeysFrom, } from "./ObjectOrInterface";
4
+ export type { ObjectTypeDefinition, ObjectTypeDefinitionFrom, ObjectTypeKeysFrom as ObjectTypeKeysFrom, ObjectTypeLinkDefinition, ObjectTypeLinkDefinitionFrom, ObjectTypeLinkKeysFrom, ObjectTypeLinkTargetTypeFrom, ObjectTypePropertyDefinition, ObjectTypePropertyDefinitionFrom, ObjectTypePropertyDefinitionsFrom, ObjectTypePropertyKeysFrom, } from "./ObjectTypeDefinition";
5
+ export type { OntologyDefinition } from "./OntologyDefinition";
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";
package/package.json CHANGED
@@ -1,37 +1,27 @@
1
1
  {
2
2
  "name": "@osdk/api",
3
- "version": "1.1.0",
3
+ "version": "1.1.1",
4
4
  "description": "",
5
5
  "access": "public",
6
6
  "license": "Apache-2.0",
7
7
  "exports": {
8
8
  ".": {
9
- "import": {
10
- "types": "./build/esm/index.d.ts",
11
- "default": "./build/esm/index.mjs"
12
- },
13
- "require": {
14
- "types": "./build/cjs/index.d.cts",
15
- "default": "./build/cjs/index.js"
16
- }
9
+ "types": "./build/types/index.d.ts",
10
+ "import": "./build/js/index.mjs",
11
+ "require": "./build/js/index.js"
17
12
  },
18
13
  "./*": {
19
- "import": {
20
- "types": "./build/esm/public/*.d.ts",
21
- "default": "./build/esm/public/*.mjs"
22
- },
23
- "require": {
24
- "types": "./build/cjs/public/*.d.cts",
25
- "default": "./build/cjs/public/*.js"
26
- }
14
+ "types": "./build/types/public/*.d.ts",
15
+ "import": "./build/js/public/*.mjs",
16
+ "require": "./build/js/public/*.js"
27
17
  }
28
18
  },
29
19
  "dependencies": {
30
20
  "@types/geojson": "^7946.0.13",
31
21
  "fetch-retry": "^5.0.6",
32
22
  "tiny-invariant": "^1.3.1",
33
- "@osdk/gateway": "1.1.0",
34
- "@osdk/shared.net": "1.1.0"
23
+ "@osdk/gateway": "1.1.1",
24
+ "@osdk/shared.net": "1.1.1"
35
25
  },
36
26
  "devDependencies": {
37
27
  "ts-expect": "^1.3.0",
@@ -42,23 +32,21 @@
42
32
  },
43
33
  "keywords": [],
44
34
  "files": [
45
- "build/cjs",
46
- "build/esm",
35
+ "build/types",
36
+ "build/js",
47
37
  "CHANGELOG.md",
48
38
  "package.json",
49
39
  "*.d.ts"
50
40
  ],
51
- "main": "./build/cjs/index.js",
52
- "module": "./build/esm/index.mjs",
53
- "types": "./build/cjs/index.d.cts",
54
- "type": "module",
41
+ "main": "./build/js/index.js",
42
+ "module": "./build/js/index.mjs",
43
+ "types": "./build/types/index.d.ts",
55
44
  "scripts": {
56
45
  "clean": "rm -rf lib dist types build tsconfig.tsbuildinfo",
57
46
  "dev:transpile": "tsup --watch",
58
47
  "fix-lint": "eslint . --fix && dprint fmt --config $(find-up dprint.json)",
59
48
  "lint": "eslint . && dprint check --config $(find-up dprint.json)",
60
49
  "test": "vitest run",
61
- "test:package-types": "if [ -d src/public ]; then ls src/public | sed -e 's/\\(.*\\).ts/--include-entrypoints=\\1/' | xargs pnpm attw --pack .; else pnpm attw --pack .; fi",
62
50
  "test:watch": "vitest",
63
51
  "transpile": "tsup",
64
52
  "transpileWatch": "tsup --watch",
@@ -1,188 +0,0 @@
1
- import * as GeoJSON from 'geojson';
2
-
3
- interface ActionDefinition<A extends string, K extends string> {
4
- apiName: A;
5
- description?: string;
6
- displayName?: string;
7
- parameters: Record<string, ActionParameterDefinition<K>>;
8
- modifiedEntities?: Partial<Record<K, ActionModifiedEntity>>;
9
- }
10
- interface ActionModifiedEntity {
11
- created: boolean;
12
- modified: boolean;
13
- }
14
- interface ValidBaseActionParameterTypes {
15
- boolean: boolean;
16
- string: string;
17
- integer: number;
18
- long: number;
19
- double: number;
20
- datetime: Date;
21
- timestamp: Date;
22
- attachment: any;
23
- }
24
- interface ObjectActionDataType<K extends string> {
25
- type: "object";
26
- object: K;
27
- }
28
- interface ObjectSetActionDataType<K extends string> {
29
- type: "objectSet";
30
- objectSet: K;
31
- }
32
- type ValidActionParameterTypes<K extends string = never> = keyof ValidBaseActionParameterTypes | ObjectActionDataType<K> | ObjectSetActionDataType<K>;
33
- interface ActionParameterDefinition<K extends string = never> {
34
- type: ValidActionParameterTypes<K>;
35
- description?: string;
36
- multiplicity?: boolean;
37
- nullable?: boolean;
38
- }
39
-
40
- interface OntologyMetadata {
41
- ontologyRid: string;
42
- ontologyApiName: string;
43
- userAgent: string;
44
- }
45
-
46
- interface QueryDefinition<Q extends string, K extends string> {
47
- apiName: Q;
48
- description?: string;
49
- displayName?: string;
50
- version: string;
51
- parameters: Record<string, QueryParameterDefinition<K>>;
52
- output: QueryDataTypeDefinition<K>;
53
- }
54
- type QueryParameterDefinition<K extends string> = {
55
- description?: string;
56
- } & QueryDataTypeDefinition<K>;
57
- type QueryDataTypeDefinition<K extends string> = PrimitiveDataType | ObjectQueryDataType<K> | ObjectSetQueryDataType<K> | SetQueryDataType<K> | UnionQueryDataType<K> | StructQueryDataType<K> | TwoDimensionalAggregationDataType | ThreeDimensionalAggregationDataType;
58
- type BaseQueryDataTypeDefinition<T extends string> = {
59
- multiplicity?: boolean;
60
- nullable?: boolean;
61
- type: T;
62
- };
63
- interface WireQueryDataTypes {
64
- double: number;
65
- float: number;
66
- integer: number;
67
- long: number;
68
- boolean: boolean;
69
- string: string;
70
- date: Date;
71
- timestamp: Date;
72
- attachment: any;
73
- }
74
- type PrimitiveDataType<Q extends keyof WireQueryDataTypes = keyof WireQueryDataTypes> = BaseQueryDataTypeDefinition<Q>;
75
- interface ObjectQueryDataType<K extends string> extends BaseQueryDataTypeDefinition<"object"> {
76
- object: K;
77
- }
78
- interface ObjectSetQueryDataType<K extends string> extends BaseQueryDataTypeDefinition<"objectSet"> {
79
- objectSet: K;
80
- }
81
- interface SetQueryDataType<K extends string> extends BaseQueryDataTypeDefinition<"set"> {
82
- set: QueryDataTypeDefinition<K>;
83
- }
84
- interface UnionQueryDataType<K extends string> extends BaseQueryDataTypeDefinition<"union"> {
85
- union: ReadonlyArray<QueryDataTypeDefinition<K>>;
86
- }
87
- interface StructQueryDataType<K extends string> extends BaseQueryDataTypeDefinition<"struct"> {
88
- struct: Record<string, QueryDataTypeDefinition<K>>;
89
- }
90
- interface TwoDimensionalAggregationDataType extends BaseQueryDataTypeDefinition<"twoDimensionalAggregation"> {
91
- twoDimensionalAggregation: TwoDimensionalQueryAggregationDefinition;
92
- }
93
- interface ThreeDimensionalAggregationDataType extends BaseQueryDataTypeDefinition<"threeDimensionalAggregation"> {
94
- threeDimensionalAggregation: ThreeDimensionalQueryAggregationDefinition;
95
- }
96
- type AggregationKeyDataType<V = any> = SimpleAggregationKeyDataType<V> | RangeAggregationKeyDataType<V>;
97
- interface SimpleAggregationKeyDataType<V = any> {
98
- keyType: "boolean" | "string";
99
- valueType: V;
100
- }
101
- interface RangeAggregationKeyDataType<V = any> {
102
- keyType: "range";
103
- keySubtype: "date" | "double" | "integer" | "timestamp";
104
- valueType: V;
105
- }
106
- type TwoDimensionalQueryAggregationDefinition = AggregationKeyDataType<"date" | "double" | "timestamp">;
107
- type ThreeDimensionalQueryAggregationDefinition = AggregationKeyDataType<TwoDimensionalQueryAggregationDefinition>;
108
-
109
- interface OntologyDefinition<K extends string, A extends string = any, Q extends string = any, I extends string = any> {
110
- metadata: OntologyMetadata;
111
- objects: {
112
- [KK in K]: ObjectTypeDefinition<KK, K>;
113
- };
114
- actions: {
115
- [AA in A]: ActionDefinition<AA, K>;
116
- };
117
- queries: {
118
- [QQ in Q]: QueryDefinition<QQ, K>;
119
- };
120
- interfaces?: {
121
- [II in I]: InterfaceDefinition<II, K>;
122
- };
123
- }
124
-
125
- interface WirePropertyTypes {
126
- string: string;
127
- datetime: string;
128
- double: number;
129
- boolean: boolean;
130
- integer: number;
131
- timestamp: string;
132
- short: number;
133
- long: number;
134
- float: number;
135
- decimal: number;
136
- byte: number;
137
- numericTimeseries: any;
138
- stringTimeseries: any;
139
- attachment: any;
140
- geopoint: GeoJSON.Point;
141
- geoshape: GeoJSON.Geometry;
142
- }
143
-
144
- type ObjectTypeDefinitionFrom<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>> = O["objects"][K];
145
- type ObjectTypeKeysFrom<O extends OntologyDefinition<string>> = keyof O["objects"];
146
- type ObjectTypePropertyKeysFrom<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>> = keyof ObjectTypeDefinitionFrom<O, K>["properties"] & string;
147
- type ObjectTypePropertyDefinitionsFrom<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>> = ObjectTypeDefinitionFrom<O, K>["properties"];
148
- type ObjectTypePropertyDefinitionFrom<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>, P extends ObjectTypePropertyKeysFrom<O, K>> = ObjectTypePropertyDefinitionsFrom<O, K>[P];
149
- interface ObjectTypeDefinition<K extends string, L extends string> {
150
- apiName: K;
151
- description?: string;
152
- primaryKeyType: keyof WirePropertyTypes;
153
- properties: Record<string, ObjectTypePropertyDefinition>;
154
- links: Record<string, ObjectTypeLinkDefinition<L>>;
155
- }
156
- type ObjectTypeLinkKeysFrom<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>> = keyof ObjectTypeDefinitionFrom<O, K>["links"];
157
- interface ObjectTypeLinkDefinition<K extends string> {
158
- targetType: K;
159
- multiplicity: boolean;
160
- }
161
- type ObjectTypeLinkDefinitionFrom<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>, L extends ObjectTypeLinkKeysFrom<O, K>> = ObjectTypeDefinitionFrom<O, K>["links"][L];
162
- type ObjectTypeLinkTargetTypeFrom<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>, L extends ObjectTypeLinkKeysFrom<O, K>> = ObjectTypeLinkDefinitionFrom<O, K, L>["targetType"];
163
- interface ObjectTypePropertyDefinition {
164
- readonly?: boolean;
165
- displayName?: string;
166
- description?: string;
167
- type: keyof WirePropertyTypes;
168
- multiplicity?: boolean;
169
- nullable?: boolean;
170
- }
171
-
172
- type InterfaceDefinitionFrom<O extends OntologyDefinition<any>, K extends InterfaceKeysFrom<O>> = O["interfaces"] extends {} ? O["interfaces"][K] : never;
173
- type InterfaceKeysFrom<O extends OntologyDefinition<string>> = keyof O["interfaces"];
174
- type InterfacePropertyKeysFrom<O extends OntologyDefinition<any>, K extends InterfaceKeysFrom<O>> = keyof InterfaceDefinitionFrom<O, K>["properties"] & string;
175
- type InterfacePropertyDefinitionsFrom<O extends OntologyDefinition<any>, K extends InterfaceKeysFrom<O>> = InterfaceDefinitionFrom<O, K>["properties"];
176
- type InterfacePropertyDefinitionFrom<O extends OntologyDefinition<any>, K extends InterfaceKeysFrom<O>, P extends InterfacePropertyKeysFrom<O, K>> = InterfacePropertyDefinitionsFrom<O, K>[P];
177
- interface InterfaceDefinition<K extends string, _L extends string> {
178
- apiName: K;
179
- description?: string;
180
- properties: Record<string, ObjectTypePropertyDefinition>;
181
- }
182
-
183
- type ObjectOrInterfaceKeysFrom<O extends OntologyDefinition<any, any>> = ObjectTypeKeysFrom<O> | InterfaceKeysFrom<O>;
184
- type ObjectOrInterfaceDefinition<K extends string, L extends string> = ObjectTypeDefinition<K, L> | InterfaceDefinition<K, L>;
185
- type ObjectOrInterfacePropertyKeysFrom<O extends OntologyDefinition<any, any>, K extends ObjectOrInterfaceKeysFrom<O>> = K extends InterfaceKeysFrom<O> ? InterfacePropertyKeysFrom<O, K> : ObjectTypePropertyKeysFrom<O, K>;
186
- type ObjectOrInterfaceDefinitionFrom<O extends OntologyDefinition<any, any>, K extends ObjectOrInterfaceKeysFrom<O>> = K extends InterfaceKeysFrom<O> ? InterfaceDefinitionFrom<O, K> : ObjectTypeDefinitionFrom<O, K>;
187
-
188
- export type { ActionDefinition, ActionModifiedEntity, ActionParameterDefinition, AggregationKeyDataType, InterfaceDefinition, InterfaceDefinitionFrom, InterfaceKeysFrom, InterfacePropertyDefinitionFrom, InterfacePropertyDefinitionsFrom, InterfacePropertyKeysFrom, ObjectActionDataType, ObjectOrInterfaceDefinition, ObjectOrInterfaceDefinitionFrom, ObjectOrInterfaceKeysFrom, ObjectOrInterfacePropertyKeysFrom, ObjectQueryDataType, ObjectSetActionDataType, ObjectSetQueryDataType, ObjectTypeDefinition, ObjectTypeDefinitionFrom, ObjectTypeKeysFrom, ObjectTypeLinkDefinition, ObjectTypeLinkDefinitionFrom, ObjectTypeLinkKeysFrom, ObjectTypeLinkTargetTypeFrom, ObjectTypePropertyDefinition, ObjectTypePropertyDefinitionFrom, ObjectTypePropertyDefinitionsFrom, ObjectTypePropertyKeysFrom, OntologyDefinition, PrimitiveDataType, QueryDataTypeDefinition, QueryDefinition, QueryParameterDefinition, RangeAggregationKeyDataType, SetQueryDataType, SimpleAggregationKeyDataType, StructQueryDataType, ThreeDimensionalAggregationDataType, ThreeDimensionalQueryAggregationDefinition, TwoDimensionalAggregationDataType, TwoDimensionalQueryAggregationDefinition, UnionQueryDataType, ValidActionParameterTypes, WirePropertyTypes, WireQueryDataTypes };
@@ -1 +0,0 @@
1
- {"type": "commonjs"}
@@ -1,188 +0,0 @@
1
- import * as GeoJSON from 'geojson';
2
-
3
- interface ActionDefinition<A extends string, K extends string> {
4
- apiName: A;
5
- description?: string;
6
- displayName?: string;
7
- parameters: Record<string, ActionParameterDefinition<K>>;
8
- modifiedEntities?: Partial<Record<K, ActionModifiedEntity>>;
9
- }
10
- interface ActionModifiedEntity {
11
- created: boolean;
12
- modified: boolean;
13
- }
14
- interface ValidBaseActionParameterTypes {
15
- boolean: boolean;
16
- string: string;
17
- integer: number;
18
- long: number;
19
- double: number;
20
- datetime: Date;
21
- timestamp: Date;
22
- attachment: any;
23
- }
24
- interface ObjectActionDataType<K extends string> {
25
- type: "object";
26
- object: K;
27
- }
28
- interface ObjectSetActionDataType<K extends string> {
29
- type: "objectSet";
30
- objectSet: K;
31
- }
32
- type ValidActionParameterTypes<K extends string = never> = keyof ValidBaseActionParameterTypes | ObjectActionDataType<K> | ObjectSetActionDataType<K>;
33
- interface ActionParameterDefinition<K extends string = never> {
34
- type: ValidActionParameterTypes<K>;
35
- description?: string;
36
- multiplicity?: boolean;
37
- nullable?: boolean;
38
- }
39
-
40
- interface OntologyMetadata {
41
- ontologyRid: string;
42
- ontologyApiName: string;
43
- userAgent: string;
44
- }
45
-
46
- interface QueryDefinition<Q extends string, K extends string> {
47
- apiName: Q;
48
- description?: string;
49
- displayName?: string;
50
- version: string;
51
- parameters: Record<string, QueryParameterDefinition<K>>;
52
- output: QueryDataTypeDefinition<K>;
53
- }
54
- type QueryParameterDefinition<K extends string> = {
55
- description?: string;
56
- } & QueryDataTypeDefinition<K>;
57
- type QueryDataTypeDefinition<K extends string> = PrimitiveDataType | ObjectQueryDataType<K> | ObjectSetQueryDataType<K> | SetQueryDataType<K> | UnionQueryDataType<K> | StructQueryDataType<K> | TwoDimensionalAggregationDataType | ThreeDimensionalAggregationDataType;
58
- type BaseQueryDataTypeDefinition<T extends string> = {
59
- multiplicity?: boolean;
60
- nullable?: boolean;
61
- type: T;
62
- };
63
- interface WireQueryDataTypes {
64
- double: number;
65
- float: number;
66
- integer: number;
67
- long: number;
68
- boolean: boolean;
69
- string: string;
70
- date: Date;
71
- timestamp: Date;
72
- attachment: any;
73
- }
74
- type PrimitiveDataType<Q extends keyof WireQueryDataTypes = keyof WireQueryDataTypes> = BaseQueryDataTypeDefinition<Q>;
75
- interface ObjectQueryDataType<K extends string> extends BaseQueryDataTypeDefinition<"object"> {
76
- object: K;
77
- }
78
- interface ObjectSetQueryDataType<K extends string> extends BaseQueryDataTypeDefinition<"objectSet"> {
79
- objectSet: K;
80
- }
81
- interface SetQueryDataType<K extends string> extends BaseQueryDataTypeDefinition<"set"> {
82
- set: QueryDataTypeDefinition<K>;
83
- }
84
- interface UnionQueryDataType<K extends string> extends BaseQueryDataTypeDefinition<"union"> {
85
- union: ReadonlyArray<QueryDataTypeDefinition<K>>;
86
- }
87
- interface StructQueryDataType<K extends string> extends BaseQueryDataTypeDefinition<"struct"> {
88
- struct: Record<string, QueryDataTypeDefinition<K>>;
89
- }
90
- interface TwoDimensionalAggregationDataType extends BaseQueryDataTypeDefinition<"twoDimensionalAggregation"> {
91
- twoDimensionalAggregation: TwoDimensionalQueryAggregationDefinition;
92
- }
93
- interface ThreeDimensionalAggregationDataType extends BaseQueryDataTypeDefinition<"threeDimensionalAggregation"> {
94
- threeDimensionalAggregation: ThreeDimensionalQueryAggregationDefinition;
95
- }
96
- type AggregationKeyDataType<V = any> = SimpleAggregationKeyDataType<V> | RangeAggregationKeyDataType<V>;
97
- interface SimpleAggregationKeyDataType<V = any> {
98
- keyType: "boolean" | "string";
99
- valueType: V;
100
- }
101
- interface RangeAggregationKeyDataType<V = any> {
102
- keyType: "range";
103
- keySubtype: "date" | "double" | "integer" | "timestamp";
104
- valueType: V;
105
- }
106
- type TwoDimensionalQueryAggregationDefinition = AggregationKeyDataType<"date" | "double" | "timestamp">;
107
- type ThreeDimensionalQueryAggregationDefinition = AggregationKeyDataType<TwoDimensionalQueryAggregationDefinition>;
108
-
109
- interface OntologyDefinition<K extends string, A extends string = any, Q extends string = any, I extends string = any> {
110
- metadata: OntologyMetadata;
111
- objects: {
112
- [KK in K]: ObjectTypeDefinition<KK, K>;
113
- };
114
- actions: {
115
- [AA in A]: ActionDefinition<AA, K>;
116
- };
117
- queries: {
118
- [QQ in Q]: QueryDefinition<QQ, K>;
119
- };
120
- interfaces?: {
121
- [II in I]: InterfaceDefinition<II, K>;
122
- };
123
- }
124
-
125
- interface WirePropertyTypes {
126
- string: string;
127
- datetime: string;
128
- double: number;
129
- boolean: boolean;
130
- integer: number;
131
- timestamp: string;
132
- short: number;
133
- long: number;
134
- float: number;
135
- decimal: number;
136
- byte: number;
137
- numericTimeseries: any;
138
- stringTimeseries: any;
139
- attachment: any;
140
- geopoint: GeoJSON.Point;
141
- geoshape: GeoJSON.Geometry;
142
- }
143
-
144
- type ObjectTypeDefinitionFrom<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>> = O["objects"][K];
145
- type ObjectTypeKeysFrom<O extends OntologyDefinition<string>> = keyof O["objects"];
146
- type ObjectTypePropertyKeysFrom<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>> = keyof ObjectTypeDefinitionFrom<O, K>["properties"] & string;
147
- type ObjectTypePropertyDefinitionsFrom<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>> = ObjectTypeDefinitionFrom<O, K>["properties"];
148
- type ObjectTypePropertyDefinitionFrom<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>, P extends ObjectTypePropertyKeysFrom<O, K>> = ObjectTypePropertyDefinitionsFrom<O, K>[P];
149
- interface ObjectTypeDefinition<K extends string, L extends string> {
150
- apiName: K;
151
- description?: string;
152
- primaryKeyType: keyof WirePropertyTypes;
153
- properties: Record<string, ObjectTypePropertyDefinition>;
154
- links: Record<string, ObjectTypeLinkDefinition<L>>;
155
- }
156
- type ObjectTypeLinkKeysFrom<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>> = keyof ObjectTypeDefinitionFrom<O, K>["links"];
157
- interface ObjectTypeLinkDefinition<K extends string> {
158
- targetType: K;
159
- multiplicity: boolean;
160
- }
161
- type ObjectTypeLinkDefinitionFrom<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>, L extends ObjectTypeLinkKeysFrom<O, K>> = ObjectTypeDefinitionFrom<O, K>["links"][L];
162
- type ObjectTypeLinkTargetTypeFrom<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>, L extends ObjectTypeLinkKeysFrom<O, K>> = ObjectTypeLinkDefinitionFrom<O, K, L>["targetType"];
163
- interface ObjectTypePropertyDefinition {
164
- readonly?: boolean;
165
- displayName?: string;
166
- description?: string;
167
- type: keyof WirePropertyTypes;
168
- multiplicity?: boolean;
169
- nullable?: boolean;
170
- }
171
-
172
- type InterfaceDefinitionFrom<O extends OntologyDefinition<any>, K extends InterfaceKeysFrom<O>> = O["interfaces"] extends {} ? O["interfaces"][K] : never;
173
- type InterfaceKeysFrom<O extends OntologyDefinition<string>> = keyof O["interfaces"];
174
- type InterfacePropertyKeysFrom<O extends OntologyDefinition<any>, K extends InterfaceKeysFrom<O>> = keyof InterfaceDefinitionFrom<O, K>["properties"] & string;
175
- type InterfacePropertyDefinitionsFrom<O extends OntologyDefinition<any>, K extends InterfaceKeysFrom<O>> = InterfaceDefinitionFrom<O, K>["properties"];
176
- type InterfacePropertyDefinitionFrom<O extends OntologyDefinition<any>, K extends InterfaceKeysFrom<O>, P extends InterfacePropertyKeysFrom<O, K>> = InterfacePropertyDefinitionsFrom<O, K>[P];
177
- interface InterfaceDefinition<K extends string, _L extends string> {
178
- apiName: K;
179
- description?: string;
180
- properties: Record<string, ObjectTypePropertyDefinition>;
181
- }
182
-
183
- type ObjectOrInterfaceKeysFrom<O extends OntologyDefinition<any, any>> = ObjectTypeKeysFrom<O> | InterfaceKeysFrom<O>;
184
- type ObjectOrInterfaceDefinition<K extends string, L extends string> = ObjectTypeDefinition<K, L> | InterfaceDefinition<K, L>;
185
- type ObjectOrInterfacePropertyKeysFrom<O extends OntologyDefinition<any, any>, K extends ObjectOrInterfaceKeysFrom<O>> = K extends InterfaceKeysFrom<O> ? InterfacePropertyKeysFrom<O, K> : ObjectTypePropertyKeysFrom<O, K>;
186
- type ObjectOrInterfaceDefinitionFrom<O extends OntologyDefinition<any, any>, K extends ObjectOrInterfaceKeysFrom<O>> = K extends InterfaceKeysFrom<O> ? InterfaceDefinitionFrom<O, K> : ObjectTypeDefinitionFrom<O, K>;
187
-
188
- export type { ActionDefinition, ActionModifiedEntity, ActionParameterDefinition, AggregationKeyDataType, InterfaceDefinition, InterfaceDefinitionFrom, InterfaceKeysFrom, InterfacePropertyDefinitionFrom, InterfacePropertyDefinitionsFrom, InterfacePropertyKeysFrom, ObjectActionDataType, ObjectOrInterfaceDefinition, ObjectOrInterfaceDefinitionFrom, ObjectOrInterfaceKeysFrom, ObjectOrInterfacePropertyKeysFrom, ObjectQueryDataType, ObjectSetActionDataType, ObjectSetQueryDataType, ObjectTypeDefinition, ObjectTypeDefinitionFrom, ObjectTypeKeysFrom, ObjectTypeLinkDefinition, ObjectTypeLinkDefinitionFrom, ObjectTypeLinkKeysFrom, ObjectTypeLinkTargetTypeFrom, ObjectTypePropertyDefinition, ObjectTypePropertyDefinitionFrom, ObjectTypePropertyDefinitionsFrom, ObjectTypePropertyKeysFrom, OntologyDefinition, PrimitiveDataType, QueryDataTypeDefinition, QueryDefinition, QueryParameterDefinition, RangeAggregationKeyDataType, SetQueryDataType, SimpleAggregationKeyDataType, StructQueryDataType, ThreeDimensionalAggregationDataType, ThreeDimensionalQueryAggregationDefinition, TwoDimensionalAggregationDataType, TwoDimensionalQueryAggregationDefinition, UnionQueryDataType, ValidActionParameterTypes, WirePropertyTypes, WireQueryDataTypes };
File without changes
File without changes
File without changes
File without changes