@openhi/constructs 0.0.8 → 0.0.10

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/lib/index.d.mts CHANGED
@@ -217,6 +217,9 @@ declare class OpenHiApp extends App {
217
217
  get secondaryEnvironments(): Array<OpenHiEnvironment>;
218
218
  }
219
219
 
220
+ /**
221
+ * @see sites/www-docs/content/packages/@openhi/constructs/app/open-hi-service.md
222
+ */
220
223
  /**
221
224
  * Known OpenHI service type strings. Each service class defines its own
222
225
  * static SERVICE_TYPE (e.g. OpenHiAuthService.SERVICE_TYPE === "auth").
@@ -333,6 +336,9 @@ declare abstract class OpenHiService extends Stack {
333
336
  get childZonePrefix(): string;
334
337
  }
335
338
 
339
+ /**
340
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/acm/root-wildcard-certificate.md
341
+ */
336
342
  declare class RootWildcardCertificate extends Certificate {
337
343
  /**
338
344
  * Used when storing the Certificate ARN in SSM.
@@ -346,6 +352,9 @@ declare class RootWildcardCertificate extends Certificate {
346
352
  constructor(scope: Construct, props: CertificateProps);
347
353
  }
348
354
 
355
+ /**
356
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/api-gateway/root-http-api.md
357
+ */
349
358
  declare class RootHttpApi extends HttpApi {
350
359
  /**
351
360
  * Used when storing the API ID in SSM.
@@ -354,6 +363,9 @@ declare class RootHttpApi extends HttpApi {
354
363
  constructor(scope: Construct, props?: HttpApiProps);
355
364
  }
356
365
 
366
+ /**
367
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/app-sync/root-graphql-api.md
368
+ */
357
369
  interface RootGraphqlApiProps extends GraphqlApiProps {
358
370
  }
359
371
  declare class RootGraphqlApi extends GraphqlApi {
@@ -365,6 +377,9 @@ declare class RootGraphqlApi extends GraphqlApi {
365
377
  constructor(scope: Construct, props?: Omit<RootGraphqlApiProps, "name">);
366
378
  }
367
379
 
380
+ /**
381
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/cognito/cognito-user-pool.md
382
+ */
368
383
  declare class CognitoUserPool extends UserPool {
369
384
  /**
370
385
  * Used when storing the User Pool ID in SSM.
@@ -373,6 +388,9 @@ declare class CognitoUserPool extends UserPool {
373
388
  constructor(scope: Construct, props?: UserPoolProps);
374
389
  }
375
390
 
391
+ /**
392
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/cognito/cognito-user-pool-client.md
393
+ */
376
394
  declare class CognitoUserPoolClient extends UserPoolClient {
377
395
  /**
378
396
  * Used when storing the User Pool Client ID in SSM.
@@ -381,6 +399,9 @@ declare class CognitoUserPoolClient extends UserPoolClient {
381
399
  constructor(scope: Construct, props: UserPoolClientProps);
382
400
  }
383
401
 
402
+ /**
403
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/cognito/cognito-user-pool-domain.md
404
+ */
384
405
  declare class CognitoUserPoolDomain extends UserPoolDomain {
385
406
  /**
386
407
  * Used when storing the User Pool Domain in SSM.
@@ -389,6 +410,9 @@ declare class CognitoUserPoolDomain extends UserPoolDomain {
389
410
  constructor(scope: Construct, props: UserPoolDomainProps);
390
411
  }
391
412
 
413
+ /**
414
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/cognito/cognito-user-pool-kms-key.md
415
+ */
392
416
  declare class CognitoUserPoolKmsKey extends Key {
393
417
  /**
394
418
  * Used when storing the KMS Key in SSM.
@@ -405,6 +429,9 @@ declare class PreTokenGenerationLambda extends Construct {
405
429
  constructor(scope: Construct);
406
430
  }
407
431
 
432
+ /**
433
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/dynamodb/dynamo-db-data-store.md
434
+ */
408
435
  /**
409
436
  * DynamoDB table name for the data store. Used for cross-stack reference and
410
437
  * deterministic naming per branch. The table backs multiple use cases (e.g.
@@ -431,6 +458,9 @@ declare class DynamoDbDataStore extends Table {
431
458
  constructor(scope: Construct, id: string, props?: DynamoDbDataStoreProps);
432
459
  }
433
460
 
461
+ /**
462
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/event-bridge/data-event-bus.md
463
+ */
434
464
  declare class DataEventBus extends EventBus {
435
465
  /*****************************************************************************
436
466
  *
@@ -443,6 +473,9 @@ declare class DataEventBus extends EventBus {
443
473
  constructor(scope: Construct, props?: EventBusProps);
444
474
  }
445
475
 
476
+ /**
477
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/event-bridge/ops-event-bus.md
478
+ */
446
479
  declare class OpsEventBus extends EventBus {
447
480
  /*****************************************************************************
448
481
  *
@@ -455,6 +488,9 @@ declare class OpsEventBus extends EventBus {
455
488
  constructor(scope: Construct, props?: EventBusProps);
456
489
  }
457
490
 
491
+ /**
492
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/route-53/child-hosted-zone.md
493
+ */
458
494
  interface ChildHostedZoneProps extends HostedZoneProps {
459
495
  /**
460
496
  * The root zone we will attach this sub-zone to.
@@ -469,6 +505,9 @@ declare class ChildHostedZone extends HostedZone {
469
505
  constructor(scope: Construct, id: string, props: ChildHostedZoneProps);
470
506
  }
471
507
 
508
+ /**
509
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/route-53/root-hosted-zone.md
510
+ */
472
511
  /**
473
512
  * Placeholder for root hosted zone. Use {@link OpenHiGlobalService.rootHostedZoneFromConstruct}
474
513
  * to obtain an IHostedZone from attributes (e.g. from config). The root zone is always
@@ -477,6 +516,9 @@ declare class ChildHostedZone extends HostedZone {
477
516
  declare class RootHostedZone extends Construct {
478
517
  }
479
518
 
519
+ /**
520
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/ssm/discoverable-string-parameter.md
521
+ */
480
522
  /*******************************************************************************
481
523
  *
482
524
  * DiscoverableStringParameterProps: props for creating or looking up SSM
@@ -541,6 +583,9 @@ declare class DiscoverableStringParameter extends StringParameter {
541
583
  constructor(scope: Construct, id: string, props: DiscoverableStringParameterProps);
542
584
  }
543
585
 
586
+ /**
587
+ * @see sites/www-docs/content/packages/@openhi/constructs/services/open-hi-auth-service.md
588
+ */
544
589
  interface OpenHiAuthServiceProps extends OpenHiServiceProps {
545
590
  /**
546
591
  * Optional props for the Cognito User Pool.
@@ -624,6 +669,9 @@ declare class OpenHiAuthService extends OpenHiService {
624
669
  protected createUserPoolDomain(): IUserPoolDomain;
625
670
  }
626
671
 
672
+ /**
673
+ * @see sites/www-docs/content/packages/@openhi/constructs/services/open-hi-global-service.md
674
+ */
627
675
  interface OpenHiGlobalServiceProps extends OpenHiServiceProps {
628
676
  }
629
677
  /**
@@ -677,6 +725,9 @@ declare class OpenHiGlobalService extends OpenHiService {
677
725
  protected createRootWildcardCertificate(): ICertificate;
678
726
  }
679
727
 
728
+ /**
729
+ * @see sites/www-docs/content/packages/@openhi/constructs/services/open-hi-rest-api-service.md
730
+ */
680
731
  interface OpenHiRestApiServiceProps extends OpenHiServiceProps {
681
732
  }
682
733
  /**
@@ -745,6 +796,9 @@ declare class OpenHiRestApiService extends OpenHiService {
745
796
  protected createRootHttpApi(domainName: DomainName): RootHttpApi;
746
797
  }
747
798
 
799
+ /**
800
+ * @see sites/www-docs/content/packages/@openhi/constructs/services/open-hi-data-service.md
801
+ */
748
802
  interface OpenHiDataServiceProps extends OpenHiServiceProps {
749
803
  }
750
804
  /**
package/lib/index.d.ts CHANGED
@@ -297,6 +297,9 @@ declare class OpenHiApp extends App {
297
297
  get secondaryEnvironments(): Array<OpenHiEnvironment>;
298
298
  }
299
299
 
300
+ /**
301
+ * @see sites/www-docs/content/packages/@openhi/constructs/app/open-hi-service.md
302
+ */
300
303
  /**
301
304
  * Known OpenHI service type strings. Each service class defines its own
302
305
  * static SERVICE_TYPE (e.g. OpenHiAuthService.SERVICE_TYPE === "auth").
@@ -413,6 +416,9 @@ declare abstract class OpenHiService extends Stack {
413
416
  get childZonePrefix(): string;
414
417
  }
415
418
 
419
+ /**
420
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/acm/root-wildcard-certificate.md
421
+ */
416
422
  declare class RootWildcardCertificate extends Certificate {
417
423
  /**
418
424
  * Used when storing the Certificate ARN in SSM.
@@ -426,6 +432,9 @@ declare class RootWildcardCertificate extends Certificate {
426
432
  constructor(scope: Construct, props: CertificateProps);
427
433
  }
428
434
 
435
+ /**
436
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/api-gateway/root-http-api.md
437
+ */
429
438
  declare class RootHttpApi extends HttpApi {
430
439
  /**
431
440
  * Used when storing the API ID in SSM.
@@ -434,6 +443,9 @@ declare class RootHttpApi extends HttpApi {
434
443
  constructor(scope: Construct, props?: HttpApiProps);
435
444
  }
436
445
 
446
+ /**
447
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/app-sync/root-graphql-api.md
448
+ */
437
449
  interface RootGraphqlApiProps extends GraphqlApiProps {
438
450
  }
439
451
  declare class RootGraphqlApi extends GraphqlApi {
@@ -445,6 +457,9 @@ declare class RootGraphqlApi extends GraphqlApi {
445
457
  constructor(scope: Construct, props?: Omit<RootGraphqlApiProps, "name">);
446
458
  }
447
459
 
460
+ /**
461
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/cognito/cognito-user-pool.md
462
+ */
448
463
  declare class CognitoUserPool extends UserPool {
449
464
  /**
450
465
  * Used when storing the User Pool ID in SSM.
@@ -453,6 +468,9 @@ declare class CognitoUserPool extends UserPool {
453
468
  constructor(scope: Construct, props?: UserPoolProps);
454
469
  }
455
470
 
471
+ /**
472
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/cognito/cognito-user-pool-client.md
473
+ */
456
474
  declare class CognitoUserPoolClient extends UserPoolClient {
457
475
  /**
458
476
  * Used when storing the User Pool Client ID in SSM.
@@ -461,6 +479,9 @@ declare class CognitoUserPoolClient extends UserPoolClient {
461
479
  constructor(scope: Construct, props: UserPoolClientProps);
462
480
  }
463
481
 
482
+ /**
483
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/cognito/cognito-user-pool-domain.md
484
+ */
464
485
  declare class CognitoUserPoolDomain extends UserPoolDomain {
465
486
  /**
466
487
  * Used when storing the User Pool Domain in SSM.
@@ -469,6 +490,9 @@ declare class CognitoUserPoolDomain extends UserPoolDomain {
469
490
  constructor(scope: Construct, props: UserPoolDomainProps);
470
491
  }
471
492
 
493
+ /**
494
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/cognito/cognito-user-pool-kms-key.md
495
+ */
472
496
  declare class CognitoUserPoolKmsKey extends Key {
473
497
  /**
474
498
  * Used when storing the KMS Key in SSM.
@@ -485,6 +509,9 @@ declare class PreTokenGenerationLambda extends Construct {
485
509
  constructor(scope: Construct);
486
510
  }
487
511
 
512
+ /**
513
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/dynamodb/dynamo-db-data-store.md
514
+ */
488
515
  /**
489
516
  * DynamoDB table name for the data store. Used for cross-stack reference and
490
517
  * deterministic naming per branch. The table backs multiple use cases (e.g.
@@ -511,6 +538,9 @@ declare class DynamoDbDataStore extends Table {
511
538
  constructor(scope: Construct, id: string, props?: DynamoDbDataStoreProps);
512
539
  }
513
540
 
541
+ /**
542
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/event-bridge/data-event-bus.md
543
+ */
514
544
  declare class DataEventBus extends EventBus {
515
545
  /*****************************************************************************
516
546
  *
@@ -523,6 +553,9 @@ declare class DataEventBus extends EventBus {
523
553
  constructor(scope: Construct, props?: EventBusProps);
524
554
  }
525
555
 
556
+ /**
557
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/event-bridge/ops-event-bus.md
558
+ */
526
559
  declare class OpsEventBus extends EventBus {
527
560
  /*****************************************************************************
528
561
  *
@@ -535,6 +568,9 @@ declare class OpsEventBus extends EventBus {
535
568
  constructor(scope: Construct, props?: EventBusProps);
536
569
  }
537
570
 
571
+ /**
572
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/route-53/child-hosted-zone.md
573
+ */
538
574
  interface ChildHostedZoneProps extends HostedZoneProps {
539
575
  /**
540
576
  * The root zone we will attach this sub-zone to.
@@ -549,6 +585,9 @@ declare class ChildHostedZone extends HostedZone {
549
585
  constructor(scope: Construct, id: string, props: ChildHostedZoneProps);
550
586
  }
551
587
 
588
+ /**
589
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/route-53/root-hosted-zone.md
590
+ */
552
591
  /**
553
592
  * Placeholder for root hosted zone. Use {@link OpenHiGlobalService.rootHostedZoneFromConstruct}
554
593
  * to obtain an IHostedZone from attributes (e.g. from config). The root zone is always
@@ -557,6 +596,9 @@ declare class ChildHostedZone extends HostedZone {
557
596
  declare class RootHostedZone extends Construct {
558
597
  }
559
598
 
599
+ /**
600
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/ssm/discoverable-string-parameter.md
601
+ */
560
602
  /*******************************************************************************
561
603
  *
562
604
  * DiscoverableStringParameterProps: props for creating or looking up SSM
@@ -621,6 +663,9 @@ declare class DiscoverableStringParameter extends StringParameter {
621
663
  constructor(scope: Construct, id: string, props: DiscoverableStringParameterProps);
622
664
  }
623
665
 
666
+ /**
667
+ * @see sites/www-docs/content/packages/@openhi/constructs/services/open-hi-auth-service.md
668
+ */
624
669
  interface OpenHiAuthServiceProps extends OpenHiServiceProps {
625
670
  /**
626
671
  * Optional props for the Cognito User Pool.
@@ -704,6 +749,9 @@ declare class OpenHiAuthService extends OpenHiService {
704
749
  protected createUserPoolDomain(): IUserPoolDomain;
705
750
  }
706
751
 
752
+ /**
753
+ * @see sites/www-docs/content/packages/@openhi/constructs/services/open-hi-global-service.md
754
+ */
707
755
  interface OpenHiGlobalServiceProps extends OpenHiServiceProps {
708
756
  }
709
757
  /**
@@ -757,6 +805,9 @@ declare class OpenHiGlobalService extends OpenHiService {
757
805
  protected createRootWildcardCertificate(): ICertificate;
758
806
  }
759
807
 
808
+ /**
809
+ * @see sites/www-docs/content/packages/@openhi/constructs/services/open-hi-rest-api-service.md
810
+ */
760
811
  interface OpenHiRestApiServiceProps extends OpenHiServiceProps {
761
812
  }
762
813
  /**
@@ -825,6 +876,9 @@ declare class OpenHiRestApiService extends OpenHiService {
825
876
  protected createRootHttpApi(domainName: DomainName): RootHttpApi;
826
877
  }
827
878
 
879
+ /**
880
+ * @see sites/www-docs/content/packages/@openhi/constructs/services/open-hi-data-service.md
881
+ */
828
882
  interface OpenHiDataServiceProps extends OpenHiServiceProps {
829
883
  }
830
884
  /**
package/lib/index.js CHANGED
@@ -920,11 +920,13 @@ var _OpenHiAuthService = class _OpenHiAuthService extends OpenHiService {
920
920
  createUserPool() {
921
921
  const userPool = new CognitoUserPool(this, {
922
922
  ...this.props.userPoolProps,
923
- customSenderKmsKey: this.userPoolKmsKey,
924
- lambdaTriggers: {
925
- preTokenGeneration: this.preTokenGenerationLambda
926
- }
923
+ customSenderKmsKey: this.userPoolKmsKey
927
924
  });
925
+ userPool.addTrigger(
926
+ import_aws_cognito4.UserPoolOperation.PRE_TOKEN_GENERATION_CONFIG,
927
+ this.preTokenGenerationLambda,
928
+ import_aws_cognito4.LambdaVersion.V2_0
929
+ );
928
930
  new DiscoverableStringParameter(this, "user-pool-param", {
929
931
  ssmParamName: CognitoUserPool.SSM_PARAM_NAME,
930
932
  stringValue: userPool.userPoolId,