@flipdish/cdk-constructs 0.1.0

package/README.md

@@ -0,0 +1,88 @@
+# @flipdish/cdk-constructs
+
+CDK Constructs for Flipdish serverless applications, with a focus on API constructs that provide automatic OpenAPI documentation generation and deployment.
+
+## Installation
+
+```bash
+npm install @flipdish/cdk-constructs
+```
+
+## Overview
+
+This package provides CDK constructs and utilities for building serverless APIs with strong typing and automatic OpenAPI documentation. It is designed to be used with [SST](https://sst.dev/) and integrates with Zod for schema validation and OpenAPI generation.
+
+## Features
+
+- **Api Construct**: Drop-in replacement for SST's Api construct, with built-in OpenAPI documentation generation.
+- **Automatic OpenAPI Docs**: Generates and deploys OpenAPI JSON, YAML, and HTML documentation for your API routes.
+- **Schema Integration**: Supports Zod-based schema definitions for routes.
+- **TypeScript-first**: All constructs and utilities are strictly typed.
+
+## Usage
+
+### Basic Example
+
+```typescript
+import { Api, SchemaFunction } from '@flipdish/cdk-constructs';
+import { z } from 'zod';
+import { StackContext } from 'sst/constructs';
+
+export function API({ stack }: StackContext) {
+  const api = new Api(stack, 'Api', {
+    routes: {
+      'GET /hello': {
+        function: new SchemaFunction(stack, 'HelloHandler', {
+          handler: 'src/hello.handler',
+          schema: {
+            responses: {
+              200: z.object({ message: z.string() }),
+            },
+          },
+        }),
+      },
+    },
+  });
+
+  // The following endpoints are automatically added:
+  // - /openapi.json
+  // - /openapi.yaml
+  // - /openapi.html
+
+  return { api };
+}
+```
+
+### OpenAPI Utilities
+
+You can also use the following utilities for advanced OpenAPI schema generation:
+
+- `buildSchema(registry, serviceName, url)`: Generates an OpenAPI schema document from a registry.
+- `sstRoutesToOpenApiSchema(routes)`: Converts SST route definitions to OpenAPI route configs.
+
+### Types
+
+The package exports several types to help with strong typing and schema integration:
+
+- `Schema`
+- `SchemaFunction`
+- `SchemaFunctionProps`
+- `SchemaRouteProps`
+- `SchemaApiProps`
+- `SchemaApiFunctionRouteProps`
+
+## Development & Testing
+
+This package is maintained in the [serverless-app-template](https://github.com/flipdishbytes/serverless-app-template) repository.
+
+### Testing
+
+You can test the constructs by deploying a stack and verifying that the OpenAPI documentation endpoints are available and accurate. For unit testing, use your preferred test runner (e.g., Vitest or Jest) to check that the constructs behave as expected.
+
+## License
+
+MIT
+
+## Contributing
+
+This package is maintained in the [serverless-app-template](https://github.com/flipdishbytes/serverless-app-template) repository. 

package/dist/Api.d.ts

@@ -0,0 +1,12 @@
+import type { Construct } from 'constructs';
+import { type ApiAuthorizer, type Stack, Api as sstApi } from 'sst/constructs';
+import type { SchemaApiProps, SchemaRouteProps } from './types';
+export declare class Api<Authorizers extends Record<string, ApiAuthorizer> = Record<string, ApiAuthorizer>> extends sstApi<Authorizers> {
+    private readonly registry;
+    private readonly serviceName;
+    private readonly deployment;
+    constructor(stack: Stack, id: string, props?: SchemaApiProps<Authorizers>);
+    addRoutes(scope: Construct, routes: Record<string, SchemaRouteProps<keyof Authorizers>>): void;
+    private exportSchema;
+}
+//# sourceMappingURL=Api.d.ts.map

package/dist/Api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Api.d.ts","sourceRoot":"","sources":["../src/Api.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,SAAS,EAAc,MAAM,YAAY,CAAC;AACxD,OAAO,EAAE,KAAK,aAAa,EAAU,KAAK,KAAK,EAAE,GAAG,IAAI,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAEvF,OAAO,KAAK,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAyBhE,qBAAa,GAAG,CAAC,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAE,SAAQ,MAAM,CAAC,WAAW,CAAC;IAC7H,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA0C;IACnE,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAS;IACrC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAmB;gBAElC,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,cAAc,CAAC,WAAW,CAAC;IAwBlE,SAAS,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,MAAM,WAAW,CAAC,CAAC,GAAG,IAAI;IAWrG,OAAO,CAAC,YAAY;CAKrB"}

package/dist/Api.js

@@ -0,0 +1,102 @@
+import { OpenAPIRegistry } from '@asteasolutions/zod-to-openapi';
+import { Aspects, RemovalPolicy, Tags } from 'aws-cdk-lib';
+import { BucketDeployment, Source } from 'aws-cdk-lib/aws-s3-deployment';
+import { NagSuppressions } from 'cdk-nag';
+import { Bucket, Api as sstApi } from 'sst/constructs';
+import { buildSchema, sstRoutesToOpenApiSchema } from './OpenApi';
+// This class extends the SST Api class to provide additional functionality for OpenAPI documentation generation.
+// The type of 'ApiProps' has been extended to include a 'schema' property, which is used to define the OpenAPI schema for the API.
+//
+// WE DO THIS NOT BECAUSE IT IS EASY, BUT BECAUSE WE THOUGHT IT WOULD BE EASY.
+// There are 2 strange things in this class.
+//
+// 1.
+// The SST Api class has a design peculiarity that made this difficult to implement.
+// The intended design was that we walk over the routes, collect them into an OpenAPI schema registry,
+// and then generate the OpenAPI schema from the registry, and serve up it over HTTP as a static site.
+// CDK constructs are designed to be immutable, and declarative, but the SST Api class is not.
+// The class has an 'addRoutes' method that can be called multiple times. Each call to 'addRoutes' will add
+// more routes to the API, which adds to the registry. At any point in time, we cannot tell if the registry
+// is complete or not - there might be more calls to 'addRoutes' pending.
+// To work around this, we miss-use the Aspect mechanism, to call a callback function when the Api construct is created.
+// Aspects are called after the construct tree is built, so we can be sure that all routes have been added to the registry.
+//
+// 2.
+// The base class (the SST Api) makes a call to the public 'addRoutes' method from its constructor.
+// We override the 'addRoutes' method to add the routes to the OpenAPI registry. When this class calls 'super' in
+// the constructor, there is a call to 'addRoutes', before the registry is initialized. To work around this,
+// we check if the registry to tell if the call to 'addRoutes' is the first one (from the constructor) or a subsequent call.
+export class Api extends sstApi {
+    registry = new OpenAPIRegistry();
+    serviceName;
+    deployment;
+    constructor(stack, id, props) {
+        super(stack, id, props);
+        this.serviceName = stack.stackName.toLowerCase();
+        const { deployment, bucket } = buildWebDeployment(stack, this);
+        this.deployment = deployment;
+        for (const schema of sstRoutesToOpenApiSchema(props?.routes ?? {})) {
+            this.registry.registerPath(schema);
+        }
+        Aspects.of(this).add(new ApiCallbackAspect((api) => {
+            api.exportSchema();
+        }));
+        this.addRoutes(this, {
+            'GET /openapi.html': { type: 'url', url: `https://${bucket.cdk.bucket.bucketDomainName}/openapi.html` },
+            'GET /openapi.json': { type: 'url', url: `https://${bucket.cdk.bucket.bucketDomainName}/openapi.json` },
+            'GET /openapi.yaml': { type: 'url', url: `https://${bucket.cdk.bucket.bucketDomainName}/openapi.yaml` },
+        });
+    }
+    addRoutes(scope, routes) {
+        super.addRoutes(scope, routes);
+        if (!this.registry) {
+            return; // this call is from the constructor, and the registry is not initialized yet.
+        }
+        for (const schema of sstRoutesToOpenApiSchema(routes)) {
+            this.registry.registerPath(schema);
+        }
+    }
+    exportSchema() {
+        const schema = buildSchema(this.registry, this.serviceName, 'https://example.com');
+        this.deployment.addSource(Source.jsonData('openapi.json', schema));
+        this.deployment.addSource(Source.yamlData('openapi.yaml', schema));
+    }
+}
+// This function creates a static web site.
+// It creates an S3 bucket to host the static files and a CloudFront distribution to serve them,
+// and returns a deployment object that can be used to deploy the static files to the S3 bucket.
+const buildWebDeployment = (stack, scope) => {
+    const bucket = new Bucket(scope, 'OpenApiDocs', {
+        cdk: {
+            bucket: {
+                removalPolicy: RemovalPolicy.DESTROY,
+                autoDeleteObjects: true,
+                websiteIndexDocument: 'openapi.html',
+                publicReadAccess: true,
+            },
+        },
+    });
+    Tags.of(bucket.cdk.bucket).add('flipdish:ephemeral', 'true');
+    NagSuppressions.addResourceSuppressions(bucket.cdk.bucket, [
+        { id: 'AwsSolutions-S2', reason: 'This bucket is used to host public files for OpenAPI documentation' },
+        { id: 'AwsSolutions-S5', reason: 'This bucket is used to host public files for OpenAPI documentation' },
+    ]);
+    const deployment = new BucketDeployment(scope, 'DeployOpenApiFiles', {
+        sources: [Source.asset('stacks/static/openapi')],
+        destinationBucket: bucket.cdk.bucket,
+    });
+    NagSuppressions.addStackSuppressions(stack, [{ id: 'AwsSolutions-L1', reason: 'cdk deployments use a lambda that is outside of our control' }]);
+    return { deployment, bucket };
+};
+class ApiCallbackAspect {
+    fn;
+    constructor(fn) {
+        this.fn = fn;
+    }
+    visit(node) {
+        if (node instanceof Api) {
+            this.fn(node);
+        }
+    }
+}
+//# sourceMappingURL=Api.js.map

package/dist/Api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Api.js","sourceRoot":"","sources":["../src/Api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AACjE,OAAO,EAAE,OAAO,EAAgB,aAAa,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AACzE,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE1C,OAAO,EAAsB,MAAM,EAAc,GAAG,IAAI,MAAM,EAAE,MAAM,gBAAgB,CAAC;AACvF,OAAO,EAAE,WAAW,EAAE,wBAAwB,EAAE,MAAM,WAAW,CAAC;AAGlE,iHAAiH;AACjH,mIAAmI;AACnI,EAAE;AACF,8EAA8E;AAC9E,4CAA4C;AAC5C,EAAE;AACF,KAAK;AACL,oFAAoF;AACpF,sGAAsG;AACtG,sGAAsG;AACtG,8FAA8F;AAC9F,2GAA2G;AAC3G,2GAA2G;AAC3G,yEAAyE;AACzE,wHAAwH;AACxH,2HAA2H;AAC3H,EAAE;AACF,KAAK;AACL,mGAAmG;AACnG,iHAAiH;AACjH,4GAA4G;AAC5G,4HAA4H;AAE5H,MAAM,OAAO,GAAuF,SAAQ,MAAmB;IAC5G,QAAQ,GAAoB,IAAI,eAAe,EAAE,CAAC;IAClD,WAAW,CAAS;IACpB,UAAU,CAAmB;IAE9C,YAAY,KAAY,EAAE,EAAU,EAAE,KAAmC;QACvE,KAAK,CAAC,KAAK,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;QACxB,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC;QAEjD,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,kBAAkB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAC/D,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAE7B,KAAK,MAAM,MAAM,IAAI,wBAAwB,CAAC,KAAK,EAAE,MAAM,IAAI,EAAE,CAAC,EAAE,CAAC;YACnE,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QACrC,CAAC;QAED,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,GAAG,CAClB,IAAI,iBAAiB,CAAC,CAAC,GAAG,EAAE,EAAE;YAC5B,GAAG,CAAC,YAAY,EAAE,CAAC;QACrB,CAAC,CAAC,CACH,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE;YACnB,mBAAmB,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,WAAW,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,gBAAgB,eAAe,EAAE;YACvG,mBAAmB,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,WAAW,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,gBAAgB,eAAe,EAAE;YACvG,mBAAmB,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,WAAW,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,gBAAgB,eAAe,EAAE;SACxG,CAAC,CAAC;IACL,CAAC;IAEM,SAAS,CAAC,KAAgB,EAAE,MAA2D;QAC5F,KAAK,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC/B,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,OAAO,CAAC,8EAA8E;QACxF,CAAC;QAED,KAAK,MAAM,MAAM,IAAI,wBAAwB,CAAC,MAAM,CAAC,EAAE,CAAC;YACtD,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QACrC,CAAC;IACH,CAAC;IAEO,YAAY;QAClB,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,WAAW,EAAE,qBAAqB,CAAC,CAAC;QACnF,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC;QACnE,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC;IACrE,CAAC;CACF;AAED,2CAA2C;AAC3C,gGAAgG;AAChG,gGAAgG;AAChG,MAAM,kBAAkB,GAAG,CAAC,KAAY,EAAE,KAAgB,EAAE,EAAE;IAC5D,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,KAAK,EAAE,aAAa,EAAE;QAC9C,GAAG,EAAE;YACH,MAAM,EAAE;gBACN,aAAa,EAAE,aAAa,CAAC,OAAO;gBACpC,iBAAiB,EAAE,IAAI;gBACvB,oBAAoB,EAAE,cAAc;gBACpC,gBAAgB,EAAE,IAAI;aACvB;SACF;KACF,CAAC,CAAC;IAEH,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;IAE7D,eAAe,CAAC,uBAAuB,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE;QACzD,EAAE,EAAE,EAAE,iBAAiB,EAAE,MAAM,EAAE,oEAAoE,EAAE;QACvG,EAAE,EAAE,EAAE,iBAAiB,EAAE,MAAM,EAAE,oEAAoE,EAAE;KACxG,CAAC,CAAC;IAEH,MAAM,UAAU,GAAG,IAAI,gBAAgB,CAAC,KAAK,EAAE,oBAAoB,EAAE;QACnE,OAAO,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAChD,iBAAiB,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM;KACrC,CAAC,CAAC;IAEH,eAAe,CAAC,oBAAoB,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,iBAAiB,EAAE,MAAM,EAAE,6DAA6D,EAAE,CAAC,CAAC,CAAC;IAEhJ,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC;AAChC,CAAC,CAAC;AAEF,MAAM,iBAAiB;IACe;IAApC,YAAoC,EAAsB;QAAtB,OAAE,GAAF,EAAE,CAAoB;IAAI,CAAC;IACxD,KAAK,CAAC,IAAgB;QAC3B,IAAI,IAAI,YAAY,GAAG,EAAE,CAAC;YACxB,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;QAChB,CAAC;IACH,CAAC;CACF"}

package/dist/OpenApi.d.ts

@@ -0,0 +1,6 @@
+import { type OpenAPIRegistry, type RouteConfig } from '@asteasolutions/zod-to-openapi';
+import { type ApiAuthorizer } from 'sst/constructs';
+import { type SchemaRouteProps } from './types';
+export declare function buildSchema(registry: OpenAPIRegistry, serviceName: string, url: string): unknown;
+export declare function sstRoutesToOpenApiSchema<Authorizers extends Record<string, ApiAuthorizer> = Record<string, ApiAuthorizer>>(route: Record<string, SchemaRouteProps<keyof Authorizers>>): Array<RouteConfig>;
+//# sourceMappingURL=OpenApi.d.ts.map

package/dist/OpenApi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OpenApi.d.ts","sourceRoot":"","sources":["../src/OpenApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,eAAe,EAAsB,KAAK,WAAW,EAAE,MAAM,gCAAgC,CAAC;AAC5G,OAAO,EAAE,KAAK,aAAa,EAAsE,MAAM,gBAAgB,CAAC;AACxH,OAAO,EAAwF,KAAK,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAEtI,wBAAgB,WAAW,CAAC,QAAQ,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAiBhG;AAyFD,wBAAgB,wBAAwB,CAAC,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,EACxH,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,MAAM,WAAW,CAAC,CAAC,GACzD,KAAK,CAAC,WAAW,CAAC,CAOpB"}

package/dist/OpenApi.js

@@ -0,0 +1,100 @@
+import { OpenApiGeneratorV3 } from '@asteasolutions/zod-to-openapi';
+import { Function as sstFunction } from 'sst/constructs';
+import { SchemaFunction } from './types';
+export function buildSchema(registry, serviceName, url) {
+    const bearerAuth = registry.registerComponent('securitySchemes', 'ApiKeyAuth', {
+        type: 'apiKey',
+        in: 'header',
+        name: 'Authorization',
+    });
+    const generator = new OpenApiGeneratorV3(registry.definitions);
+    return generator.generateDocument({
+        openapi: '3.1.0',
+        info: {
+            version: '1.0.0',
+            title: `${serviceName} API`,
+            description: `${serviceName} API`,
+        },
+        servers: [{ url, description: 'Example server' }],
+        security: [{ [bearerAuth.name]: [] }],
+    });
+}
+const NotNull = (item) => {
+    return item !== undefined;
+};
+function openApiMethod(method) {
+    switch (method.toLowerCase()) {
+        case 'get':
+            return 'get';
+        case 'post':
+            return 'post';
+        case 'put':
+            return 'put';
+        case 'delete':
+            return 'delete';
+        case 'patch':
+            return 'patch';
+        case 'head':
+            return 'head';
+        case 'options':
+            return 'options';
+        default:
+            throw new Error(`Unknown method: '${method}'`);
+    }
+}
+function isSchemaFunctionProps(route) {
+    return 'schema' in route;
+}
+function sstRouteToOpenApiRoute(method, path, route) {
+    // RouteProps is a union type, and we need to handle lots of different cases.
+    // We try to deal with the cases from simple to complex, and we will throw
+    // an error if we encounter a case that we don't know how to handle.
+    // the function is just a path to the handler {function: 'path/to/handler'}
+    if (typeof route === 'string') {
+        return undefined;
+    }
+    if (route instanceof SchemaFunction && route.schema) {
+        return {
+            ...route.schema,
+            path,
+            method: method,
+        };
+    }
+    if (route instanceof sstFunction) {
+        return undefined;
+    }
+    if (route.type === 'aws' || route.type === 'url' || route.type === 'alb' || route.type === 'nlb' || route.type === 'graphql') {
+        return undefined;
+    }
+    const fn = route.function;
+    if (!fn || typeof fn === 'string') {
+        return undefined;
+    }
+    if (fn instanceof SchemaFunction && fn.schema) {
+        return {
+            ...fn.schema,
+            path,
+            method: method,
+        };
+    }
+    if (fn instanceof sstFunction) {
+        return undefined;
+    }
+    if (isSchemaFunctionProps(fn) && fn.schema) {
+        return {
+            ...fn.schema,
+            path,
+            method: method,
+        };
+    }
+    return undefined;
+}
+export function sstRoutesToOpenApiSchema(route) {
+    return Object.entries(route)
+        .map(([pathPattern, routeProps]) => {
+        const [method, path] = pathPattern.split(/\s+/);
+        return sstRouteToOpenApiRoute(openApiMethod(method), path, routeProps);
+    })
+        .filter(NotNull);
+}
+//# sourceMappingURL=OpenApi.js.map

package/dist/OpenApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OpenApi.js","sourceRoot":"","sources":["../src/OpenApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAwB,kBAAkB,EAAoB,MAAM,gCAAgC,CAAC;AAC5G,OAAO,EAAiE,QAAQ,IAAI,WAAW,EAAE,MAAM,gBAAgB,CAAC;AACxH,OAAO,EAAe,cAAc,EAAkF,MAAM,SAAS,CAAC;AAEtI,MAAM,UAAU,WAAW,CAAC,QAAyB,EAAE,WAAmB,EAAE,GAAW;IACrF,MAAM,UAAU,GAAG,QAAQ,CAAC,iBAAiB,CAAC,iBAAiB,EAAE,YAAY,EAAE;QAC7E,IAAI,EAAE,QAAQ;QACd,EAAE,EAAE,QAAQ;QACZ,IAAI,EAAE,eAAe;KACtB,CAAC,CAAC;IACH,MAAM,SAAS,GAAG,IAAI,kBAAkB,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IAC/D,OAAO,SAAS,CAAC,gBAAgB,CAAC;QAChC,OAAO,EAAE,OAAO;QAChB,IAAI,EAAE;YACJ,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,GAAG,WAAW,MAAM;YAC3B,WAAW,EAAE,GAAG,WAAW,MAAM;SAClC;QACD,OAAO,EAAE,CAAC,EAAE,GAAG,EAAE,WAAW,EAAE,gBAAgB,EAAE,CAAC;QACjD,QAAQ,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,CAAC;KACtC,CAAC,CAAC;AACL,CAAC;AAID,MAAM,OAAO,GAAG,CAAI,IAAmB,EAAa,EAAE;IACpD,OAAO,IAAI,KAAK,SAAS,CAAC;AAC5B,CAAC,CAAC;AAEF,SAAS,aAAa,CAAC,MAAc;IACnC,QAAQ,MAAM,CAAC,WAAW,EAAE,EAAE,CAAC;QAC7B,KAAK,KAAK;YACR,OAAO,KAAK,CAAC;QACf,KAAK,MAAM;YACT,OAAO,MAAM,CAAC;QAChB,KAAK,KAAK;YACR,OAAO,KAAK,CAAC;QACf,KAAK,QAAQ;YACX,OAAO,QAAQ,CAAC;QAClB,KAAK,OAAO;YACV,OAAO,OAAO,CAAC;QACjB,KAAK,MAAM;YACT,OAAO,MAAM,CAAC;QAChB,KAAK,SAAS;YACZ,OAAO,SAAS,CAAC;QACnB;YACE,MAAM,IAAI,KAAK,CAAC,oBAAoB,MAAM,GAAG,CAAC,CAAC;IACnD,CAAC;AACH,CAAC;AAED,SAAS,qBAAqB,CAAC,KAAoB;IACjD,OAAO,QAAQ,IAAI,KAAK,CAAC;AAC3B,CAAC;AAED,SAAS,sBAAsB,CAAI,MAAc,EAAE,IAAY,EAAE,KAA0B;IACzF,6EAA6E;IAC7E,0EAA0E;IAC1E,oEAAoE;IAEpE,2EAA2E;IAE3E,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,KAAK,YAAY,cAAc,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;QACpD,OAAO;YACL,GAAG,KAAK,CAAC,MAAM;YACf,IAAI;YACJ,MAAM,EAAE,MAAM;SACf,CAAC;IACJ,CAAC;IAED,IAAI,KAAK,YAAY,WAAW,EAAE,CAAC;QACjC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,KAAK,CAAC,IAAI,KAAK,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC7H,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,EAAE,GAAG,KAAK,CAAC,QAAQ,CAAC;IAE1B,IAAI,CAAC,EAAE,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE,CAAC;QAClC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,EAAE,YAAY,cAAc,IAAI,EAAE,CAAC,MAAM,EAAE,CAAC;QAC9C,OAAO;YACL,GAAG,EAAE,CAAC,MAAM;YACZ,IAAI;YACJ,MAAM,EAAE,MAAM;SACf,CAAC;IACJ,CAAC;IAED,IAAI,EAAE,YAAY,WAAW,EAAE,CAAC;QAC9B,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,qBAAqB,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,MAAM,EAAE,CAAC;QAC3C,OAAO;YACL,GAAG,EAAE,CAAC,MAAM;YACZ,IAAI;YACJ,MAAM,EAAE,MAAM;SACf,CAAC;IACJ,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,MAAM,UAAU,wBAAwB,CACtC,KAA0D;IAE1D,OAAO,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC;SACzB,GAAG,CAAC,CAAC,CAAC,WAAW,EAAE,UAAU,CAAC,EAAE,EAAE;QACjC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAChD,OAAO,sBAAsB,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;IACzE,CAAC,CAAC;SACD,MAAM,CAAC,OAAO,CAAC,CAAC;AACrB,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { Api } from './Api.js';
+export { buildSchema, sstRoutesToOpenApiSchema } from './OpenApi.js';
+export { Schema, SchemaFunction, SchemaFunctionProps, SchemaRouteProps, SchemaApiProps, SchemaApiFunctionRouteProps } from './types.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AACrE,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,cAAc,EAAE,2BAA2B,EAAE,MAAM,YAAY,CAAC"}

package/dist/index.js

@@ -0,0 +1,4 @@
+export { Api } from './Api.js';
+export { buildSchema, sstRoutesToOpenApiSchema } from './OpenApi.js';
+export { SchemaFunction } from './types.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AACrE,OAAO,EAAU,cAAc,EAAsF,MAAM,YAAY,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,20 @@
+import type { RouteConfig } from '@asteasolutions/zod-to-openapi';
+import type { Construct } from 'constructs';
+import { type ApiAuthorizer, type ApiFunctionRouteProps, type ApiProps, type ApiRouteProps, type FunctionProps, Function as sstFunction } from 'sst/constructs';
+export type Schema = Omit<RouteConfig, 'path' | 'method'>;
+export interface SchemaFunctionProps extends FunctionProps {
+    schema?: Schema;
+}
+export declare class SchemaFunction extends sstFunction {
+    readonly schema?: Schema;
+    constructor(scope: Construct, id: string, { schema, ...props }: SchemaFunctionProps);
+}
+export type SchemaFunctionDefinition = string | SchemaFunction | SchemaFunctionProps;
+export interface SchemaApiFunctionRouteProps<AuthorizersKeys = string> extends ApiFunctionRouteProps<AuthorizersKeys> {
+    function?: SchemaFunctionDefinition;
+}
+export type SchemaRouteProps<AuthorizerKeys> = ApiRouteProps<AuthorizerKeys> | SchemaApiFunctionRouteProps<AuthorizerKeys>;
+export interface SchemaApiProps<Authorizers extends Record<string, ApiAuthorizer> = Record<string, ApiAuthorizer>, AuthorizerKeys = keyof Authorizers> extends ApiProps<Authorizers, AuthorizerKeys> {
+    routes?: Record<string, SchemaRouteProps<AuthorizerKeys>>;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gCAAgC,CAAC;AAClE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAC5C,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,qBAAqB,EAC1B,KAAK,QAAQ,EACb,KAAK,aAAa,EAClB,KAAK,aAAa,EAClB,QAAQ,IAAI,WAAW,EACxB,MAAM,gBAAgB,CAAC;AAExB,MAAM,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,EAAE,MAAM,GAAG,QAAQ,CAAC,CAAC;AAE1D,MAAM,WAAW,mBAAoB,SAAQ,aAAa;IACxD,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,qBAAa,cAAe,SAAQ,WAAW;IAC7C,SAAgB,MAAM,CAAC,EAAE,MAAM,CAAC;gBACpB,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,GAAG,KAAK,EAAE,EAAE,mBAAmB;CAIpF;AAED,MAAM,MAAM,wBAAwB,GAAG,MAAM,GAAG,cAAc,GAAG,mBAAmB,CAAC;AAErF,MAAM,WAAW,2BAA2B,CAAC,eAAe,GAAG,MAAM,CAAE,SAAQ,qBAAqB,CAAC,eAAe,CAAC;IACnH,QAAQ,CAAC,EAAE,wBAAwB,CAAC;CACrC;AAED,MAAM,MAAM,gBAAgB,CAAC,cAAc,IAAI,aAAa,CAAC,cAAc,CAAC,GAAG,2BAA2B,CAAC,cAAc,CAAC,CAAC;AAE3H,MAAM,WAAW,cAAc,CAAC,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,EAAE,cAAc,GAAG,MAAM,WAAW,CACnJ,SAAQ,QAAQ,CAAC,WAAW,EAAE,cAAc,CAAC;IAC7C,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,cAAc,CAAC,CAAC,CAAC;CAC3D"}

package/dist/types.js

@@ -0,0 +1,9 @@
+import { Function as sstFunction, } from 'sst/constructs';
+export class SchemaFunction extends sstFunction {
+    schema;
+    constructor(scope, id, { schema, ...props }) {
+        super(scope, id, props);
+        this.schema = schema;
+    }
+}
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAEA,OAAO,EAML,QAAQ,IAAI,WAAW,GACxB,MAAM,gBAAgB,CAAC;AAQxB,MAAM,OAAO,cAAe,SAAQ,WAAW;IAC7B,MAAM,CAAU;IAChC,YAAY,KAAgB,EAAE,EAAU,EAAE,EAAE,MAAM,EAAE,GAAG,KAAK,EAAuB;QACjF,KAAK,CAAC,KAAK,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF"}

package/package.json

@@ -0,0 +1,38 @@
+{
+    "name": "@flipdish/cdk-constructs",
+    "version": "0.1.0",
+    "description": "CDK Constructs for Flipdish serverless applications",
+    "type": "module",
+    "main": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "default": "./dist/index.js"
+        }
+    },
+    "scripts": {
+        "build": "tsc",
+        "clean": "rm -rf dist",
+        "prebuild": "npm run clean"
+    },
+    "devDependencies": {
+        "typescript": "^5.0.0",
+        "@tsconfig/node22": "22.0.2",
+        "aws-cdk-lib": "2.179.0",
+        "constructs": "10.3.0",
+        "sst": "2.48.5"
+    },
+    "files": [
+        "dist"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/flipdishbytes/serverless-app-template.git"
+    },
+    "author": "Flipdish",
+    "license": "MIT",
+    "publishConfig": {
+        "access": "public"
+    }
+}