@openhi/constructs 0.0.131 → 0.0.132

package/lib/index.d.mts

@@ -1708,16 +1708,14 @@ declare class OpenHiGlobalService extends OpenHiService {
 /**
  * Caller-supplied portion of the runtime-config payload exposed through the
  * public `GET /control/runtime-config` route. The three Cognito IDs are
- * resolved inside the service via SSM lookups against the auth stack, so the
- * caller only supplies the values the service cannot derive itself: the
- * OAuth redirect URI (depends on the website's domain) and the API base URL
- * (depends on the integration path the website's CloudFront uses).
+ * resolved inside the service via SSM lookups against the auth stack, and
+ * the API base URL is derived from this stack's own custom domain — so the
+ * caller only supplies the OAuth redirect URI (depends on the website's
+ * domain).
  */
 interface OpenHiRestApiRuntimeConfig {
     /** OAuth redirect URI registered on the User Pool client (e.g. https://admin.example.com/oauth/callback). */
     readonly cognitoRedirectUri: string;
-    /** Base URL the admin-console uses to reach the REST API (typically a same-origin `/api` relative path). */
-    readonly apiBaseUrl: string;
 }
 interface OpenHiRestApiServiceProps extends OpenHiServiceProps {
     /**
@@ -1729,10 +1727,9 @@ interface OpenHiRestApiServiceProps extends OpenHiServiceProps {
      * Values exposed through the public `GET /control/runtime-config` route.
      * When supplied, the service plumbs five `OPENHI_RUNTIME_CONFIG_*`
      * environment variables to the REST API Lambda — the three Cognito IDs
-     * are resolved internally from the auth stack via SSM, and the two
-     * fields on this prop are passed verbatim. The website's CloudFront
-     * distribution proxies `/api/*` to this endpoint so the admin-console can
-     * fetch its bootstrap config same-origin and stay branch-agnostic.
+     * are resolved internally from the auth stack via SSM, the API base URL
+     * is derived from this stack's own custom domain (e.g.
+     * `https://api.<zone>`), and the OAuth redirect URI is passed verbatim.
      *
      * Omit to leave the route returning 500 (missing-env-var diagnostic).
      */
@@ -1775,6 +1772,12 @@ declare class OpenHiRestApiService extends OpenHiService {
     /** Override so this.props is typed with this service's options (e.g. rootHttpApiProps). */
     props: OpenHiRestApiServiceProps;
     readonly rootHttpApi: RootHttpApi;
+    /**
+     * REST API custom domain (bare hostname, no scheme — e.g.
+     * `api.dev.openhi.org`). Captured so {@link resolveRuntimeConfigEnvVars}
+     * can derive the public `apiBaseUrl` without callers having to hardcode it.
+     */
+    private readonly apiDomainName;
     constructor(ohEnv: OpenHiEnvironment, props?: OpenHiRestApiServiceProps);
     /**
      * Validates that config required for the REST API stack is present.
@@ -1833,7 +1836,8 @@ declare class OpenHiRestApiService extends OpenHiService {
      * The three Cognito IDs are resolved via SSM lookups against the auth
      * stack from a dedicated sub-scope (`runtime-config`) so they don't
      * collide with the user-pool / user-pool-client constructs already
-     * created in {@link createRootHttpApi}.
+     * created in {@link createRootHttpApi}. `apiBaseUrl` is derived from
+     * this stack's own custom domain so callers don't have to hardcode it.
      */
     protected resolveRuntimeConfigEnvVars(): Record<string, string> | undefined;
 }

package/lib/index.d.ts

@@ -2345,16 +2345,14 @@ declare class OpenHiGlobalService extends OpenHiService {
 /**
  * Caller-supplied portion of the runtime-config payload exposed through the
  * public `GET /control/runtime-config` route. The three Cognito IDs are
- * resolved inside the service via SSM lookups against the auth stack, so the
- * caller only supplies the values the service cannot derive itself: the
- * OAuth redirect URI (depends on the website's domain) and the API base URL
- * (depends on the integration path the website's CloudFront uses).
+ * resolved inside the service via SSM lookups against the auth stack, and
+ * the API base URL is derived from this stack's own custom domain — so the
+ * caller only supplies the OAuth redirect URI (depends on the website's
+ * domain).
  */
 interface OpenHiRestApiRuntimeConfig {
     /** OAuth redirect URI registered on the User Pool client (e.g. https://admin.example.com/oauth/callback). */
     readonly cognitoRedirectUri: string;
-    /** Base URL the admin-console uses to reach the REST API (typically a same-origin `/api` relative path). */
-    readonly apiBaseUrl: string;
 }
 interface OpenHiRestApiServiceProps extends OpenHiServiceProps {
     /**
@@ -2366,10 +2364,9 @@ interface OpenHiRestApiServiceProps extends OpenHiServiceProps {
      * Values exposed through the public `GET /control/runtime-config` route.
      * When supplied, the service plumbs five `OPENHI_RUNTIME_CONFIG_*`
      * environment variables to the REST API Lambda — the three Cognito IDs
-     * are resolved internally from the auth stack via SSM, and the two
-     * fields on this prop are passed verbatim. The website's CloudFront
-     * distribution proxies `/api/*` to this endpoint so the admin-console can
-     * fetch its bootstrap config same-origin and stay branch-agnostic.
+     * are resolved internally from the auth stack via SSM, the API base URL
+     * is derived from this stack's own custom domain (e.g.
+     * `https://api.<zone>`), and the OAuth redirect URI is passed verbatim.
      *
      * Omit to leave the route returning 500 (missing-env-var diagnostic).
      */
@@ -2412,6 +2409,12 @@ declare class OpenHiRestApiService extends OpenHiService {
     /** Override so this.props is typed with this service's options (e.g. rootHttpApiProps). */
     props: OpenHiRestApiServiceProps;
     readonly rootHttpApi: RootHttpApi;
+    /**
+     * REST API custom domain (bare hostname, no scheme — e.g.
+     * `api.dev.openhi.org`). Captured so {@link resolveRuntimeConfigEnvVars}
+     * can derive the public `apiBaseUrl` without callers having to hardcode it.
+     */
+    private readonly apiDomainName;
     constructor(ohEnv: OpenHiEnvironment, props?: OpenHiRestApiServiceProps);
     /**
      * Validates that config required for the REST API stack is present.
@@ -2470,7 +2473,8 @@ declare class OpenHiRestApiService extends OpenHiService {
      * The three Cognito IDs are resolved via SSM lookups against the auth
      * stack from a dedicated sub-scope (`runtime-config`) so they don't
      * collide with the user-pool / user-pool-client constructs already
-     * created in {@link createRootHttpApi}.
+     * created in {@link createRootHttpApi}. `apiBaseUrl` is derived from
+     * this stack's own custom domain so callers don't have to hardcode it.
      */
     protected resolveRuntimeConfigEnvVars(): Record<string, string> | undefined;
 }

package/lib/index.js

@@ -7105,9 +7105,9 @@ var _OpenHiRestApiService = class _OpenHiRestApiService extends OpenHiService {
     this.validateConfig(props);
     const hostedZone = this.createHostedZone();
     const certificate = this.createCertificate();
-    const apiDomainName = this.createApiDomainNameString(hostedZone);
-    this.createRestApiBaseUrlParameter(apiDomainName);
-    this.createRestApiDomainNameParameter(apiDomainName);
+    this.apiDomainName = this.createApiDomainNameString(hostedZone);
+    this.createRestApiBaseUrlParameter(this.apiDomainName);
+    this.createRestApiDomainNameParameter(this.apiDomainName);
     const domainName = this.createDomainName(hostedZone, certificate);
     this.rootHttpApi = this.createRootHttpApi(domainName);
     this.createRestApiLambdaAndRoutes(hostedZone, domainName);
@@ -7371,7 +7371,8 @@ var _OpenHiRestApiService = class _OpenHiRestApiService extends OpenHiService {
    * The three Cognito IDs are resolved via SSM lookups against the auth
    * stack from a dedicated sub-scope (`runtime-config`) so they don't
    * collide with the user-pool / user-pool-client constructs already
-   * created in {@link createRootHttpApi}.
+   * created in {@link createRootHttpApi}. `apiBaseUrl` is derived from
+   * this stack's own custom domain so callers don't have to hardcode it.
    */
   resolveRuntimeConfigEnvVars() {
     if (this.props.runtimeConfig === void 0) {
@@ -7386,7 +7387,7 @@ var _OpenHiRestApiService = class _OpenHiRestApiService extends OpenHiService {
       OPENHI_RUNTIME_CONFIG_COGNITO_USER_POOL_CLIENT_ID: userPoolClient.userPoolClientId,
       OPENHI_RUNTIME_CONFIG_COGNITO_DOMAIN_URL: cognitoDomainUrl,
       OPENHI_RUNTIME_CONFIG_COGNITO_REDIRECT_URI: this.props.runtimeConfig.cognitoRedirectUri,
-      OPENHI_RUNTIME_CONFIG_API_BASE_URL: this.props.runtimeConfig.apiBaseUrl
+      OPENHI_RUNTIME_CONFIG_API_BASE_URL: `https://${this.apiDomainName}`
     };
   }
 };