wraplet 0.7.0

package/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2024-present Łukasz Zaroda
+
+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/AbstractWraplet.d.ts

@@ -0,0 +1,16 @@
+import { WrapletChildrenMap } from "./types/WrapletChildrenMap";
+import { WrapletChildren } from "./types/WrapletChildren";
+import { Wraplet } from "./types/Wraplet";
+import { DeepWriteable } from "./types/Utils";
+export declare abstract class AbstractWraplet<T extends WrapletChildrenMap = {}, E extends Element = Element> implements Wraplet {
+    protected element: E;
+    isWraplet: true;
+    protected children: WrapletChildren<T>;
+    protected static debug: boolean;
+    constructor(element: E, mapAlterCallback?: ((map: DeepWriteable<T>) => void) | null);
+    protected abstract defineChildrenMap(): T;
+    protected instantiateChildren(map: T): WrapletChildren<T>;
+    protected createWraplet(wrapletClass: new (...args: any[]) => Wraplet, childElement: Element, args?: unknown[]): Wraplet;
+    private childTypeGuard;
+    protected static createWraplets<T extends AbstractWraplet<any> = never>(document: Document, additional_args: unknown[] | undefined, selector: string): T[];
+}

package/dist/errors.d.ts

@@ -0,0 +1,4 @@
+export declare class MissingRequiredChildError extends Error {
+}
+export declare class MapError extends Error {
+}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { AbstractWraplet } from "./AbstractWraplet";
+export { WrapletChildrenMap } from "./types/WrapletChildrenMap";
+import "./types/global";

package/dist/index.js

@@ -0,0 +1,2 @@
+!function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t():"function"==typeof define&&define.amd?define([],t):"object"==typeof exports?exports.wraplet=t():e.wraplet=t()}(self,(()=>(()=>{"use strict";var e={d:(t,r)=>{for(var n in r)e.o(r,n)&&!e.o(t,n)&&Object.defineProperty(t,n,{enumerable:!0,get:r[n]})},o:(e,t)=>Object.prototype.hasOwnProperty.call(e,t),r:e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})}},t={};e.r(t),e.d(t,{AbstractWraplet:()=>o});class r extends Error{}class n extends Error{}class o{constructor(e,t=null){this.element=e,this.isWraplet=!0;const r=this.defineChildrenMap();t&&t(r),this.children=this.instantiateChildren(r),this.element.wraplets||(this.element.wraplets=[]),this.element.wraplets.push(this)}instantiateChildren(e){const t={};for(const o in e){const s=e[o],i=s.selector,l=s.Class,a=s.args||[],c=s.multiple,u=s.required;if(!i){if(u)throw new n(`${this.constructor.name}: Child "${o}" cannot at the same be required and have no selector.`);t[o]=c?[]:null;continue}const h=this.element.querySelectorAll(i);if(0===h.length){if(u)throw new r(`${this.constructor.name}: Couldn't find an element for the wraplet "${o}". Selector used: "${i}".`);this.constructor.debug&&console.log(`${this.constructor.name}: Optional child '${o}' has not been found. Selector used: "${i}"`),t[o]=c?[]:null;continue}const d=[];for(const e of h)if(d.push(this.createWraplet(l,e,a)),!c)break;const f=c?d:d[0];if(c&&!f&&this.constructor.debug&&console.log(`${this.constructor.name}: no items for the multiple child '${o}' have been found. Selector used: "${i}"`),!this.childTypeGuard(f,o)){if(void 0===f)throw new Error(`${this.constructor.name}: Couldn't intantionate the "${o}" child. Selector used: "${i}".`);throw new Error(`${this.constructor.name}: Child value doesn't match the map. Value: ${f}. Expected: ${e[o].Class.name}`)}t[o]=f}return t}createWraplet(e,t,r=[]){return new e(...[t,...r])}childTypeGuard(e,t){const r=this.defineChildrenMap(),n=r[t].Class,o=r[t].required;return r[t].multiple?!!Array.isArray(e)&&(!o||e.every((e=>e instanceof n))):o?e instanceof n:e instanceof n||null===e}static createWraplets(e,t=[],r){if(this instanceof o)throw new Error("You cannot instantiate an abstract class.");const n=[],s=e.querySelectorAll(r);for(const e of s)n.push(new this(e,...t));return n}}return o.debug=!1,t})()));
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","mappings":"CAAA,SAA2CA,EAAMC,GAC1B,iBAAZC,SAA0C,iBAAXC,OACxCA,OAAOD,QAAUD,IACQ,mBAAXG,QAAyBA,OAAOC,IAC9CD,OAAO,GAAIH,GACe,iBAAZC,QACdA,QAAiB,QAAID,IAErBD,EAAc,QAAIC,GACnB,CATD,CASGK,MAAM,I,mBCRT,IAAIC,EAAsB,CCA1BA,EAAwB,CAACL,EAASM,KACjC,IAAI,IAAIC,KAAOD,EACXD,EAAoBG,EAAEF,EAAYC,KAASF,EAAoBG,EAAER,EAASO,IAC5EE,OAAOC,eAAeV,EAASO,EAAK,CAAEI,YAAY,EAAMC,IAAKN,EAAWC,IAE1E,ECNDF,EAAwB,CAACQ,EAAKC,IAAUL,OAAOM,UAAUC,eAAeC,KAAKJ,EAAKC,GCClFT,EAAyBL,IACH,oBAAXkB,QAA0BA,OAAOC,aAC1CV,OAAOC,eAAeV,EAASkB,OAAOC,YAAa,CAAEC,MAAO,WAE7DX,OAAOC,eAAeV,EAAS,aAAc,CAAEoB,OAAO,GAAO,G,2CCLvD,MAAMC,UAAkCC,OAExC,MAAMC,UAAiBD,OCDvB,MAAME,EACT,WAAAC,CAAYC,EAASC,EAAmB,MACpCC,KAAKF,QAAUA,EACfE,KAAKC,WAAY,EACjB,MAAMC,EAAMF,KAAKG,oBACbJ,GACAA,EAAiBG,GAErBF,KAAKI,SAAWJ,KAAKK,oBAAoBH,GACpCF,KAAKF,QAAQQ,WACdN,KAAKF,QAAQQ,SAAW,IAE5BN,KAAKF,QAAQQ,SAASC,KAAKP,KAC/B,CACA,mBAAAK,CAAoBH,GAChB,MAAME,EAAW,CAAC,EAClB,IAAK,MAAMI,KAAMN,EAAK,CAClB,MAAMO,EAAOP,EAAIM,GACXE,EAAWD,EAAKC,SAChBC,EAAeF,EAAKG,MACpBC,EAAOJ,EAAKI,MAAQ,GACpBC,EAAWL,EAAKK,SAChBC,EAAaN,EAAKO,SACxB,IAAKN,EAAU,CACX,GAAIK,EACA,MAAM,IAAIpB,EAAS,GAAGK,KAAKH,YAAYoB,gBAAgBT,2DAE3DJ,EAASI,GAAMM,EACT,GACA,KACN,QACJ,CACA,MAAMI,EAAgBlB,KAAKF,QAAQqB,iBAAiBT,GACpD,GAA6B,IAAzBQ,EAAcE,OAAc,CAC5B,GAAIL,EACA,MAAM,IAAItB,EAA0B,GAAGO,KAAKH,YAAYoB,mDAAmDT,uBAAwBE,OAEnIV,KAAKH,YAAYwB,OACjBC,QAAQC,IAAI,GAAGvB,KAAKH,YAAYoB,yBAAyBT,0CAA2CE,MAExGN,EAASI,GAAMM,EACT,GACA,KACN,QACJ,CACA,MAAMU,EAAe,GACrB,IAAK,MAAMC,KAAgBP,EAEvB,GADAM,EAAajB,KAAKP,KAAK0B,cAAcf,EAAcc,EAAcZ,KAC5DC,EACD,MAGR,MAAMtB,EAAQsB,EACRU,EACAA,EAAa,GAInB,GAHIV,IAAatB,GAASQ,KAAKH,YAAYwB,OACvCC,QAAQC,IAAI,GAAGvB,KAAKH,YAAYoB,0CAA0CT,uCAAwCE,OAEjHV,KAAK2B,eAAenC,EAAOgB,GAAK,CACjC,QAAqB,IAAVhB,EACP,MAAM,IAAIE,MAAM,GAAGM,KAAKH,YAAYoB,oCAAoCT,6BAA8BE,OAE1G,MAAM,IAAIhB,MAAM,GAAGM,KAAKH,YAAYoB,mDAAmDzB,gBAAoBU,EAAIM,GAAW,MAAES,OAChI,CACAb,EAASI,GAAMhB,CACnB,CAEA,OAAOY,CACX,CACA,aAAAsB,CAAcf,EAAcc,EAAcZ,EAAO,IAC7C,OAAO,IAAIF,KAAgB,CAAKc,KAAkBZ,GACtD,CACA,cAAAc,CAAeC,EAAUpB,GACrB,MAAMN,EAAMF,KAAKG,oBACXS,EAAQV,EAAIM,GAAII,MAChBG,EAAab,EAAIM,GAAIQ,SAE3B,OADmBd,EAAIM,GAAIM,WAEPe,MAAMC,QAAQF,MAI1Bb,GACOa,EAASG,OAAOvC,GAAUA,aAAiBoB,KAItDG,EACOa,aAAoBhB,EAExBgB,aAAoBhB,GAAsB,OAAbgB,CACxC,CAIA,qBAAOI,CAAeC,EAAUC,EAAkB,GAAIxB,GAClD,GAAIV,gBAAgBJ,EAChB,MAAM,IAAIF,MAAM,6CAEpB,MAAMyC,EAAS,GACTC,EAAgBH,EAASd,iBAAiBT,GAChD,IAAK,MAAMZ,KAAWsC,EAClBD,EAAO5B,KAAK,IAAIP,KAAKF,KAAYoC,IAErC,OAAOC,CACX,E,OAEJvC,EAAgByB,OAAQ,E","sources":["webpack://wraplet/webpack/universalModuleDefinition","webpack://wraplet/webpack/bootstrap","webpack://wraplet/webpack/runtime/define property getters","webpack://wraplet/webpack/runtime/hasOwnProperty shorthand","webpack://wraplet/webpack/runtime/make namespace object","webpack://wraplet/./src/errors.ts","webpack://wraplet/./src/AbstractWraplet.ts"],"sourcesContent":["(function webpackUniversalModuleDefinition(root, factory) {\n\tif(typeof exports === 'object' && typeof module === 'object')\n\t\tmodule.exports = factory();\n\telse if(typeof define === 'function' && define.amd)\n\t\tdefine([], factory);\n\telse if(typeof exports === 'object')\n\t\texports[\"wraplet\"] = factory();\n\telse\n\t\troot[\"wraplet\"] = factory();\n})(self, () => {\nreturn ","// The require scope\nvar __webpack_require__ = {};\n\n","// define getter functions for harmony exports\n__webpack_require__.d = (exports, definition) => {\n\tfor(var key in definition) {\n\t\tif(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) {\n\t\t\tObject.defineProperty(exports, key, { enumerable: true, get: definition[key] });\n\t\t}\n\t}\n};","__webpack_require__.o = (obj, prop) => (Object.prototype.hasOwnProperty.call(obj, prop))","// define __esModule on exports\n__webpack_require__.r = (exports) => {\n\tif(typeof Symbol !== 'undefined' && Symbol.toStringTag) {\n\t\tObject.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });\n\t}\n\tObject.defineProperty(exports, '__esModule', { value: true });\n};","export class MissingRequiredChildError extends Error {\n}\nexport class MapError extends Error {\n}\n","import { MapError, MissingRequiredChildError } from \"./errors\";\nexport class AbstractWraplet {\n    constructor(element, mapAlterCallback = null) {\n        this.element = element;\n        this.isWraplet = true;\n        const map = this.defineChildrenMap();\n        if (mapAlterCallback) {\n            mapAlterCallback(map);\n        }\n        this.children = this.instantiateChildren(map);\n        if (!this.element.wraplets) {\n            this.element.wraplets = [];\n        }\n        this.element.wraplets.push(this);\n    }\n    instantiateChildren(map) {\n        const children = {};\n        for (const id in map) {\n            const item = map[id];\n            const selector = item.selector;\n            const wrapletClass = item.Class;\n            const args = item.args || [];\n            const multiple = item.multiple;\n            const isRequired = item.required;\n            if (!selector) {\n                if (isRequired) {\n                    throw new MapError(`${this.constructor.name}: Child \"${id}\" cannot at the same be required and have no selector.`);\n                }\n                children[id] = multiple\n                    ? []\n                    : null;\n                continue;\n            }\n            const childElements = this.element.querySelectorAll(selector);\n            if (childElements.length === 0) {\n                if (isRequired) {\n                    throw new MissingRequiredChildError(`${this.constructor.name}: Couldn't find an element for the wraplet \"${id}\". Selector used: \"${selector}\".`);\n                }\n                if (this.constructor.debug) {\n                    console.log(`${this.constructor.name}: Optional child '${id}' has not been found. Selector used: \"${selector}\"`);\n                }\n                children[id] = multiple\n                    ? []\n                    : null;\n                continue;\n            }\n            const childWraplet = [];\n            for (const childElement of childElements) {\n                childWraplet.push(this.createWraplet(wrapletClass, childElement, args));\n                if (!multiple) {\n                    break;\n                }\n            }\n            const value = multiple\n                ? childWraplet\n                : childWraplet[0];\n            if (multiple && !value && this.constructor.debug) {\n                console.log(`${this.constructor.name}: no items for the multiple child '${id}' have been found. Selector used: \"${selector}\"`);\n            }\n            if (!this.childTypeGuard(value, id)) {\n                if (typeof value === \"undefined\") {\n                    throw new Error(`${this.constructor.name}: Couldn't intantionate the \"${id}\" child. Selector used: \"${selector}\".`);\n                }\n                throw new Error(`${this.constructor.name}: Child value doesn't match the map. Value: ${value}. Expected: ${map[id][\"Class\"].name}`);\n            }\n            children[id] = value;\n        }\n        // Now we should have all properties set, so let's assert the final form.\n        return children;\n    }\n    createWraplet(wrapletClass, childElement, args = []) {\n        return new wrapletClass(...[...[childElement], ...args]);\n    }\n    childTypeGuard(variable, id) {\n        const map = this.defineChildrenMap();\n        const Class = map[id].Class;\n        const isRequired = map[id].required;\n        const isMultiple = map[id].multiple;\n        if (isMultiple) {\n            const isArray = Array.isArray(variable);\n            if (!isArray) {\n                return false;\n            }\n            if (isRequired) {\n                return variable.every((value) => value instanceof Class);\n            }\n            return true;\n        }\n        if (isRequired) {\n            return variable instanceof Class;\n        }\n        return variable instanceof Class || variable === null;\n    }\n    // We can afford \"any\" here because this method is only for the external usage, and external\n    // callers don't need to know what map is the current wraplet using, as it's its internal\n    // matter.\n    static createWraplets(document, additional_args = [], selector) {\n        if (this instanceof AbstractWraplet) {\n            throw new Error(\"You cannot instantiate an abstract class.\");\n        }\n        const result = [];\n        const foundElements = document.querySelectorAll(selector);\n        for (const element of foundElements) {\n            result.push(new this(element, ...additional_args));\n        }\n        return result;\n    }\n}\nAbstractWraplet.debug = false;\n"],"names":["root","factory","exports","module","define","amd","self","__webpack_require__","definition","key","o","Object","defineProperty","enumerable","get","obj","prop","prototype","hasOwnProperty","call","Symbol","toStringTag","value","MissingRequiredChildError","Error","MapError","AbstractWraplet","constructor","element","mapAlterCallback","this","isWraplet","map","defineChildrenMap","children","instantiateChildren","wraplets","push","id","item","selector","wrapletClass","Class","args","multiple","isRequired","required","name","childElements","querySelectorAll","length","debug","console","log","childWraplet","childElement","createWraplet","childTypeGuard","variable","Array","isArray","every","createWraplets","document","additional_args","result","foundElements"],"sourceRoot":""}

package/dist/types/Utils.d.ts

@@ -0,0 +1,9 @@
+export type InstantiableReturnType<T> = T extends {
+    new (...args: any[]): infer R;
+} ? R : never;
+export type Nullable<T> = {
+    [K in keyof T]: T[K] | null;
+};
+export type DeepWriteable<T> = {
+    -readonly [P in keyof T]: DeepWriteable<T[P]>;
+};

package/dist/types/Wraplet.d.ts

@@ -0,0 +1,3 @@
+export interface Wraplet {
+    isWraplet: true;
+}

package/dist/types/WrapletChildDefinition.d.ts

@@ -0,0 +1,10 @@
+import { AbstractWraplet } from "../AbstractWraplet";
+export type WrapletChildDefinition<T extends AbstractWraplet = AbstractWraplet> = {
+    selector?: string;
+    Class: {
+        new (...args: any[]): T;
+    };
+    required: boolean;
+    multiple: boolean;
+    args?: unknown[];
+};

package/dist/types/WrapletChildren.d.ts

@@ -0,0 +1,5 @@
+import { WrapletChildrenMap } from "./WrapletChildrenMap";
+import { InstantiableReturnType } from "./Utils";
+export type WrapletChildren<T extends WrapletChildrenMap> = {
+    [id in keyof T]: T[id]["multiple"] extends true ? InstantiableReturnType<T[id]["Class"]>[] : T[id]["required"] extends true ? InstantiableReturnType<T[id]["Class"]> : InstantiableReturnType<T[id]["Class"]> | null;
+};

package/dist/types/WrapletChildrenMap.d.ts

@@ -0,0 +1,4 @@
+import { WrapletChildDefinition } from "./WrapletChildDefinition";
+export type WrapletChildrenMap = {
+    [id: string]: WrapletChildDefinition;
+};

package/dist/types/global.d.ts

@@ -0,0 +1,6 @@
+import { Wraplet } from "./Wraplet";
+declare global {
+    interface Element {
+        wraplets?: Wraplet[];
+    }
+}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "wraplet",
+  "version": "0.7.0",
+  "description": "",
+  "main": "dist/index.js",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/lukasz-zaroda/wraplet.git"
+  },
+  "files": ["dist"],
+  "scripts": {
+    "setup": "yarn install",
+    "build": "./node_modules/.bin/webpack --mode production --config ./webpack.config.js",
+    "dev:build": "./node_modules/.bin/webpack --mode development --config ./webpack.config.js",
+    "dev:watch": "./node_modules/.bin/webpack --mode development --watch --config ./webpack.config.js",
+    "lint": "tsc --noemit && npx eslint './src/**/*.ts' './tests/**/*.ts'",
+    "lint:fix": "npx eslint './src/**/*.ts' './tests/**/*.ts' --fix",
+    "tests": "jest"
+  },
+  "dependencies": {
+  },
+  "devDependencies": {
+    "typescript": "^5.5.4",
+    "ts-loader": "^9.5.1",
+    "@eslint/js": "^9.9.1",
+    "eslint": "^9.9.1",
+    "globals": "^15.9.0",
+    "typescript-eslint": "^8.2.0",
+    "webpack": "^5.94.0",
+    "webpack-cli": "^5.1.4",
+    "prettier": "^3.3.3",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "prettier-eslint": "^16.3.0",
+    "jest": "^29.7.0",
+    "jest-cli": "^29.7.0",
+    "ts-jest": "^29.2.5",
+    "@types/jest": "^29.5.12",
+    "jest-environment-jsdom": "^29.7.0"
+  }
+}