@unito/integration-api 7.1.2 → 8.0.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 (10) hide show
  1. package/dist/schemas/definitions.json +1 -0
  2. package/dist/schemas/item.json +1 -1
  3. package/dist/schemas/itemSummary.json +1 -1
  4. package/dist/src/compatibilities.d.ts +35 -0
  5. package/dist/src/compatibilities.js +35 -0
  6. package/dist/src/guards.js +2 -0
  7. package/dist/src/index.cjs +38 -0
  8. package/dist/src/types.d.ts +3 -2
  9. package/dist/src/types.js +1 -0
  10. package/package.json +1 -1
package/dist/schemas/definitions.json CHANGED
@@ -19,6 +19,7 @@
19
19
  "number",
20
20
  "object",
21
21
  "reference",
22
+ "richText",
22
23
  "string",
23
24
  "url"
24
25
  ]
package/dist/schemas/item.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "title": "Item",
4
4
  "type": "object",
5
5
  "additionalProperties": false,
6
- "required": ["fields", "relations"],
6
+ "required": ["fields", "relations", "canonicalPath"],
7
7
  "properties": {
8
8
  "fields": {
9
9
  "type": "object",
package/dist/schemas/itemSummary.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "title": "ItemSummary",
4
4
  "type": "object",
5
5
  "additionalProperties": false,
6
- "required": ["path"],
6
+ "required": ["path", "canonicalPath"],
7
7
  "properties": {
8
8
  "path": {
9
9
  "type": "string",
package/dist/src/compatibilities.d.ts CHANGED
@@ -12,6 +12,7 @@ export declare const fieldTypeCompatibilityMatrix: {
12
12
  readonly number: null;
13
13
  readonly object: null;
14
14
  readonly reference: null;
15
+ readonly richText: null;
15
16
  readonly html: null;
16
17
  readonly markdown: null;
17
18
  readonly string: null;
@@ -30,6 +31,7 @@ export declare const fieldTypeCompatibilityMatrix: {
30
31
  readonly number: {};
31
32
  readonly object: null;
32
33
  readonly reference: null;
34
+ readonly richText: null;
33
35
  readonly html: {};
34
36
  readonly markdown: {};
35
37
  readonly string: {};
@@ -48,6 +50,7 @@ export declare const fieldTypeCompatibilityMatrix: {
48
50
  readonly number: {};
49
51
  readonly object: null;
50
52
  readonly reference: null;
53
+ readonly richText: null;
51
54
  readonly html: {
52
55
  readonly locale: {
53
56
  readonly type: "enum";
@@ -117,6 +120,7 @@ export declare const fieldTypeCompatibilityMatrix: {
117
120
  readonly number: null;
118
121
  readonly object: null;
119
122
  readonly reference: null;
123
+ readonly richText: null;
120
124
  readonly html: null;
121
125
  readonly markdown: null;
122
126
  readonly string: null;
@@ -135,6 +139,7 @@ export declare const fieldTypeCompatibilityMatrix: {
135
139
  readonly number: {};
136
140
  readonly object: null;
137
141
  readonly reference: null;
142
+ readonly richText: null;
138
143
  readonly html: {
139
144
  readonly locale: {
140
145
  readonly type: "enum";
@@ -204,6 +209,7 @@ export declare const fieldTypeCompatibilityMatrix: {
204
209
  readonly number: null;
205
210
  readonly object: null;
206
211
  readonly reference: null;
212
+ readonly richText: null;
207
213
  readonly html: null;
208
214
  readonly markdown: null;
209
215
  readonly string: null;
@@ -222,6 +228,7 @@ export declare const fieldTypeCompatibilityMatrix: {
222
228
  readonly number: {};
223
229
  readonly object: null;
224
230
  readonly reference: null;
231
+ readonly richText: null;
225
232
  readonly html: {};
226
233
  readonly markdown: {};
227
234
  readonly string: {};
@@ -249,6 +256,7 @@ export declare const fieldTypeCompatibilityMatrix: {
249
256
  readonly required: true;
250
257
  };
251
258
  };
259
+ readonly richText: null;
252
260
  readonly html: {};
253
261
  readonly markdown: {};
254
262
  readonly string: {};
@@ -267,6 +275,7 @@ export declare const fieldTypeCompatibilityMatrix: {
267
275
  readonly number: {};
268
276
  readonly object: null;
269
277
  readonly reference: null;
278
+ readonly richText: null;
270
279
  readonly html: {};
271
280
  readonly markdown: {};
272
281
  readonly string: {};
@@ -285,6 +294,7 @@ export declare const fieldTypeCompatibilityMatrix: {
285
294
  readonly number: {};
286
295
  readonly object: null;
287
296
  readonly reference: null;
297
+ readonly richText: null;
288
298
  readonly html: {};
289
299
  readonly markdown: {};
290
300
  readonly string: {};
@@ -303,6 +313,7 @@ export declare const fieldTypeCompatibilityMatrix: {
303
313
  readonly number: null;
304
314
  readonly object: null;
305
315
  readonly reference: null;
316
+ readonly richText: null;
306
317
  readonly html: null;
307
318
  readonly markdown: null;
308
319
  readonly string: null;
@@ -347,6 +358,7 @@ export declare const fieldTypeCompatibilityMatrix: {
347
358
  readonly required: true;
348
359
  };
349
360
  };
361
+ readonly richText: null;
350
362
  readonly html: {
351
363
  readonly field: {
352
364
  readonly type: "sourceField";
@@ -379,6 +391,25 @@ export declare const fieldTypeCompatibilityMatrix: {
379
391
  };
380
392
  readonly url: null;
381
393
  };
394
+ readonly richText: {
395
+ readonly blob: null;
396
+ readonly boolean: null;
397
+ readonly date: null;
398
+ readonly dateRange: null;
399
+ readonly datetime: null;
400
+ readonly datetimeRange: null;
401
+ readonly duration: null;
402
+ readonly email: null;
403
+ readonly integer: null;
404
+ readonly number: null;
405
+ readonly object: null;
406
+ readonly reference: null;
407
+ readonly richText: null;
408
+ readonly html: null;
409
+ readonly markdown: null;
410
+ readonly string: null;
411
+ readonly url: null;
412
+ };
382
413
  readonly html: {
383
414
  readonly blob: null;
384
415
  readonly boolean: null;
@@ -392,6 +423,7 @@ export declare const fieldTypeCompatibilityMatrix: {
392
423
  readonly number: null;
393
424
  readonly object: null;
394
425
  readonly reference: null;
426
+ readonly richText: null;
395
427
  readonly html: {
396
428
  readonly decoratorTemplate: {
397
429
  readonly type: "stringWithSourceItemFields";
@@ -460,6 +492,7 @@ export declare const fieldTypeCompatibilityMatrix: {
460
492
  readonly number: null;
461
493
  readonly object: null;
462
494
  readonly reference: null;
495
+ readonly richText: null;
463
496
  readonly html: {
464
497
  readonly decoratorTemplate: {
465
498
  readonly type: "stringWithSourceItemFields";
@@ -537,6 +570,7 @@ export declare const fieldTypeCompatibilityMatrix: {
537
570
  readonly required: true;
538
571
  };
539
572
  };
573
+ readonly richText: null;
540
574
  readonly html: {};
541
575
  readonly markdown: {};
542
576
  readonly string: {};
@@ -555,6 +589,7 @@ export declare const fieldTypeCompatibilityMatrix: {
555
589
  readonly number: null;
556
590
  readonly object: null;
557
591
  readonly reference: null;
592
+ readonly richText: null;
558
593
  readonly html: {};
559
594
  readonly markdown: {};
560
595
  readonly string: {};
package/dist/src/compatibilities.js CHANGED
@@ -103,6 +103,7 @@ export const fieldTypeCompatibilityMatrix = {
103
103
  [Api.FieldValueTypes.NUMBER]: null,
104
104
  [Api.FieldValueTypes.OBJECT]: null,
105
105
  [Api.FieldValueTypes.REFERENCE]: null,
106
+ [Api.FieldValueTypes.RICH_TEXT]: null,
106
107
  [Api.FieldValueTypes.RICH_TEXT_HTML]: null,
107
108
  [Api.FieldValueTypes.RICH_TEXT_MARKDOWN]: null,
108
109
  [Api.FieldValueTypes.STRING]: null,
@@ -121,6 +122,7 @@ export const fieldTypeCompatibilityMatrix = {
121
122
  [Api.FieldValueTypes.NUMBER]: {},
122
123
  [Api.FieldValueTypes.OBJECT]: null,
123
124
  [Api.FieldValueTypes.REFERENCE]: null,
125
+ [Api.FieldValueTypes.RICH_TEXT]: null,
124
126
  [Api.FieldValueTypes.RICH_TEXT_HTML]: {},
125
127
  [Api.FieldValueTypes.RICH_TEXT_MARKDOWN]: {},
126
128
  [Api.FieldValueTypes.STRING]: {},
@@ -139,6 +141,7 @@ export const fieldTypeCompatibilityMatrix = {
139
141
  [Api.FieldValueTypes.NUMBER]: {},
140
142
  [Api.FieldValueTypes.OBJECT]: null,
141
143
  [Api.FieldValueTypes.REFERENCE]: null,
144
+ [Api.FieldValueTypes.RICH_TEXT]: null,
142
145
  [Api.FieldValueTypes.RICH_TEXT_HTML]: dateToStringlikeConfiguration,
143
146
  [Api.FieldValueTypes.RICH_TEXT_MARKDOWN]: dateToStringlikeConfiguration,
144
147
  [Api.FieldValueTypes.STRING]: dateToStringlikeConfiguration,
@@ -157,6 +160,7 @@ export const fieldTypeCompatibilityMatrix = {
157
160
  [Api.FieldValueTypes.NUMBER]: null,
158
161
  [Api.FieldValueTypes.OBJECT]: null,
159
162
  [Api.FieldValueTypes.REFERENCE]: null,
163
+ [Api.FieldValueTypes.RICH_TEXT]: null,
160
164
  [Api.FieldValueTypes.RICH_TEXT_HTML]: null,
161
165
  [Api.FieldValueTypes.RICH_TEXT_MARKDOWN]: null,
162
166
  [Api.FieldValueTypes.STRING]: null,
@@ -175,6 +179,7 @@ export const fieldTypeCompatibilityMatrix = {
175
179
  [Api.FieldValueTypes.NUMBER]: {},
176
180
  [Api.FieldValueTypes.OBJECT]: null,
177
181
  [Api.FieldValueTypes.REFERENCE]: null,
182
+ [Api.FieldValueTypes.RICH_TEXT]: null,
178
183
  [Api.FieldValueTypes.RICH_TEXT_HTML]: dateToStringlikeConfiguration,
179
184
  [Api.FieldValueTypes.RICH_TEXT_MARKDOWN]: dateToStringlikeConfiguration,
180
185
  [Api.FieldValueTypes.STRING]: dateToStringlikeConfiguration,
@@ -193,6 +198,7 @@ export const fieldTypeCompatibilityMatrix = {
193
198
  [Api.FieldValueTypes.NUMBER]: null,
194
199
  [Api.FieldValueTypes.OBJECT]: null,
195
200
  [Api.FieldValueTypes.REFERENCE]: null,
201
+ [Api.FieldValueTypes.RICH_TEXT]: null,
196
202
  [Api.FieldValueTypes.RICH_TEXT_HTML]: null,
197
203
  [Api.FieldValueTypes.RICH_TEXT_MARKDOWN]: null,
198
204
  [Api.FieldValueTypes.STRING]: null,
@@ -211,6 +217,7 @@ export const fieldTypeCompatibilityMatrix = {
211
217
  [Api.FieldValueTypes.NUMBER]: {},
212
218
  [Api.FieldValueTypes.OBJECT]: null,
213
219
  [Api.FieldValueTypes.REFERENCE]: null,
220
+ [Api.FieldValueTypes.RICH_TEXT]: null,
214
221
  [Api.FieldValueTypes.RICH_TEXT_HTML]: {},
215
222
  [Api.FieldValueTypes.RICH_TEXT_MARKDOWN]: {},
216
223
  [Api.FieldValueTypes.STRING]: {},
@@ -229,6 +236,7 @@ export const fieldTypeCompatibilityMatrix = {
229
236
  [Api.FieldValueTypes.NUMBER]: null,
230
237
  [Api.FieldValueTypes.OBJECT]: null,
231
238
  [Api.FieldValueTypes.REFERENCE]: stringLikeToReferenceConfiguration,
239
+ [Api.FieldValueTypes.RICH_TEXT]: null,
232
240
  [Api.FieldValueTypes.RICH_TEXT_HTML]: {},
233
241
  [Api.FieldValueTypes.RICH_TEXT_MARKDOWN]: {},
234
242
  [Api.FieldValueTypes.STRING]: {},
@@ -247,6 +255,7 @@ export const fieldTypeCompatibilityMatrix = {
247
255
  [Api.FieldValueTypes.NUMBER]: {},
248
256
  [Api.FieldValueTypes.OBJECT]: null,
249
257
  [Api.FieldValueTypes.REFERENCE]: null,
258
+ [Api.FieldValueTypes.RICH_TEXT]: null,
250
259
  [Api.FieldValueTypes.RICH_TEXT_HTML]: {},
251
260
  [Api.FieldValueTypes.RICH_TEXT_MARKDOWN]: {},
252
261
  [Api.FieldValueTypes.STRING]: {},
@@ -265,6 +274,7 @@ export const fieldTypeCompatibilityMatrix = {
265
274
  [Api.FieldValueTypes.NUMBER]: {},
266
275
  [Api.FieldValueTypes.OBJECT]: null,
267
276
  [Api.FieldValueTypes.REFERENCE]: null,
277
+ [Api.FieldValueTypes.RICH_TEXT]: null,
268
278
  [Api.FieldValueTypes.RICH_TEXT_HTML]: {},
269
279
  [Api.FieldValueTypes.RICH_TEXT_MARKDOWN]: {},
270
280
  [Api.FieldValueTypes.STRING]: {},
@@ -283,6 +293,7 @@ export const fieldTypeCompatibilityMatrix = {
283
293
  [Api.FieldValueTypes.NUMBER]: null,
284
294
  [Api.FieldValueTypes.OBJECT]: null,
285
295
  [Api.FieldValueTypes.REFERENCE]: null,
296
+ [Api.FieldValueTypes.RICH_TEXT]: null,
286
297
  [Api.FieldValueTypes.RICH_TEXT_HTML]: null,
287
298
  [Api.FieldValueTypes.RICH_TEXT_MARKDOWN]: null,
288
299
  [Api.FieldValueTypes.STRING]: null,
@@ -316,11 +327,31 @@ export const fieldTypeCompatibilityMatrix = {
316
327
  required: true,
317
328
  },
318
329
  },
330
+ [Api.FieldValueTypes.RICH_TEXT]: null,
319
331
  [Api.FieldValueTypes.RICH_TEXT_HTML]: referenceToStringLikeConfiguration,
320
332
  [Api.FieldValueTypes.RICH_TEXT_MARKDOWN]: referenceToStringLikeConfiguration,
321
333
  [Api.FieldValueTypes.STRING]: referenceToStringLikeConfiguration,
322
334
  [Api.FieldValueTypes.URL]: null,
323
335
  },
336
+ [Api.FieldValueTypes.RICH_TEXT]: {
337
+ [Api.FieldValueTypes.BLOB]: null,
338
+ [Api.FieldValueTypes.BOOLEAN]: null,
339
+ [Api.FieldValueTypes.DATE]: null,
340
+ [Api.FieldValueTypes.DATE_RANGE]: null,
341
+ [Api.FieldValueTypes.DATETIME]: null,
342
+ [Api.FieldValueTypes.DATETIME_RANGE]: null,
343
+ [Api.FieldValueTypes.DURATION]: null,
344
+ [Api.FieldValueTypes.EMAIL]: null,
345
+ [Api.FieldValueTypes.INTEGER]: null,
346
+ [Api.FieldValueTypes.NUMBER]: null,
347
+ [Api.FieldValueTypes.OBJECT]: null,
348
+ [Api.FieldValueTypes.REFERENCE]: null,
349
+ [Api.FieldValueTypes.RICH_TEXT]: null,
350
+ [Api.FieldValueTypes.RICH_TEXT_HTML]: null,
351
+ [Api.FieldValueTypes.RICH_TEXT_MARKDOWN]: null,
352
+ [Api.FieldValueTypes.STRING]: null,
353
+ [Api.FieldValueTypes.URL]: null,
354
+ },
324
355
  [Api.FieldValueTypes.RICH_TEXT_HTML]: {
325
356
  [Api.FieldValueTypes.BLOB]: null,
326
357
  [Api.FieldValueTypes.BOOLEAN]: null,
@@ -334,6 +365,7 @@ export const fieldTypeCompatibilityMatrix = {
334
365
  [Api.FieldValueTypes.NUMBER]: null,
335
366
  [Api.FieldValueTypes.OBJECT]: null,
336
367
  [Api.FieldValueTypes.REFERENCE]: null,
368
+ [Api.FieldValueTypes.RICH_TEXT]: null,
337
369
  [Api.FieldValueTypes.RICH_TEXT_HTML]: htmlToRichTextConfiguration,
338
370
  [Api.FieldValueTypes.RICH_TEXT_MARKDOWN]: htmlToRichTextConfiguration,
339
371
  [Api.FieldValueTypes.STRING]: {},
@@ -352,6 +384,7 @@ export const fieldTypeCompatibilityMatrix = {
352
384
  [Api.FieldValueTypes.NUMBER]: null,
353
385
  [Api.FieldValueTypes.OBJECT]: null,
354
386
  [Api.FieldValueTypes.REFERENCE]: null,
387
+ [Api.FieldValueTypes.RICH_TEXT]: null,
355
388
  [Api.FieldValueTypes.RICH_TEXT_HTML]: markdownToRichTextConfiguration,
356
389
  [Api.FieldValueTypes.RICH_TEXT_MARKDOWN]: markdownToRichTextConfiguration,
357
390
  [Api.FieldValueTypes.STRING]: {},
@@ -370,6 +403,7 @@ export const fieldTypeCompatibilityMatrix = {
370
403
  [Api.FieldValueTypes.NUMBER]: {},
371
404
  [Api.FieldValueTypes.OBJECT]: null,
372
405
  [Api.FieldValueTypes.REFERENCE]: stringLikeToReferenceConfiguration,
406
+ [Api.FieldValueTypes.RICH_TEXT]: null,
373
407
  [Api.FieldValueTypes.RICH_TEXT_HTML]: {},
374
408
  [Api.FieldValueTypes.RICH_TEXT_MARKDOWN]: {},
375
409
  [Api.FieldValueTypes.STRING]: {},
@@ -388,6 +422,7 @@ export const fieldTypeCompatibilityMatrix = {
388
422
  [Api.FieldValueTypes.NUMBER]: null,
389
423
  [Api.FieldValueTypes.OBJECT]: null,
390
424
  [Api.FieldValueTypes.REFERENCE]: null,
425
+ [Api.FieldValueTypes.RICH_TEXT]: null,
391
426
  [Api.FieldValueTypes.RICH_TEXT_HTML]: {},
392
427
  [Api.FieldValueTypes.RICH_TEXT_MARKDOWN]: {},
393
428
  [Api.FieldValueTypes.STRING]: {},
package/dist/src/guards.js CHANGED
@@ -31,6 +31,7 @@ export function isUndefined(potentialUndefined) {
31
31
  export function isItemSummary(potentialItemSummary) {
32
32
  return (isObject(potentialItemSummary) &&
33
33
  isString(potentialItemSummary['path']) &&
34
+ isString(potentialItemSummary['canonicalPath']) &&
34
35
  (isUndefined(potentialItemSummary['fields']) || isObject(potentialItemSummary['fields'])) &&
35
36
  (isUndefined(potentialItemSummary['relations']) ||
36
37
  (Array.isArray(potentialItemSummary['relations']) && potentialItemSummary['relations'].every(isString))));
@@ -43,6 +44,7 @@ export function isItemSummary(potentialItemSummary) {
43
44
  export function isItem(potentialItem) {
44
45
  return (isObject(potentialItem) &&
45
46
  isObject(potentialItem['fields']) &&
47
+ isString(potentialItem['canonicalPath']) &&
46
48
  Array.isArray(potentialItem['relations']) &&
47
49
  potentialItem['relations'].every((r) => isRelation(r)));
48
50
  }
package/dist/src/index.cjs CHANGED
@@ -20,6 +20,7 @@ const FieldValueTypes = {
20
20
  NUMBER: 'number',
21
21
  OBJECT: 'object',
22
22
  REFERENCE: 'reference',
23
+ RICH_TEXT: 'richText',
23
24
  STRING: 'string',
24
25
  URL: 'url',
25
26
  };
@@ -148,6 +149,7 @@ function isUndefined(potentialUndefined) {
148
149
  function isItemSummary(potentialItemSummary) {
149
150
  return (isObject(potentialItemSummary) &&
150
151
  isString(potentialItemSummary['path']) &&
152
+ isString(potentialItemSummary['canonicalPath']) &&
151
153
  (isUndefined(potentialItemSummary['fields']) || isObject(potentialItemSummary['fields'])) &&
152
154
  (isUndefined(potentialItemSummary['relations']) ||
153
155
  (Array.isArray(potentialItemSummary['relations']) && potentialItemSummary['relations'].every(isString))));
@@ -160,6 +162,7 @@ function isItemSummary(potentialItemSummary) {
160
162
  function isItem(potentialItem) {
161
163
  return (isObject(potentialItem) &&
162
164
  isObject(potentialItem['fields']) &&
165
+ isString(potentialItem['canonicalPath']) &&
163
166
  Array.isArray(potentialItem['relations']) &&
164
167
  potentialItem['relations'].every((r) => isRelation(r)));
165
168
  }
@@ -377,6 +380,7 @@ const fieldTypeCompatibilityMatrix = {
377
380
  [FieldValueTypes.NUMBER]: null,
378
381
  [FieldValueTypes.OBJECT]: null,
379
382
  [FieldValueTypes.REFERENCE]: null,
383
+ [FieldValueTypes.RICH_TEXT]: null,
380
384
  [FieldValueTypes.RICH_TEXT_HTML]: null,
381
385
  [FieldValueTypes.RICH_TEXT_MARKDOWN]: null,
382
386
  [FieldValueTypes.STRING]: null,
@@ -395,6 +399,7 @@ const fieldTypeCompatibilityMatrix = {
395
399
  [FieldValueTypes.NUMBER]: {},
396
400
  [FieldValueTypes.OBJECT]: null,
397
401
  [FieldValueTypes.REFERENCE]: null,
402
+ [FieldValueTypes.RICH_TEXT]: null,
398
403
  [FieldValueTypes.RICH_TEXT_HTML]: {},
399
404
  [FieldValueTypes.RICH_TEXT_MARKDOWN]: {},
400
405
  [FieldValueTypes.STRING]: {},
@@ -413,6 +418,7 @@ const fieldTypeCompatibilityMatrix = {
413
418
  [FieldValueTypes.NUMBER]: {},
414
419
  [FieldValueTypes.OBJECT]: null,
415
420
  [FieldValueTypes.REFERENCE]: null,
421
+ [FieldValueTypes.RICH_TEXT]: null,
416
422
  [FieldValueTypes.RICH_TEXT_HTML]: dateToStringlikeConfiguration,
417
423
  [FieldValueTypes.RICH_TEXT_MARKDOWN]: dateToStringlikeConfiguration,
418
424
  [FieldValueTypes.STRING]: dateToStringlikeConfiguration,
@@ -431,6 +437,7 @@ const fieldTypeCompatibilityMatrix = {
431
437
  [FieldValueTypes.NUMBER]: null,
432
438
  [FieldValueTypes.OBJECT]: null,
433
439
  [FieldValueTypes.REFERENCE]: null,
440
+ [FieldValueTypes.RICH_TEXT]: null,
434
441
  [FieldValueTypes.RICH_TEXT_HTML]: null,
435
442
  [FieldValueTypes.RICH_TEXT_MARKDOWN]: null,
436
443
  [FieldValueTypes.STRING]: null,
@@ -449,6 +456,7 @@ const fieldTypeCompatibilityMatrix = {
449
456
  [FieldValueTypes.NUMBER]: {},
450
457
  [FieldValueTypes.OBJECT]: null,
451
458
  [FieldValueTypes.REFERENCE]: null,
459
+ [FieldValueTypes.RICH_TEXT]: null,
452
460
  [FieldValueTypes.RICH_TEXT_HTML]: dateToStringlikeConfiguration,
453
461
  [FieldValueTypes.RICH_TEXT_MARKDOWN]: dateToStringlikeConfiguration,
454
462
  [FieldValueTypes.STRING]: dateToStringlikeConfiguration,
@@ -467,6 +475,7 @@ const fieldTypeCompatibilityMatrix = {
467
475
  [FieldValueTypes.NUMBER]: null,
468
476
  [FieldValueTypes.OBJECT]: null,
469
477
  [FieldValueTypes.REFERENCE]: null,
478
+ [FieldValueTypes.RICH_TEXT]: null,
470
479
  [FieldValueTypes.RICH_TEXT_HTML]: null,
471
480
  [FieldValueTypes.RICH_TEXT_MARKDOWN]: null,
472
481
  [FieldValueTypes.STRING]: null,
@@ -485,6 +494,7 @@ const fieldTypeCompatibilityMatrix = {
485
494
  [FieldValueTypes.NUMBER]: {},
486
495
  [FieldValueTypes.OBJECT]: null,
487
496
  [FieldValueTypes.REFERENCE]: null,
497
+ [FieldValueTypes.RICH_TEXT]: null,
488
498
  [FieldValueTypes.RICH_TEXT_HTML]: {},
489
499
  [FieldValueTypes.RICH_TEXT_MARKDOWN]: {},
490
500
  [FieldValueTypes.STRING]: {},
@@ -503,6 +513,7 @@ const fieldTypeCompatibilityMatrix = {
503
513
  [FieldValueTypes.NUMBER]: null,
504
514
  [FieldValueTypes.OBJECT]: null,
505
515
  [FieldValueTypes.REFERENCE]: stringLikeToReferenceConfiguration,
516
+ [FieldValueTypes.RICH_TEXT]: null,
506
517
  [FieldValueTypes.RICH_TEXT_HTML]: {},
507
518
  [FieldValueTypes.RICH_TEXT_MARKDOWN]: {},
508
519
  [FieldValueTypes.STRING]: {},
@@ -521,6 +532,7 @@ const fieldTypeCompatibilityMatrix = {
521
532
  [FieldValueTypes.NUMBER]: {},
522
533
  [FieldValueTypes.OBJECT]: null,
523
534
  [FieldValueTypes.REFERENCE]: null,
535
+ [FieldValueTypes.RICH_TEXT]: null,
524
536
  [FieldValueTypes.RICH_TEXT_HTML]: {},
525
537
  [FieldValueTypes.RICH_TEXT_MARKDOWN]: {},
526
538
  [FieldValueTypes.STRING]: {},
@@ -539,6 +551,7 @@ const fieldTypeCompatibilityMatrix = {
539
551
  [FieldValueTypes.NUMBER]: {},
540
552
  [FieldValueTypes.OBJECT]: null,
541
553
  [FieldValueTypes.REFERENCE]: null,
554
+ [FieldValueTypes.RICH_TEXT]: null,
542
555
  [FieldValueTypes.RICH_TEXT_HTML]: {},
543
556
  [FieldValueTypes.RICH_TEXT_MARKDOWN]: {},
544
557
  [FieldValueTypes.STRING]: {},
@@ -557,6 +570,7 @@ const fieldTypeCompatibilityMatrix = {
557
570
  [FieldValueTypes.NUMBER]: null,
558
571
  [FieldValueTypes.OBJECT]: null,
559
572
  [FieldValueTypes.REFERENCE]: null,
573
+ [FieldValueTypes.RICH_TEXT]: null,
560
574
  [FieldValueTypes.RICH_TEXT_HTML]: null,
561
575
  [FieldValueTypes.RICH_TEXT_MARKDOWN]: null,
562
576
  [FieldValueTypes.STRING]: null,
@@ -590,11 +604,31 @@ const fieldTypeCompatibilityMatrix = {
590
604
  required: true,
591
605
  },
592
606
  },
607
+ [FieldValueTypes.RICH_TEXT]: null,
593
608
  [FieldValueTypes.RICH_TEXT_HTML]: referenceToStringLikeConfiguration,
594
609
  [FieldValueTypes.RICH_TEXT_MARKDOWN]: referenceToStringLikeConfiguration,
595
610
  [FieldValueTypes.STRING]: referenceToStringLikeConfiguration,
596
611
  [FieldValueTypes.URL]: null,
597
612
  },
613
+ [FieldValueTypes.RICH_TEXT]: {
614
+ [FieldValueTypes.BLOB]: null,
615
+ [FieldValueTypes.BOOLEAN]: null,
616
+ [FieldValueTypes.DATE]: null,
617
+ [FieldValueTypes.DATE_RANGE]: null,
618
+ [FieldValueTypes.DATETIME]: null,
619
+ [FieldValueTypes.DATETIME_RANGE]: null,
620
+ [FieldValueTypes.DURATION]: null,
621
+ [FieldValueTypes.EMAIL]: null,
622
+ [FieldValueTypes.INTEGER]: null,
623
+ [FieldValueTypes.NUMBER]: null,
624
+ [FieldValueTypes.OBJECT]: null,
625
+ [FieldValueTypes.REFERENCE]: null,
626
+ [FieldValueTypes.RICH_TEXT]: null,
627
+ [FieldValueTypes.RICH_TEXT_HTML]: null,
628
+ [FieldValueTypes.RICH_TEXT_MARKDOWN]: null,
629
+ [FieldValueTypes.STRING]: null,
630
+ [FieldValueTypes.URL]: null,
631
+ },
598
632
  [FieldValueTypes.RICH_TEXT_HTML]: {
599
633
  [FieldValueTypes.BLOB]: null,
600
634
  [FieldValueTypes.BOOLEAN]: null,
@@ -608,6 +642,7 @@ const fieldTypeCompatibilityMatrix = {
608
642
  [FieldValueTypes.NUMBER]: null,
609
643
  [FieldValueTypes.OBJECT]: null,
610
644
  [FieldValueTypes.REFERENCE]: null,
645
+ [FieldValueTypes.RICH_TEXT]: null,
611
646
  [FieldValueTypes.RICH_TEXT_HTML]: htmlToRichTextConfiguration,
612
647
  [FieldValueTypes.RICH_TEXT_MARKDOWN]: htmlToRichTextConfiguration,
613
648
  [FieldValueTypes.STRING]: {},
@@ -626,6 +661,7 @@ const fieldTypeCompatibilityMatrix = {
626
661
  [FieldValueTypes.NUMBER]: null,
627
662
  [FieldValueTypes.OBJECT]: null,
628
663
  [FieldValueTypes.REFERENCE]: null,
664
+ [FieldValueTypes.RICH_TEXT]: null,
629
665
  [FieldValueTypes.RICH_TEXT_HTML]: markdownToRichTextConfiguration,
630
666
  [FieldValueTypes.RICH_TEXT_MARKDOWN]: markdownToRichTextConfiguration,
631
667
  [FieldValueTypes.STRING]: {},
@@ -644,6 +680,7 @@ const fieldTypeCompatibilityMatrix = {
644
680
  [FieldValueTypes.NUMBER]: {},
645
681
  [FieldValueTypes.OBJECT]: null,
646
682
  [FieldValueTypes.REFERENCE]: stringLikeToReferenceConfiguration,
683
+ [FieldValueTypes.RICH_TEXT]: null,
647
684
  [FieldValueTypes.RICH_TEXT_HTML]: {},
648
685
  [FieldValueTypes.RICH_TEXT_MARKDOWN]: {},
649
686
  [FieldValueTypes.STRING]: {},
@@ -662,6 +699,7 @@ const fieldTypeCompatibilityMatrix = {
662
699
  [FieldValueTypes.NUMBER]: null,
663
700
  [FieldValueTypes.OBJECT]: null,
664
701
  [FieldValueTypes.REFERENCE]: null,
702
+ [FieldValueTypes.RICH_TEXT]: null,
665
703
  [FieldValueTypes.RICH_TEXT_HTML]: {},
666
704
  [FieldValueTypes.RICH_TEXT_MARKDOWN]: {},
667
705
  [FieldValueTypes.STRING]: {},
package/dist/src/types.d.ts CHANGED
@@ -268,6 +268,7 @@ export declare const FieldValueTypes: {
268
268
  readonly NUMBER: "number";
269
269
  readonly OBJECT: "object";
270
270
  readonly REFERENCE: "reference";
271
+ readonly RICH_TEXT: "richText";
271
272
  readonly STRING: "string";
272
273
  readonly URL: "url";
273
274
  };
@@ -348,7 +349,7 @@ export interface Item<T extends RelationSchema | undefined = undefined> {
348
349
  * The canonical path of the item. This is the path / id that uniquely identifies the item in a provider.
349
350
  * Even if the item is moved in the graph, the canonical path should remain the same.
350
351
  */
351
- canonicalPath?: string;
352
+ canonicalPath: string;
352
353
  }
353
354
  /**
354
355
  * An ItemSummary is a constituent of a collection.
@@ -375,7 +376,7 @@ export interface ItemSummary<T extends RelationSchema | undefined = undefined> {
375
376
  * The canonical path of the item. This is the path / id that uniquely identifies the item in a provider.
376
377
  * Even if the item is moved in the graph, the canonical path should remain the same.
377
378
  */
378
- canonicalPath?: string;
379
+ canonicalPath: string;
379
380
  }
380
381
  /**
381
382
  * A BlobSummary contains a path to download the corresponding Blob.
package/dist/src/types.js CHANGED
@@ -18,6 +18,7 @@ export const FieldValueTypes = {
18
18
  NUMBER: 'number',
19
19
  OBJECT: 'object',
20
20
  REFERENCE: 'reference',
21
+ RICH_TEXT: 'richText',
21
22
  STRING: 'string',
22
23
  URL: 'url',
23
24
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@unito/integration-api",
3
- "version": "7.1.2",
3
+ "version": "8.0.1",
4
4
  "description": "The Unito Integration API",
5
5
  "type": "module",
6
6
  "types": "./dist/src/index.d.ts",