@aurum-grid/vue 0.0.0-stage → 0.5.2

package/LICENSE.md

@@ -0,0 +1,24 @@
+# Aurum Grid Commercial License (draft template)
+
+> This is a starting-point template, not legal advice. Have a lawyer review it before you sell licences.
+
+Copyright (c) 2026 the Aurum Grid authors. All rights reserved.
+
+## 1. Evaluation
+You may install and use Aurum Grid ("the Software") free of charge for **30 days** to evaluate it. During and after
+evaluation the Software runs unmodified; after 30 days without a valid licence key it displays an
+"unlicensed" watermark and console notice.
+
+## 2. Annual developer licence
+A licence costs **USD 50 per developer per year**. Each licensed developer may use the Software to build an
+unlimited number of applications and deploy them to an unlimited number of end users. The licence key must be
+renewed every year to keep receiving updates and to keep the watermark removed in newly built versions.
+
+## 3. Restrictions
+You may not: (a) redistribute the Software as a standalone component library or competing product;
+(b) remove, alter or circumvent the licence checks or watermark; (c) share licence keys between developers
+beyond the purchased seat count.
+
+## 4. No warranty
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
+ANY CLAIM, DAMAGES OR OTHER LIABILITY ARISING FROM THE USE OF THE SOFTWARE.

package/README.md

@@ -1,3 +1,7 @@
-# Temporary Holding Version
+# @aurum-grid/vue
 
-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.
+Aurum Grid Vue 3 adapter.
+
+Part of **Aurum Grid** — the enterprise data grid. See the main documentation: https://github.com/YOUR_ORG/aurum-grid#readme
+
+Licensing: 30-day evaluation, then $50 per developer per year. See LICENSE.md.

package/dist/index.d.ts

@@ -0,0 +1,42 @@
+import { type Component, type PropType } from 'vue';
+import { type CellRendererParams, type FrameworkRendererResult, type GridOptions, type ICellEditor, type ICellEditorParams } from '@aurum-grid/core';
+/**
+ * <AurumGrid :options="gridOptions" @grid-ready="onReady" />
+ * Options are watched shallowly; replacing `rowData`, `columnDefs`, `theme`, etc. updates the grid.
+ */
+export declare const AurumGrid: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    options: {
+        type: PropType<GridOptions<any>>;
+        required: true;
+    };
+    height: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: string;
+    };
+}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "grid-ready"[], "grid-ready", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    options: {
+        type: PropType<GridOptions<any>>;
+        required: true;
+    };
+    height: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: string;
+    };
+}>> & Readonly<{
+    "onGrid-ready"?: ((...args: any[]) => any) | undefined;
+}>, {
+    height: string | number;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+/** Use a Vue component as a cell renderer: `cellRenderer: vueCellRenderer(StatusBadge)`. */
+export declare function vueCellRenderer(comp: Component): (params: CellRendererParams) => FrameworkRendererResult;
+/**
+ * Use a Vue component as a cell editor: `cellEditor: vueCellEditor(AddressForm, { popup: true })`.
+ * The component receives `params` and `value`, and emits `update:value` with the new value
+ * (so `v-model:value` works inside your own wrappers) — or calls `params.stopEditing()`.
+ */
+export declare function vueCellEditor(comp: Component, opts?: {
+    popup?: boolean;
+    popupPosition?: 'over' | 'under';
+}): (params: ICellEditorParams) => ICellEditor;

package/dist/index.js

@@ -0,0 +1,79 @@
+import { defineComponent, h, onBeforeUnmount, onMounted, ref, shallowRef, watch, render } from 'vue';
+import { createGrid } from '@aurum-grid/core';
+/**
+ * <AurumGrid :options="gridOptions" @grid-ready="onReady" />
+ * Options are watched shallowly; replacing `rowData`, `columnDefs`, `theme`, etc. updates the grid.
+ */
+export const AurumGrid = defineComponent({
+    name: 'AurumGrid',
+    props: {
+        options: { type: Object, required: true },
+        height: { type: [String, Number], default: '100%' },
+    },
+    emits: ['grid-ready'],
+    setup(props, { emit, expose }) {
+        const host = ref(null);
+        const api = shallowRef(null);
+        let prev = {};
+        onMounted(() => {
+            api.value = createGrid(host.value, { ...props.options });
+            prev = { ...props.options };
+            emit('grid-ready', api.value);
+        });
+        watch(() => ({ ...props.options }), (next) => {
+            if (!api.value)
+                return;
+            const patch = {};
+            for (const [k, v] of Object.entries(next))
+                if (prev[k] !== v)
+                    patch[k] = v;
+            prev = { ...next };
+            if (Object.keys(patch).length)
+                api.value.updateGridOptions(patch);
+        });
+        onBeforeUnmount(() => {
+            api.value?.destroy();
+            api.value = null;
+        });
+        expose({ api });
+        return () => h('div', { ref: host, style: { height: typeof props.height === 'number' ? `${props.height}px` : props.height, width: '100%' } });
+    },
+});
+/** Use a Vue component as a cell renderer: `cellRenderer: vueCellRenderer(StatusBadge)`. */
+export function vueCellRenderer(comp) {
+    return (params) => {
+        const el = document.createElement('span');
+        render(h(comp, { params }), el);
+        return {
+            element: el,
+            update: (p) => render(h(comp, { params: p }), el),
+            destroy: () => render(null, el),
+        };
+    };
+}
+/**
+ * Use a Vue component as a cell editor: `cellEditor: vueCellEditor(AddressForm, { popup: true })`.
+ * The component receives `params` and `value`, and emits `update:value` with the new value
+ * (so `v-model:value` works inside your own wrappers) — or calls `params.stopEditing()`.
+ */
+export function vueCellEditor(comp, opts = {}) {
+    return (params) => {
+        const el = document.createElement('div');
+        el.className = 'agr-vue-editor';
+        let value = params.value;
+        const draw = () => render(h(comp, {
+            params, value,
+            'onUpdate:value': (v) => { value = v; params.onValueChange(v); draw(); },
+        }), el);
+        draw();
+        return {
+            getGui: () => el,
+            getValue: () => value,
+            isPopup: () => !!opts.popup,
+            getPopupPosition: () => opts.popupPosition ?? 'under',
+            afterGuiAttached: () => el.querySelector('[autofocus], input, select, textarea, button')?.focus(),
+            destroy: () => render(null, el),
+        };
+    };
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,CAAC,EAAE,eAAe,EAAE,SAAS,EAAE,GAAG,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,EAAiC,MAAM,KAAK,CAAC;AACpI,OAAO,EAAE,UAAU,EAAgI,MAAM,kBAAkB,CAAC;AAE5K;;;GAGG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,eAAe,CAAC;IACvC,IAAI,EAAE,WAAW;IACjB,KAAK,EAAE;QACL,OAAO,EAAE,EAAE,IAAI,EAAE,MAAoC,EAAE,QAAQ,EAAE,IAAI,EAAE;QACvE,MAAM,EAAE,EAAE,IAAI,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE;KACpD;IACD,KAAK,EAAE,CAAC,YAAY,CAAC;IACrB,KAAK,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE;QAC3B,MAAM,IAAI,GAAG,GAAG,CAAwB,IAAI,CAAC,CAAC;QAC9C,MAAM,GAAG,GAAG,UAAU,CAAmB,IAAI,CAAC,CAAC;QAC/C,IAAI,IAAI,GAA4B,EAAE,CAAC;QACvC,SAAS,CAAC,GAAG,EAAE;YACb,GAAG,CAAC,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,KAAM,EAAE,EAAE,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;YAC1D,IAAI,GAAG,EAAE,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC;YAC5B,IAAI,CAAC,YAAY,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC,CAAC,CAAC;QACH,KAAK,CACH,GAAG,EAAE,CAAC,CAAC,EAAE,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC,EAC5B,CAAC,IAAI,EAAE,EAAE;YACP,IAAI,CAAC,GAAG,CAAC,KAAK;gBAAE,OAAO;YACvB,MAAM,KAAK,GAA4B,EAAE,CAAC;YAC1C,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC;gBAAE,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;oBAAE,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;YAC3E,IAAI,GAAG,EAAE,GAAG,IAAI,EAAE,CAAC;YACnB,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM;gBAAE,GAAG,CAAC,KAAK,CAAC,iBAAiB,CAAC,KAAyB,CAAC,CAAC;QACxF,CAAC,CACF,CAAC;QACF,eAAe,CAAC,GAAG,EAAE;YACnB,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,CAAC;YACrB,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC;QACnB,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC;QAChB,OAAO,GAAG,EAAE,CAAC,CAAC,CAAC,KAAK,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,MAAM,EAAE,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;IAChJ,CAAC;CACF,CAAC,CAAC;AAEH,4FAA4F;AAC5F,MAAM,UAAU,eAAe,CAAC,IAAe;IAC7C,OAAO,CAAC,MAA0B,EAA2B,EAAE;QAC7D,MAAM,EAAE,GAAG,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAC1C,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;QAChC,OAAO;YACL,OAAO,EAAE,EAAE;YACX,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YACjD,OAAO,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC;SAChC,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,IAAe,EAAE,OAA8D,EAAE;IAC7G,OAAO,CAAC,MAAyB,EAAe,EAAE;QAChD,MAAM,EAAE,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QACzC,EAAE,CAAC,SAAS,GAAG,gBAAgB,CAAC;QAChC,IAAI,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;QACzB,MAAM,IAAI,GAAG,GAAG,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE;YAChC,MAAM,EAAE,KAAK;YACb,gBAAgB,EAAE,CAAC,CAAU,EAAE,EAAE,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;SAClF,CAAC,EAAE,EAAE,CAAC,CAAC;QACR,IAAI,EAAE,CAAC;QACP,OAAO;YACL,MAAM,EAAE,GAAG,EAAE,CAAC,EAAE;YAChB,QAAQ,EAAE,GAAG,EAAE,CAAC,KAAK;YACrB,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK;YAC3B,gBAAgB,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,aAAa,IAAI,OAAO;YACrD,gBAAgB,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,aAAa,CAAc,8CAA8C,CAAC,EAAE,KAAK,EAAE;YAC9G,OAAO,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC;SAChC,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,36 @@
 {
   "name": "@aurum-grid/vue",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.5.2",
+  "description": "Aurum Grid Vue 3 adapter.",
+  "license": "SEE LICENSE IN LICENSE.md",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "LICENSE.md",
+    "README.md"
+  ],
+  "dependencies": {
+    "@aurum-grid/core": "0.5.2"
+  },
+  "peerDependencies": {
+    "vue": ">=3.3"
+  },
+  "devDependencies": {
+    "vue": "^3.5.12"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  }
 }