vovk 0.2.3-beta.112 → 0.2.3-beta.114

package/cli/{generateClient.js → generateClient.mjs}

@@ -1,15 +1,15 @@
 // @ts-check
-const fs = require('fs/promises');
-const path = require('path');
-const getReturnPath = require('./lib/getReturnPath');
+import fs from 'fs/promises';
+import path from 'path';
+import getReturnPath from './lib/getReturnPath.mjs';
 
-/** @type {(moduleName: string) => boolean} */
-function canRequire(moduleName) {
+/** @type {(moduleName: string) => Promise<boolean>} */
+async function canImport(moduleName) {
   try {
-    require.resolve(moduleName);
-    return true; // The module exists and can be required
+    await import(moduleName);
+    return true; // The module exists and can be imported
   } catch (e) {
-    return false; // The module does not exist
+    return false; // The module does not exist or cannot be imported
   }
 }
 
@@ -18,7 +18,7 @@ function canRequire(moduleName) {
  * TODO: Check fetcher for existence
  * @type {(rcPath: import('../src').VovkEnv) => Promise<{ written: boolean; path: string }>}
  */
-async function generateClient({ ...env }) {
+export default async function generateClient({ ...env }) {
   const outDir = env.VOVK_CLIENT_OUT;
   const returnDir = getReturnPath(outDir, process.cwd());
   const jsonPath = path.join(returnDir, '.vovk.json');
@@ -26,20 +26,22 @@ async function generateClient({ ...env }) {
   const fetcherPath = env.VOVK_FETCHER.startsWith('.') ? path.join(returnDir, env.VOVK_FETCHER) : env.VOVK_FETCHER;
 
   if (!env.VOVK_VALIDATE_ON_CLIENT) {
-    env.VOVK_VALIDATE_ON_CLIENT = canRequire('vovk-zod/zodValidateOnClient') ? 'vovk-zod/zodValidateOnClient' : '';
+    env.VOVK_VALIDATE_ON_CLIENT = (await canImport('vovk-zod/zodValidateOnClient'))
+      ? 'vovk-zod/zodValidateOnClient'
+      : '';
   }
   const validatePath = env.VOVK_VALIDATE_ON_CLIENT.startsWith('.')
     ? path.join(returnDir, env.VOVK_VALIDATE_ON_CLIENT)
     : env.VOVK_VALIDATE_ON_CLIENT;
   const localValidatePath = env.VOVK_VALIDATE_ON_CLIENT.startsWith('.') ? path.join('..', validatePath) : validatePath;
 
-  if (env.VOVK_VALIDATE_ON_CLIENT && !canRequire(localValidatePath)) {
+  if (env.VOVK_VALIDATE_ON_CLIENT && !(await canImport(localValidatePath))) {
     throw new Error(
       `Unble to generate Vovk Client: cannot find "validateOnClient" module '${env.VOVK_VALIDATE_ON_CLIENT}'. Check your vovk.config.js file`
     );
   }
 
-  if (!canRequire(localJsonPath)) {
+  if (!(await canImport(localJsonPath))) {
     throw new Error(`Unble to generate Vovk Client: cannot find ".vovk.json" file '${jsonPath}'.`);
   }
 
@@ -116,5 +118,3 @@ type Options = typeof fetcher extends VovkClientFetcher<infer U> ? U : never;
 
   return { written: true, path: outDir };
 }
-
-module.exports = generateClient;

package/cli/{getVars.js → getVars.mjs}

@@ -1,11 +1,11 @@
 // @ts-check
 
-const path = require('path');
+import path from 'path';
 
 /** @type {import('../src').VovkEnv} */
 let vars;
-/** @type {(rcPath: string, options?: { VOVK_CLIENT_OUT?: string; PORT?: string; }) => import('../src').VovkEnv} */
-function getVars(configPath, options = {}) {
+/** @type {(rcPath: string, options?: { VOVK_CLIENT_OUT?: string; PORT?: string; }) => Promise<import('../src').VovkEnv>} */
+export default async function getVars(configPath, options = {}) {
   if (vars) return vars;
   /** @type {Required<import('../src').VovkConfig>} */
   const vovkConfig = {
@@ -19,7 +19,7 @@ function getVars(configPath, options = {}) {
   try {
     // make PORT available to the config file
     process.env.PORT = options.PORT || process.env.PORT || '3000';
-    Object.assign(vovkConfig, require(configPath));
+    Object.assign(vovkConfig, await import(configPath));
   } catch {
     // noop
   }
@@ -43,5 +43,3 @@ function getVars(configPath, options = {}) {
 
   return vars;
 }
-
-module.exports = getVars;

package/cli/{index.js → index.mjs}

@@ -1,15 +1,16 @@
 #!/usr/bin/env node
 // @ts-check
-const generateClient = require('./generateClient');
-const path = require('path');
-const parallel = require('./lib/parallel');
-const getAvailablePort = require('./lib/getAvailablePort');
-const getVars = require('./getVars');
-const parseCommandLineArgs = require('./lib/parseCommandLineArgs');
+import path from 'path';
+import generateClient from './generateClient.mjs';
+import parallel from './lib/parallel.mjs';
+import getAvailablePort from './lib/getAvailablePort.mjs';
+import getVars from './getVars.mjs';
+import parseCommandLineArgs from './lib/parseCommandLineArgs.mjs';
 
 const { command, flags, restArgs } = parseCommandLineArgs();
 const {
   config = path.join(process.cwd(), 'vovk.config.js'), // Path to vovk.config.js
+  // TODO not documented
   project = process.cwd(), // Path to Next.js project
   clientOut = path.join(process.cwd(), './node_modules/.vovk'), // Path to output directory
 } = flags;
@@ -22,7 +23,7 @@ if (command === 'dev') {
         throw new Error(' 🐺 Failed to find available Next port');
       }));
 
-    const env = getVars(config, { VOVK_CLIENT_OUT: clientOut, PORT });
+    const env = await getVars(config, { VOVK_CLIENT_OUT: clientOut, PORT });
 
     let VOVK_PORT = parseInt(env.VOVK_PORT);
 
@@ -42,36 +43,17 @@ if (command === 'dev') {
     ).catch((e) => console.error(e));
     console.info(' 🐺 All processes have ended');
   })();
-} else if (command === 'build') {
+} else if (command === 'generate') {
   void (async () => {
-    const env = getVars(config, { VOVK_CLIENT_OUT: clientOut });
-
-    let VOVK_PORT = parseInt(env.VOVK_PORT);
+    const env = await getVars(config, { VOVK_CLIENT_OUT: clientOut });
 
-    env.VOVK_PORT = await getAvailablePort(VOVK_PORT, 30).catch(() => {
-      throw new Error(' 🐺 Failed to find available port');
+    void generateClient(env).then(({ path }) => {
+      console.info(` 🐺 Client generated in ${path}`);
     });
-    await parallel(
-      [
-        {
-          command: `node ${__dirname}/server.js --once`,
-          name: 'Vovk',
-        },
-        { command: `cd ${project} && npx next build ${restArgs}`, name: 'Next' },
-      ],
-      env
-    ).catch((e) => console.error(e));
   })();
-} else if (command === 'generate') {
-  const env = getVars(config, { VOVK_CLIENT_OUT: clientOut });
-
-  void generateClient(env).then(({ path }) => {
-    console.info(` 🐺 Client generated in ${path}`);
-  });
 } else if (command === 'help') {
   console.info(` 🐺 Vovk CLI
   dev - Start development server
-  build - Build Next.js project
   generate - Generate client
   help - Show this help message`);
 } else {

package/cli/lib/{getAvailablePort.js → getAvailablePort.mjs}

@@ -1,4 +1,4 @@
-const net = require('net');
+import net from 'net';
 
 function checkPort(port, callback) {
   const server = net.createServer();
@@ -15,7 +15,7 @@ function checkPort(port, callback) {
 }
 
 /** @type {(startPort: number, maxAttempts: number, attempt?: number) => Promise<string>} */
-function getAvailablePort(startPort, maxAttempts, attempt = 1) {
+export default function getAvailablePort(startPort, maxAttempts, attempt = 1) {
   return new Promise((resolve, reject) => {
     checkPort(startPort, (isAvailable) => {
       if (isAvailable) {
@@ -28,5 +28,3 @@ function getAvailablePort(startPort, maxAttempts, attempt = 1) {
     });
   });
 }
-
-module.exports = getAvailablePort;

package/cli/lib/{getReturnPath.js → getReturnPath.mjs}

@@ -1,6 +1,6 @@
 // @ts-check
 /** @type {(fromPath: string, toPath: string) => string} */
-function getReturnPath(fromPath, toPath) {
+export default function getReturnPath(fromPath, toPath) {
   // Split the paths into components
   const fromParts = fromPath.replace(/^\.?\/|\/$/g, '').split('/');
   const toParts = toPath.replace(/^\.?\/|\/$/g, '').split('/');
@@ -24,5 +24,3 @@ function getReturnPath(fromPath, toPath) {
 
   return result;
 }
-
-module.exports = getReturnPath;

package/cli/lib/{isEqual.js → isEqual.mjs}

@@ -1,6 +1,6 @@
 // @ts-check
 /** @type {(obj1: any, obj2: any) => boolean} */
-const isEqual = (obj1, obj2) => {
+export default function isEqual(obj1, obj2) {
   if (obj1 === obj2) {
     return true;
   }
@@ -23,6 +23,4 @@ const isEqual = (obj1, obj2) => {
   }
 
   return true;
-};
-
-module.exports = isEqual;
+}

package/cli/lib/{parallel.js → parallel.mjs}

@@ -1,8 +1,8 @@
 // @ts-check
-const { spawn } = require('child_process');
+import { spawn } from 'child_process';
 
 /** @type {(commands: { command: string; name: string; }[], env: import('../../src').VovkEnv) => Promise<void>} */
-function parallel(commands, env) {
+export default function parallel(commands, env) {
   return new Promise((resolve, reject) => {
     /** @type {{ name: string; process: import('child_process').ChildProcess; }[]} */
     let processes = [];
@@ -46,5 +46,3 @@ function parallel(commands, env) {
     }
   });
 }
-
-module.exports = parallel;

package/cli/lib/{parseCommandLineArgs.js → parseCommandLineArgs.mjs}

@@ -7,7 +7,7 @@ function toCamelCase(str) {
 
 /** @typedef {{ config?: string; project?: string; clientOut?: string }} Flags */
 /** @typedef {'dev' | 'build' | 'generate' | 'help'} Command */
-function parseCommandLineArgs() {
+export default function parseCommandLineArgs() {
   const args = process.argv.slice(2); // Slice off node and script path
   let command = /** @type {Command} */ null;
   /** @type {Flags} */
@@ -37,5 +37,3 @@ function parseCommandLineArgs() {
 
   return { command, flags, restArgs };
 }
-
-module.exports = parseCommandLineArgs;

package/cli/{postinstall.js → postinstall.mjs}

@@ -1,6 +1,6 @@
 // @ts-check
-const fs = require('fs/promises');
-const path = require('path');
+import fs from 'fs/promises';
+import path from 'path';
 
 /** @type {(path: string) => Promise<boolean>} */
 const fileExists = async (path) => !!(await fs.stat(path).catch(() => false));

package/cli/{server.js → server.mjs}

@@ -1,15 +1,15 @@
 // @ts-check
-const http = require('http');
-const fs = require('fs/promises');
-const path = require('path');
-const parseCommandLineArgs = require('./lib/parseCommandLineArgs');
-const generateClient = require('./generateClient');
-const getVars = require('./getVars');
-const isEqual = require('./lib/isEqual');
+import http from 'http';
+import fs from 'fs/promises';
+import path from 'path';
+import parseCommandLineArgs from './lib/parseCommandLineArgs.mjs';
+import generateClient from './generateClient.mjs';
+import getVars from './getVars.mjs';
+import isEqual from './lib/isEqual.mjs';
 
 const { flags } = parseCommandLineArgs();
 
-const { once, config } = /** @type {{ once?: boolean; config: string }} */ (flags);
+const { config } = /** @type {{ config: string }} */ (flags);
 
 const metadataPath = path.join(__dirname, '../../../.vovk.json');
 
@@ -36,26 +36,32 @@ let pingInterval;
 /** @type {import('../src').VovkEnv} */
 let vars;
 
+/** @type {() => Promise<void>} */
+const ping = async () => {
+  vars = vars ?? (await getVars(config));
+  let prefix = vars.VOVK_PREFIX;
+  prefix = prefix.startsWith('http://')
+    ? prefix
+    : `http://localhost:${process.env.PORT}/${prefix.startsWith('/') ? prefix.slice(1) : prefix}`;
+  const endpoint = `${prefix.endsWith('/') ? prefix.slice(0, -1) : prefix}/__ping`;
+  // Create the HTTP GET request
+  const req = http.get(endpoint, () => {
+    // noop
+  });
+
+  // Error handling for the request
+  req.on('error', (err) => {
+    console.error(`🐺 ❌ Error during HTTP request made to ${endpoint}:`, err.message);
+  });
+};
+
+// make initial ping
+setTimeout(() => void ping(), 1000 * 3);
+
 /** @type {() => void} */
-const startPinging = () => {
+const constantlyPing = () => {
   clearInterval(pingInterval);
-  pingInterval = setInterval(() => {
-    vars = vars ?? getVars(config);
-    let prefix = vars.VOVK_PREFIX;
-    prefix = prefix.startsWith('http://')
-      ? prefix
-      : `http://localhost:${process.env.PORT}/${prefix.startsWith('/') ? prefix.slice(1) : prefix}`;
-    const endpoint = `${prefix.endsWith('/') ? prefix.slice(0, -1) : prefix}/__ping`;
-    // Create the HTTP GET request
-    const req = http.get(endpoint, () => {
-      // noop
-    });
-
-    // Error handling for the request
-    req.on('error', (err) => {
-      console.error(`🐺 ❌ Error during HTTP request made to ${endpoint}:`, err.message);
-    });
-  }, 1000 * 3);
+  pingInterval = setInterval(() => void ping(), 1000 * 3);
 };
 
 const server = http.createServer((req, res) => {
@@ -72,7 +78,7 @@ const server = http.createServer((req, res) => {
         /** @type {{ metadata?: import('../src') }} */
         const { metadata } = JSON.parse(body); // Parse the JSON data
         const metadataWritten = metadata ? await writeMetadata(metadata) : { written: false, path: metadataPath };
-        vars = vars ?? getVars(config);
+        vars = vars ?? (await getVars(config));
         const codeWritten = await generateClient(vars);
         res.writeHead(200, { 'Content-Type': 'text/plain' });
         res.end('JSON data received and file created');
@@ -84,18 +90,12 @@ const server = http.createServer((req, res) => {
           console.info(` 🐺 Client generated in ${codeWritten.path}`);
         }
 
-        if (!once) {
-          startPinging();
-        }
-
-        if (once && metadata) server.close();
+        constantlyPing();
       } catch (e) {
         const err = /** @type {Error} */ (e);
         res.writeHead(400, { 'Content-Type': 'text/plain' });
         res.end(err?.message ?? 'Error');
         console.error(' 🐺 ❌ ' + err?.message);
-
-        if (once) server.close();
       }
     });
   } else {

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "vovk",
-  "version": "0.2.3-beta.112",
+  "version": "0.2.3-beta.114",
   "description": "Structural add-on for Next.js",
-  "bin": "./cli/index.js",
+  "bin": "./cli/index.mjs",
   "scripts": {
     "postinstall": "node ./cli/postinstall.js",
     "upgrade": "npx npm-check-updates -u && npm i",
@@ -22,6 +22,7 @@
     "minor": "npm t && npm version minor && npm run build && npm publish ./dist && git push && git push --tags",
     "BREAKING-major": "npm t && npm version major && npm run build && npm publish ./dist && git push && git push --tags",
     "beta": "npm t && npm version prerelease --preid=beta && npm run build && npm publish ./dist --tag beta && git push && git push --tags",
+    "beta-notest": "npm version prerelease --preid=beta && npm run build && npm publish ./dist --tag beta && git push && git push --tags",
     "beta-patch": "npm t && npm version prepatch --preid=beta && npm run build && npm publish ./dist --tag beta && git push && git push --tags",
     "beta-minor": "npm t && npm version preminor --preid=beta && npm run build && npm publish ./dist --tag beta && git push && git push --tags",
     "BREAKING-beta-major": "npm t && npm version premajor --preid=beta && npm run build && npm publish ./dist --tag beta && git push && git push --tags"
@@ -51,16 +52,16 @@
     "@types/jest": "^29.5.12",
     "@types/lodash": "^4.14.202",
     "@types/supertest": "^6.0.2",
-    "@typescript-eslint/eslint-plugin": "^6.20.0",
-    "@typescript-eslint/parser": "^6.20.0",
+    "@typescript-eslint/eslint-plugin": "^6.21.0",
+    "@typescript-eslint/parser": "^6.21.0",
     "eslint": "^8.56.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-prettier": "^5.1.3",
     "jest": "^29.7.0",
     "lodash": "^4.17.21",
     "next": "^14.1.0",
-    "prettier": "^3.2.4",
-    "puppeteer": "^21.10.0",
+    "prettier": "^3.2.5",
+    "puppeteer": "^22.0.0",
     "supertest": "^6.3.4",
     "ts-jest": "^29.1.2",
     "typescript": "^5.3.3",