refactor(cdk-rpc-api): rename to RpcApi

.changeset/hungry-tomatoes-remember.md

@@ -0,0 +1,5 @@
+---
+"@codedazur/cdk-rpc-api": major
+---
+
+stable release

apps/infrastructure/stacks/Storybook.ts

@@ -1,6 +1,5 @@
-import { StaticSite } from "@codedazur/cdk-static-site";
-import { App, Stack, StackProps } from "aws-cdk-lib";
 import { env } from "@codedazur/essentials";
+import { App, Stack, StackProps } from "aws-cdk-lib";
 import { ToolkitSite } from "../constructs/ToolkitSite";
 
 export class Storybook extends Stack {

apps/infrastructure/stacks/Website.ts

@@ -1,6 +1,5 @@
-import { StaticSite } from "@codedazur/cdk-static-site";
-import { App, Stack, StackProps } from "aws-cdk-lib";
 import { env } from "@codedazur/essentials";
+import { App, Stack, StackProps } from "aws-cdk-lib";
 import { ToolkitSite } from "../constructs/ToolkitSite";
 
 export class Website extends Stack {

packages/cdk-rpc-api/README.md

@@ -0,0 +1 @@
+# @codedazur/cdk-rpc-api

packages/cdk-api/constructs/RestApi.ts → packages/cdk-rpc-api/constructs/RpcApi.ts

@@ -17,8 +17,8 @@ import {
 import { ApiGateway } from "aws-cdk-lib/aws-route53-targets";
 import { Construct } from "constructs";
 
-export interface ApiProps extends RestApiProps {
-  endpoints: Record<string, ResourceProps>;
+export interface RpcApiProps extends RestApiProps {
+  procedures: Record<string, ProcedureProps>;
   domain?: DomainProps;
 }
 
@@ -27,33 +27,64 @@ interface DomainProps {
   subdomain?: string;
 }
 
-interface ResourceProps {
+interface ProcedureProps {
   method?: HttpMethod;
   handler?: IFunction;
-  endpoints?: Record<string, ResourceProps>;
+  procedures?: Record<string, ProcedureProps>;
 }
 
-export class Api extends RestApi {
-  constructor(scope: Construct, id: string, { endpoints, ...props }: ApiProps) {
+/**
+ * A construct to create a Remote Procedure Call API on API Gateway.
+ *
+ * @example
+ * new RpcApi(this, "MyRpcApi", {
+ *   procedures: {
+ *     helloWorld: {
+ *       method: HttpMethod.GET,
+ *       handler: helloWorldHandler,
+ *     },
+ *     search: {
+ *       method: HttpMethod.GET,
+ *       handler: searchHandler,
+ *       procedures: {
+ *         createIndex: {
+ *           method: HttpMethod.POST,
+ *           handler: createIndexHandler,
+ *         },
+ *         flushIndex: {
+ *           method: HttpMethod.DELETE,
+ *           handler: flushIndexHandler,
+ *         },
+ *       },
+ *     },
+ *   },
+ * });
+ */
+export class RpcApi extends RestApi {
+  constructor(
+    scope: Construct,
+    id: string,
+    { procedures: endpoints, ...props }: RpcApiProps,
+  ) {
     super(scope, id, props);
 
-    this.createEndpoints(this.root, endpoints);
+    this.createProcedures(this.root, endpoints);
     this.createDomain(props.domain);
   }
 
-  protected createEndpoints(
+  protected createProcedures(
     parent: IResource,
-    children: Record<string, ResourceProps>,
+    children: Record<string, ProcedureProps>,
   ) {
     Object.entries(children).forEach(([slug, child]) =>
-      this.createEndpoint(parent, slug, child),
+      this.createProcedure(parent, slug, child),
     );
   }
 
-  protected createEndpoint(
+  protected createProcedure(
     parent: IResource,
     slug: string,
-    { method, handler, endpoints }: ResourceProps,
+    { method, handler, procedures: endpoints }: ProcedureProps,
   ) {
     const resource = parent.addResource(slug, {
       defaultIntegration:
@@ -65,7 +96,7 @@ export class Api extends RestApi {
     }
 
     if (endpoints) {
-      this.createEndpoints(resource, endpoints);
+      this.createProcedures(resource, endpoints);
     }
   }
 

packages/cdk-rpc-api/index.ts

@@ -0,0 +1 @@
+export * from "./constructs/RpcApi";

packages/cdk-api/package.json → packages/cdk-rpc-api/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@codedazur/cdk-rest-api",
+  "name": "@codedazur/cdk-rpc-api",
   "version": "0.0.0",
   "main": "./index.ts",
   "types": "./index.ts",