@infoxchange/make-it-so 2.1.0-internal-testing-add-api-construct.1 → 2.2.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/IxQuicksightWorkspace.d.ts

@@ -0,0 +1,13 @@
+import { Construct } from "constructs";
+type ConstructScope = ConstructorParameters<typeof Construct>[0];
+type ConstructId = ConstructorParameters<typeof Construct>[1];
+type Props = {
+    appName: string;
+    dataBuckets: string[];
+};
+export declare class IxQuicksightWorkspace extends Construct {
+    constructor(scope: ConstructScope, id: ConstructId, props: Props);
+    private createQuicksightWorkspace;
+}
+export {};
+//# sourceMappingURL=IxQuicksightWorkspace.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"IxQuicksightWorkspace.d.ts","sourceRoot":"","sources":["../../src/cdk-constructs/IxQuicksightWorkspace.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAIvC,KAAK,cAAc,GAAG,qBAAqB,CAAC,OAAO,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;AACjE,KAAK,WAAW,GAAG,qBAAqB,CAAC,OAAO,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;AAE9D,KAAK,KAAK,GAAG;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,EAAE,CAAC;CACvB,CAAC;AAEF,qBAAa,qBAAsB,SAAQ,SAAS;gBACtC,KAAK,EAAE,cAAc,EAAE,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK;IAKhE,OAAO,CAAC,yBAAyB;CAmBlC"}

package/dist/cdk-constructs/IxQuicksightWorkspace.js

@@ -0,0 +1,20 @@
+import { Construct } from "constructs";
+import { StringParameter } from "aws-cdk-lib/aws-ssm";
+import { CustomResource } from "aws-cdk-lib";
+export class IxQuicksightWorkspace extends Construct {
+    constructor(scope, id, props) {
+        super(scope, id);
+        this.createQuicksightWorkspace(scope, id, props);
+    }
+    createQuicksightWorkspace(scope, id, constructProps) {
+        const qsWorkspaceSetupLambdaArn = StringParameter.valueForStringParameter(scope, "/shared-services/quicksight-workspace/lambdaArn");
+        new CustomResource(scope, id + "-CustomResource", {
+            resourceType: "Custom::QuicksightWorkspace",
+            serviceToken: qsWorkspaceSetupLambdaArn,
+            properties: {
+                app_name: constructProps.appName,
+                data_buckets: constructProps.dataBuckets,
+            },
+        });
+    }
+}

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

@@ -4,4 +4,5 @@ export * from "./IxDnsRecord.js";
 export * from "./IxNextjsSite.js";
 export * from "./IxElasticache.js";
 export * from "./IxApi.js";
+export * from "./IxQuicksightWorkspace.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;AACnC,cAAc,YAAY,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;AAC3B,cAAc,4BAA4B,CAAC"}

package/dist/cdk-constructs/index.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@infoxchange/make-it-so",
-  "version": "2.1.0-internal-testing-add-api-construct.1",
+  "version": "2.2.0",
   "description": "Makes deploying services to IX infra easy",
   "repository": "github:infoxchange/make-it-so",
   "type": "module",

package/src/cdk-constructs/IxQuicksightWorkspace.ts

@@ -0,0 +1,38 @@
+import { Construct } from "constructs";
+import { StringParameter } from "aws-cdk-lib/aws-ssm";
+import { CustomResource } from "aws-cdk-lib";
+
+type ConstructScope = ConstructorParameters<typeof Construct>[0];
+type ConstructId = ConstructorParameters<typeof Construct>[1];
+
+type Props = {
+  appName: string;
+  dataBuckets: string[];
+};
+
+export class IxQuicksightWorkspace extends Construct {
+  constructor(scope: ConstructScope, id: ConstructId, props: Props) {
+    super(scope, id);
+    this.createQuicksightWorkspace(scope, id, props);
+  }
+
+  private createQuicksightWorkspace(
+    scope: ConstructScope,
+    id: ConstructId,
+    constructProps: Props,
+  ): void {
+    const qsWorkspaceSetupLambdaArn = StringParameter.valueForStringParameter(
+      scope,
+      "/shared-services/quicksight-workspace/lambdaArn",
+    );
+
+    new CustomResource(scope, id + "-CustomResource", {
+      resourceType: "Custom::QuicksightWorkspace",
+      serviceToken: qsWorkspaceSetupLambdaArn,
+      properties: {
+        app_name: constructProps.appName,
+        data_buckets: constructProps.dataBuckets,
+      },
+    });
+  }
+}

package/src/cdk-constructs/index.ts

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