metaowl 0.4.0 → 0.5.0

package/CHANGELOG.md

@@ -0,0 +1,52 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.5.0] - 2026-04-24
+
+### Changed
+
+- **TypeScript migration completed** — the framework source, Vite integration, CLI entrypoints,
+  and test suite now use TypeScript as the primary source of truth while preserving the existing
+  public API and runtime behavior.
+- **Runtime build output separated from source** — publishable JavaScript is now emitted to
+  `build/runtime`, and package `main`, `exports`, and `bin` entries resolve from that generated
+  runtime output.
+
+### Removed
+
+- **Redundant source JavaScript files** — legacy hand-maintained `.js` source files in `modules/`,
+  `bin/`, `vite/`, and the root entrypoint were removed in favor of the TypeScript sources and the
+  generated runtime build.
+
+### Added
+
+- **Release build workflow** — added dedicated runtime build and release helper scripts for
+  clean runtime generation, release checks, and package dry-run validation.
+
+## [0.4.1] - 2026-03-25
+
+### Added
+
+- **Content hash for `templates.xml`** — the merged OWL template file is now written
+  as `templates.<hash>.xml` (8-character SHA-256 content hash) during `build` and
+  `generate`. All references in the built HTML and JS assets are rewritten accordingly,
+  ensuring browsers always fetch the latest templates after a deployment and never serve
+  stale cached versions.
+
+## [0.4.0] - 2026-03-24
+
+### Added
+
+- **Link component** added.
+
+## [0.3.7] - 2026-03-24
+
+### Fixed
+
+- **bin/metaowl-lint.js** — Fixed inconsistent default lint paths. Changed from `src/owl/pages/**` and `src/owl/components/**` to `src/pages/**` and `src/components/**` to match the documented project structure.
+- **eslint.js** — Fixed `ignores` configuration placement. Moved `ignores` to a separate configuration object as required by ESLint Flat Config format. Also added `.metaowl/**` to the ignore list for the auto-generated component declarations.
+- **modules/auto-import.js** — Fixed missing `node:` prefix for Node.js built-in module import.

package/README.md

@@ -117,6 +117,18 @@ npm install metaowl
 
 `@odoo/owl` is bundled with metaowl and resolved automatically — no separate installation required.
 
+### Release Workflow
+
+For the package itself, the TypeScript sources remain the source of truth and the publishable runtime files are generated into `build/runtime`.
+
+```bash
+npm run release:check   # typecheck + tests
+npm run build:runtime   # clean build/runtime and emit JS
+npm run release:pack    # full check + build + npm pack --dry-run
+```
+
+`npm pack` and `npm publish` also trigger `prepack`, which rebuilds `build/runtime` automatically.
+
 ---
 
 ## Create a New Project
@@ -1654,21 +1666,7 @@ npx serve -s dist
 
 ## Changelog
 
-### v0.4.0 (2026-03-24)
-
-**Added:**
-
-- **Link component** added.
-
-### v0.3.7 (2026-03-24)
-
-**Fixed:**
-
-- **bin/metaowl-lint.js**: Fixed inconsistent default lint paths. Changed from `src/owl/pages/**` and `src/owl/components/**` to `src/pages/**` and `src/components/**` to match the documented project structure.
-
-- **eslint.js**: Fixed `ignores` configuration placement. Moved `ignores` to a separate configuration object as required by ESLint Flat Config format. Also added `.metaowl/**` to the ignore list for the auto-generated component declarations.
-
-- **modules/auto-import.js**: Fixed missing `node:` prefix for Node.js built-in module import.
+See [CHANGELOG.md](CHANGELOG.md) for the full release history.
 
 ---
 

package/build/runtime/bin/metaowl-build.js

@@ -0,0 +1,10 @@
+#!/usr/bin/env node
+/**
+ * metaowl build — lint then production build.
+ */
+import { banner, resolveBin, resolveOwnRuntimeBin, run, success } from './utils.js';
+banner('build');
+run('Linting', `node "${resolveOwnRuntimeBin('metaowl-lint')}"`);
+run('Building', `"${resolveBin('vite')}" build`);
+success('Build complete');
+console.log();

package/{bin → build/runtime/bin}/metaowl-create.js

@@ -1,71 +1,51 @@
 #!/usr/bin/env node
 /**
  * metaowl create — scaffold a new metaowl project.
- *
- * Usage:
- *   metaowl-create [project-name]
- *
- * If no name is given, it will be prompted interactively.
  */
-import { createInterface } from 'node:readline/promises'
-import { mkdirSync, writeFileSync, existsSync } from 'node:fs'
-import { resolve, join, dirname } from 'node:path'
-import { banner, step, success, failure, version } from './utils.js'
-
-banner('create')
-
-// --- Project name ---
-let name = process.argv[2]?.trim()
-
+import { mkdirSync, writeFileSync, existsSync } from 'node:fs';
+import { dirname, join, resolve } from 'node:path';
+import { createInterface } from 'node:readline/promises';
+import { banner, failure, step, success, version } from './utils.js';
+banner('create');
+let name = process.argv[2]?.trim() ?? '';
 if (!name) {
-  const rl = createInterface({ input: process.stdin, output: process.stdout })
-  name = (await rl.question('  Project name: ')).trim()
-  rl.close()
-  console.log()
+    const rl = createInterface({ input: process.stdin, output: process.stdout });
+    name = (await rl.question('  Project name: ')).trim();
+    rl.close();
+    console.log();
 }
-
 if (!name || !/^[a-zA-Z0-9_-]+$/.test(name)) {
-  failure('Invalid project name. Use only letters, numbers, hyphens, or underscores.')
-  process.exit(1)
+    failure('Invalid project name. Use only letters, numbers, hyphens, or underscores.');
+    process.exit(1);
 }
-
-const dest = resolve(process.cwd(), name)
-
+const dest = resolve(process.cwd(), name);
 if (existsSync(dest)) {
-  failure(`Directory "${name}" already exists.`)
-  process.exit(1)
+    failure(`Directory "${name}" already exists.`);
+    process.exit(1);
 }
-
-step(`Scaffolding project "${name}"...`)
-console.log()
-
-// --- File writer helper ---
+step(`Scaffolding project "${name}"...`);
+console.log();
 function write(filePath, content) {
-  const abs = join(dest, filePath)
-  mkdirSync(dirname(abs), { recursive: true })
-  writeFileSync(abs, content, 'utf-8')
-  console.log(`    ${filePath}`)
+    const abs = join(dest, filePath);
+    mkdirSync(dirname(abs), { recursive: true });
+    writeFileSync(abs, content, 'utf-8');
+    console.log(`    ${filePath}`);
 }
-
-// --- package.json ---
 write('package.json', JSON.stringify({
-  name,
-  version: '0.1.0',
-  type: 'module',
-  scripts: {
-    dev: 'metaowl-dev',
-    build: 'metaowl-build',
-    generate: 'metaowl-generate',
-    lint: 'metaowl-lint'
-  },
-  dependencies: {
-    metaowl: `^${version}`
-  }
-}, null, 2) + '\n')
-
-// --- vite.config.js ---
-write('vite.config.js',
-`import { metaowlConfig } from 'metaowl/vite'
+    name,
+    version: '0.1.0',
+    type: 'module',
+    scripts: {
+        dev: 'metaowl-dev',
+        build: 'metaowl-build',
+        generate: 'metaowl-generate',
+        lint: 'metaowl-lint'
+    },
+    dependencies: {
+        metaowl: `^${version}`
+    }
+}, null, 2) + '\n');
+write('vite.config.js', `import { metaowlConfig } from 'metaowl/vite'
 
 export default async () => {
   return metaowlConfig({
@@ -73,45 +53,31 @@ export default async () => {
     pagesDir: 'src/pages'
   })
 }
-`)
-
-// --- eslint.config.js ---
-write('eslint.config.js',
-`import { eslintConfig } from 'metaowl/eslint'
+`);
+write('eslint.config.js', `import { eslintConfig } from 'metaowl/eslint'
 
 export default eslintConfig
-`)
-
-// --- postcss.config.cjs ---
-write('postcss.config.cjs',
-`const { createPostcssConfig } = require('metaowl/postcss')
+`);
+write('postcss.config.cjs', `const { createPostcssConfig } = require('metaowl/postcss')
 
 module.exports = createPostcssConfig()
-`)
-
-// --- jsconfig.json ---
+`);
 write('jsconfig.json', JSON.stringify({
-  extends: './node_modules/metaowl/config/jsconfig.base.json',
-  compilerOptions: {
-    baseUrl: '.',
-    paths: {
-      '@pages/*': ['src/pages/*'],
-      '@components/*': ['src/components/*']
-    }
-  },
-  include: ['src']
-}, null, 2) + '\n')
-
-// --- .gitignore ---
-write('.gitignore',
-`node_modules/
+    extends: './node_modules/metaowl/config/jsconfig.base.json',
+    compilerOptions: {
+        baseUrl: '.',
+        paths: {
+            '@pages/*': ['src/pages/*'],
+            '@components/*': ['src/components/*']
+        }
+    },
+    include: ['src']
+}, null, 2) + '\n');
+write('.gitignore', `node_modules/
 dist/
 .env
-`)
-
-// --- src/index.html ---
-write('src/index.html',
-`<!doctype html>
+`);
+write('src/index.html', `<!doctype html>
 <html lang="en">
   <head>
     <meta charset="UTF-8" />
@@ -123,28 +89,19 @@ write('src/index.html',
     <script type="module" src="/metaowl.js"></script>
   </body>
 </html>
-`)
-
-// --- src/metaowl.js ---
-write('src/metaowl.js',
-`import { boot, Fetch } from 'metaowl'
+`);
+write('src/metaowl.js', `import { boot, Fetch } from 'metaowl'
 
 Fetch.configure({
   baseUrl: import.meta.env.VITE_API_URL ?? ''
 })
 
 boot()
-`)
-
-// --- src/css.js ---
-write('src/css.js',
-`// Global styles — import shared CSS here.
+`);
+write('src/css.js', `// Global styles — import shared CSS here.
 // Component and page CSS files are auto-imported by the metaowl Vite plugin.
-`)
-
-// --- src/pages/index/Index.js ---
-write('src/pages/index/Index.js',
-`import { Component } from '@odoo/owl'
+`);
+write('src/pages/index/Index.js', `import { Component } from '@odoo/owl'
 import { Meta } from 'metaowl'
 import AppHeader from '@components/AppHeader/AppHeader'
 import AppFooter from '@components/AppFooter/AppFooter'
@@ -157,11 +114,8 @@ export default class Index extends Component {
     Meta.title('Home — ${name}')
   }
 }
-`)
-
-// --- src/pages/index/Index.xml ---
-write('src/pages/index/Index.xml',
-`<templates>
+`);
+write('src/pages/index/Index.xml', `<templates>
   <t t-name="Index">
     <div class="layout">
       <AppHeader />
@@ -172,11 +126,8 @@ write('src/pages/index/Index.xml',
     </div>
   </t>
 </templates>
-`)
-
-// --- src/pages/index/index.css ---
-write('src/pages/index/index.css',
-`.layout {
+`);
+write('src/pages/index/index.css', `.layout {
   display: flex;
   flex-direction: column;
   min-height: 100vh;
@@ -186,31 +137,22 @@ write('src/pages/index/index.css',
   flex: 1;
   padding: 2rem;
 }
-`)
-
-// --- src/components/AppHeader/AppHeader.js ---
-write('src/components/AppHeader/AppHeader.js',
-`import { Component } from '@odoo/owl'
+`);
+write('src/components/AppHeader/AppHeader.js', `import { Component } from '@odoo/owl'
 
 export default class AppHeader extends Component {
   static template = 'AppHeader'
 }
-`)
-
-// --- src/components/AppHeader/AppHeader.xml ---
-write('src/components/AppHeader/AppHeader.xml',
-`<templates>
+`);
+write('src/components/AppHeader/AppHeader.xml', `<templates>
   <t t-name="AppHeader">
     <header class="app-header">
       <span class="app-header__logo">${name}</span>
     </header>
   </t>
 </templates>
-`)
-
-// --- src/components/AppHeader/AppHeader.css ---
-write('src/components/AppHeader/AppHeader.css',
-`.app-header {
+`);
+write('src/components/AppHeader/AppHeader.css', `.app-header {
   display: flex;
   align-items: center;
   padding: 0 1.5rem;
@@ -222,31 +164,22 @@ write('src/components/AppHeader/AppHeader.css',
   font-weight: 600;
   font-size: 1.1rem;
 }
-`)
-
-// --- src/components/AppFooter/AppFooter.js ---
-write('src/components/AppFooter/AppFooter.js',
-`import { Component } from '@odoo/owl'
+`);
+write('src/components/AppFooter/AppFooter.js', `import { Component } from '@odoo/owl'
 
 export default class AppFooter extends Component {
   static template = 'AppFooter'
 }
-`)
-
-// --- src/components/AppFooter/AppFooter.xml ---
-write('src/components/AppFooter/AppFooter.xml',
-`<templates>
+`);
+write('src/components/AppFooter/AppFooter.xml', `<templates>
   <t t-name="AppFooter">
     <footer class="app-footer">
       <span>Built with metaowl</span>
     </footer>
   </t>
 </templates>
-`)
-
-// --- src/components/AppFooter/AppFooter.css ---
-write('src/components/AppFooter/AppFooter.css',
-`.app-footer {
+`);
+write('src/components/AppFooter/AppFooter.css', `.app-footer {
   display: flex;
   align-items: center;
   justify-content: center;
@@ -255,11 +188,8 @@ write('src/components/AppFooter/AppFooter.css',
   color: #6b7280;
   border-top: 1px solid #e5e7eb;
 }
-`)
-
-// --- .cursorrules ---
-write('.cursorrules',
-`# MetaOwl Project Rules
+`);
+write('.cursorrules', `# MetaOwl Project Rules
 
 ## Framework Overview
 This is a MetaOwl application - a lightweight meta-framework for Odoo OWL built on top of Vite.
@@ -296,7 +226,7 @@ This is a MetaOwl application - a lightweight meta-framework for Odoo OWL built
 
 ## File Structure
 - pages/ - Route components
-- components/ - Reusable components  
+- components/ - Reusable components
 - layouts/ - Page layouts (optional)
 - metaowl.js - App entry point
 
@@ -309,11 +239,8 @@ This is a MetaOwl application - a lightweight meta-framework for Odoo OWL built
 ## Documentation
 - See README.md for full API reference
 - See metaowl module docs for detailed API
-`)
-
-// --- CLAUDE.md ---
-write('CLAUDE.md',
-`# ${name} - MetaOwl Project
+`);
+write('CLAUDE.md', `# ${name} - MetaOwl Project
 
 ## Quick Start for Claude Code
 
@@ -329,7 +256,7 @@ This project uses MetaOwl, a meta-framework for Odoo OWL on Vite.
 \`\`\`
 src/
 ├── metaowl.js          # App bootstrap
-├── pages/              # Route components (file-based routing)
+├── pages/              # Route components
 │   └── index/
 │       ├── Index.js    # Page component
 │       ├── Index.xml   # OWL template
@@ -420,7 +347,7 @@ src/
 │       └── AdminLayout.xml
 \`\`\`
 
-Layout Template uses \`<t t-slot=\"default\"/>\` to render page content:
+Layout Template uses \`<t t-slot="default"/>\` to render page content:
 \`\`\`xml
 <t t-name="AdminLayout">
   <div class="layout-admin">
@@ -461,11 +388,8 @@ Meta.canonical('https://example.com/page')
 - File-based routing uses directory name, not file name
 - OWL uses xml templates, not JSX
 - Static properties are required (template, components)
-`)
-
-// --- llms.txt ---
-write('llms.txt',
-`# MetaOwl LLM Context
+`);
+write('llms.txt', `# MetaOwl LLM Context
 
 ## Framework Identity
 MetaOwl is a lightweight meta-framework for Odoo OWL (Odoo Web Library) applications, built on Vite. It provides file-based routing, state management, and app mounting.
@@ -611,11 +535,8 @@ export default class ComponentName extends Component {
 - README.md - Full documentation
 - https://github.com/odoo/owl - OWL framework
 - https://vitejs.dev - Vite documentation
-`)
-
-// --- .github/copilot-instructions.md ---
-write('.github/copilot-instructions.md',
-`# GitHub Copilot Instructions for MetaOwl
+`);
+write('.github/copilot-instructions.md', `# GitHub Copilot Instructions for MetaOwl
 
 ## About This Project
 This is a MetaOwl application - a lightweight meta-framework for Odoo OWL (Odoo Web Library) built on Vite.
@@ -731,15 +652,13 @@ router.beforeEach((to, from, next) => {
 - Scope CSS to components
 - Use Meta helpers for SEO
 - Leverage Store for shared state
-`)
-
-// --- Done ---
-console.log()
-success(`Project "${name}" ready`)
-console.log()
-console.log('  Next steps:')
-console.log()
-console.log(`    cd ${name}`)
-console.log(`    npm install`)
-console.log(`    npm run dev`)
-console.log()
+`);
+console.log();
+success(`Project "${name}" ready`);
+console.log();
+console.log('  Next steps:');
+console.log();
+console.log(`    cd ${name}`);
+console.log('    npm install');
+console.log('    npm run dev');
+console.log();

package/build/runtime/bin/metaowl-dev.js

@@ -0,0 +1,10 @@
+#!/usr/bin/env node
+/**
+ * metaowl dev — start the Vite development server.
+ */
+import { execSync } from 'node:child_process';
+import { banner, cwd, resolveBin, step } from './utils.js';
+banner('dev');
+step('Starting development server...');
+console.log();
+execSync(`"${resolveBin('vite')}"`, { stdio: 'inherit', cwd });