@unito/integration-api 7.0.0 → 7.1.0

package/dist/schemas/definitions.json

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

package/dist/schemas/fieldSchema.json

@@ -49,7 +49,14 @@
           }
         },
         "reference": {
-          "$ref": "https://unito.io/integration_api/referenceRelation.schema.json"
+          "oneOf": [
+            {
+              "$ref": "https://unito.io/integration_api/referenceRelation.schema.json"
+            },
+            {
+              "$ref": "https://unito.io/integration_api/relationPointer.schema.json"
+            }
+          ]
         },
         "info": {
           "type": "string"

package/dist/schemas/relationPointer.json

@@ -0,0 +1,20 @@
+{
+  "$id": "https://unito.io/integration_api/relationPointer.schema.json",
+  "title": "RelationPointer",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["itemPath", "relationName"],
+  "properties": {
+    "itemPath": {
+      "type": "string",
+      "format": "uri-reference",
+      "pattern": "^\/.*$"
+    },
+    "relationName": {
+      "type": "string",
+      "pattern": "^[a-zA-Z0-9_-]*$",
+      "minLength": 1,
+      "maxLength": 100
+    }
+  }
+}

package/dist/src/guards.d.ts

@@ -29,6 +29,12 @@ export declare function isItemSummary(potentialItemSummary: unknown): potentialI
  * @returns True if the value is an Item, false otherwise.
  */
 export declare function isItem(potentialItem: unknown): potentialItem is Api.Item;
+/**
+ * Checks if the input is an Api.RelationPointer object.
+ * @param potentialRelationPointer - The value to check.
+ * @returns True if the value is a RelationPointer, false otherwise.
+ */
+export declare function isRelationPointer(potentialRelationPointer: unknown): potentialRelationPointer is Api.RelationPointer;
 /**
  * Checks if the input is an Api.ReferenceRelation object.
  * @param potentialReferenceRelation - The value to check.

package/dist/src/guards.js

@@ -46,6 +46,16 @@ export function isItem(potentialItem) {
         Array.isArray(potentialItem['relations']) &&
         potentialItem['relations'].every(isRelation));
 }
+/**
+ * Checks if the input is an Api.RelationPointer object.
+ * @param potentialRelationPointer - The value to check.
+ * @returns True if the value is a RelationPointer, false otherwise.
+ */
+export function isRelationPointer(potentialRelationPointer) {
+    return (isObject(potentialRelationPointer) &&
+        isString(potentialRelationPointer['itemPath']) &&
+        isString(potentialRelationPointer['relationName']));
+}
 /**
  * Checks if the input is an Api.ReferenceRelation object.
  * @param potentialReferenceRelation - The value to check.

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',
@@ -152,6 +163,16 @@ function isItem(potentialItem) {
         Array.isArray(potentialItem['relations']) &&
         potentialItem['relations'].every(isRelation));
 }
+/**
+ * Checks if the input is an Api.RelationPointer object.
+ * @param potentialRelationPointer - The value to check.
+ * @returns True if the value is a RelationPointer, false otherwise.
+ */
+function isRelationPointer(potentialRelationPointer) {
+    return (isObject(potentialRelationPointer) &&
+        isString(potentialRelationPointer['itemPath']) &&
+        isString(potentialRelationPointer['relationName']));
+}
 /**
  * Checks if the input is an Api.ReferenceRelation object.
  * @param potentialReferenceRelation - The value to check.
@@ -817,6 +838,7 @@ exports.isItemSummary = isItemSummary;
 exports.isObject = isObject;
 exports.isReferenceRelation = isReferenceRelation;
 exports.isRelation = isRelation;
+exports.isRelationPointer = isRelationPointer;
 exports.isRelationSchema = isRelationSchema;
 exports.isRelationSchemaOrSelf = isRelationSchemaOrSelf;
 exports.isRelationSummary = isRelationSummary;

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.
@@ -142,19 +146,33 @@ export interface BlobFieldSchema extends AbstractFieldSchema {
 interface UserReferenceFieldSchema extends AbstractFieldSchema {
     semantic: typeof Semantics.USER;
     type: typeof FieldValueTypes.REFERENCE;
-    reference: ReferenceRelation;
+    reference: ReferenceRelation | RelationPointer;
 }
 interface ParentReferenceFieldSchema extends AbstractFieldSchema {
     semantic: typeof Semantics.PARENT;
     type: typeof FieldValueTypes.REFERENCE;
-    reference: ReferenceRelation;
+    reference: ReferenceRelation | RelationPointer;
 }
 interface UnconstrainedReferenceFieldSchema extends AbstractFieldSchema {
     semantic?: never;
     type: typeof FieldValueTypes.REFERENCE;
-    reference: ReferenceRelation;
+    reference: ReferenceRelation | RelationPointer;
 }
 export type ReferenceFieldSchema = UserReferenceFieldSchema | ParentReferenceFieldSchema | UnconstrainedReferenceFieldSchema;
+/**
+ * A RelationPointer points to an existing relation elsewhere in the graph,
+ * avoiding the need to redeclare its schema inline.
+ */
+export interface RelationPointer {
+    /**
+     * The path of the item that owns the target relation.
+     */
+    itemPath: string;
+    /**
+     * The name of the relation on that item.
+     */
+    relationName: string;
+}
 /**
  * A ReferenceRelation describes a relation that can be used in a ReferenceFieldSchema.
  */
@@ -263,6 +281,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";

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": "7.0.0",
+  "version": "7.1.0",
   "description": "The Unito Integration API",
   "type": "module",
   "types": "./dist/src/index.d.ts",