@unito/integration-api 8.0.5 → 8.0.7

package/dist/schemas/createItemResponsePayload.json

@@ -0,0 +1,58 @@
+{
+  "$id": "https://unito.io/integration_api/createItemResponsePayload.schema.json",
+  "title": "CreateItemResponsePayload",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["path", "canonicalPath"],
+  "properties": {
+    "path": {
+      "type": "string",
+      "format": "uri-reference",
+      "pattern": "^\/.*$"
+    },
+    "fields": {
+      "type": "object",
+      "additionalProperties": true
+    },
+    "relations": {
+      "type": "object",
+      "additionalProperties": {
+        "type": "string",
+        "format": "uri-reference",
+        "pattern": "^\/.*$"
+      }
+    },
+    "requestSchema": {
+      "$ref": "https://unito.io/integration_api/requestSchema.schema.json"
+    },
+    "canonicalPath": {
+      "type": "string"
+    },
+    "errors": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["source", "code", "message"],
+        "properties": {
+          "source": {
+            "type": "string"
+          },
+          "code": {
+            "type": "string"
+          },
+          "message": {
+            "type": "string"
+          },
+          "details": {
+            "type": "object",
+            "additionalProperties": true
+          },
+          "originalError": {
+            "$ref": "https://unito.io/integration_api/error.schema.json"
+          }
+        }
+      }
+    }
+  }
+}

package/dist/schemas/updateItemResponsePayload.json

@@ -0,0 +1,48 @@
+{
+  "$id": "https://unito.io/integration_api/updateItemResponsePayload.schema.json",
+  "title": "UpdateItemResponsePayload",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["fields", "relations", "canonicalPath"],
+  "properties": {
+    "fields": {
+      "type": "object",
+      "additionalProperties": true
+    },
+    "relations": {
+      "type": "array",
+      "items": {
+        "$ref": "https://unito.io/integration_api/relation.schema.json"
+      }
+    },
+    "canonicalPath": {
+      "type": "string"
+    },
+    "errors": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["source", "code", "message"],
+        "properties": {
+          "source": {
+            "type": "string"
+          },
+          "code": {
+            "type": "string"
+          },
+          "message": {
+            "type": "string"
+          },
+          "details": {
+            "type": "object",
+            "additionalProperties": true
+          },
+          "originalError": {
+            "$ref": "https://unito.io/integration_api/error.schema.json"
+          }
+        }
+      }
+    }
+  }
+}

package/dist/src/compatibilities.d.ts

@@ -405,9 +405,9 @@ export declare const fieldTypeCompatibilityMatrix: {
         readonly object: null;
         readonly reference: null;
         readonly richText: {};
-        readonly html: null;
-        readonly markdown: null;
-        readonly string: null;
+        readonly html: {};
+        readonly markdown: {};
+        readonly string: {};
         readonly url: null;
     };
     readonly html: {
@@ -423,7 +423,7 @@ export declare const fieldTypeCompatibilityMatrix: {
         readonly number: null;
         readonly object: null;
         readonly reference: null;
-        readonly richText: null;
+        readonly richText: {};
         readonly html: {
             readonly decoratorTemplate: {
                 readonly type: "stringWithSourceItemFields";
@@ -492,7 +492,7 @@ export declare const fieldTypeCompatibilityMatrix: {
         readonly number: null;
         readonly object: null;
         readonly reference: null;
-        readonly richText: null;
+        readonly richText: {};
         readonly html: {
             readonly decoratorTemplate: {
                 readonly type: "stringWithSourceItemFields";
@@ -570,7 +570,7 @@ export declare const fieldTypeCompatibilityMatrix: {
                 readonly required: true;
             };
         };
-        readonly richText: null;
+        readonly richText: {};
         readonly html: {};
         readonly markdown: {};
         readonly string: {};

package/dist/src/compatibilities.js

@@ -347,9 +347,9 @@ export const fieldTypeCompatibilityMatrix = {
         [Api.FieldValueTypes.OBJECT]: null,
         [Api.FieldValueTypes.REFERENCE]: null,
         [Api.FieldValueTypes.RICH_TEXT]: {},
-        [Api.FieldValueTypes.RICH_TEXT_HTML]: null,
-        [Api.FieldValueTypes.RICH_TEXT_MARKDOWN]: null,
-        [Api.FieldValueTypes.STRING]: null,
+        [Api.FieldValueTypes.RICH_TEXT_HTML]: {},
+        [Api.FieldValueTypes.RICH_TEXT_MARKDOWN]: {},
+        [Api.FieldValueTypes.STRING]: {},
         [Api.FieldValueTypes.URL]: null,
     },
     [Api.FieldValueTypes.RICH_TEXT_HTML]: {
@@ -365,7 +365,7 @@ export const fieldTypeCompatibilityMatrix = {
         [Api.FieldValueTypes.NUMBER]: null,
         [Api.FieldValueTypes.OBJECT]: null,
         [Api.FieldValueTypes.REFERENCE]: null,
-        [Api.FieldValueTypes.RICH_TEXT]: null,
+        [Api.FieldValueTypes.RICH_TEXT]: {},
         [Api.FieldValueTypes.RICH_TEXT_HTML]: htmlToRichTextConfiguration,
         [Api.FieldValueTypes.RICH_TEXT_MARKDOWN]: htmlToRichTextConfiguration,
         [Api.FieldValueTypes.STRING]: {},
@@ -384,7 +384,7 @@ export const fieldTypeCompatibilityMatrix = {
         [Api.FieldValueTypes.NUMBER]: null,
         [Api.FieldValueTypes.OBJECT]: null,
         [Api.FieldValueTypes.REFERENCE]: null,
-        [Api.FieldValueTypes.RICH_TEXT]: null,
+        [Api.FieldValueTypes.RICH_TEXT]: {},
         [Api.FieldValueTypes.RICH_TEXT_HTML]: markdownToRichTextConfiguration,
         [Api.FieldValueTypes.RICH_TEXT_MARKDOWN]: markdownToRichTextConfiguration,
         [Api.FieldValueTypes.STRING]: {},
@@ -403,7 +403,7 @@ export const fieldTypeCompatibilityMatrix = {
         [Api.FieldValueTypes.NUMBER]: {},
         [Api.FieldValueTypes.OBJECT]: null,
         [Api.FieldValueTypes.REFERENCE]: stringLikeToReferenceConfiguration,
-        [Api.FieldValueTypes.RICH_TEXT]: null,
+        [Api.FieldValueTypes.RICH_TEXT]: {},
         [Api.FieldValueTypes.RICH_TEXT_HTML]: {},
         [Api.FieldValueTypes.RICH_TEXT_MARKDOWN]: {},
         [Api.FieldValueTypes.STRING]: {},

package/dist/src/index.cjs

@@ -626,9 +626,9 @@ const fieldTypeCompatibilityMatrix = {
         [FieldValueTypes.OBJECT]: null,
         [FieldValueTypes.REFERENCE]: null,
         [FieldValueTypes.RICH_TEXT]: {},
-        [FieldValueTypes.RICH_TEXT_HTML]: null,
-        [FieldValueTypes.RICH_TEXT_MARKDOWN]: null,
-        [FieldValueTypes.STRING]: null,
+        [FieldValueTypes.RICH_TEXT_HTML]: {},
+        [FieldValueTypes.RICH_TEXT_MARKDOWN]: {},
+        [FieldValueTypes.STRING]: {},
         [FieldValueTypes.URL]: null,
     },
     [FieldValueTypes.RICH_TEXT_HTML]: {
@@ -644,7 +644,7 @@ const fieldTypeCompatibilityMatrix = {
         [FieldValueTypes.NUMBER]: null,
         [FieldValueTypes.OBJECT]: null,
         [FieldValueTypes.REFERENCE]: null,
-        [FieldValueTypes.RICH_TEXT]: null,
+        [FieldValueTypes.RICH_TEXT]: {},
         [FieldValueTypes.RICH_TEXT_HTML]: htmlToRichTextConfiguration,
         [FieldValueTypes.RICH_TEXT_MARKDOWN]: htmlToRichTextConfiguration,
         [FieldValueTypes.STRING]: {},
@@ -663,7 +663,7 @@ const fieldTypeCompatibilityMatrix = {
         [FieldValueTypes.NUMBER]: null,
         [FieldValueTypes.OBJECT]: null,
         [FieldValueTypes.REFERENCE]: null,
-        [FieldValueTypes.RICH_TEXT]: null,
+        [FieldValueTypes.RICH_TEXT]: {},
         [FieldValueTypes.RICH_TEXT_HTML]: markdownToRichTextConfiguration,
         [FieldValueTypes.RICH_TEXT_MARKDOWN]: markdownToRichTextConfiguration,
         [FieldValueTypes.STRING]: {},
@@ -682,7 +682,7 @@ const fieldTypeCompatibilityMatrix = {
         [FieldValueTypes.NUMBER]: {},
         [FieldValueTypes.OBJECT]: null,
         [FieldValueTypes.REFERENCE]: stringLikeToReferenceConfiguration,
-        [FieldValueTypes.RICH_TEXT]: null,
+        [FieldValueTypes.RICH_TEXT]: {},
         [FieldValueTypes.RICH_TEXT_HTML]: {},
         [FieldValueTypes.RICH_TEXT_MARKDOWN]: {},
         [FieldValueTypes.STRING]: {},

package/dist/src/types.d.ts

@@ -476,15 +476,15 @@ export interface RelationSchema {
     /**
      * Can we create items?
      */
-    canCreateItem?: boolean;
+    canCreateItem: boolean;
     /**
      * Can we update items?
      */
-    canUpdateItem?: boolean;
+    canUpdateItem: boolean;
     /**
      * Can we delete items?
      */
-    canDeleteItem?: boolean;
+    canDeleteItem: boolean;
     /**
      * Can we add fields to the schema?
      * Defaults to false.
@@ -536,6 +536,31 @@ export type UpdateItemRequestPayload = CreateItemRequestPayload & {
         };
     };
 };
+/**
+ * Describes a field the integration accepted in the request body but did not send to,
+ * or that was not successfully accepted by, the provider. Reported alongside a 2xx
+ * response so the caller knows the resource was created/updated but the listed
+ * locations were dropped.
+ */
+export type FieldError = Error & {
+    /**
+     * JSONPath query (dot/bracket notation) locating the problematic field on the request body.
+     * e.g. "name", "customFields.priority", "tags[0]"
+     */
+    source: string;
+};
+/**
+ * A CreateItemResponsePayload describes the shape of a response from an item creation endpoint.
+ */
+export type CreateItemResponsePayload<T extends RelationSchema | undefined = undefined> = ItemSummary<T> & {
+    errors?: FieldError[];
+};
+/**
+ * An UpdateItemResponsePayload describes the shape of a response from an item update endpoint.
+ */
+export type UpdateItemResponsePayload<T extends RelationSchema | undefined = undefined> = Item<T> & {
+    errors?: FieldError[];
+};
 /**
  * A Request Schema describes how a path should be accessed.
  */

package/package.json

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