@unito/integration-api 7.1.1 → 8.0.0

package/dist/schemas/item.json

@@ -3,7 +3,7 @@
   "title": "Item",
   "type": "object",
   "additionalProperties": false,
-  "required": ["fields", "relations"],
+  "required": ["fields", "relations", "canonicalPath"],
   "properties": {
     "fields": {
       "type": "object",

package/dist/schemas/itemSummary.json

@@ -3,7 +3,7 @@
   "title": "ItemSummary",
   "type": "object",
   "additionalProperties": false,
-  "required": ["path"],
+  "required": ["path", "canonicalPath"],
   "properties": {
     "path": {
       "type": "string",

package/dist/src/guards.js

@@ -31,6 +31,7 @@ export function isUndefined(potentialUndefined) {
 export function isItemSummary(potentialItemSummary) {
     return (isObject(potentialItemSummary) &&
         isString(potentialItemSummary['path']) &&
+        isString(potentialItemSummary['canonicalPath']) &&
         (isUndefined(potentialItemSummary['fields']) || isObject(potentialItemSummary['fields'])) &&
         (isUndefined(potentialItemSummary['relations']) ||
             (Array.isArray(potentialItemSummary['relations']) && potentialItemSummary['relations'].every(isString))));
@@ -43,6 +44,7 @@ export function isItemSummary(potentialItemSummary) {
 export function isItem(potentialItem) {
     return (isObject(potentialItem) &&
         isObject(potentialItem['fields']) &&
+        isString(potentialItem['canonicalPath']) &&
         Array.isArray(potentialItem['relations']) &&
         potentialItem['relations'].every((r) => isRelation(r)));
 }
@@ -62,8 +64,19 @@ export function isRelationPointer(potentialRelationPointer) {
  * @returns True if the value is a ReferenceRelation, false otherwise.
  */
 export function isReferenceRelation(potentialReferenceRelation, options) {
+    if (!isObject(potentialReferenceRelation)) {
+        return false;
+    }
+    // breaking change introducing the name in the reference.
+    if ('name' in potentialReferenceRelation) {
+        return (isObject(potentialReferenceRelation) &&
+            isString(potentialReferenceRelation['name']) &&
+            isString(potentialReferenceRelation['path']) &&
+            isString(potentialReferenceRelation['label']) &&
+            isRelationSchemaOrSelf(potentialReferenceRelation['schema'], options));
+    }
+    // backward compatible check
     return (isObject(potentialReferenceRelation) &&
-        isString(potentialReferenceRelation['name']) &&
         isString(potentialReferenceRelation['path']) &&
         isString(potentialReferenceRelation['label']) &&
         isRelationSchemaOrSelf(potentialReferenceRelation['schema'], options));

package/dist/src/index.cjs

@@ -148,6 +148,7 @@ function isUndefined(potentialUndefined) {
 function isItemSummary(potentialItemSummary) {
     return (isObject(potentialItemSummary) &&
         isString(potentialItemSummary['path']) &&
+        isString(potentialItemSummary['canonicalPath']) &&
         (isUndefined(potentialItemSummary['fields']) || isObject(potentialItemSummary['fields'])) &&
         (isUndefined(potentialItemSummary['relations']) ||
             (Array.isArray(potentialItemSummary['relations']) && potentialItemSummary['relations'].every(isString))));
@@ -160,6 +161,7 @@ function isItemSummary(potentialItemSummary) {
 function isItem(potentialItem) {
     return (isObject(potentialItem) &&
         isObject(potentialItem['fields']) &&
+        isString(potentialItem['canonicalPath']) &&
         Array.isArray(potentialItem['relations']) &&
         potentialItem['relations'].every((r) => isRelation(r)));
 }
@@ -179,8 +181,19 @@ function isRelationPointer(potentialRelationPointer) {
  * @returns True if the value is a ReferenceRelation, false otherwise.
  */
 function isReferenceRelation(potentialReferenceRelation, options) {
+    if (!isObject(potentialReferenceRelation)) {
+        return false;
+    }
+    // breaking change introducing the name in the reference.
+    if ('name' in potentialReferenceRelation) {
+        return (isObject(potentialReferenceRelation) &&
+            isString(potentialReferenceRelation['name']) &&
+            isString(potentialReferenceRelation['path']) &&
+            isString(potentialReferenceRelation['label']) &&
+            isRelationSchemaOrSelf(potentialReferenceRelation['schema'], options));
+    }
+    // backward compatible check
     return (isObject(potentialReferenceRelation) &&
-        isString(potentialReferenceRelation['name']) &&
         isString(potentialReferenceRelation['path']) &&
         isString(potentialReferenceRelation['label']) &&
         isRelationSchemaOrSelf(potentialReferenceRelation['schema'], options));

package/dist/src/types.d.ts

@@ -348,7 +348,7 @@ export interface Item<T extends RelationSchema | undefined = undefined> {
      * 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;
+    canonicalPath: string;
 }
 /**
  * An ItemSummary is a constituent of a collection.
@@ -375,7 +375,7 @@ export interface ItemSummary<T extends RelationSchema | undefined = undefined> {
      * 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;
+    canonicalPath: string;
 }
 /**
  * A BlobSummary contains a path to download the corresponding Blob.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unito/integration-api",
-  "version": "7.1.1",
+  "version": "8.0.0",
   "description": "The Unito Integration API",
   "type": "module",
   "types": "./dist/src/index.d.ts",