vovk-cli 0.0.1-beta.2 → 0.0.1-beta.4

package/LICENSE

@@ -0,0 +1,23 @@
+MIT License
+
+Copyright (c) 2023-present Andrii Gubanov
+
+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/getProjectInfo/index.d.mts

@@ -8,7 +8,6 @@ export default function getProjectInfo({ port: givenPort, clientOutDir, }?: {
     port: string;
     vovkPort: string;
     apiEntryPoint: string;
-    apiPrefix: string;
     apiDir: string;
     srcRoot: string;
     metadataOutFullPath: string;

package/dist/getProjectInfo/index.mjs

@@ -10,8 +10,7 @@ export default async function getProjectInfo({ port: givenPort, clientOutDir, }
     const cwd = process.cwd();
     const { config, srcRoot } = await getConfig({ clientOutDir });
     const vovkPort = env.VOVK_PORT || (parseInt(port) + 6969).toString();
-    const apiEntryPoint = `${config.origin}/${config.rootEntry}`; // ??? TODO
-    const apiPrefix = `${config.origin}/${config.rootEntry}`; // ??? TODO
+    const apiEntryPoint = `${config.origin ?? ''}/${config.rootEntry}`;
     const apiDir = path.join(srcRoot, 'app', config.rootEntry);
     const metadataOutFullPath = path.join(cwd, config.metadataOutDir);
     const metadataOutImportPath = path.relative(config.clientOutDir, metadataOutFullPath);
@@ -32,7 +31,6 @@ export default async function getProjectInfo({ port: givenPort, clientOutDir, }
         port,
         vovkPort,
         apiEntryPoint,
-        apiPrefix,
         apiDir,
         srcRoot,
         metadataOutFullPath,

package/dist/server/generateClient.mjs

@@ -48,11 +48,11 @@ type Options = typeof fetcher extends VovkClientFetcher<infer U> ? U : never;
     ts += `
 ${validatePath ? `import validateOnClient from '${validatePath}';\n` : '\nconst validateOnClient = undefined;'}
 type Options = typeof fetcher extends VovkClientFetcher<infer U> ? U : never;
-const prefix = '${projectInfo.apiPrefix}';
+const prefix = '${projectInfo.apiEntryPoint}';
   `;
     js += `
 const { default: validateOnClient = null } = ${validatePath ? `require('${validatePath}')` : '{}'};
-const prefix = '${projectInfo.apiPrefix}';
+const prefix = '${projectInfo.apiEntryPoint}';
 `;
     for (let i = 0; i < segments.length; i++) {
         const { segmentName } = segments[i];

package/dist/server/index.mjs

@@ -183,8 +183,8 @@ export class VovkCLIServer {
         }
     };
     #ping = debounceWithArgs((segmentName) => {
-        const { apiEntryPoint, log } = this.#projectInfo;
-        const endpoint = `${apiEntryPoint}/${segmentName ? `${segmentName}/` : ''}_vovk-ping_`;
+        const { apiEntryPoint, log, port } = this.#projectInfo;
+        const endpoint = `${apiEntryPoint.startsWith('http') ? apiEntryPoint : `http://localhost:${port}${apiEntryPoint}`}/${segmentName ? `${segmentName}/` : ''}_vovk-ping_`;
         log.debug(`Pinging segment "${segmentName}" at ${endpoint}`);
         const req = http.get(endpoint, (resp) => {
             if (resp.statusCode !== 200) {

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "vovk-cli",
-  "version": "0.0.1-beta.2",
+  "version": "0.0.1-beta.4",
   "bin": {
     "vovk": "./dist/index.mjs"
   },
   "type": "module",
   "types": "./dist/index.d.mts",
+  "prefix": ".",
   "scripts": {
     "build": "rm -rf dist tsconfig.tsbuildinfo && tsc",
     "test": "ts-node test/index.mts",
@@ -29,7 +30,7 @@
   },
   "homepage": "https://vovk.dev",
   "peerDependencies": {
-    "vovk": "^3.0.0-beta.0"
+    "vovk": "^3.0.0-beta.8"
   },
   "dependencies": {
     "@inquirer/prompts": "^5.3.8",

package/.eslintrc.mjs

@@ -1,20 +0,0 @@
-export default {
-  extends: '../../.eslintrc.js',
-  rules: {
-    '@typescript-eslint/no-unsafe-argument': 'off',
-    '@typescript-eslint/no-unsafe-assignment': 'off',
-    '@typescript-eslint/no-var-requires': 'off',
-    '@typescript-eslint/no-unsafe-call': 'off',
-    '@typescript-eslint/no-unsafe-member-access': 'off',
-    '@typescript-eslint/no-unsafe-return': 'off',
-    'no-console': 'error',
-  },
-  parserOptions: {
-    ecmaVersion: 2022,
-    sourceType: 'module',
-    project: './tsconfig.test.json',
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-    tsconfigRootDir: __dirname,
-    createDefaultProgram: true,
-  },
-};

package/src/getProjectInfo/directoryExists.mts

@@ -1,10 +0,0 @@
-import fs from 'fs/promises';
-
-export default async function directoryExists(dir: string) {
-  try {
-    const stats = await fs.stat(dir);
-    return stats.isDirectory();
-  } catch (error) {
-    return false;
-  }
-}

package/src/getProjectInfo/getConfig.mts

@@ -1,29 +0,0 @@
-import readConfig from './readConfig.mjs';
-import type { VovkConfig, VovkEnv } from '../types.mjs';
-import getCwdPath from './getCwdPath.mjs';
-import getSrcRoot from './getSrcRoot.mjs';
-import path from 'path';
-
-export default async function getConfig({ clientOutDir }: { clientOutDir?: string }) {
-  const env = process.env as VovkEnv;
-  const userConfig = await readConfig();
-  const srcRoot = await getSrcRoot();
-  const cwd = process.cwd();
-  const config: Required<VovkConfig> = {
-    modulesDir: path.join(
-      cwd,
-      env.VOVK_MODULES_DIR ?? userConfig.modulesDir ?? './' + [srcRoot, 'modules'].filter(Boolean).join('/')
-    ),
-    validateOnClient: getCwdPath(env.VOVK_VALIDATE_ON_CLIENT ?? userConfig.validateOnClient ?? null),
-    validationLibrary: getCwdPath(env.VOVK_VALIDATION_LIBRARY ?? userConfig.validationLibrary ?? null),
-    fetcher: getCwdPath(env.VOVK_FETCHER ?? userConfig.fetcher ?? 'vovk/client/defaultFetcher'),
-    metadataOutDir: env.VOVK_METADATA_OUT_DIR ?? userConfig.metadataOutDir ?? './.vovk-schema',
-    clientOutDir: clientOutDir ?? env.VOVK_CLIENT_OUT_DIR ?? userConfig.clientOutDir ?? './node_modules/.vovk',
-    origin: (env.VOVK_ORIGIN ?? userConfig.origin ?? '').replace(/\/$/, ''), // Remove trailing slash
-    rootEntry: env.VOVK_ROOT_ENTRY ?? userConfig.rootEntry ?? 'api',
-    rootSegmentModulesDirName: env.VOVK_ROOT_SEGMENT_MODULES_DIR_NAME ?? userConfig.rootSegmentModulesDirName ?? '',
-    logLevel: env.VOVK_LOG_LEVEL ?? userConfig.logLevel ?? 'debug', // TODO: change to 'warn' when v3 is ready
-  };
-
-  return { config, srcRoot };
-}

package/src/getProjectInfo/getCwdPath.mts

@@ -1,15 +0,0 @@
-import path from 'path';
-
-// TODO Rename
-export default function getCwdPath<T extends string | null>(inputPath: T, baseDir = process.cwd()): T {
-  if (inputPath === null) {
-    return null as T;
-  }
-  // Check if the path is absolute
-  if (path.isAbsolute(inputPath) || inputPath.startsWith('./') || inputPath.startsWith('../')) {
-    return path.resolve(baseDir, inputPath) as T;
-  }
-
-  // If it's a module or absolute path, keep it as is
-  return inputPath;
-}

package/src/getProjectInfo/getSrcRoot.mts

@@ -1,14 +0,0 @@
-import path from 'path';
-import directoryExists from './directoryExists.mjs';
-
-export default async function getSrcRoot() {
-  const cwd = process.cwd();
-  // Next.js Docs: src/app or src/pages will be ignored if app or pages are present in the root directory.
-  if (await directoryExists(path.join(cwd, 'app'))) {
-    return cwd;
-  } else if (await directoryExists(path.join(cwd, 'src/app'))) {
-    return path.join(cwd, 'src');
-  }
-
-  throw new Error(`Could not find app router directory. Check Next.js docs for more info.`);
-}

package/src/getProjectInfo/index.mts

@@ -1,59 +0,0 @@
-import type { VovkEnv } from '../types.mjs';
-import path from 'path';
-import loglevel from 'loglevel';
-import chalk from 'chalk';
-import getConfig from './getConfig.mjs';
-
-export type ProjectInfo = Awaited<ReturnType<typeof getProjectInfo>>;
-
-export default async function getProjectInfo({
-  port: givenPort,
-  clientOutDir,
-}: { port?: number; clientOutDir?: string } = {}) {
-  const env = process.env as VovkEnv;
-  const port = givenPort?.toString() ?? process.env.PORT ?? '3000';
-
-  // Make PORT available to the config file at getConfig
-  process.env.PORT = port;
-
-  const cwd = process.cwd();
-  const { config, srcRoot } = await getConfig({ clientOutDir });
-  const vovkPort = env.VOVK_PORT || (parseInt(port) + 6969).toString();
-  const apiEntryPoint = `${config.origin}/${config.rootEntry}`; // ??? TODO
-  const apiPrefix = `${config.origin}/${config.rootEntry}`; // ??? TODO
-  const apiDir = path.join(srcRoot, 'app', config.rootEntry);
-
-  const metadataOutFullPath = path.join(cwd, config.metadataOutDir);
-  const metadataOutImportPath = path.relative(config.clientOutDir, metadataOutFullPath);
-  const fetcherClientImportPath = config.fetcher.startsWith('.')
-    ? path.relative(config.clientOutDir, config.fetcher)
-    : config.fetcher;
-
-  const clientOutFullPath = path.join(cwd, config.clientOutDir);
-
-  const log = {
-    info: (msg: string) => loglevel.info(chalk.blueBright(`🐺 ${msg}`)),
-    warn: (msg: string) => loglevel.warn(chalk.yellowBright(`🐺 ${msg}`)),
-    error: (msg: string) => loglevel.error(chalk.redBright(`🐺 ${msg}`)),
-    debug: (msg: string) => loglevel.debug(chalk.gray(`🐺 ${msg}`)),
-    raw: loglevel,
-  };
-
-  loglevel.setLevel(config.logLevel);
-
-  return {
-    cwd,
-    port,
-    vovkPort,
-    apiEntryPoint,
-    apiPrefix,
-    apiDir,
-    srcRoot,
-    metadataOutFullPath,
-    metadataOutImportPath,
-    clientOutFullPath,
-    fetcherClientImportPath,
-    config,
-    log,
-  };
-}

package/src/getProjectInfo/readConfig.mts

@@ -1,44 +0,0 @@
-import { promises as fs } from 'fs';
-import path from 'path';
-import type { VovkConfig } from '../types.mjs';
-
-async function findConfigPath(): Promise<string | null> {
-  const rootDir = process.cwd();
-  const baseName = 'vovk.config';
-  const extensions = ['cjs', 'mjs', 'js'];
-
-  for (const ext of extensions) {
-    const filePath = path.join(rootDir, `${baseName}.${ext}`);
-    try {
-      await fs.stat(filePath);
-      return filePath; // Return the path if the file exists
-    } catch {
-      // If the file doesn't exist, an error is thrown. Catch it and continue checking.
-    }
-  }
-
-  return null; // Return null if no config file was found
-}
-
-async function readConfig(): Promise<VovkConfig> {
-  const configPath = await findConfigPath();
-  let config: VovkConfig = {};
-
-  if (!configPath) {
-    return config;
-  }
-
-  try {
-    if (configPath.endsWith('.cjs') || configPath.endsWith('.js')) {
-      const cacheBuster = Date.now();
-      ({ default: config } = (await import(`${configPath}?cache=${cacheBuster}`)) as { default: VovkConfig });
-    }
-  } catch (e) {
-    // eslint-disable-next-line no-console
-    console.error('🐺 ❌ Error reading config file:', (e as Error).message);
-  }
-
-  return config;
-}
-
-export default readConfig;

package/src/index.mts

@@ -1,113 +0,0 @@
-#!/usr/bin/env node
-import { Command } from 'commander';
-import concurrently from 'concurrently';
-import getAvailablePort from './utils/getAvailablePort.mjs';
-import { VovkCLIServer } from './server/index.mjs';
-import getProjectInfo from './getProjectInfo/index.mjs';
-import generateClient from './server/generateClient.mjs';
-import locateSegments from './locateSegments.mjs';
-import { VovkConfig, VovkEnv } from './types.mjs';
-import { VovkMetadata } from 'vovk';
-import path from 'path';
-import { readFileSync } from 'fs';
-
-export type { VovkConfig, VovkEnv };
-
-interface DevOptions {
-  project: string;
-  clientOut?: string;
-  nextDev: boolean;
-}
-
-interface GenerateOptions {
-  clientOut?: string;
-}
-
-const program = new Command();
-
-const packageJSON = JSON.parse(readFileSync(path.join(import.meta.dirname, '../package.json'), 'utf-8')) as {
-  version: string;
-};
-
-program.name('vovk').description('Vovk CLI').version(packageJSON.version);
-
-program
-  .command('dev')
-  .description('Start development server (optional flag --next-dev to start Vovk Server with Next.js)')
-  .option('--project <path>', 'Path to Next.js project', process.cwd())
-  .option('--client-out <path>', 'Path to client output directory')
-  .option('--next-dev', 'Start Vovk Server and Next.js with automatic port allocation', false)
-  .allowUnknownOption(true)
-  .action(async (options: DevOptions, command: Command) => {
-    const portAttempts = 30;
-    const PORT = !options.nextDev
-      ? process.env.PORT
-      : process.env.PORT ||
-        (await getAvailablePort(3000, portAttempts, 0, (failedPort, tryingPort) =>
-          // eslint-disable-next-line no-console
-          console.warn(`🐺 Next.js Port ${failedPort} is in use, trying ${tryingPort} instead.`)
-        ).catch(() => {
-          throw new Error(`🐺 ❌ Failed to find available Next port after ${portAttempts} attempts`);
-        }));
-
-    if (!PORT) {
-      throw new Error('🐺 ❌ PORT env variable is required');
-    }
-
-    if (options.nextDev) {
-      const { result } = concurrently(
-        [
-          {
-            command: `node ${import.meta.dirname}/server/index.mjs`,
-            name: 'Vovk.ts Metadata Server',
-            env: Object.assign(
-              { PORT, __VOVK_START_SERVER_IN_STANDALONE_MODE__: 'true' as const },
-              options.clientOut ? { VOVK_CLIENT_OUT_DIR: options.clientOut } : {}
-            ),
-          },
-          {
-            command: `cd ${options.project} && npx next dev ${command.args.join(' ')}`,
-            name: 'Next.js Development Server',
-            env: { PORT },
-          },
-        ],
-        {
-          killOthers: ['failure', 'success'],
-          prefix: 'none',
-        }
-      );
-      try {
-        await result;
-      } finally {
-        // eslint-disable-next-line no-console
-        console.log('🐺 Exiting...');
-      }
-    } else {
-      void new VovkCLIServer().startServer({ clientOutDir: options.clientOut });
-    }
-  });
-
-program
-  .command('generate')
-  .description('Generate client')
-  .option('--client-out <path>', 'Path to output directory')
-  .action(async (options: GenerateOptions) => {
-    const projectInfo = await getProjectInfo({ clientOutDir: options.clientOut });
-    const segments = await locateSegments(projectInfo.apiDir);
-    const metadata = (await import(path.join(projectInfo.metadataOutFullPath, 'index.js'))) as {
-      default: Record<string, VovkMetadata>;
-    };
-
-    await generateClient(projectInfo, segments, metadata.default);
-  });
-
-program
-  .command('help')
-  .description('Show help message')
-  .action(() => program.help());
-
-program.parse(process.argv);
-
-if (!process.argv.slice(2).length) {
-  program.outputHelp();
-}

package/src/init.mts

@@ -1,174 +0,0 @@
-#!/usr/bin/env node
-/*
-npx vovk-cli init
-- Check if the project is already initialized
-  - Do you want to reinitialize the project?
-    - Yes
-    - No (exit)
-- Check for package.json, if not found, show error and exit
-- Check for tsconfig.json, if not found, show error and exit
-- Check Next.js installed
-- Choose validation library: add to the installation list
-    - vovk-zod
-        - Further installation notes: install zod
-    - vovk-yup
-        - Further installation notes: install yup
-    - vovk-dto
-        - Further installation notes: install class-validator and class-transformer
-    - None
-- If validation library is not None,
-    - Do you want to enable client validation?
-        - Yes 
-            - Add client validation to the config
-        - No
-- Do you want to use concurrently? (NO NEED, USE CONCURRENTLY BY DEFAULT)
-    - Yes (recommended)
-        - Add concurrently to the installation list
-    - No
-- Do you want to update NPM scripts?
-    - Yes
-        - Update NPM scripts
-    - No
-- if experimentalDecorators is not found in tsconfig.json,
-    - Do you want to add experimentalDecorators to tsconfig.json?
-        - Yes
-            - Add experimentalDecorators to tsconfig.json
-        - No
-- Do you want to create route file with example service and controller? (NO NEED)
-    - Yes
-        - Create route file with example controller
-    - No, I will create it myself
-- End
-    - If there are any packages to install, install them
-    - Show installation notes
-    - If there are any files to create, create
-    - If there are any config files to update, update
-    - If example route file is NOT created, show example route file and controller
-    - Show how to run the project
-        - If npm scripts are updated
-            - npm run dev
-        - If npm scripts are NOT updated
-            - If concurrently is installed
-                - concurrently "vovk dev" "next dev"
-            - If concurrently is NOT installed
-                - vovk dev --next-dev
-        - Open http://localhost:3000/api/hello-world
-        - Show how to make a request to the example route
-    - Show success message
-*/
-
-import { confirm } from '@inquirer/prompts';
-// Or
-// import confirm from '@inquirer/confirm';
-
-// eslint-disable-next-line no-console
-void confirm({ message: 'Continue?' }).then(console.info);
-
-/*
-const wizard = [
-  {
-    description: 'Check if the project is already initialized',
-    type: 'check',
-    choices: {
-      type: 'choice',
-      choices: [
-        {
-          label: 'Yes',
-          action: 'continue',
-        },
-        {
-          label: 'No',
-          action: 'exit',
-          exitMessage: 'Exiting...',
-        },
-      ],
-    },
-  },
-  {
-    description: 'Check for package.json',
-    type: 'check',
-    handleCheck: () => {
-      // Check if the project is already initialized
-    },
-    yes: {
-      action: 'continue',
-    },
-    no: {
-      action: 'exit',
-      exitMessage: 'Exiting...',
-    },
-  },
-  {
-    description: 'Check for tsconfig.json',
-    type: 'check',
-    handleCheck: () => {
-      // Check for package.json
-    },
-    yes: {
-      action: 'continue',
-    },
-    no: {
-      action: 'exit',
-      exitMessage: 'Exiting...',
-    },
-  },
-  {
-    description: 'Check Next.js installed with app router',
-    type: 'check',
-    handleCheck: () => {
-      // Check for tsconfig.json
-    },
-    yes: {
-      action: 'continue',
-    },
-    no: {
-      action: 'exit',
-      exitMessage: 'Exiting...',
-    },
-  },
-  {
-    description: 'Choose validation library',
-    type: 'install',
-    choices: {
-      type: 'choice',
-      choices: [
-        {
-          package: 'vovk-zod',
-          action: 'install',
-          notes: 'Further installation notes: install zod',
-        },
-        {
-          package: 'vovk-yup',
-          action: 'install',
-          notes: 'Further installation notes: install yup',
-        },
-        {
-          package: 'vovk-dto',
-          action: 'install',
-          notes: 'Further installation notes: install class-validator and class-transformer',
-        },
-        {
-          package: null,
-          action: 'continue',
-        },
-      ],
-    },
-  },
-  {
-    description: 'Do you want to enable client validation?',
-    type: 'choice',
-    choices: [
-      {
-        label: 'Yes',
-        action: 'updateConfig',
-      },
-      {
-        label: 'No',
-        action: 'updateConfig',
-      },
-    ],
-  },
-];
-
-// export default console.info(wizard);
-*/

package/src/locateSegments.mts

@@ -1,40 +0,0 @@
-import { promises as fs } from 'fs';
-import * as path from 'path';
-import fileExists from './utils/fileExists.mjs';
-
-export type Segment = {
-  routeFilePath: string;
-  segmentName: string;
-};
-
-export default async function locateSegments(dir: string, rootDir = dir): Promise<Segment[]> {
-  let results: Segment[] = [];
-
-  // Read the contents of the directory
-  const list = await fs.readdir(dir);
-
-  // Iterate through each item in the directory
-  for (const file of list) {
-    const filePath = path.join(dir, file);
-    const stat = await fs.stat(filePath);
-
-    if (stat.isDirectory()) {
-      // Check if the directory name matches the pattern [[...something]]
-      if (file.startsWith('[[...') && file.endsWith(']]')) {
-        // Check if there's a route.ts file inside this directory
-        const routeFilePath = path.join(filePath, 'route.ts');
-        if (await fileExists(routeFilePath)) {
-          // Calculate the basePath relative to the root directory
-          const segmentName = path.relative(rootDir, dir);
-          results.push({ routeFilePath, segmentName });
-        }
-      }
-
-      // Recursively search inside subdirectories
-      const subDirResults = await locateSegments(filePath, rootDir);
-      results = results.concat(subDirResults);
-    }
-  }
-
-  return results;
-}

package/src/postinstall.mts

@@ -1,27 +0,0 @@
-import { promises as fs } from 'fs';
-import path from 'path';
-
-/**
- * Checks if a file exists at the given path.
- * @param {string} filePath - The path to the file.
- * @returns {Promise<boolean>} - A promise that resolves to true if the file exists, false otherwise.
- */
-const fileExists = async (filePath: string): Promise<boolean> => !!(await fs.stat(filePath).catch(() => false));
-
-async function postinstall(): Promise<void> {
-  const vovk = path.join(import.meta.dirname, '../../.vovk');
-  const js = path.join(vovk, 'client.js');
-  const ts = path.join(vovk, 'client.d.ts');
-  const index = path.join(vovk, 'index.ts');
-
-  if ((await fileExists(js)) || (await fileExists(ts)) || (await fileExists(index))) {
-    return;
-  }
-
-  await fs.mkdir(vovk, { recursive: true });
-  await fs.writeFile(js, '/* postinstall */');
-  await fs.writeFile(ts, '/* postinstall */');
-  await fs.writeFile(index, '/* postinstall */');
-}
-
-void postinstall();