@unito/integration-api 0.43.2 → 0.43.4

package/dist/schemas/relation.json

@@ -28,7 +28,7 @@
     "searchable": {
       "type": "boolean"
     },
-    "relationSemantic": {
+    "semantic": {
       "$ref": "https://unito.io/integration_api/definitions.schema.json#/$defs/relationSemantic"
     },
     "schema": {

package/dist/schemas/relationSummary.json

@@ -17,7 +17,7 @@
       "minLength": 1,
       "maxLength": 100
     },
-    "relationSemantic": {
+    "semantic": {
       "$ref": "https://unito.io/integration_api/definitions.schema.json#/$defs/relationSemantic"
     },
     "schema": {

package/dist/src/index.cjs

@@ -39,6 +39,15 @@ exports.Semantic = void 0;
     Semantic["UPDATED_AT"] = "updatedAt";
     Semantic["USER"] = "user";
 })(exports.Semantic || (exports.Semantic = {}));
+/**
+ * A Relation Semantic gives meaning to a Relation in the Unito platform. A relation with a
+ * specified semantic is expected to hold a certain type of item that can later be used by
+ * the consumers of the spec for specific usage.
+ */
+exports.RelationSemantic = void 0;
+(function (RelationSemantic) {
+    RelationSemantic["COMMENTS"] = "comments";
+})(exports.RelationSemantic || (exports.RelationSemantic = {}));
 /**
  * An OperatorType represents an operator used in a filter.
  */

package/dist/src/types.d.ts

@@ -196,6 +196,14 @@ export declare enum Semantic {
     UPDATED_AT = "updatedAt",
     USER = "user"
 }
+/**
+ * A Relation Semantic gives meaning to a Relation in the Unito platform. A relation with a
+ * specified semantic is expected to hold a certain type of item that can later be used by
+ * the consumers of the spec for specific usage.
+ */
+export declare enum RelationSemantic {
+    COMMENTS = "comments"
+}
 /**
  * An OperatorType represents an operator used in a filter.
  */
@@ -272,6 +280,10 @@ export interface Relation {
      * Whether the relation is searchable.
      */
     searchable?: boolean;
+    /**
+     * The semantic of the relation.
+     */
+    semantic?: RelationSemantic;
     /**
      * The shape of the relation.
      */
@@ -280,7 +292,7 @@ export interface Relation {
 /**
  * A summary of a relation.
  */
-export type RelationSummary = Pick<Relation, 'name' | 'label' | 'schema'>;
+export type RelationSummary = Pick<Relation, 'name' | 'label' | 'schema' | 'semantic'>;
 /**
  * A Relation Schema describes the shape of an item in a relation.
  */

package/dist/src/types.js

@@ -37,6 +37,15 @@ export var Semantic;
     Semantic["UPDATED_AT"] = "updatedAt";
     Semantic["USER"] = "user";
 })(Semantic || (Semantic = {}));
+/**
+ * A Relation Semantic gives meaning to a Relation in the Unito platform. A relation with a
+ * specified semantic is expected to hold a certain type of item that can later be used by
+ * the consumers of the spec for specific usage.
+ */
+export var RelationSemantic;
+(function (RelationSemantic) {
+    RelationSemantic["COMMENTS"] = "comments";
+})(RelationSemantic || (RelationSemantic = {}));
 /**
  * An OperatorType represents an operator used in a filter.
  */

package/package.json

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