@unito/integration-api 1.0.3 → 2.0.0

package/dist/src/index.cjs

@@ -5,87 +5,88 @@
  * The type represents a unique scalar value such as a string or an integer.
  * For more complex types, use an Item instead.
  */
-exports.FieldValueType = void 0;
-(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";
-})(exports.FieldValueType || (exports.FieldValueType = {}));
+const FieldValueTypes = {
+    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.
  */
-exports.Semantic = void 0;
-(function (Semantic) {
-    Semantic["CREATED_AT"] = "createdAt";
-    Semantic["DESCRIPTION"] = "description";
-    Semantic["DISPLAY_NAME"] = "displayName";
-    Semantic["PROVIDER_URL"] = "providerUrl";
-    Semantic["UPDATED_AT"] = "updatedAt";
-    Semantic["USER"] = "user";
-    Semantic["PARENT"] = "parent";
-})(exports.Semantic || (exports.Semantic = {}));
+const Semantics = {
+    CREATED_AT: 'createdAt',
+    DESCRIPTION: 'description',
+    DISPLAY_NAME: 'displayName',
+    PROVIDER_URL: 'providerUrl',
+    UPDATED_AT: 'updatedAt',
+    USER: 'user',
+    PARENT: 'parent',
+};
 /**
  * A Relation Semantic gives meaning to a Relation in the Unito platform. A relation with a
  * specified semantic is expected to hold a certain type of item that can later be used by
  * the consumers of the spec for specific usage.
  */
-exports.RelationSemantic = void 0;
-(function (RelationSemantic) {
-    RelationSemantic["COMMENTS"] = "comments";
-    RelationSemantic["SUBTASKS"] = "subtasks";
-    RelationSemantic["USERS"] = "users";
-    RelationSemantic["ATTACHMENTS"] = "attachments";
-})(exports.RelationSemantic || (exports.RelationSemantic = {}));
+const RelationSemantics = {
+    COMMENTS: 'comments',
+    SUBTASKS: 'subtasks',
+    USERS: 'users',
+    ATTACHMENTS: 'attachments',
+};
 /**
  * An OperatorType represents an operator used in a filter.
  */
-exports.OperatorType = void 0;
-(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"] = "!";
-})(exports.OperatorType || (exports.OperatorType = {}));
+const OperatorTypes = {
+    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: '!',
+};
 /**
  * HTTP code returned by the integration
  */
-exports.StatusCode = void 0;
-(function (StatusCode) {
-    StatusCode[StatusCode["OK"] = 200] = "OK";
-    StatusCode[StatusCode["CREATED"] = 201] = "CREATED";
-    StatusCode[StatusCode["ACCEPTED"] = 202] = "ACCEPTED";
-    StatusCode[StatusCode["NO_CONTENT"] = 204] = "NO_CONTENT";
-    StatusCode[StatusCode["BAD_REQUEST"] = 400] = "BAD_REQUEST";
-    StatusCode[StatusCode["UNAUTHORIZED"] = 401] = "UNAUTHORIZED";
-    StatusCode[StatusCode["FORBIDDEN"] = 403] = "FORBIDDEN";
-    StatusCode[StatusCode["NOT_FOUND"] = 404] = "NOT_FOUND";
-    StatusCode[StatusCode["NOT_ACCEPTABLE"] = 406] = "NOT_ACCEPTABLE";
-    StatusCode[StatusCode["REQUEST_TIMEOUT"] = 408] = "REQUEST_TIMEOUT";
-    StatusCode[StatusCode["UNPROCESSABLE_CONTENT"] = 422] = "UNPROCESSABLE_CONTENT";
-    StatusCode[StatusCode["LOCKED"] = 423] = "LOCKED";
-    StatusCode[StatusCode["TOO_MANY_REQUESTS"] = 429] = "TOO_MANY_REQUESTS";
-    StatusCode[StatusCode["INTERNAL_SERVER_ERROR"] = 500] = "INTERNAL_SERVER_ERROR";
-})(exports.StatusCode || (exports.StatusCode = {}));
+const StatusCodes = {
+    OK: 200,
+    CREATED: 201,
+    ACCEPTED: 202,
+    NO_CONTENT: 204,
+    BAD_REQUEST: 400,
+    UNAUTHORIZED: 401,
+    FORBIDDEN: 403,
+    NOT_FOUND: 404,
+    NOT_ACCEPTABLE: 406,
+    REQUEST_TIMEOUT: 408,
+    UNPROCESSABLE_CONTENT: 422,
+    LOCKED: 423,
+    TOO_MANY_REQUESTS: 429,
+    INTERNAL_SERVER_ERROR: 500,
+};
+
+exports.FieldValueTypes = FieldValueTypes;
+exports.OperatorTypes = OperatorTypes;
+exports.RelationSemantics = RelationSemantics;
+exports.Semantics = Semantics;
+exports.StatusCodes = StatusCodes;

package/dist/src/types.d.ts

@@ -94,19 +94,19 @@ export interface BasicFieldSchema extends AbstractFieldSchema {
     /**
      * The type of the field.
      */
-    type: Exclude<FieldValueType, FieldValueType.BLOB | FieldValueType.REFERENCE | FieldValueType.OBJECT | FieldValueType.DATETIME_RANGE | FieldValueType.DATE_RANGE>;
+    type: Exclude<FieldValueType, typeof FieldValueTypes.BLOB | typeof FieldValueTypes.REFERENCE | typeof FieldValueTypes.OBJECT | typeof FieldValueTypes.DATETIME_RANGE | typeof FieldValueTypes.DATE_RANGE>;
 }
 export interface BlobFieldSchema extends AbstractFieldSchema {
     /**
      * The type of the field.
      */
-    type: FieldValueType.BLOB;
+    type: typeof FieldValueTypes.BLOB;
 }
 export interface ReferenceFieldSchema extends AbstractFieldSchema {
     /**
      * The type of the field.
      */
-    type: FieldValueType.REFERENCE;
+    type: typeof FieldValueTypes.REFERENCE;
     /**
      * Describe the referenced collection.
      */
@@ -116,7 +116,7 @@ export interface DatetimeRangeFieldSchema extends AbstractFieldSchema {
     /**
      * The type of the field.
      */
-    type: FieldValueType.DATETIME_RANGE;
+    type: typeof FieldValueTypes.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' }, ...]
@@ -132,7 +132,7 @@ export interface DateRangeFieldSchema extends AbstractFieldSchema {
     /**
      * The type of the field.
      */
-    type: FieldValueType.DATE_RANGE;
+    type: typeof FieldValueTypes.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' }, ...]
@@ -148,7 +148,7 @@ export interface ObjectFieldSchema extends AbstractFieldSchema {
     /**
      * The type of the field.
      */
-    type: FieldValueType.OBJECT;
+    type: typeof FieldValueTypes.OBJECT;
     /**
      * Describe the schema of the object.
      */
@@ -163,66 +163,70 @@ export type FieldSchema = BasicFieldSchema | BlobFieldSchema | ReferenceFieldSch
  * 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"
-}
+export declare const FieldValueTypes: {
+    readonly BLOB: "blob";
+    readonly BOOLEAN: "boolean";
+    readonly DATE: "date";
+    readonly DATE_RANGE: "dateRange";
+    readonly DATETIME: "datetime";
+    readonly DATETIME_RANGE: "datetimeRange";
+    readonly DURATION: "duration";
+    readonly EMAIL: "email";
+    readonly RICH_TEXT_HTML: "html";
+    readonly INTEGER: "integer";
+    readonly RICH_TEXT_MARKDOWN: "markdown";
+    readonly NUMBER: "number";
+    readonly OBJECT: "object";
+    readonly REFERENCE: "reference";
+    readonly STRING: "string";
+    readonly URL: "url";
+};
+export type FieldValueType = (typeof FieldValueTypes)[keyof typeof FieldValueTypes];
 /**
  * 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 {
-    CREATED_AT = "createdAt",
-    DESCRIPTION = "description",
-    DISPLAY_NAME = "displayName",
-    PROVIDER_URL = "providerUrl",
-    UPDATED_AT = "updatedAt",
-    USER = "user",
-    PARENT = "parent"
-}
+export declare const Semantics: {
+    readonly CREATED_AT: "createdAt";
+    readonly DESCRIPTION: "description";
+    readonly DISPLAY_NAME: "displayName";
+    readonly PROVIDER_URL: "providerUrl";
+    readonly UPDATED_AT: "updatedAt";
+    readonly USER: "user";
+    readonly PARENT: "parent";
+};
+export type Semantic = (typeof Semantics)[keyof typeof Semantics];
 /**
  * A Relation Semantic gives meaning to a Relation in the Unito platform. A relation with a
  * specified semantic is expected to hold a certain type of item that can later be used by
  * the consumers of the spec for specific usage.
  */
-export declare enum RelationSemantic {
-    COMMENTS = "comments",
-    SUBTASKS = "subtasks",
-    USERS = "users",
-    ATTACHMENTS = "attachments"
-}
+export declare const RelationSemantics: {
+    readonly COMMENTS: "comments";
+    readonly SUBTASKS: "subtasks";
+    readonly USERS: "users";
+    readonly ATTACHMENTS: "attachments";
+};
+export type RelationSemantic = (typeof RelationSemantics)[keyof typeof RelationSemantics];
 /**
  * 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 = "!"
-}
+export declare const OperatorTypes: {
+    readonly EQUAL: "=";
+    readonly NOT_EQUAL: "!=";
+    readonly GREATER_THAN: ">";
+    readonly GREATER_THAN_OR_EQUAL: ">=";
+    readonly LESSER_THAN: "<";
+    readonly LESSER_THAN_OR_EQUAL: "<=";
+    readonly INCLUDE: "*=";
+    readonly EXCLUDE: "!*=";
+    readonly START_WITH: "^=";
+    readonly END_WITH: "$=";
+    readonly IS_NULL: "!!";
+    readonly IS_NOT_NULL: "!";
+};
+export type OperationType = (typeof OperatorTypes)[keyof typeof OperatorTypes];
 /**
  * An Item represents a syncable entity. It has fields of its own as well as relations to other items.
  */
@@ -310,7 +314,7 @@ export interface Relation {
     /**
      * The semantic of the relation.
      */
-    semantic?: RelationSemantic;
+    semantic?: Semantic;
     /**
      * The shape of the relation.
      */
@@ -411,22 +415,23 @@ export interface RequestSchema {
 /**
  * HTTP code returned by the integration
  */
-export declare enum StatusCode {
-    OK = 200,
-    CREATED = 201,
-    ACCEPTED = 202,
-    NO_CONTENT = 204,
-    BAD_REQUEST = 400,
-    UNAUTHORIZED = 401,
-    FORBIDDEN = 403,
-    NOT_FOUND = 404,
-    NOT_ACCEPTABLE = 406,
-    REQUEST_TIMEOUT = 408,
-    UNPROCESSABLE_CONTENT = 422,
-    LOCKED = 423,
-    TOO_MANY_REQUESTS = 429,
-    INTERNAL_SERVER_ERROR = 500
-}
+export declare const StatusCodes: {
+    readonly OK: 200;
+    readonly CREATED: 201;
+    readonly ACCEPTED: 202;
+    readonly NO_CONTENT: 204;
+    readonly BAD_REQUEST: 400;
+    readonly UNAUTHORIZED: 401;
+    readonly FORBIDDEN: 403;
+    readonly NOT_FOUND: 404;
+    readonly NOT_ACCEPTABLE: 406;
+    readonly REQUEST_TIMEOUT: 408;
+    readonly UNPROCESSABLE_CONTENT: 422;
+    readonly LOCKED: 423;
+    readonly TOO_MANY_REQUESTS: 429;
+    readonly INTERNAL_SERVER_ERROR: 500;
+};
+export type StatusCode = (typeof StatusCodes)[keyof typeof StatusCodes];
 /**
  * A WebhookSubscriptionPayload describes the shape of the request on the "webhook subscription" endpoint.
  */

package/dist/src/types.js

@@ -3,87 +3,82 @@
  * The type represents a unique scalar value such as a string or an integer.
  * For more complex types, use an Item instead.
  */
-export 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 || (FieldValueType = {}));
+export const FieldValueTypes = {
+    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 var Semantic;
-(function (Semantic) {
-    Semantic["CREATED_AT"] = "createdAt";
-    Semantic["DESCRIPTION"] = "description";
-    Semantic["DISPLAY_NAME"] = "displayName";
-    Semantic["PROVIDER_URL"] = "providerUrl";
-    Semantic["UPDATED_AT"] = "updatedAt";
-    Semantic["USER"] = "user";
-    Semantic["PARENT"] = "parent";
-})(Semantic || (Semantic = {}));
+export const Semantics = {
+    CREATED_AT: 'createdAt',
+    DESCRIPTION: 'description',
+    DISPLAY_NAME: 'displayName',
+    PROVIDER_URL: 'providerUrl',
+    UPDATED_AT: 'updatedAt',
+    USER: 'user',
+    PARENT: 'parent',
+};
 /**
  * A Relation Semantic gives meaning to a Relation in the Unito platform. A relation with a
  * specified semantic is expected to hold a certain type of item that can later be used by
  * the consumers of the spec for specific usage.
  */
-export var RelationSemantic;
-(function (RelationSemantic) {
-    RelationSemantic["COMMENTS"] = "comments";
-    RelationSemantic["SUBTASKS"] = "subtasks";
-    RelationSemantic["USERS"] = "users";
-    RelationSemantic["ATTACHMENTS"] = "attachments";
-})(RelationSemantic || (RelationSemantic = {}));
+export const RelationSemantics = {
+    COMMENTS: 'comments',
+    SUBTASKS: 'subtasks',
+    USERS: 'users',
+    ATTACHMENTS: 'attachments',
+};
 /**
  * An OperatorType represents an operator used in a filter.
  */
-export 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 || (OperatorType = {}));
+export const OperatorTypes = {
+    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: '!',
+};
 /**
  * HTTP code returned by the integration
  */
-export var StatusCode;
-(function (StatusCode) {
-    StatusCode[StatusCode["OK"] = 200] = "OK";
-    StatusCode[StatusCode["CREATED"] = 201] = "CREATED";
-    StatusCode[StatusCode["ACCEPTED"] = 202] = "ACCEPTED";
-    StatusCode[StatusCode["NO_CONTENT"] = 204] = "NO_CONTENT";
-    StatusCode[StatusCode["BAD_REQUEST"] = 400] = "BAD_REQUEST";
-    StatusCode[StatusCode["UNAUTHORIZED"] = 401] = "UNAUTHORIZED";
-    StatusCode[StatusCode["FORBIDDEN"] = 403] = "FORBIDDEN";
-    StatusCode[StatusCode["NOT_FOUND"] = 404] = "NOT_FOUND";
-    StatusCode[StatusCode["NOT_ACCEPTABLE"] = 406] = "NOT_ACCEPTABLE";
-    StatusCode[StatusCode["REQUEST_TIMEOUT"] = 408] = "REQUEST_TIMEOUT";
-    StatusCode[StatusCode["UNPROCESSABLE_CONTENT"] = 422] = "UNPROCESSABLE_CONTENT";
-    StatusCode[StatusCode["LOCKED"] = 423] = "LOCKED";
-    StatusCode[StatusCode["TOO_MANY_REQUESTS"] = 429] = "TOO_MANY_REQUESTS";
-    StatusCode[StatusCode["INTERNAL_SERVER_ERROR"] = 500] = "INTERNAL_SERVER_ERROR";
-})(StatusCode || (StatusCode = {}));
+export const StatusCodes = {
+    OK: 200,
+    CREATED: 201,
+    ACCEPTED: 202,
+    NO_CONTENT: 204,
+    BAD_REQUEST: 400,
+    UNAUTHORIZED: 401,
+    FORBIDDEN: 403,
+    NOT_FOUND: 404,
+    NOT_ACCEPTABLE: 406,
+    REQUEST_TIMEOUT: 408,
+    UNPROCESSABLE_CONTENT: 422,
+    LOCKED: 423,
+    TOO_MANY_REQUESTS: 429,
+    INTERNAL_SERVER_ERROR: 500,
+};

package/package.json

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