@skylivellc/lienzo-editor 0.0.0-stage → 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Skylive LLC
+
+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.

package/README.md

@@ -1,3 +1,62 @@
-# Temporary Holding Version
+# @skylivellc/lienzo-editor
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The visual editor of [Lienzo](https://github.com/SkyliveLLC/lienzo), an open-source landing page builder. Admins place headings, images, forms and your app's own elements on a free-form canvas, with a separate phone layout, then publish. The canvas renders through `@skylivellc/lienzo-core` in an iframe, so it shows the same markup and styles visitors get, and your app's CSS cannot leak into it.
+
+The editor talks to a backend over the Lienzo protocol. The Laravel package `skylive/lienzo` implements it and ships this editor prebuilt, so Laravel apps do not install this package. For other backends, see [Other backends](https://github.com/SkyliveLLC/lienzo#other-backends).
+
+The editor comes in three forms. Pick the one that matches your frontend.
+
+## Use it as a Vue 3 component
+
+```sh
+npm install @skylivellc/lienzo-editor vue
+```
+
+```vue
+<script setup lang="ts">
+import { LienzoEditor } from '@skylivellc/lienzo-editor';
+</script>
+
+<template>
+	<LienzoEditor endpoint="/admin/site/1" locale="en" style="height: 100vh" />
+</template>
+```
+
+## Use it as a custom element with your bundler
+
+`@skylivellc/lienzo-editor/element` registers `<lienzo-editor>`. Install `vue` next to it, as for the component, because your bundler resolves it. The editor renders in a shadow root, so page CSS does not reach it.
+
+```ts
+import '@skylivellc/lienzo-editor/element';
+```
+
+```html
+<lienzo-editor endpoint="/admin/site/1" locale="en" style="display: block; height: 100vh"></lienzo-editor>
+```
+
+## Use the standalone file with no build step
+
+`@skylivellc/lienzo-editor/standalone` is one ES module with Vue and the editor's CSS inside. The file is `dist/standalone/lienzo-editor.js` in the package. Serve it as a static file and load it with a script tag:
+
+```html
+<script type="module" src="/assets/lienzo-editor.js"></script>
+<lienzo-editor endpoint="/api/lienzo" style="display: block; height: 100vh"></lienzo-editor>
+```
+
+## Options
+
+| Option | Type | Description |
+| --- | --- | --- |
+| `endpoint` | `string` | Base URL of the protocol routes. Required. |
+| `locale` | `string` | Language of the editor. English (`en`) and Spanish (`es`) ship. Defaults to `en`. |
+| `messages` | `Record<locale, Partial<Messages>>` | Strings to add or override, by locale. Missing keys fall back to English. |
+| `headers` | `Record<string, string>` | Extra request headers, such as a bearer token. |
+| `fetch` | `typeof fetch` | A fetch implementation to use instead of the global one. |
+
+On the custom element, `endpoint` and `locale` are attributes. `messages`, `headers` and `fetch` are properties: set them before you attach the element, because the editor reads them once.
+
+Requests send cookies for the same origin. If the page has Laravel's `XSRF-TOKEN` cookie, the editor sends it back as the `X-XSRF-TOKEN` header, so session-authenticated Laravel backends need no extra setup.
+
+## License
+
+MIT. The standalone file includes Vue, Zod and Lucide icons. See [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).

package/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,101 @@
+Lienzo bundles third-party material under the licenses below.
+
+## Lucide icons
+
+The icon catalog (packages/core/src/icons.json) is derived from Lucide (https://lucide.dev). The editor's standalone bundle also includes @lucide/vue, under the same ISC license.
+
+ISC License
+
+Copyright (c) 2026 Lucide Icons and Contributors
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+---
+
+The following Lucide icons are derived from the Feather project:
+
+airplay, alert-circle, alert-octagon, alert-triangle, aperture, arrow-down-circle, arrow-down-left, arrow-down-right, arrow-down, arrow-left-circle, arrow-left, arrow-right-circle, arrow-right, arrow-up-circle, arrow-up-left, arrow-up-right, arrow-up, at-sign, calendar, cast, check, chevron-down, chevron-left, chevron-right, chevron-up, chevrons-down, chevrons-left, chevrons-right, chevrons-up, circle, clipboard, clock, code, columns, command, compass, corner-down-left, corner-down-right, corner-left-down, corner-left-up, corner-right-down, corner-right-up, corner-up-left, corner-up-right, crosshair, database, divide-circle, divide-square, dollar-sign, download, external-link, feather, frown, hash, headphones, help-circle, info, italic, key, layout, life-buoy, link-2, link, loader, lock, log-in, log-out, maximize, meh, minimize, minimize-2, minus-circle, minus-square, minus, monitor, moon, more-horizontal, more-vertical, move, music, navigation-2, navigation, octagon, pause-circle, percent, plus-circle, plus-square, plus, power, radio, rss, search, server, share, shopping-bag, sidebar, smartphone, smile, square, table-2, tablet, target, terminal, trash-2, trash, triangle, tv, type, upload, x-circle, x-octagon, x-square, x, zoom-in, zoom-out
+
+The MIT License (MIT) (for the icons listed above)
+
+Copyright (c) 2013-present Cole Bemis
+
+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.
+
+## Vue
+
+The editor's standalone bundle (packages/editor/dist/standalone, shipped as packages/laravel/dist/editor) includes Vue (https://vuejs.org): @vue/shared, @vue/reactivity, @vue/runtime-core and @vue/runtime-dom.
+
+The MIT License (MIT)
+
+Copyright (c) 2018-present, Yuxi (Evan) You
+
+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.
+
+## Zod
+
+@skylivellc/lienzo-core depends on Zod (https://zod.dev), and the editor's standalone bundle includes it.
+
+MIT License
+
+Copyright (c) 2025 Colin McDonnell
+
+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.