lkt-vue-kernel 1.0.4 → 1.0.5

package/dist/index.d.ts

@@ -60,7 +60,7 @@ declare class Option extends LktItem implements OptionConfig {
     group: string;
     icon: string;
     modal: ValidModalName;
-    constructor(data?: LktObject);
+    constructor(data?: Partial<OptionConfig>);
 }
 
 type ValidFieldValue = string | number | boolean | LktObject | Option[];
@@ -246,11 +246,14 @@ interface AnchorConfig {
     confirmModalKey?: ValidModalKey;
     confirmData?: ModalConfig;
     imposter?: boolean;
+    external?: boolean;
 }
 
+type ValidDrag = boolean | ((item: LktObject) => boolean);
+
 interface DragConfig {
-    isDraggable?: boolean | Function;
-    isValid?: Function;
+    isDraggable?: ValidDrag;
+    isValid?: ValidDrag;
     canRender?: boolean | Function;
     dragKey?: string;
 }
@@ -290,8 +293,9 @@ declare class Anchor extends LktItem implements AnchorConfig {
     confirmModalKey: ValidModalKey;
     confirmData: LktObject;
     imposter: boolean;
-    constructor(data?: Partial<AnchorConfig>);
+    external: boolean;
     getHref(): string;
+    constructor(data?: Partial<AnchorConfig>);
 }
 
 interface ButtonConfig {
@@ -335,20 +339,37 @@ interface ButtonConfig {
     splitClass?: string;
     clickRef?: Element | VueElement;
     tabindex?: ValidTabIndex;
-    isAnchor?: boolean;
-    onClickTo?: string;
-    onClickToExternal?: boolean;
-    download?: boolean;
-    downloadFileName?: string;
-    newTab?: boolean;
-    showSwitch?: boolean;
-    hiddenSwitch?: boolean;
 }
 
-declare class LktStrictItem extends LktItem {
-    lktStrictItem: boolean;
+declare enum ColumnType {
+    None = "",
+    Field = "field",
+    Button = "button",
+    Anchor = "anchor",
+    Text = "text",
+    Number = "number",
+    Check = "check",
+    Switch = "switch",
+    Select = "select",
+    Email = "email",
+    Tel = "tel",
+    File = "file",
+    Link = "link",
+    Action = "action",
+    Integer = "int",
+    Float = "float"
 }
 
+type ValidColSpan = Function | boolean | number | undefined;
+
+declare class SafeString {
+    private readonly value;
+    constructor(input: ValidSafeStringValue);
+    getValue(...args: any[]): string;
+}
+
+type ValidSafeStringValue = string | ((...args: any[]) => string) | undefined | SafeString;
+
 declare class Field extends LktItem implements FieldConfig {
     modelValue: ValidFieldValue;
     type: FieldType;
@@ -425,45 +446,15 @@ declare class Field extends LktItem implements FieldConfig {
     modalKey: string | number | Function;
     modalData: LktObject;
     data: LktObject;
-    constructor(data?: FieldConfig);
-}
-
-declare enum ColumnType {
-    None = "",
-    Field = "field",
-    Button = "button",
-    Anchor = "anchor",
-    Text = "text",
-    Number = "number",
-    Check = "check",
-    Switch = "switch",
-    Select = "select",
-    Email = "email",
-    Tel = "tel",
-    File = "file",
-    Link = "link",
-    Action = "action",
-    Integer = "int",
-    Float = "float"
+    constructor(data?: Partial<FieldConfig>);
 }
 
-type ValidSafeStringValue = string | ((...args: any[]) => string) | undefined | SafeString;
-
-declare class SafeString {
-    private readonly value;
-    constructor(input: ValidSafeStringValue);
-    getValue(...args: any[]): string;
-}
-
-type ValidColSpan = Function | boolean | number | undefined;
-
 declare class Button extends LktItem implements ButtonConfig {
     lktAllowUndefinedProps: string[];
+    static lktDefaultValues: (keyof ButtonConfig)[];
     type: ButtonType;
     name: string;
     palette: string;
-    onClickTo: string;
-    onClickToExternal: boolean;
     class: string;
     containerClass: string;
     value: string;
@@ -472,7 +463,6 @@ declare class Button extends LktItem implements ButtonConfig {
     wrapContent: boolean;
     split: boolean;
     splitIcon: string;
-    isAnchor: boolean;
     resource: string;
     resourceData: LktObject;
     modal: ValidModalName;
@@ -486,9 +476,6 @@ declare class Button extends LktItem implements ButtonConfig {
     iconDot: boolean;
     iconEnd: string;
     img: string;
-    newTab: boolean;
-    download: boolean;
-    downloadFileName: string;
     tooltip: boolean;
     showTooltipOnHoverDelay: number;
     tooltipWindowMargin: number;
@@ -505,7 +492,7 @@ declare class Button extends LktItem implements ButtonConfig {
     hideTooltipOnLeave?: boolean;
     tooltipClass?: string;
     splitClass?: string;
-    constructor(data?: ButtonConfig);
+    constructor(data?: Partial<ButtonConfig>);
 }
 
 interface ColumnConfig {
@@ -529,9 +516,17 @@ interface ColumnConfig {
     action?: Function;
 }
 
+declare enum TableType {
+    Table = "table",
+    Item = "item",
+    Ul = "ul",
+    Ol = "ol"
+}
+
 declare class Column extends LktItem implements ColumnConfig {
     lktExcludedProps: string[];
     lktAllowUndefinedProps: string[];
+    static lktDefaultValues: (keyof ColumnConfig)[];
     type: ColumnType;
     key: string;
     label: string;
@@ -550,11 +545,103 @@ declare class Column extends LktItem implements ColumnConfig {
     button: Button | ButtonConfig | undefined;
     link: ValidSafeStringValue | SafeString | undefined;
     action?: Function;
-    constructor(data: ColumnConfig);
+    constructor(data?: Partial<ColumnConfig>);
     getHref(item: LktObject): string;
     doAction(item: LktObject): any;
 }
 
+declare enum TablePermission {
+    Create = "create",
+    Update = "update",// Save changes
+    Edit = "edit",// Displays edit button
+    Drop = "drop",// Displays drop button
+    Sort = "sort",// Sort
+    InlineEdit = "inline-edit",// Be able to edit columns inside the table
+    InlineCreate = "inline-create",// Be able to append a new editable row (needs InlineEdit in order to be editable)
+    ModalCreate = "modal-create",// Be able to append a new row after save a modal form
+    InlineCreateEver = "inline-create-ever"
+}
+
+type ValidTablePermission = TablePermission | string;
+
+interface HeaderConfig {
+    tag?: string;
+    class?: string;
+    text?: string;
+    icon?: string;
+}
+
+interface TableConfig {
+    modelValue: LktObject[];
+    type?: TableType;
+    columns: Column[];
+    resource?: string;
+    noResultsText?: string;
+    filters?: LktObject[];
+    hideEmptyColumns?: boolean;
+    itemDisplayChecker?: Function;
+    loading?: boolean;
+    page?: number;
+    perms?: ValidTablePermission[];
+    editMode?: boolean;
+    dataStateConfig?: LktObject;
+    sortable?: boolean;
+    sorter?: Function;
+    initialSorting?: boolean;
+    draggableChecker?: Function;
+    checkValidDrag?: Function;
+    renderDrag?: boolean | Function;
+    disabledDrag?: boolean | Function;
+    draggableItemKey?: string;
+    header?: HeaderConfig;
+    title?: string;
+    titleTag?: string;
+    titleIcon?: string;
+    headerClass?: string;
+    saveButton?: ButtonConfig;
+    createButton?: ButtonConfig;
+    dropButton?: ButtonConfig;
+    wrapContentTag?: string;
+    wrapContentClass?: string;
+    itemsContainerClass?: string;
+    hiddenSave?: boolean;
+    saveDisabled?: boolean;
+    saveValidator?: Function;
+    saveConfirm?: string;
+    confirmData?: LktObject;
+    saveResource?: string;
+    saveResourceData?: LktObject;
+    saveTooltipEngine?: string;
+    splitSave?: boolean;
+    saveText?: string;
+    createText?: string;
+    createIcon?: string;
+    createRoute?: string;
+    dropText?: string;
+    dropIcon?: string;
+    editText?: string;
+    editIcon?: string;
+    editLink?: string;
+    editModeText?: string;
+    switchEditionEnabled?: boolean;
+    createDisabled?: boolean;
+    dropConfirm?: string;
+    dropResource?: string;
+    addNavigation?: boolean;
+    createEnabledValidator?: Function;
+    newValueGenerator?: Function;
+    requiredItemsForTopCreate?: number;
+    requiredItemsForBottomCreate?: number;
+    slotItemVar?: string;
+    modal?: string;
+    modalData?: LktObject;
+    itemMode?: boolean;
+}
+
+declare class LktStrictItem extends LktItem {
+    lktStrictItem: boolean;
+}
+
 declare class Tooltip extends LktItem implements TooltipConfig {
     static lktDefaultValues: (keyof TooltipConfig)[];
     modelValue: boolean;
@@ -570,7 +657,7 @@ declare class Tooltip extends LktItem implements TooltipConfig {
     referrer: HTMLElement | undefined;
     locationY: TooltipLocationY;
     locationX: TooltipLocationX;
-    constructor(data?: FieldConfig);
+    constructor(data?: Partial<TooltipConfig>);
 }
 
 declare class Modal extends LktItem implements ModalConfig {
@@ -591,7 +678,75 @@ declare class Modal extends LktItem implements ModalConfig {
     zIndex: number;
     beforeClose: Function | undefined;
     item: LktObject;
-    constructor(data?: FieldConfig);
+    constructor(data?: Partial<ModalConfig>);
+}
+
+declare class Table extends LktItem implements TableConfig {
+    static lktDefaultValues: (keyof TableConfig)[];
+    modelValue: LktObject[];
+    type?: TableType;
+    columns: Column[];
+    resource?: string;
+    noResultsText?: string;
+    filters?: LktObject[];
+    hideEmptyColumns?: boolean;
+    itemDisplayChecker?: Function;
+    loading?: boolean;
+    page?: number;
+    perms?: ValidTablePermission[];
+    editMode?: boolean;
+    dataStateConfig?: LktObject;
+    sortable?: boolean;
+    sorter?: Function;
+    initialSorting?: boolean;
+    draggableChecker?: Function;
+    checkValidDrag?: Function;
+    renderDrag?: boolean | Function;
+    disabledDrag?: boolean | Function;
+    draggableItemKey?: string;
+    header?: HeaderConfig;
+    title?: string;
+    titleTag?: string;
+    titleIcon?: string;
+    headerClass?: string;
+    saveButton?: ButtonConfig;
+    createButton?: ButtonConfig;
+    dropButton?: ButtonConfig;
+    wrapContentTag?: string;
+    wrapContentClass?: string;
+    itemsContainerClass?: string;
+    hiddenSave?: boolean;
+    saveDisabled?: boolean;
+    saveValidator?: Function;
+    saveConfirm?: string;
+    confirmData?: LktObject;
+    saveResource?: string;
+    saveResourceData?: LktObject;
+    saveTooltipEngine?: string;
+    splitSave?: boolean;
+    saveText?: string;
+    createText?: string;
+    createIcon?: string;
+    createRoute?: string;
+    dropText?: string;
+    dropIcon?: string;
+    editText?: string;
+    editIcon?: string;
+    editLink?: string;
+    editModeText?: string;
+    switchEditionEnabled?: boolean;
+    createDisabled?: boolean;
+    dropConfirm?: string;
+    dropResource?: string;
+    addNavigation?: boolean;
+    createEnabledValidator?: Function;
+    newValueGenerator?: Function;
+    requiredItemsForTopCreate?: number;
+    requiredItemsForBottomCreate?: number;
+    slotItemVar?: string;
+    modal?: string;
+    modalData?: LktObject;
+    constructor(data?: Partial<TableConfig>);
 }
 
 declare enum ModalType {
@@ -604,13 +759,6 @@ declare enum SortDirection {
     Desc = "desc"
 }
 
-declare enum TableType {
-    Table = "table",
-    Item = "item",
-    Ul = "ul",
-    Ol = "ol"
-}
-
 /**
  * Export common interfaces
  */
@@ -620,4 +768,4 @@ declare function getDefaultValues<T>(cls: {
     lktDefaultValues: (keyof T)[];
 }): Partial<T>;
 
-export { Anchor, type AnchorConfig, AnchorType, Button, type ButtonConfig, ButtonType, Column, ColumnType, type DragConfig, type EmptyModalKey, Field, FieldAutoValidationTrigger, type FieldConfig, FieldType, LktItem, type LktObject, LktStrictItem, Modal, type ModalConfig, ModalType, MultipleOptionsDisplay, Option, type OptionConfig, SafeString, SortDirection, TableType, ToggleMode, Tooltip, type TooltipConfig, TooltipLocationX, TooltipLocationY, TooltipPositionEngine, type ValidColSpan, type ValidFieldMinMax, type ValidFieldValue, type ValidModalKey, type ValidModalName, type ValidOptionValue, type ValidSafeStringValue, type ValidTabIndex, getDefaultValues };
+export { Anchor, type AnchorConfig, AnchorType, Button, type ButtonConfig, ButtonType, Column, type ColumnConfig, ColumnType, type DragConfig, type EmptyModalKey, Field, FieldAutoValidationTrigger, type FieldConfig, FieldType, LktItem, type LktObject, LktStrictItem, Modal, type ModalConfig, ModalType, MultipleOptionsDisplay, Option, type OptionConfig, SafeString, SortDirection, Table, type TableConfig, TablePermission, TableType, ToggleMode, Tooltip, type TooltipConfig, TooltipLocationX, TooltipLocationY, TooltipPositionEngine, type ValidColSpan, type ValidFieldMinMax, type ValidFieldValue, type ValidModalKey, type ValidModalName, type ValidOptionValue, type ValidSafeStringValue, type ValidTabIndex, getDefaultValues };

package/dist/index.js

@@ -243,7 +243,8 @@ var Anchor = class extends LktItem {
     "confirmModal",
     "confirmModalKey",
     "confirmData",
-    "imposter"
+    "imposter",
+    "external"
   ];
   type = "router-link" /* RouterLink */;
   to = "";
@@ -256,10 +257,7 @@ var Anchor = class extends LktItem {
   confirmModalKey = "_";
   confirmData = {};
   imposter = false;
-  constructor(data = {}) {
-    super();
-    this.feed(data);
-  }
+  external = false;
   getHref() {
     let href = "";
     if (typeof this.to === "string") href = this.to;
@@ -277,6 +275,10 @@ var Anchor = class extends LktItem {
     if (typeof this.to === "string" && this.to !== "") return this.to;
     return "";
   }
+  constructor(data = {}) {
+    super();
+    this.feed(data);
+  }
 };
 
 // src/enums/ButtonType.ts
@@ -316,11 +318,51 @@ var Button = class extends LktItem {
     "showTooltipOnHover",
     "hideTooltipOnLeave"
   ];
+  static lktDefaultValues = [
+    "type",
+    "name",
+    "palette",
+    "class",
+    "containerClass",
+    "value",
+    "disabled",
+    "loading",
+    "wrapContent",
+    "split",
+    "splitIcon",
+    "resource",
+    "resourceData",
+    "modal",
+    "modalKey",
+    "modalData",
+    "confirmModal",
+    "confirmModalKey",
+    "confirmData",
+    "text",
+    "icon",
+    "iconDot",
+    "iconEnd",
+    "img",
+    "tooltip",
+    "showTooltipOnHoverDelay",
+    "tooltipWindowMargin",
+    "tooltipReferrerMargin",
+    "tooltipLocationY",
+    "tooltipLocationX",
+    "checked",
+    "clickRef",
+    "openTooltip",
+    "tabindex",
+    "anchor",
+    "tooltipEngine",
+    "showTooltipOnHover",
+    "hideTooltipOnLeave",
+    "tooltipClass",
+    "splitClass"
+  ];
   type = "button" /* Button */;
   name = generateRandomString2(10);
   palette = "";
-  onClickTo = "";
-  onClickToExternal = false;
   class = "";
   containerClass = "";
   value = "";
@@ -329,23 +371,19 @@ var Button = class extends LktItem {
   wrapContent = false;
   split = false;
   splitIcon = "";
-  isAnchor = false;
   resource = "";
-  resourceData = () => ({});
+  resourceData = {};
   modal = "";
   modalKey = "_";
-  modalData = () => ({});
+  modalData = {};
   confirmModal = "";
   confirmModalKey = "_";
-  confirmData = () => ({});
+  confirmData = {};
   text = "";
   icon = "";
   iconDot = false;
   iconEnd = "";
   img = "";
-  newTab = false;
-  download = false;
-  downloadFileName = "";
   tooltip = false;
   showTooltipOnHoverDelay = 0;
   tooltipWindowMargin = 0;
@@ -382,6 +420,26 @@ var Column = class extends LktItem {
     "link",
     "action"
   ];
+  static lktDefaultValues = [
+    "type",
+    "key",
+    "label",
+    "sortable",
+    "hidden",
+    "editable",
+    "formatter",
+    "checkEmpty",
+    "colspan",
+    "preferSlot",
+    "isForRowKey",
+    "extractTitleFromColumn",
+    "slotData",
+    "field",
+    "anchor",
+    "button",
+    "link",
+    "action"
+  ];
   type = "" /* None */;
   key = "";
   label = "";
@@ -400,7 +458,7 @@ var Column = class extends LktItem {
   button = void 0;
   link = void 0;
   action = void 0;
-  constructor(data) {
+  constructor(data = {}) {
     super();
     this.feed(data);
     switch (this.type) {
@@ -525,6 +583,159 @@ var Modal = class extends LktItem {
   }
 };
 
+// src/enums/TableType.ts
+var TableType = /* @__PURE__ */ ((TableType2) => {
+  TableType2["Table"] = "table";
+  TableType2["Item"] = "item";
+  TableType2["Ul"] = "ul";
+  TableType2["Ol"] = "ol";
+  return TableType2;
+})(TableType || {});
+
+// src/instances/Table.ts
+var Table = class extends LktItem {
+  static lktDefaultValues = [
+    "modelValue",
+    "type",
+    "columns",
+    "resource",
+    "noResultsText",
+    "filters",
+    "hideEmptyColumns",
+    "itemDisplayChecker",
+    "loading",
+    "page",
+    "perms",
+    "editMode",
+    "dataStateConfig",
+    "sortable",
+    "sorter",
+    "initialSorting",
+    "draggableChecker",
+    "checkValidDrag",
+    "renderDrag",
+    "disabledDrag",
+    "draggableItemKey",
+    "header",
+    "title",
+    "titleTag",
+    "titleIcon",
+    "headerClass",
+    "saveButton",
+    "createButton",
+    "dropButton",
+    "wrapContentTag",
+    "wrapContentClass",
+    "itemsContainerClass",
+    "hiddenSave",
+    "saveDisabled",
+    "saveValidator",
+    "saveConfirm",
+    "confirmData",
+    "saveResource",
+    "saveResourceData",
+    "saveTooltipEngine",
+    "splitSave",
+    "saveText",
+    "createText",
+    "createIcon",
+    "createRoute",
+    "dropText",
+    "dropIcon",
+    "editText",
+    "editIcon",
+    "editLink",
+    "editModeText",
+    "switchEditionEnabled",
+    "createDisabled",
+    "dropConfirm",
+    "dropResource",
+    "addNavigation",
+    "createEnabledValidator",
+    "newValueGenerator",
+    "requiredItemsForTopCreate",
+    "requiredItemsForBottomCreate",
+    "slotItemVar",
+    "modal",
+    "modalData"
+  ];
+  // Data
+  modelValue = [];
+  type = "table" /* Table */;
+  columns = [];
+  resource = "";
+  noResultsText = "";
+  filters = [];
+  // Data visualization
+  hideEmptyColumns = false;
+  itemDisplayChecker = void 0;
+  // State
+  loading = false;
+  page = 1;
+  perms = [];
+  editMode = false;
+  dataStateConfig = {};
+  // Sort
+  sortable = false;
+  sorter = void 0;
+  initialSorting = false;
+  // Drag (Old)
+  draggableChecker;
+  checkValidDrag;
+  renderDrag;
+  disabledDrag;
+  draggableItemKey;
+  // New proposed prop: header
+  header;
+  // Replaces:
+  title = "";
+  titleTag = "h2";
+  titleIcon = "";
+  headerClass = "";
+  // New proposed prop: saveButton
+  saveButton = {};
+  createButton = {};
+  dropButton = {};
+  wrapContentTag = "div";
+  wrapContentClass = "";
+  itemsContainerClass = "";
+  hiddenSave = false;
+  saveDisabled = false;
+  saveValidator = void 0;
+  saveConfirm = "";
+  confirmData = {};
+  saveResource = "";
+  saveResourceData = {};
+  saveTooltipEngine = "absolute" /* Absolute */;
+  splitSave = false;
+  saveText = "";
+  createText = "";
+  createIcon = "";
+  createRoute = "";
+  dropText = "";
+  dropIcon = "";
+  editText = "";
+  editIcon = "";
+  editLink = "";
+  editModeText = "";
+  switchEditionEnabled = false;
+  createDisabled = false;
+  dropConfirm = "";
+  dropResource = "";
+  addNavigation = false;
+  createEnabledValidator = void 0;
+  newValueGenerator = void 0;
+  requiredItemsForTopCreate = 0;
+  requiredItemsForBottomCreate = 0;
+  slotItemVar = "item";
+  modal = "";
+  modalData = {};
+  constructor(data = {}) {
+    super();
+    this.feed(data);
+  }
+};
+
 // src/enums/ModalType.ts
 var ModalType = /* @__PURE__ */ ((ModalType2) => {
   ModalType2["Modal"] = "modal";
@@ -539,14 +750,19 @@ var SortDirection = /* @__PURE__ */ ((SortDirection2) => {
   return SortDirection2;
 })(SortDirection || {});
 
-// src/enums/TableType.ts
-var TableType = /* @__PURE__ */ ((TableType2) => {
-  TableType2["Table"] = "table";
-  TableType2["Item"] = "item";
-  TableType2["Ul"] = "ul";
-  TableType2["Ol"] = "ol";
-  return TableType2;
-})(TableType || {});
+// src/enums/TablePermission.ts
+var TablePermission = /* @__PURE__ */ ((TablePermission2) => {
+  TablePermission2["Create"] = "create";
+  TablePermission2["Update"] = "update";
+  TablePermission2["Edit"] = "edit";
+  TablePermission2["Drop"] = "drop";
+  TablePermission2["Sort"] = "sort";
+  TablePermission2["InlineEdit"] = "inline-edit";
+  TablePermission2["InlineCreate"] = "inline-create";
+  TablePermission2["ModalCreate"] = "modal-create";
+  TablePermission2["InlineCreateEver"] = "inline-create-ever";
+  return TablePermission2;
+})(TablePermission || {});
 
 // src/enums/ToggleMode.ts
 var ToggleMode = /* @__PURE__ */ ((ToggleMode2) => {
@@ -587,6 +803,8 @@ export {
   Option,
   SafeString,
   SortDirection,
+  Table,
+  TablePermission,
   TableType,
   ToggleMode,
   Tooltip,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lkt-vue-kernel",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "LKT Vue Kernel",
   "keywords": [
     "lkt",