@unito/integration-api 4.6.2 → 4.7.0

package/dist/schemas/fieldSchema.json

@@ -56,16 +56,20 @@
         },
         "readOnly": {
           "type": "boolean",
-          "deprecated": true
+          "deprecated": true,
+          "default": false
         },
         "canSetOnCreate": {
-          "type": "boolean"
+          "type": "boolean",
+          "default": true
         },
         "canSetOnUpdate": {
-          "type": "boolean"
+          "type": "boolean",
+          "default": true
         },
         "isArray": {
-          "type": "boolean"
+          "type": "boolean",
+          "default": false
         },
         "nullable": {
           "type": "boolean",

package/dist/schemas/relationSchema.json

@@ -11,19 +11,24 @@
       "maxLength": 100
     },
     "canReadItem": {
-      "type": "boolean"
+      "type": "boolean",
+      "default": true
     },
     "canCreateItem": {
-      "type": "boolean"
+      "type": "boolean",
+      "default": true
     },
     "canUpdateItem": {
-      "type": "boolean"
+      "type": "boolean",
+      "default": true
     },
     "canDeleteItem": {
-      "type": "boolean"
+      "type": "boolean",
+      "default": false
     },
     "canAddFields": {
-      "type": "boolean"
+      "type": "boolean",
+      "default": false
     },
     "fields": {
       "type": "array",

package/dist/src/index.cjs

@@ -84,6 +84,25 @@ const StatusCodes = {
     TOO_MANY_REQUESTS: 429,
     INTERNAL_SERVER_ERROR: 500,
 };
+/**
+ * Default values of properties of a relation schema.
+ */
+const RelationSchemaDefaultValues = {
+    CAN_READ_ITEM: true,
+    CAN_CREATE_ITEM: true,
+    CAN_UPDATE_ITEM: true,
+    CAN_DELETE_ITEM: false,
+    CAN_ADD_FIELDS: false,
+};
+/**
+ * Default values of properties of a field schema.
+ */
+const FieldSchemaDefaultValues = {
+    CAN_SET_ON_CREATE: true,
+    CAN_SET_ON_UPDATE: true,
+    IS_ARRAY: false,
+    NULLABLE: false,
+};
 
 /**
  * Checks if the input is a record<unknown, unknown>
@@ -780,8 +799,10 @@ function matchesFilter(item, filter) {
     return item[filter.property] === filter.value;
 }
 
+exports.FieldSchemaDefaultValues = FieldSchemaDefaultValues;
 exports.FieldValueTypes = FieldValueTypes;
 exports.OperatorTypes = OperatorTypes;
+exports.RelationSchemaDefaultValues = RelationSchemaDefaultValues;
 exports.RelationSemantics = RelationSemantics;
 exports.Semantics = Semantics;
 exports.StatusCodes = StatusCodes;

package/dist/src/jsonPathHelpers.d.ts

@@ -1,4 +1,4 @@
-import * as Api from './index.js';
+import * as Api from './types.js';
 /**
  * JSONPath parser that returns a relation that is guaranteed to have its schema populated.
  */

package/dist/src/jsonPathHelpers.js

@@ -1,4 +1,4 @@
-import * as Api from './index.js';
+import * as Guards from './guards.js';
 /**
  * JSONPath parser that returns a relation that is guaranteed to have its schema populated.
  */
@@ -15,15 +15,15 @@ export function findRelationByJSONPath(item, query) {
             current = previousSchema;
         }
         const result = applyToken(current, token);
-        if (Api.isObject(result) && Api.isRelationSchema(result['schema'])) {
+        if (Guards.isObject(result) && Guards.isRelationSchema(result['schema'])) {
             schemas.push(result['schema']);
         }
         current = result;
     }
-    if (Api.isRelation(current)) {
+    if (Guards.isRelation(current)) {
         return current;
     }
-    if (Api.isReferenceRelation(current) || Api.isRelationSummary(current)) {
+    if (Guards.isReferenceRelation(current) || Guards.isRelationSummary(current)) {
         const latestSchema = schemas[schemas.length - 1];
         if (latestSchema === undefined) {
             throw new Error(`No schema found for relation ${current.label}`);
@@ -125,7 +125,7 @@ function applyToken(current, token) {
  * Apply property access
  */
 function applyProperty(current, property) {
-    if (!Api.isObject(current) || !(property in current)) {
+    if (!Guards.isObject(current) || !(property in current)) {
         return undefined;
     }
     return current[property];
@@ -149,7 +149,7 @@ function applyFilter(current, filter) {
         return undefined;
     }
     for (const item of current) {
-        if (Api.isObject(item) && matchesFilter(item, filter)) {
+        if (Guards.isObject(item) && matchesFilter(item, filter)) {
             return item;
         }
     }

package/dist/src/types.d.ts

@@ -94,10 +94,12 @@ interface AbstractFieldSchema {
      * 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.
+     * Defaults to false.
      */
     isArray?: boolean;
     /**
-     * Whether the field can be empty. Default to true.
+     * Whether the field can be empty.
+     * Defaults to true.
      */
     nullable?: boolean;
 }
@@ -595,4 +597,23 @@ export interface WebhookItem {
  * A WebhookParseResponsePayload describes the shape of the response on the "parse webhook" endpoint.
  */
 export type WebhookParseResponsePayload = WebhookParsedItem | WebhookItem | (WebhookParsedItem | WebhookItem)[];
+/**
+ * Default values of properties of a relation schema.
+ */
+export declare const RelationSchemaDefaultValues: {
+    readonly CAN_READ_ITEM: true;
+    readonly CAN_CREATE_ITEM: true;
+    readonly CAN_UPDATE_ITEM: true;
+    readonly CAN_DELETE_ITEM: false;
+    readonly CAN_ADD_FIELDS: false;
+};
+/**
+ * Default values of properties of a field schema.
+ */
+export declare const FieldSchemaDefaultValues: {
+    readonly CAN_SET_ON_CREATE: true;
+    readonly CAN_SET_ON_UPDATE: true;
+    readonly IS_ARRAY: false;
+    readonly NULLABLE: false;
+};
 export {};

package/dist/src/types.js

@@ -82,3 +82,22 @@ export const StatusCodes = {
     TOO_MANY_REQUESTS: 429,
     INTERNAL_SERVER_ERROR: 500,
 };
+/**
+ * Default values of properties of a relation schema.
+ */
+export const RelationSchemaDefaultValues = {
+    CAN_READ_ITEM: true,
+    CAN_CREATE_ITEM: true,
+    CAN_UPDATE_ITEM: true,
+    CAN_DELETE_ITEM: false,
+    CAN_ADD_FIELDS: false,
+};
+/**
+ * Default values of properties of a field schema.
+ */
+export const FieldSchemaDefaultValues = {
+    CAN_SET_ON_CREATE: true,
+    CAN_SET_ON_UPDATE: true,
+    IS_ARRAY: false,
+    NULLABLE: false,
+};

package/package.json

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