lkt-item-crud 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 lekrat
+
+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/jest.config.d.ts

@@ -0,0 +1,2 @@
+export const preset: string;
+export const testEnvironment: string;

package/dist/lkt-item-crud.es.js

@@ -0,0 +1,71 @@
+import { defineComponent as q, useSlots as w, ref as p, computed as I, watch as m, resolveComponent as B, openBlock as c, createElementBlock as f, createElementVNode as h, toDisplayString as D, renderSlot as k, createCommentVNode as v, createBlock as L } from "vue";
+import { httpCall as d } from "lkt-http-client";
+const b = { class: "lkt-item-crud" }, j = {
+  key: 0,
+  class: "lkt-item-crud_header"
+}, E = { class: "lkt-item-crud_header-title" }, N = { class: "lkt-item-crud_header-slot" }, O = {
+  key: 1,
+  class: "lkt-item-crud_content"
+}, $ = { name: "LktItemCrud", inheritAttrs: !1 }, x = /* @__PURE__ */ q({
+  ...$,
+  props: {
+    modelValue: { type: Object, required: !1, default: () => ({}) },
+    readResource: { type: String, required: !0 },
+    readData: { type: Object, required: !1, default: () => ({}) },
+    createResource: { type: String, required: !1 },
+    updateResource: { type: String, required: !1 },
+    dropResource: { type: String, required: !1 },
+    title: { type: String, default: "" }
+  },
+  emits: ["update:modelValue", "read", "create", "update", "drop", "perms"],
+  setup(u, { expose: _, emit: y }) {
+    const r = u, R = w(), s = y, t = p(!0), o = p(r.modelValue), n = p([]), i = async () => (t.value = !0, await d(r.readResource, r.readData).then((e) => {
+      t.value = !1, o.value = e.data, n.value = e.perms, s("read", e);
+    })), S = I(() => t.value ? !1 : r.title || !!R["post-title"]);
+    m(() => r.modelValue, (e) => o.value = e), m(o, () => s("update:modelValue", o.value)), m(n, () => s("perms", n.value));
+    const g = async (e) => {
+      const l = r.createResource;
+      return t.value = !0, await d(l, { ...e }).then((a) => {
+        t.value = !1, s("create", a);
+      });
+    }, C = async (e) => {
+      const l = r.updateResource;
+      return t.value = !0, await d(l, { ...e }).then((a) => {
+        t.value = !1, s("update", a);
+      });
+    }, V = async (e) => {
+      const l = r.dropResource;
+      return t.value = !0, await d(l, { ...e }).then((a) => {
+        t.value = !1, s("drop", a);
+      });
+    };
+    return r.readResource && i(), _({
+      fetchItem: i,
+      create: g,
+      update: C,
+      drop: V,
+      refresh: i
+    }), (e, l) => {
+      const a = B("lkt-loader");
+      return c(), f("article", b, [
+        S.value ? (c(), f("header", j, [
+          h("h1", E, D(u.title), 1),
+          h("div", N, [
+            k(e.$slots, "post-title", { item: o.value })
+          ])
+        ])) : v("", !0),
+        t.value ? v("", !0) : (c(), f("div", O, [
+          k(e.$slots, "item", { item: o.value })
+        ])),
+        t.value ? (c(), L(a, { key: 2 })) : v("", !0)
+      ]);
+    };
+  }
+}), z = {
+  install: (u, _ = {}) => {
+    u.component("LktItemCrud", x);
+  }
+};
+export {
+  z as default
+};

package/dist/lkt-item-crud.umd.js

@@ -0,0 +1 @@
+(function(e,o){typeof exports=="object"&&typeof module<"u"?module.exports=o(require("vue"),require("lkt-http-client")):typeof define=="function"&&define.amd?define(["vue","lkt-http-client"],o):(e=typeof globalThis<"u"?globalThis:e||self,e.LktItemCrud=o(e.Vue,e.LktHttpClient))})(this,function(e,o){"use strict";const m={class:"lkt-item-crud"},f={key:0,class:"lkt-item-crud_header"},h={class:"lkt-item-crud_header-title"},k={class:"lkt-item-crud_header-slot"},_={key:1,class:"lkt-item-crud_content"},y={name:"LktItemCrud",inheritAttrs:!1},C=e.defineComponent({...y,props:{modelValue:{type:Object,required:!1,default:()=>({})},readResource:{type:String,required:!0},readData:{type:Object,required:!1,default:()=>({})},createResource:{type:String,required:!1},updateResource:{type:String,required:!1},dropResource:{type:String,required:!1},title:{type:String,default:""}},emits:["update:modelValue","read","create","update","drop","perms"],setup(d,{expose:p,emit:V}){const a=d,R=e.useSlots(),l=V,r=e.ref(!0),n=e.ref(a.modelValue),u=e.ref([]),i=async()=>(r.value=!0,await o.httpCall(a.readResource,a.readData).then(t=>{r.value=!1,n.value=t.data,u.value=t.perms,l("read",t)})),S=e.computed(()=>r.value?!1:a.title||!!R["post-title"]);e.watch(()=>a.modelValue,t=>n.value=t),e.watch(n,()=>l("update:modelValue",n.value)),e.watch(u,()=>l("perms",u.value));const q=async t=>{const c=a.createResource;return r.value=!0,await o.httpCall(c,{...t}).then(s=>{r.value=!1,l("create",s)})},B=async t=>{const c=a.updateResource;return r.value=!0,await o.httpCall(c,{...t}).then(s=>{r.value=!1,l("update",s)})},w=async t=>{const c=a.dropResource;return r.value=!0,await o.httpCall(c,{...t}).then(s=>{r.value=!1,l("drop",s)})};return a.readResource&&i(),p({fetchItem:i,create:q,update:B,drop:w,refresh:i}),(t,c)=>{const s=e.resolveComponent("lkt-loader");return e.openBlock(),e.createElementBlock("article",m,[S.value?(e.openBlock(),e.createElementBlock("header",f,[e.createElementVNode("h1",h,e.toDisplayString(d.title),1),e.createElementVNode("div",k,[e.renderSlot(t.$slots,"post-title",{item:n.value})])])):e.createCommentVNode("",!0),r.value?e.createCommentVNode("",!0):(e.openBlock(),e.createElementBlock("div",_,[e.renderSlot(t.$slots,"item",{item:n.value})])),r.value?(e.openBlock(),e.createBlock(s,{key:2})):e.createCommentVNode("",!0)])}}});return{install:(d,p={})=>{d.component("LktItemCrud",C)}}});

package/dist/types/index.d.ts

@@ -0,0 +1,5 @@
+import { App } from "vue";
+declare const LktItemCrud: {
+    install: (app: App, options?: {}) => void;
+};
+export default LktItemCrud;

package/dist/types/lib-components/LktItemCrud.vue.d.ts

@@ -0,0 +1,206 @@
+import { LktObject } from "lkt-ts-interfaces";
+declare const _default: {
+    new (...args: any[]): import("vue").CreateComponentPublicInstance<Readonly<import("vue").ExtractPropTypes<{
+        modelValue: {
+            type: ObjectConstructor;
+            required: false;
+            default: () => {};
+        };
+        readResource: {
+            type: StringConstructor;
+            required: true;
+        };
+        readData: {
+            type: ObjectConstructor;
+            required: false;
+            default: () => {};
+        };
+        createResource: {
+            type: StringConstructor;
+            required: false;
+        };
+        updateResource: {
+            type: StringConstructor;
+            required: false;
+        };
+        dropResource: {
+            type: StringConstructor;
+            required: false;
+        };
+        title: {
+            type: StringConstructor;
+            default: string;
+        };
+    }>> & {
+        onDrop?: ((...args: any[]) => any) | undefined;
+        onUpdate?: ((...args: any[]) => any) | undefined;
+        "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+        onRead?: ((...args: any[]) => any) | undefined;
+        onCreate?: ((...args: any[]) => any) | undefined;
+        onPerms?: ((...args: any[]) => any) | undefined;
+    }, {
+        fetchItem: () => Promise<void>;
+        create: (data: LktObject) => Promise<void>;
+        update: (data: LktObject) => Promise<void>;
+        drop: (data: LktObject) => Promise<void>;
+        refresh: () => Promise<void>;
+    }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("drop" | "update" | "update:modelValue" | "read" | "create" | "perms")[], import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps & Readonly<import("vue").ExtractPropTypes<{
+        modelValue: {
+            type: ObjectConstructor;
+            required: false;
+            default: () => {};
+        };
+        readResource: {
+            type: StringConstructor;
+            required: true;
+        };
+        readData: {
+            type: ObjectConstructor;
+            required: false;
+            default: () => {};
+        };
+        createResource: {
+            type: StringConstructor;
+            required: false;
+        };
+        updateResource: {
+            type: StringConstructor;
+            required: false;
+        };
+        dropResource: {
+            type: StringConstructor;
+            required: false;
+        };
+        title: {
+            type: StringConstructor;
+            default: string;
+        };
+    }>> & {
+        onDrop?: ((...args: any[]) => any) | undefined;
+        onUpdate?: ((...args: any[]) => any) | undefined;
+        "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+        onRead?: ((...args: any[]) => any) | undefined;
+        onCreate?: ((...args: any[]) => any) | undefined;
+        onPerms?: ((...args: any[]) => any) | undefined;
+    }, {
+        title: string;
+        modelValue: Record<string, any>;
+        readData: Record<string, any>;
+    }, true, {}, {}, {
+        P: {};
+        B: {};
+        D: {};
+        C: {};
+        M: {};
+        Defaults: {};
+    }, Readonly<import("vue").ExtractPropTypes<{
+        modelValue: {
+            type: ObjectConstructor;
+            required: false;
+            default: () => {};
+        };
+        readResource: {
+            type: StringConstructor;
+            required: true;
+        };
+        readData: {
+            type: ObjectConstructor;
+            required: false;
+            default: () => {};
+        };
+        createResource: {
+            type: StringConstructor;
+            required: false;
+        };
+        updateResource: {
+            type: StringConstructor;
+            required: false;
+        };
+        dropResource: {
+            type: StringConstructor;
+            required: false;
+        };
+        title: {
+            type: StringConstructor;
+            default: string;
+        };
+    }>> & {
+        onDrop?: ((...args: any[]) => any) | undefined;
+        onUpdate?: ((...args: any[]) => any) | undefined;
+        "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+        onRead?: ((...args: any[]) => any) | undefined;
+        onCreate?: ((...args: any[]) => any) | undefined;
+        onPerms?: ((...args: any[]) => any) | undefined;
+    }, {
+        fetchItem: () => Promise<void>;
+        create: (data: LktObject) => Promise<void>;
+        update: (data: LktObject) => Promise<void>;
+        drop: (data: LktObject) => Promise<void>;
+        refresh: () => Promise<void>;
+    }, {}, {}, {}, {
+        title: string;
+        modelValue: Record<string, any>;
+        readData: Record<string, any>;
+    }>;
+    __isFragment?: undefined;
+    __isTeleport?: undefined;
+    __isSuspense?: undefined;
+} & import("vue").ComponentOptionsBase<Readonly<import("vue").ExtractPropTypes<{
+    modelValue: {
+        type: ObjectConstructor;
+        required: false;
+        default: () => {};
+    };
+    readResource: {
+        type: StringConstructor;
+        required: true;
+    };
+    readData: {
+        type: ObjectConstructor;
+        required: false;
+        default: () => {};
+    };
+    createResource: {
+        type: StringConstructor;
+        required: false;
+    };
+    updateResource: {
+        type: StringConstructor;
+        required: false;
+    };
+    dropResource: {
+        type: StringConstructor;
+        required: false;
+    };
+    title: {
+        type: StringConstructor;
+        default: string;
+    };
+}>> & {
+    onDrop?: ((...args: any[]) => any) | undefined;
+    onUpdate?: ((...args: any[]) => any) | undefined;
+    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+    onRead?: ((...args: any[]) => any) | undefined;
+    onCreate?: ((...args: any[]) => any) | undefined;
+    onPerms?: ((...args: any[]) => any) | undefined;
+}, {
+    fetchItem: () => Promise<void>;
+    create: (data: LktObject) => Promise<void>;
+    update: (data: LktObject) => Promise<void>;
+    drop: (data: LktObject) => Promise<void>;
+    refresh: () => Promise<void>;
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("drop" | "update" | "update:modelValue" | "read" | "create" | "perms")[], "drop" | "update" | "update:modelValue" | "read" | "create" | "perms", {
+    title: string;
+    modelValue: Record<string, any>;
+    readData: Record<string, any>;
+}, {}, string, {}> & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps & (new () => {
+    $slots: {
+        'post-title': (_: {
+            item: Record<string, any>;
+        }) => any;
+        item: (_: {
+            item: Record<string, any>;
+        }) => any;
+    };
+});
+export default _default;

package/dist/vite.config.d.ts

@@ -0,0 +1,44 @@
+declare namespace _default {
+    const plugins: import("vite").Plugin[];
+    namespace resolve {
+        const alias: {
+            '@': string;
+            '@test': string;
+        };
+    }
+    namespace build {
+        export namespace lib {
+            const entry: string;
+            const name: string;
+            function fileName(format: any): string;
+        }
+        export { outDir };
+        export const minify: boolean;
+        export namespace rollupOptions {
+            const external: string[];
+            namespace output {
+                const globals: {
+                    vue: string;
+                    '@vuepic/vue-datepicker': string;
+                    'vue-next-select': string;
+                    suneditor: string;
+                    katex: string;
+                    'lkt-tools': string;
+                    'lkt-http-client': string;
+                    'lkt-string-tools': string;
+                    'lkt-vue-tools': string;
+                    'lkt-events': string;
+                };
+                const sourcemapExcludeSources: boolean;
+            }
+        }
+    }
+    namespace test {
+        namespace coverage {
+            const reporter: string[];
+        }
+        function resolveSnapshotPath(testPath: any, snapExtension: any): string;
+    }
+}
+export default _default;
+declare const outDir: string;

package/lkt-item-crud.css

@@ -0,0 +1,11 @@
+.lkt-item-crud {
+    display: flex;
+    flex-direction: column;
+    gap: 15px;
+}
+
+.lkt-item-crud_content {
+    display: flex;
+    flex-direction: column;
+    gap: 15px;
+}

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "lkt-item-crud",
+  "version": "1.0.0",
+  "description": "",
+  "main": "src/index.ts",
+  "module": "src/index.ts",
+  "files": [
+    "lkt-item-crud.css",
+    "dist/*",
+    "src/**/*.vue"
+  ],
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": "./dist/lkt-item-crud.es.js",
+      "require": "./dist/lkt-item-crud.umd.js"
+    },
+    "./dist/style.css": "./dist/style.css"
+  },
+  "types": "./dist/types/index.d.ts",
+  "scripts": {
+    "serve": "vite",
+    "build": "vite build && vue-tsc --emitDeclarationOnly --project tsconfig.json && mv dist/src dist/types",
+    "build2": "vite build",
+    "preview": "vite preview",
+    "test": "jest",
+    "test-coverage": "vitest run --coverage"
+  },
+  "author": "Antonio Ibáñez",
+  "devDependencies": {
+    "@babel/core": "^7.13.13",
+    "@babel/preset-env": "^7.13.12",
+    "@babel/types": "^7.18.9",
+    "@testing-library/cypress": "^7.0.4",
+    "@testing-library/dom": "^7.30.1",
+    "@testing-library/jest-dom": "^5.11.10",
+    "@types/jest": "^29.0.1",
+    "@types/node": "^18.6.2",
+    "@typescript-eslint/eslint-plugin": "^5.36.2",
+    "@typescript-eslint/parser": "^5.36.2",
+    "@vitejs/plugin-vue": "^3.0.1",
+    "babel-eslint": "^10.1.0",
+    "babel-jest": "^29.0.3",
+    "babel-loader": "^8.2.2",
+    "cypress": "^6.8.0",
+    "eslint": "8.22.0",
+    "eslint-config-prettier": "^8.1.0",
+    "eslint-plugin-cypress": "^2.11.2",
+    "eslint-plugin-html": "^7.1.0",
+    "eslint-plugin-import": "^2.22.1",
+    "eslint-plugin-jest": "^24.3.2",
+    "eslint-plugin-prettier": "^3.3.1",
+    "eslint-plugin-simple-import-sort": "^7.0.0",
+    "jest": "^29.0.3",
+    "prettier": "^2.7.1",
+    "ts-jest": "^29.0.0",
+    "typescript": "^4.8.3",
+    "vite": "^3.1.2",
+    "vue-tsc": "^0.38.9"
+  },
+  "dependencies": {
+    "lkt-events": "^1.0.2",
+    "lkt-http-client": "^1.0.12",
+    "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"
+  },
+  "engines": {
+    "node": ">=18"
+  }
+}

package/src/index.ts

@@ -0,0 +1,10 @@
+import {App} from "vue";
+import {default as itemCrud} from "./lib-components/LktItemCrud.vue";
+
+
+const LktItemCrud = {
+    install: (app: App, options = {}) => {
+        app.component('LktItemCrud', itemCrud);
+    },
+};
+export default LktItemCrud;

package/src/lib-components/LktItemCrud.vue

@@ -0,0 +1,103 @@
+<script lang="ts">
+export default {name: "LktItemCrud", inheritAttrs: false}
+</script>
+
+<script setup lang="ts">
+import {ref, watch, useSlots, computed} from "vue";
+import {httpCall} from "lkt-http-client";
+import {LktObject} from "lkt-ts-interfaces";
+
+const props = defineProps({
+    modelValue: {type: Object, required: false, default: () => ({})},
+    readResource: {type: String, required: true},
+    readData: {type: Object, required: false, default: () => ({})},
+    createResource: {type: String, required: false},
+    updateResource: {type: String, required: false},
+    dropResource: {type: String, required: false},
+    title: {type: String, default: ''},
+});
+
+const slots = useSlots();
+
+const emit = defineEmits(['update:modelValue', 'read', 'create', 'update', 'drop', 'perms']);
+
+const loading = ref(true),
+    item = ref(props.modelValue),
+    perms = ref([]);
+
+const fetchItem = async () => {
+    loading.value = true;
+    return await httpCall(props.readResource, props.readData).then(r => {
+        loading.value = false;
+        item.value = r.data;
+        perms.value = r.perms;
+        emit('read', r);
+    });
+}
+
+const displayHeader = computed(() => {
+    if (loading.value) return false;
+
+    return props.title || !!slots['post-title'];
+})
+
+watch(() => props.modelValue, v => item.value = v);
+watch(item, () => emit('update:modelValue', item.value));
+watch(perms, () => emit('perms', perms.value));
+
+const create = async (data: LktObject) => {
+    const resource = props.createResource;
+
+    loading.value = true;
+    return await httpCall(resource, {...data}).then(r => {
+        loading.value = false;
+        emit('create', r);
+    });
+}
+
+const update = async (data: LktObject) => {
+    const resource = props.updateResource;
+
+    loading.value = true;
+    return await httpCall(resource, {...data}).then(r => {
+        loading.value = false;
+        emit('update', r);
+    });
+}
+
+const drop = async (data: LktObject) => {
+    const resource = props.dropResource;
+
+    loading.value = true;
+    return await httpCall(resource, {...data}).then(r => {
+        loading.value = false;
+        emit('drop', r);
+    });
+}
+
+// Fetch item
+if (props.readResource) fetchItem();
+
+defineExpose({
+    fetchItem,
+    create,
+    update,
+    drop,
+    refresh: fetchItem
+});
+</script>
+
+<template>
+    <article class="lkt-item-crud">
+        <header class="lkt-item-crud_header" v-if="displayHeader">
+            <h1 class="lkt-item-crud_header-title">{{ title }}</h1>
+            <div class="lkt-item-crud_header-slot">
+                <slot name="post-title" v-bind:item="item"></slot>
+            </div>
+        </header>
+        <div class="lkt-item-crud_content" v-if="!loading">
+            <slot name="item" v-bind:item="item"></slot>
+        </div>
+        <lkt-loader v-if="loading"></lkt-loader>
+    </article>
+</template>