Include the scope in the package name, and more (#24)

* chore: bump dependencies

* chore: replace npm with run-s from npm-run-all2

Makes the scripts package manager agnostic.

* chore: include scope `@codemonger-io` in package name

* chore(example): bump dependencies

* chore(example): include scope `@codemonger-io` in package name

* docs: update README.md

- Includes the scope `@codemonger-io` in the package name
- Replaces `npm` with `pnpm`

* docs(example): update README

Includes the scope `@codemonger-io` in the package name.

* chore: configure pnpm workspace

Configures the pnpm workspace that includes:
- the root directory
- the `example` directory

The `example` package installs `@codemonger-io/cdk-rest-api-with-spec`
from the workspace.

* docs: update API documentation

* chore: clean dist folder on build

The `build` script removes the `dist` folder before building.

* chore: bump version to 0.3.0

Author: kikuomax

README.ja.md

@@ -1,8 +1,8 @@
 [English](./README.md) / 日本語
 
-# cdk-rest-api-with-spec
+# @codemonger-io/cdk-rest-api-with-spec
 
-[Amazon API Gateway (API Gateway)](https://docs.aws.amazon.com/apigateway/latest/developerguide/welcome.html)のREST APIとその[OpenAPI](https://spec.openapis.org/oas/latest.html)定義を`cdk-rest-api-with-spec`で一度に記述。
+[Amazon API Gateway (API Gateway)](https://docs.aws.amazon.com/apigateway/latest/developerguide/welcome.html)のREST APIとその[OpenAPI](https://spec.openapis.org/oas/latest.html)定義を`@codemonger-io/cdk-rest-api-with-spec`で一度に記述。
 
 ## 誰のためのライブラリ?
 
@@ -12,7 +12,7 @@
 ## 事前準備
 
 [Node.js](https://nodejs.org/en/) v12かそれ以降をインストールしてください。
-このライブラリはNode.js v16.xで開発しました。
+このライブラリはNode.js v22.xで開発しました。
 
 このライブラリはCDK**バージョン2** (CDK v2)向けに実装されており、CDKバージョン1には対応していません。
 
@@ -21,7 +21,7 @@
 このレポジトリを依存関係(`dependencies`)に追加してください。
 
 ```sh
-npm install https://github.com/codemonger-io/cdk-rest-api-with-spec.git#v0.2.3
+npm install https://github.com/codemonger-io/cdk-rest-api-with-spec.git#v0.3.0
 ```
 
 このライブラリはCDK v2プロジェクトで使用することを想定しており、以下のモジュールは`dependencies`ではなく`peerDependencies`に含んでいます。
@@ -320,13 +320,13 @@ const authorizer = augmentAuthorizer(
 ### 依存関係を解決する
 
 ```sh
-npm install
+pnpm install
 ```
 
 ### ライブラリをビルドする
 
 ```sh
-npm run build
+pnpm build
 ```
 
 `dist`フォルダ内で以下のファイルが作成または更新されます。
@@ -341,7 +341,7 @@ npm run build
 ### ドキュメンテーションを生成する
 
 ```sh
-npm run doc
+pnpm doc
 ```
 
 [`api-docs/markdown`](./api-docs/markdown)フォルダのコンテンツを置き換えます。

README.md

@@ -1,8 +1,8 @@
 English / [日本語](./README.ja.md)
 
-# cdk-rest-api-with-spec
+# @codemonger-io/cdk-rest-api-with-spec
 
-Describe an [Amazon API Gateway (API Gateway)](https://docs.aws.amazon.com/apigateway/latest/developerguide/welcome.html) REST API and the [OpenAPI](https://spec.openapis.org/oas/latest.html) definition at once with `cdk-rest-api-with-spec`.
+Describe an [Amazon API Gateway (API Gateway)](https://docs.aws.amazon.com/apigateway/latest/developerguide/welcome.html) REST API and the [OpenAPI](https://spec.openapis.org/oas/latest.html) definition at once with `@codemonger-io/cdk-rest-api-with-spec`.
 
 ## For whom is this library?
 
@@ -12,7 +12,7 @@ See ["Background"](#background) for more details.
 ## Prerequisites
 
 You have to install [Node.js](https://nodejs.org/en/) v12 or later.
-I have developed this library with Node.js v16.x.
+I have developed this library with Node.js v22.x.
 
 This library is implemented for the CDK **version 2** (CDK v2) and does not work with the CDK version 1.
 
@@ -21,7 +21,7 @@ This library is implemented for the CDK **version 2** (CDK v2) and does not work
 Please add this repository to your dependencies.
 
 ```sh
-npm install https://github.com/codemonger-io/cdk-rest-api-with-spec.git#v0.2.3
+npm install https://github.com/codemonger-io/cdk-rest-api-with-spec.git#v0.3.0
 ```
 
 This library is supposed to be used in a CDK v2 project, so it does not include the following modules in the `dependencies` but does in the `peerDependencies`.
@@ -320,13 +320,13 @@ The latest API documentation is available on [`api-docs/markdown/index.md`](./ap
 ### Resolving dependencies
 
 ```sh
-npm install
+pnpm install
 ```
 
 ### Building the library
 
 ```sh
-npm run build
+pnpm build
 ```
 
 You will find the following files created or updated in the `dist` folder,
@@ -341,7 +341,7 @@ You will also find the file [`api-docs/cdk-rest-api-with-spec.api.md`](./api-doc
 ### Generating the documentation
 
 ```sh
-npm run doc
+pnpm doc
 ```
 
 This will replace the contents of the [`api-docs/markdown`](./api-docs/markdown) folder.

api-docs/cdk-rest-api-with-spec.api.md

@@ -1,4 +1,4 @@
-## API Report File for "cdk-rest-api-with-spec"
+## API Report File for "@codemonger-io/cdk-rest-api-with-spec"
 
 > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
 

api-docs/markdown/cdk-rest-api-with-spec.augmentauthorizer.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [cdk-rest-api-with-spec](./cdk-rest-api-with-spec.md) &gt; [augmentAuthorizer](./cdk-rest-api-with-spec.augmentauthorizer.md)
+[Home](./index.md) &gt; [@codemonger-io/cdk-rest-api-with-spec](./cdk-rest-api-with-spec.md) &gt; [augmentAuthorizer](./cdk-rest-api-with-spec.augmentauthorizer.md)
 
 ## augmentAuthorizer() function
 
@@ -17,11 +17,55 @@ export declare function augmentAuthorizer(authorizer: apigateway.IAuthorizer, se
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  authorizer | apigateway.IAuthorizer | Authorizer to be augmented. |
-|  securitySchemeObject | SecuritySchemeObject | Security scheme object to add to <code>authorizer</code>. |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+authorizer
+
+
+</td><td>
+
+apigateway.IAuthorizer
+
+
+</td><td>
+
+Authorizer to be augmented.
+
+
+</td></tr>
+<tr><td>
+
+securitySchemeObject
+
+
+</td><td>
+
+SecuritySchemeObject
+
+
+</td><td>
+
+Security scheme object to add to `authorizer`<!-- -->.
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 [IAuthorizerWithSpec](./cdk-rest-api-with-spec.iauthorizerwithspec.md)

api-docs/markdown/cdk-rest-api-with-spec.iauthorizerwithspec.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [cdk-rest-api-with-spec](./cdk-rest-api-with-spec.md) &gt; [IAuthorizerWithSpec](./cdk-rest-api-with-spec.iauthorizerwithspec.md)
+[Home](./index.md) &gt; [@codemonger-io/cdk-rest-api-with-spec](./cdk-rest-api-with-spec.md) &gt; [IAuthorizerWithSpec](./cdk-rest-api-with-spec.iauthorizerwithspec.md)
 
 ## IAuthorizerWithSpec interface
 
@@ -18,7 +18,44 @@ export interface IAuthorizerWithSpec extends apigateway.IAuthorizer
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [securitySchemeObject?](./cdk-rest-api-with-spec.iauthorizerwithspec.securityschemeobject.md) |  | SecuritySchemeObject | **_(BETA)_** _(Optional)_ Security scheme object representing this authorizer. |
+<table><thead><tr><th>
 
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[securitySchemeObject?](./cdk-rest-api-with-spec.iauthorizerwithspec.securityschemeobject.md)
+
+
+</td><td>
+
+
+</td><td>
+
+SecuritySchemeObject
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_ Security scheme object representing this authorizer.
+
+
+</td></tr>
+</tbody></table>

api-docs/markdown/cdk-rest-api-with-spec.iauthorizerwithspec.securityschemeobject.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [cdk-rest-api-with-spec](./cdk-rest-api-with-spec.md) &gt; [IAuthorizerWithSpec](./cdk-rest-api-with-spec.iauthorizerwithspec.md) &gt; [securitySchemeObject](./cdk-rest-api-with-spec.iauthorizerwithspec.securityschemeobject.md)
+[Home](./index.md) &gt; [@codemonger-io/cdk-rest-api-with-spec](./cdk-rest-api-with-spec.md) &gt; [IAuthorizerWithSpec](./cdk-rest-api-with-spec.iauthorizerwithspec.md) &gt; [securitySchemeObject](./cdk-rest-api-with-spec.iauthorizerwithspec.securityschemeobject.md)
 
 ## IAuthorizerWithSpec.securitySchemeObject property
 

api-docs/markdown/cdk-rest-api-with-spec.iresourcewithspec.addmethod.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [cdk-rest-api-with-spec](./cdk-rest-api-with-spec.md) &gt; [IResourceWithSpec](./cdk-rest-api-with-spec.iresourcewithspec.md) &gt; [addMethod](./cdk-rest-api-with-spec.iresourcewithspec.addmethod.md)
+[Home](./index.md) &gt; [@codemonger-io/cdk-rest-api-with-spec](./cdk-rest-api-with-spec.md) &gt; [IResourceWithSpec](./cdk-rest-api-with-spec.iresourcewithspec.md) &gt; [addMethod](./cdk-rest-api-with-spec.iresourcewithspec.addmethod.md)
 
 ## IResourceWithSpec.addMethod() method
 
@@ -17,12 +17,69 @@ addMethod(httpMethod: string, target?: apigateway.Integration, options?: MethodO
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  httpMethod | string |  |
-|  target | apigateway.Integration | _(Optional)_ |
-|  options | [MethodOptionsWithSpec](./cdk-rest-api-with-spec.methodoptionswithspec.md) | _(Optional)_ |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+httpMethod
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+target
+
+
+</td><td>
+
+apigateway.Integration
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+options
+
+
+</td><td>
+
+[MethodOptionsWithSpec](./cdk-rest-api-with-spec.methodoptionswithspec.md)
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 apigateway.Method

api-docs/markdown/cdk-rest-api-with-spec.iresourcewithspec.addresource.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [cdk-rest-api-with-spec](./cdk-rest-api-with-spec.md) &gt; [IResourceWithSpec](./cdk-rest-api-with-spec.iresourcewithspec.md) &gt; [addResource](./cdk-rest-api-with-spec.iresourcewithspec.addresource.md)
+[Home](./index.md) &gt; [@codemonger-io/cdk-rest-api-with-spec](./cdk-rest-api-with-spec.md) &gt; [IResourceWithSpec](./cdk-rest-api-with-spec.iresourcewithspec.md) &gt; [addResource](./cdk-rest-api-with-spec.iresourcewithspec.addresource.md)
 
 ## IResourceWithSpec.addResource() method
 
@@ -17,11 +17,53 @@ addResource(pathPart: string, options?: ResourceOptionsWithSpec): IResourceWithS
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  pathPart | string |  |
-|  options | [ResourceOptionsWithSpec](./cdk-rest-api-with-spec.resourceoptionswithspec.md) | _(Optional)_ |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+pathPart
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+options
+
+
+</td><td>
+
+[ResourceOptionsWithSpec](./cdk-rest-api-with-spec.resourceoptionswithspec.md)
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 [IResourceWithSpec](./cdk-rest-api-with-spec.iresourcewithspec.md)