create-faas-app 8.0.0-beta.25 → 8.0.0-beta.27

package/README.md

@@ -1,5 +1,77 @@
 # create-faas-app
 
-## Functions
+Create a new FaasJS app from a curated starter template.
+
+FaasJS is optimized for database-driven React business applications. `create-faas-app` gives new projects a working starting point for the official path instead of asking every team to assemble React, API, database, testing, and UI conventions from scratch.
+
+## Quick Start
+
+```bash
+npx create-faas-app --name my-faas-app
+cd my-faas-app
+npm run dev
+```
+
+The default template is `admin`, which demonstrates the curated React + Ant Design + PostgreSQL path.
+
+## Templates
+
+### `admin`
+
+Use `admin` for the golden-path FaasJS starter.
+
+```bash
+npx create-faas-app --name my-admin --template admin
+```
+
+It includes:
+
+- React app structure powered by Vite Plus
+- `@faasjs/ant-design` and Ant Design for business UI
+- `defineApi` endpoints for typed backend APIs
+- a copyable users slice with create, list, detail, update, migration, table types, and API tests
+- `@faasjs/pg` for PostgreSQL access and migrations
+- `@faasjs/pg-dev` for pg-dev-powered tests
+- `.env.example` for local database configuration
+- type declarations for PostgreSQL table inference
+
+This is the best starting point for admin panels, internal tools, SaaS dashboards, and other database-driven business applications.
+
+### `minimal`
+
+Use `minimal` when you want a smaller React starter without the database and Ant Design stack.
+
+```bash
+npx create-faas-app --name my-minimal-app --template minimal
+```
+
+It is useful for learning the core FaasJS runtime, building API-only or BFF-style projects, or adding a custom UI/database path intentionally.
+
+## Recommended Path
+
+Start with `admin` unless you have a specific reason not to. It shows how FaasJS expects complete application slices to fit together:
+
+- UI pages call typed APIs
+- APIs validate inputs at system boundaries
+- APIs use PostgreSQL through the shared database workflow
+- migrations and table types keep data contracts explicit
+- tests cover the API and database behavior
+
+FaasJS allows teams to replace parts of the stack, but the templates, docs, and examples optimize this curated path first.
+
+## Auth And Permissions
+
+Authentication and permissions are intentionally not built into FaasJS core because production auth requirements vary by product.
+
+The admin starter includes a small auth plugin demo. Treat it as a plugin pattern that shows how to inject current-user context, protect APIs, and model project-specific permissions. It is not a mandatory framework auth system.
+
+## Next Steps
+
+- Read the FaasJS guide at <https://faasjs.com/guide/>.
+- Review the root README for the project direction and package overview.
+- Explore runnable templates in <https://github.com/faasjs/faasjs/tree/main/templates>.
+- Use the admin starter users slice as the reference for complete UI/API/database/test examples.
+
+## API Docs
 
 - [main](functions/main.md)

package/dist/index.mjs

@@ -6,12 +6,13 @@ import { dirname, join } from "node:path";
 import { fileURLToPath } from "node:url";
 import enquirer from "enquirer";
 //#region package.json
-var version = "8.0.0-beta.24";
+var version = "8.0.0-beta.26";
 //#endregion
-//#region src/action.ts
+//#region src/action/index.ts
 const prompt = enquirer.prompt;
 const validateName = (input) => Validator.name(input);
-const templateRoot = join(dirname(fileURLToPath(import.meta.url)), "..", "template");
+const templateRoot = join(dirname(fileURLToPath(import.meta.url)), "..", "..", "template");
+const ignoredTemplateEntries = new Set(["node_modules"]);
 const Validator = { name(input) {
 	const match = /^[a-z0-9-_]+$/i.test(input) ? true : "Must be a-z, 0-9 or -_";
 	if (match !== true) return match;
@@ -21,7 +22,7 @@ const Validator = { name(input) {
 function getTemplateNames() {
 	return readdirSync(templateRoot, { withFileTypes: true }).filter((entry) => entry.isDirectory()).map((entry) => entry.name).sort();
 }
-function resolveTemplateName(template = "basic") {
+function resolveTemplateName(template = "admin") {
 	const templates = getTemplateNames();
 	if (templates.includes(template)) return template;
 	throw new Error(`Unknown template "${template}". Available templates: ${templates.join(", ")}`);
@@ -35,6 +36,7 @@ function generateSessionSecret() {
 function copyTemplateDirectory(sourcePath, targetPath, replacements) {
 	mkdirSync(targetPath, { recursive: true });
 	for (const entry of readdirSync(sourcePath, { withFileTypes: true })) {
+		if (ignoredTemplateEntries.has(entry.name)) continue;
 		const nextSourcePath = join(sourcePath, entry.name);
 		const nextTargetPath = join(targetPath, entry.name === "gitignore" ? ".gitignore" : entry.name);
 		if (entry.isDirectory()) {
@@ -53,14 +55,14 @@ function scaffold(rootPath, replacements, templateName) {
 *
 * @param {object} [options] - Optional CLI arguments used to choose the project name and template.
 * @param {string} [options.name] - Target folder name for the generated app.
-* @param {string} [options.template] - Template name such as `basic` or `antd`.
+* @param {string} [options.template] - Template name such as `admin` or `minimal`.
 * @returns {Promise<void>} Resolves after the project is generated and its test command finishes.
 * @throws {Error} When the selected template is unknown.
 * @example
 * ```ts
 * await action({
 *   name: 'faasjs-demo',
-*   template: 'basic',
+*   template: 'admin',
 * })
 * ```
 */
@@ -75,14 +77,12 @@ async function action(options = {}) {
 		validate: validateName
 	}).then((res) => res.value);
 	if (!answers.name) return;
-	const runtime = process.versions.bun ? "bun" : "npm";
 	scaffold(answers.name, {
 		name: answers.name,
 		secret: generateSessionSecret()
 	}, templateName);
-	execSync(`cd ${answers.name} && ${runtime} install`, { stdio: "inherit" });
-	if (runtime === "bun") execSync(`cd ${answers.name} && bun test`, { stdio: "inherit" });
-	else execSync(`cd ${answers.name} && npm run test`, { stdio: "inherit" });
+	execSync(`cd ${answers.name} && npm install`, { stdio: "inherit" });
+	execSync(`cd ${answers.name} && npm run test`, { stdio: "inherit" });
 }
 /**
 * Register the `create-faas-app` command on a Commander program.
@@ -97,12 +97,17 @@ async function action(options = {}) {
 * ```
 */
 function registerCreateFaasApp(program) {
-	program.description("Create a new faas app").on("--help", () => console.log(`Examples:
+	program.description("Create a new FaasJS app").on("--help", () => console.log(`Examples:
 npx create-faas-app --name faasjs
-npx create-faas-app --name faasjs-admin --template antd
+npx create-faas-app --name faasjs-admin --template admin
+npx create-faas-app --name faasjs-minimal --template minimal
 
 Templates:
-${getTemplateNames().join(", ")}`)).option("--name <name>", "Project name").option("--template <template>", "Template name", "basic").action(action);
+admin: recommended React + Ant Design + PostgreSQL starter
+minimal: lighter React starter
+
+Available:
+${getTemplateNames().join(", ")}`)).option("--name <name>", "Project name").option("--template <template>", "Template name", "admin").action(action);
 }
 //#endregion
 //#region src/index.ts
@@ -115,13 +120,9 @@ ${getTemplateNames().join(", ")}`)).option("--name <name>", "Project name").opti
 * ## Usage
 *
 * ```bash
-* # use npm
 * npx create-faas-app --name faasjs
-* npx create-faas-app --name faasjs-admin --template antd
-*
-* # use bun
-* bunx create-faas-app --name faasjs
-* bunx create-faas-app --name faasjs-admin --template antd
+* npx create-faas-app --name faasjs-admin --template admin
+* npx create-faas-app --name faasjs-minimal --template minimal
 * ```
 */
 const commander = new Command();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-faas-app",
-  "version": "8.0.0-beta.25",
+  "version": "8.0.0-beta.27",
   "homepage": "https://faasjs.com/doc/create-faas-app",
   "bugs": {
     "url": "https://github.com/faasjs/faasjs/issues"

package/template/admin/.env.example

@@ -0,0 +1 @@
+DATABASE_URL=postgres://postgres:postgres@127.0.0.1:5432/{{name}}

package/template/{antd → admin}/gitignore

@@ -1,3 +1,4 @@
 node_modules/
 dist/
 coverage/
+.env

package/template/admin/migrations/20250101000000_create_users.ts

@@ -0,0 +1,12 @@
+import type { SchemaBuilder } from '@faasjs/pg'
+
+export function up(builder: SchemaBuilder) {
+  builder.createTable('users', (table) => {
+    table.specificType('id', 'serial').primary()
+    table.string('name')
+  })
+}
+
+export function down(builder: SchemaBuilder) {
+  builder.dropTable('users')
+}

package/template/{basic → admin}/package.json

@@ -7,14 +7,21 @@
     "dev": "vp dev",
     "build": "vp build",
     "start": "node --import @faasjs/node-utils/register-hooks server.ts",
-    "test": "vp test"
-  },
-  "dependencies": {
-    "@faasjs/core": "*",
-    "@faasjs/react": "*"
+    "test": "vp test",
+    "db:new": "faasjs-pg new",
+    "db:status": "faasjs-pg status",
+    "db:migrate": "faasjs-pg migrate",
+    "db:up": "faasjs-pg up",
+    "db:down": "faasjs-pg down"
   },
   "devDependencies": {
-    "@faasjs/dev": "*"
+    "@faasjs/dev": "*",
+    "@faasjs/pg-dev": "*"
+  },
+  "peerDependencies": {
+    "@faasjs/ant-design": "*",
+    "@faasjs/core": "*",
+    "@faasjs/pg": "*"
   },
   "overrides": {
     "vite": "npm:@voidzero-dev/vite-plus-core",

package/template/admin/src/pages/home/api/auth/__tests__/me.test.ts

@@ -0,0 +1,39 @@
+import { testApi } from '@faasjs/dev'
+import { describe, expect, it } from 'vitest'
+
+import api from '../me.api'
+
+describe('pages/home/api/auth/me', () => {
+  it('returns the current user from the auth plugin demo', async () => {
+    const handler = testApi(api)
+
+    const { statusCode, data } = await handler(
+      {},
+      {
+        headers: {
+          authorization: 'Bearer demo-admin',
+        },
+      },
+    )
+
+    expect(statusCode).toEqual(200)
+    expect(data).toEqual({
+      current_user: {
+        id: 1,
+        name: 'Demo Admin',
+        role: 'admin',
+      },
+    })
+  })
+
+  it('rejects requests without the demo token', async () => {
+    const handler = testApi(api)
+
+    const { statusCode, error } = await handler()
+
+    expect(statusCode).toEqual(401)
+    expect(error).toEqual({
+      message: 'Missing demo auth token',
+    })
+  })
+})

package/template/admin/src/pages/home/api/auth/me.api.ts

@@ -0,0 +1,21 @@
+import { defineApi, HttpError } from '@faasjs/core'
+
+import { AuthPlugin } from '../../../../plugins/auth'
+
+const api = defineApi({
+  async handler({ current_user }) {
+    if (!current_user)
+      throw new HttpError({
+        statusCode: 401,
+        message: 'Missing demo auth token',
+      })
+
+    return {
+      current_user,
+    }
+  },
+})
+
+api.plugins.unshift(new AuthPlugin())
+
+export default api

package/template/admin/src/pages/home/api/users/__tests__/create.test.ts

@@ -0,0 +1,47 @@
+import { testApi } from '@faasjs/dev'
+import { getClient } from '@faasjs/pg'
+import { describe, expect, it } from 'vitest'
+
+import api from '../create.api'
+
+describe('pages/home/api/users/create', () => {
+  it('creates a user with the shared pg bootstrap', async () => {
+    const handler = testApi(api)
+
+    const { statusCode, data } = await handler({ name: 'world' })
+
+    expect(statusCode).toEqual(200)
+    expect(data).toEqual({
+      message: 'Created user #1',
+      total: 1,
+      user: {
+        id: 1,
+        name: 'world',
+      },
+    })
+
+    const client = await getClient()
+
+    await expect(client.query('users').orderBy('id', 'ASC')).resolves.toEqual([
+      {
+        id: 1,
+        name: 'world',
+      },
+    ])
+  })
+
+  it('uses the default name when params.name is missing', async () => {
+    const handler = testApi(api)
+
+    const { data } = await handler({})
+
+    expect(data).toEqual({
+      message: 'Created user #1',
+      total: 1,
+      user: {
+        id: 1,
+        name: 'FaasJS',
+      },
+    })
+  })
+})

package/template/admin/src/pages/home/api/users/__tests__/detail.test.ts

@@ -0,0 +1,39 @@
+import { testApi } from '@faasjs/dev'
+import { getClient } from '@faasjs/pg'
+import { describe, expect, it } from 'vitest'
+
+import api from '../detail.api'
+
+describe('pages/home/api/users/detail', () => {
+  it('returns one user', async () => {
+    const client = await getClient()
+    const [created] = await client.query('users').insert(
+      {
+        name: 'Ada',
+      },
+      {
+        returning: ['id'],
+      },
+    )
+    const handler = testApi(api)
+    const { statusCode, data } = await handler({ id: created.id })
+
+    expect(statusCode).toEqual(200)
+    expect(data).toEqual({
+      user: {
+        id: created.id,
+        name: 'Ada',
+      },
+    })
+  })
+
+  it('returns 404 when the user is missing', async () => {
+    const handler = testApi(api)
+    const { statusCode, error } = await handler({ id: 404 })
+
+    expect(statusCode).toEqual(404)
+    expect(error).toEqual({
+      message: 'User not found',
+    })
+  })
+})

package/template/admin/src/pages/home/api/users/__tests__/list.test.ts

@@ -0,0 +1,31 @@
+import { testApi } from '@faasjs/dev'
+import { getClient } from '@faasjs/pg'
+import { describe, expect, it } from 'vitest'
+
+import api from '../list.api'
+
+describe('pages/home/api/users/list', () => {
+  it('lists users with total count', async () => {
+    const client = await getClient()
+
+    await client.query('users').insert([{ name: 'Ada' }, { name: 'Grace' }])
+
+    const handler = testApi(api)
+    const { statusCode, data } = await handler({ limit: 10 })
+
+    expect(statusCode).toEqual(200)
+    expect(data).toEqual({
+      total: 2,
+      users: [
+        {
+          id: 2,
+          name: 'Grace',
+        },
+        {
+          id: 1,
+          name: 'Ada',
+        },
+      ],
+    })
+  })
+})

package/template/admin/src/pages/home/api/users/__tests__/update.test.ts

@@ -0,0 +1,51 @@
+import { testApi } from '@faasjs/dev'
+import { getClient } from '@faasjs/pg'
+import { describe, expect, it } from 'vitest'
+
+import api from '../update.api'
+
+describe('pages/home/api/users/update', () => {
+  it('updates one user', async () => {
+    const client = await getClient()
+    const [created] = await client.query('users').insert(
+      {
+        name: 'Ada',
+      },
+      {
+        returning: ['id'],
+      },
+    )
+    const handler = testApi(api)
+    const { statusCode, data } = await handler({
+      id: created.id,
+      name: 'Ada Lovelace',
+    })
+
+    expect(statusCode).toEqual(200)
+    expect(data).toEqual({
+      message: `Updated user #${created.id}`,
+      user: {
+        id: created.id,
+        name: 'Ada Lovelace',
+      },
+    })
+
+    await expect(client.query('users').where('id', created.id).first()).resolves.toEqual({
+      id: created.id,
+      name: 'Ada Lovelace',
+    })
+  })
+
+  it('returns 404 when the user is missing', async () => {
+    const handler = testApi(api)
+    const { statusCode, error } = await handler({
+      id: 404,
+      name: 'Missing',
+    })
+
+    expect(statusCode).toEqual(404)
+    expect(error).toEqual({
+      message: 'User not found',
+    })
+  })
+})

package/template/admin/src/pages/home/api/users/create.api.ts

@@ -0,0 +1,26 @@
+import { defineApi } from '@faasjs/core'
+import { getClient } from '@faasjs/pg'
+import * as z from 'zod'
+
+export default defineApi({
+  schema: z.object({
+    name: z.string().min(1).optional(),
+  }),
+  async handler({ params }) {
+    const client = await getClient()
+    const [user] = await client.query('users').insert(
+      {
+        name: params.name || 'FaasJS',
+      },
+      {
+        returning: ['id', 'name'],
+      },
+    )
+
+    return {
+      message: `Created user #${user.id}`,
+      total: await client.query('users').count(),
+      user,
+    }
+  },
+})

package/template/admin/src/pages/home/api/users/detail.api.ts

@@ -0,0 +1,23 @@
+import { defineApi, HttpError } from '@faasjs/core'
+import { getClient } from '@faasjs/pg'
+import * as z from 'zod'
+
+export default defineApi({
+  schema: z.object({
+    id: z.number().int().positive(),
+  }),
+  async handler({ params }) {
+    const client = await getClient()
+    const user = await client.query('users').select('id', 'name').where('id', params.id).first()
+
+    if (!user)
+      throw new HttpError({
+        statusCode: 404,
+        message: 'User not found',
+      })
+
+    return {
+      user,
+    }
+  },
+})

package/template/admin/src/pages/home/api/users/list.api.ts

@@ -0,0 +1,22 @@
+import { defineApi } from '@faasjs/core'
+import { getClient } from '@faasjs/pg'
+import * as z from 'zod'
+
+export default defineApi({
+  schema: z.object({
+    limit: z.number().int().positive().max(50).default(20),
+  }),
+  async handler({ params }) {
+    const client = await getClient()
+    const users = await client
+      .query('users')
+      .select('id', 'name')
+      .orderBy('id', 'DESC')
+      .limit(params.limit)
+
+    return {
+      total: await client.query('users').count(),
+      users,
+    }
+  },
+})

package/template/admin/src/pages/home/api/users/update.api.ts

@@ -0,0 +1,35 @@
+import { defineApi, HttpError } from '@faasjs/core'
+import { getClient } from '@faasjs/pg'
+import * as z from 'zod'
+
+export default defineApi({
+  schema: z.object({
+    id: z.number().int().positive(),
+    name: z.string().min(1),
+  }),
+  async handler({ params }) {
+    const client = await getClient()
+    const [user] = await client
+      .query('users')
+      .where('id', params.id)
+      .update(
+        {
+          name: params.name,
+        },
+        {
+          returning: ['id', 'name'],
+        },
+      )
+
+    if (!user)
+      throw new HttpError({
+        statusCode: 404,
+        message: 'User not found',
+      })
+
+    return {
+      message: `Updated user #${user.id}`,
+      user,
+    }
+  },
+})

package/template/admin/src/pages/home/index.tsx

@@ -0,0 +1,173 @@
+import { faas, useApp } from '@faasjs/ant-design'
+import { Button, Card, Input, Space, Table, Typography } from 'antd'
+import { useState } from 'react'
+
+type CurrentUserResponse = {
+  current_user?: {
+    id: number
+    name: string
+    role: string
+  }
+}
+
+type UserRecord = {
+  id: number
+  name: string
+}
+
+type ListUsersResponse = {
+  total?: number
+  users?: UserRecord[]
+}
+
+type CreateUserResponse = {
+  message?: string
+  total?: number
+  user?: UserRecord
+}
+
+export default function HomePage() {
+  const app = useApp()
+  const [name, setName] = useState('FaasJS')
+  const [messageText, setMessageText] = useState('Create your first user through the FaasJS API')
+  const [loading, setLoading] = useState(false)
+  const [authLoading, setAuthLoading] = useState(false)
+  const [users, setUsers] = useState<UserRecord[]>([])
+
+  const refreshUsers = async () => {
+    const response = await faas('/pages/home/api/users/list', {
+      limit: 10,
+    })
+    const data = (response.data as ListUsersResponse | undefined) || undefined
+
+    setUsers(data?.users || [])
+  }
+
+  const callApi = async () => {
+    setLoading(true)
+
+    try {
+      const response = await faas('/pages/home/api/users/create', {
+        name: name.trim() || undefined,
+      })
+      const data = (response.data as CreateUserResponse | undefined) || undefined
+      const nextMessage =
+        data?.user && typeof data.total === 'number'
+          ? `Created ${data.user.name} (#${data.user.id}). Total users: ${data.total}`
+          : data?.message || 'Empty response'
+
+      setMessageText(nextMessage)
+      setUsers((current) => (data?.user ? [data.user, ...current].slice(0, 10) : current))
+      app.message.success('User saved to PostgreSQL')
+    } catch (error: unknown) {
+      const errorMessage = error instanceof Error ? error.message : 'Request failed'
+
+      setMessageText(errorMessage)
+      app.notification.error({
+        message: 'API call failed',
+        description: errorMessage,
+      })
+    } finally {
+      setLoading(false)
+    }
+  }
+
+  const callAuthDemo = async () => {
+    setAuthLoading(true)
+
+    try {
+      const response = await faas(
+        '/pages/home/api/auth/me',
+        {},
+        {
+          headers: {
+            authorization: 'Bearer demo-admin',
+          },
+        },
+      )
+      const data = (response.data as CurrentUserResponse | undefined) || undefined
+
+      setMessageText(`Auth plugin injected current user: ${data?.current_user?.name || 'unknown'}`)
+      app.message.success('Auth plugin demo loaded current_user')
+    } catch (error: unknown) {
+      const errorMessage = error instanceof Error ? error.message : 'Auth demo failed'
+
+      setMessageText(errorMessage)
+      app.notification.error({
+        message: 'Auth demo failed',
+        description: errorMessage,
+      })
+    } finally {
+      setAuthLoading(false)
+    }
+  }
+
+  return (
+    <div
+      style={{
+        minHeight: '100vh',
+        display: 'grid',
+        placeItems: 'center',
+        padding: 24,
+        background: 'linear-gradient(135deg, #f5f7fa 0%, #e4ecfb 100%)',
+      }}
+    >
+      <Card
+        style={{
+          width: '100%',
+          maxWidth: 640,
+          boxShadow: '0 20px 45px rgba(15, 23, 42, 0.08)',
+        }}
+      >
+        <Space direction="vertical" size="large" style={{ width: '100%' }}>
+          <div>
+            <Typography.Title level={2}>FaasJS Admin App</Typography.Title>
+            <Typography.Paragraph type="secondary">
+              This starter follows the curated FaasJS path: React, Ant Design, PostgreSQL,
+              pg-dev-powered tests, and a simple auth plugin demo.
+            </Typography.Paragraph>
+            <Typography.Paragraph type="secondary">
+              Set <code>DATABASE_URL</code> from <code>.env.example</code> and run{' '}
+              <code>npm run db:migrate</code> before using the page in development.
+            </Typography.Paragraph>
+          </div>
+
+          <Input
+            value={name}
+            onChange={(event) => setName(event.target.value)}
+            placeholder="Who should the admin app create?"
+          />
+
+          <Space wrap>
+            <Button onClick={refreshUsers}>Load users slice</Button>
+            <Button type="primary" loading={loading} onClick={callApi}>
+              Create /pages/home/api/users/create
+            </Button>
+            <Button loading={authLoading} onClick={callAuthDemo}>
+              Call auth plugin demo
+            </Button>
+          </Space>
+
+          <Table<UserRecord>
+            rowKey="id"
+            size="small"
+            pagination={false}
+            dataSource={users}
+            columns={[
+              {
+                title: 'ID',
+                dataIndex: 'id',
+              },
+              {
+                title: 'Name',
+                dataIndex: 'name',
+              },
+            ]}
+          />
+
+          <Typography.Paragraph style={{ marginBottom: 0 }}>{messageText}</Typography.Paragraph>
+        </Space>
+      </Card>
+    </div>
+  )
+}

package/template/admin/src/plugins/auth.ts

@@ -0,0 +1,25 @@
+import type { InvokeData, Next, Plugin } from '@faasjs/core'
+
+export type CurrentUser = {
+  id: number
+  name: string
+  role: 'admin'
+}
+
+export class AuthPlugin implements Plugin {
+  public readonly name = 'auth'
+  public readonly type = 'auth'
+
+  public async onInvoke(data: InvokeData, next: Next): Promise<void> {
+    const token = data.event?.headers?.authorization || data.event?.headers?.Authorization
+
+    if (token === 'Bearer demo-admin')
+      data.current_user = {
+        id: 1,
+        name: 'Demo Admin',
+        role: 'admin',
+      } satisfies CurrentUser
+
+    await next()
+  }
+}

package/template/admin/src/types/faasjs-auth.d.ts

@@ -0,0 +1,8 @@
+import '@faasjs/core'
+import type { CurrentUser } from '../plugins/auth'
+
+declare module '@faasjs/core' {
+  interface DefineApiInject {
+    current_user?: CurrentUser
+  }
+}

package/template/admin/src/types/faasjs-pg.d.ts

@@ -0,0 +1,10 @@
+import '@faasjs/pg'
+
+declare module '@faasjs/pg' {
+  interface Tables {
+    users: {
+      id: number
+      name: string
+    }
+  }
+}

package/template/admin/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": "@faasjs/types/tsconfig/build.json",
+  "include": ["src", "migrations", "vite.config.ts", "server.ts"]
+}

package/template/admin/vite.config.ts

@@ -0,0 +1,12 @@
+import { viteConfig } from '@faasjs/dev'
+import { PgVitestPlugin } from '@faasjs/pg-dev'
+import { defineConfig } from 'vite-plus'
+
+export default defineConfig({
+  ...viteConfig,
+  plugins: [...viteConfig.plugins, PgVitestPlugin()],
+  test: {
+    fileParallelism: false,
+    testTimeout: 30_000,
+  },
+})

package/template/{basic → minimal}/gitignore

@@ -1,3 +1,4 @@
 node_modules/
 dist/
 coverage/
+.env

package/template/{antd → minimal}/package.json

@@ -9,13 +9,12 @@
     "start": "node --import @faasjs/node-utils/register-hooks server.ts",
     "test": "vp test"
   },
-  "dependencies": {
-    "@faasjs/ant-design": "*",
-    "@faasjs/core": "*"
-  },
   "devDependencies": {
     "@faasjs/dev": "*"
   },
+  "peerDependencies": {
+    "@faasjs/core": "*"
+  },
   "overrides": {
     "vite": "npm:@voidzero-dev/vite-plus-core",
     "vitest": "npm:@voidzero-dev/vite-plus-test"

package/template/{antd → minimal}/src/pages/home/api/hello.api.ts

@@ -1,4 +1,5 @@
-import { defineApi, z } from '@faasjs/core'
+import { defineApi } from '@faasjs/core'
+import * as z from 'zod'
 
 export default defineApi({
   schema: z.object({

package/template/{basic → minimal}/src/pages/home/index.tsx

@@ -31,7 +31,7 @@ export default function HomePage() {
 
   return (
     <main style={{ margin: '5rem auto', maxWidth: 420, padding: 24 }}>
-      <h1>FaasJS App</h1>
+      <h1>FaasJS Minimal App</h1>
       <p>{message}</p>
 
       <label style={{ display: 'block', marginBottom: 12 }}>

package/template/antd/src/pages/home/index.tsx

@@ -1,79 +0,0 @@
-import { faas, useApp } from '@faasjs/ant-design'
-import { Button, Card, Input, Space, Typography } from 'antd'
-import { useState } from 'react'
-
-type HelloResponse = {
-  message?: string
-}
-
-export default function HomePage() {
-  const app = useApp()
-  const [name, setName] = useState('FaasJS')
-  const [messageText, setMessageText] = useState('Click button to call API')
-  const [loading, setLoading] = useState(false)
-
-  const callApi = async () => {
-    setLoading(true)
-
-    try {
-      const response = await faas('/pages/home/api/hello', {
-        name: name.trim() || undefined,
-      })
-      const nextMessage = (response.data as HelloResponse | undefined)?.message || 'Empty response'
-
-      setMessageText(nextMessage)
-      app.message.success('API call succeeded')
-    } catch (error: unknown) {
-      const errorMessage = error instanceof Error ? error.message : 'Request failed'
-
-      setMessageText(errorMessage)
-      app.notification.error({
-        message: 'API call failed',
-        description: errorMessage,
-      })
-    } finally {
-      setLoading(false)
-    }
-  }
-
-  return (
-    <div
-      style={{
-        minHeight: '100vh',
-        display: 'grid',
-        placeItems: 'center',
-        padding: 24,
-        background: 'linear-gradient(135deg, #f5f7fa 0%, #e4ecfb 100%)',
-      }}
-    >
-      <Card
-        style={{
-          width: '100%',
-          maxWidth: 560,
-          boxShadow: '0 20px 45px rgba(15, 23, 42, 0.08)',
-        }}
-      >
-        <Space direction="vertical" size="large" style={{ width: '100%' }}>
-          <div>
-            <Typography.Title level={2}>FaasJS Ant Design App</Typography.Title>
-            <Typography.Paragraph type="secondary">
-              Call a FaasJS API through the Ant Design app shell.
-            </Typography.Paragraph>
-          </div>
-
-          <Input
-            value={name}
-            onChange={(event) => setName(event.target.value)}
-            placeholder="What should the API greet?"
-          />
-
-          <Button type="primary" loading={loading} onClick={callApi}>
-            Call /pages/home/api/hello
-          </Button>
-
-          <Typography.Paragraph style={{ marginBottom: 0 }}>{messageText}</Typography.Paragraph>
-        </Space>
-      </Card>
-    </div>
-  )
-}

package/template/basic/src/pages/home/api/__tests__/hello.test.ts

@@ -1,17 +0,0 @@
-import { testApi } from '@faasjs/dev'
-import { describe, it, expect } from 'vitest'
-
-import api from '../hello.api'
-
-describe('pages/home/api/hello', () => {
-  it('should work', async () => {
-    const handler = testApi(api)
-
-    const { statusCode, data } = await handler({ name: 'world' })
-
-    expect(statusCode).toEqual(200)
-    expect(data).toEqual({
-      message: 'Hello, world!',
-    })
-  })
-})

package/template/basic/src/pages/home/api/hello.api.ts

@@ -1,12 +0,0 @@
-import { defineApi, z } from '@faasjs/core'
-
-export default defineApi({
-  schema: z.object({
-    name: z.string().min(1).optional(),
-  }),
-  async handler({ params }) {
-    return {
-      message: `Hello, ${params.name || 'FaasJS'}!`,
-    }
-  },
-})

package/template/basic/tsconfig.json

@@ -1,4 +0,0 @@
-{
-  "extends": "@faasjs/types/tsconfig/build.json",
-  "include": ["src", "vite.config.ts", "server.ts"]
-}

package/template/basic/vite.config.ts

@@ -1,6 +0,0 @@
-import { viteConfig } from '@faasjs/dev'
-import { defineConfig } from 'vite-plus'
-
-export default defineConfig({
-  ...viteConfig,
-})