@backstage/plugin-catalog-backend-module-ldap 0.11.3-next.1 → 0.11.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 (3) hide show
  1. package/CHANGELOG.md +30 -0
  2. package/config.d.ts +343 -170
  3. package/package.json +10 -17
package/CHANGELOG.md CHANGED
@@ -1,5 +1,35 @@
1
1
  # @backstage/plugin-catalog-backend-module-ldap
2
2
 
3
+ ## 0.11.3
4
+
5
+ ### Patch Changes
6
+
7
+ - e43f41b: Fix `config.d.ts` for `ldapOrg` being incorrect. The documentation says a single
8
+ object or an array are accepted, but the definition only allows an object.
9
+ - Updated dependencies
10
+ - @backstage/backend-plugin-api@1.2.1
11
+ - @backstage/catalog-model@1.7.3
12
+ - @backstage/config@1.3.2
13
+ - @backstage/errors@1.2.7
14
+ - @backstage/types@1.2.1
15
+ - @backstage/plugin-catalog-common@1.1.3
16
+ - @backstage/plugin-catalog-node@1.16.1
17
+
18
+ ## 0.11.3-next.2
19
+
20
+ ### Patch Changes
21
+
22
+ - e43f41b: Fix `config.d.ts` for `ldapOrg` being incorrect. The documentation says a single
23
+ object or an array are accepted, but the definition only allows an object.
24
+ - Updated dependencies
25
+ - @backstage/backend-plugin-api@1.2.1-next.1
26
+ - @backstage/catalog-model@1.7.3
27
+ - @backstage/config@1.3.2
28
+ - @backstage/errors@1.2.7
29
+ - @backstage/types@1.2.1
30
+ - @backstage/plugin-catalog-common@1.1.3
31
+ - @backstage/plugin-catalog-node@1.16.1-next.1
32
+
3
33
  ## 0.11.3-next.1
4
34
 
5
35
  ### Patch Changes
package/config.d.ts CHANGED
@@ -478,180 +478,353 @@ export interface Config {
478
478
  /**
479
479
  * The settings that govern the reading and interpretation of users.
480
480
  */
481
- users: {
482
- /**
483
- * The DN under which users are stored.
484
- *
485
- * E.g. "ou=people,ou=example,dc=example,dc=net"
486
- */
487
- dn: string;
488
- /**
489
- * The search options to use. The default is scope "one" and
490
- * attributes "*" and "+".
491
- *
492
- * It is common to want to specify a filter, to narrow down the set
493
- * of matching items.
494
- */
495
- options: {
496
- scope?: 'base' | 'one' | 'sub';
497
- filter?: string;
498
- attributes?: string | string[];
499
- sizeLimit?: number;
500
- timeLimit?: number;
501
- derefAliases?: number;
502
- typesOnly?: boolean;
503
- paged?:
504
- | boolean
505
- | {
506
- pageSize?: number;
507
- pagePause?: boolean;
508
- };
509
- };
510
- /**
511
- * JSON paths (on a.b.c form) and hard coded values to set on those
512
- * paths.
513
- *
514
- * This can be useful for example if you want to hard code a
515
- * namespace or similar on the generated entities.
516
- */
517
- set?: { [key: string]: JsonValue };
518
- /**
519
- * Mappings from well known entity fields, to LDAP attribute names
520
- */
521
- map?: {
522
- /**
523
- * The name of the attribute that holds the relative
524
- * distinguished name of each entry. Defaults to "uid".
525
- */
526
- rdn?: string;
527
- /**
528
- * The name of the attribute that shall be used for the value of
529
- * the metadata.name field of the entity. Defaults to "uid".
530
- */
531
- name?: string;
532
- /**
533
- * The name of the attribute that shall be used for the value of
534
- * the metadata.description field of the entity.
535
- */
536
- description?: string;
537
- /**
538
- * The name of the attribute that shall be used for the value of
539
- * the spec.profile.displayName field of the entity. Defaults to
540
- * "cn".
541
- */
542
- displayName?: string;
543
- /**
544
- * The name of the attribute that shall be used for the value of
545
- * the spec.profile.email field of the entity. Defaults to
546
- * "mail".
547
- */
548
- email?: string;
549
- /**
550
- * The name of the attribute that shall be used for the value of
551
- * the spec.profile.picture field of the entity.
552
- */
553
- picture?: string;
554
- /**
555
- * The name of the attribute that shall be used for the values of
556
- * the spec.memberOf field of the entity. Defaults to "memberOf".
557
- */
558
- memberOf?: string;
559
- };
560
- };
481
+ users?:
482
+ | {
483
+ /**
484
+ * The DN under which users are stored.
485
+ *
486
+ * E.g. "ou=people,ou=example,dc=example,dc=net"
487
+ */
488
+ dn: string;
489
+ /**
490
+ * The search options to use. The default is scope "one" and
491
+ * attributes "*" and "+".
492
+ *
493
+ * It is common to want to specify a filter, to narrow down the set
494
+ * of matching items.
495
+ */
496
+ options: {
497
+ scope?: 'base' | 'one' | 'sub';
498
+ filter?: string;
499
+ attributes?: string | string[];
500
+ sizeLimit?: number;
501
+ timeLimit?: number;
502
+ derefAliases?: number;
503
+ typesOnly?: boolean;
504
+ paged?:
505
+ | boolean
506
+ | {
507
+ pageSize?: number;
508
+ pagePause?: boolean;
509
+ };
510
+ };
511
+ /**
512
+ * JSON paths (on a.b.c form) and hard coded values to set on those
513
+ * paths.
514
+ *
515
+ * This can be useful for example if you want to hard code a
516
+ * namespace or similar on the generated entities.
517
+ */
518
+ set?: { [key: string]: JsonValue };
519
+ /**
520
+ * Mappings from well known entity fields, to LDAP attribute names
521
+ */
522
+ map?: {
523
+ /**
524
+ * The name of the attribute that holds the relative
525
+ * distinguished name of each entry. Defaults to "uid".
526
+ */
527
+ rdn?: string;
528
+ /**
529
+ * The name of the attribute that shall be used for the value of
530
+ * the metadata.name field of the entity. Defaults to "uid".
531
+ */
532
+ name?: string;
533
+ /**
534
+ * The name of the attribute that shall be used for the value of
535
+ * the metadata.description field of the entity.
536
+ */
537
+ description?: string;
538
+ /**
539
+ * The name of the attribute that shall be used for the value of
540
+ * the spec.profile.displayName field of the entity. Defaults to
541
+ * "cn".
542
+ */
543
+ displayName?: string;
544
+ /**
545
+ * The name of the attribute that shall be used for the value of
546
+ * the spec.profile.email field of the entity. Defaults to
547
+ * "mail".
548
+ */
549
+ email?: string;
550
+ /**
551
+ * The name of the attribute that shall be used for the value of
552
+ * the spec.profile.picture field of the entity.
553
+ */
554
+ picture?: string;
555
+ /**
556
+ * The name of the attribute that shall be used for the values of
557
+ * the spec.memberOf field of the entity. Defaults to "memberOf".
558
+ */
559
+ memberOf?: string;
560
+ };
561
+ }
562
+ | Array<{
563
+ /**
564
+ * The DN under which users are stored.
565
+ *
566
+ * E.g. "ou=people,ou=example,dc=example,dc=net"
567
+ */
568
+ dn: string;
569
+ /**
570
+ * The search options to use. The default is scope "one" and
571
+ * attributes "*" and "+".
572
+ *
573
+ * It is common to want to specify a filter, to narrow down the set
574
+ * of matching items.
575
+ */
576
+ options: {
577
+ scope?: 'base' | 'one' | 'sub';
578
+ filter?: string;
579
+ attributes?: string | string[];
580
+ sizeLimit?: number;
581
+ timeLimit?: number;
582
+ derefAliases?: number;
583
+ typesOnly?: boolean;
584
+ paged?:
585
+ | boolean
586
+ | {
587
+ pageSize?: number;
588
+ pagePause?: boolean;
589
+ };
590
+ };
591
+ /**
592
+ * JSON paths (on a.b.c form) and hard coded values to set on those
593
+ * paths.
594
+ *
595
+ * This can be useful for example if you want to hard code a
596
+ * namespace or similar on the generated entities.
597
+ */
598
+ set?: { [key: string]: JsonValue };
599
+ /**
600
+ * Mappings from well known entity fields, to LDAP attribute names
601
+ */
602
+ map?: {
603
+ /**
604
+ * The name of the attribute that holds the relative
605
+ * distinguished name of each entry. Defaults to "uid".
606
+ */
607
+ rdn?: string;
608
+ /**
609
+ * The name of the attribute that shall be used for the value of
610
+ * the metadata.name field of the entity. Defaults to "uid".
611
+ */
612
+ name?: string;
613
+ /**
614
+ * The name of the attribute that shall be used for the value of
615
+ * the metadata.description field of the entity.
616
+ */
617
+ description?: string;
618
+ /**
619
+ * The name of the attribute that shall be used for the value of
620
+ * the spec.profile.displayName field of the entity. Defaults to
621
+ * "cn".
622
+ */
623
+ displayName?: string;
624
+ /**
625
+ * The name of the attribute that shall be used for the value of
626
+ * the spec.profile.email field of the entity. Defaults to
627
+ * "mail".
628
+ */
629
+ email?: string;
630
+ /**
631
+ * The name of the attribute that shall be used for the value of
632
+ * the spec.profile.picture field of the entity.
633
+ */
634
+ picture?: string;
635
+ /**
636
+ * The name of the attribute that shall be used for the values of
637
+ * the spec.memberOf field of the entity. Defaults to "memberOf".
638
+ */
639
+ memberOf?: string;
640
+ };
641
+ }>;
561
642
 
562
643
  /**
563
644
  * The settings that govern the reading and interpretation of groups.
564
645
  */
565
- groups: {
566
- /**
567
- * The DN under which groups are stored.
568
- *
569
- * E.g. "ou=people,ou=example,dc=example,dc=net"
570
- */
571
- dn: string;
572
- /**
573
- * The search options to use. The default is scope "one" and
574
- * attributes "*" and "+".
575
- *
576
- * It is common to want to specify a filter, to narrow down the set
577
- * of matching items.
578
- */
579
- options: {
580
- scope?: 'base' | 'one' | 'sub';
581
- filter?: string;
582
- attributes?: string | string[];
583
- sizeLimit?: number;
584
- timeLimit?: number;
585
- derefAliases?: number;
586
- typesOnly?: boolean;
587
- paged?:
588
- | boolean
589
- | {
590
- pageSize?: number;
591
- pagePause?: boolean;
592
- };
593
- };
594
- /**
595
- * JSON paths (on a.b.c form) and hard coded values to set on those
596
- * paths.
597
- *
598
- * This can be useful for example if you want to hard code a
599
- * namespace or similar on the generated entities.
600
- */
601
- set?: { [key: string]: JsonValue };
602
- /**
603
- * Mappings from well known entity fields, to LDAP attribute names
604
- */
605
- map?: {
606
- /**
607
- * The name of the attribute that holds the relative
608
- * distinguished name of each entry. Defaults to "cn".
609
- */
610
- rdn?: string;
611
- /**
612
- * The name of the attribute that shall be used for the value of
613
- * the metadata.name field of the entity. Defaults to "cn".
614
- */
615
- name?: string;
616
- /**
617
- * The name of the attribute that shall be used for the value of
618
- * the metadata.description field of the entity. Defaults to
619
- * "description".
620
- */
621
- description?: string;
622
- /**
623
- * The name of the attribute that shall be used for the value of
624
- * the spec.type field of the entity. Defaults to "groupType".
625
- */
626
- type?: string;
627
- /**
628
- * The name of the attribute that shall be used for the value of
629
- * the spec.profile.displayName field of the entity. Defaults to
630
- * "cn".
631
- */
632
- displayName?: string;
633
- /**
634
- * The name of the attribute that shall be used for the value of
635
- * the spec.profile.email field of the entity.
636
- */
637
- email?: string;
638
- /**
639
- * The name of the attribute that shall be used for the value of
640
- * the spec.profile.picture field of the entity.
641
- */
642
- picture?: string;
643
- /**
644
- * The name of the attribute that shall be used for the values of
645
- * the spec.parent field of the entity. Defaults to "memberOf".
646
- */
647
- memberOf?: string;
648
- /**
649
- * The name of the attribute that shall be used for the values of
650
- * the spec.children field of the entity. Defaults to "member".
651
- */
652
- members?: string;
653
- };
654
- };
646
+ groups?:
647
+ | {
648
+ /**
649
+ * The DN under which groups are stored.
650
+ *
651
+ * E.g. "ou=people,ou=example,dc=example,dc=net"
652
+ */
653
+ dn: string;
654
+ /**
655
+ * The search options to use. The default is scope "one" and
656
+ * attributes "*" and "+".
657
+ *
658
+ * It is common to want to specify a filter, to narrow down the set
659
+ * of matching items.
660
+ */
661
+ options: {
662
+ scope?: 'base' | 'one' | 'sub';
663
+ filter?: string;
664
+ attributes?: string | string[];
665
+ sizeLimit?: number;
666
+ timeLimit?: number;
667
+ derefAliases?: number;
668
+ typesOnly?: boolean;
669
+ paged?:
670
+ | boolean
671
+ | {
672
+ pageSize?: number;
673
+ pagePause?: boolean;
674
+ };
675
+ };
676
+ /**
677
+ * JSON paths (on a.b.c form) and hard coded values to set on those
678
+ * paths.
679
+ *
680
+ * This can be useful for example if you want to hard code a
681
+ * namespace or similar on the generated entities.
682
+ */
683
+ set?: { [key: string]: JsonValue };
684
+ /**
685
+ * Mappings from well known entity fields, to LDAP attribute names
686
+ */
687
+ map?: {
688
+ /**
689
+ * The name of the attribute that holds the relative
690
+ * distinguished name of each entry. Defaults to "cn".
691
+ */
692
+ rdn?: string;
693
+ /**
694
+ * The name of the attribute that shall be used for the value of
695
+ * the metadata.name field of the entity. Defaults to "cn".
696
+ */
697
+ name?: string;
698
+ /**
699
+ * The name of the attribute that shall be used for the value of
700
+ * the metadata.description field of the entity. Defaults to
701
+ * "description".
702
+ */
703
+ description?: string;
704
+ /**
705
+ * The name of the attribute that shall be used for the value of
706
+ * the spec.type field of the entity. Defaults to "groupType".
707
+ */
708
+ type?: string;
709
+ /**
710
+ * The name of the attribute that shall be used for the value of
711
+ * the spec.profile.displayName field of the entity. Defaults to
712
+ * "cn".
713
+ */
714
+ displayName?: string;
715
+ /**
716
+ * The name of the attribute that shall be used for the value of
717
+ * the spec.profile.email field of the entity.
718
+ */
719
+ email?: string;
720
+ /**
721
+ * The name of the attribute that shall be used for the value of
722
+ * the spec.profile.picture field of the entity.
723
+ */
724
+ picture?: string;
725
+ /**
726
+ * The name of the attribute that shall be used for the values of
727
+ * the spec.parent field of the entity. Defaults to "memberOf".
728
+ */
729
+ memberOf?: string;
730
+ /**
731
+ * The name of the attribute that shall be used for the values of
732
+ * the spec.children field of the entity. Defaults to "member".
733
+ */
734
+ members?: string;
735
+ };
736
+ }
737
+ | Array<{
738
+ /**
739
+ * The DN under which groups are stored.
740
+ *
741
+ * E.g. "ou=people,ou=example,dc=example,dc=net"
742
+ */
743
+ dn: string;
744
+ /**
745
+ * The search options to use. The default is scope "one" and
746
+ * attributes "*" and "+".
747
+ *
748
+ * It is common to want to specify a filter, to narrow down the set
749
+ * of matching items.
750
+ */
751
+ options: {
752
+ scope?: 'base' | 'one' | 'sub';
753
+ filter?: string;
754
+ attributes?: string | string[];
755
+ sizeLimit?: number;
756
+ timeLimit?: number;
757
+ derefAliases?: number;
758
+ typesOnly?: boolean;
759
+ paged?:
760
+ | boolean
761
+ | {
762
+ pageSize?: number;
763
+ pagePause?: boolean;
764
+ };
765
+ };
766
+ /**
767
+ * JSON paths (on a.b.c form) and hard coded values to set on those
768
+ * paths.
769
+ *
770
+ * This can be useful for example if you want to hard code a
771
+ * namespace or similar on the generated entities.
772
+ */
773
+ set?: { [key: string]: JsonValue };
774
+ /**
775
+ * Mappings from well known entity fields, to LDAP attribute names
776
+ */
777
+ map?: {
778
+ /**
779
+ * The name of the attribute that holds the relative
780
+ * distinguished name of each entry. Defaults to "cn".
781
+ */
782
+ rdn?: string;
783
+ /**
784
+ * The name of the attribute that shall be used for the value of
785
+ * the metadata.name field of the entity. Defaults to "cn".
786
+ */
787
+ name?: string;
788
+ /**
789
+ * The name of the attribute that shall be used for the value of
790
+ * the metadata.description field of the entity. Defaults to
791
+ * "description".
792
+ */
793
+ description?: string;
794
+ /**
795
+ * The name of the attribute that shall be used for the value of
796
+ * the spec.type field of the entity. Defaults to "groupType".
797
+ */
798
+ type?: string;
799
+ /**
800
+ * The name of the attribute that shall be used for the value of
801
+ * the spec.profile.displayName field of the entity. Defaults to
802
+ * "cn".
803
+ */
804
+ displayName?: string;
805
+ /**
806
+ * The name of the attribute that shall be used for the value of
807
+ * the spec.profile.email field of the entity.
808
+ */
809
+ email?: string;
810
+ /**
811
+ * The name of the attribute that shall be used for the value of
812
+ * the spec.profile.picture field of the entity.
813
+ */
814
+ picture?: string;
815
+ /**
816
+ * The name of the attribute that shall be used for the values of
817
+ * the spec.parent field of the entity. Defaults to "memberOf".
818
+ */
819
+ memberOf?: string;
820
+ /**
821
+ * The name of the attribute that shall be used for the values of
822
+ * the spec.children field of the entity. Defaults to "member".
823
+ */
824
+ members?: string;
825
+ };
826
+ }>;
827
+
655
828
  /**
656
829
  * Configuration for overriding the vendor-specific default attribute names.
657
830
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-catalog-backend-module-ldap",
3
- "version": "0.11.3-next.1",
3
+ "version": "0.11.3",
4
4
  "description": "A Backstage catalog backend module that helps integrate towards LDAP",
5
5
  "backstage": {
6
6
  "role": "backend-plugin-module",
@@ -41,28 +41,21 @@
41
41
  "test": "backstage-cli package test"
42
42
  },
43
43
  "dependencies": {
44
- "@backstage/backend-plugin-api": "1.2.1-next.1",
45
- "@backstage/catalog-model": "1.7.3",
46
- "@backstage/config": "1.3.2",
47
- "@backstage/errors": "1.2.7",
48
- "@backstage/plugin-catalog-common": "1.1.3",
49
- "@backstage/plugin-catalog-node": "1.16.1-next.1",
50
- "@backstage/types": "1.2.1",
44
+ "@backstage/backend-plugin-api": "^1.2.1",
45
+ "@backstage/catalog-model": "^1.7.3",
46
+ "@backstage/config": "^1.3.2",
47
+ "@backstage/errors": "^1.2.7",
48
+ "@backstage/plugin-catalog-common": "^1.1.3",
49
+ "@backstage/plugin-catalog-node": "^1.16.1",
50
+ "@backstage/types": "^1.2.1",
51
51
  "@types/ldapjs": "^2.2.5",
52
52
  "ldapjs": "^2.3.3",
53
53
  "lodash": "^4.17.21",
54
54
  "uuid": "^11.0.0"
55
55
  },
56
56
  "devDependencies": {
57
- "@backstage/cli": "0.30.1-next.0",
57
+ "@backstage/cli": "^0.31.0",
58
58
  "@types/lodash": "^4.14.151"
59
59
  },
60
- "configSchema": "config.d.ts",
61
- "typesVersions": {
62
- "*": {
63
- "index": [
64
- "dist/index.d.ts"
65
- ]
66
- }
67
- }
60
+ "configSchema": "config.d.ts"
68
61
  }