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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/event/.type/index.d.ts +11 -5
  2. package/event/schema.d.ts +23 -5
  3. package/event/schema.js +15 -5
  4. package/package.json +1 -1
package/event/.type/index.d.ts CHANGED
@@ -27,6 +27,16 @@ export type Event = {
27
27
  icon?: URLOfEventIcon;
28
28
  sender: Emitter;
29
29
  originator?: {
30
+ internalProcess?: {
31
+ id?: string;
32
+ title?: string;
33
+ [k: string]: unknown;
34
+ };
35
+ apiKey?: {
36
+ id?: string;
37
+ title?: string;
38
+ [k: string]: unknown;
39
+ };
30
40
  user?: {
31
41
  id?: UserID;
32
42
  name?: UserName;
@@ -53,7 +63,7 @@ export type Event = {
53
63
  [k: string]: unknown;
54
64
  };
55
65
  resource?: TheMainResourceConcernedByTheEvent;
56
- recipient?: OptionalRecipientTargetOfTheEvent;
66
+ subscribedRecipient?: OptionalRecipientTargetOfTheEvent;
57
67
  }
58
68
  export type InternationalizedTitle = {
59
69
  /**
@@ -138,10 +148,6 @@ export type OptionalRecipientTargetOfTheEvent = {
138
148
  * The display name of the user
139
149
  */
140
150
  name?: string;
141
- /**
142
- * If true, the event is only sent to the recipient if they are subscribed to the topic
143
- */
144
- subscribedOnly?: boolean;
145
151
  [k: string]: unknown;
146
152
  }
147
153
 
package/event/schema.d.ts CHANGED
@@ -58,6 +58,28 @@ declare const _default: {
58
58
  originator: {
59
59
  type: string;
60
60
  properties: {
61
+ internalProcess: {
62
+ type: string;
63
+ properties: {
64
+ id: {
65
+ type: string;
66
+ };
67
+ title: {
68
+ type: string;
69
+ };
70
+ };
71
+ };
72
+ apiKey: {
73
+ type: string;
74
+ properties: {
75
+ id: {
76
+ type: string;
77
+ };
78
+ title: {
79
+ type: string;
80
+ };
81
+ };
82
+ };
61
83
  user: {
62
84
  type: string;
63
85
  properties: {
@@ -145,7 +167,7 @@ declare const _default: {
145
167
  };
146
168
  };
147
169
  };
148
- recipient: {
170
+ subscribedRecipient: {
149
171
  type: string;
150
172
  title: string;
151
173
  required: string[];
@@ -159,10 +181,6 @@ declare const _default: {
159
181
  type: string;
160
182
  description: string;
161
183
  };
162
- subscribedOnly: {
163
- type: string;
164
- description: string;
165
- };
166
184
  };
167
185
  };
168
186
  };
package/event/schema.js CHANGED
@@ -42,6 +42,20 @@ export default {
42
42
  originator: {
43
43
  type: 'object',
44
44
  properties: {
45
+ internalProcess: {
46
+ type: 'object',
47
+ properties: {
48
+ id: { type: 'string' },
49
+ title: { type: 'string' }
50
+ }
51
+ },
52
+ apiKey: {
53
+ type: 'object',
54
+ properties: {
55
+ id: { type: 'string' },
56
+ title: { type: 'string' }
57
+ }
58
+ },
45
59
  user: {
46
60
  type: 'object',
47
61
  properties: {
@@ -125,7 +139,7 @@ export default {
125
139
  }
126
140
  }
127
141
  },
128
- recipient: {
142
+ subscribedRecipient: {
129
143
  type: 'object',
130
144
  title: 'Optional recipient target of the event',
131
145
  required: ['id'],
@@ -138,10 +152,6 @@ export default {
138
152
  name: {
139
153
  type: 'string',
140
154
  description: 'The display name of the user'
141
- },
142
- subscribedOnly: {
143
- type: 'boolean',
144
- description: 'If true, the event is only sent to the recipient if they are subscribed to the topic'
145
155
  }
146
156
  }
147
157
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@data-fair/lib-common-types",
3
- "version": "1.8.1",
3
+ "version": "1.8.3",
4
4
  "description": "Shared schemas and built type definitions in the data-fair stack.",
5
5
  "main": "index.js",
6
6
  "scripts": {