tkeron 3.0.0 → 3.0.1

package/changelog.md

@@ -1,3 +1,8 @@
+# v3.0.0
+
+- changed the argument input for the "dev" command to accept named arguments as well.
+- moved to version 3 due to issues with npm for pre-3 versions from the early phases of the project.
+
 # v0.0.10
 
 - fix positioned argument outputDir

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tkeron",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "Micro framework for developing web user interfaces with typescript.",
   "bin": {
     "tkeron": "dist/index.js",

package/dist/test/buildLoaders.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/test/buildLoaders.test.js

@@ -1,51 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const buildLoaders_1 = require("../buildLoaders");
-describe("buildLoaders", () => {
-    it("verify loaders", () => {
-        const expectedKeys = [
-            ".jpg",
-            ".png",
-            ".gif",
-            ".ico",
-            ".webp",
-            ".svg",
-            ".js",
-            ".css",
-            ".html",
-        ];
-        const expectedValues = [
-            "file",
-            "file",
-            "file",
-            "file",
-            "file",
-            "file",
-            "file",
-            "text",
-            "text",
-        ];
-        const keys = Object.keys(buildLoaders_1.buildLoaders);
-        const values = Object.values(buildLoaders_1.buildLoaders);
-        expect(keys).toMatchObject(expectedKeys);
-        expect(values).toMatchObject(expectedValues);
-    });
-    it("verify ext modules", () => {
-        const expected = `declare module '*.css';
-        declare module '*.gif';
-        declare module '*.html';
-        declare module '*.ico';
-        declare module '*.jpg';
-        declare module '*.js';
-        declare module '*.png';
-        declare module '*.svg';
-        declare module '*.webp';
-        `
-            .replace(/[\n\t]/g, " ")
-            .replace(/\s+/g, " ");
-        const extModules = (0, buildLoaders_1.getExtModules)()
-            .replace(/[\n\t]/g, " ")
-            .replace(/\s+/g, " ");
-        expect(extModules).toBe(expected);
-    });
-});

package/dist/test/bundleTs.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/test/bundleTs.test.js

@@ -1,91 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const promises_1 = require("fs/promises");
-const path_1 = require("path");
-const bundleTs_1 = require("../bundleTs");
-const fileExist_1 = require("../fileExist");
-const testDir = (0, path_1.join)(process.cwd(), "tmp_bundle_ts");
-const sumDir = (0, path_1.join)(testDir, "sum.ts");
-const minDir = (0, path_1.join)(testDir, "min.ts");
-const powDir = (0, path_1.join)(testDir, "pow.ts");
-const operationsDir = (0, path_1.join)(testDir, "operations.ts");
-const sumOutDir = (0, path_1.join)(testDir, "sum.js");
-const minOutDir = (0, path_1.join)(testDir, "min.js");
-const powOutDir = (0, path_1.join)(testDir, "pow.js");
-const operationsOutDir = (0, path_1.join)(testDir, "operations.js");
-beforeAll(async () => {
-    if (await (0, fileExist_1.fileExists)(testDir))
-        await (0, promises_1.rm)(testDir, { recursive: true, force: true });
-    await (0, promises_1.mkdir)(testDir);
-    const sum = `
-        //sum.ts
-        export const sum = (a: number, b: number) => a + b;
-    `;
-    const min = `
-        //min.ts
-        export const min = (a: number, b: number) => a - b;
-    `;
-    const pow = `
-        //pow.ts
-        export const pow = (a: number, b: number) => a ** b;
-    `;
-    const operations = `
-        //operations.ts
-        import {sum} from "./sum";
-        import {min} from "./min";
-        import {pow} from "./pow";
-
-        const a = 56;
-        const b = 12;
-
-        const sumResult = sum(a, b);
-        // const minResult = min(a, b);
-        const powResult = pow(a, b);
-
-        console\.log(\`a + b = $\{sumResult\}\`);
-        // console\.log(\`a - b = $\{minResult\}\`);
-        console\.log(\`a ** b = $\{powResult\}\`);
-    `;
-    (0, promises_1.writeFile)(sumDir, sum, { encoding: "utf-8" });
-    (0, promises_1.writeFile)(minDir, min, { encoding: "utf-8" });
-    (0, promises_1.writeFile)(powDir, pow, { encoding: "utf-8" });
-    (0, promises_1.writeFile)(operationsDir, operations, { encoding: "utf-8" });
-});
-afterAll(async () => {
-    await (0, promises_1.rm)(testDir, { recursive: true, force: true });
-});
-describe("bundleTs", () => {
-    it("bundle with undefined file", async () => {
-        const result = await (0, bundleTs_1.bundleTs)(undefined, sumOutDir).catch((_) => _);
-        expect(result).toBe("file must be defined");
-    });
-    it("bundle with undefined out file", async () => {
-        const result = await (0, bundleTs_1.bundleTs)(sumDir, undefined).catch((_) => _);
-        expect(result).toBe("outfile must be defined");
-    });
-    it("bundle with unexistent file", async () => {
-        const file = (0, path_1.join)(testDir, "unexistent.ts");
-        const result = await (0, bundleTs_1.bundleTs)(file, sumOutDir).catch((_) => _);
-        expect(result).toBe(`file ${file} doesn't exist`);
-    });
-    it("bundle sum function", async () => {
-        const result = await (0, bundleTs_1.bundleTs)(sumDir, sumOutDir);
-        const expected = "(()=>{var sum=(a,b)=>a+b;})();";
-        expect(result.trim()).toBe(expected);
-    });
-    it("bundle min function", async () => {
-        const result = await (0, bundleTs_1.bundleTs)(minDir, minOutDir);
-        const expected = "(()=>{var min=(a,b)=>a-b;})();";
-        expect(result.trim()).toBe(expected);
-    });
-    it("bundle pow function", async () => {
-        const result = await (0, bundleTs_1.bundleTs)(powDir, powOutDir);
-        const expected = "(()=>{var pow=(a,b)=>a**b;})();";
-        expect(result.trim()).toBe(expected);
-    });
-    it("bundle operations, expecting tree shaking", async () => {
-        const result = await (0, bundleTs_1.bundleTs)(operationsDir, operationsOutDir);
-        const expected = "(()=>{var sum=(a2,b2)=>a2+b2;var pow=(a2,b2)=>a2**b2;var a=56,b=12,sumResult=sum(a,b),powResult=pow(a,b);console.log(`a + b = ${sumResult}`);console.log(`a ** b = ${powResult}`);})();";
-        expect(result.trim()).toBe(expected);
-    });
-});

package/dist/test/cmdDev.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/test/cmdDev.test.js

@@ -1,50 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const cmdDev_1 = require("../cmdDev");
-describe("cmdDev", () => {
-    let app;
-    let expressGet;
-    let expressUse;
-    let expressListen;
-    let consoleLog;
-    let watchMock;
-    let defaultConsoleLog = console.log;
-    beforeEach(async () => {
-        expressGet = jest.fn();
-        expressUse = jest.fn();
-        expressListen = jest.fn();
-        consoleLog = jest.fn();
-        watchMock = jest.fn();
-        jest.mock('express', () => {
-            const originalModule = jest.requireActual('express');
-            return {
-                ...originalModule,
-                express: jest.fn(() => ({
-                    ...originalModule(),
-                    listen: expressListen,
-                    get: expressGet,
-                    use: expressUse
-                })),
-            };
-        });
-        const imported = await import('express');
-        app = imported.express();
-        console.log = consoleLog;
-        jest.mock("node-watch", () => watchMock);
-    });
-    afterEach(async () => {
-        jest.clearAllMocks();
-        console.log = defaultConsoleLog;
-    });
-    it("run dev", async () => {
-        const example = {
-            addr: "0.0.0.0",
-            outputDir: "out",
-            port: "3300",
-            sourceDir: "src"
-        };
-        const dev = await (0, cmdDev_1.cmdDev)(example);
-        dev.closeServer();
-        dev.closeWatcher();
-    });
-});

package/dist/test/errors.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/test/errors.test.js

@@ -1,29 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = require("path");
-const getDocument_1 = require("../getDocument");
-const front = (0, path_1.join)(__dirname, "..", "..", "front");
-const web = (0, path_1.join)(__dirname, "..", "..", "web");
-describe("jsdom errors", () => {
-    it("custom error", async () => {
-        const html = `
-            <!DOCTYPE html>
-            <html lang="en">
-            <head>
-                <meta charset="UTF-8" />
-                <meta http-equiv="X-UA-Compatible" content="IE=edge" />
-                <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-                <title>jsdom errors</title>
-                <script>
-                    throw "custom error";
-                </script>
-            </head>
-            <body></body>
-            </html>
-        `;
-        const { document } = (0, getDocument_1.getDocument)(html);
-        const node = document.querySelector(".tkeron_error");
-        expect(node).toBeTruthy();
-        expect(node.innerHTML).toMatch(/custom error/);
-    });
-});

package/dist/test/fileExist.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/test/fileExist.test.js

@@ -1,38 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = require("path");
-const fileExist_1 = require("../fileExist");
-describe("fileExists", () => {
-    it("unexistent file", async () => {
-        const path = (0, path_1.join)(__dirname, "..", "qwerty.asdf");
-        const result = await (0, fileExist_1.fileExists)(path);
-        expect(result).toBeFalsy();
-    });
-    it("existent directory", async () => {
-        const path = (0, path_1.join)(__dirname, "..");
-        const result = await (0, fileExist_1.fileExists)(path);
-        expect(result).toBeTruthy();
-    });
-    it("unexistent directory", async () => {
-        const path = (0, path_1.join)(__dirname, "..", "qwerty");
-        const result = await (0, fileExist_1.fileExists)(path);
-        expect(result).toBeFalsy();
-    });
-});
-describe("fileExistsSync", () => {
-    it("unexistent file", () => {
-        const path = (0, path_1.join)(__dirname, "..", "qwerty.asdf");
-        const result = (0, fileExist_1.fileExistsSync)(path);
-        expect(result).toBeFalsy();
-    });
-    it("existent directory", () => {
-        const path = (0, path_1.join)(__dirname, "..");
-        const result = (0, fileExist_1.fileExistsSync)(path);
-        expect(result).toBeTruthy();
-    });
-    it("unexistent directory", () => {
-        const path = (0, path_1.join)(__dirname, "..", "qwerty");
-        const result = (0, fileExist_1.fileExistsSync)(path);
-        expect(result).toBeFalsy();
-    });
-});

package/dist/test/getRandomValues.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/test/getRandomValues.test.js

@@ -1,35 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const crypto_1 = require("../jsDom/crypto");
-describe("getRandomValues", () => {
-    it("random Int8Array", () => {
-        const result = (0, crypto_1.getRandomValues)(new Int8Array(5));
-        expect(result).toBeTruthy();
-        expect(result).toHaveLength(5);
-    });
-    it("random Uint8Array", () => {
-        const result = (0, crypto_1.getRandomValues)(new Uint8Array(5));
-        expect(result).toBeTruthy();
-        expect(result).toHaveLength(5);
-    });
-    it("random Int16Array", () => {
-        const result = (0, crypto_1.getRandomValues)(new Int16Array(5));
-        expect(result).toBeTruthy();
-        expect(result).toHaveLength(5);
-    });
-    it("random Uint16Array", () => {
-        const result = (0, crypto_1.getRandomValues)(new Uint16Array(5));
-        expect(result).toBeTruthy();
-        expect(result).toHaveLength(5);
-    });
-    it("random Int32Array", () => {
-        const result = (0, crypto_1.getRandomValues)(new Int32Array(5));
-        expect(result).toBeTruthy();
-        expect(result).toHaveLength(5);
-    });
-    it("random Uint32Array", () => {
-        const result = (0, crypto_1.getRandomValues)(new Uint32Array(5));
-        expect(result).toBeTruthy();
-        expect(result).toHaveLength(5);
-    });
-});

package/dist/test/logs.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/test/logs.test.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const jsdom_1 = require("jsdom");
-const generateItems_1 = require("../generateItems");
-const logs_1 = require("../jsDom/logs");
-describe("logs", () => {
-    it("handleLogs", async () => {
-        const logs = ["log 1", "log B", "log 3"];
-        const { window } = new jsdom_1.JSDOM((0, generateItems_1.pageItem)("test").html, {
-            runScripts: "dangerously",
-            resources: "usable",
-        });
-        const { document } = window;
-        await new Promise((ok) => document.addEventListener("load", ok));
-        (0, logs_1.handleLogs)(logs, document);
-        const logNodes = document.querySelectorAll(".tkeron_log");
-        expect(logNodes).toHaveLength(3);
-        const [log1, log2, log3] = logNodes;
-        expect(log1.innerHTML).toBe(logs[0]);
-        expect(log2.innerHTML).toBe(logs[1]);
-        expect(log3.innerHTML).toBe(logs[2]);
-    });
-});

package/dist/test/main.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/test/main.test.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const promises_1 = require("fs/promises");
-const main_1 = require("../main");
-beforeAll(async () => {
-    await (0, promises_1.mkdir)("front", { recursive: true });
-});
-afterAll(async () => {
-    await (0, promises_1.rm)("front", { force: true, recursive: true });
-});
-describe("main", () => {
-    it("command build", () => {
-        (0, main_1.main)("tk", ["build"]);
-    });
-});

package/dist/test/pathToUrlResource.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/test/pathToUrlResource.test.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = require("path");
-const pathToUrlResource_1 = require("../pathToUrlResource");
-describe("pathToUrlResource", () => {
-    it("test dir from 1 level up", async () => {
-        const result = (0, pathToUrlResource_1.pathToUrlResource)(__dirname, (0, path_1.join)(__dirname, ".."));
-        expect(result).toMatchObject({ url: "/test", resource: "test" });
-    });
-});

package/dist/test/runOncePerTime.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/test/runOncePerTime.test.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const runOncePerTime_1 = require("../runOncePerTime");
-describe("runOncePerTime", () => {
-    it("run once in 20ms", (done) => {
-        const runOnce20ms = (0, runOncePerTime_1.runOncePerTime)(20);
-        const result = [];
-        const add = (n) => result.push(n);
-        setTimeout(() => {
-            expect(result).toHaveLength(1);
-            done();
-        }, 20);
-        setTimeout(() => runOnce20ms(() => add(1)), 5);
-        setTimeout(() => runOnce20ms(() => add(1)), 4);
-        setTimeout(() => runOnce20ms(() => add(1)), 3);
-    });
-});

package/src/base64.ts

@@ -1,5 +0,0 @@
-export const fromBase64 = (base64str: string): string =>
-  Buffer.from(base64str, "base64").toString("utf-8");
-
-export const toBase64 = (base64str: string): string =>
-  Buffer.from(base64str, "utf-8").toString("base64");

package/src/build.ts

@@ -1,190 +0,0 @@
-import { basename, join } from "path";
-import { mkdir, readFile, writeFile } from "fs/promises";
-import { fileExists } from "./fileExist";
-import { pageItem } from "./generateItems";
-import { getDocument } from "./getDocument";
-import { getFilesRecursive } from "./getFilesRecursive";
-import { getOptions } from "./getOptions";
-import { injectTsFile } from "./injectTsFile";
-import { rnds } from "./rnd";
-import { buildFront } from "./buildFront";
-import { serializeDocument } from "./serializeDocument";
-
-const backRegex = /\.back\.ts$/;
-const htmlPageRegex = /\.page\.html$/;
-
-export interface buildArguments {
-  sourceDir: string;
-  outputDir: string;
-  hotRestart?: boolean;
-  ignoreConsoleLogs?: boolean;
-  ignoreErrors?: boolean;
-  minify?: boolean;
-}
-
-export const build = async (args: buildArguments, minify = true) => {
-  const { hotRestart, ignoreConsoleLogs, ignoreErrors } = args;
-  const { outputDir, sourceDir } = getOptions({
-    sourceDir: args.sourceDir,
-    outputDir: args.outputDir,
-  });
-  if (!(await fileExists(sourceDir))) throw "directory does not exist";
-  await mkdir(outputDir, { recursive: true });
-  const pagesReady: string[] = [];
-  const backFiles = [...getFilesRecursive(sourceDir, { pattern: backRegex })];
-
-  const buildFrontPromises: Promise<[boolean, string, CallableFunction]>[] = [];
-
-  for (const file of backFiles) {
-    const name = basename(file).replace(backRegex, "");
-    const htmlFile = file.replace(backRegex, ".page.html");
-    pagesReady.push(htmlFile);
-    const htmlExist = await fileExists(htmlFile);
-    let html = htmlExist
-      ? await readFile(htmlFile, { encoding: "utf-8" })
-      : pageItem(name).html;
-    const scriptId = "tmp" + rnds(25);
-    html = await injectTsFile({
-      html,
-      outputDir,
-      sourceDir,
-      tsFile: file,
-      scriptId,
-    });
-    const { document, jsDomErrors, window } = getDocument(html, {
-      ignoreConsoleLogs,
-      ignoreErrors,
-    });
-    if (ignoreErrors && jsDomErrors.length)
-      jsDomErrors.forEach((_: any) =>
-        console["log"](`page ${name} error: `, _.detail || _),
-      );
-    await new Promise((ok) => {
-      const handle = setTimeout(() => {
-        console["log"](`time up: ${name}`);
-        ok(0);
-      }, 6e3);
-      document.addEventListener("load", () => {
-        clearTimeout(handle);
-        ok(0);
-      });
-    });
-    const scriptNode = document.querySelector(`#${scriptId}`);
-    if (scriptNode) document.head.removeChild(scriptNode);
-    html = serializeDocument(document);
-    window.close();
-    const tsFile = htmlFile.replace(htmlPageRegex, ".page.ts");
-    const outHtmlFile = file
-      .replace(sourceDir, outputDir)
-      .replace(backRegex, ".html");
-    const outTsFile = file
-      .replace(sourceDir, outputDir)
-      .replace(backRegex, ".js");
-
-    html = html.replace(/\/\*tkeron\-front\-script/g, "");
-    html = html.replace(/tkeron\-front\-script\*\//g, "");
-
-    buildFrontPromises.push(
-      tryBuildFront(
-        name,
-        html,
-        outHtmlFile,
-        hotRestart,
-        outTsFile,
-        "tkeron_page_js",
-        tsFile,
-        minify,
-      ),
-    );
-  }
-  const htmlFiles = [
-    ...getFilesRecursive(sourceDir, { pattern: htmlPageRegex }),
-  ];
-  for (const file of htmlFiles) {
-    const name = basename(file).replace(htmlPageRegex, "");
-    if (pagesReady.includes(file)) continue;
-    let html = await readFile(file, { encoding: "utf-8" });
-    const outHtmlFile = file
-      .replace(sourceDir, outputDir)
-      .replace(htmlPageRegex, ".html");
-    const outTsFile = file
-      .replace(sourceDir, outputDir)
-      .replace(htmlPageRegex, ".html");
-    const tsFile = file.replace(htmlPageRegex, ".page.ts");
-
-    html = html.replace(/\/\*tkeron\-front\-script/g, "");
-    html = html.replace(/tkeron\-front\-script\*\//g, "");
-
-    buildFrontPromises.push(
-      tryBuildFront(
-        name,
-        html,
-        outHtmlFile,
-        hotRestart,
-        outTsFile,
-        "tkeron_page_js",
-        tsFile,
-        minify,
-      ),
-    );
-  }
-
-  const results = await Promise.all(buildFrontPromises);
-  for (const result of results) {
-    const [ok, name, retry] = result;
-    if (ok) continue;
-    console["log"](`\nretry build ${name}...`);
-    await new Promise((done) => setTimeout(done, 300));
-    const [done] = await retry();
-    if (!done) throw `error building ${name}, try build command again...`;
-  }
-
-  const compdate = new Date().getTime().toString();
-  const compdateDir = join(outputDir, "compdate.txt");
-  await writeFile(compdateDir, compdate, { encoding: "utf-8" });
-
-  console["log"]("\nall site built");
-};
-
-export const tryBuildFront = async (
-  name: string,
-  html: string,
-  outHtmlFile: string,
-  hotRestart: boolean,
-  outTsFile: string,
-  scriptId: string,
-  tsFile: string,
-  minify = true,
-): Promise<[boolean, string, CallableFunction]> => {
-  return new Promise(async (ok) => {
-    try {
-      await buildFront({
-        html,
-        outHtmlFile,
-        hotRestart,
-        outTsFile,
-        scriptId: "tkeron_page_js",
-        tsFile,
-        minify,
-      });
-      console["log"](`site ${name} built`);
-      ok([true, name, async () => {}]);
-    } catch (_) {
-      console["log"](`error building site ${name}: `, _);
-      ok([
-        false,
-        name,
-        () =>
-          tryBuildFront(
-            name,
-            html,
-            outHtmlFile,
-            hotRestart,
-            outTsFile,
-            scriptId,
-            tsFile,
-          ),
-      ]);
-    }
-  });
-};

package/src/buildFront.ts

@@ -1,40 +0,0 @@
-import { mkdir, readFile, unlink, writeFile } from "fs/promises";
-import { dirname, join } from "path";
-import { bundleTs } from "./bundleTs";
-import { fileExists } from "./fileExist";
-import { injectCode } from "./injectCode";
-
-export interface buildFrontOptions {
-  html: string;
-  tsFile: string;
-  outTsFile: string;
-  outHtmlFile: string;
-  hotRestart?: boolean;
-  scriptId: string;
-  minify?: boolean;
-}
-
-export const buildFront = async (options: buildFrontOptions) => {
-  const { hotRestart, outHtmlFile, scriptId, tsFile, outTsFile, minify } =
-    options;
-  let { html } = options;
-  const outHtmlDir = dirname(outHtmlFile);
-  if (hotRestart === true) {
-    const code = await bundleTs(
-      join(__dirname, "..", "distFiles", "simpleHotRestart.ts"),
-      "shr.js",
-      true,
-      true,
-    );
-    html = injectCode(html, code, "tkeron_simple_hot_restart");
-  }
-  if (await fileExists(tsFile)) {
-    const tsCode = await bundleTs(tsFile, outTsFile, minify);
-    await unlink(outTsFile);
-    if (tsCode.trim() !== "") html = injectCode(html, tsCode, scriptId);
-  }
-  await mkdir(outHtmlDir, { recursive: true });
-  await writeFile(outHtmlFile, html, { encoding: "utf-8" });
-
-  return html;
-};