@openhi/constructs 0.0.9 → 0.0.10

package/lib/index.d.mts

@@ -217,6 +217,9 @@ declare class OpenHiApp extends App {
     get secondaryEnvironments(): Array<OpenHiEnvironment>;
 }
 
+/**
+ * @see sites/www-docs/content/packages/@openhi/constructs/app/open-hi-service.md
+ */
 /**
  * Known OpenHI service type strings. Each service class defines its own
  * static SERVICE_TYPE (e.g. OpenHiAuthService.SERVICE_TYPE === "auth").
@@ -333,6 +336,9 @@ declare abstract class OpenHiService extends Stack {
     get childZonePrefix(): string;
 }
 
+/**
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/acm/root-wildcard-certificate.md
+ */
 declare class RootWildcardCertificate extends Certificate {
     /**
      * Used when storing the Certificate ARN in SSM.
@@ -346,6 +352,9 @@ declare class RootWildcardCertificate extends Certificate {
     constructor(scope: Construct, props: CertificateProps);
 }
 
+/**
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/api-gateway/root-http-api.md
+ */
 declare class RootHttpApi extends HttpApi {
     /**
      * Used when storing the API ID in SSM.
@@ -354,6 +363,9 @@ declare class RootHttpApi extends HttpApi {
     constructor(scope: Construct, props?: HttpApiProps);
 }
 
+/**
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/app-sync/root-graphql-api.md
+ */
 interface RootGraphqlApiProps extends GraphqlApiProps {
 }
 declare class RootGraphqlApi extends GraphqlApi {
@@ -365,6 +377,9 @@ declare class RootGraphqlApi extends GraphqlApi {
     constructor(scope: Construct, props?: Omit<RootGraphqlApiProps, "name">);
 }
 
+/**
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/cognito/cognito-user-pool.md
+ */
 declare class CognitoUserPool extends UserPool {
     /**
      * Used when storing the User Pool ID in SSM.
@@ -373,6 +388,9 @@ declare class CognitoUserPool extends UserPool {
     constructor(scope: Construct, props?: UserPoolProps);
 }
 
+/**
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/cognito/cognito-user-pool-client.md
+ */
 declare class CognitoUserPoolClient extends UserPoolClient {
     /**
      * Used when storing the User Pool Client ID in SSM.
@@ -381,6 +399,9 @@ declare class CognitoUserPoolClient extends UserPoolClient {
     constructor(scope: Construct, props: UserPoolClientProps);
 }
 
+/**
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/cognito/cognito-user-pool-domain.md
+ */
 declare class CognitoUserPoolDomain extends UserPoolDomain {
     /**
      * Used when storing the User Pool Domain in SSM.
@@ -389,6 +410,9 @@ declare class CognitoUserPoolDomain extends UserPoolDomain {
     constructor(scope: Construct, props: UserPoolDomainProps);
 }
 
+/**
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/cognito/cognito-user-pool-kms-key.md
+ */
 declare class CognitoUserPoolKmsKey extends Key {
     /**
      * Used when storing the KMS Key in SSM.
@@ -405,6 +429,9 @@ declare class PreTokenGenerationLambda extends Construct {
     constructor(scope: Construct);
 }
 
+/**
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/dynamodb/dynamo-db-data-store.md
+ */
 /**
  * DynamoDB table name for the data store. Used for cross-stack reference and
  * deterministic naming per branch. The table backs multiple use cases (e.g.
@@ -431,6 +458,9 @@ declare class DynamoDbDataStore extends Table {
     constructor(scope: Construct, id: string, props?: DynamoDbDataStoreProps);
 }
 
+/**
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/event-bridge/data-event-bus.md
+ */
 declare class DataEventBus extends EventBus {
     /*****************************************************************************
      *
@@ -443,6 +473,9 @@ declare class DataEventBus extends EventBus {
     constructor(scope: Construct, props?: EventBusProps);
 }
 
+/**
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/event-bridge/ops-event-bus.md
+ */
 declare class OpsEventBus extends EventBus {
     /*****************************************************************************
      *
@@ -455,6 +488,9 @@ declare class OpsEventBus extends EventBus {
     constructor(scope: Construct, props?: EventBusProps);
 }
 
+/**
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/route-53/child-hosted-zone.md
+ */
 interface ChildHostedZoneProps extends HostedZoneProps {
     /**
      * The root zone we will attach this sub-zone to.
@@ -469,6 +505,9 @@ declare class ChildHostedZone extends HostedZone {
     constructor(scope: Construct, id: string, props: ChildHostedZoneProps);
 }
 
+/**
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/route-53/root-hosted-zone.md
+ */
 /**
  * Placeholder for root hosted zone. Use {@link OpenHiGlobalService.rootHostedZoneFromConstruct}
  * to obtain an IHostedZone from attributes (e.g. from config). The root zone is always
@@ -477,6 +516,9 @@ declare class ChildHostedZone extends HostedZone {
 declare class RootHostedZone extends Construct {
 }
 
+/**
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/ssm/discoverable-string-parameter.md
+ */
 /*******************************************************************************
  *
  * DiscoverableStringParameterProps: props for creating or looking up SSM
@@ -541,6 +583,9 @@ declare class DiscoverableStringParameter extends StringParameter {
     constructor(scope: Construct, id: string, props: DiscoverableStringParameterProps);
 }
 
+/**
+ * @see sites/www-docs/content/packages/@openhi/constructs/services/open-hi-auth-service.md
+ */
 interface OpenHiAuthServiceProps extends OpenHiServiceProps {
     /**
      * Optional props for the Cognito User Pool.
@@ -624,6 +669,9 @@ declare class OpenHiAuthService extends OpenHiService {
     protected createUserPoolDomain(): IUserPoolDomain;
 }
 
+/**
+ * @see sites/www-docs/content/packages/@openhi/constructs/services/open-hi-global-service.md
+ */
 interface OpenHiGlobalServiceProps extends OpenHiServiceProps {
 }
 /**
@@ -677,6 +725,9 @@ declare class OpenHiGlobalService extends OpenHiService {
     protected createRootWildcardCertificate(): ICertificate;
 }
 
+/**
+ * @see sites/www-docs/content/packages/@openhi/constructs/services/open-hi-rest-api-service.md
+ */
 interface OpenHiRestApiServiceProps extends OpenHiServiceProps {
 }
 /**
@@ -745,6 +796,9 @@ declare class OpenHiRestApiService extends OpenHiService {
     protected createRootHttpApi(domainName: DomainName): RootHttpApi;
 }
 
+/**
+ * @see sites/www-docs/content/packages/@openhi/constructs/services/open-hi-data-service.md
+ */
 interface OpenHiDataServiceProps extends OpenHiServiceProps {
 }
 /**

package/lib/index.d.ts

@@ -297,6 +297,9 @@ declare class OpenHiApp extends App {
     get secondaryEnvironments(): Array<OpenHiEnvironment>;
 }
 
+/**
+ * @see sites/www-docs/content/packages/@openhi/constructs/app/open-hi-service.md
+ */
 /**
  * Known OpenHI service type strings. Each service class defines its own
  * static SERVICE_TYPE (e.g. OpenHiAuthService.SERVICE_TYPE === "auth").
@@ -413,6 +416,9 @@ declare abstract class OpenHiService extends Stack {
     get childZonePrefix(): string;
 }
 
+/**
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/acm/root-wildcard-certificate.md
+ */
 declare class RootWildcardCertificate extends Certificate {
     /**
      * Used when storing the Certificate ARN in SSM.
@@ -426,6 +432,9 @@ declare class RootWildcardCertificate extends Certificate {
     constructor(scope: Construct, props: CertificateProps);
 }
 
+/**
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/api-gateway/root-http-api.md
+ */
 declare class RootHttpApi extends HttpApi {
     /**
      * Used when storing the API ID in SSM.
@@ -434,6 +443,9 @@ declare class RootHttpApi extends HttpApi {
     constructor(scope: Construct, props?: HttpApiProps);
 }
 
+/**
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/app-sync/root-graphql-api.md
+ */
 interface RootGraphqlApiProps extends GraphqlApiProps {
 }
 declare class RootGraphqlApi extends GraphqlApi {
@@ -445,6 +457,9 @@ declare class RootGraphqlApi extends GraphqlApi {
     constructor(scope: Construct, props?: Omit<RootGraphqlApiProps, "name">);
 }
 
+/**
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/cognito/cognito-user-pool.md
+ */
 declare class CognitoUserPool extends UserPool {
     /**
      * Used when storing the User Pool ID in SSM.
@@ -453,6 +468,9 @@ declare class CognitoUserPool extends UserPool {
     constructor(scope: Construct, props?: UserPoolProps);
 }
 
+/**
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/cognito/cognito-user-pool-client.md
+ */
 declare class CognitoUserPoolClient extends UserPoolClient {
     /**
      * Used when storing the User Pool Client ID in SSM.
@@ -461,6 +479,9 @@ declare class CognitoUserPoolClient extends UserPoolClient {
     constructor(scope: Construct, props: UserPoolClientProps);
 }
 
+/**
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/cognito/cognito-user-pool-domain.md
+ */
 declare class CognitoUserPoolDomain extends UserPoolDomain {
     /**
      * Used when storing the User Pool Domain in SSM.
@@ -469,6 +490,9 @@ declare class CognitoUserPoolDomain extends UserPoolDomain {
     constructor(scope: Construct, props: UserPoolDomainProps);
 }
 
+/**
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/cognito/cognito-user-pool-kms-key.md
+ */
 declare class CognitoUserPoolKmsKey extends Key {
     /**
      * Used when storing the KMS Key in SSM.
@@ -485,6 +509,9 @@ declare class PreTokenGenerationLambda extends Construct {
     constructor(scope: Construct);
 }
 
+/**
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/dynamodb/dynamo-db-data-store.md
+ */
 /**
  * DynamoDB table name for the data store. Used for cross-stack reference and
  * deterministic naming per branch. The table backs multiple use cases (e.g.
@@ -511,6 +538,9 @@ declare class DynamoDbDataStore extends Table {
     constructor(scope: Construct, id: string, props?: DynamoDbDataStoreProps);
 }
 
+/**
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/event-bridge/data-event-bus.md
+ */
 declare class DataEventBus extends EventBus {
     /*****************************************************************************
      *
@@ -523,6 +553,9 @@ declare class DataEventBus extends EventBus {
     constructor(scope: Construct, props?: EventBusProps);
 }
 
+/**
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/event-bridge/ops-event-bus.md
+ */
 declare class OpsEventBus extends EventBus {
     /*****************************************************************************
      *
@@ -535,6 +568,9 @@ declare class OpsEventBus extends EventBus {
     constructor(scope: Construct, props?: EventBusProps);
 }
 
+/**
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/route-53/child-hosted-zone.md
+ */
 interface ChildHostedZoneProps extends HostedZoneProps {
     /**
      * The root zone we will attach this sub-zone to.
@@ -549,6 +585,9 @@ declare class ChildHostedZone extends HostedZone {
     constructor(scope: Construct, id: string, props: ChildHostedZoneProps);
 }
 
+/**
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/route-53/root-hosted-zone.md
+ */
 /**
  * Placeholder for root hosted zone. Use {@link OpenHiGlobalService.rootHostedZoneFromConstruct}
  * to obtain an IHostedZone from attributes (e.g. from config). The root zone is always
@@ -557,6 +596,9 @@ declare class ChildHostedZone extends HostedZone {
 declare class RootHostedZone extends Construct {
 }
 
+/**
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/ssm/discoverable-string-parameter.md
+ */
 /*******************************************************************************
  *
  * DiscoverableStringParameterProps: props for creating or looking up SSM
@@ -621,6 +663,9 @@ declare class DiscoverableStringParameter extends StringParameter {
     constructor(scope: Construct, id: string, props: DiscoverableStringParameterProps);
 }
 
+/**
+ * @see sites/www-docs/content/packages/@openhi/constructs/services/open-hi-auth-service.md
+ */
 interface OpenHiAuthServiceProps extends OpenHiServiceProps {
     /**
      * Optional props for the Cognito User Pool.
@@ -704,6 +749,9 @@ declare class OpenHiAuthService extends OpenHiService {
     protected createUserPoolDomain(): IUserPoolDomain;
 }
 
+/**
+ * @see sites/www-docs/content/packages/@openhi/constructs/services/open-hi-global-service.md
+ */
 interface OpenHiGlobalServiceProps extends OpenHiServiceProps {
 }
 /**
@@ -757,6 +805,9 @@ declare class OpenHiGlobalService extends OpenHiService {
     protected createRootWildcardCertificate(): ICertificate;
 }
 
+/**
+ * @see sites/www-docs/content/packages/@openhi/constructs/services/open-hi-rest-api-service.md
+ */
 interface OpenHiRestApiServiceProps extends OpenHiServiceProps {
 }
 /**
@@ -825,6 +876,9 @@ declare class OpenHiRestApiService extends OpenHiService {
     protected createRootHttpApi(domainName: DomainName): RootHttpApi;
 }
 
+/**
+ * @see sites/www-docs/content/packages/@openhi/constructs/services/open-hi-data-service.md
+ */
 interface OpenHiDataServiceProps extends OpenHiServiceProps {
 }
 /**