@openhi/platform 0.0.0 → 0.0.2

package/lib/{openhi.d.ts → index.d.mts}

@@ -1,8 +1,40 @@
-import { MonorepoProject, MonorepoProjectOptions } from "@codedrifters/configulator";
-import { OpenHiConfig } from "@openhi/config";
-import { SetOptional } from "type-fest";
-import { OpenHiService } from "./service";
-export interface OpenHiOptions {
+import { MonorepoProjectOptions, MonorepoProject } from '@codedrifters/configulator';
+import { OpenHiConfig } from '@openhi/config';
+import { ValueOf, SetOptional } from 'type-fest';
+import { awscdk } from 'projen';
+
+declare const OPEN_HI_SERVICE_TYPE: {
+    readonly AUTH: "auth";
+    readonly DATA_SERVICE: "data";
+    readonly GLOBAL: "global";
+    readonly INTEGRATION: "integration";
+    readonly REST_API: "rest-api";
+};
+interface OpenHiServiceOptions {
+    /**
+     * Configuration for this service.
+     *
+     * @default uses the global default config.
+     */
+    readonly config: OpenHiConfig;
+    /**
+     * What type of service is this?
+     */
+    readonly type: ValueOf<typeof OPEN_HI_SERVICE_TYPE>;
+}
+declare class OpenHiService {
+    openHi: OpenHi;
+    id: string;
+    options: OpenHiServiceOptions;
+    readonly project: awscdk.AwsCdkTypeScriptApp;
+    constructor(openHi: OpenHi, id: string, options: OpenHiServiceOptions);
+    private addDeploymentTarget;
+    get constructName(): string;
+    get outDir(): string;
+    get serviceName(): string;
+}
+
+interface OpenHiOptions {
     /*****************************************************************************
      *
      * Root Project Configuration Options
@@ -41,16 +73,12 @@ export interface OpenHiOptions {
      * Rest API Service Config
      */
     readonly restApiServiceConfig?: OpenHiConfig;
-    /**
-     * Core Service Config
-     */
-    readonly coreServiceConfig?: OpenHiConfig;
     /**
      * Data Service Config (DynamoDB FHIR store, S3, etc.)
      */
     readonly dataServiceConfig?: OpenHiConfig;
 }
-export declare class OpenHi {
+declare class OpenHi {
     /**
      * Final options used to build this instance.
      */
@@ -65,24 +93,22 @@ export declare class OpenHi {
      */
     readonly id: string;
     /**
-     * Global service (deployed first; Core and data services depend on it).
+     * Global service (deployed first; Auth, data service, and other stacks depend on it).
      */
     readonly global: OpenHiService;
     /**
-     * Auth service (deployed before Core; Core and data services depend on it).
+     * Auth service (deployed first; data service, REST API, and data services depend on it).
      */
     readonly auth: OpenHiService;
     /**
      * Rest API service
      */
     readonly restApi: OpenHiService;
-    /**
-     * Core service
-     */
-    readonly core: OpenHiService;
     /**
      * Data service (DynamoDB FHIR store, S3, and other persistence).
      */
     readonly data: OpenHiService;
     constructor(options?: OpenHiOptions);
 }
+
+export { OPEN_HI_SERVICE_TYPE, OpenHi, type OpenHiOptions, OpenHiService, type OpenHiServiceOptions };

package/lib/index.d.ts

@@ -1,2 +1,195 @@
-export * from "./openhi";
-export * from "./service";
+import { MonorepoProjectOptions, MonorepoProject } from '@codedrifters/configulator';
+import { SetOptional, ValueOf } from 'type-fest';
+import { awscdk } from 'projen';
+
+/*******************************************************************************
+ *
+ * OpenHi Config
+ *
+ * These types are kept in their own package to prevent dependency conflicts and
+ * conditions between @openhi/constructs and @openhi/platform.
+ *
+ ******************************************************************************/
+/**
+ * Stage Types
+ *
+ * What stage of deployment is this? Dev, staging, or prod?
+ */
+declare const OPEN_HI_STAGE: {
+    /**
+     * Development environment, typically used for testing and development.
+     */
+    readonly DEV: "dev";
+    /**
+     * Staging environment, used for pre-production testing.
+     */
+    readonly STAGE: "stage";
+    /**
+     * Production environment, used for live deployments.
+     */
+    readonly PROD: "prod";
+};
+/**
+ * Deployment Target Role
+ *
+ * Is this (account, region) the primary or a secondary deployment target for the stage?
+ * Works for both multi-region (different regions) and cellular (same region, different accounts).
+ */
+declare const OPEN_HI_DEPLOYMENT_TARGET_ROLE: {
+    /**
+     * The primary deployment target for this stage (main account/region).
+     * For example, the base DynamoDB region for global tables.
+     */
+    readonly PRIMARY: "primary";
+    /**
+     * A secondary deployment target for this stage (additional account/region).
+     * For example, a replica region for a global DynamoDB table, or another cell in the same region.
+     */
+    readonly SECONDARY: "secondary";
+};
+interface OpenHiEnvironmentConfig {
+    account: string;
+    region: string;
+    /**
+     * Route53 zone containing DNS for this service.
+     */
+    hostedZoneId?: string;
+    zoneName?: string;
+}
+/**
+ * Represents the configuration for OpenHi services across different stages and
+ * deployment targets.
+ */
+interface OpenHiConfig {
+    versions?: {
+        cdk?: {
+            cdkLibVersion?: string;
+            cdkCliVersion?: string;
+        };
+    };
+    deploymentTargets?: {
+        [OPEN_HI_STAGE.DEV]?: {
+            [OPEN_HI_DEPLOYMENT_TARGET_ROLE.PRIMARY]?: OpenHiEnvironmentConfig;
+            [OPEN_HI_DEPLOYMENT_TARGET_ROLE.SECONDARY]?: Array<OpenHiEnvironmentConfig>;
+        };
+        [OPEN_HI_STAGE.STAGE]?: {
+            [OPEN_HI_DEPLOYMENT_TARGET_ROLE.PRIMARY]?: OpenHiEnvironmentConfig;
+            [OPEN_HI_DEPLOYMENT_TARGET_ROLE.SECONDARY]?: Array<OpenHiEnvironmentConfig>;
+        };
+        [OPEN_HI_STAGE.PROD]?: {
+            [OPEN_HI_DEPLOYMENT_TARGET_ROLE.PRIMARY]?: OpenHiEnvironmentConfig;
+            [OPEN_HI_DEPLOYMENT_TARGET_ROLE.SECONDARY]?: Array<OpenHiEnvironmentConfig>;
+        };
+    };
+}
+
+declare const OPEN_HI_SERVICE_TYPE: {
+    readonly AUTH: "auth";
+    readonly DATA_SERVICE: "data";
+    readonly GLOBAL: "global";
+    readonly INTEGRATION: "integration";
+    readonly REST_API: "rest-api";
+};
+interface OpenHiServiceOptions {
+    /**
+     * Configuration for this service.
+     *
+     * @default uses the global default config.
+     */
+    readonly config: OpenHiConfig;
+    /**
+     * What type of service is this?
+     */
+    readonly type: ValueOf<typeof OPEN_HI_SERVICE_TYPE>;
+}
+declare class OpenHiService {
+    openHi: OpenHi;
+    id: string;
+    options: OpenHiServiceOptions;
+    readonly project: awscdk.AwsCdkTypeScriptApp;
+    constructor(openHi: OpenHi, id: string, options: OpenHiServiceOptions);
+    private addDeploymentTarget;
+    get constructName(): string;
+    get outDir(): string;
+    get serviceName(): string;
+}
+
+interface OpenHiOptions {
+    /*****************************************************************************
+     *
+     * Root Project Configuration Options
+     *
+     * Configuration options for the root monorepo project that contains all
+     * OpenHi services and coordinate releases and builds.
+     *
+     ****************************************************************************/
+    readonly rootProjectOptions?: SetOptional<MonorepoProjectOptions, "name">;
+    /**
+     * Monorepo root project, if using an existing project.
+     */
+    readonly rootProject?: MonorepoProject;
+    /*****************************************************************************
+     *
+     * Service Configuration Options
+     *
+     * These options are used to configure the various services within the OpenHi
+     * framework. Each service can have its own configuration settings, which will
+     * be merged with the default configuration.
+     *
+     ****************************************************************************/
+    /**
+     * Default configuration used in all services with undefined configs.
+     */
+    readonly defaultConfig?: OpenHiConfig;
+    /**
+     * Global Service Config
+     */
+    readonly globalServiceConfig?: OpenHiConfig;
+    /**
+     * Auth Service Config
+     */
+    readonly authServiceConfig?: OpenHiConfig;
+    /**
+     * Rest API Service Config
+     */
+    readonly restApiServiceConfig?: OpenHiConfig;
+    /**
+     * Data Service Config (DynamoDB FHIR store, S3, etc.)
+     */
+    readonly dataServiceConfig?: OpenHiConfig;
+}
+declare class OpenHi {
+    /**
+     * Final options used to build this instance.
+     */
+    options: OpenHiOptions;
+    /**
+     * Monorepo root project, either passed in as an argument or generated in
+     * this component
+     */
+    readonly rootProject?: MonorepoProject;
+    /**
+     * Test identifier for this instance.
+     */
+    readonly id: string;
+    /**
+     * Global service (deployed first; Auth, data service, and other stacks depend on it).
+     */
+    readonly global: OpenHiService;
+    /**
+     * Auth service (deployed first; data service, REST API, and data services depend on it).
+     */
+    readonly auth: OpenHiService;
+    /**
+     * Rest API service
+     */
+    readonly restApi: OpenHiService;
+    /**
+     * Data service (DynamoDB FHIR store, S3, and other persistence).
+     */
+    readonly data: OpenHiService;
+    constructor(options?: OpenHiOptions);
+}
+
+export { OPEN_HI_SERVICE_TYPE, OpenHi, OpenHiService };
+export type { OpenHiOptions, OpenHiServiceOptions };