@flipdish/cdk-constructs 0.1.3 → 0.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -0
- package/dist/Api.d.ts +1 -1
- package/dist/Api.d.ts.map +1 -1
- package/dist/Api.js +1 -1
- package/dist/Api.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -8,6 +8,11 @@ CDK Constructs for Flipdish serverless applications, with a focus on API constru
|
|
|
8
8
|
npm install @flipdish/cdk-constructs
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
+
## Required Static File
|
|
12
|
+
|
|
13
|
+
**Important:** The file `stacks/static/openapi.html` must exist in your project. This file is required for the OpenAPI documentation endpoints to work correctly.
|
|
14
|
+
|
|
15
|
+
|
|
11
16
|
## Overview
|
|
12
17
|
|
|
13
18
|
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.
|
package/dist/Api.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { Construct } from 'constructs';
|
|
2
2
|
import { type ApiAuthorizer, type Stack, Api as sstApi } from 'sst/constructs';
|
|
3
|
-
import type { SchemaApiProps, SchemaRouteProps } from './types
|
|
3
|
+
import type { SchemaApiProps, SchemaRouteProps } from './types';
|
|
4
4
|
export declare class Api<Authorizers extends Record<string, ApiAuthorizer> = Record<string, ApiAuthorizer>> extends sstApi<Authorizers> {
|
|
5
5
|
private readonly registry;
|
|
6
6
|
private readonly serviceName;
|
package/dist/Api.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
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,
|
|
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
CHANGED
|
@@ -3,7 +3,7 @@ import { Aspects, RemovalPolicy, Tags } from 'aws-cdk-lib';
|
|
|
3
3
|
import { BucketDeployment, Source } from 'aws-cdk-lib/aws-s3-deployment';
|
|
4
4
|
import { NagSuppressions } from 'cdk-nag';
|
|
5
5
|
import { Bucket, Api as sstApi } from 'sst/constructs';
|
|
6
|
-
import { buildSchema, sstRoutesToOpenApiSchema } from './OpenApi
|
|
6
|
+
import { buildSchema, sstRoutesToOpenApiSchema } from './OpenApi';
|
|
7
7
|
// This class extends the SST Api class to provide additional functionality for OpenAPI documentation generation.
|
|
8
8
|
// The type of 'ApiProps' has been extended to include a 'schema' property, which is used to define the OpenAPI schema for the API.
|
|
9
9
|
//
|
package/dist/Api.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
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,
|
|
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,gFAAgF;AAChF,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,eAAe,CAAC,CAAC;QACxC,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;IAAG,CAAC;IACvD,KAAK,CAAC,IAAgB;QAC3B,IAAI,IAAI,YAAY,GAAG,EAAE,CAAC;YACxB,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;QAChB,CAAC;IACH,CAAC;CACF"}
|