@unito/integration-api 5.0.0 → 6.0.0

package/dist/src/index.cjs

@@ -75,6 +75,7 @@ const StatusCodes = {
     NO_CONTENT: 204,
     BAD_REQUEST: 400,
     UNAUTHORIZED: 401,
+    PAYMENT_REQUIRED: 402,
     FORBIDDEN: 403,
     NOT_FOUND: 404,
     NOT_ACCEPTABLE: 406,

package/dist/src/types.d.ts

@@ -98,28 +98,63 @@ interface AbstractFieldSchema {
      */
     nullable?: boolean;
 }
-export interface BasicFieldSchema extends AbstractFieldSchema {
-    /**
-     * The type of the field.
-     */
-    type: Exclude<FieldValueType, typeof FieldValueTypes.BLOB | typeof FieldValueTypes.REFERENCE | typeof FieldValueTypes.OBJECT | typeof FieldValueTypes.DATETIME_RANGE | typeof FieldValueTypes.DATE_RANGE>;
+type BasicFieldValueType = Exclude<FieldValueType, typeof FieldValueTypes.BLOB | typeof FieldValueTypes.REFERENCE | typeof FieldValueTypes.OBJECT | typeof FieldValueTypes.DATETIME_RANGE | typeof FieldValueTypes.DATE_RANGE>;
+/**
+ * Semantic-constrained BasicFieldSchema variants.
+ * Each semantic restricts which field types are valid, matching the runtime
+ * validation in integrationDebugger's getSemanticSupportedFieldTypes().
+ */
+interface ProviderUrlFieldSchema extends AbstractFieldSchema {
+    semantic: typeof Semantics.PROVIDER_URL;
+    type: typeof FieldValueTypes.URL;
+}
+interface CreatedAtFieldSchema extends AbstractFieldSchema {
+    semantic: typeof Semantics.CREATED_AT;
+    type: typeof FieldValueTypes.DATETIME;
 }
+interface UpdatedAtFieldSchema extends AbstractFieldSchema {
+    semantic: typeof Semantics.UPDATED_AT;
+    type: typeof FieldValueTypes.DATETIME;
+}
+interface DescriptionFieldSchema extends AbstractFieldSchema {
+    semantic: typeof Semantics.DESCRIPTION;
+    type: typeof FieldValueTypes.RICH_TEXT_HTML | typeof FieldValueTypes.RICH_TEXT_MARKDOWN | typeof FieldValueTypes.STRING;
+}
+interface DisplayNameFieldSchema extends AbstractFieldSchema {
+    semantic: typeof Semantics.DISPLAY_NAME;
+    type: typeof FieldValueTypes.STRING | typeof FieldValueTypes.EMAIL;
+}
+interface UnconstrainedBasicFieldSchema extends AbstractFieldSchema {
+    semantic?: never;
+    type: BasicFieldValueType;
+}
+export type BasicFieldSchema = ProviderUrlFieldSchema | CreatedAtFieldSchema | UpdatedAtFieldSchema | DescriptionFieldSchema | DisplayNameFieldSchema | UnconstrainedBasicFieldSchema;
 export interface BlobFieldSchema extends AbstractFieldSchema {
     /**
      * The type of the field.
      */
     type: typeof FieldValueTypes.BLOB;
 }
-export interface ReferenceFieldSchema extends AbstractFieldSchema {
-    /**
-     * The type of the field.
-     */
+/**
+ * Semantic-constrained ReferenceFieldSchema variants.
+ * USER and PARENT semantics must use REFERENCE type.
+ */
+interface UserReferenceFieldSchema extends AbstractFieldSchema {
+    semantic: typeof Semantics.USER;
+    type: typeof FieldValueTypes.REFERENCE;
+    reference: ReferenceRelation;
+}
+interface ParentReferenceFieldSchema extends AbstractFieldSchema {
+    semantic: typeof Semantics.PARENT;
+    type: typeof FieldValueTypes.REFERENCE;
+    reference: ReferenceRelation;
+}
+interface UnconstrainedReferenceFieldSchema extends AbstractFieldSchema {
+    semantic?: never;
     type: typeof FieldValueTypes.REFERENCE;
-    /**
-     * Describe the referenced collection.
-     */
     reference: ReferenceRelation;
 }
+export type ReferenceFieldSchema = UserReferenceFieldSchema | ParentReferenceFieldSchema | UnconstrainedReferenceFieldSchema;
 /**
  * A ReferenceRelation describes a relation that can be used in a ReferenceFieldSchema.
  */
@@ -471,6 +506,7 @@ export declare const StatusCodes: {
     readonly NO_CONTENT: 204;
     readonly BAD_REQUEST: 400;
     readonly UNAUTHORIZED: 401;
+    readonly PAYMENT_REQUIRED: 402;
     readonly FORBIDDEN: 403;
     readonly NOT_FOUND: 404;
     readonly NOT_ACCEPTABLE: 406;

package/dist/src/types.js

@@ -73,6 +73,7 @@ export const StatusCodes = {
     NO_CONTENT: 204,
     BAD_REQUEST: 400,
     UNAUTHORIZED: 401,
+    PAYMENT_REQUIRED: 402,
     FORBIDDEN: 403,
     NOT_FOUND: 404,
     NOT_ACCEPTABLE: 406,

package/package.json

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