@guebbit/vue-toolkit 1.0.0

package/dist/composables/structureDataManagement.js

@@ -0,0 +1,238 @@
+import { computed, ref } from 'vue';
+export const useStructureDataManagement = (
+//  The identification parameter of the item (READONLY and not exported)
+identifiers = "id", 
+// Delimiter for multiple identifiers
+delimiter = "|") => {
+    /**
+     *
+     * @param itemData
+     * @param customIdentifiers - if specified, it will create a key using these identifiers instead of the default ones
+     */
+    const createIdentifier = (itemData, customIdentifiers) => {
+        const _identifiers = customIdentifiers ?? identifiers;
+        if (Array.isArray(_identifiers))
+            return _identifiers.map((key) => itemData[key]).join(delimiter);
+        return itemData[identifier];
+    };
+    /**
+     * True identifier, become a string if it is an array
+     * (no need to be reactive)
+     */
+    const identifier = Array.isArray(identifiers) ? identifiers.join(delimiter) : identifiers;
+    /**
+     * Dictionary of items (to be filled)
+     */
+    const itemDictionary = ref({});
+    /**
+     * List of items
+     */
+    const itemList = computed(() => Object.values(itemDictionary.value));
+    /**
+     * Set records directly to the dictionary
+     *
+     * @param items
+     */
+    const setRecords = (items) => itemDictionary.value = items;
+    /**
+     * Empty the items dictionary
+     */
+    const resetRecords = () => itemDictionary.value = {};
+    /**
+     * Get record from object dictionary using identifier
+     *
+     * @param _arguments
+     */
+    const getRecord = (..._arguments) => {
+        const id = _arguments.join(delimiter);
+        return Object.prototype.hasOwnProperty.call(itemDictionary.value, id) ? itemDictionary.value[id] : undefined;
+    };
+    /**
+     * Multiple getRecord
+     *
+     * @param idsArray
+     */
+    const getRecords = (idsArray = []) => idsArray
+        .map(id => Array.isArray(id) ? getRecord(...id) : getRecord(id))
+        .filter(Boolean);
+    /**
+     * Add item to the dictionary.
+     * If item already present, it will be overwritten
+     *
+     * @param itemData
+     */
+    const addRecord = (itemData) => itemDictionary.value[createIdentifier(itemData)] = itemData;
+    /**
+     * Add a list of items to the dictionary.
+     *
+     * @param itemsArray
+     */
+    const addRecords = (itemsArray) => {
+        for (let i = 0, len = itemsArray.length; i < len; i++) {
+            if (!itemsArray[i])
+                continue;
+            addRecord(itemsArray[i]);
+        }
+    };
+    /**
+     * Edit item,
+     * If item not present, it will be ignored
+     * If it is present, it will be merged with the new partial data
+     * WARNING: If identifier change, it does NOT automatically update the dictionary id.
+     *
+     * @param data
+     * @param id - WARNING: needed createIdentifier if identifiers is array
+     * @param create - if true it will be added if not present
+     */
+    const editRecord = (data = {}, id, create = true) => {
+        // If not specified, it will be inferred
+        const _inferredId = id ?? data[identifier];
+        // if multiple identifiers, then they need to be joined\translated
+        const _id = Array.isArray(_inferredId) ? _inferredId.join(delimiter) : _inferredId;
+        // if NOT forced to create and NOT found: error
+        if (!create &&
+            (!id || !Object.prototype.hasOwnProperty.call(itemDictionary.value, _id))) {
+            // eslint-disable-next-line no-console
+            console.error("storeDataStructure - data not found", data);
+            return;
+        }
+        // Replace data if already present
+        itemDictionary.value[_id] = {
+            ...itemDictionary.value[_id],
+            ...data
+        };
+    };
+    /**
+     * Same as addRecords but with editRecord
+     *
+     * @param itemsArray
+     */
+    const editRecords = (itemsArray) => {
+        for (let i = 0, len = itemsArray.length; i < len; i++) {
+            if (!itemsArray[i])
+                continue;
+            editRecord(itemsArray[i]);
+        }
+    };
+    /**
+     * Delete record
+     *
+     * @param id
+     */
+    const deleteRecord = (id) => getRecord(id) && delete itemDictionary.value[id];
+    /**
+     * Selected ID
+     */
+    const selectedIdentifier = ref();
+    /**
+     * Selected item (by @{selectedIdentifier})
+     * Can have 2 uses:
+     *  - List mode: Show in modal or operations that require the details (example items in a table)
+     *  - Target mode: a detail page or a form to edit the selected item (example item in a dedicated detail page)
+     */
+    const selectedRecord = computed(() => selectedIdentifier.value && itemDictionary.value[selectedIdentifier.value]);
+    /**
+     * ---------------------------------- OFFLINE PAGINATION ------------------------------------
+     */
+    /**
+     * Current selected page (start with 1)
+     */
+    const pageCurrent = ref(1);
+    /**
+     * How many items in page
+     */
+    const pageSize = ref(10);
+    /**
+     * How many pages exist
+     */
+    const pageTotal = computed(() => Math.ceil(itemList.value.length / pageSize.value));
+    /**
+     * First item of the current page
+     */
+    const pageOffset = computed(() => pageSize.value * (pageCurrent.value - 1));
+    /**
+     * Items shown in current page
+     */
+    const pageItemList = computed(() => itemList.value.slice(pageOffset.value, pageOffset.value + pageSize.value));
+    /**
+     * ----------------------------- hasMany & belongsTo relationships -----------------------------
+     */
+    /**
+     * If the item has a parent, here will be stored a "parent hasMany" relation
+     */
+    const parentHasMany = ref({});
+    /**
+     *
+     * @param parentId
+     * @param childId
+     */
+    const addToParent = (parentId, childId) => {
+        if (!parentHasMany.value[parentId])
+            parentHasMany.value[parentId] = [];
+        parentHasMany.value[parentId].push(childId);
+    };
+    /**
+     *
+     * @param parentId
+     * @param childId
+     */
+    const removeFromParent = (parentId, childId) => parentHasMany.value[parentId] =
+        parentHasMany.value[parentId]
+            .filter((id) => id !== childId);
+    /**
+     *
+     * @param parentId
+     */
+    const removeDuplicateChildren = (parentId) => parentHasMany.value[parentId] = [...new Set(parentHasMany.value[parentId])];
+    /**
+     * Get all records ID by parent and use them to retrieve the complete dictionary
+     * @param parentId
+     */
+    const getRecordsByParent = (parentId) => {
+        const result = {};
+        if (!parentId || !parentHasMany.value[parentId])
+            return result;
+        for (const key of parentHasMany.value[parentId]) {
+            const record = getRecord(key);
+            if (record)
+                result[key] = record;
+        }
+        return result;
+    };
+    /**
+     * Same as above but with array result
+     * @param parentId
+     */
+    const getListByParent = (parentId) => Object.values(getRecordsByParent(parentId));
+    return {
+        createIdentifier,
+        identifier,
+        itemDictionary,
+        itemList,
+        setRecords,
+        resetRecords,
+        getRecord,
+        getRecords,
+        addRecord,
+        addRecords,
+        editRecord,
+        editRecords,
+        deleteRecord,
+        selectedIdentifier,
+        selectedRecord,
+        // Pagination
+        pageCurrent,
+        pageSize,
+        pageTotal,
+        pageOffset,
+        pageItemList,
+        // belongsTo relationship
+        parentHasMany,
+        addToParent,
+        removeFromParent,
+        removeDuplicateChildren,
+        getRecordsByParent,
+        getListByParent,
+    };
+};
+//# sourceMappingURL=structureDataManagement.js.map

package/dist/composables/structureDataManagement.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"structureDataManagement.js","sourceRoot":"","sources":["../../src/composables/structureDataManagement.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,KAAK,CAAA;AAGnC,MAAM,CAAC,MAAM,0BAA0B,GAAG;AAUxC,wEAAwE;AACxE,cAAiC,IAAI;AACrC,qCAAqC;AACrC,SAAS,GAAG,GAAG,EACf,EAAE;IAEF;;;;OAIG;IAEH,MAAM,gBAAgB,GAAG,CAAQ,QAAW,EAAE,iBAAqC,EAAK,EAAE;QACtF,MAAM,YAAY,GAAG,iBAAiB,IAAI,WAAW,CAAC;QACtD,IAAI,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC;YAC7B,OAAO,YAAY,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAc,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAM,CAAA;QACjF,OAAO,QAAQ,CAAC,UAAqB,CAAM,CAAA;IAC7C,CAAC,CAAA;IAEH;;;OAGG;IACH,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,WAAW,CAAA;IAEzF;;OAEG;IACH,MAAM,cAAc,GAAG,GAAG,CAAC,EAAkB,CAAC,CAAC;IAE/C;;OAEG;IACH,MAAM,QAAQ,GAAG,QAAQ,CAAM,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,KAAqB,CAAC,CAAC,CAAC;IAE1F;;;;OAIG;IACH,MAAM,UAAU,GAAG,CAAC,KAAmB,EAAgB,EAAE,CACvD,cAAc,CAAC,KAAK,GAAG,KAAK,CAAA;IAE9B;;OAEG;IACH,MAAM,YAAY,GAAG,GAAG,EAAE,CACxB,cAAc,CAAC,KAAK,GAAG,EAAE,CAAC;IAE5B;;;;OAIG;IACH,MAAM,SAAS,GAAG,CAAC,GAAG,UAA6B,EAAiB,EAAE;QACpE,MAAM,EAAE,GAAG,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACtC,OAAO,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,CAAE,cAAc,CAAC,KAAsB,CAAC,EAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACtI,CAAC,CAAA;IAED;;;;OAIG;IACH,MAAM,UAAU,GAAG,CAAC,WAAsC,EAAE,EAAE,EAAE,CAC9D,QAAQ;SACL,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;SAC/D,MAAM,CAAC,OAAO,CAAQ,CAAC;IAE5B;;;;;OAKG;IACH,MAAM,SAAS,GAAG,CAAC,QAAW,EAAE,EAAE,CAC/B,cAAc,CAAC,KAAsB,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,GAAG,QAAQ,CAAA;IAE/E;;;;OAIG;IACH,MAAM,UAAU,GAAG,CAAC,UAA6B,EAAE,EAAE;QACnD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;YACtD,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;gBAChB,SAAS;YACX,SAAS,CAAC,UAAU,CAAC,CAAC,CAAE,CAAC,CAAA;QAC3B,CAAC;IACH,CAAC,CAAA;IAED;;;;;;;;;OASG;IACH,MAAM,UAAU,GAAG,CAAC,OAAmB,EAAE,EAAE,EAAY,EAAE,MAAM,GAAG,IAAI,EAAE,EAAE;QACxE,wCAAwC;QACxC,MAAM,WAAW,GAAG,EAAE,IAAI,IAAI,CAAC,UAAqB,CAAY,CAAA;QAChE,kEAAkE;QAClE,MAAM,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAM,CAAC,CAAC,CAAC,WAAW,CAAA;QAEvF,+CAA+C;QAC/C,IACE,CAAC,MAAM;YACP,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,EACzE,CAAC;YACD,sCAAsC;YACtC,OAAO,CAAC,KAAK,CAAC,qCAAqC,EAAE,IAAI,CAAC,CAAC;YAC3D,OAAM;QACR,CAAC;QAED,kCAAkC;QACjC,cAAc,CAAC,KAAsB,CAAC,GAAG,CAAC,GAAG;YAC5C,GAAI,cAAc,CAAC,KAAsB,CAAC,GAAG,CAAC;YAC9C,GAAG,IAAI;SACR,CAAA;IACH,CAAC,CAAA;IAED;;;;OAIG;IACH,MAAM,WAAW,GAAG,CAAC,UAA6B,EAAE,EAAE;QACpD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;YACtD,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;gBAChB,SAAS;YACX,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAA;QAC3B,CAAC;IACH,CAAC,CAAA;IAED;;;;OAIG;IACH,MAAM,YAAY,GAAG,CAAC,EAAK,EAAE,EAAE,CAE7B,SAAS,CAAC,EAAE,CAAC,IAAI,OAAQ,cAAc,CAAC,KAAsB,CAAC,EAAE,CAAC,CAAC;IAErE;;OAEG;IACH,MAAM,kBAAkB,GAAG,GAAG,EAAK,CAAC;IAEpC;;;;;OAKG;IACH,MAAM,cAAc,GAAG,QAAQ,CAAgB,GAAG,EAAE,CAClD,kBAAkB,CAAC,KAAK,IAAK,cAAc,CAAC,KAAsB,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAC7F,CAAC;IAEF;;OAEG;IAEH;;OAEG;IACH,MAAM,WAAW,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;IAE3B;;OAEG;IACH,MAAM,QAAQ,GAAG,GAAG,CAAC,EAAE,CAAC,CAAC;IAEzB;;OAEG;IACH,MAAM,SAAS,GAAG,QAAQ,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IAEpF;;OAEG;IACH,MAAM,UAAU,GAAG,QAAQ,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,KAAK,GAAG,CAAC,WAAW,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;IAE5E;;OAEG;IACH,MAAM,YAAY,GAAG,QAAQ,CAAC,GAAG,EAAE,CACjC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,CAC1E,CAAA;IAGD;;OAEG;IAGH;;OAEG;IACH,MAAM,aAAa,GAAG,GAAG,CAAC,EAAoC,CAAC,CAAC;IAEhE;;;;OAIG;IACH,MAAM,WAAW,GAAG,CAAC,QAAW,EAAE,OAA0B,EAAE,EAAE;QAC9D,IAAI,CAAE,aAAa,CAAC,KAA4B,CAAC,QAAQ,CAAC;YACvD,aAAa,CAAC,KAAwC,CAAC,QAAQ,CAAC,GAAG,EAAyB,CAAA;QAC9F,aAAa,CAAC,KAAwC,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IACjF,CAAC,CAAA;IAED;;;;OAIG;IACH,MAAM,gBAAgB,GAAG,CAAC,QAAW,EAAE,OAA0B,EAAE,EAAE,CAClE,aAAa,CAAC,KAAwC,CAAC,QAAQ,CAAC;QAC9D,aAAa,CAAC,KAAwC,CAAC,QAAQ,CAAC;aAC9D,MAAM,CAAC,CAAC,EAAqB,EAAE,EAAE,CAAC,EAAE,KAAK,OAAO,CAAC,CAAA;IAExD;;;OAGG;IACH,MAAM,uBAAuB,GAAG,CAAC,QAAW,EAAE,EAAE,CAC7C,aAAa,CAAC,KAAwC,CAAC,QAAQ,CAAC,GAAG,CAAE,GAAG,IAAI,GAAG,CAAE,aAAa,CAAC,KAAwC,CAAC,QAAQ,CAAC,CAAC,CAAE,CAAA;IAEvJ;;;OAGG;IACH,MAAM,kBAAkB,GAAG,CAAC,QAAY,EAAgB,EAAE;QACxD,MAAM,MAAM,GAAG,EAAkB,CAAC;QAClC,IAAI,CAAC,QAAQ,IAAI,CAAE,aAAa,CAAC,KAA4B,CAAC,QAAQ,CAAC;YACrE,OAAO,MAAM,CAAC;QAChB,KAAK,MAAM,GAAG,IAAK,aAAa,CAAC,KAA8B,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC1E,MAAM,MAAM,GAAG,SAAS,CAAC,GAAQ,CAAC,CAAA;YAClC,IAAI,MAAM;gBACR,MAAM,CAAC,GAAQ,CAAC,GAAG,MAAM,CAAA;QAC7B,CAAC;QACD,OAAO,MAAM,CAAA;IACf,CAAC,CAAA;IAED;;;OAGG;IACH,MAAM,eAAe,GAAG,CAAC,QAAY,EAAO,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC,CAAC;IAE3F,OAAO;QACL,gBAAgB;QAChB,UAAU;QACV,cAAc;QACd,QAAQ;QACR,UAAU;QACV,YAAY;QACZ,SAAS;QACT,UAAU;QACV,SAAS;QACT,UAAU;QACV,UAAU;QACV,WAAW;QACX,YAAY;QACZ,kBAAkB;QAClB,cAAc;QAEd,aAAa;QACb,WAAW;QACX,QAAQ;QACR,SAAS;QACT,UAAU;QACV,YAAY;QAEZ,yBAAyB;QACzB,aAAa;QACb,WAAW;QACX,gBAAgB;QAChB,uBAAuB;QACvB,kBAAkB;QAClB,eAAe;KAChB,CAAA;AACH,CAAC,CAAC"}

package/dist/composables/structureFormValidation.js

@@ -0,0 +1,3 @@
+"use strict";
+// TODO with zod
+//# sourceMappingURL=structureFormValidation.js.map

package/dist/composables/structureFormValidation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"structureFormValidation.js","sourceRoot":"","sources":["../../src/composables/structureFormValidation.ts"],"names":[],"mappings":";AAAA,gBAAgB"}