@api-client/core 0.17.3 → 0.17.4
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.
- package/build/src/modeling/Semantics.d.ts +5 -0
- package/build/src/modeling/Semantics.d.ts.map +1 -1
- package/build/src/modeling/Semantics.js +28 -0
- package/build/src/modeling/Semantics.js.map +1 -1
- package/build/tsconfig.tsbuildinfo +1 -1
- package/package.json +1 -1
- package/src/modeling/Semantics.ts +33 -0
package/package.json
CHANGED
|
@@ -293,6 +293,11 @@ interface BaseDataSemantic {
|
|
|
293
293
|
* The category this semantic belongs to for UI organization.
|
|
294
294
|
*/
|
|
295
295
|
category: SemanticCategory
|
|
296
|
+
/**
|
|
297
|
+
* Whether the semantic has a configuration or additional options.
|
|
298
|
+
* This is used to determine if the semantic requires additional setup or configuration.
|
|
299
|
+
*/
|
|
300
|
+
hasConfig: boolean
|
|
296
301
|
}
|
|
297
302
|
|
|
298
303
|
/**
|
|
@@ -359,6 +364,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
|
|
|
359
364
|
scope: SemanticScope.Entity,
|
|
360
365
|
description: 'System users and accounts',
|
|
361
366
|
category: SemanticCategory.Identity,
|
|
367
|
+
hasConfig: false,
|
|
362
368
|
},
|
|
363
369
|
[SemanticType.Password]: {
|
|
364
370
|
id: SemanticType.Password,
|
|
@@ -367,6 +373,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
|
|
|
367
373
|
description: 'Secure password field',
|
|
368
374
|
category: SemanticCategory.Identity,
|
|
369
375
|
applicableDataTypes: ['string'],
|
|
376
|
+
hasConfig: true,
|
|
370
377
|
},
|
|
371
378
|
[SemanticType.UserRole]: {
|
|
372
379
|
id: SemanticType.UserRole,
|
|
@@ -375,6 +382,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
|
|
|
375
382
|
description: 'User permissions and access level',
|
|
376
383
|
category: SemanticCategory.Identity,
|
|
377
384
|
applicableDataTypes: ['string'],
|
|
385
|
+
hasConfig: false,
|
|
378
386
|
},
|
|
379
387
|
[SemanticType.ResourceOwnerIdentifier]: {
|
|
380
388
|
id: SemanticType.ResourceOwnerIdentifier,
|
|
@@ -382,6 +390,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
|
|
|
382
390
|
scope: SemanticScope.Association,
|
|
383
391
|
description: 'Links record to owner user',
|
|
384
392
|
category: SemanticCategory.Identity,
|
|
393
|
+
hasConfig: false,
|
|
385
394
|
},
|
|
386
395
|
|
|
387
396
|
//
|
|
@@ -395,6 +404,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
|
|
|
395
404
|
description: 'When record was created',
|
|
396
405
|
category: SemanticCategory.Lifecycle,
|
|
397
406
|
applicableDataTypes: ['datetime'],
|
|
407
|
+
hasConfig: false,
|
|
398
408
|
},
|
|
399
409
|
[SemanticType.UpdatedTimestamp]: {
|
|
400
410
|
id: SemanticType.UpdatedTimestamp,
|
|
@@ -403,6 +413,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
|
|
|
403
413
|
description: 'When record was last modified',
|
|
404
414
|
category: SemanticCategory.Lifecycle,
|
|
405
415
|
applicableDataTypes: ['datetime'],
|
|
416
|
+
hasConfig: false,
|
|
406
417
|
},
|
|
407
418
|
[SemanticType.DeletedTimestamp]: {
|
|
408
419
|
id: SemanticType.DeletedTimestamp,
|
|
@@ -411,6 +422,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
|
|
|
411
422
|
description: 'When record was marked deleted',
|
|
412
423
|
category: SemanticCategory.Lifecycle,
|
|
413
424
|
applicableDataTypes: ['datetime'],
|
|
425
|
+
hasConfig: false,
|
|
414
426
|
},
|
|
415
427
|
[SemanticType.DeletedFlag]: {
|
|
416
428
|
id: SemanticType.DeletedFlag,
|
|
@@ -419,6 +431,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
|
|
|
419
431
|
description: 'Mark record as deleted',
|
|
420
432
|
category: SemanticCategory.Lifecycle,
|
|
421
433
|
applicableDataTypes: ['boolean'],
|
|
434
|
+
hasConfig: false,
|
|
422
435
|
},
|
|
423
436
|
[SemanticType.Version]: {
|
|
424
437
|
id: SemanticType.Version,
|
|
@@ -427,6 +440,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
|
|
|
427
440
|
description: 'Auto-incrementing version counter',
|
|
428
441
|
category: SemanticCategory.Lifecycle,
|
|
429
442
|
applicableDataTypes: ['number'],
|
|
443
|
+
hasConfig: false,
|
|
430
444
|
},
|
|
431
445
|
|
|
432
446
|
//
|
|
@@ -440,6 +454,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
|
|
|
440
454
|
description: 'Main title or heading',
|
|
441
455
|
category: SemanticCategory.Content,
|
|
442
456
|
applicableDataTypes: ['string'],
|
|
457
|
+
hasConfig: false,
|
|
443
458
|
},
|
|
444
459
|
[SemanticType.Description]: {
|
|
445
460
|
id: SemanticType.Description,
|
|
@@ -448,6 +463,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
|
|
|
448
463
|
description: 'Detailed description text',
|
|
449
464
|
category: SemanticCategory.Content,
|
|
450
465
|
applicableDataTypes: ['string'],
|
|
466
|
+
hasConfig: true,
|
|
451
467
|
},
|
|
452
468
|
[SemanticType.Summary]: {
|
|
453
469
|
id: SemanticType.Summary,
|
|
@@ -456,6 +472,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
|
|
|
456
472
|
description: 'Brief summary text',
|
|
457
473
|
category: SemanticCategory.Content,
|
|
458
474
|
applicableDataTypes: ['string'],
|
|
475
|
+
hasConfig: true,
|
|
459
476
|
},
|
|
460
477
|
[SemanticType.Markdown]: {
|
|
461
478
|
id: SemanticType.Markdown,
|
|
@@ -464,6 +481,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
|
|
|
464
481
|
description: 'Formatted text content',
|
|
465
482
|
category: SemanticCategory.Content,
|
|
466
483
|
applicableDataTypes: ['string'],
|
|
484
|
+
hasConfig: true,
|
|
467
485
|
},
|
|
468
486
|
[SemanticType.HTML]: {
|
|
469
487
|
id: SemanticType.HTML,
|
|
@@ -472,6 +490,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
|
|
|
472
490
|
description: 'Rich HTML content',
|
|
473
491
|
category: SemanticCategory.Content,
|
|
474
492
|
applicableDataTypes: ['string'],
|
|
493
|
+
hasConfig: true,
|
|
475
494
|
},
|
|
476
495
|
[SemanticType.ImageURL]: {
|
|
477
496
|
id: SemanticType.ImageURL,
|
|
@@ -480,6 +499,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
|
|
|
480
499
|
description: 'Link to image file',
|
|
481
500
|
category: SemanticCategory.Content,
|
|
482
501
|
applicableDataTypes: ['string'],
|
|
502
|
+
hasConfig: false,
|
|
483
503
|
},
|
|
484
504
|
[SemanticType.FileURL]: {
|
|
485
505
|
id: SemanticType.FileURL,
|
|
@@ -488,6 +508,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
|
|
|
488
508
|
description: 'Link to file attachment',
|
|
489
509
|
category: SemanticCategory.Content,
|
|
490
510
|
applicableDataTypes: ['string'],
|
|
511
|
+
hasConfig: false,
|
|
491
512
|
},
|
|
492
513
|
|
|
493
514
|
//
|
|
@@ -501,6 +522,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
|
|
|
501
522
|
description: 'Current state of record',
|
|
502
523
|
category: SemanticCategory.Business,
|
|
503
524
|
applicableDataTypes: ['string'],
|
|
525
|
+
hasConfig: true,
|
|
504
526
|
},
|
|
505
527
|
[SemanticType.Price]: {
|
|
506
528
|
id: SemanticType.Price,
|
|
@@ -509,6 +531,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
|
|
|
509
531
|
description: 'Monetary value with currency',
|
|
510
532
|
category: SemanticCategory.Business,
|
|
511
533
|
applicableDataTypes: ['number', 'string'],
|
|
534
|
+
hasConfig: true,
|
|
512
535
|
},
|
|
513
536
|
[SemanticType.SKU]: {
|
|
514
537
|
id: SemanticType.SKU,
|
|
@@ -517,6 +540,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
|
|
|
517
540
|
description: 'Product identification code',
|
|
518
541
|
category: SemanticCategory.Business,
|
|
519
542
|
applicableDataTypes: ['string'],
|
|
543
|
+
hasConfig: true,
|
|
520
544
|
},
|
|
521
545
|
|
|
522
546
|
//
|
|
@@ -530,6 +554,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
|
|
|
530
554
|
description: 'Email address',
|
|
531
555
|
category: SemanticCategory.Contact,
|
|
532
556
|
applicableDataTypes: ['string'],
|
|
557
|
+
hasConfig: true,
|
|
533
558
|
},
|
|
534
559
|
[SemanticType.Phone]: {
|
|
535
560
|
id: SemanticType.Phone,
|
|
@@ -538,6 +563,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
|
|
|
538
563
|
description: 'Phone number',
|
|
539
564
|
category: SemanticCategory.Contact,
|
|
540
565
|
applicableDataTypes: ['string'],
|
|
566
|
+
hasConfig: true,
|
|
541
567
|
},
|
|
542
568
|
[SemanticType.URL]: {
|
|
543
569
|
id: SemanticType.URL,
|
|
@@ -546,6 +572,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
|
|
|
546
572
|
description: 'Web address or link',
|
|
547
573
|
category: SemanticCategory.Contact,
|
|
548
574
|
applicableDataTypes: ['string'],
|
|
575
|
+
hasConfig: true,
|
|
549
576
|
},
|
|
550
577
|
|
|
551
578
|
//
|
|
@@ -559,6 +586,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
|
|
|
559
586
|
description: 'URL-friendly unique identifier',
|
|
560
587
|
category: SemanticCategory.Organization,
|
|
561
588
|
applicableDataTypes: ['string'],
|
|
589
|
+
hasConfig: true,
|
|
562
590
|
},
|
|
563
591
|
[SemanticType.Tags]: {
|
|
564
592
|
id: SemanticType.Tags,
|
|
@@ -566,6 +594,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
|
|
|
566
594
|
scope: SemanticScope.Association,
|
|
567
595
|
description: 'Enable tagging functionality',
|
|
568
596
|
category: SemanticCategory.Organization,
|
|
597
|
+
hasConfig: true,
|
|
569
598
|
},
|
|
570
599
|
[SemanticType.Categories]: {
|
|
571
600
|
id: SemanticType.Categories,
|
|
@@ -573,6 +602,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
|
|
|
573
602
|
scope: SemanticScope.Association,
|
|
574
603
|
description: 'Enable categorization functionality',
|
|
575
604
|
category: SemanticCategory.Organization,
|
|
605
|
+
hasConfig: true,
|
|
576
606
|
},
|
|
577
607
|
|
|
578
608
|
//
|
|
@@ -586,6 +616,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
|
|
|
586
616
|
description: 'Location coordinates',
|
|
587
617
|
category: SemanticCategory.Location,
|
|
588
618
|
applicableDataTypes: ['string'],
|
|
619
|
+
hasConfig: true,
|
|
589
620
|
},
|
|
590
621
|
|
|
591
622
|
//
|
|
@@ -599,6 +630,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
|
|
|
599
630
|
description: 'Auto-calculated field value',
|
|
600
631
|
category: SemanticCategory.Computed,
|
|
601
632
|
applicableDataTypes: ['string'],
|
|
633
|
+
hasConfig: true,
|
|
602
634
|
},
|
|
603
635
|
[SemanticType.Derived]: {
|
|
604
636
|
id: SemanticType.Derived,
|
|
@@ -607,6 +639,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
|
|
|
607
639
|
description: 'Value derived from other fields',
|
|
608
640
|
category: SemanticCategory.Computed,
|
|
609
641
|
applicableDataTypes: ['string'],
|
|
642
|
+
hasConfig: true,
|
|
610
643
|
},
|
|
611
644
|
}
|
|
612
645
|
|