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

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

@@ -0,0 +1,115 @@
+
+export const schemaExports: string[]
+
+// see https://github.com/bcherny/json-schema-to-typescript/issues/439 if some types are not exported
+export type Title = string;
+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 Visibility = "public" | "private";
+export type ReceptionDate = string;
+
+export interface Event {
+  title: Title | InternationalizedTitle;
+  body?: Content | InternationalizedContent;
+  htmlBody?: HTMLContent | InternationalizedHTMLContent;
+  icon?: URLOfEventIcon;
+  sender: Emitter;
+  topic: {
+    key: CleDuSujet;
+    title?: LibelleDuSujet;
+  };
+  urlParams?: UsedToFillSubscriptionUrlTemplateAndSoCreateNotificationUrl;
+  visibility?: Visibility;
+  date: ReceptionDate;
+  /**
+   * Free properties that varie depending on the type of event
+   */
+  extra?: {
+    [k: string]: unknown;
+  };
+}
+export interface InternationalizedTitle {
+  /**
+   * This interface was referenced by `InternationalizedTitle`'s JSON-Schema definition
+   * via the `patternProperty` ".*".
+   */
+  [k: string]: string;
+}
+export interface InternationalizedContent {
+  /**
+   * This interface was referenced by `InternationalizedContent`'s JSON-Schema definition
+   * via the `patternProperty` ".*".
+   */
+  [k: string]: string;
+}
+export interface InternationalizedHTMLContent {
+  /**
+   * This interface was referenced by `InternationalizedHTMLContent`'s JSON-Schema definition
+   * via the `patternProperty` ".*".
+   */
+  [k: string]: string;
+}
+export interface Emitter {
+  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;
+}
+export interface UsedToFillSubscriptionUrlTemplateAndSoCreateNotificationUrl {
+  /**
+   * This interface was referenced by `UsedToFillSubscriptionUrlTemplateAndSoCreateNotificationUrl`'s JSON-Schema definition
+   * via the `patternProperty` ".*".
+   */
+  [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/.type/index.js

@@ -0,0 +1,7 @@
+/* eslint-disable */
+
+
+
+export const schemaExports = [
+  "types"
+]

package/event/index.d.ts

@@ -0,0 +1 @@
+export * from './.type/index.js';

package/event/index.js

@@ -0,0 +1 @@
+export * from './.type/index.js'

package/event/schema.d.ts

@@ -0,0 +1,136 @@
+declare const _default: {
+    $id: string;
+    'x-exports': string[];
+    title: string;
+    type: string;
+    additionalProperties: boolean;
+    required: string[];
+    properties: {
+        title: {
+            oneOf: ({
+                type: string;
+                title: string;
+                patternProperties: {
+                    '.*': {
+                        type: string;
+                    };
+                };
+            } | {
+                type: string;
+                title: string;
+            })[];
+        };
+        body: {
+            oneOf: ({
+                type: string;
+                title: string;
+                patternProperties: {
+                    '.*': {
+                        type: string;
+                    };
+                };
+            } | {
+                type: string;
+                title: string;
+            })[];
+        };
+        htmlBody: {
+            oneOf: ({
+                type: string;
+                title: string;
+                patternProperties: {
+                    '.*': {
+                        type: string;
+                    };
+                };
+            } | {
+                type: string;
+                title: string;
+            })[];
+        };
+        icon: {
+            type: string;
+            title: string;
+        };
+        sender: {
+            $ref: string;
+            title: string;
+        };
+        topic: {
+            type: string;
+            additionalProperties: boolean;
+            required: string[];
+            properties: {
+                key: {
+                    type: string;
+                    title: string;
+                };
+                title: {
+                    type: string;
+                    title: string;
+                };
+            };
+        };
+        urlParams: {
+            type: string;
+            title: string;
+            patternProperties: {
+                '.*': {
+                    type: string;
+                };
+            };
+        };
+        visibility: {
+            type: string;
+            title: string;
+            enum: string[];
+            default: string;
+        };
+        date: {
+            type: string;
+            title: string;
+            format: string;
+        };
+        extra: {
+            type: string;
+            description: string;
+        };
+    };
+    $defs: {
+        sender: {
+            type: string;
+            title: string;
+            additionalProperties: boolean;
+            required: string[];
+            properties: {
+                type: {
+                    type: string;
+                    enum: string[];
+                    title: string;
+                };
+                id: {
+                    type: string;
+                    description: string;
+                };
+                name: {
+                    type: string;
+                    description: string;
+                };
+                role: {
+                    type: string;
+                    deprecated: boolean;
+                    description: string;
+                };
+                department: {
+                    type: string;
+                    description: string;
+                };
+                departmentName: {
+                    type: string;
+                    description: string;
+                };
+            };
+        };
+    };
+};
+export default _default;

package/event/schema.js

@@ -0,0 +1,115 @@
+const i18nMsg = (title) => ({
+  type: 'object',
+  title: `Internationalized ${title} `,
+  patternProperties: {
+    '.*': { type: 'string' }
+  }
+  // properties: ['fr', 'en'].reduce((/** @type {Record<string, any>} */props, locale) => { props[locale] = { type: 'string', title: locale }; return props }, {})
+})
+export default {
+  $id: 'https://github.com/data-fair/lib/event',
+  'x-exports': ['types'],
+  title: 'Event',
+  type: 'object',
+  additionalProperties: false,
+  required: ['title', 'topic', 'sender', 'date'],
+  properties: {
+    title: {
+      oneOf: [{
+        type: 'string',
+        title: 'Title'
+      }, i18nMsg('title')]
+    },
+    body: {
+      oneOf: [{
+        type: 'string',
+        title: 'Content'
+      }, i18nMsg('content')]
+    },
+    htmlBody: {
+      oneOf: [{
+        type: 'string',
+        title: 'HTML content'
+      }, i18nMsg('HTML content')]
+    },
+    icon: {
+      type: 'string',
+      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'
+        }
+      }
+    },
+    urlParams: {
+      type: 'object',
+      title: 'used to fill subscription.urlTemplate and so create notification.url',
+      patternProperties: {
+        '.*': { type: 'string' }
+      }
+    },
+    visibility: {
+      type: 'string',
+      title: 'Visibility',
+      enum: ['public', 'private'],
+      default: 'private'
+    },
+    date: {
+      type: 'string',
+      title: 'Reception date',
+      format: 'date-time'
+    },
+    extra: {
+      type: 'object',
+      description: 'Free properties that varie depending on the type of event'
+    }
+  },
+  $defs: {
+    sender: {
+      type: 'object',
+      title: 'Propriétaire',
+      additionalProperties: false,
+      required: ['type', 'id', 'name'],
+      properties: {
+        type: {
+          type: 'string',
+          enum: ['user', 'organization'],
+          title: 'Type'
+        },
+        id: {
+          type: 'string',
+          description: 'The unique id of the user or organization'
+        },
+        name: {
+          type: 'string',
+          description: 'The display name of the user or organization'
+        },
+        role: {
+          type: 'string',
+          deprecated: true,
+          description: 'If this is set and owner is an organization, this restrict ownership to users of this organization having this role or admin role'
+        },
+        department: {
+          type: 'string',
+          description: 'If this is set and owner is an organization, this gives ownership to users of this organization that belong to this department'
+        },
+        departmentName: {
+          type: 'string',
+          description: 'The display name of the department'
+        }
+      }
+    }
+  }
+}

package/package.json

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