@openhi/constructs 0.0.0

package/README.md

@@ -0,0 +1,3 @@
+# @openhi/constructs
+
+AWS CDK constructs for deploying OpenHI infrastructure. The library provides reusable constructs for applications, shared infrastructure (auth and core resources), data services, and common components used across OpenHI stacks.

package/lib/app/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./open-hi-app";
+export * from "./open-hi-environment";
+export * from "./open-hi-service";
+export * from "./open-hi-stage";

package/lib/app/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./open-hi-app"), exports);
+__exportStar(require("./open-hi-environment"), exports);
+__exportStar(require("./open-hi-service"), exports);
+__exportStar(require("./open-hi-stage"), exports);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvYXBwL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQSxnREFBOEI7QUFDOUIsd0RBQXNDO0FBQ3RDLG9EQUFrQztBQUNsQyxrREFBZ0MiLCJzb3VyY2VzQ29udGVudCI6WyJleHBvcnQgKiBmcm9tIFwiLi9vcGVuLWhpLWFwcFwiO1xuZXhwb3J0ICogZnJvbSBcIi4vb3Blbi1oaS1lbnZpcm9ubWVudFwiO1xuZXhwb3J0ICogZnJvbSBcIi4vb3Blbi1oaS1zZXJ2aWNlXCI7XG5leHBvcnQgKiBmcm9tIFwiLi9vcGVuLWhpLXN0YWdlXCI7XG4iXX0=

package/lib/app/open-hi-app.d.ts

@@ -0,0 +1,85 @@
+import { OpenHiConfig } from "@openhi/config";
+import { App, AppProps } from "aws-cdk-lib";
+import { IConstruct } from "constructs";
+import { OpenHiEnvironment } from "./open-hi-environment";
+import { OpenHiStage } from "./open-hi-stage";
+/**
+ * Properties for creating an OpenHiApp instance.
+ */
+export interface OpenHiAppProps extends AppProps {
+    /**
+     * Optional name for the application.
+     * ```
+     */
+    readonly appName?: string;
+    /**
+     * The OpenHi configuration object that defines stages, environments, and
+     * their associated AWS account and region settings.
+     */
+    readonly config: OpenHiConfig;
+}
+/**
+ * Root application construct for OpenHi CDK applications.
+ */
+export declare class OpenHiApp extends App {
+    /**
+     * Finds the OpenHiApp instance that contains the given construct in its
+     * construct tree.
+     */
+    static of(construct: IConstruct): OpenHiApp | undefined;
+    /**
+     * Type guard that checks if a value is an OpenHiApp instance.
+     */
+    static isOpenHiApp(this: void, x: any): x is OpenHiApp;
+    /**
+     * Name for the application.
+     */
+    readonly appName: string;
+    /**
+     * The OpenHi configuration object for this application.
+     */
+    readonly config: OpenHiConfig;
+    /**
+     * Creates a new OpenHiApp instance.
+     */
+    constructor(props: OpenHiAppProps);
+    /*****************************************************************************
+     *
+     * Stages
+     *
+     ****************************************************************************/
+    /**
+     * Gets all OpenHiStage instances that are direct children of this app.
+  
+     */
+    get stages(): Array<OpenHiStage>;
+    /**
+     * Gets the development stage, if it exists.
+     */
+    get devStage(): OpenHiStage | undefined;
+    /**
+     * Gets the staging stage, if it exists.
+     */
+    get stageStage(): OpenHiStage | undefined;
+    /**
+     * Gets the production stage, if it exists.
+     */
+    get prodStage(): OpenHiStage | undefined;
+    /*****************************************************************************
+     *
+     * Environments
+     *
+     ****************************************************************************/
+    /**
+     * Gets all OpenHiEnvironment instances across all stages in this app.
+     */
+    get environments(): Array<OpenHiEnvironment>;
+    /**
+     * Gets all primary environments across all stages in this app.
+     */
+    get primaryEnvironments(): Array<OpenHiEnvironment>;
+    /**
+     * Gets all secondary environments across all stages in this app.
+     */
+    get secondaryEnvironments(): Array<OpenHiEnvironment>;
+}

package/lib/app/open-hi-app.js

@@ -0,0 +1,127 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenHiApp = void 0;
+const config_1 = require("@openhi/config");
+const aws_cdk_lib_1 = require("aws-cdk-lib");
+const open_hi_environment_1 = require("./open-hi-environment");
+const open_hi_stage_1 = require("./open-hi-stage");
+/**
+ * Symbol used for runtime type checking to identify OpenHiApp instances.
+ *
+ * @internal
+ */
+const OPEN_HI_APP_SYMBOL = Symbol.for("@openhi/constructs/core.OpenHiApp");
+/**
+ * Root application construct for OpenHi CDK applications.
+ */
+class OpenHiApp extends aws_cdk_lib_1.App {
+    /**
+     * Finds the OpenHiApp instance that contains the given construct in its
+     * construct tree.
+     */
+    static of(construct) {
+        return construct.node.scopes.reverse().find(OpenHiApp.isOpenHiApp);
+    }
+    /**
+     * Type guard that checks if a value is an OpenHiApp instance.
+     */
+    static isOpenHiApp(x) {
+        return x !== null && typeof x === "object" && OPEN_HI_APP_SYMBOL in x;
+    }
+    /**
+     * Creates a new OpenHiApp instance.
+     */
+    constructor(props) {
+        super(props);
+        // Set runtime symbol for type checking
+        Object.defineProperty(this, OPEN_HI_APP_SYMBOL, { value: true });
+        // Store app name, defaulting to "openhi" if not provided
+        this.appName = props.appName ?? "openhi";
+        // Store configuration for use by child constructs
+        this.config = props.config;
+        // Create stages and environments based on configuration
+        // Iterate through all possible stage types (dev, stage, prod)
+        Object.values(config_1.OPEN_HI_STAGE).forEach((stageType) => {
+            // Only create a stage if it's configured in the config
+            if (this.config.deploymentTargets?.[stageType]) {
+                const stage = new open_hi_stage_1.OpenHiStage(this, { stageType });
+                // Create primary deployment target if configured
+                // Each stage can have at most one primary deployment target
+                if (this.config.deploymentTargets?.[stageType]?.[config_1.OPEN_HI_DEPLOYMENT_TARGET_ROLE.PRIMARY]) {
+                    const envConfig = this.config.deploymentTargets[stageType][config_1.OPEN_HI_DEPLOYMENT_TARGET_ROLE.PRIMARY];
+                    new open_hi_environment_1.OpenHiEnvironment(stage, {
+                        deploymentTargetRole: config_1.OPEN_HI_DEPLOYMENT_TARGET_ROLE.PRIMARY,
+                        config: envConfig,
+                        env: { account: envConfig.account, region: envConfig.region },
+                    });
+                }
+                // Create secondary deployment targets if configured
+                // Each stage can have zero or more secondary deployment targets
+                if (this.config.deploymentTargets?.[stageType]?.[config_1.OPEN_HI_DEPLOYMENT_TARGET_ROLE.SECONDARY]) {
+                    this.config.deploymentTargets[stageType][config_1.OPEN_HI_DEPLOYMENT_TARGET_ROLE.SECONDARY].forEach((envConfig) => {
+                        new open_hi_environment_1.OpenHiEnvironment(stage, {
+                            deploymentTargetRole: config_1.OPEN_HI_DEPLOYMENT_TARGET_ROLE.SECONDARY,
+                            config: envConfig,
+                            env: { account: envConfig.account, region: envConfig.region },
+                        });
+                    });
+                }
+            }
+        });
+    }
+    /*****************************************************************************
+     *
+     * Stages
+     *
+     ****************************************************************************/
+    /**
+     * Gets all OpenHiStage instances that are direct children of this app.
+  
+     */
+    get stages() {
+        return this.node.children.filter(open_hi_stage_1.OpenHiStage.isOpenHiStage);
+    }
+    /**
+     * Gets the development stage, if it exists.
+     */
+    get devStage() {
+        return this.stages.find((stage) => stage.stageType === config_1.OPEN_HI_STAGE.DEV);
+    }
+    /**
+     * Gets the staging stage, if it exists.
+     */
+    get stageStage() {
+        return this.stages.find((stage) => stage.stageType === config_1.OPEN_HI_STAGE.STAGE);
+    }
+    /**
+     * Gets the production stage, if it exists.
+     */
+    get prodStage() {
+        return this.stages.find((stage) => stage.stageType === config_1.OPEN_HI_STAGE.PROD);
+    }
+    /*****************************************************************************
+     *
+     * Environments
+     *
+     ****************************************************************************/
+    /**
+     * Gets all OpenHiEnvironment instances across all stages in this app.
+     */
+    get environments() {
+        return this.stages.flatMap((stage) => stage.environments);
+    }
+    /**
+     * Gets all primary environments across all stages in this app.
+     */
+    get primaryEnvironments() {
+        return this.environments.filter((env) => env.deploymentTargetRole === "primary");
+    }
+    /**
+     * Gets all secondary environments across all stages in this app.
+     */
+    get secondaryEnvironments() {
+        return this.environments.filter((env) => env.deploymentTargetRole === "secondary");
+    }
+}
+exports.OpenHiApp = OpenHiApp;
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"open-hi-app.js","sourceRoot":"","sources":["../../src/app/open-hi-app.ts"],"names":[],"mappings":";;;AAAA,2CAKwB;AACxB,6CAA4C;AAE5C,+DAA0D;AAC1D,mDAA8C;AAE9C;;;;GAIG;AACH,MAAM,kBAAkB,GAAG,MAAM,CAAC,GAAG,CAAC,mCAAmC,CAAC,CAAC;AAmB3E;;GAEG;AACH,MAAa,SAAU,SAAQ,iBAAG;IAChC;;;OAGG;IACI,MAAM,CAAC,EAAE,CAAC,SAAqB;QACpC,OAAO,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;IACrE,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,WAAW,CAAa,CAAM;QAC1C,OAAO,CAAC,KAAK,IAAI,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,kBAAkB,IAAI,CAAC,CAAC;IACxE,CAAC;IAYD;;OAEG;IACH,YAAY,KAAqB;QAC/B,KAAK,CAAC,KAAK,CAAC,CAAC;QAEb,uCAAuC;QACvC,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,kBAAkB,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QAEjE,yDAAyD;QACzD,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,IAAI,QAAQ,CAAC;QAEzC,kDAAkD;QAClD,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAE3B,wDAAwD;QACxD,8DAA8D;QAC9D,MAAM,CAAC,MAAM,CAAC,sBAAa,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;YACjD,uDAAuD;YACvD,IAAI,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC/C,MAAM,KAAK,GAAG,IAAI,2BAAW,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;gBAEnD,iDAAiD;gBACjD,4DAA4D;gBAC5D,IACE,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE,CAAC,SAAS,CAAC,EAAE,CAC1C,uCAA8B,CAAC,OAAO,CACvC,EACD,CAAC;oBACD,MAAM,SAAS,GACb,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,SAAS,CAAC,CACtC,uCAA8B,CAAC,OAAO,CACtC,CAAC;oBACL,IAAI,uCAAiB,CAAC,KAAK,EAAE;wBAC3B,oBAAoB,EAAE,uCAA8B,CAAC,OAAO;wBAC5D,MAAM,EAAE,SAAS;wBACjB,GAAG,EAAE,EAAE,OAAO,EAAE,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,MAAM,EAAE;qBAC9D,CAAC,CAAC;gBACL,CAAC;gBAED,oDAAoD;gBACpD,gEAAgE;gBAChE,IACE,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE,CAAC,SAAS,CAAC,EAAE,CAC1C,uCAA8B,CAAC,SAAS,CACzC,EACD,CAAC;oBACD,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,SAAS,CAAC,CACtC,uCAA8B,CAAC,SAAS,CACxC,CAAC,OAAO,CAAC,CAAC,SAAkC,EAAE,EAAE;wBAChD,IAAI,uCAAiB,CAAC,KAAK,EAAE;4BAC3B,oBAAoB,EAAE,uCAA8B,CAAC,SAAS;4BAC9D,MAAM,EAAE,SAAS;4BACjB,GAAG,EAAE,EAAE,OAAO,EAAE,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,MAAM,EAAE;yBAC9D,CAAC,CAAC;oBACL,CAAC,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;kFAI8E;IAE9E;;;OAGG;IACH,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,2BAAW,CAAC,aAAa,CAAC,CAAC;IAC9D,CAAC;IAED;;OAEG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,KAAK,sBAAa,CAAC,GAAG,CAAC,CAAC;IAC5E,CAAC;IAED;;OAEG;IACH,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,KAAK,sBAAa,CAAC,KAAK,CAAC,CAAC;IAC9E,CAAC;IAED;;OAEG;IACH,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,KAAK,sBAAa,CAAC,IAAI,CAAC,CAAC;IAC7E,CAAC;IAED;;;;kFAI8E;IAE9E;;OAEG;IACH,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IAC5D,CAAC;IAED;;OAEG;IACH,IAAW,mBAAmB;QAC5B,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,CAC7B,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,oBAAoB,KAAK,SAAS,CAChD,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,IAAW,qBAAqB;QAC9B,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,CAC7B,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,oBAAoB,KAAK,WAAW,CAClD,CAAC;IACJ,CAAC;CACF;AAxJD,8BAwJC","sourcesContent":["import {\n  OPEN_HI_DEPLOYMENT_TARGET_ROLE,\n  OPEN_HI_STAGE,\n  OpenHiConfig,\n  OpenHiEnvironmentConfig,\n} from \"@openhi/config\";\nimport { App, AppProps } from \"aws-cdk-lib\";\nimport { IConstruct } from \"constructs\";\nimport { OpenHiEnvironment } from \"./open-hi-environment\";\nimport { OpenHiStage } from \"./open-hi-stage\";\n\n/**\n * Symbol used for runtime type checking to identify OpenHiApp instances.\n *\n * @internal\n */\nconst OPEN_HI_APP_SYMBOL = Symbol.for(\"@openhi/constructs/core.OpenHiApp\");\n\n/**\n * Properties for creating an OpenHiApp instance.\n */\nexport interface OpenHiAppProps extends AppProps {\n  /**\n   * Optional name for the application.\n   * ```\n   */\n  readonly appName?: string;\n\n  /**\n   * The OpenHi configuration object that defines stages, environments, and\n   * their associated AWS account and region settings.\n   */\n  readonly config: OpenHiConfig;\n}\n\n/**\n * Root application construct for OpenHi CDK applications.\n */\nexport class OpenHiApp extends App {\n  /**\n   * Finds the OpenHiApp instance that contains the given construct in its\n   * construct tree.\n   */\n  public static of(construct: IConstruct): OpenHiApp | undefined {\n    return construct.node.scopes.reverse().find(OpenHiApp.isOpenHiApp);\n  }\n\n  /**\n   * Type guard that checks if a value is an OpenHiApp instance.\n   */\n  public static isOpenHiApp(this: void, x: any): x is OpenHiApp {\n    return x !== null && typeof x === \"object\" && OPEN_HI_APP_SYMBOL in x;\n  }\n\n  /**\n   * Name for the application.\n   */\n  readonly appName: string;\n\n  /**\n   * The OpenHi configuration object for this application.\n   */\n  readonly config: OpenHiConfig;\n\n  /**\n   * Creates a new OpenHiApp instance.\n   */\n  constructor(props: OpenHiAppProps) {\n    super(props);\n\n    // Set runtime symbol for type checking\n    Object.defineProperty(this, OPEN_HI_APP_SYMBOL, { value: true });\n\n    // Store app name, defaulting to \"openhi\" if not provided\n    this.appName = props.appName ?? \"openhi\";\n\n    // Store configuration for use by child constructs\n    this.config = props.config;\n\n    // Create stages and environments based on configuration\n    // Iterate through all possible stage types (dev, stage, prod)\n    Object.values(OPEN_HI_STAGE).forEach((stageType) => {\n      // Only create a stage if it's configured in the config\n      if (this.config.deploymentTargets?.[stageType]) {\n        const stage = new OpenHiStage(this, { stageType });\n\n        // Create primary deployment target if configured\n        // Each stage can have at most one primary deployment target\n        if (\n          this.config.deploymentTargets?.[stageType]?.[\n            OPEN_HI_DEPLOYMENT_TARGET_ROLE.PRIMARY\n          ]\n        ) {\n          const envConfig =\n            this.config.deploymentTargets[stageType][\n              OPEN_HI_DEPLOYMENT_TARGET_ROLE.PRIMARY\n            ]!;\n          new OpenHiEnvironment(stage, {\n            deploymentTargetRole: OPEN_HI_DEPLOYMENT_TARGET_ROLE.PRIMARY,\n            config: envConfig,\n            env: { account: envConfig.account, region: envConfig.region },\n          });\n        }\n\n        // Create secondary deployment targets if configured\n        // Each stage can have zero or more secondary deployment targets\n        if (\n          this.config.deploymentTargets?.[stageType]?.[\n            OPEN_HI_DEPLOYMENT_TARGET_ROLE.SECONDARY\n          ]\n        ) {\n          this.config.deploymentTargets[stageType][\n            OPEN_HI_DEPLOYMENT_TARGET_ROLE.SECONDARY\n          ]!.forEach((envConfig: OpenHiEnvironmentConfig) => {\n            new OpenHiEnvironment(stage, {\n              deploymentTargetRole: OPEN_HI_DEPLOYMENT_TARGET_ROLE.SECONDARY,\n              config: envConfig,\n              env: { account: envConfig.account, region: envConfig.region },\n            });\n          });\n        }\n      }\n    });\n  }\n\n  /*****************************************************************************\n   *\n   * Stages\n   *\n   ****************************************************************************/\n\n  /**\n   * Gets all OpenHiStage instances that are direct children of this app.\n\n   */\n  public get stages(): Array<OpenHiStage> {\n    return this.node.children.filter(OpenHiStage.isOpenHiStage);\n  }\n\n  /**\n   * Gets the development stage, if it exists.\n   */\n  public get devStage(): OpenHiStage | undefined {\n    return this.stages.find((stage) => stage.stageType === OPEN_HI_STAGE.DEV);\n  }\n\n  /**\n   * Gets the staging stage, if it exists.\n   */\n  public get stageStage(): OpenHiStage | undefined {\n    return this.stages.find((stage) => stage.stageType === OPEN_HI_STAGE.STAGE);\n  }\n\n  /**\n   * Gets the production stage, if it exists.\n   */\n  public get prodStage(): OpenHiStage | undefined {\n    return this.stages.find((stage) => stage.stageType === OPEN_HI_STAGE.PROD);\n  }\n\n  /*****************************************************************************\n   *\n   * Environments\n   *\n   ****************************************************************************/\n\n  /**\n   * Gets all OpenHiEnvironment instances across all stages in this app.\n   */\n  public get environments(): Array<OpenHiEnvironment> {\n    return this.stages.flatMap((stage) => stage.environments);\n  }\n\n  /**\n   * Gets all primary environments across all stages in this app.\n   */\n  public get primaryEnvironments(): Array<OpenHiEnvironment> {\n    return this.environments.filter(\n      (env) => env.deploymentTargetRole === \"primary\",\n    );\n  }\n\n  /**\n   * Gets all secondary environments across all stages in this app.\n   */\n  public get secondaryEnvironments(): Array<OpenHiEnvironment> {\n    return this.environments.filter(\n      (env) => env.deploymentTargetRole === \"secondary\",\n    );\n  }\n}\n"]}

package/lib/app/open-hi-environment.d.ts

@@ -0,0 +1,59 @@
+import { OPEN_HI_DEPLOYMENT_TARGET_ROLE, OpenHiEnvironmentConfig } from "@openhi/config";
+import { Stage, StageProps } from "aws-cdk-lib";
+import { IConstruct } from "constructs";
+import { OpenHiStage } from "./open-hi-stage";
+/**
+ * Properties for creating an OpenHiEnvironment.
+ */
+export interface OpenHiEnvironmentProps extends StageProps {
+    /**
+     * The deployment target role for this (account, region).
+     */
+    readonly deploymentTargetRole: (typeof OPEN_HI_DEPLOYMENT_TARGET_ROLE)[keyof typeof OPEN_HI_DEPLOYMENT_TARGET_ROLE];
+    /**
+     * Configuration for this specific environment.
+     */
+    readonly config: OpenHiEnvironmentConfig;
+}
+/**
+ * Represents an OpenHi environment within an AWS CDK stage.
+ */
+export declare class OpenHiEnvironment extends Stage {
+    /**
+     * The OpenHiStage that contains this environment.
+     */
+    ohStage: OpenHiStage;
+    /**
+     * Properties for creating the environment.
+     */
+    props: OpenHiEnvironmentProps;
+    /**
+     * Finds the OpenHiEnvironment that contains the given construct.
+     * ```
+     */
+    static of(construct: IConstruct): OpenHiEnvironment | undefined;
+    /**
+     * Type guard to check if a value is an OpenHiEnvironment instance.
+     */
+    static isOpenHiEnvironment(this: void, x: any): x is OpenHiEnvironment;
+    /**
+     * Configuration for this specific environment.
+     */
+    readonly config: OpenHiEnvironmentConfig;
+    /**
+     * The deployment target role for this (account, region).
+     */
+    readonly deploymentTargetRole: (typeof OPEN_HI_DEPLOYMENT_TARGET_ROLE)[keyof typeof OPEN_HI_DEPLOYMENT_TARGET_ROLE];
+    /**
+     * Creates a new OpenHiEnvironment.
+     */
+    constructor(
+    /**
+     * The OpenHiStage that contains this environment.
+     */
+    ohStage: OpenHiStage, 
+    /**
+     * Properties for creating the environment.
+     */
+    props: OpenHiEnvironmentProps);
+}

package/lib/app/open-hi-environment.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenHiEnvironment = void 0;
+const config_1 = require("@openhi/config");
+const aws_cdk_lib_1 = require("aws-cdk-lib");
+/**
+ * Symbol used to identify OpenHiEnvironment instances at runtime.
+ */
+const OPEN_HI_ENVIRONMENT_SYMBOL = Symbol.for("@openhi/constructs/core.OpenHiEnvironment");
+/**
+ * Represents an OpenHi environment within an AWS CDK stage.
+ */
+class OpenHiEnvironment extends aws_cdk_lib_1.Stage {
+    /**
+     * Finds the OpenHiEnvironment that contains the given construct.
+     * ```
+     */
+    static of(construct) {
+        return construct.node.scopes
+            .reverse()
+            .find(OpenHiEnvironment.isOpenHiEnvironment);
+    }
+    /**
+     * Type guard to check if a value is an OpenHiEnvironment instance.
+     */
+    static isOpenHiEnvironment(x) {
+        return (x !== null && typeof x === "object" && OPEN_HI_ENVIRONMENT_SYMBOL in x);
+    }
+    /**
+     * Creates a new OpenHiEnvironment.
+     */
+    constructor(
+    /**
+     * The OpenHiStage that contains this environment.
+     */
+    ohStage, 
+    /**
+     * Properties for creating the environment.
+     */
+    props) {
+        // Copy account and region from config into env, if provided.
+        // This allows all resources in this environment to default to the correct
+        // account and region without having to specify it on each stack or resource.
+        if (props.config.account && props.config.region) {
+            props = {
+                ...props,
+                env: {
+                    account: props.config.account,
+                    region: props.config.region,
+                },
+            };
+        }
+        // Determine the stage name:
+        // - Primary environments use the environment type as the name
+        // - Secondary deployment targets use "{deploymentTargetRole}-{index}" format
+        const stageName = props.deploymentTargetRole === config_1.OPEN_HI_DEPLOYMENT_TARGET_ROLE.PRIMARY
+            ? props.deploymentTargetRole
+            : [props.deploymentTargetRole, ohStage.environments.length].join("-");
+        super(ohStage, stageName, {
+            env: props.env ?? ohStage.props.env,
+            ...props,
+        });
+        this.ohStage = ohStage;
+        this.props = props;
+        // Mark this instance as an OpenHiEnvironment for runtime type checking
+        Object.defineProperty(this, OPEN_HI_ENVIRONMENT_SYMBOL, { value: true });
+        this.deploymentTargetRole = props.deploymentTargetRole;
+        this.config = props.config;
+    }
+}
+exports.OpenHiEnvironment = OpenHiEnvironment;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoib3Blbi1oaS1lbnZpcm9ubWVudC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9hcHAvb3Blbi1oaS1lbnZpcm9ubWVudC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSwyQ0FHd0I7QUFDeEIsNkNBQWdEO0FBSWhEOztHQUVHO0FBQ0gsTUFBTSwwQkFBMEIsR0FBRyxNQUFNLENBQUMsR0FBRyxDQUMzQywyQ0FBMkMsQ0FDNUMsQ0FBQztBQWlCRjs7R0FFRztBQUNILE1BQWEsaUJBQWtCLFNBQVEsbUJBQUs7SUFDMUM7OztPQUdHO0lBQ0ksTUFBTSxDQUFDLEVBQUUsQ0FBQyxTQUFxQjtRQUNwQyxPQUFPLFNBQVMsQ0FBQyxJQUFJLENBQUMsTUFBTTthQUN6QixPQUFPLEVBQUU7YUFDVCxJQUFJLENBQUMsaUJBQWlCLENBQUMsbUJBQW1CLENBQUMsQ0FBQztJQUNqRCxDQUFDO0lBRUQ7O09BRUc7SUFDSSxNQUFNLENBQUMsbUJBQW1CLENBRS9CLENBQU07UUFFTixPQUFPLENBQ0wsQ0FBQyxLQUFLLElBQUksSUFBSSxPQUFPLENBQUMsS0FBSyxRQUFRLElBQUksMEJBQTBCLElBQUksQ0FBQyxDQUN2RSxDQUFDO0lBQ0osQ0FBQztJQVlEOztPQUVHO0lBQ0g7SUFDRTs7T0FFRztJQUNJLE9BQW9CO0lBQzNCOztPQUVHO0lBQ0ksS0FBNkI7UUFFcEMsNkRBQTZEO1FBQzdELDBFQUEwRTtRQUMxRSw2RUFBNkU7UUFDN0UsSUFBSSxLQUFLLENBQUMsTUFBTSxDQUFDLE9BQU8sSUFBSSxLQUFLLENBQUMsTUFBTSxDQUFDLE1BQU0sRUFBRSxDQUFDO1lBQ2hELEtBQUssR0FBRztnQkFDTixHQUFHLEtBQUs7Z0JBQ1IsR0FBRyxFQUFFO29CQUNILE9BQU8sRUFBRSxLQUFLLENBQUMsTUFBTSxDQUFDLE9BQU87b0JBQzdCLE1BQU0sRUFBRSxLQUFLLENBQUMsTUFBTSxDQUFDLE1BQU07aUJBQzVCO2FBQ0YsQ0FBQztRQUNKLENBQUM7UUFFRCw0QkFBNEI7UUFDNUIsOERBQThEO1FBQzlELDZFQUE2RTtRQUM3RSxNQUFNLFNBQVMsR0FDYixLQUFLLENBQUMsb0JBQW9CLEtBQUssdUNBQThCLENBQUMsT0FBTztZQUNuRSxDQUFDLENBQUMsS0FBSyxDQUFDLG9CQUFvQjtZQUM1QixDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUMsb0JBQW9CLEVBQUUsT0FBTyxDQUFDLFlBQVksQ0FBQyxNQUFNLENBQUMsQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLENBQUM7UUFFMUUsS0FBSyxDQUFDLE9BQU8sRUFBRSxTQUFTLEVBQUU7WUFDeEIsR0FBRyxFQUFFLEtBQUssQ0FBQyxHQUFHLElBQUksT0FBTyxDQUFDLEtBQUssQ0FBQyxHQUFHO1lBQ25DLEdBQUcsS0FBSztTQUNULENBQUMsQ0FBQztRQTlCSSxZQUFPLEdBQVAsT0FBTyxDQUFhO1FBSXBCLFVBQUssR0FBTCxLQUFLLENBQXdCO1FBNEJwQyx1RUFBdUU7UUFDdkUsTUFBTSxDQUFDLGNBQWMsQ0FBQyxJQUFJLEVBQUUsMEJBQTBCLEVBQUUsRUFBRSxLQUFLLEVBQUUsSUFBSSxFQUFFLENBQUMsQ0FBQztRQUV6RSxJQUFJLENBQUMsb0JBQW9CLEdBQUcsS0FBSyxDQUFDLG9CQUFvQixDQUFDO1FBQ3ZELElBQUksQ0FBQyxNQUFNLEdBQUcsS0FBSyxDQUFDLE1BQU0sQ0FBQztJQUM3QixDQUFDO0NBQ0Y7QUE5RUQsOENBOEVDIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHtcbiAgT1BFTl9ISV9ERVBMT1lNRU5UX1RBUkdFVF9ST0xFLFxuICBPcGVuSGlFbnZpcm9ubWVudENvbmZpZyxcbn0gZnJvbSBcIkBvcGVuaGkvY29uZmlnXCI7XG5pbXBvcnQgeyBTdGFnZSwgU3RhZ2VQcm9wcyB9IGZyb20gXCJhd3MtY2RrLWxpYlwiO1xuaW1wb3J0IHsgSUNvbnN0cnVjdCB9IGZyb20gXCJjb25zdHJ1Y3RzXCI7XG5pbXBvcnQgeyBPcGVuSGlTdGFnZSB9IGZyb20gXCIuL29wZW4taGktc3RhZ2VcIjtcblxuLyoqXG4gKiBTeW1ib2wgdXNlZCB0byBpZGVudGlmeSBPcGVuSGlFbnZpcm9ubWVudCBpbnN0YW5jZXMgYXQgcnVudGltZS5cbiAqL1xuY29uc3QgT1BFTl9ISV9FTlZJUk9OTUVOVF9TWU1CT0wgPSBTeW1ib2wuZm9yKFxuICBcIkBvcGVuaGkvY29uc3RydWN0cy9jb3JlLk9wZW5IaUVudmlyb25tZW50XCIsXG4pO1xuXG4vKipcbiAqIFByb3BlcnRpZXMgZm9yIGNyZWF0aW5nIGFuIE9wZW5IaUVudmlyb25tZW50LlxuICovXG5leHBvcnQgaW50ZXJmYWNlIE9wZW5IaUVudmlyb25tZW50UHJvcHMgZXh0ZW5kcyBTdGFnZVByb3BzIHtcbiAgLyoqXG4gICAqIFRoZSBkZXBsb3ltZW50IHRhcmdldCByb2xlIGZvciB0aGlzIChhY2NvdW50LCByZWdpb24pLlxuICAgKi9cbiAgcmVhZG9ubHkgZGVwbG95bWVudFRhcmdldFJvbGU6ICh0eXBlb2YgT1BFTl9ISV9ERVBMT1lNRU5UX1RBUkdFVF9ST0xFKVtrZXlvZiB0eXBlb2YgT1BFTl9ISV9ERVBMT1lNRU5UX1RBUkdFVF9ST0xFXTtcblxuICAvKipcbiAgICogQ29uZmlndXJhdGlvbiBmb3IgdGhpcyBzcGVjaWZpYyBlbnZpcm9ubWVudC5cbiAgICovXG4gIHJlYWRvbmx5IGNvbmZpZzogT3BlbkhpRW52aXJvbm1lbnRDb25maWc7XG59XG5cbi8qKlxuICogUmVwcmVzZW50cyBhbiBPcGVuSGkgZW52aXJvbm1lbnQgd2l0aGluIGFuIEFXUyBDREsgc3RhZ2UuXG4gKi9cbmV4cG9ydCBjbGFzcyBPcGVuSGlFbnZpcm9ubWVudCBleHRlbmRzIFN0YWdlIHtcbiAgLyoqXG4gICAqIEZpbmRzIHRoZSBPcGVuSGlFbnZpcm9ubWVudCB0aGF0IGNvbnRhaW5zIHRoZSBnaXZlbiBjb25zdHJ1Y3QuXG4gICAqIGBgYFxuICAgKi9cbiAgcHVibGljIHN0YXRpYyBvZihjb25zdHJ1Y3Q6IElDb25zdHJ1Y3QpOiBPcGVuSGlFbnZpcm9ubWVudCB8IHVuZGVmaW5lZCB7XG4gICAgcmV0dXJuIGNvbnN0cnVjdC5ub2RlLnNjb3Blc1xuICAgICAgLnJldmVyc2UoKVxuICAgICAgLmZpbmQoT3BlbkhpRW52aXJvbm1lbnQuaXNPcGVuSGlFbnZpcm9ubWVudCk7XG4gIH1cblxuICAvKipcbiAgICogVHlwZSBndWFyZCB0byBjaGVjayBpZiBhIHZhbHVlIGlzIGFuIE9wZW5IaUVudmlyb25tZW50IGluc3RhbmNlLlxuICAgKi9cbiAgcHVibGljIHN0YXRpYyBpc09wZW5IaUVudmlyb25tZW50KFxuICAgIHRoaXM6IHZvaWQsXG4gICAgeDogYW55LFxuICApOiB4IGlzIE9wZW5IaUVudmlyb25tZW50IHtcbiAgICByZXR1cm4gKFxuICAgICAgeCAhPT0gbnVsbCAmJiB0eXBlb2YgeCA9PT0gXCJvYmplY3RcIiAmJiBPUEVOX0hJX0VOVklST05NRU5UX1NZTUJPTCBpbiB4XG4gICAgKTtcbiAgfVxuXG4gIC8qKlxuICAgKiBDb25maWd1cmF0aW9uIGZvciB0aGlzIHNwZWNpZmljIGVudmlyb25tZW50LlxuICAgKi9cbiAgcmVhZG9ubHkgY29uZmlnOiBPcGVuSGlFbnZpcm9ubWVudENvbmZpZztcblxuICAvKipcbiAgICogVGhlIGRlcGxveW1lbnQgdGFyZ2V0IHJvbGUgZm9yIHRoaXMgKGFjY291bnQsIHJlZ2lvbikuXG4gICAqL1xuICBwdWJsaWMgcmVhZG9ubHkgZGVwbG95bWVudFRhcmdldFJvbGU6ICh0eXBlb2YgT1BFTl9ISV9ERVBMT1lNRU5UX1RBUkdFVF9ST0xFKVtrZXlvZiB0eXBlb2YgT1BFTl9ISV9ERVBMT1lNRU5UX1RBUkdFVF9ST0xFXTtcblxuICAvKipcbiAgICogQ3JlYXRlcyBhIG5ldyBPcGVuSGlFbnZpcm9ubWVudC5cbiAgICovXG4gIGNvbnN0cnVjdG9yKFxuICAgIC8qKlxuICAgICAqIFRoZSBPcGVuSGlTdGFnZSB0aGF0IGNvbnRhaW5zIHRoaXMgZW52aXJvbm1lbnQuXG4gICAgICovXG4gICAgcHVibGljIG9oU3RhZ2U6IE9wZW5IaVN0YWdlLFxuICAgIC8qKlxuICAgICAqIFByb3BlcnRpZXMgZm9yIGNyZWF0aW5nIHRoZSBlbnZpcm9ubWVudC5cbiAgICAgKi9cbiAgICBwdWJsaWMgcHJvcHM6IE9wZW5IaUVudmlyb25tZW50UHJvcHMsXG4gICkge1xuICAgIC8vIENvcHkgYWNjb3VudCBhbmQgcmVnaW9uIGZyb20gY29uZmlnIGludG8gZW52LCBpZiBwcm92aWRlZC5cbiAgICAvLyBUaGlzIGFsbG93cyBhbGwgcmVzb3VyY2VzIGluIHRoaXMgZW52aXJvbm1lbnQgdG8gZGVmYXVsdCB0byB0aGUgY29ycmVjdFxuICAgIC8vIGFjY291bnQgYW5kIHJlZ2lvbiB3aXRob3V0IGhhdmluZyB0byBzcGVjaWZ5IGl0IG9uIGVhY2ggc3RhY2sgb3IgcmVzb3VyY2UuXG4gICAgaWYgKHByb3BzLmNvbmZpZy5hY2NvdW50ICYmIHByb3BzLmNvbmZpZy5yZWdpb24pIHtcbiAgICAgIHByb3BzID0ge1xuICAgICAgICAuLi5wcm9wcyxcbiAgICAgICAgZW52OiB7XG4gICAgICAgICAgYWNjb3VudDogcHJvcHMuY29uZmlnLmFjY291bnQsXG4gICAgICAgICAgcmVnaW9uOiBwcm9wcy5jb25maWcucmVnaW9uLFxuICAgICAgICB9LFxuICAgICAgfTtcbiAgICB9XG5cbiAgICAvLyBEZXRlcm1pbmUgdGhlIHN0YWdlIG5hbWU6XG4gICAgLy8gLSBQcmltYXJ5IGVudmlyb25tZW50cyB1c2UgdGhlIGVudmlyb25tZW50IHR5cGUgYXMgdGhlIG5hbWVcbiAgICAvLyAtIFNlY29uZGFyeSBkZXBsb3ltZW50IHRhcmdldHMgdXNlIFwie2RlcGxveW1lbnRUYXJnZXRSb2xlfS17aW5kZXh9XCIgZm9ybWF0XG4gICAgY29uc3Qgc3RhZ2VOYW1lID1cbiAgICAgIHByb3BzLmRlcGxveW1lbnRUYXJnZXRSb2xlID09PSBPUEVOX0hJX0RFUExPWU1FTlRfVEFSR0VUX1JPTEUuUFJJTUFSWVxuICAgICAgICA/IHByb3BzLmRlcGxveW1lbnRUYXJnZXRSb2xlXG4gICAgICAgIDogW3Byb3BzLmRlcGxveW1lbnRUYXJnZXRSb2xlLCBvaFN0YWdlLmVudmlyb25tZW50cy5sZW5ndGhdLmpvaW4oXCItXCIpO1xuXG4gICAgc3VwZXIob2hTdGFnZSwgc3RhZ2VOYW1lLCB7XG4gICAgICBlbnY6IHByb3BzLmVudiA/PyBvaFN0YWdlLnByb3BzLmVudixcbiAgICAgIC4uLnByb3BzLFxuICAgIH0pO1xuXG4gICAgLy8gTWFyayB0aGlzIGluc3RhbmNlIGFzIGFuIE9wZW5IaUVudmlyb25tZW50IGZvciBydW50aW1lIHR5cGUgY2hlY2tpbmdcbiAgICBPYmplY3QuZGVmaW5lUHJvcGVydHkodGhpcywgT1BFTl9ISV9FTlZJUk9OTUVOVF9TWU1CT0wsIHsgdmFsdWU6IHRydWUgfSk7XG5cbiAgICB0aGlzLmRlcGxveW1lbnRUYXJnZXRSb2xlID0gcHJvcHMuZGVwbG95bWVudFRhcmdldFJvbGU7XG4gICAgdGhpcy5jb25maWcgPSBwcm9wcy5jb25maWc7XG4gIH1cbn1cbiJdfQ==

package/lib/app/open-hi-service.d.ts

@@ -0,0 +1,169 @@
+import { OpenHiEnvironmentConfig } from "@openhi/config";
+import { RemovalPolicy, Stack, StackProps } from "aws-cdk-lib";
+import { OpenHiEnvironment } from "./open-hi-environment";
+import { CoreProps } from "../components/core";
+/**
+ * Service type identifiers for OpenHI services.
+ *
+ * @remarks
+ * These constants define the different types of services that can be deployed
+ * within the OpenHI platform. Each service type represents a distinct domain
+ * or functional area with its own data model, API endpoints, and business logic.
+ *
+ * Service types are used for:
+ * - Resource naming and tagging
+ * - Service discovery and routing
+ * - Deployment context calculations
+ * - Cross-service communication patterns
+ *
+ * @public
+ */
+export declare const OPEN_HI_SERVICE_TYPE: {
+    /**
+     * Authentication service.
+     *   *
+     * Only one instance of the auth service should exist per environment.
+     */
+    readonly AUTH: "auth";
+    /**
+     * Root shared core services.
+     *
+     * Only one instance of the core service should exist per environment.
+     */
+    readonly CORE: "core";
+    /**
+     * Rest API service.
+     */
+    readonly REST_API: "rest-api";
+    /**
+     * Global Infrastructure stack (Route53, ACM).
+     */
+    readonly GLOBAL: "global";
+    /**
+     * Data service (DynamoDB, S3, persistence).
+     */
+    readonly DATA: "data";
+};
+/**
+ * Type representing valid OpenHI service type values. This is a union of the
+ * values from {@link OPEN_HI_SERVICE_TYPE}.
+ *
+ * @public
+ */
+export type OpenHiServiceType = (typeof OPEN_HI_SERVICE_TYPE)[keyof typeof OPEN_HI_SERVICE_TYPE];
+/**
+ * Properties for creating an {@link OpenHiService} stack.
+ *
+ * @public
+ */
+export interface OpenHiServiceProps extends StackProps {
+    /**
+     * Optional branch name override.
+     */
+    readonly branchName?: string;
+    /**
+     * Optional repository name override.
+     */
+    readonly repoName?: string;
+    /**
+     * Optional application name override.
+     */
+    readonly appName?: string;
+    /**
+     * Default release branch name.
+     */
+    readonly defaultReleaseBranch?: string;
+    /**
+     * The removal policy for persistent stack resources.
+     */
+    readonly removalPolicy?: RemovalPolicy;
+    /**
+     * Environment configuration for this service.
+     */
+    readonly config?: OpenHiEnvironmentConfig;
+    /**
+     * A constant that identifies the service type.
+     */
+    readonly serviceType?: OpenHiServiceType;
+    /**
+     * Optional props for the core construct.
+     */
+    readonly coreProps?: CoreProps;
+}
+/**
+ * Represents an OpenHI service stack within the OpenHI platform.
+ */
+export declare class OpenHiService extends Stack {
+    ohEnv: OpenHiEnvironment;
+    props: OpenHiServiceProps;
+    /**
+     * The service/stack ID that was passed to the constructor.
+     */
+    readonly serviceId: string;
+    /**
+     * The deployment target role identifier.
+     */
+    readonly deploymentTargetRole: string;
+    /**
+     * Repository name used in resource tagging.
+     */
+    readonly repoName: string;
+    /**
+     * Application name identifier.
+     */
+    readonly appName: string;
+    /**
+     * Default release branch name.
+     */
+    readonly defaultReleaseBranch: string;
+    /**
+     * Branch name used when calculating resource names and hashes.
+     */
+    readonly branchName: string;
+    /**
+     * Short hash unique to the deployment target (app name, deployment target role, account, region).
+     */
+    readonly environmentHash: string;
+    /**
+     * Short hash unique to the environment and branch combination.
+     */
+    readonly branchHash: string;
+    /**
+     * Short hash unique to the specific stack/service.
+     */
+    readonly stackHash: string;
+    /**
+     * The removal policy for persistent stack resources.
+     */
+    readonly removalPolicy: RemovalPolicy;
+    /**
+     * Environment configuration for this service.
+     * This is either the value passed in or the default config
+     */
+    readonly config: OpenHiEnvironmentConfig;
+    /**
+     * A constant that identifies the service type.
+     */
+    readonly serviceType: (typeof OPEN_HI_SERVICE_TYPE)[keyof typeof OPEN_HI_SERVICE_TYPE] | string;
+    /**
+     * Core construct containing shared infrastructure.
+     */
+    /**
+     * Creates a new OpenHI service stack.
+     *
+     * @param ohEnv - The OpenHI environment (stage) this service belongs to
+     * @param id - Unique identifier for this service stack (e.g., "user-service")
+     * @param props - Optional properties for configuring the service
+     *
+     * @throws {Error} If account and region are not defined in props or environment
+     *
+     */
+    constructor(ohEnv: OpenHiEnvironment, id: string, props?: OpenHiServiceProps);
+    /**
+     * Creates or returns the core construct for shared infrastructure.
+     */
+    /**
+     * DNS prefix for this branche's child zone.
+     */
+    get childZonePrefix(): string;
+}