@metricinsights/pp-dev 0.0.1

package/dist/plugins/client-injection-plugin.js

@@ -0,0 +1,57 @@
+import { normalizePath } from 'vite';
+import * as path from 'path';
+import { PP_DEV_CLIENT_ENTRY, PACKAGE_NAME, VERSION, PP_DEV_PACKAGE_DIR } from '../constants.js';
+import * as fs from 'fs';
+import { compile } from 'ejs';
+import * as url from 'url';
+const __dirname = url.fileURLToPath(new URL('.', import.meta.url));
+const PACKAGE_IMPORT = `${PACKAGE_NAME}/client`;
+const CLIENT_PATH = `/${PACKAGE_IMPORT}`;
+export function clientInjectionPlugin(opts) {
+    const clientPanelTpl = fs.readFileSync(path.resolve(__dirname, '..', 'client', 'index.html'), {
+        encoding: 'utf8',
+        flag: 'r',
+    });
+    let render;
+    return {
+        name: 'pp-dev:client',
+        apply: 'serve',
+        config: (config) => {
+            config.optimizeDeps?.exclude?.push(`${PACKAGE_NAME}/client`);
+            return config;
+        },
+        resolveId(source) {
+            const pkgRegExp = new RegExp(`^\\/?${PACKAGE_NAME}\\/client\\/(.*)$`);
+            if (pkgRegExp.test(source)) {
+                return {
+                    id: normalizePath(path.join(PP_DEV_PACKAGE_DIR, 'dist/client', source.replace(pkgRegExp, '$1'))),
+                };
+            }
+        },
+        transformIndexHtml: async (html, ctx) => {
+            const result = {
+                html,
+                tags: [
+                    { tag: 'link', injectTo: 'head', attrs: { rel: 'stylesheet', href: `${PACKAGE_NAME}/client/client.css` } },
+                    { tag: 'script', injectTo: 'body', attrs: { src: `${PACKAGE_NAME}/client/client.js`, type: 'module' } },
+                ],
+            };
+            const { backendBaseURL, templateLess, portalPageId } = opts || ctx.server?.config.clientInjectionPlugin || {};
+            if (!render && ctx.server?.config.base) {
+                render = compile(clientPanelTpl.replace(new RegExp(`${CLIENT_PATH}`, 'g'), path.posix.join(ctx.server.config.base, PACKAGE_IMPORT)), { openDelimiter: '{', closeDelimiter: '}', async: true });
+            }
+            if (ctx.server?.config.base) {
+                result.tags.push({
+                    tag: 'div',
+                    injectTo: 'body',
+                    children: await render({ PACKAGE_NAME, VERSION, backendBaseURL, templateLess, portalPageId }),
+                });
+            }
+            return result;
+        },
+        configureServer(server) {
+            server.config.server?.fs?.allow?.push(normalizePath(path.resolve(server.config.root, path.dirname(PP_DEV_CLIENT_ENTRY))));
+        },
+    };
+}
+//# sourceMappingURL=client-injection-plugin.js.map

package/dist/plugins/client-injection-plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client-injection-plugin.js","sourceRoot":"","sources":["../../src/plugins/client-injection-plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAA4B,aAAa,EAAU,MAAM,MAAM,CAAC;AACvE,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,mBAAmB,EAAE,YAAY,EAAE,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACjG,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,EAAyB,OAAO,EAAE,MAAM,KAAK,CAAC;AACrD,OAAO,KAAK,GAAG,MAAM,KAAK,CAAC;AAc3B,MAAM,SAAS,GAAG,GAAG,CAAC,aAAa,CAAC,IAAI,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAEnE,MAAM,cAAc,GAAG,GAAG,YAAY,SAAS,CAAC;AAChD,MAAM,WAAW,GAAG,IAAI,cAAc,EAAE,CAAC;AAEzC,MAAM,UAAU,qBAAqB,CAAC,IAAgC;IACpE,MAAM,cAAc,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,YAAY,CAAC,EAAE;QAC5F,QAAQ,EAAE,MAAM;QAChB,IAAI,EAAE,GAAG;KACV,CAAC,CAAC;IACH,IAAI,MAA6B,CAAC;IAElC,OAAO;QACL,IAAI,EAAE,eAAe;QACrB,KAAK,EAAE,OAAO;QACd,MAAM,EAAE,CAAC,MAAM,EAAE,EAAE;YACjB,MAAM,CAAC,YAAY,EAAE,OAAO,EAAE,IAAI,CAAC,GAAG,YAAY,SAAS,CAAC,CAAC;YAE7D,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,SAAS,CAAC,MAAM;YACd,MAAM,SAAS,GAAG,IAAI,MAAM,CAAC,QAAQ,YAAY,mBAAmB,CAAC,CAAC;YAEtE,IAAI,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;gBAC1B,OAAO;oBACL,EAAE,EAAE,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,aAAa,EAAE,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;iBACjG,CAAC;aACH;QACH,CAAC;QACD,kBAAkB,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE;YACtC,MAAM,MAAM,GAA6B;gBACvC,IAAI;gBACJ,IAAI,EAAE;oBACJ,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,YAAY,EAAE,IAAI,EAAE,GAAG,YAAY,oBAAoB,EAAE,EAAE;oBAC1G,EAAE,GAAG,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,GAAG,YAAY,mBAAmB,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;iBACxG;aACF,CAAC;YAEF,MAAM,EAAE,cAAc,EAAE,YAAY,EAAE,YAAY,EAAE,GAAG,IAAI,IAAI,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,qBAAqB,IAAI,EAAE,CAAC;YAE9G,IAAI,CAAC,MAAM,IAAI,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,EAAE;gBACtC,MAAM,GAAG,OAAO,CACd,cAAc,CAAC,OAAO,CACpB,IAAI,MAAM,CAAC,GAAG,WAAW,EAAE,EAAE,GAAG,CAAC,EACjC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,cAAc,CAAC,CACxD,EACD,EAAE,aAAa,EAAE,GAAG,EAAE,cAAc,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,CACzD,CAAC;aACH;YAED,IAAI,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,EAAE;gBAC3B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;oBACf,GAAG,EAAE,KAAK;oBACV,QAAQ,EAAE,MAAM;oBAChB,QAAQ,EAAE,MAAM,MAAM,CAAC,EAAE,YAAY,EAAE,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,YAAY,EAAE,CAAC;iBAC9F,CAAC,CAAC;aACJ;YAED,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,eAAe,CAAC,MAAM;YACpB,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,CACnC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CACnF,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/shortcuts.d.ts

@@ -0,0 +1,12 @@
+import type { ViteDevServer } from 'vite';
+export declare function isDefined<T>(value: T | undefined | null): value is T;
+export type BindShortcutsOptions = {
+    print?: boolean;
+    customShortcuts?: (CLIShortcut | undefined | null)[];
+};
+export type CLIShortcut = {
+    key: string;
+    description: string;
+    action(server: ViteDevServer): void | Promise<void>;
+};
+export declare function bindShortcuts(server: ViteDevServer, opts: BindShortcutsOptions): void;

package/dist/shortcuts.js

@@ -0,0 +1,83 @@
+import { createColors } from 'picocolors';
+const colors = createColors();
+export function isDefined(value) {
+    return value != null;
+}
+export function bindShortcuts(server, opts) {
+    if (!server.httpServer || !process.stdin.isTTY || process.env.CI) {
+        return;
+    }
+    server._shortcutsOptions = opts;
+    if (opts.print) {
+        server.config.logger.info(colors.dim(colors.green('  ➜')) + colors.dim('  press ') + colors.bold('h') + colors.dim(' to show help'));
+    }
+    const shortcuts = (opts.customShortcuts ?? []).filter(isDefined).concat(BASE_SHORTCUTS);
+    let actionRunning = false;
+    const onInput = async (input) => {
+        if (input === '\x03' || input === '\x04') {
+            await server.close().finally(() => process.exit(1));
+            return;
+        }
+        if (actionRunning) {
+            return;
+        }
+        if (input === 'h') {
+            server.config.logger.info([
+                '',
+                colors.bold('  Shortcuts'),
+                ...shortcuts.map((shortcut) => colors.dim('  press ') + colors.bold(shortcut.key) + colors.dim(` to ${shortcut.description}`)),
+            ].join('\n'));
+        }
+        const shortcut = shortcuts.find((shortcut) => shortcut.key === input);
+        if (!shortcut) {
+            return;
+        }
+        actionRunning = true;
+        await shortcut.action(server);
+        actionRunning = false;
+    };
+    process.stdin.setRawMode(true);
+    process.stdin.on('data', onInput).setEncoding('utf8').resume();
+    server.httpServer.on('close', () => {
+        process.stdin.off('data', onInput).pause();
+    });
+}
+const BASE_SHORTCUTS = [
+    {
+        key: 'r',
+        description: 'restart the server',
+        async action(server) {
+            await server.restart();
+        },
+    },
+    {
+        key: 'u',
+        description: 'show server url',
+        action(server) {
+            server.config.logger.info('');
+            server.printUrls();
+        },
+    },
+    {
+        key: 'o',
+        description: 'open in browser',
+        action(server) {
+            server.openBrowser();
+        },
+    },
+    {
+        key: 'c',
+        description: 'clear console',
+        action(server) {
+            server.config.logger.clearScreen('error');
+        },
+    },
+    {
+        key: 'q',
+        description: 'quit',
+        async action(server) {
+            await server.close().finally(() => process.exit());
+        },
+    },
+];
+//# sourceMappingURL=shortcuts.js.map

package/dist/shortcuts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shortcuts.js","sourceRoot":"","sources":["../src/shortcuts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAG1C,MAAM,MAAM,GAAG,YAAY,EAAE,CAAC;AAE9B,MAAM,UAAU,SAAS,CAAI,KAA2B;IACtD,OAAO,KAAK,IAAI,IAAI,CAAC;AACvB,CAAC;AAgBD,MAAM,UAAU,aAAa,CAAC,MAAqB,EAAE,IAA0B;IAC7E,IAAI,CAAC,MAAM,CAAC,UAAU,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE;QAChE,OAAO;KACR;IACA,MAAc,CAAC,iBAAiB,GAAG,IAAI,CAAC;IAEzC,IAAI,IAAI,CAAC,KAAK,EAAE;QACd,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CACvB,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,eAAe,CAAC,CAC1G,CAAC;KACH;IAED,MAAM,SAAS,GAAG,CAAC,IAAI,CAAC,eAAe,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;IAExF,IAAI,aAAa,GAAG,KAAK,CAAC;IAE1B,MAAM,OAAO,GAAG,KAAK,EAAE,KAAa,EAAE,EAAE;QAEtC,IAAI,KAAK,KAAK,MAAM,IAAI,KAAK,KAAK,MAAM,EAAE;YACxC,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAEpD,OAAO;SACR;QAED,IAAI,aAAa,EAAE;YACjB,OAAO;SACR;QAED,IAAI,KAAK,KAAK,GAAG,EAAE;YACjB,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CACvB;gBACE,EAAE;gBACF,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC;gBAC1B,GAAG,SAAS,CAAC,GAAG,CACd,CAAC,QAAQ,EAAE,EAAE,CACX,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,OAAO,QAAQ,CAAC,WAAW,EAAE,CAAC,CACjG;aACF,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,CAAC;SACH;QAED,MAAM,QAAQ,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,KAAK,KAAK,CAAC,CAAC;QAEtE,IAAI,CAAC,QAAQ,EAAE;YACb,OAAO;SACR;QAED,aAAa,GAAG,IAAI,CAAC;QACrB,MAAM,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC9B,aAAa,GAAG,KAAK,CAAC;IACxB,CAAC,CAAC;IAEF,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAE/B,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,CAAC;IAE/D,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;QACjC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC;IAC7C,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,cAAc,GAAkB;IACpC;QACE,GAAG,EAAE,GAAG;QACR,WAAW,EAAE,oBAAoB;QACjC,KAAK,CAAC,MAAM,CAAC,MAAM;YACjB,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;QACzB,CAAC;KACF;IACD;QACE,GAAG,EAAE,GAAG;QACR,WAAW,EAAE,iBAAiB;QAC9B,MAAM,CAAC,MAAM;YACX,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YAC9B,MAAM,CAAC,SAAS,EAAE,CAAC;QACrB,CAAC;KACF;IACD;QACE,GAAG,EAAE,GAAG;QACR,WAAW,EAAE,iBAAiB;QAC9B,MAAM,CAAC,MAAM;YACX,MAAM,CAAC,WAAW,EAAE,CAAC;QACvB,CAAC;KACF;IACD;QACE,GAAG,EAAE,GAAG;QACR,WAAW,EAAE,eAAe;QAC5B,MAAM,CAAC,MAAM;YACX,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAC5C,CAAC;KACF;IACD;QACE,GAAG,EAAE,GAAG;QACR,WAAW,EAAE,MAAM;QACnB,KAAK,CAAC,MAAM,CAAC,MAAM;YACjB,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;QACrD,CAAC;KACF;CACF,CAAC"}

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@metricinsights/pp-dev",
+  "type": "module",
+  "version": "0.0.1",
+  "description": "Portal Page dev build tool",
+  "bin": {
+    "pp-dev": "bin/pp-dev.js"
+  },
+  "main": "dist/index.js",
+  "scripts": {
+    "clean": "rimraf ./dist",
+    "prebuild": "npm run clean",
+    "build": "npm run build:node && npm run build:client",
+    "build:node": "tsc",
+    "build:client": "rollup --config src/client/rollup.config.ts --configPlugin typescript",
+    "test": "cd test && npm run build"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./plugin": {
+      "types": "./dist/plugin.d.ts",
+      "import": "./dist/plugin.js"
+    },
+    "./client/*": "./dist/client/*",
+    "./package.json": "./package.json"
+  },
+  "author": "Serhii Shpak",
+  "license": "ISC",
+  "dependencies": {
+    "axios": "^1.4.0",
+    "cac": "^6.7.14",
+    "ejs": "^3.1.9",
+    "esbuild": "^0.17.18",
+    "express": "^4.18.2",
+    "file-type": "^18.3.0",
+    "http-proxy-middleware": "^2.0.6",
+    "jsdom": "^22.0.0",
+    "picocolors": "^1.0.0",
+    "sass": "^1.62.1",
+    "typescript": "^5.0.4",
+    "vite": "^4.3.4",
+    "vite-plugin-zip-pack": "^1.0.5"
+  },
+  "devDependencies": {
+    "@rollup/plugin-node-resolve": "^15.0.2",
+    "@rollup/plugin-typescript": "^11.1.1",
+    "@rollup/plugin-url": "^8.0.1",
+    "@types/ejs": "^3.1.2",
+    "@types/express": "^4.17.17",
+    "@types/jsdom": "^21.1.1",
+    "rimraf": "^5.0.1",
+    "rollup": "^3.23.0",
+    "rollup-plugin-scss": "^3.0.0",
+    "tslib": "^2.5.2"
+  },
+  "files": [
+    "bin",
+    "dist",
+    "package.json",
+    "README.md",
+    "LICENSE.md",
+    "pp-dev.d.ts",
+    "assets"
+  ]
+}

package/pp-dev.d.ts

@@ -0,0 +1,60 @@
+import type { PPDevConfig, PPWatchConfig } from '.';
+
+declare module 'pp-dev.config.ts' {
+  const config: PPDevConfig;
+
+  export default config;
+}
+
+declare module '.pp-dev.config.ts' {
+  const config: PPDevConfig;
+
+  export default config;
+}
+
+declare module 'pp-dev.config.js' {
+  const config: PPDevConfig;
+
+  export default config;
+}
+
+declare module '.pp-dev.config.js' {
+  const config: PPDevConfig;
+
+  export default config;
+}
+
+declare module 'pp-dev.config.json' {
+  const config: PPDevConfig;
+
+  export default config;
+}
+
+declare module '.pp-dev.config.json' {
+  const config: PPDevConfig;
+
+  export default config;
+}
+
+declare module '.pp-watch.config.ts' {
+  const config: PPWatchConfig;
+
+  export default config;
+}
+
+declare module '.pp-watch.config.js' {
+  const config: PPWatchConfig;
+
+  export default config;
+}
+
+declare module '.pp-watch.config.json' {
+  const config: PPWatchConfig;
+
+  export default config;
+}
+
+declare module '*.scss' {
+  const content: Record<string, string>;
+  export default content;
+}