@unito/integration-api 0.46.2 → 1.0.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.
@@ -14,6 +14,9 @@
14
14
  "items": {
15
15
  "$ref": "https://unito.io/integration_api/relation.schema.json"
16
16
  }
17
+ },
18
+ "canonicalPath": {
19
+ "type": "string"
17
20
  }
18
21
  }
19
22
  }
@@ -24,6 +24,9 @@
24
24
  },
25
25
  "requestSchema": {
26
26
  "$ref": "https://unito.io/integration_api/requestSchema.schema.json"
27
+ },
28
+ "canonicalPath": {
29
+ "type": "string"
27
30
  }
28
31
  }
29
32
  }
@@ -31,7 +31,6 @@ exports.FieldValueType = void 0;
31
31
  */
32
32
  exports.Semantic = void 0;
33
33
  (function (Semantic) {
34
- Semantic["CANONICAL_PATH"] = "canonicalPath";
35
34
  Semantic["CREATED_AT"] = "createdAt";
36
35
  Semantic["DESCRIPTION"] = "description";
37
36
  Semantic["DISPLAY_NAME"] = "displayName";
@@ -1,4 +1,4 @@
1
- import stream from 'node:stream';
1
+ import { Readable } from 'node:stream';
2
2
  /**
3
3
  * A Collection represents a paginated list of ItemSummary available through a Relation.
4
4
  */
@@ -191,7 +191,6 @@ export declare enum FieldValueType {
191
191
  * by the consumers of the spec to better understand what that value means.
192
192
  */
193
193
  export declare enum Semantic {
194
- CANONICAL_PATH = "canonicalPath",
195
194
  CREATED_AT = "createdAt",
196
195
  DESCRIPTION = "description",
197
196
  DISPLAY_NAME = "displayName",
@@ -242,6 +241,11 @@ export interface Item {
242
241
  * The relations of the item
243
242
  */
244
243
  relations: Relation[];
244
+ /**
245
+ * The canonical path of the item. This is the path / id that uniquely identifies the item in a provider.
246
+ * Even if the item is moved in the graph, the canonical path should remain the same.
247
+ */
248
+ canonicalPath?: string;
245
249
  }
246
250
  /**
247
251
  * An ItemSummary is a constituent of a collection.
@@ -268,6 +272,11 @@ export interface ItemSummary {
268
272
  relations?: {
269
273
  [k: string]: string;
270
274
  };
275
+ /**
276
+ * The canonical path of the item. This is the path / id that uniquely identifies the item in a provider.
277
+ * Even if the item is moved in the graph, the canonical path should remain the same.
278
+ */
279
+ canonicalPath?: string;
271
280
  }
272
281
  /**
273
282
  * A BlobSummary contains a path to download the corresponding Blob.
@@ -373,7 +382,7 @@ export type CreateItemRequestPayload = Record<string, unknown>;
373
382
  * A CreateBlobRequestPayload describes the shape of a request on a blob creation endpoint.
374
383
  */
375
384
  export type CreateBlobRequestPayload = {
376
- file: stream.Readable;
385
+ file: Readable;
377
386
  mimeType: string;
378
387
  encoding: string;
379
388
  filename: string;
package/dist/src/types.js CHANGED
@@ -29,7 +29,6 @@ export var FieldValueType;
29
29
  */
30
30
  export var Semantic;
31
31
  (function (Semantic) {
32
- Semantic["CANONICAL_PATH"] = "canonicalPath";
33
32
  Semantic["CREATED_AT"] = "createdAt";
34
33
  Semantic["DESCRIPTION"] = "description";
35
34
  Semantic["DISPLAY_NAME"] = "displayName";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@unito/integration-api",
3
- "version": "0.46.2",
3
+ "version": "1.0.0",
4
4
  "description": "The Unito Integration API",
5
5
  "type": "module",
6
6
  "types": "./dist/src/index.d.ts",
@@ -16,7 +16,7 @@
16
16
  "dist/schemas/**/*"
17
17
  ],
18
18
  "engines": {
19
- "node": ">=18",
19
+ "node": ">=20",
20
20
  "npm": ">=10"
21
21
  },
22
22
  "scripts": {