@lukoweb/apitogo 0.1.93 → 0.1.94
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/dist/cli/cli.js +10 -7
- package/docs/cli/commands.md +2 -1
- package/docs/cli/overview.md +1 -1
- package/docs/cli/setup.md +19 -5
- package/docs/cli/shape.md +2 -2
- package/docs/configuration/make-config.mdx +1 -1
- package/package.json +1 -1
package/dist/cli/cli.js
CHANGED
|
@@ -9395,7 +9395,8 @@ var PLATFORM_PLAN_CATALOG = [
|
|
|
9395
9395
|
"Paid end-user gateway plans (Stripe checkout for API subscribers)",
|
|
9396
9396
|
"1 custom domain on the dev portal",
|
|
9397
9397
|
"100k requests included; up to 1M requests / month",
|
|
9398
|
-
"Stripe subscription billing with promotion codes at checkout"
|
|
9398
|
+
"Stripe subscription billing with promotion codes at checkout",
|
|
9399
|
+
"Standard support"
|
|
9399
9400
|
],
|
|
9400
9401
|
limitations: [
|
|
9401
9402
|
"Requires Stripe checkout to activate",
|
|
@@ -9415,7 +9416,8 @@ var PLATFORM_PLAN_CATALOG = [
|
|
|
9415
9416
|
"3 custom domains",
|
|
9416
9417
|
"1M requests included; up to 10M requests / month",
|
|
9417
9418
|
"Advanced analytics and CDN for your API",
|
|
9418
|
-
"Extended monitoring history and alerts"
|
|
9419
|
+
"Extended monitoring history and alerts",
|
|
9420
|
+
"Enterprise support"
|
|
9419
9421
|
],
|
|
9420
9422
|
limitations: [
|
|
9421
9423
|
"Requires Stripe checkout to activate",
|
|
@@ -9434,8 +9436,8 @@ function buildPlatformPlanSelectionAgentInstruction(quota) {
|
|
|
9434
9436
|
const lines = [
|
|
9435
9437
|
"Before calling ensure_platform_plan, explain the platform hosting tiers to the user using platformPlanCatalog from the bootstrap response or list_platform_plans.",
|
|
9436
9438
|
"Free: $0/month, dev portal + API hub, no custom domain, free ($0) gateway/API plans only.",
|
|
9437
|
-
"Starter: $99/month via Stripe, custom domain, paid gateway plans, production hosting.",
|
|
9438
|
-
"Professional: $999/month via Stripe, higher limits, multiple domains, advanced analytics.",
|
|
9439
|
+
"Starter: $99/month via Stripe, custom domain, paid gateway plans, production hosting, standard support.",
|
|
9440
|
+
"Professional: $999/month via Stripe, higher limits, multiple domains, advanced analytics, enterprise support.",
|
|
9439
9441
|
"This is separate from gateway/API plans (what end users pay for API access) configured in apitogo.config.json.",
|
|
9440
9442
|
"If apitogo.config.json already has paid gateway plans (priceAmount > 0), warn before they pick Free: Free cannot publish paid API plans \u2014 they must choose Starter/Professional, or remove/zero those paid plans first. Never silently strip paid plans."
|
|
9441
9443
|
];
|
|
@@ -12533,7 +12535,7 @@ import {
|
|
|
12533
12535
|
// package.json
|
|
12534
12536
|
var package_default = {
|
|
12535
12537
|
name: "@lukoweb/apitogo",
|
|
12536
|
-
version: "0.1.
|
|
12538
|
+
version: "0.1.94",
|
|
12537
12539
|
type: "module",
|
|
12538
12540
|
sideEffects: [
|
|
12539
12541
|
"**/*.css",
|
|
@@ -18504,12 +18506,13 @@ function buildCreateApitogoCliArgs(invocationArgs, projectName, options) {
|
|
|
18504
18506
|
const cliArgs = [
|
|
18505
18507
|
...invocationArgs,
|
|
18506
18508
|
projectName,
|
|
18507
|
-
"--
|
|
18509
|
+
"--typescript",
|
|
18510
|
+
"--eslint",
|
|
18508
18511
|
"--skip-install",
|
|
18509
18512
|
"--use-npm"
|
|
18510
18513
|
];
|
|
18511
18514
|
if (options?.withExamples) {
|
|
18512
|
-
cliArgs.push("--
|
|
18515
|
+
cliArgs.push("--include-examples");
|
|
18513
18516
|
}
|
|
18514
18517
|
return cliArgs;
|
|
18515
18518
|
}
|
package/docs/cli/commands.md
CHANGED
|
@@ -29,7 +29,8 @@ same commands so agents and humans get identical behavior.
|
|
|
29
29
|
| `init [dir]` | Named folder; `--install` (default), `--overwrite`, `--json`, `--openapi-search` |
|
|
30
30
|
| `config` | Interactive on TTY; flags: `--openapi`, `--page-*`, `--plan`, `--backend`, `--theme`, `--patch`, `--json` |
|
|
31
31
|
|
|
32
|
-
`
|
|
32
|
+
`npx @lukoweb/create-apitogo@latest` remains an interactive alternative for new folders.
|
|
33
|
+
Pass `--typescript --eslint` to skip those prompts. See [Install the CLI](./setup.md#scaffold-options).
|
|
33
34
|
|
|
34
35
|
See [Make config (CLI)](../configuration/make-config.mdx) for all `config` flags.
|
|
35
36
|
|
package/docs/cli/overview.md
CHANGED
|
@@ -13,7 +13,7 @@ local files, preview with `apitogo dev`, and publish to APItoGo hosting with `ap
|
|
|
13
13
|
|
|
14
14
|
## What you get
|
|
15
15
|
|
|
16
|
-
- Scaffold a local portal site (`
|
|
16
|
+
- Scaffold a local portal site (`npx @lukoweb/create-apitogo@latest` or `apitogo init`)
|
|
17
17
|
- Shape backend, OpenAPI, plans, and docs pages via `apitogo config` and file edits
|
|
18
18
|
- Preview locally (`apitogo dev`)
|
|
19
19
|
- Publish to APItoGo hosting (`apitogo apply`) with platform plans **Free**, **Starter**, or
|
package/docs/cli/setup.md
CHANGED
|
@@ -23,10 +23,10 @@ need a global install — scaffold commands add it to your project and `npm inst
|
|
|
23
23
|
|
|
24
24
|
### New project (recommended)
|
|
25
25
|
|
|
26
|
-
`
|
|
26
|
+
`npx @lukoweb/create-apitogo` scaffolds the site **and** installs `@lukoweb/apitogo` locally:
|
|
27
27
|
|
|
28
28
|
```bash
|
|
29
|
-
|
|
29
|
+
npx @lukoweb/create-apitogo@latest
|
|
30
30
|
cd your-project-name
|
|
31
31
|
npx apitogo config # interactive: backend, OpenAPI, pages, plans
|
|
32
32
|
npm run dev
|
|
@@ -35,14 +35,28 @@ npm run dev
|
|
|
35
35
|
Also works with `pnpm create @lukoweb/apitogo`, `yarn create @lukoweb/apitogo`, or
|
|
36
36
|
`bunx @lukoweb/create-apitogo`.
|
|
37
37
|
|
|
38
|
-
Non-interactive
|
|
38
|
+
Non-interactive:
|
|
39
39
|
|
|
40
40
|
```bash
|
|
41
|
-
|
|
41
|
+
npx @lukoweb/create-apitogo@latest my-portal --typescript --eslint
|
|
42
42
|
cd my-portal
|
|
43
43
|
npx apitogo config
|
|
44
44
|
```
|
|
45
45
|
|
|
46
|
+
#### Scaffold options
|
|
47
|
+
|
|
48
|
+
| Flag | Effect |
|
|
49
|
+
| ---- | ------ |
|
|
50
|
+
| `--typescript` / `--ts` | TypeScript project |
|
|
51
|
+
| `--javascript` / `--js` | JavaScript project |
|
|
52
|
+
| `--eslint` | Add ESLint config |
|
|
53
|
+
| `--no-eslint` | Skip ESLint |
|
|
54
|
+
| `--include-examples` | Add starter docs and a sample OpenAPI spec (off unless passed) |
|
|
55
|
+
|
|
56
|
+
Omit flags to be prompted for TypeScript and ESLint. Example files are never prompted.
|
|
57
|
+
|
|
58
|
+
See `@lukoweb/create-apitogo --help` for package manager and install flags.
|
|
59
|
+
|
|
46
60
|
### Scaffold into an existing folder
|
|
47
61
|
|
|
48
62
|
`apitogo init` writes `package.json` with `@lukoweb/apitogo` as a dependency. Run **`npm install`**
|
|
@@ -63,7 +77,7 @@ to preview, then `apitogo apply` when ready to go live.
|
|
|
63
77
|
|
|
64
78
|
| Situation | Command |
|
|
65
79
|
| --------- | ------- |
|
|
66
|
-
| After `
|
|
80
|
+
| After `npx @lukoweb/create-apitogo` or `npm install` in the project | `npx apitogo <command>` (e.g. `npx apitogo config`) |
|
|
67
81
|
| Same, if `node_modules/.bin` is on your PATH | `apitogo <command>` |
|
|
68
82
|
| One-off, no project yet | `npx @lukoweb/apitogo <command>` |
|
|
69
83
|
| Optional global install | `npm install -g @lukoweb/apitogo` then `apitogo <command>` anywhere |
|
package/docs/cli/shape.md
CHANGED
|
@@ -13,10 +13,10 @@ Requires the **`apitogo`** CLI (`@lukoweb/apitogo`). If you have not installed i
|
|
|
13
13
|
|
|
14
14
|
## Happy path
|
|
15
15
|
|
|
16
|
-
`
|
|
16
|
+
`npx @lukoweb/create-apitogo` installs `@lukoweb/apitogo` into the new project. Then run config via `npx`:
|
|
17
17
|
|
|
18
18
|
```bash
|
|
19
|
-
|
|
19
|
+
npx @lukoweb/create-apitogo@latest my-portal --typescript --eslint
|
|
20
20
|
cd my-portal
|
|
21
21
|
npx apitogo config # backend, OpenAPI, pages, plans (apply each immediately)
|
|
22
22
|
npm run dev # http://localhost:3000
|
|
@@ -20,7 +20,7 @@ on new scaffolds. The command does **not** change `redirects`.
|
|
|
20
20
|
|
|
21
21
|
Install the CLI first — see [Install the CLI](../cli/setup.md). In short:
|
|
22
22
|
|
|
23
|
-
- **New site:** `
|
|
23
|
+
- **New site:** `npx @lukoweb/create-apitogo@latest` (installs `@lukoweb/apitogo` into the project)
|
|
24
24
|
- **Existing folder:** `npx @lukoweb/apitogo init .` then `npm install`
|
|
25
25
|
|
|
26
26
|
Run config from the project root with `npx apitogo config` (or `apitogo config` if
|