vovk-cli 0.0.1-draft.107 → 0.0.1-draft.109

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023-present Andrii Gubanov
+Copyright (c) 2023-present Andrey 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

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

@@ -1,8 +1,8 @@
 <%- `// auto-generated ${new Date().toISOString()}\n/* eslint-disable */` %>
-const { default: fetcher } = require('<%= t.imports.fetcher %>');
-const { default: createRPC } = require('<%= t.imports.createRPC %>');
+const { fetcher } = require('<%= t.imports.fetcher %>');
+const { createRPC } = require('<%= t.imports.createRPC %>');
 const fullSchema = require('<%= t.imports.fullSchema %>');
-const { default: validateOnClient = null } = <%- t.imports.validateOnClient ? `require('${t.imports.validateOnClient}')` : '{}'%>;
+const { validateOnClient = null } = <%- t.imports.validateOnClient ? `require('${t.imports.validateOnClient}')` : '{}'%>;
 const apiRoot = '<%= t.apiRoot %>';
 <% Object.values(t.fullSchema.segments).forEach((segment) => { 
   Object.keys(segment.controllers).forEach((controllerName) => { %>

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

@@ -1,10 +1,10 @@
 
 <%- `// auto-generated ${new Date().toISOString()}\n/* eslint-disable */` %>
 import type { VovkClientFetcher } from 'vovk';
-import type fetcher from '<%= t.imports.fetcher %>';
-import type createRPC from '<%= t.imports.createRPC %>';
+import type { fetcher } from '<%= t.imports.fetcher %>';
+import type { createRPC } from '<%= t.imports.createRPC %>';
 <% Object.values(t.fullSchema.segments).forEach((segment, i) => { if(Object.keys(segment.controllers).length) { %>
-import type { Controllers as Controllers<%= i %> } from "<%= segment.segmentImportPath %>";
+import type { Controllers as Controllers<%= i %> } from "<%= t.segmentMeta[segment.segmentName].segmentImportPath %>";
 <% }}) %>
 type Options = typeof fetcher extends VovkClientFetcher<infer U> ? U : never;
 <% Object.values(t.fullSchema.segments).forEach((segment, i) => {

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

@@ -1,10 +1,10 @@
 
 <%- `// auto-generated ${new Date().toISOString()}\n/* eslint-disable */` %>
 import type { VovkClientFetcher } from 'vovk';
-import type fetcher from '<%= t.imports.module.fetcher %>';
-import type createRPC from '<%= t.imports.module.createRPC %>';
+import type { fetcher } from '<%= t.imports.module.fetcher %>';
+import type { createRPC } from '<%= t.imports.module.createRPC %>';
 <% Object.values(t.fullSchema.segments).forEach((segment, i) => { if(Object.keys(segment.controllers).length) { %>
-import type { Controllers as Controllers<%= i %> } from "<%= segment.segmentImportPath %>";
+import type { Controllers as Controllers<%= i %> } from "<%= t.segmentMeta[segment.segmentName].segmentImportPath %>";
 <% }}) %>
 type Options = typeof fetcher extends VovkClientFetcher<infer U> ? U : never;
 <% Object.values(t.fullSchema.segments).forEach((segment, i) => { 

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

@@ -1,16 +1,13 @@
 <%- `// auto-generated ${new Date().toISOString()}\n/* eslint-disable */` %>
-import fetcherImport from '<%= t.imports.module.fetcher %>';
-import createRPCImport from '<%= t.imports.module.createRPC %>';
+import { fetcher } from '<%= t.imports.module.fetcher %>';
+import { createRPC } from '<%= t.imports.module.createRPC %>';
 import fullSchema from '<%= t.imports.module.fullSchema %>';
 <% if (t.imports.module.validateOnClient) { %>
-import validateOnClientImport from '<%= t.imports.module.validateOnClient %>';
-const validateOnClient = validateOnClientImport.default || validateOnClientImport;
+import { validateOnClient } from '<%= t.imports.module.validateOnClient %>';
 <% } else { %>
 const validateOnClient = undefined;
 <% } %>
 const apiRoot = '<%= t.apiRoot %>';
-const fetcher = fetcherImport.default || fetcherImport;
-const createRPC = createRPCImport.default || createRPCImport;
 <% Object.values(t.fullSchema.segments).forEach((segment, i) => {
   Object.keys(segment.controllers).forEach((controllerName) => { %>
 export const <%= controllerName %> = createRPC(

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

@@ -1,13 +1,13 @@
 <%- `// auto-generated ${new Date().toISOString()}\n/* eslint-disable */` %>
 import type { VovkClientFetcher } from 'vovk';
-import fetcher from '<%= t.imports.fetcher %>';
-import createRPC from '<%= t.imports.createRPC %>';
+import { fetcher } from '<%= t.imports.fetcher %>';
+import { createRPC } from '<%= t.imports.createRPC %>';
 import fullSchema from '<%= t.imports.fullSchema %>';
 <% Object.values(t.fullSchema.segments).forEach((segment, i) => { if(Object.keys(segment.controllers).length) { %>
-import type { Controllers as Controllers<%= i %> } from "<%= segment.segmentImportPath %>";
+import type { Controllers as Controllers<%= i %> } from "<%= t.segmentMeta[segment.segmentName].segmentImportPath %>";
 <% }}) %>
 <% if (t.imports.validateOnClient) { %>
-import validateOnClient from '<%= t.imports.validateOnClient %>';
+import { validateOnClient } from '<%= t.imports.validateOnClient %>';
 <% } else { %>
 const validateOnClient = undefined;
 <% } %>

package/dist/dev/writeConfigJson.mjs

@@ -7,9 +7,9 @@ export default async function writeConfigJson(schemaOutAbsolutePath, projectInfo
     const existingStr = await fs.readFile(configJsonPath, 'utf-8').catch(() => null);
     if (existingStr !== configStr) {
         await fs.writeFile(configJsonPath, configStr);
-        projectInfo?.log.info(`config.json written to ${configJsonPath}`);
+        projectInfo?.log.info(`Config JSON written to ${configJsonPath}`);
     }
     else {
-        projectInfo?.log.debug(`config.json is up to date at ${configJsonPath}`);
+        projectInfo?.log.debug(`Config JSON is up to date at ${configJsonPath}`);
     }
 }

package/dist/generate/ensureClient.d.mts

@@ -1,5 +1,4 @@
 import type { ProjectInfo } from '../getProjectInfo/index.mjs';
 export default function ensureClient({ config, cwd, log }: ProjectInfo): Promise<{
     written: boolean;
-    path: string;
 }>;

package/dist/generate/ensureClient.mjs

@@ -2,6 +2,7 @@ import fs from 'node:fs/promises';
 import getClientTemplates from './getClientTemplates.mjs';
 import uniq from 'lodash/uniq.js';
 import chalkHighlightThing from '../utils/chalkHighlightThing.mjs';
+import path from 'node:path';
 export default async function ensureClient({ config, cwd, log }) {
     const now = Date.now();
     const { clientOutDirAbsolutePath, templateFiles } = getClientTemplates({
@@ -17,7 +18,7 @@ export default async function ensureClient({ config, cwd, log }) {
     for (const { outPath, templateName } of templateFiles) {
         const existing = await fs.readFile(outPath, 'utf-8').catch(() => null);
         if (!existing) {
-            await fs.mkdir(clientOutDirAbsolutePath, { recursive: true });
+            await fs.mkdir(path.dirname(outPath), { recursive: true });
             await fs.writeFile(outPath, outPath.endsWith('.py') ? text.replace(/\/\//g, '#') : text);
             usedTemplateNames.push(templateName);
         }
@@ -26,5 +27,5 @@ export default async function ensureClient({ config, cwd, log }) {
     if (usedTemplateNames.length) {
         log.info(`Placeholder client files from template${usedTemplateNames.length !== 1 ? 's' : ''} ${chalkHighlightThing(usedTemplateNames.map((s) => `"${s}"`).join(', '))} are generated at ${clientOutDirAbsolutePath} in ${Date.now() - now}ms`);
     }
-    return { written: !!usedTemplateNames.length, path: clientOutDirAbsolutePath };
+    return { written: !!usedTemplateNames.length };
 }

package/dist/generate/index.d.mts

@@ -1,7 +1,7 @@
 import type { VovkFullSchema } from 'vovk';
 import type { ProjectInfo } from '../getProjectInfo/index.mjs';
 import type { Segment } from '../locateSegments.mjs';
-import { GenerateOptions } from '../types.mjs';
+import type { GenerateOptions } from '../types.mjs';
 export default function generate({ projectInfo, segments, forceNothingWrittenLog, templates, prettify: prettifyClient, fullSchema, emitFullSchema, }: {
     projectInfo: ProjectInfo;
     segments: Segment[];

package/dist/generate/index.mjs

@@ -1,11 +1,12 @@
 import path from 'node:path';
 import fs from 'node:fs/promises';
 import ejs from 'ejs';
+import matter from 'gray-matter';
+import uniq from 'lodash/uniq.js';
 import formatLoggedSegmentName from '../utils/formatLoggedSegmentName.mjs';
 import prettify from '../utils/prettify.mjs';
 import getClientTemplates from './getClientTemplates.mjs';
 import chalkHighlightThing from '../utils/chalkHighlightThing.mjs';
-import uniq from 'lodash/uniq.js';
 export default async function generate({ projectInfo, segments, forceNothingWrittenLog, templates, prettify: prettifyClient, fullSchema, emitFullSchema, }) {
     const segmentsSchema = fullSchema.segments;
     const generateFrom = templates ?? projectInfo.config.generateFrom;
@@ -28,16 +29,29 @@ export default async function generate({ projectInfo, segments, forceNothingWrit
         apiRoot,
         imports: clientImports,
         fullSchema,
+        segmentMeta: Object.fromEntries(segments.map(({ segmentName, ...s }) => [segmentName, s])),
     };
     // Process each template in parallel
     const processedTemplates = noClient
         ? []
         : await Promise.all(templateFiles.map(async ({ templatePath, outPath, templateName }) => {
+            /*const parsed = matter((await ejs.render(codeTemplate, { t }, { async: true, filename: templateFileName })).trim());
+              const { dir, fileName, sourceName, compiledName } = parsed.data as VovkModuleRenderResult;
+              const code = empty ? (sourceName ? `export default class ${sourceName} {}` : '') : parsed.content;*/
             // Read the EJS template
             const templateContent = await fs.readFile(templatePath, 'utf-8');
+            const { data, content } = matter(templateContent);
+            if (data.imports instanceof Array) {
+                for (const imp of data.imports) {
+                    t.imports = {
+                        ...t.imports,
+                        [imp]: await import(imp),
+                    };
+                }
+            }
             // Render the template
             let rendered = templatePath.endsWith('.ejs')
-                ? ejs.render(templateContent, { t }, {
+                ? ejs.render(content, { t }, {
                     filename: templatePath,
                 })
                 : templateContent;
@@ -66,10 +80,6 @@ export default async function generate({ projectInfo, segments, forceNothingWrit
             .map(({ emitFullSchema }) => (typeof emitFullSchema === 'string' ? emitFullSchema : DEFAULT_NAME)));
     }
     fullSchemaNames = uniq(fullSchemaNames);
-    if (fullSchemaNames.length || usedTemplateNames.length > 0) {
-        // Make sure the output directory exists
-        await fs.mkdir(clientOutDirAbsolutePath, { recursive: true });
-    }
     if (fullSchemaNames.length) {
         await Promise.all(fullSchemaNames.map(async (name) => {
             const fullSchemaOutAbsolutePath = path.resolve(clientOutDirAbsolutePath, name);
@@ -83,8 +93,9 @@ export default async function generate({ projectInfo, segments, forceNothingWrit
         return { written: false, path: clientOutDirAbsolutePath };
     }
     // Write updated files where needed
-    await Promise.all(processedTemplates.map(({ outPath, rendered, needsWriting }) => {
+    await Promise.all(processedTemplates.map(async ({ outPath, rendered, needsWriting }) => {
         if (needsWriting) {
+            await fs.mkdir(clientOutDirAbsolutePath, { recursive: true });
             return fs.writeFile(outPath, rendered);
         }
         return null;

package/dist/getProjectInfo/getConfig.mjs

@@ -6,8 +6,8 @@ export default async function getConfig({ clientOutDir, 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 fetcherImport = env.VOVK_FETCHER_PATH ?? conf.fetcherImport ?? 'vovk';
+    const createRPCImport = env.VOVK_CREATE_RPC_PATH ?? conf.createRPCImport ?? 'vovk';
     const defaultClientTemplates = ['ts', 'module', 'main'];
     const config = {
         emitConfig: [],

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, reactQuery, channel, dryRun }, }: {
+export default function createConfig({ root, log, options: { validationLibrary, reactQuery, channel, dryRun }, }: {
     root: string;
     log: ReturnType<typeof getLogger>;
-    options: Pick<InitOptions, 'validationLibrary' | 'validateOnClient' | 'reactQuery' | 'channel' | 'dryRun'>;
+    options: Pick<InitOptions, 'validationLibrary' | '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, reactQuery, channel, dryRun }, }) {
+export default async function createConfig({ root, log, options: { validationLibrary, reactQuery, channel, dryRun }, }) {
     const config = {};
     const dotConfigPath = path.join(root, '.config');
     const dir = (await getFileSystemEntryType(dotConfigPath)) === FileSystemEntryType.DIRECTORY ? dotConfigPath : root;
@@ -16,9 +16,10 @@ export default async function createConfig({ root, log, options: { validationLib
         service: 'vovk-cli/templates/service.ejs',
     };
     if (validationLibrary) {
-        if (validateOnClient) {
-            config.validateOnClientImport = `${validationLibrary}/validateOnClient.js`;
-        }
+        config.validateOnClientImport =
+            {
+                'vovk-dto': `vovk-dto/validateOnClient.js`,
+            }[validationLibrary] ?? 'vovk-ajv';
         try {
             const validationTemplates = await getTemplateFilesFromPackage(validationLibrary, channel);
             Object.assign(templates, validationTemplates);

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, reactQuery, dryRun, channel, }: InitOptions): Promise<void>;
+    main(prefix: string, { yes, logLevel, useNpm, useYarn, usePnpm, useBun, skipInstall, updateTsConfig, updateScripts, validationLibrary, reactQuery, dryRun, channel, }: InitOptions): Promise<void>;
 }

package/dist/init/index.mjs

@@ -17,26 +17,24 @@ import NPMCliPackageJson from '@npmcli/package-json';
 export class Init {
     root;
     log;
-    async #init({ configPaths, pkgJson, }, { useNpm, useYarn, usePnpm, useBun, skipInstall, updateTsConfig, updateScripts, validationLibrary, validateOnClient, reactQuery, dryRun, channel, }) {
+    async #init({ configPaths, pkgJson, }, { useNpm, useYarn, usePnpm, useBun, skipInstall, updateTsConfig, updateScripts, validationLibrary, reactQuery, dryRun, channel, }) {
         const { log, root } = this;
-        const dependencies = ['vovk', 'vovk-client'];
-        const devDependencies = ['vovk-cli', 'openapi3-ts'];
+        const dependencies = ['vovk', 'vovk-client', 'vovk-openapi'];
+        const devDependencies = ['vovk-cli'];
         // delete older config files
         if (configPaths.length) {
             await Promise.all(configPaths.map((configPath) => fs.rm(configPath)));
             log.debug(`Deleted existing config file${configPaths.length > 1 ? 's' : ''} at ${configPaths.join(', ')}`);
         }
         if (validationLibrary) {
-            dependencies.push(validationLibrary);
-            dependencies.push(...({
+            dependencies.push(validationLibrary, 'vovk-ajv', ...({
                 'vovk-zod': ['zod'],
                 'vovk-yup': ['yup'],
                 'vovk-dto': ['class-validator', 'class-transformer', 'vovk-mapped-types', 'reflect-metadata'],
             }[validationLibrary] ?? []));
         }
         if (reactQuery) {
-            dependencies.push('vovk-react-query');
-            dependencies.push('@tanstack/react-query');
+            dependencies.push('vovk-react-query', '@tanstack/react-query');
         }
         if (updateScripts) {
             try {
@@ -106,7 +104,7 @@ export class Init {
             const { configAbsolutePath } = await createConfig({
                 root,
                 log,
-                options: { validationLibrary, validateOnClient, reactQuery, channel, dryRun },
+                options: { validationLibrary, reactQuery, channel, dryRun },
             });
             log.info('Config created successfully at ' + configAbsolutePath);
         }
@@ -114,7 +112,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, reactQuery, dryRun, channel, }) {
+    async main(prefix, { yes, logLevel, useNpm, useYarn, usePnpm, useBun, skipInstall, updateTsConfig, updateScripts, validationLibrary, reactQuery, dryRun, channel, }) {
         const cwd = process.cwd();
         const root = path.resolve(cwd, prefix);
         const log = getLogger(logLevel);
@@ -132,7 +130,6 @@ export class Init {
                 updateTsConfig: updateTsConfig ?? true,
                 updateScripts: updateScripts ?? 'implicit',
                 validationLibrary: validationLibrary?.toLocaleLowerCase() === 'none' ? null : (validationLibrary ?? 'vovk-zod'),
-                validateOnClient: validateOnClient ?? true,
                 reactQuery: reactQuery ?? true,
                 dryRun: dryRun ?? false,
                 channel: channel ?? 'latest',
@@ -176,13 +173,6 @@ export class Init {
                             { name: 'None', value: null, description: 'Install validation library later' },
                         ],
                     })));
-        if (validationLibrary) {
-            validateOnClient =
-                validateOnClient ??
-                    (await confirm({
-                        message: 'Do you want to enable client validation?',
-                    }));
-        }
         updateScripts =
             updateScripts ??
                 (await select({
@@ -234,7 +224,6 @@ export class Init {
             updateTsConfig,
             updateScripts,
             validationLibrary,
-            validateOnClient,
             reactQuery,
             dryRun,
             channel,

package/dist/init/updateNPMScripts.mjs

@@ -9,7 +9,9 @@ export default async function updateNPMScripts(pkgJson, root, updateScriptsMode)
     pkgJson.update({
         scripts: {
             ...pkgJson.content.scripts,
-            generate: 'vovk generate',
+            generate: pkgJson.content.scripts?.generate
+                ? `${pkgJson.content.scripts.generate} && vovk generate`
+                : 'vovk generate',
             dev: getDevScript(pkgJson, updateScriptsMode),
         },
     });

package/dist/initProgram.mjs

@@ -14,7 +14,6 @@ export default function initProgram(program) {
         .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')

package/dist/types.d.mts

@@ -28,7 +28,6 @@ export interface InitOptions {
     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.107",
+  "version": "0.0.1-draft.109",
   "bin": {
     "vovk": "./dist/index.mjs"
   },
@@ -29,14 +29,17 @@
     "cli",
     "vovk"
   ],
-  "author": "Andrii Gubanov",
+  "author": "Andrey Gubanov",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/finom/vovk/issues"
   },
   "homepage": "https://vovk.dev",
   "peerDependencies": {
-    "vovk": "^3.0.0-draft.90"
+    "vovk": "^3.0.0-draft.92"
+  },
+  "optionalDependencies": {
+    "vovk-python-client": "*"
   },
   "dependencies": {
     "@inquirer/prompts": "^7.3.1",