@progress/kendo-vue-data-tools 8.3.0-develop.1 → 8.3.0-develop.3

package/clipboard/clipboard.service.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { ClipboardActionType } from './common';
+/**
+ * @hidden
+ */
+export declare class ClipboardService {
+    private clipboardEvent;
+    constructor(clipboardEventHandler: (clipboardType: ClipboardActionType, event: ClipboardEvent) => void);
+    private copyHandler;
+    private cutHandler;
+    private pasteHandler;
+    addEventListeners: (document: Document | undefined) => void;
+    removeEventListeners: (document: Document | undefined) => void;
+}

package/clipboard/clipboard.service.js

@@ -0,0 +1,8 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const t=require("./common.js");class r{constructor(i){this.copyHandler=e=>{this.clipboardEvent(t.ClipboardActionType.copy,e)},this.cutHandler=e=>{this.clipboardEvent(t.ClipboardActionType.cut,e)},this.pasteHandler=e=>{this.clipboardEvent(t.ClipboardActionType.paste,e)},this.addEventListeners=e=>{e&&(e.addEventListener(t.ClipboardActionType.copy,this.copyHandler),e.addEventListener(t.ClipboardActionType.cut,this.cutHandler),e.addEventListener(t.ClipboardActionType.paste,this.pasteHandler))},this.removeEventListeners=e=>{e&&(e.removeEventListener(t.ClipboardActionType.copy,this.copyHandler),e.removeEventListener(t.ClipboardActionType.cut,this.cutHandler),e.removeEventListener(t.ClipboardActionType.paste,this.pasteHandler))},this.clipboardEvent=i}}exports.ClipboardService=r;

package/clipboard/clipboard.service.mjs

@@ -0,0 +1,26 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { ClipboardActionType as t } from "./common.mjs";
+class n {
+  constructor(r) {
+    this.copyHandler = (e) => {
+      this.clipboardEvent(t.copy, e);
+    }, this.cutHandler = (e) => {
+      this.clipboardEvent(t.cut, e);
+    }, this.pasteHandler = (e) => {
+      this.clipboardEvent(t.paste, e);
+    }, this.addEventListeners = (e) => {
+      e && (e.addEventListener(t.copy, this.copyHandler), e.addEventListener(t.cut, this.cutHandler), e.addEventListener(t.paste, this.pasteHandler));
+    }, this.removeEventListeners = (e) => {
+      e && (e.removeEventListener(t.copy, this.copyHandler), e.removeEventListener(t.cut, this.cutHandler), e.removeEventListener(t.paste, this.pasteHandler));
+    }, this.clipboardEvent = r;
+  }
+}
+export {
+  n as ClipboardService
+};

package/clipboard/common.d.ts

@@ -0,0 +1,188 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { ColumnBaseProps } from '../interfaces/ColumnProps';
+import { SelectDescriptor } from '../selection/TableSelection';
+/**
+ * The possible values of the  `type` property.
+ */
+export declare enum ClipboardActionType {
+    copy = "copy",
+    cut = "cut",
+    paste = "paste"
+}
+/**
+ * Represents the object of the `ClipboardDataEvent` event.
+ */
+export interface ClipboardDataEvent {
+    /**
+     * Represents the type of the clipboard action.
+     */
+    type: ClipboardActionType;
+    /**
+     * Represents the native [ClipboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/ClipboardEvent)
+     */
+    nativeEvent?: ClipboardEvent;
+    /**
+     * All the Grid columns.
+     */
+    columns: ColumnBaseProps[];
+    /**
+     * Passes the dataItemKey prop in the clipboard action.
+     */
+    dataItemKey: string;
+    /**
+     * Passes the clipboard prop copyHeaders value in the clipboard action.
+     */
+    copyHeaders?: boolean;
+    /**
+     * Sets the cell delimiter used when manipulating the clipboard data Defaults to `\t`.
+     */
+    cellDelimiter?: string;
+    /**
+     * Sets the row delimiter used when manipulating the clipboard data Defaults to `\r\n`.
+     */
+    newLineDelimiter?: string;
+    /**
+     * This is the item that is clicked if the action is raised from the contextMenu.
+     */
+    dataItem?: any;
+    /**
+     *  This is the column field that is clicked if the action is raised from the contextMenu.
+     */
+    field?: string;
+}
+/**
+ * Represents the object of the `GridClipboardEvent` event.
+ */
+export interface GridClipboardEvent extends ClipboardDataEvent, ClipboardData {
+}
+/**
+ * Represents the `PopulateClipboardArgs` event argument.
+ */
+export interface PopulateClipboardArgs {
+    /**
+     * Represents the base object of the `ClipboardDataEvent` event.
+     */
+    event: ClipboardDataEvent;
+    /**
+     * Represents the current selected state of the data.
+     */
+    selectedState: SelectDescriptor;
+    /**
+     * Passes the data currently displayed.
+     */
+    data: any[];
+    /**
+     * Passes dataItemKey name of the field that could be used to make difference between dataItems.
+     */
+    dataItemKey?: string;
+    /**
+     * Passes subItemsField that will be used in grouping cases.
+     */
+    subItemsField?: string;
+    /**
+     * Previous copied items.
+     */
+    previousCopiedItems?: ClipboardItem[];
+}
+/**
+ * Represents the object that is returned form the `populateClipboardData` function.
+ */
+export interface ClipboardData {
+    /**
+     * A collection of the ClipboardItem that are selected.
+     */
+    copiedItems: ClipboardItem[];
+    /**
+     * A collection of the ClipboardItem that are pasted.
+     */
+    pastedItems: ClipboardItem[];
+    /**
+     * When the action is `copy` or `cut` - the Grid data, copied to the clipboard, in Excel-compatible format.
+     * When the action is `paste` - the current clipboard data, available in the original DOM event.
+     */
+    clipboardData: string;
+}
+/**
+ * Represents the aria that is copied - the dataItem and the fields.
+ */
+export interface ClipboardItem {
+    /**
+     * Represents the dataItem used in the clipboard action.
+     */
+    dataItem: any;
+    /**
+     * Represents the fields used in the clipboard action.
+     */
+    fields: string[];
+}
+/**
+ * Represents settings that can be added to the clipboard behavior.
+ */
+export interface ClipboardSettings {
+    /**
+     * Determines whether column titles or field names will be included in the generated data
+     * during the `copy` and `cut` actions.
+     * Defaults to `false`.
+     */
+    copyHeaders?: boolean;
+    /**
+     * Determines what is the delimiter used to separate the cells.
+     * Defaults to `\t`.
+     */
+    cellDelimiter?: string;
+    /**
+     * Determines what is the delimiter used to separate the rows.
+     * Defaults to `'\r\n'`.
+     */
+    newLineDelimiter?: string;
+}
+/**
+ * @hidden
+ */
+export declare const getItemsToUpdateOnPaste: (args: PopulateClipboardArgs, selectedItems: ClipboardItem[], dataLength: number, dataItemKey: string) => any[];
+/**
+ * @hidden
+ */
+export declare const getPreviouslyCopiedItemsData: (previousCopiedItems?: ClipboardItem[]) => any[][];
+/**
+ * @hidden
+ */
+export declare const getClipboardItemsToPaste: (args: PopulateClipboardArgs, clipboardText: string) => string[][];
+/**
+ * @hidden
+ */
+export declare const getItemsToPaste: (args: PopulateClipboardArgs, clipboardText: string) => any[][];
+/**
+ * @hidden
+ */
+export declare const getPastedItems: (args: PopulateClipboardArgs, clipboardText: string) => ClipboardItem[];
+/**
+ * @hidden
+ */
+export declare const itemToString: (item: any, cols: string[], cellDelimiter?: string) => string | null;
+/**
+ * @hidden
+ */
+export declare const addHeaders: (initialData: string, cols: string[], event: ClipboardDataEvent) => string;
+/**
+ * @hidden
+ */
+export declare const getSelectedItems: (args: PopulateClipboardArgs) => ClipboardItem[];
+/**
+ * @hidden
+ */
+export declare const getClipboardText: (copiedItems: ClipboardItem[], event: ClipboardDataEvent) => string;
+/**
+ * @hidden
+ */
+export declare const getClipboardData: (event: ClipboardDataEvent, copiedItems: ClipboardItem[]) => string;
+/**
+ * A function used to populate the Clipboard data.
+ */
+export declare const populateClipboardData: (args: PopulateClipboardArgs) => ClipboardData;

package/clipboard/common.js

@@ -0,0 +1,13 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const D=require("@progress/kendo-vue-common");var b=(t=>(t.copy="copy",t.cut="cut",t.paste="paste",t))(b||{});const x=(t,n,e,a)=>{const s=D.getter(a);if(!n.length)return[];const l=t.data.findIndex(d=>s(d)===s(n[0].dataItem))||0,o=n.length<2?e:n.length;return t.data.filter((d,i)=>i>=l&&i<l+o)||[]},C=t=>(t==null?void 0:t.map(e=>e.fields.map(a=>e.dataItem[a].toString())))||[],w=(t,n)=>{var d,i;const{event:e}=t,a=n.includes(`
+`)?`
+`:null,s=(d=e.cellDelimiter)!=null?d:"	",l=(i=e.newLineDelimiter)!=null?i:`\r
+`,o=n.includes(l)?l:a;return(o?n.split(o):[n]).map(r=>r.includes(s)?r.split(s):[r])},S=(t,n)=>{var e;return((e=t.event.nativeEvent)==null?void 0:e.type)==="paste"?w(t,n):C(t.previousCopiedItems)},E=(t,n)=>{var I,u,y;const{event:e}=t,a=e.dataItem,s=(u=(I=t.dataItemKey)!=null?I:e.dataItemKey)!=null?u:"",l=D.getter(s),o=a&&!a.selected&&e.field?[{dataItem:e.dataItem,fields:[e.field]}]:h(t),c=o.length?o[0].fields[0]:(y=e.columns[0].field)!=null?y:"",d=e.columns.map(f=>{var g;return(g=f.field)!=null?g:""}),i=d.indexOf(c),r=S(t,n),p=x(t,o,r.length,s);return r.slice(0,p.length).map((f,g)=>{const F=i+f.length,P=d.slice(i,F),T={[s]:l(p[g])};return P.forEach(($,j)=>T[$]=f[j]),{dataItem:T,fields:P}})},L=(t,n,e="	")=>{if(!n.length)return null;let a="";return n.forEach((s,l,o)=>a+=`${t[s]}${l<o.length-1?e:""}`),a},v=(t,n,e)=>{var o,c;const a=(o=e.cellDelimiter)!=null?o:"	",s=(c=e.newLineDelimiter)!=null?c:`\r
+`;return`${n.join(a)}${s}${t}`},h=t=>{var d,i;const{event:n,selectedState:e,data:a}=t,s=(i=(d=t.dataItemKey)!=null?d:n.dataItemKey)!=null?i:"",l=D.getter(s),o={},c=[];return Object.entries(e).forEach(([r,p])=>{o[r]=Array.isArray(p)?p.map(m=>n.columns[m]).filter(m=>!m.declarationIndex||m.declarationIndex>=0):n.columns.filter(m=>!m.declarationIndex||m.declarationIndex>=0)}),a==null||a.forEach(r=>{var m;const p=(m=l(r))!=null?m:"";o[p]&&c.push({dataItem:r,fields:o[p].map(I=>{var u;return(u=I.field)!=null?u:""})})}),c},K=(t,n)=>{var l,o;const e=(l=n.newLineDelimiter)!=null?l:`\r
+`,a=(o=n.cellDelimiter)!=null?o:"	";return t.map((c,d)=>{var r;let i=(r=L(c.dataItem,c.fields,a))!=null?r:"";return n.copyHeaders&&d===0&&(i=v(i,c.fields,n)),i?[i]:[]}).join(e)},O=(t,n)=>{var a;let e="";if(t.type==="paste"){const s=t.nativeEvent?t.nativeEvent.clipboardData:"";e=s?s.getData("text").trim():""}else e=K(n,t),(a=navigator.clipboard)==null||a.writeText(e);return e},R=t=>{const{event:n}=t,e=h(t)||[],a=O(n,e)||"",s=n.type==="paste"?E(t,a)||[]:[];return{copiedItems:e,pastedItems:s,clipboardData:a}};exports.ClipboardActionType=b;exports.addHeaders=v;exports.getClipboardData=O;exports.getClipboardItemsToPaste=w;exports.getClipboardText=K;exports.getItemsToPaste=S;exports.getItemsToUpdateOnPaste=x;exports.getPastedItems=E;exports.getPreviouslyCopiedItemsData=C;exports.getSelectedItems=h;exports.itemToString=L;exports.populateClipboardData=R;

package/clipboard/common.mjs

@@ -0,0 +1,104 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { getter as h } from "@progress/kendo-vue-common";
+var E = /* @__PURE__ */ ((t) => (t.copy = "copy", t.cut = "cut", t.paste = "paste", t))(E || {});
+const L = (t, n, e, a) => {
+  const s = h(a);
+  if (!n.length)
+    return [];
+  const l = t.data.findIndex((d) => s(d) === s(n[0].dataItem)) || 0, i = n.length < 2 ? e : n.length;
+  return t.data.filter((d, o) => o >= l && o < l + i) || [];
+}, C = (t) => (t == null ? void 0 : t.map((e) => e.fields.map((a) => e.dataItem[a].toString()))) || [], K = (t, n) => {
+  var d, o;
+  const { event: e } = t, a = n.includes(`
+`) ? `
+` : null, s = (d = e.cellDelimiter) != null ? d : "	", l = (o = e.newLineDelimiter) != null ? o : `\r
+`, i = n.includes(l) ? l : a;
+  return (i ? n.split(i) : [n]).map((c) => c.includes(s) ? c.split(s) : [c]);
+}, F = (t, n) => {
+  var e;
+  return ((e = t.event.nativeEvent) == null ? void 0 : e.type) === "paste" ? K(t, n) : C(t.previousCopiedItems);
+}, S = (t, n) => {
+  var f, u, g;
+  const { event: e } = t, a = e.dataItem, s = (u = (f = t.dataItemKey) != null ? f : e.dataItemKey) != null ? u : "", l = h(s), i = a && !a.selected && e.field ? [{ dataItem: e.dataItem, fields: [e.field] }] : w(t), r = i.length ? i[0].fields[0] : (g = e.columns[0].field) != null ? g : "", d = e.columns.map((I) => {
+    var D;
+    return (D = I.field) != null ? D : "";
+  }), o = d.indexOf(r), c = F(t, n), p = L(t, i, c.length, s);
+  return c.slice(0, p.length).map((I, D) => {
+    const P = o + I.length, x = d.slice(o, P), y = { [s]: l(p[D]) };
+    return x.forEach((T, b) => y[T] = I[b]), {
+      dataItem: y,
+      fields: x
+    };
+  });
+}, $ = (t, n, e = "	") => {
+  if (!n.length)
+    return null;
+  let a = "";
+  return n.forEach((s, l, i) => a += `${t[s]}${l < i.length - 1 ? e : ""}`), a;
+}, v = (t, n, e) => {
+  var i, r;
+  const a = (i = e.cellDelimiter) != null ? i : "	", s = (r = e.newLineDelimiter) != null ? r : `\r
+`;
+  return `${n.join(a)}${s}${t}`;
+}, w = (t) => {
+  var d, o;
+  const { event: n, selectedState: e, data: a } = t, s = (o = (d = t.dataItemKey) != null ? d : n.dataItemKey) != null ? o : "", l = h(s), i = {}, r = [];
+  return Object.entries(e).forEach(([c, p]) => {
+    i[c] = Array.isArray(p) ? p.map((m) => n.columns[m]).filter((m) => !m.declarationIndex || m.declarationIndex >= 0) : n.columns.filter((m) => !m.declarationIndex || m.declarationIndex >= 0);
+  }), a == null || a.forEach((c) => {
+    var m;
+    const p = (m = l(c)) != null ? m : "";
+    i[p] && r.push({
+      dataItem: c,
+      fields: i[p].map((f) => {
+        var u;
+        return (u = f.field) != null ? u : "";
+      })
+    });
+  }), r;
+}, O = (t, n) => {
+  var l, i;
+  const e = (l = n.newLineDelimiter) != null ? l : `\r
+`, a = (i = n.cellDelimiter) != null ? i : "	";
+  return t.map((r, d) => {
+    var c;
+    let o = (c = $(r.dataItem, r.fields, a)) != null ? c : "";
+    return n.copyHeaders && d === 0 && (o = v(o, r.fields, n)), o ? [o] : [];
+  }).join(e);
+}, R = (t, n) => {
+  var a;
+  let e = "";
+  if (t.type === "paste") {
+    const s = t.nativeEvent ? t.nativeEvent.clipboardData : "";
+    e = s ? s.getData("text").trim() : "";
+  } else
+    e = O(n, t), (a = navigator.clipboard) == null || a.writeText(e);
+  return e;
+}, G = (t) => {
+  const { event: n } = t, e = w(t) || [], a = R(n, e) || "", s = n.type === "paste" ? S(t, a) || [] : [];
+  return {
+    copiedItems: e,
+    pastedItems: s,
+    clipboardData: a
+  };
+};
+export {
+  E as ClipboardActionType,
+  v as addHeaders,
+  R as getClipboardData,
+  K as getClipboardItemsToPaste,
+  O as getClipboardText,
+  F as getItemsToPaste,
+  L as getItemsToUpdateOnPaste,
+  S as getPastedItems,
+  C as getPreviouslyCopiedItemsData,
+  w as getSelectedItems,
+  $ as itemToString,
+  G as populateClipboardData
+};