create-acrylblends 0.2.3 → 0.2.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. package/README.md +10 -0
  2. package/dist/index.d.ts +15 -0
  3. package/dist/index.js +287 -14
  4. package/dist/index.js.map +1 -1
  5. package/docs/framework/README.md +6 -4
  6. package/docs/framework/UPSTREAM.md +1 -1
  7. package/docs/framework/getting-started/aws-lambda.md +115 -0
  8. package/docs/framework/getting-started/bun.md +1 -3
  9. package/docs/framework/getting-started/cloudflare-pages.md +53 -0
  10. package/docs/framework/getting-started/cloudflare-workers.md +67 -0
  11. package/docs/framework/getting-started/deploy.md +5 -5
  12. package/docs/framework/getting-started/lambda-edge.md +41 -0
  13. package/docs/framework/getting-started/netlify.md +25 -0
  14. package/docs/framework/getting-started/other-runtimes.md +20 -9
  15. package/docs/framework/getting-started/service-worker.md +33 -0
  16. package/docs/framework/getting-started/vercel.md +28 -0
  17. package/docs/framework/guides/create-acrylblends.md +40 -2
  18. package/docs/framework/guides/data.md +202 -0
  19. package/docs/framework/guides/faq.md +2 -2
  20. package/docs/framework/guides/forms-and-sessions.md +34 -30
  21. package/docs/framework/helpers/conninfo.md +1 -1
  22. package/docs/framework/helpers/ssg.md +1 -1
  23. package/docs/framework/helpers/streaming.md +3 -2
  24. package/docs/framework/helpers/websocket.md +2 -2
  25. package/docs/framework/middleware/builtin/ip-restriction.md +1 -1
  26. package/docs/framework/upstream.json +3 -3
  27. package/package.json +3 -2
  28. package/templates/chat/gitignore +3 -2
  29. package/templates/chat/migrations/001-chat.sql +12 -0
  30. package/templates/chat/src/app.ts +4 -2
  31. package/templates/chat/src/chat-app.ts +22 -18
  32. package/templates/chat/src/db.ts +30 -36
  33. package/templates/chat/src/index.ts +9 -4
  34. package/templates/chat/test/chat.test.ts +21 -9
  35. package/templates/chat/test/server.test.ts +1 -1
  36. package/templates/notes/gitignore +3 -2
  37. package/templates/notes/migrations/001-notes.sql +18 -0
  38. package/templates/notes/src/app.ts +4 -3
  39. package/templates/notes/src/auth.ts +21 -19
  40. package/templates/notes/src/db.ts +40 -50
  41. package/templates/notes/src/index.ts +9 -4
  42. package/templates/notes/src/notes-app.ts +35 -29
  43. package/templates/notes/test/notes.test.ts +27 -20
  44. package/templates/notes/test/server.test.ts +1 -1
@@ -2,13 +2,13 @@ import type { Context } from '__PACKAGE__'
2
2
  import { __CLASS__ } from '__PACKAGE__'
3
3
  import { deleteCookie, getCookie, setCookie } from '__PACKAGE__/cookie'
4
4
  import { csrf } from '__PACKAGE__/csrf'
5
+ import type { Db } from '__PACKAGE__/db'
5
6
  import { createMiddleware } from '__PACKAGE__/factory'
6
7
  import { HTTPException } from '__PACKAGE__/http-exception'
7
8
  import { clientModules } from '__PACKAGE__/node-server'
8
9
  import { schemaValidator } from '__PACKAGE__/schema-validator'
9
- import type { DatabaseSync } from 'node:sqlite'
10
10
  import { authStore, verifyPassword } from './auth.ts'
11
- import { notesStore, openDb } from './db.ts'
11
+ import { notesStore } from './db.ts'
12
12
  import { checkCredentials, checkNote, NoteSchema } from './schema.ts'
13
13
  import { authPage, formPage, listPage } from './views.tsx'
14
14
 
@@ -24,36 +24,42 @@ export interface AppOptions {
24
24
  publicOrigin?: string
25
25
  }
26
26
 
27
- export function createApi(db: DatabaseSync) {
27
+ export function createApi(db: Db) {
28
28
  const auth = authStore(db)
29
29
  const notes = notesStore(db)
30
30
  return new __CLASS__<Env>()
31
31
  .use(async (c, next) => {
32
- const user = auth.userFor(getCookie(c, COOKIE))
32
+ const user = await auth.userFor(getCookie(c, COOKIE))
33
33
  if (!user) return c.json({ error: 'Log in first.' }, 401)
34
34
  c.set('user', user)
35
35
  await next()
36
36
  })
37
- .get('/', (c) => c.json({ notes: notes.list(c.get('user').id, c.req.query('q') ?? '') }, 200))
38
- .post('/', schemaValidator('json', NoteSchema), (c) =>
37
+ .get('/', async (c) =>
38
+ c.json({ notes: await notes.list(c.get('user').id, c.req.query('q') ?? '') }, 200),
39
+ )
40
+ .post('/', schemaValidator('json', NoteSchema), async (c) =>
39
41
  c.json(
40
42
  {
41
- note: notes.create(c.get('user').id, c.req.valid('json').title, c.req.valid('json').body),
43
+ note: await notes.create(
44
+ c.get('user').id,
45
+ c.req.valid('json').title,
46
+ c.req.valid('json').body,
47
+ ),
42
48
  },
43
49
  201,
44
50
  ),
45
51
  )
46
- .get('/:id', (c) => {
47
- const note = notes.get(c.get('user').id, Number(c.req.param('id')))
52
+ .get('/:id', async (c) => {
53
+ const note = await notes.get(c.get('user').id, Number(c.req.param('id')))
48
54
  return note ? c.json({ note }, 200) : c.json({ error: 'No such note.' }, 404)
49
55
  })
50
- .put('/:id', schemaValidator('json', NoteSchema), (c) => {
56
+ .put('/:id', schemaValidator('json', NoteSchema), async (c) => {
51
57
  const { title, body } = c.req.valid('json')
52
- const note = notes.update(c.get('user').id, Number(c.req.param('id')), title, body)
58
+ const note = await notes.update(c.get('user').id, Number(c.req.param('id')), title, body)
53
59
  return note ? c.json({ note }, 200) : c.json({ error: 'No such note.' }, 404)
54
60
  })
55
- .delete('/:id', (c) =>
56
- notes.remove(c.get('user').id, Number(c.req.param('id')))
61
+ .delete('/:id', async (c) =>
62
+ (await notes.remove(c.get('user').id, Number(c.req.param('id'))))
57
63
  ? c.json({ ok: true }, 200)
58
64
  : c.json({ error: 'No such note.' }, 404),
59
65
  )
@@ -62,7 +68,7 @@ export function createApi(db: DatabaseSync) {
62
68
  export type Api = ReturnType<typeof createApi>
63
69
 
64
70
  export function createApp(
65
- db: DatabaseSync = openDb(),
71
+ db: Db,
66
72
  {
67
73
  trustProxy = process.env.TRUST_PROXY === '1',
68
74
  publicOrigin = process.env.PUBLIC_ORIGIN,
@@ -91,7 +97,7 @@ export function createApp(
91
97
  })
92
98
 
93
99
  const requireUser = createMiddleware<Env>(async (c, next) => {
94
- const user = auth.userFor(getCookie(c, COOKIE))
100
+ const user = await auth.userFor(getCookie(c, COOKIE))
95
101
  if (!user) return c.redirect('/login')
96
102
  c.set('user', user)
97
103
  await next()
@@ -107,11 +113,11 @@ export function createApp(
107
113
  .trim()
108
114
  .toLowerCase()
109
115
  const errors = checkCredentials(email, form.password, true)
110
- if (errors.length === 0 && auth.findUser(email))
116
+ if (errors.length === 0 && (await auth.findUser(email)))
111
117
  errors.push('That email already has an account. Log in instead.')
112
118
  if (errors.length > 0) return c.html(authPage('signup', errors, email), 400)
113
119
  const id = await auth.createUser(email, String(form.password))
114
- setCookie(c, COOKIE, auth.startSession(id), session(c))
120
+ setCookie(c, COOKIE, await auth.startSession(id), session(c))
115
121
  return c.redirect('/notes', 303)
116
122
  })
117
123
 
@@ -122,16 +128,16 @@ export function createApp(
122
128
  .toLowerCase()
123
129
  const errors = checkCredentials(email, form.password, false)
124
130
  if (errors.length > 0) return c.html(authPage('login', errors, email), 400)
125
- const user = auth.findUser(email)
131
+ const user = await auth.findUser(email)
126
132
  if (!user || !(await verifyPassword(String(form.password), user.password_hash)))
127
133
  return c.html(authPage('login', ['Wrong email or password.'], email), 401)
128
- setCookie(c, COOKIE, auth.startSession(user.id), session(c))
134
+ setCookie(c, COOKIE, await auth.startSession(user.id), session(c))
129
135
  return c.redirect('/notes', 303)
130
136
  })
131
137
 
132
- app.post('/logout', (c) => {
138
+ app.post('/logout', async (c) => {
133
139
  const token = getCookie(c, COOKIE)
134
- if (token) auth.endSession(token)
140
+ if (token) await auth.endSession(token)
135
141
  deleteCookie(c, COOKIE, { path: '/' })
136
142
  return c.redirect('/login', 303)
137
143
  })
@@ -139,9 +145,9 @@ export function createApp(
139
145
  app.use('/notes/*', requireUser)
140
146
  app.use('/notes', requireUser)
141
147
 
142
- app.get('/notes', (c) => {
148
+ app.get('/notes', async (c) => {
143
149
  const q = (c.req.query('q') ?? '').trim()
144
- return c.html(listPage(c.get('user').email, notes.list(c.get('user').id, q), q))
150
+ return c.html(listPage(c.get('user').email, await notes.list(c.get('user').id, q), q))
145
151
  })
146
152
  app.get('/notes/new', (c) =>
147
153
  c.html(formPage(c.get('user').email, '/notes', { title: '', body: '' })),
@@ -159,11 +165,11 @@ export function createApp(
159
165
  ),
160
166
  400,
161
167
  )
162
- notes.create(c.get('user').id, checked.value.title, checked.value.body)
168
+ await notes.create(c.get('user').id, checked.value.title, checked.value.body)
163
169
  return c.redirect('/notes', 303)
164
170
  })
165
- app.get('/notes/:id/edit', (c) => {
166
- const note = notes.get(c.get('user').id, Number(c.req.param('id')))
171
+ app.get('/notes/:id/edit', async (c) => {
172
+ const note = await notes.get(c.get('user').id, Number(c.req.param('id')))
167
173
  return note
168
174
  ? c.html(formPage(c.get('user').email, `/notes/${note.id}`, note))
169
175
  : c.html(listPage(c.get('user').email, [], ''), 404)
@@ -182,12 +188,12 @@ export function createApp(
182
188
  ),
183
189
  400,
184
190
  )
185
- if (!notes.update(c.get('user').id, id, checked.value.title, checked.value.body))
191
+ if (!(await notes.update(c.get('user').id, id, checked.value.title, checked.value.body)))
186
192
  return c.text('No such note.', 404)
187
193
  return c.redirect('/notes', 303)
188
194
  })
189
- app.post('/notes/:id/delete', (c) => {
190
- if (!notes.remove(c.get('user').id, Number(c.req.param('id'))))
195
+ app.post('/notes/:id/delete', async (c) => {
196
+ if (!(await notes.remove(c.get('user').id, Number(c.req.param('id')))))
191
197
  return c.text('No such note.', 404)
192
198
  return c.redirect('/notes', 303)
193
199
  })
@@ -1,10 +1,19 @@
1
+ import type { Db } from '__PACKAGE__/db'
1
2
  import { testClient } from '__PACKAGE__/testing'
2
3
  import assert from 'node:assert/strict'
3
- import type { DatabaseSync } from 'node:sqlite'
4
- import { test } from 'node:test'
5
- import { openDb } from '../src/db.ts'
4
+ import { after, test } from 'node:test'
5
+ import { openNotesDb } from '../src/db.ts'
6
6
  import { createApi, createApp } from '../src/notes-app.ts'
7
7
 
8
+ /** A fresh database in memory with the real migrations; every one is closed when the tests end. */
9
+ const closers: (() => Promise<void>)[] = []
10
+ after(() => Promise.all(closers.map((close) => close())))
11
+ async function memoryDb(): Promise<Db> {
12
+ const { db, close } = await openNotesDb(':memory:')
13
+ closers.push(close)
14
+ return db
15
+ }
16
+
8
17
  const form = (data: Record<string, string>, cookie = ''): RequestInit => ({
9
18
  method: 'POST',
10
19
  body: new URLSearchParams(data),
@@ -18,7 +27,7 @@ async function signedUp(app: ReturnType<typeof createApp>, email = 'a@example.co
18
27
  }
19
28
 
20
29
  test('the home page sends a visitor to the notes, which send them to log in', async () => {
21
- const app = createApp(openDb(':memory:'))
30
+ const app = createApp(await memoryDb())
22
31
  assert.equal((await app.request('/')).headers.get('location'), '/notes')
23
32
  const res = await app.request('/notes')
24
33
  assert.equal(res.status, 302)
@@ -26,7 +35,7 @@ test('the home page sends a visitor to the notes, which send them to log in', as
26
35
  })
27
36
 
28
37
  test('sign up validates, refuses a duplicate, and starts a session', async () => {
29
- const app = createApp(openDb(':memory:'))
38
+ const app = createApp(await memoryDb())
30
39
  assert.match(await (await app.request('/signup')).text(), /Create account/)
31
40
  const bad = await app.request('/signup', form({ email: 'nope', password: 'short' }))
32
41
  assert.equal(bad.status, 400)
@@ -44,7 +53,7 @@ test('sign up validates, refuses a duplicate, and starts a session', async () =>
44
53
  })
45
54
 
46
55
  test('log in checks the password; log out ends the session', async () => {
47
- const app = createApp(openDb(':memory:'))
56
+ const app = createApp(await memoryDb())
48
57
  const first = await signedUp(app)
49
58
  assert.match(await (await app.request('/login')).text(), /Log in/)
50
59
  const wrong = await app.request(
@@ -69,7 +78,7 @@ test('log in checks the password; log out ends the session', async () => {
69
78
  })
70
79
 
71
80
  test('create, search, edit and delete a note through the forms', async () => {
72
- const app = createApp(openDb(':memory:'))
81
+ const app = createApp(await memoryDb())
73
82
  const cookie = await signedUp(app)
74
83
  assert.match(
75
84
  await (await app.request('/notes/new', { headers: { cookie } })).text(),
@@ -123,7 +132,7 @@ test('create, search, edit and delete a note through the forms', async () => {
123
132
  })
124
133
 
125
134
  test("one user cannot read or change another user's notes", async () => {
126
- const app = createApp(openDb(':memory:'))
135
+ const app = createApp(await memoryDb())
127
136
  const alice = await signedUp(app, 'alice@example.com')
128
137
  const bob = await signedUp(app, 'bob@example.com')
129
138
  await app.request('/notes', form({ title: 'Secret', body: 'alice only' }, alice))
@@ -133,7 +142,7 @@ test("one user cannot read or change another user's notes", async () => {
133
142
  })
134
143
 
135
144
  test('the JSON API needs a session and validates input', async () => {
136
- const db = openDb(':memory:')
145
+ const db = await memoryDb()
137
146
  const app = createApp(db)
138
147
  const cookie = await signedUp(app)
139
148
  const res = await app.request('/api/notes')
@@ -149,7 +158,7 @@ test('the JSON API needs a session and validates input', async () => {
149
158
  })
150
159
 
151
160
  test('the typed client covers every API route', async () => {
152
- const db = openDb(':memory:')
161
+ const db = await memoryDb()
153
162
  const app = createApp(db)
154
163
  const cookie = await signedUp(app)
155
164
  const client = testClient(createApi(db))
@@ -180,7 +189,7 @@ test('the typed client covers every API route', async () => {
180
189
  })
181
190
 
182
191
  test('csrf refuses a form POST from another site', async () => {
183
- const app = createApp(openDb(':memory:'))
192
+ const app = createApp(await memoryDb())
184
193
  const res = await app.request('/signup', {
185
194
  method: 'POST',
186
195
  body: new URLSearchParams({ email: 'a@example.com', password: 'correct horse' }),
@@ -192,7 +201,7 @@ test('csrf refuses a form POST from another site', async () => {
192
201
  test('the session cookie is Secure over HTTPS, and behind a proxy only when the proxy is trusted', async () => {
193
202
  const body = new URLSearchParams({ email: 'a@example.com', password: 'correct horse' })
194
203
  const flags = async (url: string, headers: Record<string, string>, trustProxy: boolean) => {
195
- const app = createApp(openDb(':memory:'), { trustProxy })
204
+ const app = createApp(await memoryDb(), { trustProxy })
196
205
  const origin = new URL(url).origin
197
206
  const res = await app.request(url, { method: 'POST', body, headers: { origin, ...headers } })
198
207
  assert.equal(res.status, 303)
@@ -206,7 +215,7 @@ test('the session cookie is Secure over HTTPS, and behind a proxy only when the
206
215
  })
207
216
 
208
217
  test('behind a proxy csrf accepts the public origin and still refuses others', async () => {
209
- const app = createApp(openDb(':memory:'), { publicOrigin: 'https://notes.example.com' })
218
+ const app = createApp(await memoryDb(), { publicOrigin: 'https://notes.example.com' })
210
219
  const post = (origin: string) =>
211
220
  app.request('/signup', {
212
221
  method: 'POST',
@@ -218,12 +227,10 @@ test('behind a proxy csrf accepts the public origin and still refuses others', a
218
227
  })
219
228
 
220
229
  test('an error answers a plain 500 with no stack and no detail', async () => {
221
- const broken = {
222
- prepare() {
223
- throw new Error('secret detail at /srv/app/db.ts:1')
224
- },
225
- exec() {},
226
- } as unknown as DatabaseSync
230
+ const fail = async (): Promise<never> => {
231
+ throw new Error('secret detail at /srv/app/db.ts:1')
232
+ }
233
+ const broken: Db = { exec: fail, run: fail, get: fail, all: fail, transaction: fail }
227
234
  const app = createApp(broken)
228
235
  const res = await app.request('/notes', { headers: { cookie: 'sid=anything' } })
229
236
  assert.equal(res.status, 500)
@@ -231,7 +238,7 @@ test('an error answers a plain 500 with no stack and no detail', async () => {
231
238
  })
232
239
 
233
240
  test('the note form loads the character counter, a client component compiled for the browser', async () => {
234
- const app = createApp(openDb(':memory:'))
241
+ const app = createApp(await memoryDb())
235
242
  const cookie = await signedUp(app)
236
243
  assert.match(
237
244
  await (await app.request('/notes/new', { headers: { cookie } })).text(),
@@ -15,7 +15,7 @@ async function start(env: Record<string, string> = {}) {
15
15
  env: {
16
16
  ...process.env,
17
17
  PORT: '0',
18
- NOTES_DB: join(mkdtempSync(join(tmpdir(), 'notes-')), 'notes.db'),
18
+ NOTES_DB: join(mkdtempSync(join(tmpdir(), 'notes-')), 'notes.sqlite'),
19
19
  ...env,
20
20
  },
21
21
  stdio: ['ignore', 'pipe', 'inherit'],