vovk-cli 0.0.1-draft.66 → 0.0.1-draft.68

package/client-templates/main/main.cjs.ejs

@@ -1,11 +1,11 @@
 <%- '// auto-generated\n/* eslint-disable */' %>
-const { default: fetcher } = require('<%= fetcherClientImportPath %>');
-const { default: createRPC } = require('<%= createRPCImportPath %>');
-const schema = require('<%= schemaOutImportPath %>');
-const { default: validateOnClient = null } = <%- validateOnClientImportPath ? `require('${validateOnClientImportPath}')` : '{}'%>;
-const apiRoot = '<%= apiRoot %>';
-<% segments.forEach((segment) => { 
-  Object.keys(segmentsSchema[segment.segmentName].controllers).forEach((key) => { %>
+const { default: fetcher } = require('<%= template.imports.fetcher %>');
+const { default: createRPC } = require('<%= template.imports.createRPC %>');
+const schema = require('<%= template.imports.schema %>');
+const { default: validateOnClient = null } = <%- template.imports.validateOnClient ? `require('${template.imports.validateOnClient}')` : '{}'%>;
+const apiRoot = '<%= template.apiRoot %>';
+<% template.segments.forEach((segment) => { 
+  Object.keys(template.fullSchema[segment.segmentName].controllers).forEach((key) => { %>
 exports.<%= key %> = createRPC(
   schema['<%= segment.segmentName %>'].controllers.<%= key %>, 
   '<%= segment.segmentName %>', 

package/client-templates/main/main.d.cts.ejs

@@ -1,14 +1,14 @@
 
 <%- '// auto-generated\n/* eslint-disable */' %>
 import type { VovkClientFetcher } from 'vovk';
-import type fetcher from '<%= fetcherClientImportPath %>';
-import type createRPC from '<%= createRPCImportPath %>';
-<% segments.forEach((segment, i) => { if(Object.keys(segmentsSchema[segment.segmentName].controllers).length) { %>
+import type fetcher from '<%= template.imports.fetcher %>';
+import type createRPC from '<%= template.imports.createRPC %>';
+<% template.segments.forEach((segment, i) => { if(Object.keys(template.fullSchema[segment.segmentName].controllers).length) { %>
 import type { Controllers as Controllers<%= i %> } from "<%= segment.segmentImportPath %>";
 <% }}) %>
 type Options = typeof fetcher extends VovkClientFetcher<infer U> ? U : never;
-<% segments.forEach((segment, i) => {
-  Object.keys(segmentsSchema[segment.segmentName].controllers).forEach((key) => { %>
+<% template.segments.forEach((segment, i) => {
+  Object.keys(template.fullSchema[segment.segmentName].controllers).forEach((key) => { %>
 export const <%= key %>: ReturnType<typeof createRPC<Controllers<%= i %>["<%= key %>"], Options>>;
   <% }) 
 }) %>

package/client-templates/module/module.d.mts.ejs

@@ -1,14 +1,14 @@
 
 <%- '// auto-generated\n/* eslint-disable */' %>
 import type { VovkClientFetcher } from 'vovk';
-import type fetcher from '<%= fetcherClientImportPath %>';
-import type createRPC from '<%= createRPCImportPath %>';
-<% segments.forEach((segment, i) => { if(Object.keys(segmentsSchema[segment.segmentName].controllers).length) { %>
+import type fetcher from '<%= template.imports.module.fetcher %>';
+import type createRPC from '<%= template.imports.module.createRPC %>';
+<% template.segments.forEach((segment, i) => { if(Object.keys(template.fullSchema[segment.segmentName].controllers).length) { %>
 import type { Controllers as Controllers<%= i %> } from "<%= segment.segmentImportPath %>";
 <% }}) %>
 type Options = typeof fetcher extends VovkClientFetcher<infer U> ? U : never;
-<% segments.forEach((segment, i) => { 
-  Object.keys(segmentsSchema[segment.segmentName].controllers).forEach((key) => { %>
+<% template.segments.forEach((segment, i) => { 
+  Object.keys(template.fullSchema[segment.segmentName].controllers).forEach((key) => { %>
 export const <%= key %>: ReturnType<typeof createRPC<Controllers<%= i %>["<%= key %>"], Options>>;
   <% }) 
 }) %>

package/client-templates/module/module.mjs.ejs

@@ -1,18 +1,18 @@
 <%- '// auto-generated\n/* eslint-disable */' %>
-import fetcherImport from '<%= fetcherClientImportPath %>';
-import createRPCImport from '<%= createRPCImportPath %>';
-import schema from '<%= schemaOutImportPath %>';
-<% if (validateOnClientImportPath) { %>
-import validateOnClientImport from '<%= validateOnClientImportPath %>';
+import fetcherImport from '<%= template.imports.module.fetcher %>';
+import createRPCImport from '<%= template.imports.module.createRPC %>';
+import schema from '<%= template.imports.module.schema %>';
+<% if (template.imports.module.validateOnClient) { %>
+import validateOnClientImport from '<%= template.imports.module.validateOnClient %>';
 const validateOnClient = validateOnClientImport.default || validateOnClientImport;
 <% } else { %>
 const validateOnClient = undefined;
 <% } %>
-const apiRoot = '<%= apiRoot %>';
+const apiRoot = '<%= template.apiRoot %>';
 const fetcher = fetcherImport.default || fetcherImport;
 const createRPC = createRPCImport.default || createRPCImport;
-<% segments.forEach((segment, i) => {
-  Object.keys(segmentsSchema[segment.segmentName].controllers).forEach((key) => { %>
+<% template.segments.forEach((segment, i) => {
+  Object.keys(template.fullSchema[segment.segmentName].controllers).forEach((key) => { %>
 export const <%= key %> = createRPC(
   schema['<%= segment.segmentName %>'].controllers.<%= key %>, 
   '<%= segment.segmentName %>', 

package/client-templates/ts/index.ts.ejs

@@ -1,21 +1,21 @@
 <%- '// auto-generated\n/* eslint-disable */' %>
 import type { VovkClientFetcher } from 'vovk';
-import fetcher from '<%= fetcherClientImportPath %>';
-import createRPC from '<%= createRPCImportPath %>';
-import schema from '<%= schemaOutImportPath %>';
-<% segments.forEach((segment, i) => { if(Object.keys(segmentsSchema[segment.segmentName].controllers).length) { %>
+import fetcher from '<%= template.imports.fetcher %>';
+import createRPC from '<%= template.imports.createRPC %>';
+import schema from '<%= template.imports.schema %>';
+<% template.segments.forEach((segment, i) => { if(Object.keys(template.fullSchema[segment.segmentName].controllers).length) { %>
 import type { Controllers as Controllers<%= i %> } from "<%= segment.segmentImportPath %>";
 <% }}) %>
-<% if (validateOnClientImportPath) { %>
-import validateOnClient from '<%= validateOnClientImportPath %>';
+<% if (template.imports.validateOnClient) { %>
+import validateOnClient from '<%= template.imports.validateOnClient %>';
 <% } else { %>
 const validateOnClient = undefined;
 <% } %>
 type Options = typeof fetcher extends VovkClientFetcher<infer U> ? U : never;
-const apiRoot = '<%= apiRoot %>';
+const apiRoot = '<%= template.apiRoot %>';
 
-<% segments.forEach((segment, i) => { %>
-  <% Object.keys(segmentsSchema[segment.segmentName].controllers).forEach((key) => { %>
+<% template.segments.forEach((segment, i) => { %>
+  <% Object.keys(template.fullSchema[segment.segmentName].controllers).forEach((key) => { %>
 export const <%= key %> = createRPC<Controllers<%= i %>["<%= key %>"], Options>(
   schema['<%= segment.segmentName %>'].controllers.<%= key %>, 
   '<%= segment.segmentName %>', 

package/dist/dev/ensureSchemaFiles.mjs

@@ -9,7 +9,6 @@ import formatLoggedSegmentName from '../utils/formatLoggedSegmentName.mjs';
 export default async function ensureSchemaFiles(projectInfo, schemaOutAbsolutePath, segmentNames) {
     const now = Date.now();
     let hasChanged = false;
-    // Create index.js file
     const indexContent = `// auto-generated
 ${segmentNames
         .map((segmentName) => {
@@ -18,12 +17,12 @@ ${segmentNames
         .join('\n')}`;
     const dTsContent = `// auto-generated
 import type { VovkSchema } from 'vovk';
-declare const segmentSchema: {
-${segmentNames.map((segmentName) => `  '${segmentName}': VovkSchema;`).join('\n')}
+declare const fullSchema: {
+${segmentNames.map((segmentName) => `  '${segmentName}': typeof import('./${segmentName || ROOT_SEGMENT_SCHEMA_NAME}.json');`).join('\n')}
 };
-export default segmentSchema;`;
-    const jsAbsolutePath = path.join(schemaOutAbsolutePath, 'index.js');
-    const dTsAbsolutePath = path.join(schemaOutAbsolutePath, 'index.d.ts');
+export default fullSchema;`;
+    const jsAbsolutePath = path.join(schemaOutAbsolutePath, 'index.cjs');
+    const dTsAbsolutePath = path.join(schemaOutAbsolutePath, 'index.d.cts');
     const existingJs = await fs.readFile(jsAbsolutePath, 'utf-8').catch(() => null);
     const existingDTs = await fs.readFile(dTsAbsolutePath, 'utf-8').catch(() => null);
     await fs.mkdir(schemaOutAbsolutePath, { recursive: true });

package/dist/dev/index.mjs

@@ -150,6 +150,7 @@ export class VovkDev {
             }
             else {
                 log.info('Config file has been updated');
+                this.#generate();
             }
             isInitial = false;
         }, 1000);
@@ -347,7 +348,7 @@ export class VovkDev {
             });
         }
         else {
-            log.info(`Ready in ${Date.now() - now}ms. Making initial requests for schemas in a moment...`);
+            log.info(`Ready in ${Date.now() - now}ms. Making requests for schemas in a moment...`);
         }
     }
 }

package/dist/dev/logDiffResult.mjs

@@ -29,23 +29,23 @@ export default function logDiffResult(segmentName, diffResult, projectInfo) {
             case 'controller':
                 switch (diffNormalizedItem.type) {
                     case 'added':
-                        projectInfo.log.info(`Schema forn RPC ${chalkHighlightThing(diffNormalizedItem.name)} has been ${addedText} at ${formatLoggedSegmentName(segmentName)}`);
+                        projectInfo.log.info(`Schema for RPC ${chalkHighlightThing(diffNormalizedItem.name)} has been ${addedText} at ${formatLoggedSegmentName(segmentName)}`);
                         break;
                     case 'removed':
-                        projectInfo.log.info(`Schema forn RPC ${chalkHighlightThing(diffNormalizedItem.name)} has been ${removedText} from ${formatLoggedSegmentName(segmentName)}`);
+                        projectInfo.log.info(`Schema for RPC ${chalkHighlightThing(diffNormalizedItem.name)} has been ${removedText} from ${formatLoggedSegmentName(segmentName)}`);
                         break;
                 }
                 break;
             case 'controllerHandler':
                 switch (diffNormalizedItem.type) {
                     case 'added':
-                        projectInfo.log.info(`Schema forn RPC method ${chalkHighlightThing(diffNormalizedItem.name)} has been ${addedText} at ${formatLoggedSegmentName(segmentName)}`);
+                        projectInfo.log.info(`Schema for RPC method ${chalkHighlightThing(diffNormalizedItem.name)} has been ${addedText} at ${formatLoggedSegmentName(segmentName)}`);
                         break;
                     case 'removed':
-                        projectInfo.log.info(`Schema forn RPC method ${chalkHighlightThing(diffNormalizedItem.name)} has been ${removedText} from ${formatLoggedSegmentName(segmentName)}`);
+                        projectInfo.log.info(`Schema for RPC method ${chalkHighlightThing(diffNormalizedItem.name)} has been ${removedText} from ${formatLoggedSegmentName(segmentName)}`);
                         break;
                     case 'changed':
-                        projectInfo.log.info(`Schema forn RPC method ${chalkHighlightThing(diffNormalizedItem.name)} has been ${changedText} at ${formatLoggedSegmentName(segmentName)}`);
+                        projectInfo.log.info(`Schema for RPC method ${chalkHighlightThing(diffNormalizedItem.name)} has been ${changedText} at ${formatLoggedSegmentName(segmentName)}`);
                         break;
                 }
                 break;

package/dist/generate/index.mjs

@@ -7,7 +7,7 @@ import getClientTemplates from './getClientTemplates.mjs';
 export default async function generate({ projectInfo, segments, segmentsSchema, forceNothingWrittenLog, templates, prettify: prettifyClient, fullSchema, }) {
     templates = templates ?? projectInfo.config.experimental_clientGenerateTemplateNames;
     const noClient = templates?.[0] === 'none';
-    const { config, cwd, log, validateOnClientImportPath, apiRoot, fetcherClientImportPath, createRPCImportPath, schemaOutImportPath, } = projectInfo;
+    const { config, cwd, log, clientImports, apiRoot } = projectInfo;
     const { clientOutDirAbsolutePath, templateFiles } = getClientTemplates({ config, cwd, templateNames: templates });
     // Ensure that each segment has a matching schema if it needs to be emitted:
     for (let i = 0; i < segments.length; i++) {
@@ -21,14 +21,11 @@ export default async function generate({ projectInfo, segments, segmentsSchema,
     }
     const now = Date.now();
     // Data for the EJS templates:
-    const ejsData = {
+    const template = {
         apiRoot,
-        fetcherClientImportPath,
-        schemaOutImportPath,
-        validateOnClientImportPath,
-        createRPCImportPath,
+        imports: clientImports,
         segments,
-        segmentsSchema,
+        fullSchema: segmentsSchema,
     };
     // Process each template in parallel
     const processedTemplates = noClient
@@ -37,7 +34,11 @@ export default async function generate({ projectInfo, segments, segmentsSchema,
             // Read the EJS template
             const templateContent = await fs.readFile(templatePath, 'utf-8');
             // Render the template
-            let rendered = templatePath.endsWith('.ejs') ? ejs.render(templateContent, ejsData) : templateContent;
+            let rendered = templatePath.endsWith('.ejs')
+                ? ejs.render(templateContent, { template }, {
+                    filename: templatePath,
+                })
+                : templateContent;
             // Optionally prettify
             if (prettifyClient || config.prettifyClient) {
                 rendered = await prettify(rendered, outPath);

package/dist/getProjectInfo/getConfig.d.mts

@@ -1,11 +1,11 @@
-import type { VovkConfig } from '../types.mjs';
+import type { VovkStrictConfig } from '../types.mjs';
 export default function getConfig({ clientOutDir, cwd }: {
     clientOutDir?: string;
     cwd: string;
 }): Promise<{
-    config: Required<VovkConfig>;
+    config: VovkStrictConfig;
     srcRoot: string;
     configAbsolutePaths: string[];
-    userConfig: VovkConfig | null;
+    userConfig: import("../types.mjs").VovkConfig | null;
     error: Error | undefined;
 }>;

package/dist/getProjectInfo/getConfig.mjs

@@ -5,11 +5,14 @@ export default async function getConfig({ clientOutDir, cwd }) {
     const { configAbsolutePaths, error, userConfig } = await getUserConfig({ cwd });
     const conf = userConfig ?? {};
     const srcRoot = await getRelativeSrcRoot({ cwd });
+    const validateOnClientImport = env.VOVK_VALIDATE_ON_CLIENT_PATH ?? conf.validateOnClientImport ?? null;
+    const fetcherImport = env.VOVK_FETCHER_PATH ?? conf.fetcherImport ?? 'vovk/dist/client/defaultFetcher.js';
+    const createRPCImport = env.VOVK_CREATE_RPC_PATH ?? conf.createRPCImport ?? 'vovk/dist/client/createRPC.js';
     const config = {
         modulesDir: env.VOVK_MODULES_DIR ?? conf.modulesDir ?? './' + [srcRoot, 'modules'].filter(Boolean).join('/'),
-        validateOnClientPath: env.VOVK_VALIDATE_ON_CLIENT_PATH ?? conf.validateOnClientPath ?? null,
-        fetcherPath: env.VOVK_FETCHER_PATH ?? conf.fetcherPath ?? 'vovk/dist/client/defaultFetcher.js',
-        createRPCPath: env.VOVK_CREATE_RPC_PATH ?? conf.createRPCPath ?? 'vovk/dist/client/createRPC.js',
+        validateOnClientImport: typeof validateOnClientImport === 'string' ? [validateOnClientImport] : validateOnClientImport,
+        fetcherImport: typeof fetcherImport === 'string' ? [fetcherImport] : fetcherImport,
+        createRPCImport: typeof createRPCImport === 'string' ? [createRPCImport] : createRPCImport,
         schemaOutDir: env.VOVK_SCHEMA_OUT_DIR ?? conf.schemaOutDir ?? './.vovk-schema',
         clientOutDir: clientOutDir ?? env.VOVK_CLIENT_OUT_DIR ?? conf.clientOutDir ?? './node_modules/.vovk-client',
         origin: (env.VOVK_ORIGIN ?? conf.origin ?? '').replace(/\/$/, ''), // Remove trailing slash

package/dist/getProjectInfo/index.d.mts

@@ -9,11 +9,19 @@ export default function getProjectInfo({ port: givenPort, clientOutDir, cwd, }?:
     apiRoot: string;
     apiDir: string;
     srcRoot: string;
-    schemaOutImportPath: string;
-    fetcherClientImportPath: string;
-    createRPCImportPath: string;
-    validateOnClientImportPath: string | null;
-    config: Required<import("../types.mjs").VovkConfig>;
+    config: import("../types.mjs").VovkStrictConfig;
+    clientImports: {
+        schema: string;
+        fetcher: string;
+        createRPC: string;
+        validateOnClient: string | null;
+        module: {
+            schema: string;
+            fetcher: string;
+            createRPC: string;
+            validateOnClient: string | null;
+        };
+    };
     log: {
         info: (msg: string) => void;
         warn: (msg: string) => void;

package/dist/getProjectInfo/index.mjs

@@ -9,16 +9,7 @@ export default async function getProjectInfo({ port: givenPort, clientOutDir, cw
     const apiRoot = `${config.origin ?? ''}/${config.rootEntry}`;
     const apiDir = path.join(srcRoot, 'app', config.rootEntry);
     const schemaOutImportPath = path.relative(config.clientOutDir, config.schemaOutDir).replace(/\\/g, '/') + // windows fix
-        '/index.js';
-    const fetcherClientImportPath = config.fetcherPath.startsWith('.')
-        ? path.relative(config.clientOutDir, config.fetcherPath)
-        : config.fetcherPath;
-    const createRPCImportPath = config.createRPCPath.startsWith('.')
-        ? path.relative(config.clientOutDir, config.createRPCPath)
-        : config.createRPCPath;
-    const validateOnClientImportPath = config.validateOnClientPath?.startsWith('.')
-        ? path.relative(config.clientOutDir, config.validateOnClientPath)
-        : config.validateOnClientPath;
+        '/index.cjs';
     const log = getLogger(config.logLevel);
     if (configAbsolutePaths.length > 1) {
         log.warn(`Multiple config files found. Using the first one: ${configAbsolutePaths[0]}`);
@@ -26,17 +17,29 @@ export default async function getProjectInfo({ port: givenPort, clientOutDir, cw
     if (!userConfig && configAbsolutePaths.length > 0) {
         log.error(`Error reading config file at ${configAbsolutePaths[0]}: ${error?.message ?? 'Unknown Error'}`);
     }
+    const getImportPath = (p) => (p.startsWith('.') ? path.relative(config.clientOutDir, p) : p);
+    const clientImports = {
+        schema: schemaOutImportPath,
+        fetcher: getImportPath(config.fetcherImport[0]),
+        createRPC: getImportPath(config.createRPCImport[0]),
+        validateOnClient: config.validateOnClientImport ? getImportPath(config.validateOnClientImport[0]) : null,
+        module: {
+            schema: schemaOutImportPath,
+            fetcher: getImportPath(config.fetcherImport[1] ?? config.fetcherImport[0]),
+            createRPC: getImportPath(config.createRPCImport[1] ?? config.createRPCImport[0]),
+            validateOnClient: config.validateOnClientImport
+                ? getImportPath(config.validateOnClientImport[1] ?? config.validateOnClientImport[0])
+                : null,
+        },
+    };
     return {
         cwd,
         port,
         apiRoot,
         apiDir,
         srcRoot,
-        schemaOutImportPath,
-        fetcherClientImportPath,
-        createRPCImportPath,
-        validateOnClientImportPath,
         config,
+        clientImports,
         log,
     };
 }

package/dist/index.mjs

@@ -20,10 +20,10 @@ program
     .command('dev')
     .alias('d')
     .description('start schema watcher (optional flag --next-dev to start it with Next.js)')
+    .argument('[nextArgs...]', 'extra arguments for the dev command')
     .option('--next-dev', 'start schema watcher and Next.js with automatic port allocation')
     .option('--exit', 'kill the processe when schema and client is generated')
-    .allowUnknownOption(true)
-    .action(async (options, command) => {
+    .action(async (nextArgs, options) => {
     const { nextDev, exit = false } = options;
     const portAttempts = 30;
     const PORT = !nextDev
@@ -40,7 +40,7 @@ program
     if (nextDev) {
         const { result } = concurrently([
             {
-                command: `npx next dev ${command.args.join(' ')}`,
+                command: `npx next dev ${nextArgs.join(' ')}`,
                 name: 'Next.js Development Server',
                 env: { PORT },
             },
@@ -72,7 +72,7 @@ program
 program
     .command('generate')
     .alias('g')
-    .description('Generate client')
+    .description('Generate RPC client from schema')
     .option('--out, --client-out-dir <path>', 'path to output directory')
     .option('--template, --templates <templates...>', 'client code templates ("ts", "compiled", "python", "none", a custom path)')
     .option('--full-schema [fileName]', 'generate client with full schema')
@@ -83,7 +83,7 @@ program
     const { cwd, config, apiDir } = projectInfo;
     const segments = await locateSegments({ dir: apiDir, config });
     const schemaOutAbsolutePath = path.join(cwd, config.schemaOutDir);
-    const schemaImportUrl = pathToFileURL(path.join(schemaOutAbsolutePath, 'index.js')).href;
+    const schemaImportUrl = pathToFileURL(path.join(schemaOutAbsolutePath, 'index.cjs')).href;
     const { default: segmentsSchema } = (await import(schemaImportUrl));
     await generate({
         projectInfo,

package/dist/init/createConfig.d.mts

@@ -1,9 +1,9 @@
 import type getLogger from '../utils/getLogger.mjs';
 import type { InitOptions } from '../types.mjs';
-export default function createConfig({ root, log, options: { validationLibrary, validateOnClient, channel, dryRun }, }: {
+export default function createConfig({ root, log, options: { validationLibrary, validateOnClient, reactQuery, channel, dryRun }, }: {
     root: string;
     log: ReturnType<typeof getLogger>;
-    options: Pick<InitOptions, 'validationLibrary' | 'validateOnClient' | 'channel' | 'dryRun'>;
+    options: Pick<InitOptions, 'validationLibrary' | 'validateOnClient' | 'reactQuery' | 'channel' | 'dryRun'>;
 }): Promise<{
     configAbsolutePath: string;
 }>;

package/dist/init/createConfig.mjs

@@ -3,7 +3,7 @@ import fs from 'node:fs/promises';
 import getTemplateFilesFromPackage from './getTemplateFilesFromPackage.mjs';
 import prettify from '../utils/prettify.mjs';
 import getFileSystemEntryType, { FileSystemEntryType } from '../utils/getFileSystemEntryType.mjs';
-export default async function createConfig({ root, log, options: { validationLibrary, validateOnClient, channel, dryRun }, }) {
+export default async function createConfig({ root, log, options: { validationLibrary, validateOnClient, reactQuery, channel, dryRun }, }) {
     const config = {};
     const dotConfigPath = path.join(root, '.config');
     const dir = (await getFileSystemEntryType(dotConfigPath)) === FileSystemEntryType.DIRECTORY ? dotConfigPath : root;
@@ -17,7 +17,7 @@ export default async function createConfig({ root, log, options: { validationLib
     };
     if (validationLibrary) {
         if (validateOnClient) {
-            config.validateOnClientPath = `${validationLibrary}/validateOnClient/index.js`;
+            config.validateOnClientImport = `${validationLibrary}/validateOnClient.js`;
         }
         try {
             const validationTemplates = await getTemplateFilesFromPackage(validationLibrary, channel);
@@ -27,6 +27,9 @@ export default async function createConfig({ root, log, options: { validationLib
             log.warn(`Failed to fetch validation library templates: ${error.message}`);
         }
     }
+    if (reactQuery) {
+        config.createRPCImport = 'vovk-react-query';
+    }
     config.templates = templates;
     const configStr = await prettify(`/** @type {import('vovk-cli').VovkConfig} */
 const config = ${JSON.stringify(config, null, 2)};

package/dist/init/index.d.mts

@@ -4,5 +4,5 @@ export declare class Init {
     #private;
     root: string;
     log: ReturnType<typeof getLogger>;
-    main(prefix: string, { yes, logLevel, useNpm, useYarn, usePnpm, useBun, skipInstall, updateTsConfig, updateScripts, validationLibrary, validateOnClient, dryRun, channel, }: InitOptions): Promise<void>;
+    main(prefix: string, { yes, logLevel, useNpm, useYarn, usePnpm, useBun, skipInstall, updateTsConfig, updateScripts, validationLibrary, validateOnClient, reactQuery, dryRun, channel, }: InitOptions): Promise<void>;
 }

package/dist/init/index.mjs

@@ -17,10 +17,10 @@ import NPMCliPackageJson from '@npmcli/package-json';
 export class Init {
     root;
     log;
-    async #init({ configPaths, pkgJson, }, { useNpm, useYarn, usePnpm, useBun, skipInstall, updateTsConfig, updateScripts, validationLibrary, validateOnClient, dryRun, channel, }) {
+    async #init({ configPaths, pkgJson, }, { useNpm, useYarn, usePnpm, useBun, skipInstall, updateTsConfig, updateScripts, validationLibrary, validateOnClient, reactQuery, dryRun, channel, }) {
         const { log, root } = this;
         const dependencies = ['vovk', 'vovk-client'];
-        const devDependencies = ['vovk-cli'];
+        const devDependencies = ['vovk-cli', 'openapi3-ts'];
         // delete older config files
         if (configPaths.length) {
             await Promise.all(configPaths.map((configPath) => fs.rm(configPath)));
@@ -34,6 +34,10 @@ export class Init {
                 'vovk-dto': ['class-validator', 'class-transformer', 'vovk-mapped-types', 'reflect-metadata'],
             }[validationLibrary] ?? []));
         }
+        if (reactQuery) {
+            dependencies.push('vovk-react-query');
+            dependencies.push('@tanstack/react-query');
+        }
         if (updateScripts) {
             try {
                 if (!dryRun)
@@ -102,7 +106,7 @@ export class Init {
             const { configAbsolutePath } = await createConfig({
                 root,
                 log,
-                options: { validationLibrary, validateOnClient, channel, dryRun },
+                options: { validationLibrary, validateOnClient, reactQuery, channel, dryRun },
             });
             log.info('Config created successfully at ' + configAbsolutePath);
         }
@@ -110,7 +114,7 @@ export class Init {
             log.error(`Failed to create config: ${error.message}`);
         }
     }
-    async main(prefix, { yes, logLevel, useNpm, useYarn, usePnpm, useBun, skipInstall, updateTsConfig, updateScripts, validationLibrary, validateOnClient, dryRun, channel, }) {
+    async main(prefix, { yes, logLevel, useNpm, useYarn, usePnpm, useBun, skipInstall, updateTsConfig, updateScripts, validationLibrary, validateOnClient, reactQuery, dryRun, channel, }) {
         const cwd = process.cwd();
         const root = path.resolve(cwd, prefix);
         const log = getLogger(logLevel);
@@ -129,6 +133,7 @@ export class Init {
                 updateScripts: updateScripts ?? 'implicit',
                 validationLibrary: validationLibrary?.toLocaleLowerCase() === 'none' ? null : (validationLibrary ?? 'vovk-zod'),
                 validateOnClient: validateOnClient ?? true,
+                reactQuery: reactQuery ?? true,
                 dryRun: dryRun ?? false,
                 channel: channel ?? 'latest',
             });
@@ -181,7 +186,7 @@ export class Init {
         updateScripts =
             updateScripts ??
                 (await select({
-                    message: 'Do you want to update package.json by adding "generate" and "dev" NPM scripts?',
+                    message: 'Do you want to update package.json by adding "generate" and updating "dev" NPM scripts?',
                     default: 'implicit',
                     choices: [
                         {
@@ -201,17 +206,22 @@ export class Init {
                         },
                     ],
                 }));
+        reactQuery =
+            reactQuery ??
+                (await confirm({
+                    message: 'Do you want to use @tanstack/react-query for data fetching at React components?',
+                }));
         if (typeof updateTsConfig === 'undefined') {
             let shouldAsk = false;
             try {
                 shouldAsk = !(await checkTSConfigForExperimentalDecorators(root));
             }
             catch (error) {
-                log.error(`Failed to check tsconfig.json for experimentalDecorators: ${error.message}`);
+                log.error(`Failed to check tsconfig.json for "experimentalDecorators": ${error.message}`);
             }
             if (shouldAsk) {
                 updateTsConfig = await confirm({
-                    message: 'Do you want to add experimentalDecorators to tsconfig.json?',
+                    message: 'Do you want to add "experimentalDecorators" option to tsconfig.json?',
                 });
             }
         }
@@ -225,6 +235,7 @@ export class Init {
             updateScripts,
             validationLibrary,
             validateOnClient,
+            reactQuery,
             dryRun,
             channel,
         });

package/dist/initProgram.mjs

@@ -2,20 +2,21 @@ import { Init } from './init/index.mjs';
 // reused at vovk-init
 export default function initProgram(program) {
     return program
-        .argument('[prefix]', 'Directory to initialize project in', '.')
-        .description('Initialize Vovk project')
-        .option('-y, --yes', 'Skip all prompts and use default values')
-        .option('--log-level <level>', 'Set log level', 'info')
-        .option('--use-npm', 'Use npm as package manager')
-        .option('--use-yarn', 'Use yarn as package manager')
-        .option('--use-pnpm', 'Use pnpm as package manager')
-        .option('--use-bun', 'Use bun as package manager')
-        .option('--skip-install', 'Skip installing dependencies')
-        .option('--update-ts-config', 'Update tsconfig.json')
-        .option('--update-scripts <mode>', 'Update package.json scripts ("implicit" or "explicit")')
-        .option('--validation-library <library>', 'Validation library to use ("vovk-zod", "vovk-yup", "vovk-dto" or another). Set to "none" to skip validation')
-        .option('--validate-on-client', 'Path to validateOnClient file')
-        .option('--channel <channel>', 'Channel to use for fetching packages', 'latest')
-        .option('--dry-run', 'Do not write files to disk')
+        .argument('[prefix]', 'directory to initialize project in', '.')
+        .description('Initialize Vovk.ts project')
+        .option('-y, --yes', 'skip all prompts and use default values')
+        .option('--log-level <level>', 'set log level', 'info')
+        .option('--use-npm', 'use npm as package manager')
+        .option('--use-yarn', 'use yarn as package manager')
+        .option('--use-pnpm', 'use pnpm as package manager')
+        .option('--use-bun', 'use bun as package manager')
+        .option('--skip-install', 'skip installing dependencies')
+        .option('--update-ts-config', 'update tsconfig.json')
+        .option('--update-scripts <mode>', 'update package.json scripts ("implicit" or "explicit")')
+        .option('--validation-library <library>', 'validation library to use ("vovk-zod", "vovk-yup", "vovk-dto" or another); set to "none" to skip')
+        .option('--validate-on-client', 'path to validateOnClient file')
+        .option('--react-query', 'use @tanstack/react-query for data fetching inside components')
+        .option('--channel <channel>', 'channel to use for fetching packages', 'latest')
+        .option('--dry-run', 'do not write files to disk')
         .action((prefix = '.', options) => new Init().main(prefix, options));
 }

package/dist/new/newSegment.mjs

@@ -5,6 +5,7 @@ import getFileSystemEntryType from '../utils/getFileSystemEntryType.mjs';
 import chalkHighlightThing from '../utils/chalkHighlightThing.mjs';
 import formatLoggedSegmentName from '../utils/formatLoggedSegmentName.mjs';
 import prettify from '../utils/prettify.mjs';
+import chalk from 'chalk';
 export default async function newSegment({ segmentName, overwrite, dryRun, }) {
     const { apiDir, cwd, log } = await getProjectInfo();
     const absoluteSegmentRoutePath = path.join(cwd, apiDir, segmentName, '[[...vovk]]/route.ts');
@@ -29,5 +30,6 @@ ${segmentName ? `  segmentName: '${segmentName}',\n` : ''}  emitSchema: true,
         await fs.writeFile(absoluteSegmentRoutePath, code);
     }
     log.info(`${formatLoggedSegmentName(segmentName, { upperFirst: true })} created at ${absoluteSegmentRoutePath}.`);
-    log.info(`Run ${chalkHighlightThing(`npx vovk new service controller ${[segmentName, 'thing'].filter(Boolean).join('/')}`)} to create a new controller with a service at /modules/thing/ folder.`);
+    const dir = chalk.cyanBright([segmentName, 'thing'].filter(Boolean).join('/'));
+    log.info(`Run ${chalkHighlightThing(`npx vovk new service controller ${dir}`)} to create a new controller with a service at modules/${dir} folder for this segment`);
 }

package/dist/types.d.mts

@@ -21,9 +21,9 @@ export type VovkEnv = {
 export type VovkConfig = {
     clientOutDir?: string;
     schemaOutDir?: string;
-    fetcherPath?: string;
-    validateOnClientPath?: string | null;
-    createRPCPath?: string;
+    fetcherImport?: string | string[];
+    validateOnClientImport?: string | string[] | null;
+    createRPCImport?: string | string[];
     modulesDir?: string;
     rootEntry?: string;
     origin?: string;
@@ -38,6 +38,11 @@ export type VovkConfig = {
         [key: string]: string | undefined;
     };
 };
+export type VovkStrictConfig = Required<Omit<VovkConfig, 'validateOnClientImport' | 'fetcherImport' | 'createRPCImport'>> & {
+    validateOnClientImport: string[] | null;
+    fetcherImport: string[];
+    createRPCImport: string[];
+};
 export type VovkModuleRenderResult = {
     fileName: string;
     dir: string;
@@ -66,6 +71,7 @@ export interface InitOptions {
     updateTsConfig?: boolean;
     updateScripts?: 'implicit' | 'explicit';
     validationLibrary?: string | null;
+    reactQuery?: boolean;
     validateOnClient?: boolean;
     dryRun?: boolean;
     channel?: 'latest' | 'beta' | 'draft';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vovk-cli",
-  "version": "0.0.1-draft.66",
+  "version": "0.0.1-draft.68",
   "bin": {
     "vovk": "./dist/index.mjs"
   },
@@ -36,14 +36,14 @@
   },
   "homepage": "https://vovk.dev",
   "peerDependencies": {
-    "vovk": "^3.0.0-draft.65"
+    "vovk": "^3.0.0-draft.67"
   },
   "dependencies": {
     "@inquirer/prompts": "^7.3.1",
     "@npmcli/package-json": "^6.1.1",
     "chalk": "^5.4.1",
     "chokidar": "^4.0.3",
-    "commander": "^12.1.0",
+    "commander": "^13.1.0",
     "concurrently": "^9.1.2",
     "dotenv": "^16.4.7",
     "ejs": "^3.1.10",