@epilot/entity-client 4.7.0 → 4.7.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.
Files changed (7) hide show
  1. package/dist/definition.js +1 -1
  2. package/dist/index.js +1 -5
  3. package/dist/openapi.d.ts +150 -97
  4. package/dist/openapi.json +130 -100
  5. package/dist/schema-model.d.ts +2 -2
  6. package/package.json +3 -4
  7. package/LICENSE +0 -21
package/dist/openapi.json CHANGED
@@ -48,12 +48,12 @@
48
48
  "get": {
49
49
  "operationId": "listSchemas",
50
50
  "summary": "listSchemas",
51
- "description": "Get the latest version of local schema",
51
+ "description": "Get the latest versions of all schemas",
52
52
  "parameters": [
53
53
  {
54
54
  "in": "query",
55
55
  "name": "unpublished",
56
- "description": "Includes the unpublished version of unpublished schema",
56
+ "description": "Return unpublished draft schemas",
57
57
  "schema": {
58
58
  "type": "boolean",
59
59
  "default": false
@@ -85,82 +85,6 @@
85
85
  }
86
86
  }
87
87
  },
88
- "/v1/entity/schemas/blueprints": {
89
- "get": {
90
- "operationId": "listSchemaBlueprints",
91
- "summary": "listSchemaBlueprints",
92
- "description": "List canonical versions of all available schemas",
93
- "tags": [
94
- "Schemas"
95
- ],
96
- "responses": {
97
- "200": {
98
- "description": "Success",
99
- "content": {
100
- "application/json": {
101
- "schema": {
102
- "type": "object",
103
- "properties": {
104
- "results": {
105
- "type": "array",
106
- "items": {
107
- "$ref": "#/components/schemas/EntitySchemaItem"
108
- }
109
- }
110
- }
111
- }
112
- }
113
- }
114
- }
115
- }
116
- }
117
- },
118
- "/v1/entity/schemas/{slug}/versions": {
119
- "get": {
120
- "operationId": "getSchemaVersions",
121
- "summary": "getSchemaVersions",
122
- "description": "Get all versions of this schema ordered by the latest versions including drafts.",
123
- "tags": [
124
- "Schemas"
125
- ],
126
- "parameters": [
127
- {
128
- "in": "path",
129
- "name": "slug",
130
- "required": true,
131
- "schema": {
132
- "$ref": "#/components/schemas/EntitySlug"
133
- }
134
- }
135
- ],
136
- "responses": {
137
- "200": {
138
- "description": "Success",
139
- "content": {
140
- "application/json": {
141
- "schema": {
142
- "type": "object",
143
- "properties": {
144
- "versions": {
145
- "type": "array",
146
- "items": {
147
- "$ref": "#/components/schemas/EntitySchemaItem"
148
- }
149
- },
150
- "drafts": {
151
- "type": "array",
152
- "items": {
153
- "$ref": "#/components/schemas/EntitySchemaItem"
154
- }
155
- }
156
- }
157
- }
158
- }
159
- }
160
- }
161
- }
162
- }
163
- },
164
88
  "/v1/entity/schemas/{slug}": {
165
89
  "get": {
166
90
  "operationId": "getSchema",
@@ -200,9 +124,9 @@
200
124
  }
201
125
  },
202
126
  "put": {
203
- "operationId": "createNewSchemaVersion",
204
- "summary": "createNewSchemaVersion",
205
- "description": "Create new version of the schema and default draft is false.",
127
+ "operationId": "updateSchema",
128
+ "summary": "updateSchema",
129
+ "description": "Create or update a schema with a new version",
206
130
  "tags": [
207
131
  "Schemas"
208
132
  ],
@@ -247,9 +171,9 @@
247
171
  }
248
172
  },
249
173
  "delete": {
250
- "operationId": "deleteSchemaById",
251
- "summary": "deleteSchemaById",
252
- "description": "Delete schema by Id",
174
+ "operationId": "deleteSchema",
175
+ "summary": "deleteSchema",
176
+ "description": "Delete a schema, or a specific version of a schema",
253
177
  "tags": [
254
178
  "Schemas"
255
179
  ],
@@ -261,19 +185,87 @@
261
185
  "schema": {
262
186
  "$ref": "#/components/schemas/EntitySlug"
263
187
  }
264
- },
188
+ }
189
+ ],
190
+ "responses": {
191
+ "204": {
192
+ "description": "Success"
193
+ }
194
+ }
195
+ }
196
+ },
197
+ "/v1/entity/schemas/{slug}/versions": {
198
+ "get": {
199
+ "operationId": "getSchemaVersions",
200
+ "summary": "getSchemaVersions",
201
+ "description": "Get all versions of this schema ordered by the latest versions including drafts.",
202
+ "tags": [
203
+ "Schemas"
204
+ ],
205
+ "parameters": [
265
206
  {
266
- "in": "query",
267
- "name": "id",
207
+ "in": "path",
208
+ "name": "slug",
268
209
  "required": true,
269
210
  "schema": {
270
- "$ref": "#/components/schemas/SchemaId"
211
+ "$ref": "#/components/schemas/EntitySlug"
271
212
  }
272
213
  }
273
214
  ],
274
215
  "responses": {
275
- "204": {
276
- "description": "Success"
216
+ "200": {
217
+ "description": "Success",
218
+ "content": {
219
+ "application/json": {
220
+ "schema": {
221
+ "type": "object",
222
+ "properties": {
223
+ "versions": {
224
+ "type": "array",
225
+ "items": {
226
+ "$ref": "#/components/schemas/EntitySchemaItem"
227
+ }
228
+ },
229
+ "drafts": {
230
+ "type": "array",
231
+ "items": {
232
+ "$ref": "#/components/schemas/EntitySchemaItem"
233
+ }
234
+ }
235
+ }
236
+ }
237
+ }
238
+ }
239
+ }
240
+ }
241
+ }
242
+ },
243
+ "/v1/entity/schemas/blueprints": {
244
+ "get": {
245
+ "operationId": "listSchemaBlueprints",
246
+ "summary": "listSchemaBlueprints",
247
+ "description": "List canonical versions of all available schemas",
248
+ "tags": [
249
+ "Schemas"
250
+ ],
251
+ "responses": {
252
+ "200": {
253
+ "description": "Success",
254
+ "content": {
255
+ "application/json": {
256
+ "schema": {
257
+ "type": "object",
258
+ "properties": {
259
+ "results": {
260
+ "type": "array",
261
+ "items": {
262
+ "$ref": "#/components/schemas/EntitySchemaItem"
263
+ }
264
+ }
265
+ }
266
+ }
267
+ }
268
+ }
277
269
  }
278
270
  }
279
271
  }
@@ -897,6 +889,27 @@
897
889
  "schema": {
898
890
  "$ref": "#/components/schemas/ActivityId"
899
891
  }
892
+ },
893
+ {
894
+ "in": "query",
895
+ "name": "operations_size",
896
+ "description": "Maximum number of operations to include in response (default: 10)\n",
897
+ "schema": {
898
+ "type": "integer",
899
+ "minimum": 0,
900
+ "maximum": 1000,
901
+ "default": 25
902
+ }
903
+ },
904
+ {
905
+ "in": "query",
906
+ "name": "operations_from",
907
+ "description": "Pagination offset for operations\n",
908
+ "schema": {
909
+ "type": "integer",
910
+ "minimum": 0,
911
+ "default": 0
912
+ }
900
913
  }
901
914
  ],
902
915
  "responses": {
@@ -2086,16 +2099,16 @@
2086
2099
  },
2087
2100
  "layout_settings": {
2088
2101
  "type": "object",
2089
- "description": "Custom grid definitions for the layout",
2090
- "additionalProperties": {
2091
- "type": "object",
2092
- "properties": {
2093
- "grid_gap": {
2094
- "type": "string"
2095
- },
2096
- "grid_template_columns": {
2097
- "type": "string"
2098
- }
2102
+ "description": "Custom grid definitions for the layout. These settings are composed by managed and un-managed properties:\n- Managed Properties: are interpreted and transformed into layout styles\n- Un-managed Properties: are appended as styles into the attribute mounting node\n",
2103
+ "additionalProperties": true,
2104
+ "properties": {
2105
+ "grid_gap": {
2106
+ "type": "string",
2107
+ "description": "Defines the grid gap for the mounting node of the attribute."
2108
+ },
2109
+ "grid_template_columns": {
2110
+ "type": "string",
2111
+ "description": "Defines the grid column template for the mounting node of the attribute."
2099
2112
  }
2100
2113
  }
2101
2114
  },
@@ -2364,6 +2377,12 @@
2364
2377
  "type": "string",
2365
2378
  "description": "Defines the conditional rendering expression for showing this field.\nWhen a valid expression is parsed, their evaluation defines the visibility of this attribute.\nNote: Empty or invalid expression have no effect on the field visibility.\n"
2366
2379
  },
2380
+ "_purpose": {
2381
+ "type": "array",
2382
+ "items": {
2383
+ "$ref": "#/components/schemas/ClassificationId"
2384
+ }
2385
+ },
2367
2386
  "constraints": {
2368
2387
  "type": "object",
2369
2388
  "description": "A set of constraints applicable to the attribute.\nThese constraints should and will be enforced by the attribute renderer.\n",
@@ -3426,6 +3445,12 @@
3426
3445
  "$ref": "#/components/schemas/Attribute"
3427
3446
  }
3428
3447
  },
3448
+ "_purpose": {
3449
+ "type": "array",
3450
+ "items": {
3451
+ "$ref": "#/components/schemas/ClassificationId"
3452
+ }
3453
+ },
3429
3454
  "ui_hooks": {
3430
3455
  "type": "array",
3431
3456
  "items": {
@@ -4291,6 +4316,11 @@
4291
4316
  {
4292
4317
  "type": "object",
4293
4318
  "properties": {
4319
+ "operations_total": {
4320
+ "type": "integer",
4321
+ "description": "Count of total operations attached to this activity",
4322
+ "example": 1
4323
+ },
4294
4324
  "operations": {
4295
4325
  "type": "array",
4296
4326
  "items": {
package/dist/schema-model.d.ts CHANGED
@@ -7,5 +7,5 @@ export declare enum RelationAffinityMode {
7
7
  WEAK = "weak",
8
8
  STRONG = "strong"
9
9
  }
10
- export type Attribute = Components.Schemas.Attribute;
11
- export type AttributeType = Attribute['type'];
10
+ export declare type Attribute = Components.Schemas.Attribute;
11
+ export declare type AttributeType = Attribute['type'];
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/entity-client",
3
- "version": "4.7.0",
3
+ "version": "4.7.1",
4
4
  "description": "JavaScript client library for the epilot Core Entity API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -24,7 +24,7 @@
24
24
  "test": "jest",
25
25
  "typescript": "tsc",
26
26
  "bundle-definition": "webpack",
27
- "openapi": "../../scripts/update-openapi.sh https://docs.api.epilot.io/entity.yaml",
27
+ "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/entity.yaml",
28
28
  "typegen": "echo '/* eslint-disable */' > src/openapi.d.ts && typegen ./src/openapi.json >> src/openapi.d.ts",
29
29
  "build": "tsc && npm run bundle-definition",
30
30
  "build:watch": "npm run build && tsc -w",
@@ -71,6 +71,5 @@
71
71
  "typescript": "^4.1.3",
72
72
  "webpack": "^5.18.0",
73
73
  "webpack-cli": "^4.4.0"
74
- },
75
- "gitHead": "d41cf7334964ffb68c562b531d6cf3c286367f76"
74
+ }
76
75
  }
package/LICENSE DELETED
@@ -1,21 +0,0 @@
1
- The MIT License (MIT)
2
-
3
- Copyright (c) 2022 epilot GmbH
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in
13
- all copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
- THE SOFTWARE.