lkt-step-process 1.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 LKT VUE
+
+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/dist/build.d.ts

@@ -0,0 +1,4 @@
+export { ve as default };
+declare namespace ve {
+    function install(v: any, g?: {}): void;
+}

package/dist/build.js

@@ -0,0 +1,114 @@
+import { defineComponent as K, useSlots as M, ref as c, computed as l, resolveComponent as S, openBlock as u, createElementBlock as o, normalizeClass as Q, createElementVNode as f, toDisplayString as U, renderSlot as m, createCommentVNode as _, withDirectives as y, createVNode as H, withCtx as B, unref as D, vShow as h, Fragment as W, renderList as X, createBlock as Y } from "vue";
+const Z = {
+  key: 0,
+  class: "lkt-step-process_header"
+}, ee = { class: "lkt-step-process_header-title" }, te = { class: "lkt-step-process_header-slot" }, re = { class: "lkt-step-process-buttons" }, le = { key: 1 }, ne = { key: 1 }, ae = {
+  key: 1,
+  class: "lkt-step-process_content"
+}, ue = { class: "lkt-grid-1" }, oe = { name: "LktStepProcess", inheritAttrs: !1 }, se = /* @__PURE__ */ K({
+  ...oe,
+  props: {
+    modelValue: { type: Object, required: !1, default: () => ({ step: 1, steps: [], data: {} }) },
+    title: { type: String, default: "" },
+    nextText: { type: String, default: "Next" },
+    prevText: { type: String, default: "Back" },
+    nextValidator: { type: Function, required: !1, default: () => !0 },
+    prevValidator: { type: Function, required: !1, default: () => !0 }
+  },
+  emits: ["next", "prev", "finish"],
+  setup(v, { expose: g, emit: N }) {
+    const s = v, p = M(), x = N, n = c(!1), e = c(s.modelValue), V = c(null), b = c(null), L = l(() => n.value ? !1 : s.title || !!p["post-title"]), R = l(() => {
+      let r = [];
+      for (let k in p)
+        k.indexOf("step-") !== -1 && r.push(k.substring(5));
+      return r;
+    }), d = l(() => e.value.step ? e.value.step : !e.value.steps || !e.value.steps[0] ? null : e.value.steps[0].name), a = l(() => e.value.steps.findIndex((r) => r.name === d.value)), t = l(() => e.value.steps[a.value]), $ = l(() => typeof t.value.prevValidator == "function" ? t.value.prevValidator(e.value) : typeof t.value.prevValidator == "boolean" ? t.value.prevValidator : typeof s.prevValidator == "function" ? s.prevValidator(e.value) : !0), P = l(() => typeof t.value.nextValidator == "function" ? t.value.nextValidator(e.value) : typeof t.value.nextValidator == "boolean" ? t.value.nextValidator : typeof s.nextValidator == "function" ? s.nextValidator(e.value) : !0), j = l(() => a.value === 0 || !$.value), q = l(() => a.value === e.value.steps.length - 1 || !P.value), w = l(() => typeof t.value.prevHidden == "function" ? t.value.prevHidden(e.value) : typeof t.value.prevHidden == "boolean" ? t.value.prevHidden : a.value === 0), F = l(() => typeof t.value.nextHidden == "function" ? t.value.nextHidden(e.value) : typeof t.value.nextHidden == "boolean" ? t.value.nextHidden : a.value === e.value.steps.length - 1), E = l(() => typeof t.value.prevConfirm == "string" ? t.value.prevConfirm : ""), I = l(() => typeof t.value.nextConfirm == "string" ? t.value.nextConfirm : ""), O = l(() => typeof t.value.nextResource == "string" ? t.value.nextResource : ""), T = l(() => typeof t.value.nextResourceData == "object" ? t.value.nextResourceData : {}), z = l(() => {
+      const r = ["lkt-step-process"];
+      return d.value && r.push(`step-${d.value}`), r.join(" ");
+    }), A = (r) => {
+      e.value.step = e.value.steps[a.value + 1].name, a.value === e.value.steps.length - 1 ? x("finish", r) : x("next", r);
+    }, G = (r) => {
+      e.value.step = e.value.steps[a.value - 1].name, x("prev", r);
+    };
+    return g({
+      goNext: () => {
+        b.value.click();
+      },
+      goPrev: () => {
+        V.value.click();
+      },
+      startLoader: () => n.value = !0,
+      stopLoader: () => n.value = !1
+    }), (r, k) => {
+      const C = S("lkt-button"), J = S("lkt-loader");
+      return u(), o("article", {
+        class: Q(z.value)
+      }, [
+        L.value ? (u(), o("header", Z, [
+          f("h1", ee, U(v.title), 1),
+          f("div", te, [
+            m(r.$slots, "post-title", {
+              config: e.value,
+              loading: n.value
+            })
+          ])
+        ])) : _("", !0),
+        f("div", re, [
+          y(H(C, {
+            ref: (i) => V.value = i,
+            palette: "danger",
+            disabled: j.value,
+            "confirm-modal": E.value,
+            onClick: G
+          }, {
+            default: B(() => [
+              D(p)["button-prev"] ? m(r.$slots, "button-prev", {
+                key: 0,
+                config: e.value
+              }) : (u(), o("span", le, "Back"))
+            ]),
+            _: 3
+          }, 8, ["disabled", "confirm-modal"]), [
+            [h, !n.value && !w.value]
+          ]),
+          y(H(C, {
+            ref: (i) => b.value = i,
+            palette: "success",
+            disabled: q.value,
+            "confirm-modal": I.value,
+            resource: O.value,
+            "resource-data": T.value,
+            onClick: A
+          }, {
+            default: B(() => [
+              D(p)["button-next"] ? m(r.$slots, "button-next", {
+                key: 0,
+                config: e.value
+              }) : (u(), o("span", ne, "Next"))
+            ]),
+            _: 3
+          }, 8, ["disabled", "confirm-modal", "resource", "resource-data"]), [
+            [h, !n.value && !F.value]
+          ])
+        ]),
+        n.value ? _("", !0) : (u(), o("div", ae, [
+          f("div", ue, [
+            (u(!0), o(W, null, X(R.value, (i) => y((u(), o("div", null, [
+              m(r.$slots, "step-" + i, { config: e.value })
+            ], 512)), [
+              [h, i === d.value]
+            ])), 256))
+          ])
+        ])),
+        n.value ? (u(), Y(J, { key: 2 })) : _("", !0)
+      ], 2);
+    };
+  }
+}), ve = {
+  install: (v, g = {}) => {
+    v.component("lkt-step-process", se);
+  }
+};
+export {
+  ve as default
+};

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import { Plugin } from "vue";
+import "./../lkt-step-process.css";
+declare const LktStepProcess: Plugin;
+export default LktStepProcess;

package/dist/lib-components/LktStepProcess.vue.d.ts

@@ -0,0 +1,97 @@
+import { StepProcess } from "../types/StepProcess";
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
+    modelValue: {
+        type: ObjectConstructor;
+        required: false;
+        default: () => StepProcess;
+    };
+    title: {
+        type: StringConstructor;
+        default: string;
+    };
+    nextText: {
+        type: StringConstructor;
+        default: string;
+    };
+    prevText: {
+        type: StringConstructor;
+        default: string;
+    };
+    nextValidator: {
+        type: FunctionConstructor;
+        required: false;
+        default: () => boolean;
+    };
+    prevValidator: {
+        type: FunctionConstructor;
+        required: false;
+        default: () => boolean;
+    };
+}, {
+    goNext: () => void;
+    goPrev: () => void;
+    startLoader: () => boolean;
+    stopLoader: () => boolean;
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    finish: (...args: any[]) => void;
+    next: (...args: any[]) => void;
+    prev: (...args: any[]) => void;
+}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    modelValue: {
+        type: ObjectConstructor;
+        required: false;
+        default: () => StepProcess;
+    };
+    title: {
+        type: StringConstructor;
+        default: string;
+    };
+    nextText: {
+        type: StringConstructor;
+        default: string;
+    };
+    prevText: {
+        type: StringConstructor;
+        default: string;
+    };
+    nextValidator: {
+        type: FunctionConstructor;
+        required: false;
+        default: () => boolean;
+    };
+    prevValidator: {
+        type: FunctionConstructor;
+        required: false;
+        default: () => boolean;
+    };
+}>> & {
+    onNext?: ((...args: any[]) => any) | undefined;
+    onFinish?: ((...args: any[]) => any) | undefined;
+    onPrev?: ((...args: any[]) => any) | undefined;
+}, {
+    title: string;
+    modelValue: Record<string, any>;
+    nextText: string;
+    prevText: string;
+    nextValidator: Function;
+    prevValidator: Function;
+}, {}>, Partial<Record<string, (_: {
+    config: Record<string, any>;
+}) => any>> & {
+    "post-title"?(_: {
+        config: Record<string, any>;
+        loading: boolean;
+    }): any;
+    "button-prev"?(_: {
+        config: Record<string, any>;
+    }): any;
+    "button-next"?(_: {
+        config: Record<string, any>;
+    }): any;
+}>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/style.css

@@ -0,0 +1 @@
+.lkt-step-process,.lkt-step-process_content{display:flex;flex-direction:column;gap:15px}.lkt-step-process-buttons{position:sticky;top:calc(-1 * var(--gap));display:flex;align-items:center;justify-content:flex-end;gap:var(--gap);transition:all linear .15s;background:#fff;z-index:2;padding:var(--gap) 0}

package/dist/types/Step.d.ts

@@ -0,0 +1,13 @@
+import { LktObject } from "lkt-ts-interfaces";
+export type Step = {
+    name: string;
+    readResource?: string;
+    nextResource?: string;
+    nextResourceData?: LktObject;
+    nextConfirm?: string;
+    prevConfirm?: string;
+    nextValidator?: Function | boolean;
+    prevValidator?: Function | boolean;
+    nextHidden?: boolean;
+    prevHidden?: boolean;
+};

package/dist/types/StepProcess.d.ts

@@ -0,0 +1,7 @@
+import { LktObject } from "lkt-ts-interfaces";
+import { Step } from "./Step";
+export type StepProcess = {
+    step: number | string;
+    steps: Step[];
+    data: LktObject;
+};

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "lkt-step-process",
+  "version": "1.1.0",
+  "description": "",
+  "type": "module",
+  "module": "./dist/build.js",
+  "exports": {
+    ".": {
+      "import": "./dist/build.js"
+    },
+    "./styles": "./dist/style.css"
+  },
+  "types": "./dist/index.d.ts",
+  "files": ["dist/*", "src/**/*.vue"],
+  "license": "MIT",
+  "sideEffects": false,
+  "scripts": {
+    "build": "rm -rf dist/*; vue-tsc --declaration --emitDeclarationOnly; vite build; tsc --project tsconfig.build.json; cp build/* dist/"
+  },
+  "author": "Antonio Ibáñez",
+  "devDependencies": {
+    "@babel/types": "^7.23.6",
+    "@types/node": "^20.11.19",
+    "@types/rollup": "^0.54.0",
+    "@vitejs/plugin-vue": "^5.0.4",
+    "rollup": "^4.9.6",
+    "typescript": "^5.3.3",
+    "vite": "^5.1.3",
+    "vue": "^3.3.0",
+    "vue-tsc": "^1.8.27"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "dependencies": {
+    "lkt-button": "^1.0.14",
+    "lkt-data-state": "^1.0.9",
+    "lkt-events": "^1.0.2",
+    "lkt-field-switch": "^1.0.0",
+    "lkt-http-client": "^1.0.12",
+    "lkt-http-info": "^1.0.2",
+    "lkt-loader": "^1.0.2",
+    "lkt-string-tools": "^1.0.2",
+    "lkt-ts-interfaces": "^1.0.2",
+    "path": "^0.12.7",
+    "vue": "^3.3.0"
+  }
+}

package/src/lib-components/LktStepProcess.vue

@@ -0,0 +1,210 @@
+<script lang="ts">
+export default {name: "LktStepProcess", inheritAttrs: false}
+</script>
+
+<script setup lang="ts">
+import {ref, useSlots, computed} from "vue";
+import {StepProcess} from "../types/StepProcess";
+import {Step} from "../types/Step";
+
+const props = defineProps({
+    modelValue: {type: Object, required: false, default: (): StepProcess => ({step: 1, steps: [], data: {}})},
+
+    title: {type: String, default: ''},
+    nextText: {type: String, default: 'Next'},
+    prevText: {type: String, default: 'Back'},
+
+    nextValidator: {type: Function, required: false, default: () => true},
+    prevValidator: {type: Function, required: false, default: () => true},
+});
+
+const slots = useSlots();
+
+const emit = defineEmits(['next', 'prev', 'finish']);
+
+const isLoading = ref(false),
+    config = ref(props.modelValue),
+    prevButton = ref(null),
+    nextButton = ref(null);
+
+const displayHeader = computed(() => {
+    if (isLoading.value) return false;
+
+    return props.title || !!slots['post-title'];
+});
+
+const slotsSteps = computed(() => {
+    let r = [];
+    for (let k in slots) if (k.indexOf('step-') !== -1) r.push(k.substring(5));
+    return r;
+})
+
+const currentStep = computed(() => {
+        if (!config.value.step) {
+            if (!config.value.steps) {
+                return null;
+            }
+            if (!config.value.steps[0]) return null;
+            return config.value.steps[0].name;
+        }
+        return config.value.step;
+    }),
+    currentStepIndex = computed(() => {
+        return config.value.steps.findIndex((step: Step) => step.name === currentStep.value);
+    }),
+    currentStepConfig = computed(() => {
+        return config.value.steps[currentStepIndex.value];
+    }),
+    prevValid = computed(() => {
+        if (typeof currentStepConfig.value.prevValidator === 'function') {
+            return currentStepConfig.value.prevValidator(config.value);
+        }
+        if (typeof currentStepConfig.value.prevValidator === 'boolean') {
+            return currentStepConfig.value.prevValidator;
+        }
+        if (typeof props.prevValidator === 'function') {
+            return props.prevValidator(config.value);
+        }
+        return true;
+    }),
+    nextValid = computed(() => {
+        if (typeof currentStepConfig.value.nextValidator === 'function') {
+            return currentStepConfig.value.nextValidator(config.value);
+        }
+        if (typeof currentStepConfig.value.nextValidator === 'boolean') {
+            return currentStepConfig.value.nextValidator;
+        }
+        if (typeof props.nextValidator === 'function') {
+            return props.nextValidator(config.value);
+        }
+        return true;
+    }),
+    prevDisabled = computed(() => {
+        return currentStepIndex.value === 0 || !prevValid.value;
+    }),
+    nextDisabled = computed(() => {
+        return currentStepIndex.value === (config.value.steps.length - 1) || !nextValid.value;
+    }),
+    prevHidden = computed(() => {
+        if (typeof currentStepConfig.value.prevHidden === 'function') {
+            return currentStepConfig.value.prevHidden(config.value);
+        }
+        if (typeof currentStepConfig.value.prevHidden === 'boolean') {
+            return currentStepConfig.value.prevHidden;
+        }
+        return currentStepIndex.value === 0;
+    }),
+    nextHidden = computed(() => {
+        if (typeof currentStepConfig.value.nextHidden === 'function') {
+            return currentStepConfig.value.nextHidden(config.value);
+        }
+        if (typeof currentStepConfig.value.nextHidden === 'boolean') {
+            return currentStepConfig.value.nextHidden;
+        }
+        return currentStepIndex.value === (config.value.steps.length - 1);
+    }),
+    prevConfirm = computed(() => {
+        if (typeof currentStepConfig.value.prevConfirm === 'string') {
+            return currentStepConfig.value.prevConfirm;
+        }
+        return '';
+    }),
+    nextConfirm = computed(() => {
+        if (typeof currentStepConfig.value.nextConfirm === 'string') {
+            return currentStepConfig.value.nextConfirm;
+        }
+        return '';
+    }),
+    nextResource = computed(() => {
+        if (typeof currentStepConfig.value.nextResource === 'string') {
+            return currentStepConfig.value.nextResource;
+        }
+        return '';
+    }),
+    nextResourceData = computed(() => {
+        if (typeof currentStepConfig.value.nextResourceData === 'object') {
+            return currentStepConfig.value.nextResourceData;
+        }
+        return {};
+    }),
+    classes = computed(() => {
+
+        const r = ['lkt-step-process'];
+
+        if (currentStep.value) r.push(`step-${currentStep.value}`);
+        return r.join(' ');
+    });
+
+const onNext = (data: any) => {
+        config.value.step = config.value.steps[currentStepIndex.value + 1].name;
+        if (currentStepIndex.value === (config.value.steps.length - 1)) {
+            emit('finish', data);
+
+        } else {
+            emit('next', data);
+        }
+    },
+    onPrev = (data: any) => {
+        config.value.step = config.value.steps[currentStepIndex.value - 1].name;
+        emit('prev', data);
+    };
+
+
+defineExpose({
+    goNext: () => {
+        // @ts-ignore
+        nextButton.value.click()
+    },
+    goPrev: () => {
+        // @ts-ignore
+        prevButton.value.click()
+    },
+    startLoader: () => isLoading.value = true,
+    stopLoader: () => isLoading.value = false,
+});
+</script>
+
+<template>
+    <article :class="classes">
+        <header class="lkt-step-process_header" v-if="displayHeader">
+            <h1 class="lkt-step-process_header-title">{{ title }}</h1>
+            <div class="lkt-step-process_header-slot">
+                <slot name="post-title" v-bind:config="config" v-bind:loading="isLoading"></slot>
+            </div>
+        </header>
+        <div class="lkt-step-process-buttons">
+            <lkt-button
+                :ref="(el:any) => prevButton = el"
+                v-show="!isLoading && !prevHidden"
+                palette="danger"
+                v-bind:disabled="prevDisabled"
+                v-bind:confirm-modal="prevConfirm"
+                v-on:click="onPrev">
+                <slot v-if="!!slots['button-prev']" name="button-prev" v-bind:config="config"></slot>
+                <span v-else>Back</span>
+            </lkt-button>
+
+            <lkt-button
+                :ref="(el:any) => nextButton = el"
+                v-show="!isLoading && !nextHidden"
+                palette="success"
+                v-bind:disabled="nextDisabled"
+                v-bind:confirm-modal="nextConfirm"
+                v-bind:resource="nextResource"
+                v-bind:resource-data="nextResourceData"
+                v-on:click="onNext">
+                <slot v-if="!!slots['button-next']" name="button-next" v-bind:config="config"></slot>
+                <span v-else>Next</span>
+            </lkt-button>
+        </div>
+
+        <div class="lkt-step-process_content" v-if="!isLoading">
+            <div class="lkt-grid-1">
+                <div v-for="step in slotsSteps" v-show="step === currentStep">
+                    <slot :name="'step-'+step" v-bind:config="config"></slot>
+                </div>
+            </div>
+        </div>
+        <lkt-loader v-if="isLoading"></lkt-loader>
+    </article>
+</template>