@openhi/constructs 0.0.115 → 0.0.116

package/lib/index.d.mts

@@ -20,7 +20,8 @@ import * as ec2 from 'aws-cdk-lib/aws-ec2';
 import * as rds from 'aws-cdk-lib/aws-rds';
 import { HostedZone, HostedZoneProps, IHostedZone, HostedZoneAttributes } from 'aws-cdk-lib/aws-route53';
 import { StringParameterProps, StringParameter } from 'aws-cdk-lib/aws-ssm';
-import { Distribution, DistributionProps } from 'aws-cdk-lib/aws-cloudfront';
+import { Distribution, DistributionProps, CachePolicyProps } from 'aws-cdk-lib/aws-cloudfront';
+import { HostingMode } from './static-hosting.viewer-request-handler.mjs';
 export { C as CascadeChunkInput, a as CascadeFinalizeInput, b as CascadeFinalizeOutput, c as CascadeListInput, d as CascadeListOutput, O as OWNING_DELETE_CASCADE_CONSUMER_NAME, e as OWNING_DELETE_CASCADE_DEFAULT_CONCURRENCY, f as OWNING_DELETE_CASCADE_STUCK_THRESHOLD_MINUTES, g as OWNING_DELETE_OPS_EVENT_BUS_ENV_VAR } from './events-CjS-sm0W.mjs';
 import { StateMachine } from 'aws-cdk-lib/aws-stepfunctions';
 export { B as BRIDGED_STATUSES, a as BridgedStatus, C as CLOUDFORMATION_EVENT_SOURCE, b as CLOUDFORMATION_STACK_STATUS_CHANGE_DETAIL_TYPE, c as CONTROL_EVENT_BUS_NAME_ENV_VAR, d as CloudFormationStackStatusChangeDetail, O as OPENHI_REPO_TAG_KEY_ENV_VAR, e as OPENHI_TAG_KEY_PREFIX_ENV_VAR, P as PLATFORM_DEPLOY_BRIDGE_ACTOR_SYSTEM } from './events-BfrkMoBD.mjs';
@@ -245,7 +246,7 @@ declare class OpenHiApp extends App {
  *
  * @public
  */
-type OpenHiServiceType = "auth" | "rest-api" | "data" | "global" | "graphql-api";
+type OpenHiServiceType = "auth" | "rest-api" | "data" | "global" | "graphql-api" | "website";
 /**
  * Tag-key suffixes applied by every OpenHiService stack via Tags.of().
  * Full keys are composed `${appName}:${suffix}` — see {@link openHiTagKey}.
@@ -966,6 +967,79 @@ declare class DiscoverableStringParameter extends StringParameter {
     constructor(scope: Construct, id: string, props: DiscoverableStringParameterProps);
 }
 
+/**
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/static-hosting/static-content.md
+ */
+/*******************************************************************************
+ *
+ *  STATIC CONTENT UPLOADER
+ *
+ *  This construct uploads a directory of content from a local location into S3.
+ *
+ *  To support PR and branch specific builds, each S3 bucket can store content
+ *  for multiple domains and builds, using the following format:
+ *
+ *  S3-bucket/<sub-domain>.<full-domain>/*
+ *
+ *  A bucket used to store content for stage.openhi.org might have the
+ *  following directory structure (all in the same bucket):
+ *
+ *  /www.stage.openhi.org/* -> serves content to www.stage.openhi.org
+ *  /feature-7.stage.openhi.org/* -> serves content to feature-7.stage.openhi.org
+ *  /pr-123.stage.openhi.org/* -> serves content to pr-123.stage.openhi.org
+ *
+ ******************************************************************************/
+/**
+ * Props for the StaticContent construct.
+ */
+interface StaticContentProps {
+    /**
+     * Absolute path to directory containing content for the website.
+     */
+    readonly contentSourceDirectory: string;
+    /**
+     * Directory to place content into. Should start with a slash.
+     * Example: '/widget'
+     *
+     * @default "/"
+     */
+    readonly contentDestinationDirectory?: string;
+    /**
+     * The sub domain prefix (e.g. "feature-7"). Used as the per-branch folder
+     * name in the bucket so each branch deploys to its own prefix.
+     *
+     * @default the current stack's branch name (kebab-cased)
+     */
+    readonly subDomain?: string;
+    /**
+     * The full domain (e.g. "stage.openhi.org"). Used together with
+     * `subDomain` to form the destination prefix
+     * `<sub-domain>.<full-domain>`.
+     */
+    readonly fullDomain: string;
+    /**
+     * Service type used to look up the static-hosting bucket ARN via
+     * DiscoverableStringParameter.
+     *
+     * @default STATIC_HOSTING_SERVICE_TYPE ("website")
+     */
+    readonly serviceType?: string;
+}
+/**
+ * Static content uploader: deploys a local directory to the static-hosting
+ * S3 bucket under `<sub-domain>.<full-domain>/<dest>` so each branch
+ * deploys to its own prefix without clobbering siblings. The bucket ARN is
+ * looked up via DiscoverableStringParameter so the uploader can run on a
+ * feature-branch stack while the bucket itself was provisioned by the
+ * release-branch service stack.
+ */
+declare class StaticContent extends Construct {
+    constructor(scope: Construct, id: string, props: StaticContentProps);
+}
+
+/**
+ * @see sites/www-docs/content/packages/@openhi/constructs/components/static-hosting/static-hosting.md
+ */
 /**
  * Service type for the website service. Used in SSM parameter paths and by
  * OpenHiWebsiteService for fromConstruct() lookups.
@@ -980,21 +1054,61 @@ interface StaticHostingProps {
      */
     readonly bucketProps?: Omit<BucketProps, "bucketName">;
     /**
-     * Optional CloudFront distribution props. Do not enable invalidation.
-     * Default TTL is 10 seconds via a custom cache policy.
+     * Optional CloudFront distribution props. Defaults wire a custom cache
+     * policy (60s/300s with gzip+brotli), `REDIRECT_TO_HTTPS`, and
+     * `ALLOW_GET_HEAD_OPTIONS` on the default behavior; overrides apply on top.
      */
     readonly distributionProps?: Omit<DistributionProps, "defaultBehavior" | "defaultRootObject">;
+    /**
+     * Optional cache policy overrides. Defaults: `defaultTtl=60s`, `maxTtl=300s`,
+     * `minTtl=0s`, gzip+brotli enabled, no headers/cookies/query strings cached.
+     */
+    readonly cachePolicyProps?: Omit<CachePolicyProps, "cachePolicyName">;
+    /**
+     * Wildcard certificate to attach to the CloudFront distribution. When
+     * supplied together with `hostedZone` and `domainNames`, CloudFront serves
+     * the listed domains and Route53 ARecords are created in the zone.
+     *
+     * @default - no custom certificate; CloudFront default domain is served
+     */
+    readonly certificate?: ICertificate;
+    /**
+     * Hosted zone to create Route53 ARecords in. Required together with
+     * `certificate` and `domainNames` to attach a custom domain.
+     */
+    readonly hostedZone?: IHostedZone;
+    /**
+     * Domain names to attach to the CloudFront distribution. Each name also
+     * gets an ARecord in `hostedZone`.
+     */
+    readonly domainNames?: ReadonlyArray<string>;
+    /**
+     * Selects how path-like URIs are rewritten by the viewer-request
+     * Lambda@Edge handler.
+     *
+     * - `spa` (default): path-like URIs rewrite to `/index.html`.
+     * - `static`: path-like URIs append `/index.html`.
+     *
+     * @default "spa"
+     */
+    readonly hostingMode?: HostingMode;
     /**
      * Service type for SSM parameter paths.
+     *
      * @default STATIC_HOSTING_SERVICE_TYPE ("website")
      */
     readonly serviceType?: string;
+    /**
+     * Optional human-readable description used in distribution comment and
+     * SSM parameter descriptions.
+     */
+    readonly description?: string;
 }
 /**
  * Static hosting: S3 bucket (private) + CloudFront distribution with Origin
- * Access Control (OAC). Stores bucket ARN and distribution ARN in SSM via
- * DiscoverableStringParameter for cross-stack lookup. No cache invalidation;
- * default TTL 10 seconds.
+ * Access Control (OAC) + Lambda@Edge viewer-request handler. Publishes
+ * bucket ARN, distribution ARN, distribution domain, and distribution ID
+ * via DiscoverableStringParameter for cross-stack lookup.
  */
 declare class StaticHosting extends Construct {
     /**
@@ -1005,8 +1119,18 @@ declare class StaticHosting extends Construct {
      * SSM parameter name for the CloudFront distribution ARN.
      */
     static readonly SSM_PARAM_NAME_DISTRIBUTION_ARN = "STATIC_HOSTING_DISTRIBUTION_ARN";
+    /**
+     * SSM parameter name for the CloudFront distribution domain
+     * (e.g. dXXXXX.cloudfront.net).
+     */
+    static readonly SSM_PARAM_NAME_DISTRIBUTION_DOMAIN = "STATIC_HOSTING_DISTRIBUTION_DOMAIN";
+    /**
+     * SSM parameter name for the CloudFront distribution ID.
+     */
+    static readonly SSM_PARAM_NAME_DISTRIBUTION_ID = "STATIC_HOSTING_DISTRIBUTION_ID";
     readonly bucket: IBucket;
     readonly distribution: Distribution;
+    readonly viewerRequestHandler: NodejsFunction;
     constructor(scope: Construct, id: string, props?: StaticHostingProps);
 }
 
@@ -1783,6 +1907,141 @@ declare class OpenHiGraphqlService extends OpenHiService {
     protected createRootGraphqlApi(): RootGraphqlApi;
 }
 
+/**
+ * @see sites/www-docs/content/packages/@openhi/constructs/services/open-hi-website-service.md
+ */
+interface OpenHiWebsiteServiceProps extends OpenHiServiceProps {
+    /**
+     * Sub-domain prefix attached to the child zone (e.g. "www" -> "www.<zone>").
+     *
+     * @default "www"
+     */
+    readonly domainPrefix?: string;
+    /**
+     * Absolute path to the local directory whose contents should be uploaded
+     * to the static-hosting bucket. Required.
+     */
+    readonly contentSourceDirectory: string;
+    /**
+     * Path under the per-branch destination prefix to upload into. Should start
+     * with a slash.
+     *
+     * @default "/"
+     */
+    readonly contentDestinationDirectory?: string;
+    /**
+     * Force the `StaticHosting` infrastructure (bucket + distribution +
+     * Lambda@Edge + DNS + 4 SSM params) to be created on this branch even when
+     * it is not the release branch. Useful for one-off bootstraps and tests.
+     *
+     * When omitted, hosting infrastructure is created only on
+     * `defaultReleaseBranch`. The `StaticContent` uploader is always
+     * created so feature branches can publish their content under their own
+     * sub-domain folder against the release-branch bucket.
+     *
+     * @default - true on release branch, false otherwise
+     */
+    readonly createHostingInfrastructure?: boolean;
+}
+/**
+ * SSM parameter name suffix for the website's full domain
+ * (e.g. www.example.com).
+ */
+declare const SSM_PARAM_NAME_FULL_DOMAIN = "WEBSITE_FULL_DOMAIN";
+/**
+ * Website service stack: composes StaticHosting (only on release-branch
+ * deploys) and StaticContent (always) so feature branches can ship their
+ * content to a per-branch sub-domain folder against the release-branch
+ * bucket without provisioning duplicate infrastructure.
+ *
+ * Resources are created in protected methods; subclasses may override to
+ * customize.
+ */
+declare class OpenHiWebsiteService extends OpenHiService {
+    static readonly SERVICE_TYPE: "website";
+    /**
+     * Looks up the static-hosting bucket ARN published by the release-branch
+     * deploy of this service.
+     */
+    static bucketArnFromConstruct(scope: Construct): string;
+    /**
+     * Looks up the CloudFront distribution ARN published by the release-branch
+     * deploy of this service.
+     */
+    static distributionArnFromConstruct(scope: Construct): string;
+    /**
+     * Looks up the CloudFront distribution domain
+     * (e.g. dXXXXX.cloudfront.net) published by the release-branch deploy.
+     */
+    static distributionDomainFromConstruct(scope: Construct): string;
+    /**
+     * Looks up the CloudFront distribution ID published by the release-branch
+     * deploy of this service.
+     */
+    static distributionIdFromConstruct(scope: Construct): string;
+    /**
+     * Looks up the website's full domain (e.g. www.example.com) published by
+     * the release-branch deploy of this service.
+     */
+    static fullDomainFromConstruct(scope: Construct): string;
+    get serviceType(): string;
+    /** Override so this.props is typed with this service's options. */
+    props: OpenHiWebsiteServiceProps;
+    /**
+     * Full domain served by this website (e.g. www.example.com). Derived from
+     * `domainPrefix` and the child hosted zone name.
+     */
+    readonly fullDomain: string;
+    /**
+     * The hosting construct, only created on release-branch deploys (or when
+     * `createHostingInfrastructure` is true).
+     */
+    readonly staticHosting?: StaticHosting;
+    /**
+     * The content uploader, always created.
+     */
+    readonly staticContent: StaticContent;
+    constructor(ohEnv: OpenHiEnvironment, props: OpenHiWebsiteServiceProps);
+    /**
+     * Validates that config required for the website stack is present.
+     */
+    protected validateConfig(props: OpenHiWebsiteServiceProps): void;
+    /**
+     * Looks up the child hosted zone published by the Global service.
+     * Override to customize.
+     */
+    protected createHostedZone(): IHostedZone;
+    /**
+     * Returns the wildcard certificate looked up from the Global service.
+     * Override to customize.
+     */
+    protected createCertificate(): ICertificate;
+    /**
+     * Computes the full website domain from `domainPrefix` and the child
+     * zone name.
+     */
+    protected computeFullDomain(hostedZone: IHostedZone): string;
+    /**
+     * Creates the StaticHosting infrastructure (bucket + distribution +
+     * Lambda@Edge + 4 SSM params + DNS).
+     */
+    protected createStaticHosting(deps: {
+        certificate: ICertificate;
+        hostedZone: IHostedZone;
+    }): StaticHosting;
+    /**
+     * Creates the SSM parameter that publishes the website's full domain.
+     * Look up via {@link OpenHiWebsiteService.fullDomainFromConstruct}.
+     */
+    protected createFullDomainParameter(): void;
+    /**
+     * Creates the StaticContent uploader. Always created so feature-branch
+     * deploys can publish content to their own sub-domain folder against the
+     * release-branch bucket.
+     */
+    protected createStaticContent(): StaticContent;
+}
+
 interface OwningDeleteCascadeLambdasProps {
     /** Data-store table the cascade reads (Query) and writes (DeleteItem / TransactWriteItems) against. */
     readonly dataStoreTable: ITable;
@@ -1967,4 +2226,4 @@ declare class RenameCascadeWorkflow extends Construct {
     constructor(scope: Construct, props: RenameCascadeWorkflowProps);
 }
 
-export { type BuildParameterNameProps, ChildHostedZone, type ChildHostedZoneProps, CognitoUserPool, CognitoUserPoolClient, CognitoUserPoolDomain, CognitoUserPoolKmsKey, ControlEventBus, DATA_STORE_CHANGE_DETAIL_MAX_UTF8_BYTES, DATA_STORE_CHANGE_DETAIL_TYPE, DATA_STORE_CHANGE_EVENT_SOURCE, DEMO_DATA_PLANE_FIXTURES, DataEventBus, DataStoreHistoricalArchive, type DataStoreHistoricalArchiveProps, DataStorePostgresReplica, type DataStorePostgresReplicaProps, type DemoWorkspaceDataPlaneFixtures, DiscoverableStringParameter, type DiscoverableStringParameterProps, DynamoDbDataStore, type DynamoDbDataStoreProps, type FhirCurrentResourceChangeDetail, type GrantConsumerOptions, OPENHI_TAG_SUFFIX_BRANCH_NAME, OPENHI_TAG_SUFFIX_REPO_NAME, OPENHI_TAG_SUFFIX_SERVICE_TYPE, OPENHI_TAG_SUFFIX_STAGE_TYPE, OpenHiApp, type OpenHiAppProps, OpenHiAuthService, type OpenHiAuthServiceProps, OpenHiDataService, type OpenHiDataServiceProps, OpenHiEnvironment, type OpenHiEnvironmentProps, OpenHiGlobalService, type OpenHiGlobalServiceProps, OpenHiGraphqlService, type OpenHiGraphqlServiceProps, OpenHiRestApiService, type OpenHiRestApiServiceProps, OpenHiService, type OpenHiServiceProps, type OpenHiServiceType, OpenHiStage, type OpenHiStageProps, OpsEventBus, OwningDeleteCascadeLambdas, type OwningDeleteCascadeLambdasProps, OwningDeleteCascadeWorkflow, type OwningDeleteCascadeWorkflowProps, POSTGRES_REPLICA_CLUSTER_ARN_SSM_NAME, POSTGRES_REPLICA_DATABASE_NAME_SSM_NAME, POSTGRES_REPLICA_SECRET_ARN_SSM_NAME, PlatformDeployBridge, PlatformDeployBridgeLambda, type PlatformDeployBridgeLambdaProps, type PlatformDeployBridgeProps, PostAuthenticationLambda, PostConfirmationLambda, type PostConfirmationLambdaProps, PreTokenGenerationLambda, type PreTokenGenerationLambdaProps, ProvisionDefaultWorkspaceLambda, type ProvisionDefaultWorkspaceLambdaProps, REST_API_BASE_URL_SSM_NAME, RenameCascadeLambdas, type RenameCascadeLambdasProps, RenameCascadeWorkflow, type RenameCascadeWorkflowProps, RootGraphqlApi, type RootGraphqlApiProps, RootHostedZone, RootHttpApi, type RootHttpApiProps, RootWildcardCertificate, SEED_SYSTEM_DATA_ACTOR_SYSTEM, SEED_SYSTEM_DATA_CONSUMER_NAME, SEED_SYSTEM_DATA_CONTROL_BUS_ENV_VAR, STATIC_HOSTING_SERVICE_TYPE, SeedDemoDataLambda, type SeedDemoDataLambdaProps, SeedDemoDataWorkflow, type SeedDemoDataWorkflowProps, SeedSystemDataLambda, type SeedSystemDataLambdaProps, SeedSystemDataWorkflow, type SeedSystemDataWorkflowProps, StaticHosting, type StaticHostingProps, UserOnboardingWorkflow, type UserOnboardingWorkflowProps, WorkflowDedupConsumerNameInvalidError, WorkflowDedupTable, WorkflowDedupTableDuplicateError, type WorkflowDedupTableProps, buildFhirCurrentResourceChangeDetail, getDynamoDbDataStoreTableName, getPostgresReplicaSchemaName, getWorkflowDedupTableName, openHiTagKey };
+export { type BuildParameterNameProps, ChildHostedZone, type ChildHostedZoneProps, CognitoUserPool, CognitoUserPoolClient, CognitoUserPoolDomain, CognitoUserPoolKmsKey, ControlEventBus, DATA_STORE_CHANGE_DETAIL_MAX_UTF8_BYTES, DATA_STORE_CHANGE_DETAIL_TYPE, DATA_STORE_CHANGE_EVENT_SOURCE, DEMO_DATA_PLANE_FIXTURES, DataEventBus, DataStoreHistoricalArchive, type DataStoreHistoricalArchiveProps, DataStorePostgresReplica, type DataStorePostgresReplicaProps, type DemoWorkspaceDataPlaneFixtures, DiscoverableStringParameter, type DiscoverableStringParameterProps, DynamoDbDataStore, type DynamoDbDataStoreProps, type FhirCurrentResourceChangeDetail, type GrantConsumerOptions, HostingMode, OPENHI_TAG_SUFFIX_BRANCH_NAME, OPENHI_TAG_SUFFIX_REPO_NAME, OPENHI_TAG_SUFFIX_SERVICE_TYPE, OPENHI_TAG_SUFFIX_STAGE_TYPE, OpenHiApp, type OpenHiAppProps, OpenHiAuthService, type OpenHiAuthServiceProps, OpenHiDataService, type OpenHiDataServiceProps, OpenHiEnvironment, type OpenHiEnvironmentProps, OpenHiGlobalService, type OpenHiGlobalServiceProps, OpenHiGraphqlService, type OpenHiGraphqlServiceProps, OpenHiRestApiService, type OpenHiRestApiServiceProps, OpenHiService, type OpenHiServiceProps, type OpenHiServiceType, OpenHiStage, type OpenHiStageProps, OpenHiWebsiteService, type OpenHiWebsiteServiceProps, OpsEventBus, OwningDeleteCascadeLambdas, type OwningDeleteCascadeLambdasProps, OwningDeleteCascadeWorkflow, type OwningDeleteCascadeWorkflowProps, POSTGRES_REPLICA_CLUSTER_ARN_SSM_NAME, POSTGRES_REPLICA_DATABASE_NAME_SSM_NAME, POSTGRES_REPLICA_SECRET_ARN_SSM_NAME, PlatformDeployBridge, PlatformDeployBridgeLambda, type PlatformDeployBridgeLambdaProps, type PlatformDeployBridgeProps, PostAuthenticationLambda, PostConfirmationLambda, type PostConfirmationLambdaProps, PreTokenGenerationLambda, type PreTokenGenerationLambdaProps, ProvisionDefaultWorkspaceLambda, type ProvisionDefaultWorkspaceLambdaProps, REST_API_BASE_URL_SSM_NAME, RenameCascadeLambdas, type RenameCascadeLambdasProps, RenameCascadeWorkflow, type RenameCascadeWorkflowProps, RootGraphqlApi, type RootGraphqlApiProps, RootHostedZone, RootHttpApi, type RootHttpApiProps, RootWildcardCertificate, SEED_SYSTEM_DATA_ACTOR_SYSTEM, SEED_SYSTEM_DATA_CONSUMER_NAME, SEED_SYSTEM_DATA_CONTROL_BUS_ENV_VAR, SSM_PARAM_NAME_FULL_DOMAIN, STATIC_HOSTING_SERVICE_TYPE, SeedDemoDataLambda, type SeedDemoDataLambdaProps, SeedDemoDataWorkflow, type SeedDemoDataWorkflowProps, SeedSystemDataLambda, type SeedSystemDataLambdaProps, SeedSystemDataWorkflow, type SeedSystemDataWorkflowProps, StaticContent, type StaticContentProps, StaticHosting, type StaticHostingProps, UserOnboardingWorkflow, type UserOnboardingWorkflowProps, WorkflowDedupConsumerNameInvalidError, WorkflowDedupTable, WorkflowDedupTableDuplicateError, type WorkflowDedupTableProps, buildFhirCurrentResourceChangeDetail, getDynamoDbDataStoreTableName, getPostgresReplicaSchemaName, getWorkflowDedupTableName, openHiTagKey };