@flipdish/cdk-constructs 0.50.0 → 0.51.0

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/dist/Api.d.ts CHANGED
@@ -5,6 +5,8 @@ export declare class Api<Authorizers extends Record<string, ApiAuthorizer> = Rec
5
5
  private readonly registry;
6
6
  private readonly serviceName;
7
7
  private readonly deployment;
8
+ private readonly serviceUrl;
9
+ private readonly description;
8
10
  constructor(stack: Stack, id: string, props?: SchemaApiProps<Authorizers>);
9
11
  addRoutes(scope: Construct, routes: Record<string, SchemaRouteProps<keyof Authorizers>>): void;
10
12
  private exportSchema;
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,EAAE,MAAM,YAAY,CAAC;AAC5C,OAAO,EAAE,KAAK,aAAa,EAAU,KAAK,KAAK,EAAE,GAAG,IAAI,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAGvF,OAAO,KAAK,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAsCnE,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;IAgClE,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"}
1
+ {"version":3,"file":"Api.d.ts","sourceRoot":"","sources":["../src/Api.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAC5C,OAAO,EAAE,KAAK,aAAa,EAAU,KAAK,KAAK,EAAE,GAAG,IAAI,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAGvF,OAAO,KAAK,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAsCnE,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;IAC9C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAqB;gBAErC,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,cAAc,CAAC,WAAW,CAAC;IAkClE,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
@@ -43,9 +43,13 @@ export class Api extends sstApi {
43
43
  registry = new OpenAPIRegistry();
44
44
  serviceName;
45
45
  deployment;
46
+ serviceUrl;
47
+ description;
46
48
  constructor(stack, id, props) {
47
49
  super(stack, id, props);
48
- this.serviceName = stack.stackName.toLowerCase();
50
+ this.serviceName = props?.title ?? stack.stackName.toLowerCase();
51
+ this.serviceUrl = props?.uri ?? 'https://example.com';
52
+ this.description = props?.description;
49
53
  const { deployment, bucket } = buildWebDeployment(stack, this);
50
54
  this.deployment = deployment;
51
55
  for (const schema of sstRoutesToOpenApiSchema(props?.routes ?? {})) {
@@ -80,7 +84,7 @@ export class Api extends sstApi {
80
84
  }
81
85
  }
82
86
  exportSchema() {
83
- const schema = buildSchema(this.registry, this.serviceName, 'https://example.com');
87
+ const schema = buildSchema(this.registry, this.serviceName, this.serviceUrl, this.description);
84
88
  this.deployment.addSource(Source.jsonData('openapi.json', schema));
85
89
  this.deployment.addSource(Source.yamlData('openapi.yaml', schema));
86
90
  }
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,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AACzD,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,6BAA6B,EAAE,MAAM,gBAAgB,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAGrE,MAAM,kBAAkB,GAAG;;;;;;;;;;;CAW1B,CAAC;AAEF,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,6BAA6B,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;QAE/D,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE;YACnB,mBAAmB,EAAE;gBACnB,IAAI,EAAE,KAAK;gBACX,GAAG,EAAE,WAAW,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,gBAAgB,eAAe;gBACjE,UAAU,EAAE,MAAM;aACnB;YACD,mBAAmB,EAAE;gBACnB,IAAI,EAAE,KAAK;gBACX,GAAG,EAAE,WAAW,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,gBAAgB,eAAe;gBACjE,UAAU,EAAE,MAAM;aACnB;YACD,mBAAmB,EAAE;gBACnB,IAAI,EAAE,KAAK;gBACX,GAAG,EAAE,WAAW,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,gBAAgB,eAAe;gBACjE,UAAU,EAAE,MAAM;aACnB;SACF,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,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,EAAE;QAClE,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;YACE,EAAE,EAAE,iBAAiB;YACrB,MAAM,EAAE,oEAAoE;SAC7E;QACD;YACE,EAAE,EAAE,iBAAiB;YACrB,MAAM,EAAE,oEAAoE;SAC7E;KACF,CAAC,CAAC;IAEH,MAAM,UAAU,GAAG,IAAI,gBAAgB,CAAC,KAAK,EAAE,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,oBAAoB,EAAE;QAC3F,OAAO,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QAC1D,iBAAiB,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM;KACrC,CAAC,CAAC;IAEH,eAAe,CAAC,oBAAoB,CAAC,KAAK,EAAE;QAC1C;YACE,EAAE,EAAE,iBAAiB;YACrB,MAAM,EAAE,6DAA6D;SACtE;KACF,CAAC,CAAC;IAEH,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC;AAChC,CAAC,CAAC"}
1
+ {"version":3,"file":"Api.js","sourceRoot":"","sources":["../src/Api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AACjE,OAAO,EAAE,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AACzD,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,6BAA6B,EAAE,MAAM,gBAAgB,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAGrE,MAAM,kBAAkB,GAAG;;;;;;;;;;;CAW1B,CAAC;AAEF,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;IAC7B,UAAU,CAAS;IACnB,WAAW,CAAqB;IAEjD,YAAY,KAAY,EAAE,EAAU,EAAE,KAAmC;QACvE,KAAK,CAAC,KAAK,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;QACxB,IAAI,CAAC,WAAW,GAAG,KAAK,EAAE,KAAK,IAAI,KAAK,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC;QACjE,IAAI,CAAC,UAAU,GAAG,KAAK,EAAE,GAAG,IAAI,qBAAqB,CAAC;QACtD,IAAI,CAAC,WAAW,GAAG,KAAK,EAAE,WAAW,CAAC;QAEtC,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,6BAA6B,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;QAE/D,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE;YACnB,mBAAmB,EAAE;gBACnB,IAAI,EAAE,KAAK;gBACX,GAAG,EAAE,WAAW,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,gBAAgB,eAAe;gBACjE,UAAU,EAAE,MAAM;aACnB;YACD,mBAAmB,EAAE;gBACnB,IAAI,EAAE,KAAK;gBACX,GAAG,EAAE,WAAW,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,gBAAgB,eAAe;gBACjE,UAAU,EAAE,MAAM;aACnB;YACD,mBAAmB,EAAE;gBACnB,IAAI,EAAE,KAAK;gBACX,GAAG,EAAE,WAAW,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,gBAAgB,eAAe;gBACjE,UAAU,EAAE,MAAM;aACnB;SACF,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,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAC/F,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,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,EAAE;QAClE,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;YACE,EAAE,EAAE,iBAAiB;YACrB,MAAM,EAAE,oEAAoE;SAC7E;QACD;YACE,EAAE,EAAE,iBAAiB;YACrB,MAAM,EAAE,oEAAoE;SAC7E;KACF,CAAC,CAAC;IAEH,MAAM,UAAU,GAAG,IAAI,gBAAgB,CAAC,KAAK,EAAE,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,oBAAoB,EAAE;QAC3F,OAAO,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QAC1D,iBAAiB,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM;KACrC,CAAC,CAAC;IAEH,eAAe,CAAC,oBAAoB,CAAC,KAAK,EAAE;QAC1C;YACE,EAAE,EAAE,iBAAiB;YACrB,MAAM,EAAE,6DAA6D;SACtE;KACF,CAAC,CAAC;IAEH,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC;AAChC,CAAC,CAAC"}
package/dist/OpenApi.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { type OpenAPIRegistry, type RouteConfig } from '@asteasolutions/zod-to-openapi';
2
2
  import { type ApiAuthorizer } from 'sst/constructs';
3
3
  import { type SchemaRouteProps } from './types.js';
4
- export declare function buildSchema(registry: OpenAPIRegistry, serviceName: string, url: string): unknown;
4
+ export declare function buildSchema(registry: OpenAPIRegistry, serviceName: string, url: string, description?: string): unknown;
5
5
  export declare function sstRoutesToOpenApiSchema<Authorizers extends Record<string, ApiAuthorizer> = Record<string, ApiAuthorizer>>(route: Record<string, SchemaRouteProps<keyof Authorizers>>): Array<RouteConfig>;
6
6
  //# sourceMappingURL=OpenApi.d.ts.map
@@ -1 +1 @@
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,EAA+C,MAAM,gBAAgB,CAAC;AACjG,OAAO,EAA4C,KAAK,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAE7F,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"}
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,EAA+C,MAAM,gBAAgB,CAAC;AACjG,OAAO,EAA4C,KAAK,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAE7F,wBAAgB,WAAW,CAAC,QAAQ,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAiBtH;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 CHANGED
@@ -1,7 +1,7 @@
1
1
  import { OpenApiGeneratorV3 } from '@asteasolutions/zod-to-openapi';
2
2
  import { Function as sstFunction } from 'sst/constructs';
3
3
  import { SchemaFunction } from './types.js';
4
- export function buildSchema(registry, serviceName, url) {
4
+ export function buildSchema(registry, serviceName, url, description) {
5
5
  const bearerAuth = registry.registerComponent('securitySchemes', 'ApiKeyAuth', {
6
6
  type: 'apiKey',
7
7
  in: 'header',
@@ -13,9 +13,9 @@ export function buildSchema(registry, serviceName, url) {
13
13
  info: {
14
14
  version: '1.0.0',
15
15
  title: `${serviceName} API`,
16
- description: `${serviceName} API`,
16
+ description: description ?? `${serviceName} API`,
17
17
  },
18
- servers: [{ url, description: 'Example server' }],
18
+ servers: [{ url, description: description ?? 'Example server' }],
19
19
  security: [{ [bearerAuth.name]: [] }],
20
20
  });
21
21
  }
@@ -1 +1 @@
1
- {"version":3,"file":"OpenApi.js","sourceRoot":"","sources":["../src/OpenApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAwB,kBAAkB,EAAoB,MAAM,gCAAgC,CAAC;AAC5G,OAAO,EAA0C,QAAQ,IAAI,WAAW,EAAE,MAAM,gBAAgB,CAAC;AACjG,OAAO,EAAE,cAAc,EAAmD,MAAM,YAAY,CAAC;AAE7F,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"}
1
+ {"version":3,"file":"OpenApi.js","sourceRoot":"","sources":["../src/OpenApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAwB,kBAAkB,EAAoB,MAAM,gCAAgC,CAAC;AAC5G,OAAO,EAA0C,QAAQ,IAAI,WAAW,EAAE,MAAM,gBAAgB,CAAC;AACjG,OAAO,EAAE,cAAc,EAAmD,MAAM,YAAY,CAAC;AAE7F,MAAM,UAAU,WAAW,CAAC,QAAyB,EAAE,WAAmB,EAAE,GAAW,EAAE,WAAoB;IAC3G,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,WAAW,IAAI,GAAG,WAAW,MAAM;SACjD;QACD,OAAO,EAAE,CAAC,EAAE,GAAG,EAAE,WAAW,EAAE,WAAW,IAAI,gBAAgB,EAAE,CAAC;QAChE,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/types.d.ts CHANGED
@@ -16,5 +16,8 @@ export interface SchemaApiFunctionRouteProps<AuthorizersKeys = string> extends A
16
16
  export type SchemaRouteProps<AuthorizerKeys> = ApiRouteProps<AuthorizerKeys> | SchemaApiFunctionRouteProps<AuthorizerKeys>;
17
17
  export interface SchemaApiProps<Authorizers extends Record<string, ApiAuthorizer> = Record<string, ApiAuthorizer>, AuthorizerKeys = keyof Authorizers> extends ApiProps<Authorizers, AuthorizerKeys> {
18
18
  routes?: Record<string, SchemaRouteProps<AuthorizerKeys>>;
19
+ title?: string;
20
+ description?: string;
21
+ uri?: string;
19
22
  }
20
23
  //# sourceMappingURL=types.d.ts.map
@@ -1 +1 @@
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"}
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;IAC1D,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@flipdish/cdk-constructs",
3
- "version": "0.50.0",
3
+ "version": "0.51.0",
4
4
  "description": "CDK Constructs for Flipdish serverless applications",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",