feat: Add CRUD example; Parse and validate request.body (#8)

.changeset/hot-pots-divide.md

@@ -0,0 +1,5 @@
+---
+"@flare-city/core": minor
+---
+
+Adds another example & template that details CRUD setup; Allows parsing of request.body

packages/cli/examples/with-crud/.eslintrc.cjs

@@ -0,0 +1,8 @@
+const path = require("path");
+
+module.exports = {
+  extends: "@flare-city/eslint-config",
+  parserOptions: {
+    project: path.resolve(__dirname, "./tsconfig.json"),
+  },
+};

packages/cli/examples/with-crud/.gitignore

@@ -0,0 +1,4 @@
+node_modules
+# Keep environment variables out of version control
+.env
+.wrangler

packages/cli/examples/with-crud/eslint.config.cjs

@@ -0,0 +1,8 @@
+const path = require("path");
+
+module.exports = {
+  extends: "@flare-city/eslint-config",
+  parserOptions: {
+    project: path.resolve(__dirname, "./tsconfig.json"),
+  },
+};

packages/cli/examples/with-crud/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "with-crud",
+  "version": "0.0.0",
+  "private": true,
+  "description": "with-crud",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "license": "MIT",
+  "scripts": {
+    "deploy": "wrangler deploy",
+    "dev": "wrangler dev --port=8282",
+    "build": "yarn tsc --project tsconfig.types.json",
+    "test": "yarn flare-city test",
+    "lint": "npx eslint . --fix"
+  },
+  "dependencies": {
+    "@flare-city/core": "workspace:*",
+    "@flare-city/logger": "workspace:*",
+    "zod": "3.22.4"
+  },
+  "devDependencies": {
+    "@cloudflare/workers-types": "latest",
+    "@flare-city/cli": "workspace:*",
+    "@flare-city/eslint-config": "workspace:*",
+    "@flare-city/test": "workspace:*",
+    "@flare-city/tsconfig": "workspace:*",
+    "@types/node": "20.8.9",
+    "dotenv-cli": "7.3.0",
+    "typescript": "5.2.2",
+    "wrangler": "3.15.0"
+  }
+}

packages/cli/examples/with-crud/src/features/index.ts

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

packages/cli/examples/with-crud/src/features/post/index.ts

@@ -0,0 +1,4 @@
+export * from "./post.route";
+
+// GET
+export * from "./post.crud";

packages/cli/examples/with-crud/src/features/post/post.crud.spec.ts

@@ -0,0 +1,15 @@
+import { WorkerTest } from "@flare-city/test";
+import { expect, test, describe } from "vitest";
+import type { GetAllPostsApiResponse } from "./post.crud";
+
+describe("GET /post", () => {
+  let worker: WorkerTest;
+
+  test("Should response with 2 entries", async () => {
+    worker = new WorkerTest(global.worker);
+    const res = await worker.get<GetAllPostsApiResponse>({
+      endpoint: "/post",
+    });
+    expect(res.json.data).toHaveLength(2);
+  });
+});

packages/cli/examples/with-crud/src/features/post/post.crud.ts

@@ -0,0 +1,164 @@
+import type { ApiResponse, RequestURLSegments } from "@flare-city/core";
+import { RoutePost } from "./post.route";
+import { z } from "zod";
+
+// Post Schema
+const PostSchema = z.object({
+  title: z.string(),
+  description: z.string(),
+});
+
+// Segments
+const PostApiSegmentsSchema = z.object({ id: z.string() });
+export type PostApiSegments = z.infer<typeof PostApiSegmentsSchema>;
+
+// GET Response & Params
+const GetSinglePostApiResponseSchema = PostSchema.extend({ id: z.string() });
+export type GetSinglePostApiResponse = ApiResponse<
+  z.infer<typeof GetSinglePostApiResponseSchema>
+>;
+
+// GET All Response & Params
+export type GetAllPostsApiResponse = ApiResponse<
+  z.infer<typeof GetSinglePostApiResponseSchema>[]
+>;
+const GetAllPostsApiSearchParamsSchema = z.object({
+  search: z.string().optional(),
+  amount: z.coerce.number().optional(),
+  type: z.union([z.literal("test-1"), z.literal("test-2")]).optional(),
+});
+export type GetAllPostsApiSearchParams = z.infer<
+  typeof GetAllPostsApiSearchParamsSchema
+>;
+
+// POST & PUT Request
+const CreateSinglePostApiRequestSchema = PostSchema;
+export type CreateSinglePostApiRequest = z.infer<
+  typeof CreateSinglePostApiRequestSchema
+>;
+export type CreateSinglePostApiResponse = GetSinglePostApiResponse;
+
+/**
+ * Get's all of the posts
+ * @description GET /post
+ */
+RoutePost.get<
+  GetAllPostsApiResponse,
+  RequestURLSegments,
+  GetAllPostsApiSearchParams
+>({
+  path: "",
+  parse: {
+    params: GetAllPostsApiSearchParamsSchema,
+  },
+  handler: async (req, env, context, res) => {
+    return res({
+      json: {
+        data: [
+          {
+            id: "1",
+            title: "post title",
+            description: "post description",
+          },
+          {
+            id: "2",
+            title: "post title",
+            description: "post description",
+          },
+        ],
+      },
+      status: 200,
+    });
+  },
+});
+
+/**
+ * Get's a single post by ID
+ * @description GET /post/:id
+ */
+RoutePost.get<GetSinglePostApiResponse, PostApiSegments>({
+  path: "/:id",
+  parse: {
+    segments: PostApiSegmentsSchema,
+  },
+  handler: async (req, env, context, res) => {
+    return res({
+      json: {
+        data: {
+          id: context.segments.id,
+          title: "post title",
+          description: "post description",
+        },
+      },
+      status: 200,
+    });
+  },
+});
+
+/**
+ * Creates a new post
+ * @description POST /post
+ */
+RoutePost.post<CreateSinglePostApiResponse, CreateSinglePostApiRequest>({
+  path: "",
+  parse: {
+    body: CreateSinglePostApiRequestSchema,
+  },
+  handler: async (req, env, context, res) => {
+    return res({
+      json: {
+        data: {
+          id: "1",
+          description: context.body.description,
+          title: context.body.title,
+        },
+      },
+      status: 200,
+    });
+  },
+});
+
+/**
+ * Updates a post with the provided :id segment
+ * @description PUT /post/:id
+ */
+RoutePost.put<CreateSinglePostApiResponse, CreateSinglePostApiRequest>({
+  path: "/:id",
+  parse: {
+    segments: PostApiSegmentsSchema,
+    body: CreateSinglePostApiRequestSchema,
+  },
+  handler: async (req, env, context, res) => {
+    return res({
+      json: {
+        data: {
+          id: context.segments.id,
+          title: context.body.title,
+          description: context.body.description,
+        },
+      },
+      status: 200,
+    });
+  },
+});
+
+/**
+ * Deletes a post with the provided :id segment
+ * @description DELETE /post/:id
+ */
+RoutePost.delete({
+  path: "/:id",
+  parse: {
+    segments: PostApiSegmentsSchema,
+  },
+  handler: async (req, env, context, res) => {
+    return res({
+      json: {
+        data: {
+          message: "Running the DELETE handler",
+        },
+      },
+      status: 200,
+    });
+  },
+});

packages/cli/examples/with-crud/src/features/post/post.route.ts

@@ -0,0 +1,3 @@
+import { Route } from "@flare-city/core";
+
+export const RoutePost = new Route({ root: "/post" });

packages/cli/examples/with-crud/src/index.ts

@@ -0,0 +1,11 @@
+import { App } from "@flare-city/core";
+import { RoutePost } from "./features";
+
+// Declare a new application
+export const API = new App("with-crud");
+
+// Add routes
+API.addRoute(RoutePost);
+
+// Start the API
+export default API.start();

packages/cli/examples/with-crud/src/lib/index.ts

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

packages/cli/examples/with-crud/src/lib/logger/index.ts

@@ -0,0 +1,6 @@
+import { WorkersLogger } from "@flare-city/logger";
+
+export const log = new WorkersLogger({
+  name: "with-crud",
+  level: "debug",
+});

packages/cli/examples/with-crud/src/types/env.ts

@@ -0,0 +1,15 @@
+import type {
+  RequestURLSearchParams,
+  RequestURLSegments,
+} from "@flare-city/core";
+
+declare global {
+  interface ExecutionContext<
+    T extends RequestURLSegments = RequestURLSegments,
+    P extends RequestURLSearchParams = RequestURLSearchParams,
+  > {
+    segments: T;
+    params: P;
+    sample: string;
+  }
+}

packages/cli/examples/with-crud/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "@flare-city/tsconfig/worker",
+  "compilerOptions": {
+    "types": ["@flare-city/test/types"]
+  },
+  "include": ["./src/**/*.ts"]
+}

packages/cli/examples/with-crud/tsconfig.types.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "noEmit": false,
+    "emitDeclarationOnly": true,
+    "declaration": true,
+    "declarationDir": "./dist"
+  }
+}

packages/cli/examples/with-crud/vitest.config.ts

@@ -0,0 +1,7 @@
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+  test: {
+    setupFiles: ["@flare-city/test/setup"],
+  },
+});