@vobs/cli 0.1.0

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 (10) hide show
  1. package/LICENSE +21 -0
  2. package/dist/enterprise-template.d.ts +83 -0
  3. package/dist/enterprise-template.js +656 -0
  4. package/dist/index.d.ts +17 -0
  5. package/dist/index.js +271 -0
  6. package/dist/logo/cli-logo.d.ts +5 -0
  7. package/dist/logo/cli-logo.js +16 -0
  8. package/dist/scaffold.d.ts +23 -0
  9. package/dist/scaffold.js +449 -0
  10. package/package.json +52 -0
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 vobsjs
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/dist/enterprise-template.d.ts ADDED
@@ -0,0 +1,83 @@
1
+ /** @license MIT
2
+ * Copyright (c) 2026 vobsjs
3
+ * @vobs/cli
4
+ */
5
+ export declare const enterpriseFiles: readonly [{
6
+ readonly path: "package.json";
7
+ readonly content: "{\n \"name\": \"{{packageName}}\",\n \"version\": \"0.1.0\",\n \"private\": true,\n \"type\": \"module\",\n \"scripts\": {\n \"dev\": \"vite\",\n \"build\": \"tsc --noEmit && vite build\",\n \"preview\": \"vite preview\",\n \"typecheck\": \"tsc --noEmit\"\n },\n \"dependencies\": {\n \"@vobs/di\": \"latest\",\n \"@vobs/forms\": \"latest\",\n \"@vobs/i18n\": \"latest\",\n \"@vobs/reactivity\": \"latest\",\n \"@vobs/router\": \"latest\",\n \"@vobs/runtime-dom\": \"latest\",\n \"@vobs/server-renderer\": \"latest\",\n \"@vobs/ui\": \"latest\"\n },\n \"devDependencies\": {\n \"@vobs/vite-plugin\": \"latest\",\n \"typescript\": \"^5.7.0\",\n \"vite\": \"^7.0.0\"\n }\n}\n";
8
+ }, {
9
+ readonly path: "tsconfig.json";
10
+ readonly content: "{\n \"compilerOptions\": {\n \"target\": \"ES2022\",\n \"module\": \"ESNext\",\n \"moduleResolution\": \"Bundler\",\n \"lib\": [\"ES2022\", \"DOM\", \"DOM.Iterable\"],\n \"strict\": true,\n \"skipLibCheck\": true,\n \"isolatedModules\": true,\n \"verbatimModuleSyntax\": true,\n \"types\": [\"@vobs/vite-plugin/client\"]\n },\n \"include\": [\"src/**/*.ts\", \"vite.config.ts\"]\n}\n";
11
+ }, {
12
+ readonly path: "vite.config.ts";
13
+ readonly content: "import { defineConfig, type PluginOption } from 'vite';\nimport { vobs } from '@vobs/vite-plugin';\n\nexport default defineConfig({\n plugins: [vobs() as PluginOption],\n});\n";
14
+ }, {
15
+ readonly path: "index.html";
16
+ readonly content: "<!doctype html>\n<html lang=\"en\">\n <head>\n <meta charset=\"UTF-8\" />\n <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\" />\n <title>{{projectName}}</title>\n </head>\n <body>\n <div id=\"app\"></div>\n <script type=\"module\" src=\"/src/main.ts\"></script>\n </body>\n</html>\n";
17
+ }, {
18
+ readonly path: "README.md";
19
+ readonly content: "# {{projectName}}\n\n{{description}}\n\n## Run\n\n~~~bash\nnpm install\nnpm run dev\n~~~\n\nOpen /dashboard for the application shell and /dashboard/users/new for the schema-driven form.\n\n## Boundaries\n\n| Area | Starter responsibility | Production responsibility |\n| --- | --- | --- |\n| DI | One root InjectionScope wires authorization, audit, UI, and i18n | Replace service implementations at composition time |\n| Authorization | Route guards consume an AuthorizationSubject and capability list | Authenticate the request and re-authorize every server mutation |\n| UI | setupUi registers AppShell and shared providers | Extend navigation and components without putting policy decisions in UI Plans |\n| Forms | useForm owns validation and accessible view state | Call an API and apply server errors before showing success |\n| SSR | render-request.ts adapts URL/request data to renderRoute | Supply compiled routes/templates per request and attach platform HTTP headers |\n\nThe built-in local subject exists only so the generated client demo is navigable. Treat client capability checks as presentation logic, never as a security boundary. On SSR, pass authorizationSubject in the request context. Your API must independently authenticate and authorize writes.\n\nThe SSR adapter is host-independent. A Node, Hono, Express, or edge entry point can call renderEnterpriseRequest with its route array, server template registry, per-request environment, and request context, then map RenderRouteResult.status to an HTTP status. Keep secrets and non-serializable session objects out of initialState.\n";
20
+ }, {
21
+ readonly path: "src/env.d.ts";
22
+ readonly content: "/// <reference types=\"@vobs/vite-plugin/client\" />\n\ndeclare module '*.css';\n";
23
+ }, {
24
+ readonly path: "src/main.ts";
25
+ readonly content: "import { app } from './app.js';\nimport '@vobs/ui/tokens.css';\nimport '@vobs/ui/base.css';\nimport '@vobs/ui/components.css';\nimport './styles/global.css';\n\nawait app.mount('#app');\n";
26
+ }, {
27
+ readonly path: "src/app.ts";
28
+ readonly content: "import { createInjectionScope } from '@vobs/di';\nimport { provideI18n } from '@vobs/i18n';\nimport { createVobsApp } from '@vobs/runtime-dom';\nimport { setupUi } from '@vobs/ui';\nimport router from 'vobs:routes';\nimport appShells from './app-shell.js';\nimport { createEnterpriseI18n } from './app/i18n.js';\nimport { registerEnterpriseServices } from './app/services.js';\n\nconst ui = setupUi({ appShells });\nconst injections = ui.injections ?? createInjectionScope();\nregisterEnterpriseServices(injections);\nprovideI18n(injections, createEnterpriseI18n());\n\nconst app = createVobsApp({\n router,\n ui: { ...ui, injections },\n routePending: true,\n onAppError(error) {\n queueMicrotask(() => {\n throw error;\n });\n },\n});\n\nexport { app, injections };\n";
29
+ }, {
30
+ readonly path: "src/app/i18n.ts";
31
+ readonly content: "import { createI18n, defineMessages } from '@vobs/i18n';\n\nconst en = defineMessages({\n navigation: {\n dashboard: 'Dashboard',\n users: 'Users',\n },\n dashboard: {\n title: 'Operations dashboard',\n },\n users: {\n new: 'Create user',\n },\n forms: {\n required: '{label} is required',\n },\n});\n\nexport function createEnterpriseI18n() {\n return createI18n({\n locale: 'en-US',\n fallbackLocale: 'en-US',\n messages: { 'en-US': en },\n });\n}\n";
32
+ }, {
33
+ readonly path: "src/app/services.ts";
34
+ readonly content: "import { createInjectionKey, type InjectionScope } from '@vobs/di';\nimport {\n AuthorizationPortKey,\n defaultAuthorizationPort,\n} from '../access/authorization.js';\n\nexport interface AuditService {\n record(event: string, details: Readonly<Record<string, unknown>>): void;\n}\n\nexport const AuditServiceKey = createInjectionKey<AuditService>('enterprise.audit');\n\nexport function registerEnterpriseServices(scope: InjectionScope): void {\n scope.provide(AuthorizationPortKey, defaultAuthorizationPort);\n scope.provide(AuditServiceKey, {\n record(event, details) {\n console.info('[audit]', event, details);\n },\n });\n}\n";
35
+ }, {
36
+ readonly path: "src/app-shell.ts";
37
+ readonly content: "import { defineAppShell } from '@vobs/ui';\n\nexport default defineAppShell({\n id: 'enterprise',\n title: '{{projectName}}',\n brand: {\n label: '{{projectName}}',\n href: '/dashboard',\n mark: 'K',\n },\n navigation: {\n primary: [\n { id: 'dashboard', label: 'Dashboard', route: '/dashboard' },\n { id: 'new-user', label: 'Create user', route: '/dashboard/users/new' },\n ],\n },\n routes: [\n {\n route: '/dashboard',\n title: 'Operations dashboard',\n description: 'A quiet starting point for enterprise workflows.',\n activeNav: 'dashboard',\n status: 'Ready',\n },\n {\n route: '/dashboard/users/new',\n title: 'Create user',\n description: 'Schema-driven form with DI, i18n, and validation.',\n activeNav: 'new-user',\n status: 'Form',\n },\n ],\n pageHeader: {\n kicker: 'Workspace',\n titleFallback: '{{projectName}}',\n descriptionFallback: 'Enterprise administration starter.',\n },\n topbar: {\n account: {\n label: 'Local Admin',\n initials: 'LA',\n menu: [{ id: 'sign-out', label: 'Sign out', tone: 'danger' }],\n },\n },\n statusbar: {\n text: 'Ready',\n version: '{{projectName}} v0.1.0',\n },\n theme: {\n mode: 'light',\n brand: 'green',\n },\n});\n";
38
+ }, {
39
+ readonly path: "src/access/authorization.ts";
40
+ readonly content: "import { createInjectionKey } from '@vobs/di';\nimport type { RouteGuardContext, RouteGuardResult } from '@vobs/router';\n\nexport interface AuthorizationSubject {\n readonly id: string;\n readonly capabilities: readonly string[];\n}\n\nexport interface AuthorizationRequestContext {\n readonly authorizationSubject?: AuthorizationSubject | null;\n}\n\nexport interface AuthorizationDecision {\n readonly allowed: boolean;\n readonly missingCapabilities: readonly string[];\n}\n\nexport interface AuthorizationPort {\n evaluate(\n subject: AuthorizationSubject | null,\n requiredCapabilities: readonly string[],\n ): AuthorizationDecision;\n}\n\nexport const AuthorizationPortKey =\n createInjectionKey<AuthorizationPort>('enterprise.authorization');\n\nexport const defaultAuthorizationPort: AuthorizationPort = {\n evaluate(subject, requiredCapabilities) {\n const missingCapabilities = requiredCapabilities.filter(\n (capability) => subject?.capabilities.includes(capability) !== true,\n );\n return { allowed: subject !== null && missingCapabilities.length === 0, missingCapabilities };\n },\n};\n\nconst developmentSubject: AuthorizationSubject = {\n id: 'local-admin',\n capabilities: ['dashboard:view', 'users:write'],\n};\n\nexport function requireCapabilities(\n context: RouteGuardContext,\n requiredCapabilities: readonly string[],\n): RouteGuardResult {\n const subject = readAuthorizationSubject(context.request);\n if (subject === null) return '/login';\n const decision = defaultAuthorizationPort.evaluate(subject, requiredCapabilities);\n return decision.allowed ? true : '/403';\n}\n\nfunction readAuthorizationSubject(request: unknown): AuthorizationSubject | null {\n if (typeof request !== 'object' || request === null || !('authorizationSubject' in request)) {\n return developmentSubject;\n }\n return (request as AuthorizationRequestContext).authorizationSubject ?? null;\n}\n";
41
+ }, {
42
+ readonly path: "src/server/render-request.ts";
43
+ readonly content: "import { createRouteResolver } from '@vobs/router';\nimport {\n renderRoute,\n type RenderRouteOptions,\n type RenderRouteResult,\n} from '@vobs/server-renderer';\n\nexport interface EnterpriseSsrRequestOptions\n extends Omit<RenderRouteOptions, 'path' | 'request' | 'resolver'> {\n readonly url: string;\n readonly request?: unknown;\n}\n\nexport async function renderEnterpriseRequest(\n options: EnterpriseSsrRequestOptions,\n): Promise<RenderRouteResult> {\n const { url, request, ...renderOptions } = options;\n const location = new URL(url, 'http://localhost');\n return renderRoute({\n ...renderOptions,\n path: location.pathname,\n resolver: createRouteResolver(),\n ...(request === undefined ? {} : { request }),\n });\n}\n\nexport function createHtmlDocument(result: RenderRouteResult): string {\n return (\n '<!doctype html><html lang=\"en\"><head><meta charset=\"UTF-8\">' +\n '<meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">' +\n '<title>{{projectName}}</title></head><body><div id=\"app\">' +\n result.html +\n (result.initialStateScript ?? '') +\n '</div><script type=\"module\" src=\"/src/main.ts\"></script></body></html>'\n );\n}\n";
44
+ }, {
45
+ readonly path: "src/pages/index.ts";
46
+ readonly content: "import { definePage } from '@vobs/runtime-dom';\nimport template from './index.html';\n\nexport default definePage({\n template,\n setup() {\n return { projectName: '{{projectName}}' };\n },\n});\n";
47
+ }, {
48
+ readonly path: "src/pages/index.html";
49
+ readonly content: "<main class=\"entry-page\">\n <p class=\"eyebrow\">vobs enterprise starter</p>\n <h1>{{ projectName }}</h1>\n <p>Start with the dashboard shell, authorization boundary, forms, i18n, and SSR adapter.</p>\n <a class=\"primary-link\" href=\"/dashboard\">Open dashboard</a>\n</main>\n";
50
+ }, {
51
+ readonly path: "src/pages/login.ts";
52
+ readonly content: "import { definePage } from '@vobs/runtime-dom';\nimport template from './login.html';\n\nexport default definePage({ template, setup: () => ({}) });\n";
53
+ }, {
54
+ readonly path: "src/pages/login.html";
55
+ readonly content: "<main class=\"status-page\">\n <h1>Sign in required</h1>\n <p>Replace this page with your identity provider redirect or sign-in flow.</p>\n <a href=\"/dashboard\">Use local development subject</a>\n</main>\n";
56
+ }, {
57
+ readonly path: "src/pages/403.ts";
58
+ readonly content: "import { definePage } from '@vobs/runtime-dom';\nimport template from './403.html';\n\nexport default definePage({ template, setup: () => ({}) });\n";
59
+ }, {
60
+ readonly path: "src/pages/403.html";
61
+ readonly content: "<main class=\"status-page\">\n <h1>Access denied</h1>\n <p>Your current subject does not have the required capability.</p>\n <a href=\"/dashboard\">Return to dashboard</a>\n</main>\n";
62
+ }, {
63
+ readonly path: "src/pages/(admin)/_layout.ts";
64
+ readonly content: "import { definePage } from '@vobs/runtime-dom';\nimport template from './_layout.html';\n\nexport default definePage({ template, setup: () => ({}) });\n";
65
+ }, {
66
+ readonly path: "src/pages/(admin)/_layout.html";
67
+ readonly content: "<k-app-shell shell=\"enterprise\">\n <slot></slot>\n</k-app-shell>\n";
68
+ }, {
69
+ readonly path: "src/pages/(admin)/dashboard/index.ts";
70
+ readonly content: "import type { RouteGuardContext, RouteGuardResult } from '@vobs/router';\nimport { definePage } from '@vobs/runtime-dom';\nimport { requireCapabilities } from '../../../access/authorization.js';\nimport template from './index.html';\n\nexport const meta = {\n requiresAuth: true,\n capabilities: ['dashboard:view'],\n} as const;\n\nexport function guard(context: RouteGuardContext): RouteGuardResult {\n return requireCapabilities(context, meta.capabilities);\n}\n\nexport default definePage({\n template,\n setup() {\n return {\n stats: [\n { id: 'open', label: 'Open work', value: 18 },\n { id: 'review', label: 'Awaiting review', value: 7 },\n { id: 'resolved', label: 'Resolved today', value: 42 },\n ],\n };\n },\n});\n";
71
+ }, {
72
+ readonly path: "src/pages/(admin)/dashboard/index.html";
73
+ readonly content: "<main class=\"workspace-page\">\n <h1>{{@dashboard.title}}</h1>\n <section class=\"stat-grid\" aria-label=\"Operational summary\">\n <article #for=\"stat in stats\" #key=\"stat.id\" class=\"stat-item\">\n <span>{{ stat.label }}</span>\n <strong>{{ stat.value }}</strong>\n </article>\n </section>\n <section class=\"work-list\">\n <h2>Next actions</h2>\n <a href=\"/dashboard/users/new\">Create a user</a>\n </section>\n</main>\n";
74
+ }, {
75
+ readonly path: "src/pages/(admin)/dashboard/users/new.ts";
76
+ readonly content: "import { defineForm, useForm, type FormView } from '@vobs/forms';\nimport { signal } from '@vobs/reactivity';\nimport type { RouteGuardContext, RouteGuardResult } from '@vobs/router';\nimport { definePage } from '@vobs/runtime-dom';\nimport { requireCapabilities } from '../../../../access/authorization.js';\nimport { AuditServiceKey } from '../../../../app/services.js';\nimport template from './new.html';\n\nconst userFormSchema = defineForm({\n fields: {\n name: { label: 'Name', defaultValue: '', required: true },\n email: { label: 'Email', defaultValue: '', required: true },\n role: {\n label: 'Role',\n defaultValue: 'operator',\n type: 'select',\n options: [\n { label: 'Operator', value: 'operator' },\n { label: 'Administrator', value: 'administrator' },\n ],\n },\n active: { label: 'Active', defaultValue: true, type: 'checkbox' },\n },\n});\n\ntype UserFormView = FormView<typeof userFormSchema.fields>;\n\nexport const meta = {\n requiresAuth: true,\n capabilities: ['users:write'],\n} as const;\n\nexport function guard(context: RouteGuardContext): RouteGuardResult {\n return requireCapabilities(context, meta.capabilities);\n}\n\nexport default definePage<{\n readonly view: UserFormView;\n readonly saved: ReturnType<typeof signal<string>>;\n readonly save: () => void;\n}>({\n template,\n setup(context) {\n const { view } = useForm(context, userFormSchema, {\n viewId: 'user-form',\n validateOn: 'blur',\n });\n const saved = signal('');\n\n function save() {\n void view.submit((values) => {\n context.inject(AuditServiceKey).record('user.created', values);\n saved.value = 'Saved ' + values.name;\n });\n }\n\n return { view, saved, save };\n },\n});\n";
77
+ }, {
78
+ readonly path: "src/pages/(admin)/dashboard/users/new.html";
79
+ readonly content: "<main class=\"workspace-page\">\n <h1>{{@users.new}}</h1>\n <form :id=\"view.id\" :class=\"view.className\" novalidate @submit.prevent=\"save\">\n <section #if=\"view.errorSummary.value.length > 0\" class=\"error-summary\" role=\"alert\">\n <h2>Check the form</h2>\n <ul>\n <li #for=\"error in view.errorSummary.value\" #key=\"error.id\">\n <a :href=\"error.href\">{{ error.message }}</a>\n </li>\n </ul>\n </section>\n <section #for=\"item in view.items\" #key=\"item.name\" :class=\"item.className\">\n <span :id=\"item.labelId\">{{ item.labelText }}</span>\n <input\n #if=\"item.control === 'input'\"\n :id=\"item.controlId\"\n :name=\"item.name\"\n :type=\"item.inputType\"\n :required=\"item.required\"\n :disabled=\"item.disabled\"\n :aria-labelledby=\"item.labelId\"\n :aria-describedby=\"item.ariaDescribedBy\"\n :aria-invalid=\"item.ariaInvalid\"\n #model=\"item.model\"\n />\n <select\n #if=\"item.control === 'select'\"\n :id=\"item.controlId\"\n :name=\"item.name\"\n :required=\"item.required\"\n :disabled=\"item.disabled\"\n :aria-labelledby=\"item.labelId\"\n :aria-describedby=\"item.ariaDescribedBy\"\n :aria-invalid=\"item.ariaInvalid\"\n #model=\"item.model\"\n >\n <option #for=\"option in item.options\" #key=\"option.value\" :value=\"option.value\">\n {{ option.label }}\n </option>\n </select>\n <input\n #if=\"item.control === 'checkbox'\"\n :id=\"item.controlId\"\n :name=\"item.name\"\n type=\"checkbox\"\n :disabled=\"item.disabled\"\n :aria-labelledby=\"item.labelId\"\n #model=\"item.model\"\n />\n <p #if=\"item.errorText.value.length > 0\" :id=\"item.errorId\" class=\"field-error\">\n {{ item.errorText }}\n </p>\n </section>\n <button type=\"submit\" :disabled=\"view.submitting\">Save user</button>\n </form>\n <output aria-live=\"polite\">{{ saved }}</output>\n</main>\n";
80
+ }, {
81
+ readonly path: "src/styles/global.css";
82
+ readonly content: ":root {\n color-scheme: light;\n font-family: Inter, ui-sans-serif, system-ui, sans-serif;\n color: #18211d;\n background: #f5f7f6;\n}\n\nbody {\n margin: 0;\n}\n\na {\n color: #176a46;\n}\n\n.entry-page,\n.status-page,\n.workspace-page {\n width: min(100% - 32px, 960px);\n margin: 0 auto;\n padding: 40px 0;\n}\n\n.eyebrow {\n color: #527064;\n font-size: 0.8rem;\n font-weight: 700;\n text-transform: uppercase;\n}\n\n.primary-link,\nbutton {\n display: inline-flex;\n min-height: 40px;\n align-items: center;\n border: 0;\n border-radius: 4px;\n padding: 0 16px;\n color: white;\n background: #176a46;\n font: inherit;\n text-decoration: none;\n}\n\n.stat-grid {\n display: grid;\n grid-template-columns: repeat(auto-fit, minmax(160px, 1fr));\n gap: 12px;\n}\n\n.stat-item {\n border: 1px solid #d7dfdb;\n border-radius: 6px;\n padding: 16px;\n background: white;\n}\n\n.stat-item strong {\n display: block;\n margin-top: 8px;\n font-size: 1.8rem;\n}\n\n.work-list,\nform {\n margin-top: 24px;\n border-top: 1px solid #d7dfdb;\n padding-top: 24px;\n}\n\n.vobs-field {\n display: grid;\n gap: 6px;\n max-width: 520px;\n margin-bottom: 16px;\n}\n\ninput,\nselect {\n min-height: 40px;\n box-sizing: border-box;\n border: 1px solid #aab8b1;\n border-radius: 4px;\n padding: 8px 10px;\n font: inherit;\n}\n\n.field-error,\n.error-summary {\n color: #a22020;\n}\n";
83
+ }];