@lukoweb/apitogo 0.1.51 → 0.1.54

package/docs/configuration/manifest.md

@@ -1,59 +1,20 @@
----
-title: Site configuration (apitogo.config.json)
-sidebar_icon: file-json
----
+# Site configuration (apitogo.config.json)
 
-Dev portal sites use a single JSON configuration file for site settings, plans,
-branding, backend paths, and gateway metadata. Code-only pieces (plugins, custom
-components) stay in `apitogo.config.tsx`.
+Dev portal sites use a single JSON file for site settings, plans, authentication, and backend
+metadata. Code-only pieces (plugins, custom components) stay in `apitogo.config.tsx`.
 
 ## Files
 
-| File | Purpose |
-| --- | --- |
-| `apitogo.config.json` | Committed defaults: site, modules, plans, branding, backend, gateway |
-| `apitogo.config.tsx` | Plugins and other non-JSON configuration |
-| `.env` / `.env.local` / `.env.production` | Per-environment overrides via `APITOGO_CONFIG_*` and `VITE_*` vars |
+| File                  | Purpose                                                     |
+| --------------------- | ----------------------------------------------------------- |
+| `apitogo.config.json` | Committed defaults: site, modules, authentication, backend  |
+| `apitogo.config.tsx`  | Plugins and other non-JSON configuration                    |
+| `.env` / `.env.local` | Public client vars + publish secrets via `APITOGO_CONFIG_*` |
 
-## Environment overrides
-
-Use `APITOGO_CONFIG_<path>` with double underscores for nested paths:
-
-```sh
-APITOGO_CONFIG_site__title=My Local Site
-APITOGO_CONFIG_pricing__enabled=true
-APITOGO_CONFIG_projectId=your-local-project-id
-APITOGO_CONFIG_backend__sourceDirectory=../my-api
-```
-
-Values are parsed as JSON when possible (`true`, `false`, numbers, objects).
-
-For the live dev-portal API URL (client-visible):
-
-```sh
-VITE_APITOGO_DEV_PORTAL_API_URL=https://your-dev-portal-api.example.com
-```
-
-Keep secrets (OIDC client secret, Stripe keys, etc.) in `.env.local` using the
-same `APITOGO_CONFIG_*` pattern — never commit them.
-
-## Example `apitogo.config.json`
+## Canonical shape
 
 ```json
 {
-  "siteName": "My API",
-  "branding": { "title": "My API" },
-  "pricing": { "enabled": true },
-  "authentication": { "enabled": true, "type": "dev-portal" },
-  "plans": [
-    {
-      "sku": "pro",
-      "displayName": "Pro",
-      "isFree": false,
-      "priceAmount": 9.99,
-      "billingPeriod": "month"
-    }
-  ],
   "site": {
     "title": "My API",
     "logo": {
@@ -62,10 +23,72 @@ same `APITOGO_CONFIG_*` pattern — never commit them.
       "width": "130px"
     }
   },
-  "docs": { "files": "/pages/**/*.{md,mdx}" }
+  "authentication": {
+    "enabled": true,
+    "type": "dev-portal",
+    "apiBaseUrl": "https://your-dev-portal-api.example.com",
+    "gateway": {
+      "authMode": "bringYourOwnOidc",
+      "oidcMetadataUrl": "https://login.example.com/.well-known/openid-configuration"
+    }
+  },
+  "modules": {
+    "docs": { "files": "/pages/**/*.{md,mdx}" },
+    "landing": { "enabled": true, "path": "/", "layout": "landing" },
+    "userPanel": {
+      "enabled": true,
+      "dashboard": { "enabled": true },
+      "userManagement": { "enabled": true },
+      "plans": {
+        "enabled": true,
+        "items": [
+          {
+            "sku": "free",
+            "displayName": "Free",
+            "priceAmount": 0
+          }
+        ]
+      }
+    }
+  },
+  "apis": [{ "type": "file", "input": "./apis/openapi.yaml", "path": "api" }]
 }
 ```
 
+- **Site name / logo:** only `site.title` and `site.logo` (platform branding is derived at publish).
+- **OpenAPI path:** `backend.openApiPath` is derived from `apis[0].input`.
+- **Billing / account plans:** use `modules.userPanel.plans.enabled` and store the plan catalog in
+  `modules.userPanel.plans.items`. Legacy root `plans` is migrated on load. Legacy `pricing.enabled`
+  is migrated and stripped from site JSON; MCP/publish still receives derived `pricing.enabled`.
+- **Docs / API keys:** configure under `modules.docs` and `modules.userPanel.apiKeys` only.
+
+## Environment variables
+
+Public client URL (mirrors `authentication.apiBaseUrl`):
+
+```sh
+VITE_APITOGO_AUTHENTICATION_API_BASE_URL=https://your-dev-portal-api.example.com
+```
+
+Nested config overrides:
+
+```sh
+APITOGO_CONFIG_site__title=My Local Site
+APITOGO_CONFIG_pricing__enabled=true
+APITOGO_CONFIG_projectId=your-local-project-id
+APITOGO_CONFIG_authentication__apiBaseUrl=https://your-dev-portal-api.example.com
+```
+
+Publish secrets (`.env.local`, never commit):
+
+```sh
+APITOGO_CONFIG_authentication__oidc__authority=https://login.example.com
+APITOGO_CONFIG_authentication__oidc__clientId=your-client-id
+APITOGO_CONFIG_authentication__oidc__clientSecret=your-client-secret
+APITOGO_CONFIG_authentication__stripe__secretKey=sk_test_...
+APITOGO_CONFIG_authentication__stripe__webhookSecret=whsec_...
+```
+
 ## Thin `apitogo.config.tsx`
 
 ```tsx
@@ -77,29 +100,7 @@ export default buildApitogoConfig({
 });
 ```
 
-## What to put where
-
-| Concern | Recommended location |
-| --- | --- |
-| Plans, rate limits, `includedActionKeys` | `apitogo.config.json` |
-| Branding, site name, modules, navigation | `apitogo.config.json` |
-| Machine-specific paths, `projectId` | `.env.local` via `APITOGO_CONFIG_*` |
-| OIDC / Stripe for publish | `.env.local` via `APITOGO_CONFIG_*` |
-| Plugins | `apitogo.config.tsx` |
-
-## Hot reload
-
-During `npm run dev`, changes to `apitogo.config.json` hot-reload on `/pricing`
-without restarting the server. Restart the dev server after changing
-`VITE_APITOGO_DEV_PORTAL_API_URL` in `.env`.
-
-## Legacy manifests
-
-Older projects may still have `apitogo.json` with optional
-`apitogo.local.json` / `apitogo.prod.json` overrides. The tooling falls back to
-those files when `apitogo.config.json` is missing.
-
-## Related configuration
+## Related
 
-- Site navigation, docs, and plugins: [`apitogo.config.tsx`](./overview.md)
-- Authentication for dev-portal sites: [Authentication](./authentication.md)
+- [Authentication](./authentication.md)
+- [Overview](./overview.md)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lukoweb/apitogo",
-  "version": "0.1.51",
+  "version": "0.1.54",
   "type": "module",
   "sideEffects": [
     "**/*.css",