@infoxchange/make-it-so 2.0.1 → 2.1.0

package/README.md

@@ -64,6 +64,23 @@ const site = new IxNextjsSite(stack, "Site", {
 });
 ```
 
+### CDK Construct - IxApi
+
+Deploys an instance of API Gateway. IxApi extends [SST's Api](https://docs.sst.dev/constructs/Api) and takes the exact same props.
+
+It will automatically create certificates and DNS records for a single domain that the API should deploy to. If the props `customDomain` is not set the first site domain provided by the IX deployment pipeline will be used as the domain. Explicitly setting `customDomain` to `undefined` will ensure no customDomain is used. Regardless of if a custom domain is set, the API Gateway will still be accessible via the 'api-id.execute-api.region.amazonaws.com' url.
+
+```typescript
+import { IxApi } from "@infoxchange/make-it-so/cdk-constructs";
+
+const site = new IxApi(stack, "api", {
+  // Included by default:
+  // customDomain: {
+  //   domainName: ixDeployConfig.siteDomains[0],
+  // },
+});
+```
+
 ### CDK Construct - IxElasticache
 
 Deploys an AWS Elasticache cluster, either the redis or the memcached flavour.
@@ -204,8 +221,12 @@ important that sst and aws lib version match those used in ix-deploy-support
 
 Honestly I've never seen Star Trek but I figured the name is appropriate since the goal of this library is to allow you, the user, to deploy applications by stating what you want and letting someone else handle the nitty gritty details of how to actually implement it.
 
-# Contributing
+# Development and Contributing
 
 Changes to the main branch automatically trigger the CI to build and publish to npm. We do this with [semantic-release](https://semantic-release.gitbook.io/) which uses commit messages to determine what the new version number should be.
 
 Commit messages must be formatted in the [Conventional Commits](https://www.conventionalcommits.org) style to allow semantic-release to generate release notes based on the git history. To help with this the CLI tool for creating a commit with a valid commit message can be used via `npm run commit`.
+
+If adding a new construct the easiest way to develop it maybe by building it in whatever app repo it is intended to be used in. When it appears to be working correctly it can be moved into make-it-so and the app can be updated to import that construct from make-it-so.
+
+To test change a change in make-it-so create a branch starting with the prefix "internal-testing-". When pushed the CI will release a new package with a pre-release version. It'll look a little something like `2.1.3-internal-testing-name-of-feature.3`. A serverless app using make-it-so can be modified to use this package version and then deployed to a dev environment to test that the make-it-so changes are functioning correctly. Once a change has been merged into main and there are no serverless apps using the pre-release package any more it's a good idea to [delete that version](https://docs.npmjs.com/unpublishing-packages-from-the-registry#unpublishing-a-single-version-of-a-package) to keep the [npm package version history clean](https://www.npmjs.com/package/@infoxchange/make-it-so?activeTab=versions).

package/dist/cdk-constructs/IxApi.d.ts

@@ -0,0 +1,12 @@
+import { Api } from "sst/constructs";
+type ConstructScope = ConstructorParameters<typeof Api>[0];
+type ConstructId = ConstructorParameters<typeof Api>[1];
+type ConstructProps = Exclude<ConstructorParameters<typeof Api>[2], undefined>;
+export declare class IxApi extends Api {
+    constructor(scope: ConstructScope, id: ConstructId, props?: ConstructProps);
+    private static setupCustomDomain;
+    private static setupCertificate;
+    private createDnsRecords;
+}
+export {};
+//# sourceMappingURL=IxApi.d.ts.map

package/dist/cdk-constructs/IxApi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IxApi.d.ts","sourceRoot":"","sources":["../../src/cdk-constructs/IxApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAMrC,KAAK,cAAc,GAAG,qBAAqB,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AAC3D,KAAK,WAAW,GAAG,qBAAqB,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AACxD,KAAK,cAAc,GAAG,OAAO,CAAC,qBAAqB,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;AAE/E,qBAAa,KAAM,SAAQ,GAAG;gBAE1B,KAAK,EAAE,cAAc,EACrB,EAAE,EAAE,WAAW,EACf,KAAK,GAAE,cAAmB;IAc5B,OAAO,CAAC,MAAM,CAAC,iBAAiB;IAgBhC,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAuB/B,OAAO,CAAC,gBAAgB;CAazB"}

package/dist/cdk-constructs/IxApi.js

@@ -0,0 +1,56 @@
+import { Api } from "sst/constructs";
+import { IxCertificate } from "./IxCertificate.js";
+import { IxDnsRecord } from "./IxDnsRecord.js";
+import ixDeployConfig from "../deployConfig.js";
+import { convertToBase62Hash } from "../shared.js";
+export class IxApi extends Api {
+    constructor(scope, id, props = {}) {
+        if (ixDeployConfig.isIxDeploy) {
+            IxApi.setupCustomDomain(scope, id, props);
+        }
+        super(scope, id, props);
+        if (ixDeployConfig.isIxDeploy) {
+            this.createDnsRecords(scope);
+        }
+    }
+    // This must be static because we need to call it in the constructor before super
+    static setupCustomDomain(scope, id, props) {
+        // Default to using domains names passed in by the pipeline as the custom domain
+        if (ixDeployConfig.isIxDeploy && !("customDomain" in props)) {
+            props.customDomain = {
+                domainName: ixDeployConfig.siteDomains[0],
+            };
+        }
+        this.setupCertificate(scope, id, props);
+    }
+    // This must be static because we need to call it in the constructor before super
+    static setupCertificate(scope, id, props) {
+        if (!props?.customDomain)
+            return;
+        if (typeof props.customDomain === "string") {
+            props.customDomain = { domainName: props.customDomain };
+        }
+        const domainName = props.customDomain.domainName;
+        if (domainName) {
+            const domainCert = new IxCertificate(scope, id + "-IxCertificate", {
+                domainName,
+                region: "ap-southeast-2", // API Gateway wants southeast-2.
+            });
+            props.customDomain.isExternalDomain = true;
+            props.customDomain.cdk = props.customDomain.cdk ?? {};
+            props.customDomain.cdk.certificate = domainCert.acmCertificate;
+        }
+    }
+    createDnsRecords(scope) {
+        if (this.cdk.domainName?.name && this.cdk.domainName?.regionalDomainName) {
+            const domainNameLogicalId = convertToBase62Hash(this.cdk.domainName.name);
+            // API Gateway has a separate domain for using with a CNAME (regionalDomainName)
+            new IxDnsRecord(scope, `DnsRecord-${domainNameLogicalId}`, {
+                type: "CNAME",
+                name: this.cdk.domainName.name,
+                value: this.cdk.domainName?.regionalDomainName,
+                ttl: 900,
+            });
+        }
+    }
+}

package/dist/cdk-constructs/IxNextjsSite.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"IxNextjsSite.d.ts","sourceRoot":"","sources":["../../src/cdk-constructs/IxNextjsSite.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAO5C,KAAK,cAAc,GAAG,qBAAqB,CAAC,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;AAClE,KAAK,WAAW,GAAG,qBAAqB,CAAC,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;AAC/D,KAAK,cAAc,GAAG,OAAO,CAC3B,qBAAqB,CAAC,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC,EAC3C,SAAS,CACV,CAAC;AAEF,qBAAa,YAAa,SAAQ,UAAU;gBAExC,KAAK,EAAE,cAAc,EACrB,EAAE,EAAE,WAAW,EACf,KAAK,GAAE,cAAmB;IAiB5B,OAAO,CAAC,MAAM,CAAC,oBAAoB;IAuBnC,OAAO,CAAC,MAAM,CAAC,iBAAiB;IAiBhC,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAgC/B,OAAO,CAAC,gBAAgB;IAgBxB,IAAW,aAAa,IAAI,MAAM,EAAE,CASnC;IAED,IAAW,mBAAmB,IAAI,MAAM,GAAG,IAAI,CAO9C;IAED,IAAW,WAAW,IAAI,MAAM,GAAG,IAAI,CAKtC;IAED,IAAW,kBAAkB,IAAI,MAAM,EAAE,CAKxC;IAEM,aAAa,qBACwD;IAErE,aAAa,SAAmC;CACxD"}
+{"version":3,"file":"IxNextjsSite.d.ts","sourceRoot":"","sources":["../../src/cdk-constructs/IxNextjsSite.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAQ5C,KAAK,cAAc,GAAG,qBAAqB,CAAC,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;AAClE,KAAK,WAAW,GAAG,qBAAqB,CAAC,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;AAC/D,KAAK,cAAc,GAAG,OAAO,CAC3B,qBAAqB,CAAC,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC,EAC3C,SAAS,CACV,CAAC;AAEF,qBAAa,YAAa,SAAQ,UAAU;gBAExC,KAAK,EAAE,cAAc,EACrB,EAAE,EAAE,WAAW,EACf,KAAK,GAAE,cAAmB;IAiB5B,OAAO,CAAC,MAAM,CAAC,oBAAoB;IAuBnC,OAAO,CAAC,MAAM,CAAC,iBAAiB;IAiBhC,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAgC/B,OAAO,CAAC,gBAAgB;IAgBxB,IAAW,aAAa,IAAI,MAAM,EAAE,CASnC;IAED,IAAW,mBAAmB,IAAI,MAAM,GAAG,IAAI,CAO9C;IAED,IAAW,WAAW,IAAI,MAAM,GAAG,IAAI,CAKtC;IAED,IAAW,kBAAkB,IAAI,MAAM,EAAE,CAKxC;IAEM,aAAa,qBACwD;IAErE,aAAa,SAAmC;CACxD"}

package/dist/cdk-constructs/IxNextjsSite.js

@@ -4,6 +4,7 @@ import { CloudFrontTarget } from "aws-cdk-lib/aws-route53-targets";
 import { IxVpcDetails } from "./IxVpcDetails.js";
 import { IxDnsRecord } from "./IxDnsRecord.js";
 import ixDeployConfig from "../deployConfig.js";
+import { convertToBase62Hash } from "../shared.js";
 export class IxNextjsSite extends NextjsSite {
     constructor(scope, id, props = {}) {
         const isIxDeploy = !!process.env.IX_APP_NAME;
@@ -118,16 +119,3 @@ export class IxNextjsSite extends NextjsSite {
     primaryDomain = this.primaryCustomDomain ?? this.cdk?.distribution.distributionDomainName;
     primaryOrigin = `https://${this.primaryDomain}`;
 }
-function convertToBase62Hash(string) {
-    const base62Chars = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
-    let hash = "";
-    let num = 0;
-    for (let i = 0; i < string.length; i++) {
-        num += string.charCodeAt(i);
-    }
-    while (num > 0) {
-        hash = base62Chars[num % 62] + hash;
-        num = Math.floor(num / 62);
-    }
-    return hash;
-}

package/dist/cdk-constructs/index.d.ts

@@ -3,4 +3,5 @@ export * from "./IxCertificate.js";
 export * from "./IxDnsRecord.js";
 export * from "./IxNextjsSite.js";
 export * from "./IxElasticache.js";
+export * from "./IxApi.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/cdk-constructs/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cdk-constructs/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cdk-constructs/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,YAAY,CAAC"}

package/dist/cdk-constructs/index.js

@@ -3,3 +3,4 @@ export * from "./IxCertificate.js";
 export * from "./IxDnsRecord.js";
 export * from "./IxNextjsSite.js";
 export * from "./IxElasticache.js";
+export * from "./IxApi.js";

package/dist/shared.d.ts

@@ -1,3 +1,4 @@
+export declare function convertToBase62Hash(string: string): string;
 export declare function remapKeys(object: Record<string, unknown>, keyMap: Record<string, string>): {
     [k: string]: unknown;
 };

package/dist/shared.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../src/shared.ts"],"names":[],"mappings":"AAAA,wBAAgB,SAAS,CACvB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;;EAQ/B"}
+{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../src/shared.ts"],"names":[],"mappings":"AAAA,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAa1D;AAED,wBAAgB,SAAS,CACvB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;;EAQ/B"}

package/dist/shared.js

@@ -1,3 +1,16 @@
+export function convertToBase62Hash(string) {
+    const base62Chars = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
+    let hash = "";
+    let num = 0;
+    for (let i = 0; i < string.length; i++) {
+        num += string.charCodeAt(i);
+    }
+    while (num > 0) {
+        hash = base62Chars[num % 62] + hash;
+        num = Math.floor(num / 62);
+    }
+    return hash;
+}
 export function remapKeys(object, keyMap) {
     return Object.fromEntries(Object.entries(object).map(([key, value]) => {
         const newKey = keyMap[key] ?? key;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@infoxchange/make-it-so",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "description": "Makes deploying services to IX infra easy",
   "repository": "github:infoxchange/make-it-so",
   "type": "module",

package/src/cdk-constructs/IxApi.ts

@@ -0,0 +1,81 @@
+import { Api } from "sst/constructs";
+import { IxCertificate } from "./IxCertificate.js";
+import { IxDnsRecord } from "./IxDnsRecord.js";
+import ixDeployConfig from "../deployConfig.js";
+import { convertToBase62Hash } from "../shared.js";
+
+type ConstructScope = ConstructorParameters<typeof Api>[0];
+type ConstructId = ConstructorParameters<typeof Api>[1];
+type ConstructProps = Exclude<ConstructorParameters<typeof Api>[2], undefined>;
+
+export class IxApi extends Api {
+  constructor(
+    scope: ConstructScope,
+    id: ConstructId,
+    props: ConstructProps = {},
+  ) {
+    if (ixDeployConfig.isIxDeploy) {
+      IxApi.setupCustomDomain(scope, id, props);
+    }
+
+    super(scope, id, props);
+
+    if (ixDeployConfig.isIxDeploy) {
+      this.createDnsRecords(scope);
+    }
+  }
+
+  // This must be static because we need to call it in the constructor before super
+  private static setupCustomDomain(
+    scope: ConstructScope,
+    id: ConstructId,
+    props: ConstructProps,
+  ): void {
+    // Default to using domains names passed in by the pipeline as the custom domain
+    if (ixDeployConfig.isIxDeploy && !("customDomain" in props)) {
+      props.customDomain = {
+        domainName: ixDeployConfig.siteDomains[0],
+      };
+    }
+
+    this.setupCertificate(scope, id, props);
+  }
+
+  // This must be static because we need to call it in the constructor before super
+  private static setupCertificate(
+    scope: ConstructScope,
+    id: ConstructId,
+    props: ConstructProps,
+  ): void {
+    if (!props?.customDomain) return;
+
+    if (typeof props.customDomain === "string") {
+      props.customDomain = { domainName: props.customDomain };
+    }
+
+    const domainName = props.customDomain.domainName;
+    if (domainName) {
+      const domainCert = new IxCertificate(scope, id + "-IxCertificate", {
+        domainName,
+        region: "ap-southeast-2", // API Gateway wants southeast-2.
+      });
+      props.customDomain.isExternalDomain = true;
+      props.customDomain.cdk = props.customDomain.cdk ?? {};
+      props.customDomain.cdk.certificate = domainCert.acmCertificate;
+    }
+  }
+
+  private createDnsRecords(scope: ConstructScope) {
+    if (this.cdk.domainName?.name && this.cdk.domainName?.regionalDomainName) {
+      const domainNameLogicalId = convertToBase62Hash(this.cdk.domainName.name);
+
+      // API Gateway has a separate domain for using with a CNAME (regionalDomainName)
+      new IxDnsRecord(scope, `DnsRecord-${domainNameLogicalId}`, {
+        type: "CNAME",
+        name: this.cdk.domainName.name,
+        value: this.cdk.domainName?.regionalDomainName,
+        ttl: 900,
+      });
+    }
+  }
+}

package/src/cdk-constructs/IxNextjsSite.ts

@@ -4,6 +4,7 @@ import { CloudFrontTarget } from "aws-cdk-lib/aws-route53-targets";
 import { IxVpcDetails } from "./IxVpcDetails.js";
 import { IxDnsRecord } from "./IxDnsRecord.js";
 import ixDeployConfig from "../deployConfig.js";
+import { convertToBase62Hash } from "../shared.js";
 
 type ConstructScope = ConstructorParameters<typeof NextjsSite>[0];
 type ConstructId = ConstructorParameters<typeof NextjsSite>[1];
@@ -160,18 +161,3 @@ export class IxNextjsSite extends NextjsSite {
 
   public primaryOrigin = `https://${this.primaryDomain}`;
 }
-
-function convertToBase62Hash(string: string): string {
-  const base62Chars =
-    "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
-  let hash = "";
-  let num = 0;
-  for (let i = 0; i < string.length; i++) {
-    num += string.charCodeAt(i);
-  }
-  while (num > 0) {
-    hash = base62Chars[num % 62] + hash;
-    num = Math.floor(num / 62);
-  }
-  return hash;
-}

package/src/cdk-constructs/index.ts

@@ -3,3 +3,4 @@ export * from "./IxCertificate.js";
 export * from "./IxDnsRecord.js";
 export * from "./IxNextjsSite.js";
 export * from "./IxElasticache.js";
+export * from "./IxApi.js";

package/src/shared.ts

@@ -1,3 +1,18 @@
+export function convertToBase62Hash(string: string): string {
+  const base62Chars =
+    "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
+  let hash = "";
+  let num = 0;
+  for (let i = 0; i < string.length; i++) {
+    num += string.charCodeAt(i);
+  }
+  while (num > 0) {
+    hash = base62Chars[num % 62] + hash;
+    num = Math.floor(num / 62);
+  }
+  return hash;
+}
+
 export function remapKeys(
   object: Record<string, unknown>,
   keyMap: Record<string, string>,