@unito/integration-api 4.4.0 → 4.5.1

package/dist/schemas/webhookParsedItem.json

@@ -7,6 +7,9 @@
     "itemPath": {
       "type": "string"
     },
+    "itemSummary": {
+      "$ref": "https://unito.io/integration_api/itemSummary.schema.json"
+    },
     "date": {
       "type": "string"
     },

package/dist/src/compatibilities.d.ts

@@ -51,13 +51,17 @@ export declare const fieldTypeCompatibilityMatrix: {
         readonly html: {
             readonly locale: {
                 readonly type: "enum";
-                readonly default: "en-CA";
+                readonly defaults: [{
+                    readonly value: "en-CA";
+                }];
                 readonly values: ["en-CA"];
                 readonly description: "The locale to use for formatting the date.";
             };
             readonly timezone: {
                 readonly type: "enum";
-                readonly default: "UTC";
+                readonly defaults: [{
+                    readonly value: "UTC";
+                }];
                 readonly values: ["UTC"];
                 readonly description: "The timezone to use for formatting the date.";
             };
@@ -65,13 +69,17 @@ export declare const fieldTypeCompatibilityMatrix: {
         readonly markdown: {
             readonly locale: {
                 readonly type: "enum";
-                readonly default: "en-CA";
+                readonly defaults: [{
+                    readonly value: "en-CA";
+                }];
                 readonly values: ["en-CA"];
                 readonly description: "The locale to use for formatting the date.";
             };
             readonly timezone: {
                 readonly type: "enum";
-                readonly default: "UTC";
+                readonly defaults: [{
+                    readonly value: "UTC";
+                }];
                 readonly values: ["UTC"];
                 readonly description: "The timezone to use for formatting the date.";
             };
@@ -79,13 +87,17 @@ export declare const fieldTypeCompatibilityMatrix: {
         readonly string: {
             readonly locale: {
                 readonly type: "enum";
-                readonly default: "en-CA";
+                readonly defaults: [{
+                    readonly value: "en-CA";
+                }];
                 readonly values: ["en-CA"];
                 readonly description: "The locale to use for formatting the date.";
             };
             readonly timezone: {
                 readonly type: "enum";
-                readonly default: "UTC";
+                readonly defaults: [{
+                    readonly value: "UTC";
+                }];
                 readonly values: ["UTC"];
                 readonly description: "The timezone to use for formatting the date.";
             };
@@ -126,13 +138,17 @@ export declare const fieldTypeCompatibilityMatrix: {
         readonly html: {
             readonly locale: {
                 readonly type: "enum";
-                readonly default: "en-CA";
+                readonly defaults: [{
+                    readonly value: "en-CA";
+                }];
                 readonly values: ["en-CA"];
                 readonly description: "The locale to use for formatting the date.";
             };
             readonly timezone: {
                 readonly type: "enum";
-                readonly default: "UTC";
+                readonly defaults: [{
+                    readonly value: "UTC";
+                }];
                 readonly values: ["UTC"];
                 readonly description: "The timezone to use for formatting the date.";
             };
@@ -140,13 +156,17 @@ export declare const fieldTypeCompatibilityMatrix: {
         readonly markdown: {
             readonly locale: {
                 readonly type: "enum";
-                readonly default: "en-CA";
+                readonly defaults: [{
+                    readonly value: "en-CA";
+                }];
                 readonly values: ["en-CA"];
                 readonly description: "The locale to use for formatting the date.";
             };
             readonly timezone: {
                 readonly type: "enum";
-                readonly default: "UTC";
+                readonly defaults: [{
+                    readonly value: "UTC";
+                }];
                 readonly values: ["UTC"];
                 readonly description: "The timezone to use for formatting the date.";
             };
@@ -154,13 +174,17 @@ export declare const fieldTypeCompatibilityMatrix: {
         readonly string: {
             readonly locale: {
                 readonly type: "enum";
-                readonly default: "en-CA";
+                readonly defaults: [{
+                    readonly value: "en-CA";
+                }];
                 readonly values: ["en-CA"];
                 readonly description: "The locale to use for formatting the date.";
             };
             readonly timezone: {
                 readonly type: "enum";
-                readonly default: "UTC";
+                readonly defaults: [{
+                    readonly value: "UTC";
+                }];
                 readonly values: ["UTC"];
                 readonly description: "The timezone to use for formatting the date.";
             };
@@ -218,7 +242,9 @@ export declare const fieldTypeCompatibilityMatrix: {
         readonly reference: {
             readonly field: {
                 readonly type: "targetField";
-                readonly default: "semantic:displayName";
+                readonly defaults: [{
+                    readonly value: "semantic:displayName";
+                }];
                 readonly description: "The field against which to match the string value.";
                 readonly required: true;
             };
@@ -293,7 +319,9 @@ export declare const fieldTypeCompatibilityMatrix: {
         readonly email: {
             readonly field: {
                 readonly type: "sourceField";
-                readonly default: "semantic:displayName";
+                readonly defaults: [{
+                    readonly value: "semantic:displayName";
+                }];
                 readonly description: "The field of the referenced entry to use for the string value.";
                 readonly required: true;
             };
@@ -306,7 +334,9 @@ export declare const fieldTypeCompatibilityMatrix: {
                 readonly type: "sideIdOfSameCollection";
                 readonly description: "If specified, only the references kept in sync in the specified link sides will be evaluated. An empty array means no side will be evaluated.";
                 readonly isArray: true;
-                readonly default: readonly [];
+                readonly defaults: [{
+                    readonly value: readonly [];
+                }];
             };
             readonly type: {
                 readonly type: "enum";
@@ -320,7 +350,9 @@ export declare const fieldTypeCompatibilityMatrix: {
         readonly html: {
             readonly field: {
                 readonly type: "sourceField";
-                readonly default: "semantic:displayName";
+                readonly defaults: [{
+                    readonly value: "semantic:displayName";
+                }];
                 readonly description: "The field of the referenced entry to use for the string value.";
                 readonly required: true;
             };
@@ -328,7 +360,9 @@ export declare const fieldTypeCompatibilityMatrix: {
         readonly markdown: {
             readonly field: {
                 readonly type: "sourceField";
-                readonly default: "semantic:displayName";
+                readonly defaults: [{
+                    readonly value: "semantic:displayName";
+                }];
                 readonly description: "The field of the referenced entry to use for the string value.";
                 readonly required: true;
             };
@@ -336,7 +370,9 @@ export declare const fieldTypeCompatibilityMatrix: {
         readonly string: {
             readonly field: {
                 readonly type: "sourceField";
-                readonly default: "semantic:displayName";
+                readonly defaults: [{
+                    readonly value: "semantic:displayName";
+                }];
                 readonly description: "The field of the referenced entry to use for the string value.";
                 readonly required: true;
             };
@@ -357,42 +393,54 @@ export declare const fieldTypeCompatibilityMatrix: {
         readonly object: null;
         readonly reference: null;
         readonly html: {
-            readonly decorator: {
-                readonly type: "boolean";
-                readonly description: "Decorate the content with author information and optional date.";
-                readonly default: false;
-                readonly hidden: true;
-            };
             readonly decoratorTemplate: {
                 readonly type: "stringWithSourceItemFields";
                 readonly description: "Template for the decorator. Use {author} and {date} placeholders.";
-                readonly default: "On <strong>{semantic:createdAt}</strong>, <em>{semantic:user.fields.semantic:displayName}</em> commented:";
+                readonly defaults: [{
+                    readonly sourceRelationSemantic: "comments";
+                    readonly sourceFieldSemantic: "description";
+                    readonly targetRelationSemantic: "comments";
+                    readonly targetFieldSemantic: "description";
+                    readonly value: "On <strong>{semantic:createdAt}</strong>, <em>{semantic:user.fields.semantic:displayName}</em> commented:";
+                }];
                 readonly hidden: true;
             };
             readonly decoratorPrefix: {
                 readonly type: "string";
                 readonly description: "Prefix for the decorator. Defaults to \"➤\".";
-                readonly default: "➤";
+                readonly defaults: [{
+                    readonly sourceRelationSemantic: "comments";
+                    readonly sourceFieldSemantic: "description";
+                    readonly targetRelationSemantic: "comments";
+                    readonly targetFieldSemantic: "description";
+                    readonly value: "➤";
+                }];
                 readonly hidden: true;
             };
         };
         readonly markdown: {
-            readonly decorator: {
-                readonly type: "boolean";
-                readonly description: "Decorate the content with author information and optional date.";
-                readonly default: false;
-                readonly hidden: true;
-            };
             readonly decoratorTemplate: {
                 readonly type: "stringWithSourceItemFields";
                 readonly description: "Template for the decorator. Use {author} and {date} placeholders.";
-                readonly default: "On <strong>{semantic:createdAt}</strong>, <em>{semantic:user.fields.semantic:displayName}</em> commented:";
+                readonly defaults: [{
+                    readonly sourceRelationSemantic: "comments";
+                    readonly sourceFieldSemantic: "description";
+                    readonly targetRelationSemantic: "comments";
+                    readonly targetFieldSemantic: "description";
+                    readonly value: "On <strong>{semantic:createdAt}</strong>, <em>{semantic:user.fields.semantic:displayName}</em> commented:";
+                }];
                 readonly hidden: true;
             };
             readonly decoratorPrefix: {
                 readonly type: "string";
                 readonly description: "Prefix for the decorator. Defaults to \"➤\".";
-                readonly default: "➤";
+                readonly defaults: [{
+                    readonly sourceRelationSemantic: "comments";
+                    readonly sourceFieldSemantic: "description";
+                    readonly targetRelationSemantic: "comments";
+                    readonly targetFieldSemantic: "description";
+                    readonly value: "➤";
+                }];
                 readonly hidden: true;
             };
         };
@@ -413,42 +461,54 @@ export declare const fieldTypeCompatibilityMatrix: {
         readonly object: null;
         readonly reference: null;
         readonly html: {
-            readonly decorator: {
-                readonly type: "boolean";
-                readonly description: "Decorate the content with author information and optional date.";
-                readonly default: false;
-                readonly hidden: true;
-            };
             readonly decoratorTemplate: {
                 readonly type: "stringWithSourceItemFields";
                 readonly description: "Template for the decorator. Use {author} and {date} placeholders.";
-                readonly default: "On **{semantic:createdAt}**, __{semantic:user.fields.semantic:displayName}__ commented:";
+                readonly defaults: [{
+                    readonly sourceRelationSemantic: "comments";
+                    readonly sourceFieldSemantic: "description";
+                    readonly targetRelationSemantic: "comments";
+                    readonly targetFieldSemantic: "description";
+                    readonly value: "On **{semantic:createdAt}**, __{semantic:user.fields.semantic:displayName}__ commented:";
+                }];
                 readonly hidden: true;
             };
             readonly decoratorPrefix: {
                 readonly type: "string";
                 readonly description: "Prefix for the decorator. Defaults to \"➤\".";
-                readonly default: "➤";
+                readonly defaults: [{
+                    readonly sourceRelationSemantic: "comments";
+                    readonly sourceFieldSemantic: "description";
+                    readonly targetRelationSemantic: "comments";
+                    readonly targetFieldSemantic: "description";
+                    readonly value: "➤";
+                }];
                 readonly hidden: true;
             };
         };
         readonly markdown: {
-            readonly decorator: {
-                readonly type: "boolean";
-                readonly description: "Decorate the content with author information and optional date.";
-                readonly default: false;
-                readonly hidden: true;
-            };
             readonly decoratorTemplate: {
                 readonly type: "stringWithSourceItemFields";
                 readonly description: "Template for the decorator. Use {author} and {date} placeholders.";
-                readonly default: "On **{semantic:createdAt}**, __{semantic:user.fields.semantic:displayName}__ commented:";
+                readonly defaults: [{
+                    readonly sourceRelationSemantic: "comments";
+                    readonly sourceFieldSemantic: "description";
+                    readonly targetRelationSemantic: "comments";
+                    readonly targetFieldSemantic: "description";
+                    readonly value: "On **{semantic:createdAt}**, __{semantic:user.fields.semantic:displayName}__ commented:";
+                }];
                 readonly hidden: true;
             };
             readonly decoratorPrefix: {
                 readonly type: "string";
                 readonly description: "Prefix for the decorator. Defaults to \"➤\".";
-                readonly default: "➤";
+                readonly defaults: [{
+                    readonly sourceRelationSemantic: "comments";
+                    readonly sourceFieldSemantic: "description";
+                    readonly targetRelationSemantic: "comments";
+                    readonly targetFieldSemantic: "description";
+                    readonly value: "➤";
+                }];
                 readonly hidden: true;
             };
         };
@@ -470,7 +530,9 @@ export declare const fieldTypeCompatibilityMatrix: {
         readonly reference: {
             readonly field: {
                 readonly type: "targetField";
-                readonly default: "semantic:displayName";
+                readonly defaults: [{
+                    readonly value: "semantic:displayName";
+                }];
                 readonly description: "The field against which to match the string value.";
                 readonly required: true;
             };

package/dist/src/compatibilities.js

@@ -2,7 +2,7 @@ import * as Api from './types.js';
 const referenceToStringLikeConfiguration = {
     field: {
         type: 'sourceField',
-        default: 'semantic:displayName',
+        defaults: [{ value: 'semantic:displayName' }],
         description: 'The field of the referenced entry to use for the string value.',
         required: true,
     },
@@ -10,7 +10,7 @@ const referenceToStringLikeConfiguration = {
 const stringLikeToReferenceConfiguration = {
     field: {
         type: 'targetField',
-        default: 'semantic:displayName',
+        defaults: [{ value: 'semantic:displayName' }],
         description: 'The field against which to match the string value.',
         required: true,
     },
@@ -18,54 +18,74 @@ const stringLikeToReferenceConfiguration = {
 const dateToStringlikeConfiguration = {
     locale: {
         type: 'enum',
-        default: 'en-CA',
+        defaults: [{ value: 'en-CA' }],
         values: ['en-CA'],
         description: 'The locale to use for formatting the date.',
     },
     timezone: {
         type: 'enum',
-        default: 'UTC',
+        defaults: [{ value: 'UTC' }],
         values: ['UTC'],
         description: 'The timezone to use for formatting the date.',
     },
 };
 const htmlToRichTextConfiguration = {
-    decorator: {
-        type: 'boolean',
-        description: 'Decorate the content with author information and optional date.',
-        default: false,
-        hidden: true,
-    },
     decoratorTemplate: {
         type: 'stringWithSourceItemFields',
         description: 'Template for the decorator. Use {author} and {date} placeholders.',
-        default: 'On <strong>{semantic:createdAt}</strong>, <em>{semantic:user.fields.semantic:displayName}</em> commented:',
+        defaults: [
+            {
+                sourceRelationSemantic: Api.RelationSemantics.COMMENTS,
+                sourceFieldSemantic: Api.Semantics.DESCRIPTION,
+                targetRelationSemantic: Api.RelationSemantics.COMMENTS,
+                targetFieldSemantic: Api.Semantics.DESCRIPTION,
+                value: 'On <strong>{semantic:createdAt}</strong>, <em>{semantic:user.fields.semantic:displayName}</em> commented:',
+            },
+        ],
         hidden: true,
     },
     decoratorPrefix: {
         type: 'string',
         description: `Prefix for the decorator. Defaults to "➤".`,
-        default: '➤',
+        defaults: [
+            {
+                sourceRelationSemantic: Api.RelationSemantics.COMMENTS,
+                sourceFieldSemantic: Api.Semantics.DESCRIPTION,
+                targetRelationSemantic: Api.RelationSemantics.COMMENTS,
+                targetFieldSemantic: Api.Semantics.DESCRIPTION,
+                value: '➤',
+            },
+        ],
         hidden: true,
     },
 };
 const markdownToRichTextConfiguration = {
-    decorator: {
-        type: 'boolean',
-        description: 'Decorate the content with author information and optional date.',
-        default: false,
-        hidden: true,
-    },
     decoratorTemplate: {
         type: 'stringWithSourceItemFields',
         description: 'Template for the decorator. Use {author} and {date} placeholders.',
-        default: 'On **{semantic:createdAt}**, __{semantic:user.fields.semantic:displayName}__ commented:',
+        defaults: [
+            {
+                sourceRelationSemantic: Api.RelationSemantics.COMMENTS,
+                sourceFieldSemantic: Api.Semantics.DESCRIPTION,
+                targetRelationSemantic: Api.RelationSemantics.COMMENTS,
+                targetFieldSemantic: Api.Semantics.DESCRIPTION,
+                value: 'On **{semantic:createdAt}**, __{semantic:user.fields.semantic:displayName}__ commented:',
+            },
+        ],
         hidden: true,
     },
     decoratorPrefix: {
         type: 'string',
         description: `Prefix for the decorator. Defaults to "➤".`,
-        default: '➤',
+        defaults: [
+            {
+                sourceRelationSemantic: Api.RelationSemantics.COMMENTS,
+                sourceFieldSemantic: Api.Semantics.DESCRIPTION,
+                targetRelationSemantic: Api.RelationSemantics.COMMENTS,
+                targetFieldSemantic: Api.Semantics.DESCRIPTION,
+                value: '➤',
+            },
+        ],
         hidden: true,
     },
 };
@@ -285,7 +305,7 @@ export const fieldTypeCompatibilityMatrix = {
                 type: 'sideIdOfSameCollection',
                 description: 'If specified, only the references kept in sync in the specified link sides will be evaluated. An empty array means no side will be evaluated.',
                 isArray: true,
-                default: [],
+                defaults: [{ value: [] }],
             },
             type: {
                 type: 'enum',

package/dist/src/index.cjs

@@ -221,7 +221,7 @@ function isFieldSchema(potentialFieldSchema) {
 const referenceToStringLikeConfiguration = {
     field: {
         type: 'sourceField',
-        default: 'semantic:displayName',
+        defaults: [{ value: 'semantic:displayName' }],
         description: 'The field of the referenced entry to use for the string value.',
         required: true,
     },
@@ -229,7 +229,7 @@ const referenceToStringLikeConfiguration = {
 const stringLikeToReferenceConfiguration = {
     field: {
         type: 'targetField',
-        default: 'semantic:displayName',
+        defaults: [{ value: 'semantic:displayName' }],
         description: 'The field against which to match the string value.',
         required: true,
     },
@@ -237,54 +237,74 @@ const stringLikeToReferenceConfiguration = {
 const dateToStringlikeConfiguration = {
     locale: {
         type: 'enum',
-        default: 'en-CA',
+        defaults: [{ value: 'en-CA' }],
         values: ['en-CA'],
         description: 'The locale to use for formatting the date.',
     },
     timezone: {
         type: 'enum',
-        default: 'UTC',
+        defaults: [{ value: 'UTC' }],
         values: ['UTC'],
         description: 'The timezone to use for formatting the date.',
     },
 };
 const htmlToRichTextConfiguration = {
-    decorator: {
-        type: 'boolean',
-        description: 'Decorate the content with author information and optional date.',
-        default: false,
-        hidden: true,
-    },
     decoratorTemplate: {
         type: 'stringWithSourceItemFields',
         description: 'Template for the decorator. Use {author} and {date} placeholders.',
-        default: 'On <strong>{semantic:createdAt}</strong>, <em>{semantic:user.fields.semantic:displayName}</em> commented:',
+        defaults: [
+            {
+                sourceRelationSemantic: RelationSemantics.COMMENTS,
+                sourceFieldSemantic: Semantics.DESCRIPTION,
+                targetRelationSemantic: RelationSemantics.COMMENTS,
+                targetFieldSemantic: Semantics.DESCRIPTION,
+                value: 'On <strong>{semantic:createdAt}</strong>, <em>{semantic:user.fields.semantic:displayName}</em> commented:',
+            },
+        ],
         hidden: true,
     },
     decoratorPrefix: {
         type: 'string',
         description: `Prefix for the decorator. Defaults to "➤".`,
-        default: '➤',
+        defaults: [
+            {
+                sourceRelationSemantic: RelationSemantics.COMMENTS,
+                sourceFieldSemantic: Semantics.DESCRIPTION,
+                targetRelationSemantic: RelationSemantics.COMMENTS,
+                targetFieldSemantic: Semantics.DESCRIPTION,
+                value: '➤',
+            },
+        ],
         hidden: true,
     },
 };
 const markdownToRichTextConfiguration = {
-    decorator: {
-        type: 'boolean',
-        description: 'Decorate the content with author information and optional date.',
-        default: false,
-        hidden: true,
-    },
     decoratorTemplate: {
         type: 'stringWithSourceItemFields',
         description: 'Template for the decorator. Use {author} and {date} placeholders.',
-        default: 'On **{semantic:createdAt}**, __{semantic:user.fields.semantic:displayName}__ commented:',
+        defaults: [
+            {
+                sourceRelationSemantic: RelationSemantics.COMMENTS,
+                sourceFieldSemantic: Semantics.DESCRIPTION,
+                targetRelationSemantic: RelationSemantics.COMMENTS,
+                targetFieldSemantic: Semantics.DESCRIPTION,
+                value: 'On **{semantic:createdAt}**, __{semantic:user.fields.semantic:displayName}__ commented:',
+            },
+        ],
         hidden: true,
     },
     decoratorPrefix: {
         type: 'string',
         description: `Prefix for the decorator. Defaults to "➤".`,
-        default: '➤',
+        defaults: [
+            {
+                sourceRelationSemantic: RelationSemantics.COMMENTS,
+                sourceFieldSemantic: Semantics.DESCRIPTION,
+                targetRelationSemantic: RelationSemantics.COMMENTS,
+                targetFieldSemantic: Semantics.DESCRIPTION,
+                value: '➤',
+            },
+        ],
         hidden: true,
     },
 };
@@ -504,7 +524,7 @@ const fieldTypeCompatibilityMatrix = {
                 type: 'sideIdOfSameCollection',
                 description: 'If specified, only the references kept in sync in the specified link sides will be evaluated. An empty array means no side will be evaluated.',
                 isArray: true,
-                default: [],
+                defaults: [{ value: [] }],
             },
             type: {
                 type: 'enum',

package/dist/src/types.d.ts

@@ -544,9 +544,15 @@ export interface WebhookAcknowledgeResponsePayload {
  */
 export interface WebhookParsedItem {
     /**
-     * The path of the item targetted by this event.
+     * The relative path of the item targeted by this event.
+     * @deprecated use the itemSummary instead.
      */
     itemPath: string;
+    /**
+     * The item summary of the item targeted by this event.
+     * as much as possible try to provide the canonical path within the item summary even if it's the same.
+     */
+    itemSummary?: ItemSummary;
     /**
      * The date at which the event took place, expressed as an ISO 8601 string.
      * e.g "2023-11-05T08:15:30.000-05:00"

package/package.json

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