@unito/integration-api 1.0.4 → 3.0.0

package/dist/src/index.cjs

@@ -5,7 +5,7 @@
  * The type represents a unique scalar value such as a string or an integer.
  * For more complex types, use an Item instead.
  */
-const FieldValueType = {
+const FieldValueTypes = {
     BLOB: 'blob',
     BOOLEAN: 'boolean',
     DATE: 'date',
@@ -28,7 +28,7 @@ const FieldValueType = {
  * 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.
  */
-const Semantic = {
+const Semantics = {
     CREATED_AT: 'createdAt',
     DESCRIPTION: 'description',
     DISPLAY_NAME: 'displayName',
@@ -42,7 +42,7 @@ const Semantic = {
  * 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.
  */
-const RelationSemantic = {
+const RelationSemantics = {
     COMMENTS: 'comments',
     SUBTASKS: 'subtasks',
     USERS: 'users',
@@ -51,7 +51,7 @@ const RelationSemantic = {
 /**
  * An OperatorType represents an operator used in a filter.
  */
-const OperatorType = {
+const OperatorTypes = {
     EQUAL: '=',
     NOT_EQUAL: '!=',
     GREATER_THAN: '>',
@@ -68,7 +68,7 @@ const OperatorType = {
 /**
  * HTTP code returned by the integration
  */
-const StatusCode = {
+const StatusCodes = {
     OK: 200,
     CREATED: 201,
     ACCEPTED: 202,
@@ -85,8 +85,8 @@ const StatusCode = {
     INTERNAL_SERVER_ERROR: 500,
 };
 
-exports.FieldValueType = FieldValueType;
-exports.OperatorType = OperatorType;
-exports.RelationSemantic = RelationSemantic;
-exports.Semantic = Semantic;
-exports.StatusCode = StatusCode;
+exports.FieldValueTypes = FieldValueTypes;
+exports.OperatorTypes = OperatorTypes;
+exports.RelationSemantics = RelationSemantics;
+exports.Semantics = Semantics;
+exports.StatusCodes = StatusCodes;

package/dist/src/types.d.ts

@@ -70,7 +70,7 @@ interface AbstractFieldSchema {
     /**
      * The semantic of the field.
      */
-    semantic?: (typeof Semantic)[keyof typeof Semantic];
+    semantic?: Semantic;
     /**
      * Description of the field. For information purposes only.
      */
@@ -94,19 +94,19 @@ export interface BasicFieldSchema extends AbstractFieldSchema {
     /**
      * The type of the field.
      */
-    type: Exclude<(typeof FieldValueType)[keyof typeof FieldValueType], typeof FieldValueType.BLOB | typeof FieldValueType.REFERENCE | typeof FieldValueType.OBJECT | typeof FieldValueType.DATETIME_RANGE | typeof 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: typeof FieldValueType.BLOB;
+    type: typeof FieldValueTypes.BLOB;
 }
 export interface ReferenceFieldSchema extends AbstractFieldSchema {
     /**
      * The type of the field.
      */
-    type: typeof 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: typeof 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: typeof 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: typeof FieldValueType.OBJECT;
+    type: typeof FieldValueTypes.OBJECT;
     /**
      * Describe the schema of the object.
      */
@@ -163,7 +163,7 @@ 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 const FieldValueType: {
+export declare const FieldValueTypes: {
     readonly BLOB: "blob";
     readonly BOOLEAN: "boolean";
     readonly DATE: "date";
@@ -181,12 +181,13 @@ export declare const FieldValueType: {
     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 const Semantic: {
+export declare const Semantics: {
     readonly CREATED_AT: "createdAt";
     readonly DESCRIPTION: "description";
     readonly DISPLAY_NAME: "displayName";
@@ -195,21 +196,23 @@ export declare const Semantic: {
     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 const RelationSemantic: {
+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 const OperatorType: {
+export declare const OperatorTypes: {
     readonly EQUAL: "=";
     readonly NOT_EQUAL: "!=";
     readonly GREATER_THAN: ">";
@@ -223,6 +226,7 @@ export declare const OperatorType: {
     readonly IS_NULL: "!!";
     readonly IS_NOT_NULL: "!";
 };
+export type OperatorType = (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?: (typeof RelationSemantic)[keyof typeof RelationSemantic];
+    semantic?: Semantic;
     /**
      * The shape of the relation.
      */
@@ -336,7 +340,7 @@ export type RelationSummary = {
     /**
      * The semantic of the relation.
      */
-    semantic?: (typeof RelationSemantic)[keyof typeof RelationSemantic];
+    semantic?: RelationSemantic;
     /**
      * The shape of the relation.
      */
@@ -411,7 +415,7 @@ export interface RequestSchema {
 /**
  * HTTP code returned by the integration
  */
-export declare const StatusCode: {
+export declare const StatusCodes: {
     readonly OK: 200;
     readonly CREATED: 201;
     readonly ACCEPTED: 202;
@@ -427,6 +431,7 @@ export declare const StatusCode: {
     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,7 +3,7 @@
  * The type represents a unique scalar value such as a string or an integer.
  * For more complex types, use an Item instead.
  */
-export const FieldValueType = {
+export const FieldValueTypes = {
     BLOB: 'blob',
     BOOLEAN: 'boolean',
     DATE: 'date',
@@ -26,7 +26,7 @@ export const FieldValueType = {
  * 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 const Semantic = {
+export const Semantics = {
     CREATED_AT: 'createdAt',
     DESCRIPTION: 'description',
     DISPLAY_NAME: 'displayName',
@@ -40,7 +40,7 @@ export const Semantic = {
  * 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 const RelationSemantic = {
+export const RelationSemantics = {
     COMMENTS: 'comments',
     SUBTASKS: 'subtasks',
     USERS: 'users',
@@ -49,7 +49,7 @@ export const RelationSemantic = {
 /**
  * An OperatorType represents an operator used in a filter.
  */
-export const OperatorType = {
+export const OperatorTypes = {
     EQUAL: '=',
     NOT_EQUAL: '!=',
     GREATER_THAN: '>',
@@ -66,7 +66,7 @@ export const OperatorType = {
 /**
  * HTTP code returned by the integration
  */
-export const StatusCode = {
+export const StatusCodes = {
     OK: 200,
     CREATED: 201,
     ACCEPTED: 202,

package/package.json

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