@unito/integration-api 4.2.7 → 4.2.9

package/dist/schemas/fieldSchema.json

@@ -55,6 +55,13 @@
           "type": "string"
         },
         "readOnly": {
+          "type": "boolean",
+          "deprecated": true
+        },
+        "canSetOnCreate": {
+          "type": "boolean"
+        },
+        "canSetOnUpdate": {
           "type": "boolean"
         },
         "isArray": {

package/dist/src/compatibilities.d.ts

@@ -215,7 +215,13 @@ export declare const fieldTypeCompatibilityMatrix: {
         readonly integer: null;
         readonly number: null;
         readonly object: null;
-        readonly reference: null;
+        readonly reference: {
+            readonly field: {
+                readonly type: "string";
+                readonly default: "semantic:displayName";
+                readonly description: "The field against which to match the string value.";
+            };
+        };
         readonly html: {};
         readonly markdown: {};
         readonly string: {};
@@ -283,11 +289,23 @@ export declare const fieldTypeCompatibilityMatrix: {
         readonly datetime: null;
         readonly datetimeRange: null;
         readonly duration: null;
-        readonly email: null;
+        readonly email: {
+            readonly field: {
+                readonly type: "string";
+                readonly default: "semantic:displayName";
+                readonly description: "The field of the referenced entry to use for the string value.";
+            };
+        };
         readonly integer: null;
         readonly number: null;
         readonly object: null;
-        readonly reference: {};
+        readonly reference: {
+            readonly sideIds: {
+                readonly type: "string";
+                readonly description: "If specified, only the references kept in sync in the specified link sides will be evaluated.";
+                readonly isArray: true;
+            };
+        };
         readonly html: {
             readonly field: {
                 readonly type: "string";

package/dist/src/compatibilities.js

@@ -206,7 +206,7 @@ export const fieldTypeCompatibilityMatrix = {
         [Api.FieldValueTypes.INTEGER]: null,
         [Api.FieldValueTypes.NUMBER]: null,
         [Api.FieldValueTypes.OBJECT]: null,
-        [Api.FieldValueTypes.REFERENCE]: null,
+        [Api.FieldValueTypes.REFERENCE]: stringLikeToReferenceConfiguration,
         [Api.FieldValueTypes.RICH_TEXT_HTML]: {},
         [Api.FieldValueTypes.RICH_TEXT_MARKDOWN]: {},
         [Api.FieldValueTypes.STRING]: {},
@@ -274,11 +274,17 @@ export const fieldTypeCompatibilityMatrix = {
         [Api.FieldValueTypes.DATETIME]: null,
         [Api.FieldValueTypes.DATETIME_RANGE]: null,
         [Api.FieldValueTypes.DURATION]: null,
-        [Api.FieldValueTypes.EMAIL]: null,
+        [Api.FieldValueTypes.EMAIL]: referenceToStringLikeConfiguration,
         [Api.FieldValueTypes.INTEGER]: null,
         [Api.FieldValueTypes.NUMBER]: null,
         [Api.FieldValueTypes.OBJECT]: null,
-        [Api.FieldValueTypes.REFERENCE]: {},
+        [Api.FieldValueTypes.REFERENCE]: {
+            sideIds: {
+                type: 'string',
+                description: 'If specified, only the references kept in sync in the specified link sides will be evaluated.',
+                isArray: true,
+            },
+        },
         [Api.FieldValueTypes.RICH_TEXT_HTML]: referenceToStringLikeConfiguration,
         [Api.FieldValueTypes.RICH_TEXT_MARKDOWN]: referenceToStringLikeConfiguration,
         [Api.FieldValueTypes.STRING]: referenceToStringLikeConfiguration,

package/dist/src/index.cjs

@@ -425,7 +425,7 @@ const fieldTypeCompatibilityMatrix = {
         [FieldValueTypes.INTEGER]: null,
         [FieldValueTypes.NUMBER]: null,
         [FieldValueTypes.OBJECT]: null,
-        [FieldValueTypes.REFERENCE]: null,
+        [FieldValueTypes.REFERENCE]: stringLikeToReferenceConfiguration,
         [FieldValueTypes.RICH_TEXT_HTML]: {},
         [FieldValueTypes.RICH_TEXT_MARKDOWN]: {},
         [FieldValueTypes.STRING]: {},
@@ -493,11 +493,17 @@ const fieldTypeCompatibilityMatrix = {
         [FieldValueTypes.DATETIME]: null,
         [FieldValueTypes.DATETIME_RANGE]: null,
         [FieldValueTypes.DURATION]: null,
-        [FieldValueTypes.EMAIL]: null,
+        [FieldValueTypes.EMAIL]: referenceToStringLikeConfiguration,
         [FieldValueTypes.INTEGER]: null,
         [FieldValueTypes.NUMBER]: null,
         [FieldValueTypes.OBJECT]: null,
-        [FieldValueTypes.REFERENCE]: {},
+        [FieldValueTypes.REFERENCE]: {
+            sideIds: {
+                type: 'string',
+                description: 'If specified, only the references kept in sync in the specified link sides will be evaluated.',
+                isArray: true,
+            },
+        },
         [FieldValueTypes.RICH_TEXT_HTML]: referenceToStringLikeConfiguration,
         [FieldValueTypes.RICH_TEXT_MARKDOWN]: referenceToStringLikeConfiguration,
         [FieldValueTypes.STRING]: referenceToStringLikeConfiguration,

package/dist/src/types.d.ts

@@ -77,8 +77,19 @@ interface AbstractFieldSchema {
     info?: string;
     /**
      * Whether the field is read only.
+     * @deprecated Use canSetOnCreate/canUpdate instead.
      */
     readOnly?: boolean;
+    /**
+     * Whether the field can be set during creation.
+     * Defaults to true.
+     */
+    canSetOnCreate?: boolean;
+    /**
+     * Whether the field can be updated after creation.
+     * Defaults to true.
+     */
+    canSetOnUpdate?: boolean;
     /**
      * Whether the field returns an array. Defaults to false.
      * An array is a non-paginated list of same-type values.

package/package.json

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