@unito/integration-api 7.0.1 → 7.1.0

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

@@ -163,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.
@@ -828,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

@@ -146,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.
  */

package/package.json

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