@lukoweb/apitogo 0.1.109 → 0.1.111
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 +3 -47
- package/dist/declarations/cli/platform/helpers/dev-portal-manifest.d.ts +1 -1
- package/docs/cli/commands.md +11 -23
- package/docs/cli/overview.md +1 -1
- package/docs/cli/shape.md +1 -1
- package/docs/configuration/make-config.mdx +2 -2
- package/docs/configuration/navigation.mdx +2 -2
- package/docs/configuration/plans.md +1 -1
- package/docs/guides/environment-variables.md +1 -1
- package/docs/mcp/shape.md +1 -1
- package/docs/quickstart.md +2 -2
- package/package.json +1 -1
package/dist/cli/cli.js
CHANGED
|
@@ -5801,7 +5801,7 @@ import {
|
|
|
5801
5801
|
// package.json
|
|
5802
5802
|
var package_default = {
|
|
5803
5803
|
name: "@lukoweb/apitogo",
|
|
5804
|
-
version: "0.1.
|
|
5804
|
+
version: "0.1.111",
|
|
5805
5805
|
type: "module",
|
|
5806
5806
|
sideEffects: [
|
|
5807
5807
|
"**/*.css",
|
|
@@ -11959,8 +11959,6 @@ function applyScaffoldManifestPolicy(manifest, options) {
|
|
|
11959
11959
|
if (options.includeDefaultPlans) {
|
|
11960
11960
|
result.plans = mergePlansBySku2(result.plans, DEFAULT_PLANS);
|
|
11961
11961
|
result.pricing = { enabled: true };
|
|
11962
|
-
} else {
|
|
11963
|
-
delete result.plans;
|
|
11964
11962
|
}
|
|
11965
11963
|
return result;
|
|
11966
11964
|
}
|
|
@@ -14341,7 +14339,7 @@ function buildCreateApitogoCliArgs(invocationArgs, projectName, options) {
|
|
|
14341
14339
|
"--skip-install",
|
|
14342
14340
|
"--use-npm"
|
|
14343
14341
|
];
|
|
14344
|
-
if (options?.withExamples) {
|
|
14342
|
+
if (options?.withExamples !== false) {
|
|
14345
14343
|
cliArgs.push("--include-examples");
|
|
14346
14344
|
}
|
|
14347
14345
|
return cliArgs;
|
|
@@ -16444,7 +16442,6 @@ function addConfigOptions(yargs2) {
|
|
|
16444
16442
|
var config_default = {
|
|
16445
16443
|
desc: "Create or update apitogo.config.json (interactive on TTY: backend, OpenAPI, pages, plans)",
|
|
16446
16444
|
command: "config",
|
|
16447
|
-
aliases: ["make-config"],
|
|
16448
16445
|
builder: (yargs2) => addConfigOptions(yargs2),
|
|
16449
16446
|
handler: async (argv) => {
|
|
16450
16447
|
await captureEvent({ argv, event: "apitogo config" });
|
|
@@ -16452,21 +16449,6 @@ var config_default = {
|
|
|
16452
16449
|
}
|
|
16453
16450
|
};
|
|
16454
16451
|
|
|
16455
|
-
// src/cli/cmds/configure-github-workflow.ts
|
|
16456
|
-
var REMOVED = "apitogo configure-github-workflow was removed. Multi-env SWA deploy is deprecated; use `apitogo deploy`.";
|
|
16457
|
-
var configure_github_workflow_default = {
|
|
16458
|
-
describe: false,
|
|
16459
|
-
command: "configure-github-workflow",
|
|
16460
|
-
builder: (yargs2) => yargs2,
|
|
16461
|
-
handler: async (argv) => {
|
|
16462
|
-
await captureEvent({
|
|
16463
|
-
argv,
|
|
16464
|
-
event: "apitogo configure-github-workflow removed"
|
|
16465
|
-
});
|
|
16466
|
-
await printCriticalFailureToConsoleAndExit(REMOVED);
|
|
16467
|
-
}
|
|
16468
|
-
};
|
|
16469
|
-
|
|
16470
16452
|
// src/cli/apply/handler.ts
|
|
16471
16453
|
import path62 from "node:path";
|
|
16472
16454
|
|
|
@@ -21098,7 +21080,6 @@ async function apply(argv) {
|
|
|
21098
21080
|
var deploy_default = {
|
|
21099
21081
|
desc: "Deploy apitogo.config.json to the API ToGo platform (apihub, portal backend, portal frontend)",
|
|
21100
21082
|
command: "deploy",
|
|
21101
|
-
aliases: ["apply"],
|
|
21102
21083
|
builder: (yargs2) => yargs2.option("dir", {
|
|
21103
21084
|
type: "string",
|
|
21104
21085
|
describe: "Site directory containing apitogo.config.json",
|
|
@@ -21801,18 +21782,6 @@ var init_default = {
|
|
|
21801
21782
|
}
|
|
21802
21783
|
};
|
|
21803
21784
|
|
|
21804
|
-
// src/cli/cmds/preview.ts
|
|
21805
|
-
var REMOVED2 = "apitogo preview was removed. Use `apitogo build --preview` or `apitogo run`.";
|
|
21806
|
-
var preview_default = {
|
|
21807
|
-
describe: false,
|
|
21808
|
-
command: "preview",
|
|
21809
|
-
builder: (yargs2) => yargs2,
|
|
21810
|
-
handler: async (argv) => {
|
|
21811
|
-
await captureEvent({ argv, event: "apitogo preview removed" });
|
|
21812
|
-
await printCriticalFailureToConsoleAndExit(REMOVED2);
|
|
21813
|
-
}
|
|
21814
|
-
};
|
|
21815
|
-
|
|
21816
21785
|
// src/cli/project/create-handler.ts
|
|
21817
21786
|
function resultLooksFailed2(payload) {
|
|
21818
21787
|
try {
|
|
@@ -21885,18 +21854,6 @@ var project_create_default = {
|
|
|
21885
21854
|
}
|
|
21886
21855
|
};
|
|
21887
21856
|
|
|
21888
|
-
// src/cli/cmds/remove.ts
|
|
21889
|
-
var REMOVED3 = "apitogo remove was removed. Use `apitogo teardown --yes` to delete the platform project.";
|
|
21890
|
-
var remove_default = {
|
|
21891
|
-
describe: false,
|
|
21892
|
-
command: "remove",
|
|
21893
|
-
builder: (yargs2) => yargs2,
|
|
21894
|
-
handler: async (argv) => {
|
|
21895
|
-
await captureEvent({ argv, event: "apitogo remove removed" });
|
|
21896
|
-
await printCriticalFailureToConsoleAndExit(REMOVED3);
|
|
21897
|
-
}
|
|
21898
|
-
};
|
|
21899
|
-
|
|
21900
21857
|
// src/cli/dev/handler.ts
|
|
21901
21858
|
init_joinUrl();
|
|
21902
21859
|
import path68 from "node:path";
|
|
@@ -22265,7 +22222,6 @@ async function dev(argv) {
|
|
|
22265
22222
|
var run_default = {
|
|
22266
22223
|
desc: "Run the local portal server",
|
|
22267
22224
|
command: "run",
|
|
22268
|
-
aliases: ["dev"],
|
|
22269
22225
|
builder: (yargs2) => {
|
|
22270
22226
|
return yargs2.option("dir", {
|
|
22271
22227
|
type: "string",
|
|
@@ -22532,7 +22488,7 @@ function createApitogoCli(argv) {
|
|
|
22532
22488
|
process.env.ZUPLO = "1";
|
|
22533
22489
|
printDiagnosticsToConsole("Running in Zuplo mode");
|
|
22534
22490
|
}
|
|
22535
|
-
}).middleware(warnPackageVersionMismatch).command(command(init_default)).command(command(config_default)).command(command(run_default)).command(command(build_default)).command(command(check_default)).command(command(project_create_default)).command(command(deploy_default)).command(command(status_default)).command(command(teardown_default)).
|
|
22491
|
+
}).middleware(warnPackageVersionMismatch).command(command(init_default)).command(command(config_default)).command(command(run_default)).command(command(build_default)).command(command(check_default)).command(command(project_create_default)).command(command(deploy_default)).command(command(status_default)).command(command(teardown_default)).demandCommand().strictCommands().version(packageJson?.version).fail(false).help();
|
|
22536
22492
|
}
|
|
22537
22493
|
|
|
22538
22494
|
// src/cli/cli.ts
|
|
@@ -110,7 +110,7 @@ export declare const SCAFFOLD_OPENAPI_MISSING_NEXT_STEP: DevPortalSuggestedNextS
|
|
|
110
110
|
export declare const SCAFFOLD_SUGGESTED_NEXT_STEPS: DevPortalSuggestedNextStep[];
|
|
111
111
|
export declare function buildScaffoldJourneyPhases(steps?: DevPortalSuggestedNextStep[]): DevPortalJourneyPhase[];
|
|
112
112
|
export declare const SCAFFOLD_JOURNEY_PHASES: DevPortalJourneyPhase[];
|
|
113
|
-
export declare const SCAFFOLD_AGENT_INSTRUCTION = "Scaffold only \u2014 dependencies are installed but the dev server is not started. Tell the user the site is ready and to run npm run dev in outputDirectory. The home page lives in landing/LandingPage.tsx (
|
|
113
|
+
export declare const SCAFFOLD_AGENT_INSTRUCTION = "Scaffold only \u2014 dependencies are installed but the dev server is not started. Tell the user the site is ready and to run npm run dev in outputDirectory. The home page lives in landing/LandingPage.tsx (default sample sections including plans). After npm run dev, ask if they want to customize the home page. When they do, always ask for their real content first (what the API does, key endpoints, audience, tone, desired sections) before editing \u2014 never invent placeholder copy unless they explicitly ask for placeholders \u2014 then edit that TSX file directly or call get_dev_portal_landing_guide for the component catalog. Do not write home page content to apitogo.config.json. Then ask what else they want (OpenAPI, plans, bootstrap API ToGo, or go live). Do not mention missing plans, null projectId, skipped bootstrap, publishPrerequisites, or other absent setup unless the user asks about publish or platform provisioning. One user intent \u2192 one MCP tool. When preview is running, shape-phase file edits hot-reload. Never pass restartPreview: true on update_dev_portal_manifest or set_dev_portal_theme (ignored; used to time out against npm run dev). For publish, the user saves OIDC (+ Stripe if paid) in .env using APITOGO_CONFIG_AUTHENTICATION__* keys \u2014 never collect secrets in chat. Call check_dev_portal_publish_readiness after they confirm, then publish_dev_portal. Do not call sync_gateway_plans_from_manifest before publish.";
|
|
114
114
|
export declare function manifestRequiresStripe(plans: ManifestPlanInput[] | undefined): boolean;
|
|
115
115
|
export declare function isNativeAuthEnabledInManifest(manifest: DevPortalLocalManifest): boolean;
|
|
116
116
|
export declare function readManifestAuthProviders(manifest: DevPortalLocalManifest): NonNullable<DevPortalLocalManifest["authentication"]>["providers"];
|
package/docs/cli/commands.md
CHANGED
|
@@ -10,17 +10,17 @@ same commands so agents and humans get identical behavior.
|
|
|
10
10
|
|
|
11
11
|
## Lifecycle (prefer these)
|
|
12
12
|
|
|
13
|
-
| Command
|
|
14
|
-
|
|
|
15
|
-
| `init`
|
|
16
|
-
| `config`
|
|
17
|
-
| `run`
|
|
18
|
-
| `build`
|
|
19
|
-
| `check`
|
|
20
|
-
| `project create`
|
|
21
|
-
| `deploy`
|
|
22
|
-
| `status`
|
|
23
|
-
| `teardown --yes`
|
|
13
|
+
| Command | Role |
|
|
14
|
+
| ---------------- | --------------------------------------------------------------------- |
|
|
15
|
+
| `init` | Scaffold portal (default `./dev-portal`; OpenAPI discovery + secrets) |
|
|
16
|
+
| `config` | Write or update `apitogo.config.json` (interactive or flags) |
|
|
17
|
+
| `run` | Local preview server |
|
|
18
|
+
| `build` | Production build (`--preview` to serve locally) |
|
|
19
|
+
| `check` | Publish readiness (secrets, manifest, site validation) |
|
|
20
|
+
| `project create` | Create a platform project (plan unselected) |
|
|
21
|
+
| `deploy` | Publish config to platform (apihub + portal) |
|
|
22
|
+
| `status` | Account, project, and live readiness |
|
|
23
|
+
| `teardown --yes` | Delete the linked platform project |
|
|
24
24
|
|
|
25
25
|
## Scaffold and config
|
|
26
26
|
|
|
@@ -39,7 +39,6 @@ See [Make config (CLI)](../configuration/make-config.mdx) for all `config` flags
|
|
|
39
39
|
| Command | Role |
|
|
40
40
|
| ----------------- | --------------------------------------------------------- |
|
|
41
41
|
| `run` | Run the local portal server (`--port`, `--open`, `--ssr`) |
|
|
42
|
-
| `dev` | Alias for `run` |
|
|
43
42
|
| `build` | Production static build |
|
|
44
43
|
| `build --preview` | Build then serve locally |
|
|
45
44
|
|
|
@@ -54,7 +53,6 @@ See [Make config (CLI)](../configuration/make-config.mdx) for all `config` flags
|
|
|
54
53
|
| `deploy --force` | Redeploy selected resources even when healthy |
|
|
55
54
|
| `deploy --platform-plan` | Select Free / Starter / Professional hosting |
|
|
56
55
|
| `deploy --resume-from` | Resume interrupted publish |
|
|
57
|
-
| `apply` | Alias for `deploy` |
|
|
58
56
|
| `status` | Whoami + project + live verification |
|
|
59
57
|
| `teardown --yes` | Delete platform project (confirmation required) |
|
|
60
58
|
|
|
@@ -69,16 +67,6 @@ Env: `APITOGO_API_KEY_ID`, `APITOGO_API_SECRET`. Optional: `APITOGO_API_URL`.
|
|
|
69
67
|
|
|
70
68
|
There is no CLI command for arbitrary home page content.
|
|
71
69
|
|
|
72
|
-
## Removed commands
|
|
73
|
-
|
|
74
|
-
These print a redirect message — use the replacement:
|
|
75
|
-
|
|
76
|
-
| Removed | Use instead |
|
|
77
|
-
| --------------------------- | -------------------------------------------------- |
|
|
78
|
-
| `preview` | `npx apitogo build --preview` or `npx apitogo run` |
|
|
79
|
-
| `remove` | `npx apitogo teardown --yes` |
|
|
80
|
-
| `configure-github-workflow` | `npx apitogo deploy` |
|
|
81
|
-
|
|
82
70
|
## Related
|
|
83
71
|
|
|
84
72
|
- [Overview](./overview.md)
|
package/docs/cli/overview.md
CHANGED
|
@@ -23,7 +23,7 @@ local files, preview with `npx apitogo run`, and publish to APItoGo hosting with
|
|
|
23
23
|
|
|
24
24
|
## Prerequisites
|
|
25
25
|
|
|
26
|
-
### Shell environment (for
|
|
26
|
+
### Shell environment (for deploy / status / teardown)
|
|
27
27
|
|
|
28
28
|
| Variable | Required | Purpose |
|
|
29
29
|
| -------------------- | -------- | ----------------- |
|
package/docs/cli/shape.md
CHANGED
|
@@ -56,7 +56,7 @@ Fonts and colors are **not** prompted — edit `apitogo.config.json` or see
|
|
|
56
56
|
[Colors & theme](../customization/colors-theme.mdx).
|
|
57
57
|
|
|
58
58
|
**Paid plans:** if any plan has `priceAmount > 0`, you need **Starter** or **Professional** platform
|
|
59
|
-
hosting on
|
|
59
|
+
hosting on deploy. **Free** cannot publish paid gateway plans or custom domains.
|
|
60
60
|
|
|
61
61
|
Full reference: [Make config (CLI)](../configuration/make-config.mdx) ·
|
|
62
62
|
[Gateway plans](../configuration/plans.md)
|
|
@@ -7,7 +7,7 @@ description:
|
|
|
7
7
|
site settings.
|
|
8
8
|
---
|
|
9
9
|
|
|
10
|
-
The **`npx apitogo config`**
|
|
10
|
+
The **`npx apitogo config`** command writes **`apitogo.config.json`**. It can
|
|
11
11
|
scaffold a portal project (package.json, tsconfig, landing and user-panel stubs, thin
|
|
12
12
|
`apitogo.config.tsx`) when those files are missing, merge **site / theme / authentication** from
|
|
13
13
|
flags, run an **interactive wizard** on a TTY (apply each change immediately), scan `pages/` for
|
|
@@ -71,7 +71,7 @@ Authentication stays **enabled**; `npx apitogo deploy` writes
|
|
|
71
71
|
`VITE_APITOGO_AUTHENTICATION_API_BASE_URL` to `.env` after the portal backend is provisioned.
|
|
72
72
|
|
|
73
73
|
If you add a **paid** plan (`priceAmount > 0`), the CLI warns that **Free platform hosting cannot
|
|
74
|
-
publish paid gateway plans or custom domains** — use Starter or Professional on
|
|
74
|
+
publish paid gateway plans or custom domains** — use Starter or Professional on deploy.
|
|
75
75
|
|
|
76
76
|
See [Gateway plans](./plans.md) and [Shape with CLI](../cli/shape.md).
|
|
77
77
|
|
|
@@ -58,13 +58,13 @@ one of several types. At the simplest level you may only have links and categori
|
|
|
58
58
|
|
|
59
59
|
## Generate navigation automatically
|
|
60
60
|
|
|
61
|
-
Use the CLI command **`npx apitogo
|
|
61
|
+
Use the CLI command **`npx apitogo config`** to merge **`navigation`** from your pages folder into
|
|
62
62
|
`apitogo.config.json`. See **[Make config (CLI)](./make-config.md)** for usage. The command does **not**
|
|
63
63
|
change **`redirects`**.
|
|
64
64
|
|
|
65
65
|
::::caution
|
|
66
66
|
|
|
67
|
-
Without `--force`, `
|
|
67
|
+
Without `--force`, `npx apitogo config` only **adds missing** Documentation items. `--force` rebuilds
|
|
68
68
|
Documentation items from disk but still keeps other nav entries such as API Reference.
|
|
69
69
|
|
|
70
70
|
::::
|
|
@@ -113,7 +113,7 @@ The **Free** platform plan cannot:
|
|
|
113
113
|
- Attach a **custom domain** to the dev portal
|
|
114
114
|
|
|
115
115
|
Use **Starter** or **Professional** for paid API tiers, Stripe checkout, and custom domains. If your
|
|
116
|
-
manifest has paid plans and you try `npx apitogo deploy --platform-plan free`,
|
|
116
|
+
manifest has paid plans and you try `npx apitogo deploy --platform-plan free`, deploy is blocked until you
|
|
117
117
|
upgrade or zero/remove those paid plans.
|
|
118
118
|
|
|
119
119
|
## Related
|
|
@@ -85,7 +85,7 @@ interface ImportMeta {
|
|
|
85
85
|
|
|
86
86
|
| Variable | Purpose |
|
|
87
87
|
| -------- | ------- |
|
|
88
|
-
| `APITOGO_API_KEY_ID` / `APITOGO_API_SECRET` | Required for MCP and CLI
|
|
88
|
+
| `APITOGO_API_KEY_ID` / `APITOGO_API_SECRET` | Required for MCP and CLI deploy/status/teardown |
|
|
89
89
|
| `APITOGO_DOC_TOOL_PATH` | Optional local doc-tool for scaffold |
|
|
90
90
|
| `APITOGO_CLI_PATH` | Optional local `@lukoweb/apitogo` / doc-tool checkout for MCP spawn |
|
|
91
91
|
|
package/docs/mcp/shape.md
CHANGED
package/docs/quickstart.md
CHANGED
|
@@ -39,8 +39,8 @@ Build an API product (developer portal, plans, gateway, backend) with an AI agen
|
|
|
39
39
|
> Create a portal in `./dev-portal` for my API in `./api` with Free (100/min) and Pro (1000/min);
|
|
40
40
|
> make `/health` public.
|
|
41
41
|
|
|
42
|
-
The agent should call `apply_product_intent` with `mode: "shape"` (or `create_dev_portal` for
|
|
43
|
-
|
|
42
|
+
The agent should call `apply_product_intent` with `mode: "shape"` (or `create_dev_portal` for a
|
|
43
|
+
default scaffold). See [Shape](./mcp/shape.md).
|
|
44
44
|
|
|
45
45
|
1. **Preview locally**
|
|
46
46
|
|