@unito/integration-api 0.46.2 → 0.47.0

package/dist/schemas/item.json

@@ -14,6 +14,9 @@
       "items": {
         "$ref": "https://unito.io/integration_api/relation.schema.json"
       }
+    },
+    "canonicalPath": {
+      "type": "string"
     }
   }
 }

package/dist/schemas/itemSummary.json

@@ -24,6 +24,9 @@
     },
     "requestSchema": {
       "$ref": "https://unito.io/integration_api/requestSchema.schema.json"
+    },
+    "canonicalPath": {
+      "type": "string"
     }
   }
 }

package/dist/src/index.cjs

@@ -31,6 +31,9 @@ exports.FieldValueType = void 0;
  */
 exports.Semantic = void 0;
 (function (Semantic) {
+    /**
+     * @deprecated Use `canonicalPath` at item / item summary level instead.
+     */
     Semantic["CANONICAL_PATH"] = "canonicalPath";
     Semantic["CREATED_AT"] = "createdAt";
     Semantic["DESCRIPTION"] = "description";

package/dist/src/types.d.ts

@@ -1,4 +1,4 @@
-import stream from 'node:stream';
+import { Readable } from 'node:stream';
 /**
  * A Collection represents a paginated list of ItemSummary available through a Relation.
  */
@@ -191,6 +191,9 @@ export declare enum FieldValueType {
  * by the consumers of the spec to better understand what that value means.
  */
 export declare enum Semantic {
+    /**
+     * @deprecated Use `canonicalPath` at item / item summary level instead.
+     */
     CANONICAL_PATH = "canonicalPath",
     CREATED_AT = "createdAt",
     DESCRIPTION = "description",
@@ -242,6 +245,11 @@ export interface Item {
      * The relations of the item
      */
     relations: Relation[];
+    /**
+     * The canonical path of the item. This is the path / id that uniquely identifies the item in a provider.
+     * Even if the item is moved in the graph, the canonical path should remain the same.
+     */
+    canonicalPath?: string;
 }
 /**
  * An ItemSummary is a constituent of a collection.
@@ -268,6 +276,11 @@ export interface ItemSummary {
     relations?: {
         [k: string]: string;
     };
+    /**
+     * The canonical path of the item. This is the path / id that uniquely identifies the item in a provider.
+     * Even if the item is moved in the graph, the canonical path should remain the same.
+     */
+    canonicalPath?: string;
 }
 /**
  * A BlobSummary contains a path to download the corresponding Blob.
@@ -373,7 +386,7 @@ export type CreateItemRequestPayload = Record<string, unknown>;
  * A CreateBlobRequestPayload describes the shape of a request on a blob creation endpoint.
  */
 export type CreateBlobRequestPayload = {
-    file: stream.Readable;
+    file: Readable;
     mimeType: string;
     encoding: string;
     filename: string;

package/dist/src/types.js

@@ -29,6 +29,9 @@ export var FieldValueType;
  */
 export var Semantic;
 (function (Semantic) {
+    /**
+     * @deprecated Use `canonicalPath` at item / item summary level instead.
+     */
     Semantic["CANONICAL_PATH"] = "canonicalPath";
     Semantic["CREATED_AT"] = "createdAt";
     Semantic["DESCRIPTION"] = "description";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unito/integration-api",
-  "version": "0.46.2",
+  "version": "0.47.0",
   "description": "The Unito Integration API",
   "type": "module",
   "types": "./dist/src/index.d.ts",
@@ -16,7 +16,7 @@
     "dist/schemas/**/*"
   ],
   "engines": {
-    "node": ">=18",
+    "node": ">=20",
     "npm": ">=10"
   },
   "scripts": {