@spynejs/cms 0.1.0

package/LICENSE.md

@@ -0,0 +1,84 @@
+# License
+
+Copyright © Relevant Context, Inc.  
+All rights reserved.
+
+This software is part of the **SpyneJS Platform**, developed and maintained by **Relevant Context, Inc.**, a Delaware C-Corporation.
+
+---
+
+## Dual Licensing Model
+
+This project is made available under a **dual-license model**:
+
+1. **GNU General Public License v3.0 (GPL-3.0)** — for open-source use
+2. **Commercial License** — for proprietary, enterprise, or closed-source use
+
+You may choose **either** license depending on your intended use.
+
+---
+
+## Option 1: Open Source License (GPL-3.0)
+
+This software may be used, modified, and distributed under the terms of the  
+**GNU General Public License version 3 (GPL-3.0)**.
+
+Under this license:
+
+- Any derivative works must also be licensed under GPL-3.0
+- Source code must be made available when distributing modified versions
+- The software is provided **without warranty**, as described in the GPL
+
+The full GPL-3.0 license text can be found here:  
+https://www.gnu.org/licenses/gpl-3.0.html
+
+---
+
+## Option 2: Commercial License
+
+A **commercial license** is required if you intend to:
+
+- Use this software in a **proprietary or closed-source application**
+- Distribute it as part of a **commercial SaaS or enterprise product**
+- Modify or extend it **without releasing your changes under GPL-3.0**
+- Integrate it into systems with usage restrictions, paid access, or gated features
+
+Commercial licenses provide additional rights, which may include:
+- Closed-source usage
+- Enterprise deployment
+- Internal modification without open-sourcing derivatives
+- Access to premium plugins, tooling, or services
+
+For commercial licensing inquiries, contact:
+
+**licensing@relevantcontext.ai**  
+(or update with final address)
+
+---
+
+## Platform Components & Mixed Licensing
+
+The SpyneJS platform consists of multiple components that may be distributed under **different terms**, including but not limited to:
+
+- Client-side framework code
+- CMS UI plugins
+- Webpack / server-side plugins
+- Premium or authenticated tooling
+- Hosted services and APIs
+
+Not all components are necessarily open-source, even when interoperating with GPL-licensed code.  
+Access to certain functionality may require authentication, subscription, or separate agreements.
+
+---
+
+## No Warranty
+
+THIS 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.
+
+---
+
+## Questions
+
+If you are unsure which license applies to your use case, please contact:
+
+**frankbatista@relevantcontext.io**

package/README.md

@@ -0,0 +1,154 @@
+# @spynejs/cms
+
+@spynejs/cms is the **official CMS runtime plugin for SpyneJS**.
+
+It provides a **WYSIWYG data authoring layer** for SpyneJS applications, enabling live editing of **structured JSON data** directly inside a running app — without modifying application code.
+
+The CMS operates strictly on **application data**, preserving SpyneJS’s explicit View–Behavior–Logic architecture while enabling structured collaboration between developers, content authors, and AI-assisted workflows.
+
+---
+
+## What this is
+
+- A **CMS runtime plugin**, not a standalone application
+- Designed to run **inside SpyneJS applications**
+- Enables WYSIWYG editing of structured JSON data
+- Uses **deterministic, path-based updates**
+- Built to support **human + AI copy / revise / validate workflows**
+
+This package represents the **runtime CMS layer** of the SpyneJS platform.  
+Persistence, file access, and environment-specific behavior are handled by separate adapter packages.
+
+---
+
+## Who this is for
+
+- Developers building SpyneJS applications that use structured JSON data
+- Teams that want **safe, local-first content editing** during development
+- Projects that require **explicit control over behavior wiring**
+- AI-assisted authoring workflows that must remain deterministic and auditable
+
+---
+
+## How it fits into SpyneJS
+
+SpyneJS applications treat **data, behavior, and rendering as distinct concerns**.
+
+@spynejs/cms integrates at the **data layer only**:
+- It tracks deterministic paths through application data
+- Reflects edits live in the running application
+- Stages changes without mutating application logic or templates
+
+All behavior wiring, rendering logic, and application structure remain **fully controlled by the developer**.
+
+---
+
+## AppBuilder-generated applications
+
+No setup required.
+
+All AppBuilder-generated SpyneJS applications automatically:
+- Load the CMS runtime plugin
+- Pipe supported data sources through the CMS layer
+- Enable WYSIWYG editing for local JSON data
+
+---
+
+## Custom SpyneJS applications
+
+### 1. Register the CMS plugin
+
+```js
+SpyneApp.registerPlugin(spyneCmsPlugin);
+```
+
+---
+
+### 2. Pipe fetched data through the CMS mapper
+
+When registering a fetch channel, route fetched data through the CMS mapping function:
+
+```js
+SpyneApp.registerChannel(
+  new ChannelFetch("MY_JSON_DATA", {
+    url: myJSONDataURL,
+    map: SpyneApp.pluginsFn.mapCmsData,
+  }),
+);
+```
+
+This allows the CMS to:
+- Track deterministic data paths
+- Associate UI edits with source data
+- Stage changes safely before persistence
+
+---
+
+## Local JSON editing (adapter required)
+
+To edit **local JSON files**, an environment adapter must also be installed and running.
+
+The adapter is responsible for:
+- Reading JSON files from disk
+- Applying path-based updates
+- Writing updated JSON files
+- Creating timestamped backups
+
+👉 See **@spynejs/cms-adapter** for installation and setup details.
+
+---
+
+## Release status
+
+This package represents the **first public release** of the SpyneJS CMS runtime plugin.
+
+It has been developed and used internally as a **private package for over two years** across production SpyneJS applications before being prepared for public release.
+
+The current release focuses on a **stable, intentionally scoped feature set**:
+- WYSIWYG authoring of structured JSON data
+- Deterministic, path-based updates
+- Safe integration with the SpyneJS runtime
+
+The CMS will continue to evolve as part of the broader SpyneJS authoring platform, with future expansions including additional adapters, deeper tooling integration, and AI-assisted workflows.
+
+---
+
+## Scope & roadmap
+
+**Current**
+- WYSIWYG editing of structured JSON data
+- Automatic integration with AppBuilder apps
+- Manual integration with custom SpyneJS apps
+- Deterministic, path-based update model
+
+**Planned**
+- Adapters for additional data sources (SQL, NoSQL, headless CMS)
+- Deeper integration with Spyne Studio
+- AI-assisted content editing and validation
+
+---
+
+## Important notes
+
+- This CMS **does not edit JavaScript, HTML, or SCSS**
+- It operates strictly on application data
+- All behavior wiring remains explicit and controlled by the application
+
+---
+
+## License & ownership
+
+© Relevant Context, Inc. All rights reserved.
+
+This software is part of the SpyneJS platform and is developed and maintained by Relevant Context, Inc., a Delaware C-Corporation.
+
+The final open-source license for this package has **not yet been designated**.  
+Until a license is explicitly published:
+
+- This code is provided for evaluation and authorized use only
+- Redistribution, modification, or commercial reuse may be restricted
+- Certain functionality may require authentication or an active subscription
+
+Parts of the SpyneJS CMS ecosystem — including runtime behavior, server-side plugins, and premium tooling — may be distributed separately under different terms.
+
+A formal license (likely GPL-3.0 or a dual-license model) will be announced prior to public open-source release.