@data-fair/lib-common-types 1.8.0 → 1.8.1

package/event/.type/index.d.ts

@@ -53,6 +53,7 @@ export type Event = {
     [k: string]: unknown;
   };
   resource?: TheMainResourceConcernedByTheEvent;
+  recipient?: OptionalRecipientTargetOfTheEvent;
 }
 export type InternationalizedTitle = {
   /**
@@ -128,4 +129,19 @@ export type TheMainResourceConcernedByTheEvent = {
    */
   title?: string;
 }
+export type OptionalRecipientTargetOfTheEvent = {
+  /**
+   * The unique id of the user
+   */
+  id: string;
+  /**
+   * The display name of the user
+   */
+  name?: string;
+  /**
+   * If true, the event is only sent to the recipient if they are subscribed to the topic
+   */
+  subscribedOnly?: boolean;
+  [k: string]: unknown;
+}
 

package/event/schema.d.ts

@@ -145,6 +145,26 @@ declare const _default: {
                 };
             };
         };
+        recipient: {
+            type: string;
+            title: string;
+            required: string[];
+            readOnly: boolean;
+            properties: {
+                id: {
+                    type: string;
+                    description: string;
+                };
+                name: {
+                    type: string;
+                    description: string;
+                };
+                subscribedOnly: {
+                    type: string;
+                    description: string;
+                };
+            };
+        };
     };
     $defs: {
         sender: {

package/event/schema.js

@@ -124,6 +124,26 @@ export default {
           description: 'The display name of the resource'
         }
       }
+    },
+    recipient: {
+      type: 'object',
+      title: 'Optional recipient target of the event',
+      required: ['id'],
+      readOnly: true,
+      properties: {
+        id: {
+          type: 'string',
+          description: 'The unique id of the user'
+        },
+        name: {
+          type: 'string',
+          description: 'The display name of the user'
+        },
+        subscribedOnly: {
+          type: 'boolean',
+          description: 'If true, the event is only sent to the recipient if they are subscribed to the topic'
+        }
+      }
     }
   },
   $defs: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@data-fair/lib-common-types",
-  "version": "1.8.0",
+  "version": "1.8.1",
   "description": "Shared schemas and built type definitions in the data-fair stack.",
   "main": "index.js",
   "scripts": {