diff --git a/.changeset/khaki-jars-repeat.md b/.changeset/khaki-jars-repeat.md new file mode 100644 index 00000000..aad52bba --- /dev/null +++ b/.changeset/khaki-jars-repeat.md @@ -0,0 +1,11 @@ +--- +'@noormdev/sdk': patch +--- + +Put `types` first in the package exports map + +Export conditions are matched in order, so `types` sitting after `import` is +resolvable only by luck — it works today because there is no `require` +condition to shadow it, and would silently stop working the moment one was +added. `publint` reports it as an error. Also normalized both packages' +`repository.url` to the full `git+https://….git` form npm expects. diff --git a/.changeset/olive-pugs-shave.md b/.changeset/olive-pugs-shave.md new file mode 100644 index 00000000..76c8f289 --- /dev/null +++ b/.changeset/olive-pugs-shave.md @@ -0,0 +1,11 @@ +--- +'@noormdev/cli': patch +--- + +Read change-history timestamps as UTC on postgres and mysql + +`executed_at` has no time zone and noorm writes UTC into it, but `pg` and +`mysql2` both read that back through the host's local zone. On a UTC-4 host a +change applied a second ago was reported as four hours in the future, which +surfaced in the TUI as "Applied ... in 4 hours" on the home screen and in +change history. MSSQL is unchanged — its driver was not measured. diff --git a/LICENSE b/LICENSE index ee92eec1..d6456956 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,202 @@ -MIT License - -Copyright (c) 2026 Danilo Alonso - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/NOTICE b/NOTICE new file mode 100644 index 00000000..a58dd1f7 --- /dev/null +++ b/NOTICE @@ -0,0 +1,2 @@ +noorm +Copyright 2026 Danilo Alonso diff --git a/README.md b/README.md index eac7d592..bcdddafe 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Your schema lives in SQL files. noorm builds it, versions it, and keeps every en [](https://www.npmjs.com/package/@noormdev/cli) [](https://www.npmjs.com/package/@noormdev/sdk) [](https://github.com/noormdev/noorm/actions/workflows/ci.yml) -[](./LICENSE) +[](./LICENSE) **[Documentation](https://noorm.dev)** · **[Getting started](https://noorm.dev/getting-started/installation)** · **[Terminal UI](https://noorm.dev/tui)** · **[SDK](https://noorm.dev/reference/sdk)** @@ -121,4 +121,4 @@ noorm also runs as an [MCP server](https://noorm.dev/guide/automation/mcp), behi ## License -MIT +Apache License 2.0. See [LICENSE](./LICENSE) and [NOTICE](./NOTICE). diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 97599674..b4f72515 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -81,16 +81,15 @@ gtag('config', 'G-Y69K95866J');`], // https://vitepress.dev/reference/default-theme-config logo: '/image/logo.svg', siteTitle: 'noorm', + // No Home entry: the logo already links to `/`. Dev docs are not a + // top-bar concern either — they live in the Reference group of the + // main sidebar as "Contributor Documentation". nav: [ - { text: 'Home', link: '/' }, { text: 'Getting Started', link: '/getting-started/installation' }, { text: 'Guide', link: '/guide/sql-files/organization' }, { text: 'CLI', link: '/headless' }, { text: 'TUI', link: '/tui' }, - { - text: 'Dev Docs', - link: '/dev/', - }, + { text: 'Modeling', link: '/modeling/' }, ], sidebar: { @@ -105,6 +104,7 @@ gtag('config', 'G-Y69K95866J');`], { text: 'Runner', link: '/dev/runner' }, { text: 'Settings', link: '/dev/settings' }, { text: 'State', link: '/dev/state' }, + { text: 'Project Discovery', link: '/dev/project-discovery' }, ], }, { @@ -118,6 +118,7 @@ gtag('config', 'G-Y69K95866J');`], { text: 'Locking', link: '/dev/lock' }, { text: 'Teardown', link: '/dev/teardown' }, { text: 'Config Sharing', link: '/dev/config-sharing' }, + { text: 'Data Transfer', link: '/dev/transfer' }, ], }, { @@ -144,20 +145,44 @@ gtag('config', 'G-Y69K95866J');`], { text: 'Getting Started', items: [ + { text: 'Why noorm', link: '/why-noorm' }, { text: 'Installation', link: '/getting-started/installation' }, { text: 'First Build', link: '/getting-started/first-build' }, { text: 'Building Your SDK', link: '/getting-started/building-your-sdk' }, { text: 'Concepts', link: '/getting-started/concepts' }, ], }, + // Only Getting Started and Reference omit `collapsed`, which + // is what pins them open with no toggle. Every other group + // is collapsible and starts closed, so the sidebar opens as + // a short list of topics rather than a wall of links. { text: 'Features', + collapsed: true, items: [ { text: 'CLI Reference', link: '/headless' }, { text: 'Terminal UI', link: '/tui' }, { text: 'Relational Design', link: '/guide/relational-design' }, ], }, + { + // ignatius is a separate binary with its own release + // cadence, so these pages carry the narrative and link + // out to the ignatius repo for the exhaustive rule + // catalogs rather than duplicating them here. + text: 'Information Modeling', + collapsed: true, + items: [ + { text: 'Overview', link: '/modeling/' }, + { text: 'Installation', link: '/modeling/installation' }, + { text: 'Entities & Key Inheritance', link: '/modeling/entities' }, + { text: 'Data Flows', link: '/modeling/data-flows' }, + { text: 'Modeling Skill', link: '/modeling/modeling-skill' }, + { text: 'Reverse-Engineering', link: '/modeling/reverse-engineering' }, + { text: 'Branding', link: '/modeling/branding' }, + { text: 'Best Practices', link: '/modeling/best-practices' }, + ], + }, { text: 'SQL Files', collapsed: true, @@ -175,6 +200,10 @@ gtag('config', 'G-Y69K95866J');`], { text: 'Stages', link: '/guide/environments/stages' }, { text: 'Secrets', link: '/guide/environments/secrets' }, { text: 'Vault', link: '/guide/environments/vault' }, + // Identity is what makes vault sharing and config + // export work, so it belongs beside them even though + // the page lives under /cli/. + { text: 'Identity', link: '/cli/identity' }, ], }, { @@ -201,6 +230,7 @@ gtag('config', 'G-Y69K95866J');`], collapsed: true, items: [ { text: 'CI/CD', link: '/guide/automation/ci' }, + { text: 'Deployment', link: '/guide/deployment' }, { text: 'MCP (AI Agents)', link: '/guide/automation/mcp' }, ], }, @@ -208,13 +238,18 @@ gtag('config', 'G-Y69K95866J');`], text: 'Reference', items: [ { text: 'SDK', link: '/reference/sdk' }, + { text: 'Contributor Documentation', link: '/dev/' }, ], }, ], }, + // Two GitHub repos, so both need an explicit ariaLabel: the default + // is the icon name, which would announce both as just "github". + // brand.css captions them so they are told apart visually too. socialLinks: [ - { icon: 'github', link: 'https://github.com/noormdev/noorm' }, + { icon: 'github', link: 'https://github.com/noormdev/noorm', ariaLabel: 'noorm on GitHub' }, + { icon: 'github', link: 'https://github.com/noormdev/ignatius', ariaLabel: 'ignatius on GitHub' }, ], search: { @@ -235,7 +270,9 @@ gtag('config', 'G-Y69K95866J');`], footer: { message: 'Database Schema & Change Manager', - copyright: `© ${new Date().getFullYear()} noorm · GitHub · npm · ISC License`, + // Apache-2.0 to match LICENSE and every package.json in the repo. This + // read "ISC" until 2026-08 and matched nothing that ships. + copyright: `© ${new Date().getFullYear()} noorm · GitHub · npm · Apache 2.0`, }, }, }), diff --git a/docs/.vitepress/theme/HeroEyebrow.vue b/docs/.vitepress/theme/HeroEyebrow.vue index 20805fea..ac637718 100644 --- a/docs/.vitepress/theme/HeroEyebrow.vue +++ b/docs/.vitepress/theme/HeroEyebrow.vue @@ -1,5 +1,7 @@ - V1.0 · ISC · POSTGRES · MYSQL · SQLITE · MSSQL + + V1.0 · APACHE 2.0 · POSTGRES · MYSQL · SQLITE · MSSQL