@data-fair/lib-common-types 1.10.1 → 1.10.3

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

@@ -17,6 +17,7 @@ export type OrganizationDepartment = string;
 export type OrganizationDepartmentName = string;
 export type TopicKey = string;
 export type TopicTitle = string;
+export type ExplicitlyDefinedUrlAlternativeIsToUseUrlTemplateInSubscriptionAndUrlParams = string;
 export type Visibility = "public" | "private";
 export type ReceptionDate = string;
 export type Type1 = string;
@@ -26,7 +27,7 @@ export type Event = {
   body?: Content | InternationalizedContent;
   htmlBody?: HTMLContent | InternationalizedHTMLContent;
   icon?: URLOfEventIcon;
-  sender: Emitter;
+  sender?: Emitter;
   originator?: {
     internalProcess?: {
       id?: string;
@@ -55,6 +56,7 @@ export type Event = {
     [k: string]: unknown;
   };
   topic: TopicRef;
+  url?: ExplicitlyDefinedUrlAlternativeIsToUseUrlTemplateInSubscriptionAndUrlParams;
   urlParams?: UsedToFillSubscriptionUrlTemplateAndSoCreateNotificationUrl;
   visibility?: Visibility;
   date: ReceptionDate;

package/event/schema.d.ts

@@ -127,6 +127,10 @@ declare const _default: {
         topic: {
             $ref: string;
         };
+        url: {
+            type: string;
+            title: string;
+        };
         urlParams: {
             type: string;
             title: string;

package/event/schema.js

@@ -12,7 +12,7 @@ export default {
   title: 'Event',
   type: 'object',
   additionalProperties: false,
-  required: ['title', 'topic', 'sender', 'date'],
+  required: ['title', 'topic', 'date'],
   properties: {
     title: {
       oneOf: [{
@@ -36,7 +36,7 @@ export default {
       type: 'string',
       title: 'URL of event icon'
     },
-    // sender is the owner of the topic
+    // sender is the owner of the topic, topic is global if no sender is given
     sender: { $ref: '#/$defs/sender' },
     // originator is the account/user who triggered the event
     originator: {
@@ -101,6 +101,10 @@ export default {
       }
     },
     topic: { $ref: '#/$defs/topicRef' },
+    url: {
+      type: 'string',
+      title: 'explicitly defined url, alternative is to use urlTemplate in subscription and urlParams',
+    },
     urlParams: {
       type: 'object',
       title: 'used to fill subscription.urlTemplate and so create notification.url',

package/package.json

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