@data-fair/lib-common-types 1.4.1 → 1.4.2

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

@@ -7,8 +7,8 @@ export type Content = string;
 export type HTMLContent = string;
 export type URLOfEventIcon = string;
 export type Type = "user" | "organization";
-export type CleDuSujet = string;
-export type LibelleDuSujet = string;
+export type TopicKey = string;
+export type TopicTitle = string;
 export type Visibility = "public" | "private";
 export type ReceptionDate = string;
 
@@ -18,10 +18,7 @@ export interface Event {
   htmlBody?: HTMLContent | InternationalizedHTMLContent;
   icon?: URLOfEventIcon;
   sender: Emitter;
-  topic: {
-    key: CleDuSujet;
-    title?: LibelleDuSujet;
-  };
+  topic: TopicRef;
   urlParams?: UsedToFillSubscriptionUrlTemplateAndSoCreateNotificationUrl;
   visibility?: Visibility;
   date: ReceptionDate;
@@ -53,6 +50,10 @@ export interface InternationalizedHTMLContent {
    */
   [k: string]: string;
 }
+/**
+ * This interface was referenced by `Event`'s JSON-Schema
+ * via the `definition` "sender".
+ */
 export interface Emitter {
   type: Type;
   /**
@@ -77,6 +78,14 @@ export interface Emitter {
    */
   departmentName?: string;
 }
+/**
+ * This interface was referenced by `Event`'s JSON-Schema
+ * via the `definition` "topicRef".
+ */
+export interface TopicRef {
+  key: TopicKey;
+  title?: TopicTitle;
+}
 export interface UsedToFillSubscriptionUrlTemplateAndSoCreateNotificationUrl {
   /**
    * This interface was referenced by `UsedToFillSubscriptionUrlTemplateAndSoCreateNotificationUrl`'s JSON-Schema definition
@@ -84,32 +93,4 @@ export interface UsedToFillSubscriptionUrlTemplateAndSoCreateNotificationUrl {
    */
   [k: string]: string;
 }
-/**
- * This interface was referenced by `Event`'s JSON-Schema
- * via the `definition` "sender".
- */
-export interface Proprietaire {
-  type: Type;
-  /**
-   * The unique id of the user or organization
-   */
-  id: string;
-  /**
-   * The display name of the user or organization
-   */
-  name: string;
-  /**
-   * @deprecated
-   * If this is set and owner is an organization, this restrict ownership to users of this organization having this role or admin role
-   */
-  role?: string;
-  /**
-   * If this is set and owner is an organization, this gives ownership to users of this organization that belong to this department
-   */
-  department?: string;
-  /**
-   * The display name of the department
-   */
-  departmentName?: string;
-}
 

package/event/schema.d.ts

@@ -54,22 +54,9 @@ declare const _default: {
         };
         sender: {
             $ref: string;
-            title: string;
         };
         topic: {
-            type: string;
-            additionalProperties: boolean;
-            required: string[];
-            properties: {
-                key: {
-                    type: string;
-                    title: string;
-                };
-                title: {
-                    type: string;
-                    title: string;
-                };
-            };
+            $ref: string;
         };
         urlParams: {
             type: string;
@@ -131,6 +118,21 @@ declare const _default: {
                 };
             };
         };
+        topicRef: {
+            type: string;
+            additionalProperties: boolean;
+            required: string[];
+            properties: {
+                key: {
+                    type: string;
+                    title: string;
+                };
+                title: {
+                    type: string;
+                    title: string;
+                };
+            };
+        };
     };
 };
 export default _default;

package/event/schema.js

@@ -37,22 +37,8 @@ export default {
       title: 'URL of event icon'
     },
     // sender is the owner of the topic
-    sender: { $ref: '#/$defs/sender', title: 'Emitter' },
-    topic: {
-      type: 'object',
-      additionalProperties: false,
-      required: ['key'],
-      properties: {
-        key: {
-          type: 'string',
-          title: 'Clé du sujet'
-        },
-        title: {
-          type: 'string',
-          title: 'Libellé du sujet'
-        }
-      }
-    },
+    sender: { $ref: '#/$defs/sender' },
+    topic: { $ref: '#/$defs/topicRef' },
     urlParams: {
       type: 'object',
       title: 'used to fill subscription.urlTemplate and so create notification.url',
@@ -79,7 +65,7 @@ export default {
   $defs: {
     sender: {
       type: 'object',
-      title: 'Propriétaire',
+      title: 'Emitter',
       additionalProperties: false,
       required: ['type', 'id', 'name'],
       properties: {
@@ -110,6 +96,21 @@ export default {
           description: 'The display name of the department'
         }
       }
+    },
+    topicRef: {
+      type: 'object',
+      additionalProperties: false,
+      required: ['key'],
+      properties: {
+        key: {
+          type: 'string',
+          title: 'Topic key'
+        },
+        title: {
+          type: 'string',
+          title: 'Topic title'
+        }
+      }
     }
   }
 }

package/package.json

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