@data-fair/lib-common-types 1.16.0 → 1.16.1

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 (16) hide show
  1. package/account/index.js +1 -1
  2. package/account/schema.js +37 -37
  3. package/application/index.js +1 -1
  4. package/application/schema.js +124 -124
  5. package/catalog/index.js +1 -1
  6. package/catalog/schema.js +180 -180
  7. package/event/index.js +1 -1
  8. package/event/schema.js +199 -199
  9. package/notification/index.js +1 -1
  10. package/notification/schema.js +83 -83
  11. package/package.json +1 -1
  12. package/session/index.js +55 -41
  13. package/session/schema.js +164 -164
  14. package/theme/index.js +322 -306
  15. package/theme/schema.d.ts +384 -0
  16. package/theme/schema.js +809 -368
package/account/index.js CHANGED
@@ -1 +1 @@
1
- export * from './.type/index.js'
1
+ export * from './.type/index.js';
package/account/schema.js CHANGED
@@ -1,46 +1,46 @@
1
1
  // TODO: remove this, duplicate of session/schema.ts
2
2
  export default {
3
- $id: 'https://github.com/data-fair/lib/account',
4
- 'x-exports': ['types', 'validate'],
5
- type: 'object',
6
- title: 'account',
7
- required: ['type', 'id', 'name'],
8
- properties: {
9
- type: {
10
- type: 'string',
11
- enum: ['user', 'organization']
12
- },
13
- id: {
14
- type: 'string'
15
- },
16
- name: {
17
- type: 'string'
18
- },
19
- department: {
20
- type: 'string'
21
- },
22
- departmentName: {
23
- type: 'string'
24
- }
25
- },
26
- $defs: {
27
- accountKeys: {
28
- type: 'object',
29
- title: 'account keys',
30
- required: ['type', 'id'],
31
- additionalProperties: false,
32
- properties: {
3
+ $id: 'https://github.com/data-fair/lib/account',
4
+ 'x-exports': ['types', 'validate'],
5
+ type: 'object',
6
+ title: 'account',
7
+ required: ['type', 'id', 'name'],
8
+ properties: {
33
9
  type: {
34
- type: 'string',
35
- enum: ['user', 'organization']
10
+ type: 'string',
11
+ enum: ['user', 'organization']
36
12
  },
37
13
  id: {
38
- type: 'string'
14
+ type: 'string'
15
+ },
16
+ name: {
17
+ type: 'string'
39
18
  },
40
19
  department: {
41
- type: 'string'
20
+ type: 'string'
21
+ },
22
+ departmentName: {
23
+ type: 'string'
24
+ }
25
+ },
26
+ $defs: {
27
+ accountKeys: {
28
+ type: 'object',
29
+ title: 'account keys',
30
+ required: ['type', 'id'],
31
+ additionalProperties: false,
32
+ properties: {
33
+ type: {
34
+ type: 'string',
35
+ enum: ['user', 'organization']
36
+ },
37
+ id: {
38
+ type: 'string'
39
+ },
40
+ department: {
41
+ type: 'string'
42
+ }
43
+ }
42
44
  }
43
- }
44
45
  }
45
- }
46
- }
46
+ };
package/application/index.js CHANGED
@@ -1 +1 @@
1
- export * from './.type/index.js'
1
+ export * from './.type/index.js';
package/application/schema.js CHANGED
@@ -1,138 +1,138 @@
1
1
  export default {
2
- $id: 'https://github.com/data-fair/lib/application',
3
- title: 'Application',
4
- 'x-exports': ['types'],
5
- type: 'object',
6
- required: [
7
- 'id',
8
- 'title',
9
- 'exposedUrl',
10
- 'href',
11
- 'wsUrl',
12
- 'owner',
13
- 'configuration'
14
- ],
15
- properties: {
16
- id: {
17
- type: 'string',
18
- description: 'Globally unique identifier of the application'
19
- },
20
- title: {
21
- type: 'string',
22
- description: 'Short title of the application'
23
- },
24
- exposedUrl: {
25
- type: 'string',
26
- description: 'The URL where this application is exposed'
27
- },
28
- href: {
29
- type: 'string',
30
- description: 'The URL where this resource can be fetched'
31
- },
32
- wsUrl: {
33
- type: 'string',
34
- description: 'The URL where this application can be accessed through a websocket'
35
- },
36
- owner: {
37
- $ref: 'https://github.com/data-fair/lib/account#/$defs/accountKeys'
38
- },
39
- configuration: {
40
- type: 'object',
41
- description: 'A free format configuration object used by applications. A minimal common structure is used to ensure proper linking between applications and datasets and remote services',
42
- additionalProperties: true,
43
- properties: {
44
- datasets: {
45
- type: 'array',
46
- items: {
47
- $ref: '#/$defs/dataset'
48
- }
49
- }
50
- }
51
- }
52
- },
53
- $defs: {
54
- dataset: {
55
- type: [
56
- 'object',
57
- 'null'
58
- ],
59
- required: [
60
- 'href',
2
+ $id: 'https://github.com/data-fair/lib/application',
3
+ title: 'Application',
4
+ 'x-exports': ['types'],
5
+ type: 'object',
6
+ required: [
61
7
  'id',
62
8
  'title',
63
- 'finalizedAt'
64
- ],
65
- properties: {
66
- href: {
67
- type: 'string'
68
- },
9
+ 'exposedUrl',
10
+ 'href',
11
+ 'wsUrl',
12
+ 'owner',
13
+ 'configuration'
14
+ ],
15
+ properties: {
69
16
  id: {
70
- type: 'string'
17
+ type: 'string',
18
+ description: 'Globally unique identifier of the application'
71
19
  },
72
20
  title: {
73
- type: 'string'
21
+ type: 'string',
22
+ description: 'Short title of the application'
74
23
  },
75
- key: {
76
- type: 'string',
77
- description: 'Not the id of the dataset, but a key inside this configuration object to define the role of the dataset in this context.'
24
+ exposedUrl: {
25
+ type: 'string',
26
+ description: 'The URL where this application is exposed'
78
27
  },
79
- schema: {
80
- type: 'array',
81
- items: {
82
- $ref: '#/$defs/field'
83
- }
84
- },
85
- finalizedAt: {
86
- type: 'string',
87
- format: 'date-time'
88
- }
89
- }
90
- },
91
- field: {
92
- type: 'object',
93
- required: [
94
- 'key',
95
- 'type'
96
- ],
97
- properties: {
98
- key: {
99
- type: 'string'
100
- },
101
- type: {
102
- type: 'string'
103
- },
104
- format: {
105
- type: 'string'
106
- },
107
- title: {
108
- type: 'string'
109
- },
110
- 'x-originalName': {
111
- type: 'string'
28
+ href: {
29
+ type: 'string',
30
+ description: 'The URL where this resource can be fetched'
112
31
  },
113
- 'x-group': { type: 'string' },
114
- 'x-refersTo': {
115
- deprecated: true,
116
- type: ['string', 'null']
32
+ wsUrl: {
33
+ type: 'string',
34
+ description: 'The URL where this application can be accessed through a websocket'
117
35
  },
118
- 'x-concept': {
119
- type: 'object',
120
- properties: {
121
- id: { type: 'string' },
122
- title: { type: 'string' },
123
- primary: { type: 'boolean' }
124
- }
36
+ owner: {
37
+ $ref: 'https://github.com/data-fair/lib/account#/$defs/accountKeys'
125
38
  },
126
- 'x-labels': {
127
- type: 'object',
128
- additionalProperties: {
129
- type: 'string'
130
- }
39
+ configuration: {
40
+ type: 'object',
41
+ description: 'A free format configuration object used by applications. A minimal common structure is used to ensure proper linking between applications and datasets and remote services',
42
+ additionalProperties: true,
43
+ properties: {
44
+ datasets: {
45
+ type: 'array',
46
+ items: {
47
+ $ref: '#/$defs/dataset'
48
+ }
49
+ }
50
+ }
51
+ }
52
+ },
53
+ $defs: {
54
+ dataset: {
55
+ type: [
56
+ 'object',
57
+ 'null'
58
+ ],
59
+ required: [
60
+ 'href',
61
+ 'id',
62
+ 'title',
63
+ 'finalizedAt'
64
+ ],
65
+ properties: {
66
+ href: {
67
+ type: 'string'
68
+ },
69
+ id: {
70
+ type: 'string'
71
+ },
72
+ title: {
73
+ type: 'string'
74
+ },
75
+ key: {
76
+ type: 'string',
77
+ description: 'Not the id of the dataset, but a key inside this configuration object to define the role of the dataset in this context.'
78
+ },
79
+ schema: {
80
+ type: 'array',
81
+ items: {
82
+ $ref: '#/$defs/field'
83
+ }
84
+ },
85
+ finalizedAt: {
86
+ type: 'string',
87
+ format: 'date-time'
88
+ }
89
+ }
131
90
  },
132
- 'x-labelsRestricted': {
133
- type: 'boolean'
91
+ field: {
92
+ type: 'object',
93
+ required: [
94
+ 'key',
95
+ 'type'
96
+ ],
97
+ properties: {
98
+ key: {
99
+ type: 'string'
100
+ },
101
+ type: {
102
+ type: 'string'
103
+ },
104
+ format: {
105
+ type: 'string'
106
+ },
107
+ title: {
108
+ type: 'string'
109
+ },
110
+ 'x-originalName': {
111
+ type: 'string'
112
+ },
113
+ 'x-group': { type: 'string' },
114
+ 'x-refersTo': {
115
+ deprecated: true,
116
+ type: ['string', 'null']
117
+ },
118
+ 'x-concept': {
119
+ type: 'object',
120
+ properties: {
121
+ id: { type: 'string' },
122
+ title: { type: 'string' },
123
+ primary: { type: 'boolean' }
124
+ }
125
+ },
126
+ 'x-labels': {
127
+ type: 'object',
128
+ additionalProperties: {
129
+ type: 'string'
130
+ }
131
+ },
132
+ 'x-labelsRestricted': {
133
+ type: 'boolean'
134
+ }
135
+ }
134
136
  }
135
- }
136
137
  }
137
- }
138
- }
138
+ };
package/catalog/index.js CHANGED
@@ -1 +1 @@
1
- export * from './.type/index.js'
1
+ export * from './.type/index.js';