@alxia/create 0.4.1 → 0.4.3
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.
- package/docs/roadmap.md +30 -26
- package/package.json +5 -5
package/docs/roadmap.md
CHANGED
|
@@ -7,32 +7,7 @@ number on it. Every release, with each change it made, is in
|
|
|
7
7
|
|
|
8
8
|
## Now
|
|
9
9
|
|
|
10
|
-
|
|
11
|
-
dependency and a test, the template to try alxia with, and what the
|
|
12
|
-
prompt offers first. `graphql` is a GraphQL Yoga API served by
|
|
13
|
-
`@alxia/graphql`, schema first: `schema.graphql` is the contract, GraphQL
|
|
14
|
-
Code Generator types the resolvers (committed, checked by
|
|
15
|
-
`generate --check`), `viewer` is typed in every resolver, and
|
|
16
|
-
`noteAdded` is a subscription over server-sent events.
|
|
17
|
-
- **The `api` template reads its environment with `defineEnv`.**
|
|
18
|
-
`src/env.ts`, from `@alxia/env`, checks `PORT` and `API_KEY` (a secret)
|
|
19
|
-
once, before the server listens; `src/context.ts` no longer exports
|
|
20
|
-
`apiKey`.
|
|
21
|
-
- **The `api` project split across files.** `src/context.ts` holds the
|
|
22
|
-
base the routes read and registers it with `@alxia/core`'s `Register`;
|
|
23
|
-
`src/routes/todos.ts` binds the operations with `defineRoutes()`,
|
|
24
|
-
reading that context with no import of the app; `src/app.ts` mounts
|
|
25
|
-
them, `base.plugin(todoRoutes)`.
|
|
26
|
-
- **Production-safe defaults.** Every `dev` script sets
|
|
27
|
-
`NODE_ENV=development`, the only mode alxia's dev helps run in; the
|
|
28
|
-
`api` project's `API_KEY` is required outside development and test; the
|
|
29
|
-
`api` and `graphql` projects mount `health()`, the `api` project answers
|
|
30
|
-
alxia's own errors as problems and serves `/docs` from the bundled
|
|
31
|
-
`openapi.yaml`; no template installs signal handlers of its own, as
|
|
32
|
-
`listen` drains and exits on `SIGINT` and `SIGTERM`.
|
|
33
|
-
- **The `api` template's tests use a typed client.** `src/app.spec.ts` calls
|
|
34
|
-
the app through openapi-fetch over the generated `paths.ts`, with
|
|
35
|
-
`app.fetch` as its `fetch`: in process, typed by `openapi.yaml`.
|
|
10
|
+
Nothing in progress.
|
|
36
11
|
|
|
37
12
|
## Next
|
|
38
13
|
|
|
@@ -79,6 +54,30 @@ Nothing scheduled yet.
|
|
|
79
54
|
- **A core with `app.all`.** New projects install `@alxia/core` 0.11, which
|
|
80
55
|
declares one route for every method at a path.
|
|
81
56
|
|
|
57
|
+
### 0.2.0
|
|
58
|
+
|
|
59
|
+
- **Two templates: `minimal` and `graphql`.** `minimal` is one file, one
|
|
60
|
+
dependency and a test, the template to try alxia with, and what the
|
|
61
|
+
prompt offers first. `graphql` is a GraphQL Yoga API served by
|
|
62
|
+
`@alxia/graphql`, schema first: `schema.graphql` is the contract, GraphQL
|
|
63
|
+
Code Generator types the resolvers (committed, checked by
|
|
64
|
+
`generate --check`), `viewer` is typed in every resolver, and
|
|
65
|
+
`noteAdded` is a subscription over server-sent events.
|
|
66
|
+
- **The `api` template reads its environment with `defineEnv`.**
|
|
67
|
+
`src/env.ts`, from `@alxia/env`, checks `PORT` and `API_KEY` (a secret)
|
|
68
|
+
once, before the server listens; `src/context.ts` no longer exports
|
|
69
|
+
`apiKey`.
|
|
70
|
+
- **Production-safe defaults.** Every `dev` script sets
|
|
71
|
+
`NODE_ENV=development`, the only mode alxia's dev helps run in; the
|
|
72
|
+
`api` project's `API_KEY` is required outside development and test; the
|
|
73
|
+
`api` and `graphql` projects mount `health()`, the `api` project answers
|
|
74
|
+
alxia's own errors as problems and serves `/docs` from the bundled
|
|
75
|
+
`openapi.yaml`; no template installs signal handlers of its own, as
|
|
76
|
+
`listen` drains and exits on `SIGINT` and `SIGTERM`.
|
|
77
|
+
- **The `api` template's tests use a typed client.** `src/app.spec.ts` calls
|
|
78
|
+
the app through openapi-fetch over the generated `paths.ts`, with
|
|
79
|
+
`app.fetch` as its `fetch`: in process, typed by `openapi.yaml`.
|
|
80
|
+
|
|
82
81
|
### 0.1.6
|
|
83
82
|
|
|
84
83
|
- **The `api` project is OpenAPI spec first.** `openapi.yaml` declares
|
|
@@ -98,6 +97,11 @@ Nothing scheduled yet.
|
|
|
98
97
|
- **No client package in a new project.** The `api` template's spec calls
|
|
99
98
|
the app with `app.request()`; a typed client is generated from
|
|
100
99
|
`openapi.yaml`, with a generator such as `@nxgt/openapi-codegen`.
|
|
100
|
+
- **The `api` project split across files.** `src/context.ts` holds the
|
|
101
|
+
base the routes read and registers it with `@alxia/core`'s `Register`;
|
|
102
|
+
`src/routes/todos.ts` binds the operations with `defineRoutes()`,
|
|
103
|
+
reading that context with no import of the app; `src/app.ts` mounts
|
|
104
|
+
them, `base.plugin(todoRoutes)`.
|
|
101
105
|
|
|
102
106
|
### 0.1.5
|
|
103
107
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@alxia/create",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.3",
|
|
4
4
|
"description": "Start an alxia app: `bun create @alxia` writes a minimal API, a spec-first one, a GraphQL one, or React Router's official template served by alxia",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -41,11 +41,11 @@
|
|
|
41
41
|
]
|
|
42
42
|
},
|
|
43
43
|
"devDependencies": {
|
|
44
|
-
"@alxia/core": "^0.
|
|
44
|
+
"@alxia/core": "^0.14.2",
|
|
45
45
|
"@alxia/env": "^0.2.0",
|
|
46
|
-
"@alxia/graphql": "^0.
|
|
47
|
-
"@alxia/openapi": "^0.6.
|
|
48
|
-
"@alxia/react-router": "^0.
|
|
46
|
+
"@alxia/graphql": "^0.8.0",
|
|
47
|
+
"@alxia/openapi": "^0.6.8",
|
|
48
|
+
"@alxia/react-router": "^0.8.0",
|
|
49
49
|
"@graphql-codegen/cli": "7.4.3",
|
|
50
50
|
"@graphql-codegen/typescript": "6.1.0",
|
|
51
51
|
"@graphql-codegen/typescript-resolvers": "6.1.0",
|