@vuu-ui/grid-layout 4.0.0-alpha.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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 2015 UBS
+
+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.

package/README.md

@@ -0,0 +1,141 @@
+# GridLayout
+
+`GridLayout` renders canonical immutable `GridSnapshot` state through a
+per-grid `GridController`. Applications should use `GridLayoutProvider` and the
+schema-v2 `GridLayoutDocument` persistence API. The mutable model, v1
+descriptors, and React-element serialization are compatibility implementation
+details, not persistence authority.
+
+## Versioned persistence
+
+Register a typed settings codec and a separate renderer for every persisted
+component type:
+
+```tsx
+const settingsCodecs = new GridComponentSettingsRegistry();
+settingsCodecs.register("price-tile", {
+  version: 1,
+  isSettings: isPriceTileSettings,
+  encode: (settings) => ({ ok: true, value: settings }),
+  decode: (value) =>
+    isPriceTileSettings(value)
+      ? { ok: true, value }
+      : {
+          ok: false,
+          error: {
+            code: "INVALID_PRICE_TILE",
+            message: "instrument must be a string",
+            path: "$.instrument",
+          },
+        },
+});
+
+const componentRenderers = new GridComponentRendererRegistry();
+componentRenderers.register(
+  "price-tile",
+  isPriceTileSettings,
+  (settings, componentId) => (
+    <PriceTile id={componentId} instrument={settings.instrument} />
+  ),
+);
+
+<GridLayoutProvider
+  componentRenderers={componentRenderers}
+  componentSettings={[
+    {
+      id: "price-tile-17",
+      type: "price-tile",
+      settings: { instrument: "VOD.L" },
+    },
+  ]}
+  document={savedDocument}
+  settingsCodecs={settingsCodecs}
+  onDocumentChange={saveDocument}
+  onDocumentError={reportDocumentError}
+>
+  <GridLayout id="workspace-grid" />
+</GridLayoutProvider>;
+```
+
+The plain-JSON envelope has `kind: "grid-layout"` and `version: 2`. It stores
+durable layout IDs, item and component-instance IDs, track strings, item
+metadata (including wire spelling `resizeable`), placeholders, ordered stacks
+and selected tabs, plus versioned typed component settings. Revisions,
+measurements, drag previews, DOM state, React elements, callbacks, controller
+instances, and listeners are transient and are never written.
+
+The provider subscribes to committed controller transitions. Initial hydration,
+previews, rollbacks, rejected/no-op commands, and measured-pixel updates write
+zero documents; an ordinary semantic commit writes once. Decode, migrations,
+and all renderer resolution complete before a runtime document replaces the
+active layout. Unknown component types, unsupported versions, malformed
+references, failed migrations, and renderer failures report path-aware
+`GridLayoutDocumentError` values through `onDocumentError` and leave the active
+layout unchanged.
+
+`onDocumentChange(document, change)` receives the immutable document plus its
+commit revision, transition kind, and removed component-instance IDs.
+`GridLayoutDocumentController` exposes the same current document through
+`getSnapshot()` and `subscribe()` for external-store consumers.
+
+New palette entries use a typed `ComponentTemplate`:
+
+```ts
+const template = {
+  component: {
+    settings: { instrument: "VOD.L" },
+    type: "price-tile",
+    version: 1,
+  },
+  label: "Price tile",
+} satisfies ComponentTemplate;
+```
+
+Nested providers inherit the nearest template-drag session, while retaining
+their own document callback and settings scope. Use
+`remapGridLayoutDocumentIds` with an application allocator when cloning a saved
+definition; it remaps grid, item, component, stack, placeholder, and nested
+document references recursively.
+
+Nested grids must cross the same settings boundary: encode the nested
+`GridLayoutDocument` as opaque settings for a registered component type, and
+render it with its own `GridLayoutProvider`, grid ID, and controller. An outer
+`vuu-layout` or shell document likewise stores the GridLayout document as
+opaque component settings; its schema must not be merged with the GridLayout
+schema.
+
+## Supported ownership surface
+
+- `GridLayout`, `GridLayoutItem`, `GridLayoutProvider`
+- immutable `GridSnapshot` contracts and validation
+- `GridController` and typed commands
+- `encodeGridLayoutDocument` / `decodeGridLayoutDocument`
+- settings codec, renderer, and content registries
+- deliberate drag, palette-template, and stack hooks
+
+Prefer `useGridSnapshot`, `useGridController`, and typed dispatch over direct
+model access.
+
+## Legacy compatibility and migration
+
+`serializedLayout`, `SerializedGridLayout`, `GridLayoutDescriptor`,
+`layoutFromJson`, and mutable `useGridModel` are deprecated. Existing imports
+remain temporarily available, while explicitly named adapters are grouped
+under `GridLayoutLegacyCompatibility`. The old provider input is read-only: it
+may hydrate a descriptor-v1 fixture, but subsequent persistence callbacks emit
+schema-v2 documents only and never update or serialize React props back into
+the legacy value.
+
+`componentToJson` and `layoutToJSON` remain internal legacy UI-template tools;
+they must not be used for new GridLayout writes. To migrate a consumer:
+
+1. Give layout items and component instances stable, independently meaningful
+   IDs.
+2. Define typed JSON settings and a versioned codec for each component type.
+3. Register renderers separately from codecs.
+4. Decode old descriptors only at the compatibility boundary.
+5. Save the next committed state as a v2 document and retain old formats only
+   for backward reads.
+
+Deprecated aliases will remain for a compatibility release and may be removed
+only after external consumers have migrated.

package/package.json

@@ -0,0 +1,40 @@
+{
+  "version": "4.0.0-alpha.1",
+  "description": "VUU Layout Components",
+  "main": "./src/index.js",
+  "type": "module",
+  "author": "heswell",
+  "license": "Apache-2.0",
+  "scripts": {
+    "build:dev": "node ../../scripts/run-build.mjs",
+    "build": "node ../../scripts/run-build-rslib.ts",
+    "type-defs": "node ../../scripts/build-type-defs.mjs"
+  },
+  "types": "types/index.d.ts",
+  "dependencies": {
+    "@vuu-ui/vuu-utils": "4.0.0-alpha.1",
+    "@salt-ds/core": "1.67.0",
+    "@salt-ds/lab": "1.0.0-alpha.99",
+    "@salt-ds/styles": "0.2.1",
+    "@salt-ds/window": "0.1.1"
+  },
+  "peerDependencies": {
+    "clsx": "^2.0.0",
+    "react": "^19.2.3",
+    "react-dom": "^19.2.3"
+  },
+  "sideEffects": false,
+  "files": [
+    "README.md",
+    "src",
+    "/types"
+  ],
+  "exports": {
+    ".": {
+      "import": "./src/index.js",
+      "types": "./types/index.d.ts"
+    }
+  },
+  "module": "./src/index.js",
+  "name": "@vuu-ui/grid-layout"
+}