@unito/integration-api 0.42.17

package/LICENSE

@@ -0,0 +1,3 @@
+Copyright (c) Unito, Inc.
+
+This repository is a component of the Unito Software Development Kit (SDK). By downloading, installing, accessing, or using any part of the Unito SDK, including this repository, you signify your acceptance of and agree to be bound by the terms of the Unito Software Development Kit Agreement found at https://unito.io/sdk-agreement/. If you do not agree to the terms of the Unito Software Development Kit Agreement, you are not authorized to download, install, access, or use any part of the Unito SDK, including this repository.

package/README.md

@@ -0,0 +1,10 @@
+# Integration API Specification
+
+This specification describes a REST API allowing an application to be compatible
+with two-way asynchronous syncing tools, such as Unito.
+
+## Getting started
+
+```sh
+npm install --save @unito/integration-api
+```

package/dist/schemas/collection.json

@@ -0,0 +1,24 @@
+{
+  "$id": "https://unito.io/integration_api/collection.schema.json",
+  "title": "Collection",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["info", "data"],
+  "properties": {
+    "info": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "nextPage": {
+          "type": "string"
+        }
+      }
+    },
+    "data": {
+      "type": "array",
+      "items": {
+        "$ref": "https://unito.io/integration_api/itemSummary.schema.json"
+      }
+    }
+  }
+}

package/dist/schemas/credentialAccount.json

@@ -0,0 +1,25 @@
+{
+  "$id": "https://unito.io/integration_api/credentialAccount.schema.json",
+  "title": "CredentialAccount",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["id", "displayName", "emails"],
+  "properties": {
+    "id": {
+      "type": "string"
+    },
+    "displayName": {
+      "type": "string"
+    },
+    "partition": {
+      "type": "string"
+    },
+    "emails": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "format": "email"
+      }
+    }
+  }
+}

package/dist/schemas/definitions.json

@@ -0,0 +1,46 @@
+{
+  "$id": "https://unito.io/integration_api/definitions.schema.json",
+  "$defs": {
+    "fieldValueType": {
+      "$id": "FieldValueType",
+      "type": "string",
+      "enum": [
+        "blob",
+        "boolean",
+        "date",
+        "dateRange",
+        "datetime",
+        "datetimeRange",
+        "duration",
+        "email",
+        "html",
+        "integer",
+        "markdown",
+        "number",
+        "object",
+        "reference",
+        "string",
+        "url"
+      ]
+    },
+    "semantic": {
+      "$id": "Semantic",
+      "type": ["string", "null"],
+      "enum": [
+        "canonicalPath",
+        "createdAt",
+        "description",
+        "displayName",
+        "providerUrl",
+        "updatedAt",
+        "user",
+        null
+      ]
+    },
+    "operatorType": {
+      "$id": "OperatorType",
+      "type": "string",
+      "enum": ["=", "!=", ">", ">=", "<", "<=", "*=", "!*=", "^=", "$=", "!!", "!"]
+    }
+  }
+}

package/dist/schemas/error.json

@@ -0,0 +1,22 @@
+{
+  "$id": "https://unito.io/integration_api/error.schema.json",
+  "title": "Error",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["code", "message"],
+  "properties": {
+    "code": {
+      "type": "string"
+    },
+    "message": {
+      "type": "string"
+    },
+    "details": {
+      "type": "object",
+      "additionalProperties": true
+    },
+    "originalError": {
+      "$ref": "https://unito.io/integration_api/error.schema.json"
+    }
+  }
+}

package/dist/schemas/fieldSchema.json

@@ -0,0 +1,103 @@
+{
+  "$id": "https://unito.io/integration_api/fieldSchema.schema.json",
+  "title": "FieldSchema",
+  "allOf": [
+    {
+      "type": "object",
+      "required": ["name", "type", "label"],
+      "additionalProperties": false,
+      "properties": {
+        "name": {
+          "type": "string",
+          "pattern": "^[a-zA-Z0-9_-]*$",
+          "minLength": 1,
+          "maxLength": 100
+        },
+        "type": {
+          "$ref": "https://unito.io/integration_api/definitions.schema.json#/$defs/fieldValueType"
+        },
+        "label": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 100
+        },
+        "category": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 100
+        },
+        "semantic": {
+          "$ref": "https://unito.io/integration_api/definitions.schema.json#/$defs/semantic"
+        },
+        "fields": {
+          "type": "array",
+          "items": {
+            "$ref": "https://unito.io/integration_api/fieldSchema.schema.json"
+          }
+        },
+        "optionalValues": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": ["label", "value"],
+            "additionalProperties": false,
+            "properties": {
+              "label": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 100
+              },
+              "value": {
+                "anyOf": [{ "type": ["string"] }, { "type": ["number"] }]
+              }
+            }
+          }
+        },
+        "referencePath": {
+          "type": "string",
+          "format": "uri-reference",
+          "pattern": "^\/.*$"
+        },
+        "info": {
+          "type": "string"
+        },
+        "readOnly": {
+          "type": "boolean"
+        },
+        "isArray": {
+          "type": "boolean"
+        },
+        "nullable": {
+          "type": "boolean",
+          "default": true
+        }
+      }
+    },
+    {
+      "if": {
+        "type": "object",
+        "properties": {
+          "type": { "const": "reference" }
+        },
+        "required": ["type"]
+      },
+      "then": {
+        "type": "object",
+        "required": ["fields", "referencePath"]
+      }
+    },
+    {
+      "if": {
+        "type": "object",
+        "properties": {
+          "type": { "const": "object" }
+        },
+        "required": ["type"]
+      },
+      "then": {
+        "type": "object",
+        "required": ["fields"]
+      }
+    }
+  ]
+}

package/dist/schemas/item.json

@@ -0,0 +1,19 @@
+{
+  "$id": "https://unito.io/integration_api/item.schema.json",
+  "title": "Item",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["fields", "relations"],
+  "properties": {
+    "fields": {
+      "type": "object",
+      "additionalProperties": true
+    },
+    "relations": {
+      "type": "array",
+      "items": {
+        "$ref": "https://unito.io/integration_api/relation.schema.json"
+      }
+    }
+  }
+}

package/dist/schemas/itemSummary.json

@@ -0,0 +1,21 @@
+{
+  "$id": "https://unito.io/integration_api/itemSummary.schema.json",
+  "title": "ItemSummary",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["path"],
+  "properties": {
+    "path": {
+      "type": "string",
+      "format": "uri-reference",
+      "pattern": "^\/.*$"
+    },
+    "fields": {
+      "type": "object",
+      "additionalProperties": true
+    },
+    "requestSchema": {
+      "$ref": "https://unito.io/integration_api/requestSchema.schema.json"
+    }
+  }
+}

package/dist/schemas/relation.json

@@ -0,0 +1,35 @@
+{
+  "$id": "https://unito.io/integration_api/relation.schema.json",
+  "title": "Relation",
+  "type": "object",
+  "additionalProperties": false,
+  "unito": true,
+  "required": ["name", "path", "schema", "label"],
+  "properties": {
+    "name": {
+      "type": "string",
+      "pattern": "^[a-zA-Z0-9_-]*$",
+      "minLength": 1,
+      "maxLength": 100
+    },
+    "path": {
+      "type": "string",
+      "format": "uri-reference",
+      "pattern": "^\/.*$"
+    },
+    "requestSchema": {
+      "$ref": "https://unito.io/integration_api/requestSchema.schema.json"
+    },
+    "label": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 100
+    },
+    "searchable": {
+      "type": "boolean"
+    },
+    "schema": {
+      "$ref": "https://unito.io/integration_api/relationSchema.schema.json"
+    }
+  }
+}

package/dist/schemas/relationSchema.json

@@ -0,0 +1,35 @@
+{
+  "$id": "https://unito.io/integration_api/relationSchema.schema.json",
+  "title": "RelationSchema",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["fields", "label"],
+  "properties": {
+    "label": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 100
+    },
+    "canCreateItem": {
+      "type": "boolean"
+    },
+    "canUpdateItem": {
+      "type": "boolean"
+    },
+    "canDeleteItem": {
+      "type": "boolean"
+    },
+    "fields": {
+      "type": "array",
+      "items": {
+        "$ref": "https://unito.io/integration_api/fieldSchema.schema.json"
+      }
+    },
+    "relations": {
+      "type": "array",
+      "items": {
+        "$ref": "https://unito.io/integration_api/relationSummary.schema.json"
+      }
+    }
+  }
+}

package/dist/schemas/relationSummary.json

@@ -0,0 +1,24 @@
+{
+  "$id": "https://unito.io/integration_api/relationSummary.schema.json",
+  "title": "RelationSummary",
+  "type": "object",
+  "additionalProperties": false,
+  "unito": true,
+  "required": ["name", "schema", "label"],
+  "properties": {
+    "name": {
+      "type": "string",
+      "pattern": "^[a-zA-Z0-9_-]*$",
+      "minLength": 1,
+      "maxLength": 100
+    },
+    "label": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 100
+    },
+    "schema": {
+      "$ref": "https://unito.io/integration_api/relationSchema.schema.json"
+    }
+  }
+}

package/dist/schemas/requestSchema.json

@@ -0,0 +1,15 @@
+{
+  "$id": "https://unito.io/integration_api/requestSchema.schema.json",
+  "title": "RequestSchema",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["parameters"],
+  "properties": {
+    "parameters": {
+      "type": "array",
+      "items": {
+        "$ref": "https://unito.io/integration_api/fieldSchema.schema.json"
+      }
+    }
+  }
+}

package/dist/schemas/statusCode.json

@@ -0,0 +1,17 @@
+{
+  "$id": "https://unito.io/integration_api/statusCode.schema.json",
+  "title": "Status Code",
+  "type": "number",
+  "enum": [
+    200,
+    201,
+    204,
+    400,
+    401,
+    404,
+    408,
+    422,
+    429,
+    500
+  ]
+}

package/dist/schemas/webhookAcknowledgeResponsePayload.json

@@ -0,0 +1,21 @@
+{
+  "$id": "https://unito.io/integration_api/webhookAcknowledgeResponsePayload.schema.json",
+  "title": "WebhookAcknowledgeResponsePayload",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["statusCode"],
+  "properties": {
+    "statusCode": {
+      "type": "number"
+    },
+    "headers": {
+      "type": "object",
+      "additionalProperties": {
+        "type": "string"
+      }
+    },
+    "payload": {
+      "type": "string"
+    }
+  }
+}

package/dist/schemas/webhookParseRequestPayload.json

@@ -0,0 +1,24 @@
+{
+  "$id": "https://unito.io/integration_api/webhookParseRequestPayload.schema.json",
+  "title": "WebhookParseRequestPayload",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["headers", "payload"],
+  "properties": {
+    "partition": {
+      "type": "string"
+    },
+    "headers": {
+      "type": "object",
+      "additionalProperties": {
+        "type": "string"
+      }
+    },
+    "payload": {
+      "type": "string"
+    },
+    "url": {
+      "type": "string"
+    }
+  }
+}

package/dist/schemas/webhookParseResponsePayload.json

@@ -0,0 +1,17 @@
+{
+  "$id": "https://unito.io/integration_api/webhookParseResponsePayload.schema.json",
+  "title": "WebhookParseResponsePayload",
+  "type": "object",
+  "additionalProperties": false,
+  "anyOf": [
+    {
+      "$ref": "https://unito.io/integration_api/webhookParsedItem.schema.json"
+    },
+    {
+      "type": "array",
+      "items": {
+        "$ref": "https://unito.io/integration_api/webhookParsedItem.schema.json"
+      }
+    }
+  ]
+}

package/dist/schemas/webhookParsedItem.json

@@ -0,0 +1,34 @@
+{
+  "$id": "https://unito.io/integration_api/webhookParsedItem.schema.json",
+  "title": "WebhookParsedItem",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "itemPath": {
+      "type": "string"
+    },
+    "date": {
+      "type": "string"
+    },
+    "impactedRelations": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": ["name", "impactedItems"],
+        "properties": {
+          "name": {
+            "type": "string",
+            "nullable": false
+          },
+          "impactedItems": {
+            "type": "array",
+            "nullable": false,
+            "items": {
+              "$ref": "https://unito.io/integration_api/webhookParsedItem.schema.json"
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/dist/schemas/webhookSubscriptionRequestPayload.json

@@ -0,0 +1,23 @@
+{
+  "$id": "https://unito.io/integration_api/webhookSubscriptionPayload.schema.json",
+  "title": "WebhookSubscriptionPayload",
+  "type": "object",
+  "required": ["itemPath", "targetUrl", "action"],
+  "additionalProperties": false,
+  "properties": {
+    "itemPath": {
+      "type": "string"
+    },
+    "targetURL": {
+      "type": "string",
+      "format": "uri"
+    },
+    "action": {
+      "type": "string",
+      "enum": [
+        "start",
+        "stop"
+      ]
+    }
+  }
+}

package/dist/src/index.d.ts

@@ -0,0 +1 @@
+export * from './types';

package/dist/src/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./types"), exports);

package/dist/src/types.d.ts

@@ -0,0 +1,423 @@
+/**
+ * A Collection represents a paginated list of ItemSummary available through a Relation.
+ */
+export interface Collection {
+    /**
+     * Contextual information.
+     */
+    info: {
+        /**
+         * Link to the next page.
+         */
+        nextPage?: string;
+    };
+    /**
+     * List of item summaries.
+     */
+    data: ItemSummary[];
+}
+/**
+ * A CredentialAccount describes the provider account associated to a credential.
+ */
+export interface CredentialAccount {
+    /**
+     * The native id of the provider account.
+     */
+    id: string;
+    /**
+     * The display name of the provider account.
+     */
+    displayName: string;
+    /**
+     * The emails associated with the provider account.
+     */
+    emails: string[];
+    /**
+     * Partition can be used to divide data into different buckets.
+     */
+    partition?: string;
+}
+/**
+ * An error is used when an operation doesn't succeed.
+ */
+export interface Error {
+    /**
+     * Specific error code. Usually the HTTP response code.
+     */
+    code: string;
+    /**
+     * Raw error message.
+     */
+    message: string;
+    /**
+     * Free-form key-value store. For logging/debugging purposes.
+     */
+    details?: {
+        [k: string]: unknown;
+    };
+    originalError?: Error;
+}
+interface AbstractFieldSchema {
+    /**
+     * The main identifier of the field.
+     */
+    name: string;
+    /**
+     * The publicly visible label of the field.
+     */
+    label: string;
+    /**
+     * The semantic of the field.
+     */
+    semantic?: Semantic;
+    /**
+     * Description of the field. For information purposes only.
+     */
+    info?: string;
+    /**
+     * Category of the field. Used to group fields together when displayed.
+     */
+    category?: string;
+    /**
+     * Whether the field is read only.
+     */
+    readOnly?: boolean;
+    /**
+     * Whether the field returns an array. Defaults to false.
+     * An array is a non-paginated list of same-type values.
+     * For pagination, use a relation instead.
+     */
+    isArray?: boolean;
+    /**
+     * Whether the field can be empty. Default to true.
+     */
+    nullable?: boolean;
+}
+export interface BasicFieldSchema extends AbstractFieldSchema {
+    /**
+     * The type of the field.
+     */
+    type: Exclude<FieldValueType, FieldValueType.REFERENCE | FieldValueType.OBJECT | FieldValueType.DATETIME_RANGE | FieldValueType.DATE_RANGE>;
+}
+export interface ReferenceFieldSchema extends AbstractFieldSchema {
+    /**
+     * The type of the field.
+     */
+    type: FieldValueType.REFERENCE;
+    /**
+     * Specify the source collection.
+     */
+    referencePath: string;
+    /**
+     * Describe the schema of the referenced collection.
+     */
+    fields: FieldSchema[];
+}
+export interface DatetimeRangeFieldSchema extends AbstractFieldSchema {
+    /**
+     * The type of the field.
+     */
+    type: FieldValueType.DATETIME_RANGE;
+    /**
+     * Optional values that can be used in lieu of actual dates. They should represent points in time relative to today.
+     * e.g. [{ label: 'Yesterday', value: 'yesterday' }, ...]
+     * These values become valid input for either end of the datetime range.
+     * e.g. "2023-11-01T08:15:30.000-05:00/yesterday"
+     */
+    optionalValues?: {
+        label: string;
+        value: string;
+    }[];
+}
+export interface DateRangeFieldSchema extends AbstractFieldSchema {
+    /**
+     * The type of the field.
+     */
+    type: FieldValueType.DATE_RANGE;
+    /**
+     * Optional values that can be used in lieu of actual dates. They should represent points in time relative to today.
+     * e.g. [{ label: 'Yesterday', value: 'yesterday' }, ...]
+     * When defined, the name of these fields becomes valid inputs for both startDatetime and endDatetime.
+     * e.g. "2023-11-01/yesterday"
+     */
+    optionalValues?: {
+        label: string;
+        value: string;
+    }[];
+}
+export interface ObjectFieldSchema extends AbstractFieldSchema {
+    /**
+     * The type of the field.
+     */
+    type: FieldValueType.OBJECT;
+    /**
+     * Describe the schema of the object.
+     */
+    fields: FieldSchema[];
+}
+/**
+ * A FieldSchema describes the shape of a field.
+ */
+export type FieldSchema = BasicFieldSchema | ReferenceFieldSchema | ObjectFieldSchema | DateRangeFieldSchema | DatetimeRangeFieldSchema;
+/**
+ * A FieldValueType determines the type of an item's value.
+ * The type represents a unique scalar value such as a string or an integer.
+ * For more complex types, use an Item instead.
+ */
+export declare enum FieldValueType {
+    BLOB = "blob",
+    BOOLEAN = "boolean",
+    DATE = "date",
+    DATE_RANGE = "dateRange",
+    DATETIME = "datetime",
+    DATETIME_RANGE = "datetimeRange",
+    DURATION = "duration",
+    EMAIL = "email",
+    RICH_TEXT_HTML = "html",
+    INTEGER = "integer",
+    RICH_TEXT_MARKDOWN = "markdown",
+    NUMBER = "number",
+    OBJECT = "object",
+    REFERENCE = "reference",
+    STRING = "string",
+    URL = "url"
+}
+/**
+ * A Semantic gives meaning to an Item or a Field in the Unito platform.
+ * An object with a specified semantic is expected to hold a certain type of value that can later be used
+ * by the consumers of the spec to better understand what that value means.
+ */
+export declare enum Semantic {
+    CANONICAL_PATH = "canonicalPath",
+    CREATED_AT = "createdAt",
+    DESCRIPTION = "description",
+    DISPLAY_NAME = "displayName",
+    PROVIDER_URL = "providerUrl",
+    UPDATED_AT = "updatedAt",
+    USER = "user"
+}
+/**
+ * An OperatorType represents an operator used in a filter.
+ */
+export declare enum OperatorType {
+    EQUAL = "=",
+    NOT_EQUAL = "!=",
+    GREATER_THAN = ">",
+    GREATER_THAN_OR_EQUAL = ">=",
+    LESSER_THAN = "<",
+    LESSER_THAN_OR_EQUAL = "<=",
+    INCLUDE = "*=",
+    EXCLUDE = "!*=",
+    START_WITH = "^=",
+    END_WITH = "$=",
+    IS_NULL = "!!",
+    IS_NOT_NULL = "!"
+}
+/**
+ * An Item represents a syncable entity. It has fields of its own as well as relations to other items.
+ */
+export interface Item {
+    /**
+     * The fields and values of the item.
+     */
+    fields: {
+        [k: string]: unknown;
+    };
+    /**
+     * The relations of the item
+     */
+    relations: Relation[];
+}
+/**
+ * An ItemSummary is a constituent of a collection.
+ * It links to an item, and can contain additional item information upon request.
+ */
+export interface ItemSummary {
+    /**
+     * Link to this specific item.
+     */
+    path: string;
+    /**
+     * Optional list of requested fields and their values.
+     */
+    fields?: {
+        [k: string]: unknown;
+    };
+    /**
+     * The shape of the request parameters.
+     */
+    requestSchema?: RequestSchema;
+}
+/**
+ * A Relation points to a Collection and describes the shape of the items it contains.
+ */
+export interface Relation {
+    /**
+     * The main identifier of the relation.
+     */
+    name: string;
+    /**
+     * The path at which the relation data is available.
+     */
+    path: string;
+    /**
+     * The shape of the request parameters.
+     */
+    requestSchema?: RequestSchema;
+    /**
+     * The publicly visible label of the relation.
+     */
+    label: string;
+    /**
+     * Whether the relation is searchable.
+     */
+    searchable?: boolean;
+    /**
+     * The shape of the relation.
+     */
+    schema: RelationSchema;
+}
+/**
+ * A summary of a relation.
+ */
+export type RelationSummary = Pick<Relation, 'name' | 'label' | 'schema'>;
+/**
+ * A Relation Schema describes the shape of an item in a relation.
+ */
+export interface RelationSchema {
+    /**
+     * The publicly visible label of one item in this relation.
+     */
+    label: string;
+    /**
+     * Can we create items?
+     */
+    canCreateItem?: boolean;
+    /**
+     * Can we update items?
+     */
+    canUpdateItem?: boolean;
+    /**
+     * Can we delete items?
+     */
+    canDeleteItem?: boolean;
+    /**
+     * The shape of the fields.
+     */
+    fields: FieldSchema[];
+    /**
+     * Summaries of the relations expected to be found on these items.
+     */
+    relations?: RelationSummary[];
+}
+/**
+ * A Request Schema describes how a path should be accessed.
+ */
+export interface RequestSchema {
+    /**
+     * The shape of the request parameters.
+     */
+    parameters: FieldSchema[];
+}
+/**
+ * HTTP code returned by the integration
+ */
+export declare enum StatusCode {
+    OK = 200,
+    CREATED = 201,
+    NO_CONTENT = 204,
+    BAD_REQUEST = 400,
+    UNAUTHORIZED = 401,
+    NOT_FOUND = 404,
+    REQUEST_TIMEOUT = 408,
+    UNPROCESSABLE_CONTENT = 422,
+    TOO_MANY_REQUESTS = 429,
+    INTERNAL_SERVER_ERROR = 500
+}
+/**
+ * A WebhookSubscriptionPayload describes the shape of the request on the "webhook subscription" endpoint.
+ */
+export interface WebhookSubscriptionRequestPayload {
+    /**
+     * The path of the item to which the subscription belongs
+     */
+    itemPath: string;
+    /**
+     * The target URL at which events should be sent
+     */
+    targetUrl: string;
+    /**
+     * The desired action to be applied to the subscription
+     */
+    action: 'start' | 'stop';
+}
+/**
+ * A WebhookParseRequestPayload describes the shape of the request on the "parse webhook" endpoint.
+ */
+export interface WebhookParseRequestPayload {
+    /**
+     * The partition data for which this webhook was received.
+     */
+    partition?: string;
+    /**
+     * The raw headers sent by the provider.
+     */
+    headers: Record<string, string | string[]>;
+    /**
+     * The raw payload sent by the provider.
+     */
+    payload: string;
+    /**
+     * The full URL, including query params, as sent by the provider
+     */
+    url: string;
+}
+/**
+ * A WebhookAcknowledgeResponsePayload describes the shape of the request on the "acknowledge webhook" endpoint.
+ */
+export interface WebhookAcknowledgeResponsePayload {
+    /**
+     * The status code that should be returned to the provider.
+     */
+    statusCode: number;
+    /**
+     * The headers that should be returned to the provider.
+     */
+    headers?: Record<string, string | string[]>;
+    /**
+     * The payload that should be returned to the provider.
+     */
+    payload?: string;
+}
+/**
+ * A WebhookParsedItem describes the shape an item found within a webhook's parsed payload.
+ */
+export interface WebhookParsedItem {
+    /**
+     * The path of the item targetted by this event.
+     */
+    itemPath: string;
+    /**
+     * The date at which the event took place, expressed as an ISO 8601 string.
+     * e.g "2023-11-05T08:15:30.000-05:00"
+     */
+    date: string;
+    /**
+     * The item's relations impacted by this event.
+     */
+    impactedRelations: {
+        /**
+         * The name of the relation.
+         */
+        name: string;
+        /**
+         * The list of specific items impacted by this event.
+         */
+        impactedItems: WebhookParsedItem[];
+    }[];
+}
+/**
+ * A WebhookParseResponsePayload describes the shape of the response on the "parse webhook" endpoint.
+ */
+export type WebhookParseResponsePayload = WebhookParsedItem | WebhookParsedItem[];
+export {};

package/dist/src/types.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StatusCode = exports.OperatorType = exports.Semantic = exports.FieldValueType = void 0;
+/**
+ * A FieldValueType determines the type of an item's value.
+ * The type represents a unique scalar value such as a string or an integer.
+ * For more complex types, use an Item instead.
+ */
+var FieldValueType;
+(function (FieldValueType) {
+    FieldValueType["BLOB"] = "blob";
+    FieldValueType["BOOLEAN"] = "boolean";
+    FieldValueType["DATE"] = "date";
+    FieldValueType["DATE_RANGE"] = "dateRange";
+    FieldValueType["DATETIME"] = "datetime";
+    FieldValueType["DATETIME_RANGE"] = "datetimeRange";
+    FieldValueType["DURATION"] = "duration";
+    FieldValueType["EMAIL"] = "email";
+    FieldValueType["RICH_TEXT_HTML"] = "html";
+    FieldValueType["INTEGER"] = "integer";
+    FieldValueType["RICH_TEXT_MARKDOWN"] = "markdown";
+    FieldValueType["NUMBER"] = "number";
+    FieldValueType["OBJECT"] = "object";
+    FieldValueType["REFERENCE"] = "reference";
+    FieldValueType["STRING"] = "string";
+    FieldValueType["URL"] = "url";
+})(FieldValueType || (exports.FieldValueType = FieldValueType = {}));
+/**
+ * A Semantic gives meaning to an Item or a Field in the Unito platform.
+ * An object with a specified semantic is expected to hold a certain type of value that can later be used
+ * by the consumers of the spec to better understand what that value means.
+ */
+var Semantic;
+(function (Semantic) {
+    Semantic["CANONICAL_PATH"] = "canonicalPath";
+    Semantic["CREATED_AT"] = "createdAt";
+    Semantic["DESCRIPTION"] = "description";
+    Semantic["DISPLAY_NAME"] = "displayName";
+    Semantic["PROVIDER_URL"] = "providerUrl";
+    Semantic["UPDATED_AT"] = "updatedAt";
+    Semantic["USER"] = "user";
+})(Semantic || (exports.Semantic = Semantic = {}));
+/**
+ * An OperatorType represents an operator used in a filter.
+ */
+var OperatorType;
+(function (OperatorType) {
+    OperatorType["EQUAL"] = "=";
+    OperatorType["NOT_EQUAL"] = "!=";
+    OperatorType["GREATER_THAN"] = ">";
+    OperatorType["GREATER_THAN_OR_EQUAL"] = ">=";
+    OperatorType["LESSER_THAN"] = "<";
+    OperatorType["LESSER_THAN_OR_EQUAL"] = "<=";
+    OperatorType["INCLUDE"] = "*=";
+    OperatorType["EXCLUDE"] = "!*=";
+    OperatorType["START_WITH"] = "^=";
+    OperatorType["END_WITH"] = "$=";
+    OperatorType["IS_NULL"] = "!!";
+    OperatorType["IS_NOT_NULL"] = "!";
+})(OperatorType || (exports.OperatorType = OperatorType = {}));
+/**
+ * HTTP code returned by the integration
+ */
+var StatusCode;
+(function (StatusCode) {
+    StatusCode[StatusCode["OK"] = 200] = "OK";
+    StatusCode[StatusCode["CREATED"] = 201] = "CREATED";
+    StatusCode[StatusCode["NO_CONTENT"] = 204] = "NO_CONTENT";
+    StatusCode[StatusCode["BAD_REQUEST"] = 400] = "BAD_REQUEST";
+    StatusCode[StatusCode["UNAUTHORIZED"] = 401] = "UNAUTHORIZED";
+    StatusCode[StatusCode["NOT_FOUND"] = 404] = "NOT_FOUND";
+    StatusCode[StatusCode["REQUEST_TIMEOUT"] = 408] = "REQUEST_TIMEOUT";
+    StatusCode[StatusCode["UNPROCESSABLE_CONTENT"] = 422] = "UNPROCESSABLE_CONTENT";
+    StatusCode[StatusCode["TOO_MANY_REQUESTS"] = 429] = "TOO_MANY_REQUESTS";
+    StatusCode[StatusCode["INTERNAL_SERVER_ERROR"] = 500] = "INTERNAL_SERVER_ERROR";
+})(StatusCode || (exports.StatusCode = StatusCode = {}));

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@unito/integration-api",
+  "version": "0.42.17",
+  "description": "The Unito Integration API",
+  "type": "commonjs",
+  "engines": {
+    "node": ">=18",
+    "npm": ">=9.5.0"
+  },
+  "scripts": {
+    "prepublishOnly": "npm run lint && npm run test",
+    "prepare": "npm run compile",
+    "lint": "eslint --fix src test --ext .ts && prettier --write src test && npx markdownlint-cli --fix README.md",
+    "compile": "tsc && mkdir -p dist/schemas && cp schemas/*.json dist/schemas/",
+    "test": "NODE_ENV=test ts-mocha -p tsconfig.json \"test/**/*.test.ts\"",
+    "test:debug": "NODE_ENV=test ts-mocha -p tsconfig.json --inspect-brk \"test/**/*.test.ts\"",
+    "ci:test": "nyc npm run test",
+    "ci:lint": "npx markdownlint-cli README.md"
+  },
+  "author": {
+    "name": "Unito",
+    "email": "hello@unito.io"
+  },
+  "license": "LicenseRef-LICENSE",
+  "keywords": [
+    "typescript",
+    "unito",
+    "unitoio",
+    "unitoinc",
+    "sync",
+    "integrations",
+    "connectors"
+  ],
+  "main": "dist/src/index.js",
+  "files": [
+    "dist/src/**/*",
+    "dist/schemas/**/*"
+  ],
+  "dependencies": {},
+  "devDependencies": {
+    "@types/chai": "4.x",
+    "@types/sinon": "10.x",
+    "@types/mocha": "10.x",
+    "@types/node": "18.x",
+    "@typescript-eslint/eslint-plugin": "6.x",
+    "@typescript-eslint/parser": "6.x",
+    "chai": "4.x",
+    "sinon": "16.x",
+    "eslint": "8.x",
+    "markdownlint-cli": "0.x",
+    "mocha": "10.x",
+    "nyc": "15.x",
+    "prettier": "3.x",
+    "ts-mocha": "10.x",
+    "ts-node": "10.x",
+    "typescript": "5.x"
+  }
+}