@unito/integration-api 6.0.0 → 7.0.1

package/dist/schemas/definitions.json

@@ -30,6 +30,7 @@
         "createdAt",
         "description",
         "displayName",
+        "isPublic",
         "providerUrl",
         "updatedAt",
         "user",

package/dist/schemas/referenceRelation.json

@@ -3,7 +3,7 @@
   "title": "Relation",
   "type": "object",
   "additionalProperties": false,
-  "required": ["path", "schema", "label"],
+  "required": ["path", "schema", "label", "name"],
   "properties": {
     "path": {
       "type": "string",
@@ -25,8 +25,7 @@
       "type": "string",
       "pattern": "^[a-zA-Z0-9_-]*$",
       "minLength": 1,
-      "maxLength": 100,
-      "deprecated": true
+      "maxLength": 100
     },
     "schema": {
       "oneOf": [

package/dist/src/guards.js

@@ -53,6 +53,7 @@ export function isItem(potentialItem) {
  */
 export function isReferenceRelation(potentialReferenceRelation) {
     return (isObject(potentialReferenceRelation) &&
+        isString(potentialReferenceRelation['name']) &&
         isString(potentialReferenceRelation['path']) &&
         isString(potentialReferenceRelation['label']) &&
         isRelationSchemaOrSelf(potentialReferenceRelation['schema']));

package/dist/src/index.cjs

@@ -32,6 +32,17 @@ const Semantics = {
     CREATED_AT: 'createdAt',
     DESCRIPTION: 'description',
     DISPLAY_NAME: 'displayName',
+    /**
+     * Indicates whether an item is publicly visible.
+     * For example, a comment marked as public is visible to external users.
+     *
+     * Expected field value to be of type FieldValueType.BOOLEAN.
+     * `true` means the item is public, `false` means it is private/internal.
+     *
+     * Integrations should map their provider's visibility field directly — e.g.,
+     * a Salesforce field named `Public` maps to `IS_PUBLIC` with the same polarity.
+     */
+    IS_PUBLIC: 'isPublic',
     PROVIDER_URL: 'providerUrl',
     UPDATED_AT: 'updatedAt',
     USER: 'user',
@@ -159,6 +170,7 @@ function isItem(potentialItem) {
  */
 function isReferenceRelation(potentialReferenceRelation) {
     return (isObject(potentialReferenceRelation) &&
+        isString(potentialReferenceRelation['name']) &&
         isString(potentialReferenceRelation['path']) &&
         isString(potentialReferenceRelation['label']) &&
         isRelationSchemaOrSelf(potentialReferenceRelation['schema']));

package/dist/src/types.d.ts

@@ -124,11 +124,15 @@ interface DisplayNameFieldSchema extends AbstractFieldSchema {
     semantic: typeof Semantics.DISPLAY_NAME;
     type: typeof FieldValueTypes.STRING | typeof FieldValueTypes.EMAIL;
 }
+interface IsPublicFieldSchema extends AbstractFieldSchema {
+    semantic: typeof Semantics.IS_PUBLIC;
+    type: typeof FieldValueTypes.BOOLEAN;
+}
 interface UnconstrainedBasicFieldSchema extends AbstractFieldSchema {
     semantic?: never;
     type: BasicFieldValueType;
 }
-export type BasicFieldSchema = ProviderUrlFieldSchema | CreatedAtFieldSchema | UpdatedAtFieldSchema | DescriptionFieldSchema | DisplayNameFieldSchema | UnconstrainedBasicFieldSchema;
+export type BasicFieldSchema = ProviderUrlFieldSchema | CreatedAtFieldSchema | UpdatedAtFieldSchema | DescriptionFieldSchema | DisplayNameFieldSchema | IsPublicFieldSchema | UnconstrainedBasicFieldSchema;
 export interface BlobFieldSchema extends AbstractFieldSchema {
     /**
      * The type of the field.
@@ -176,10 +180,9 @@ export interface ReferenceRelation {
      */
     semantic?: RelationSemantic;
     /**
-     * The name for the reference relation.
-     * @deprecated Will be removed in a future version.
+     * The main identifier of the reference relation.
      */
-    name?: string;
+    name: string;
     /**
      * The shape of the relation.
      */
@@ -264,6 +267,17 @@ export declare const Semantics: {
     readonly CREATED_AT: "createdAt";
     readonly DESCRIPTION: "description";
     readonly DISPLAY_NAME: "displayName";
+    /**
+     * Indicates whether an item is publicly visible.
+     * For example, a comment marked as public is visible to external users.
+     *
+     * Expected field value to be of type FieldValueType.BOOLEAN.
+     * `true` means the item is public, `false` means it is private/internal.
+     *
+     * Integrations should map their provider's visibility field directly — e.g.,
+     * a Salesforce field named `Public` maps to `IS_PUBLIC` with the same polarity.
+     */
+    readonly IS_PUBLIC: "isPublic";
     readonly PROVIDER_URL: "providerUrl";
     readonly UPDATED_AT: "updatedAt";
     readonly USER: "user";
@@ -608,7 +622,16 @@ export interface WebhookParsedItem {
 }
 export interface WebhookItem {
     /**
-     * The canonical path of the parent item, if applicable.
+     * The canonical path of the parent item for this webhook event.
+     *
+     * Used as a fallback when the item's canonicalPath is not yet known to the platform
+     * (e.g., newly created items). In that case, sync-platform enqueues a sync job for
+     * the parent, which will discover the new child item during its scan.
+     *
+     * - If the exact parent is unknown without an extra API call, setting a grandparent
+     *   (e.g., a sheet or project) is acceptable — it triggers a broader scan that will
+     *   still pick up the new item.
+     * - If undefined and the item is not found, the webhook event is skipped entirely.
      */
     parentCanonicalPath?: string;
     /**

package/dist/src/types.js

@@ -30,6 +30,17 @@ export const Semantics = {
     CREATED_AT: 'createdAt',
     DESCRIPTION: 'description',
     DISPLAY_NAME: 'displayName',
+    /**
+     * Indicates whether an item is publicly visible.
+     * For example, a comment marked as public is visible to external users.
+     *
+     * Expected field value to be of type FieldValueType.BOOLEAN.
+     * `true` means the item is public, `false` means it is private/internal.
+     *
+     * Integrations should map their provider's visibility field directly — e.g.,
+     * a Salesforce field named `Public` maps to `IS_PUBLIC` with the same polarity.
+     */
+    IS_PUBLIC: 'isPublic',
     PROVIDER_URL: 'providerUrl',
     UPDATED_AT: 'updatedAt',
     USER: 'user',

package/package.json

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