@unito/integration-api 4.1.4 → 4.1.6

package/dist/schemas/relationSchema.json

@@ -10,6 +10,9 @@
       "minLength": 1,
       "maxLength": 100
     },
+    "canReadItem": {
+      "type": "boolean"
+    },
     "canCreateItem": {
       "type": "boolean"
     },

package/dist/src/types.d.ts

@@ -257,16 +257,18 @@ export declare const OperatorTypes: {
     readonly IS_NOT_NULL: "!";
 };
 export type OperatorType = (typeof OperatorTypes)[keyof typeof OperatorTypes];
+/**
+ * A FieldValues holds the values for various fields.
+ */
+export type FieldValues<T extends FieldSchema[] | undefined = undefined> = Record<T extends FieldSchema[] ? T[number]['name'] : string, unknown>;
 /**
  * An Item represents a syncable entity. It has fields of its own as well as relations to other items.
  */
-export interface Item {
+export interface Item<T extends RelationSchema | undefined = undefined> {
     /**
      * The fields and values of the item.
      */
-    fields: {
-        [k: string]: unknown;
-    };
+    fields: T extends RelationSchema ? FieldValues<T['fields']> : FieldValues;
     /**
      * The relations of the item
      */
@@ -281,7 +283,7 @@ export interface Item {
  * An ItemSummary is a constituent of a collection.
  * It links to an item, and can contain additional item information upon request.
  */
-export interface ItemSummary {
+export interface ItemSummary<T extends RelationSchema | undefined = undefined> {
     /**
      * Link to this specific item.
      */
@@ -289,9 +291,7 @@ export interface ItemSummary {
     /**
      * Optional list of requested fields and their values.
      */
-    fields?: {
-        [k: string]: unknown;
-    };
+    fields?: Partial<FieldValues<T extends RelationSchema ? T['fields'] : undefined>>;
     /**
      * The shape of the request parameters.
      */
@@ -299,9 +299,7 @@ export interface ItemSummary {
     /**
      * Optional list of relation paths.
      */
-    relations?: {
-        [k: string]: string;
-    };
+    relations?: Partial<Record<T extends RelationSchema ? T['relations'] extends NonNullable<RelationSchema['relations']> ? T['relations'][number]['name'] : never : string, string>>;
     /**
      * The canonical path of the item. This is the path / id that uniquely identifies the item in a provider.
      * Even if the item is moved in the graph, the canonical path should remain the same.

package/package.json

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