create-faas-app 8.0.0-beta.4 → 8.0.0-beta.41

package/template/admin/server.ts

@@ -0,0 +1,33 @@
+import { dirname, join } from 'node:path'
+import { loadEnvFile } from 'node:process'
+import { fileURLToPath } from 'node:url'
+
+import { Server, staticHandler } from '@faasjs/core'
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = dirname(__filename)
+
+try {
+  loadEnvFile()
+} catch (error) {
+  console.warn('[faasjs] Failed to load env file', error)
+}
+
+const publicHandler = staticHandler({
+  root: join(__dirname, 'public'),
+  notFound: false,
+})
+
+const distHandler = staticHandler({
+  root: join(__dirname, 'dist'),
+  notFound: 'index.html',
+})
+
+new Server(join(__dirname, 'src'), {
+  beforeHandle: async (req, res, ctx) => {
+    if (!req.url || req.method !== 'GET') return
+
+    await publicHandler(req, res, ctx)
+    await distHandler(req, res, ctx)
+  },
+}).listen()

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

@@ -0,0 +1,16 @@
+/**
+ * Generated by @faasjs/dev.
+ *
+ * Do not edit this file manually.
+ */
+import type { InferFaasAction } from '@faasjs/types'
+
+declare module '@faasjs/types' {
+  interface FaasActions {
+    "features/auth/api/me": InferFaasAction<typeof import("../features/auth/api/me.api")>
+    "features/users/api/create": InferFaasAction<typeof import("../features/users/api/create.api")>
+    "features/users/api/detail": InferFaasAction<typeof import("../features/users/api/detail.api")>
+    "features/users/api/list": InferFaasAction<typeof import("../features/users/api/list.api")>
+    "features/users/api/update": InferFaasAction<typeof import("../features/users/api/update.api")>
+  }
+}

package/template/admin/src/db/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/admin/src/db/tables/users.ts

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

package/template/admin/src/faas.yaml

@@ -0,0 +1,11 @@
+defaults:
+  server:
+    root: .
+    base: /
+  plugins:
+    http:
+      config:
+        cookie:
+          secure: false
+          session:
+            secret: '{{secret}}'

package/template/admin/src/features/auth/api/__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('features/auth/api/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/features/auth/api/me.api.ts

@@ -0,0 +1,23 @@
+import { defineApi, HttpError } from '@faasjs/core'
+import { z } from '@faasjs/utils'
+
+import { AuthPlugin } from '../../../plugins/auth'
+
+const api = defineApi({
+  schema: z.object({}).strict(),
+  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/features/users/api/__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('features/users/api/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/features/users/api/__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('features/users/api/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/features/users/api/__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('features/users/api/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,
+      rows: [
+        {
+          id: 2,
+          name: 'Grace',
+        },
+        {
+          id: 1,
+          name: 'Ada',
+        },
+      ],
+    })
+  })
+})

package/template/admin/src/features/users/api/__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('features/users/api/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/features/users/api/create.api.ts

@@ -0,0 +1,26 @@
+import { defineApi } from '@faasjs/core'
+import { getClient } from '@faasjs/pg'
+import { z } from '@faasjs/utils'
+
+export default defineApi({
+  schema: z.object({
+    name: z.nonemptystring().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/features/users/api/detail.api.ts

@@ -0,0 +1,23 @@
+import { defineApi, HttpError } from '@faasjs/core'
+import { getClient } from '@faasjs/pg'
+import { z } from '@faasjs/utils'
+
+export default defineApi({
+  schema: z.object({
+    id: z.positiveint(),
+  }),
+  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/features/users/api/list.api.ts

@@ -0,0 +1,22 @@
+import { defineApi } from '@faasjs/core'
+import { getClient } from '@faasjs/pg'
+import { z } from '@faasjs/utils'
+
+export default defineApi({
+  schema: z.object({
+    limit: z.positiveint().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(),
+      rows: users,
+    }
+  },
+})

package/template/admin/src/features/users/api/update.api.ts

@@ -0,0 +1,35 @@
+import { defineApi, HttpError } from '@faasjs/core'
+import { getClient } from '@faasjs/pg'
+import { z } from '@faasjs/utils'
+
+export default defineApi({
+  schema: z.object({
+    id: z.positiveint(),
+    name: z.nonemptystring(),
+  }),
+  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/features/users/index.tsx

@@ -0,0 +1,138 @@
+import { faas, useApp, useFaas } from '@faasjs/ant-design'
+import { toErrorMessage } from '@faasjs/utils'
+import { Button, Card, Input, Space, Table, Typography } from 'antd'
+import { useState } from 'react'
+
+export default function UsersPage() {
+  const app = useApp()
+  const [name, setName] = useState('FaasJS')
+  const [messageText, setMessageText] = useState('Create your first user through the FaasJS API')
+
+  const {
+    data: listData,
+    loading: listLoading,
+    reload,
+  } = useFaas('features/users/api/list', { limit: 10 })
+
+  const rows = listData?.rows || []
+
+  const [creating, setCreating] = useState(false)
+  const callApi = async () => {
+    setCreating(true)
+    try {
+      const response = await faas('features/users/api/create', {
+        name: name.trim() || undefined,
+      })
+      const result = response.data
+      const nextMessage =
+        result?.user && typeof result.total === 'number'
+          ? `Created ${result.user.name} (#${result.user.id}). Total users: ${result.total}`
+          : result?.message || 'Empty response'
+
+      setMessageText(nextMessage)
+      app.message.success('User saved to PostgreSQL')
+      await reload()
+    } catch (error: unknown) {
+      const errorMessage = toErrorMessage(error, 'Request failed')
+      setMessageText(errorMessage)
+      app.notification.error({
+        message: 'API call failed',
+        description: errorMessage,
+      })
+    } finally {
+      setCreating(false)
+    }
+  }
+
+  const [authLoading, setAuthLoading] = useState(false)
+  const callAuthDemo = async () => {
+    setAuthLoading(true)
+    try {
+      const response = await faas(
+        'features/auth/api/me',
+        {},
+        {
+          headers: { authorization: 'Bearer demo-admin' },
+        },
+      )
+      const currentUser = response.data?.current_user
+      setMessageText(`Auth plugin injected current user: ${currentUser?.name || 'unknown'}`)
+      app.message.success('Auth plugin demo loaded current_user')
+    } catch (error: unknown) {
+      const errorMessage = toErrorMessage(error, '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={() => reload()} loading={listLoading}>
+              Load users slice
+            </Button>
+            <Button type="primary" loading={creating} onClick={callApi}>
+              Create features/users/api/create
+            </Button>
+            <Button loading={authLoading} onClick={callAuthDemo}>
+              Call auth plugin demo
+            </Button>
+          </Space>
+
+          <Table
+            rowKey="id"
+            size="small"
+            pagination={false}
+            loading={listLoading}
+            dataSource={rows}
+            columns={[
+              { title: 'ID', dataIndex: 'id' },
+              { title: 'Name', dataIndex: 'name' },
+            ]}
+          />
+
+          <Typography.Paragraph style={{ marginBottom: 0 }}>{messageText}</Typography.Paragraph>
+        </Space>
+      </Card>
+    </div>
+  )
+}

package/template/admin/src/main.tsx

@@ -0,0 +1,24 @@
+import { App } from '@faasjs/ant-design'
+import { createRoot } from 'react-dom/client'
+
+import UsersPage from './features/users'
+
+createRoot(document.getElementById('root') as HTMLElement).render(
+  <App
+    configProviderProps={{
+      theme: {
+        token: {
+          borderRadius: 16,
+          colorPrimary: '#1677ff',
+        },
+      },
+    }}
+    faasConfigProviderProps={{
+      faasClientOptions: {
+        baseUrl: '/',
+      },
+    }}
+  >
+    <UsersPage />
+  </App>,
+)

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/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": "@faasjs/types/tsconfig/build.json",
+  "include": ["src", "src/.faasjs/types.d.ts", "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/minimal/gitignore

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

package/template/minimal/index.html

@@ -0,0 +1,12 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>FaasJS App</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>