vovk-cli 0.0.1-draft.277 → 0.0.1-draft.279

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

@@ -7,7 +7,7 @@ const { validateOnClient = null } = <%- t.imports.validateOnClient ? `require('$
   Object.keys(segment.controllers).forEach((rpcModuleName) => { %>
 exports.<%= rpcModuleName %> = createRPC(
   schema, '<%= segment.segmentName %>', '<%= rpcModuleName %>', fetcher,
-  { validateOnClient, <%- typeof t.segmentMeta[segment.segmentName].segmentNameOverride === 'string' ? `segmentNameOverride: '${t.segmentMeta[segment.segmentName].segmentNameOverride}', ` : '' %><%- segment.segmentType === 'mixin' ? '' : `apiRoot: '${segment.segmentApiRoot ?? t.apiRoot}'` %> }
+  { validateOnClient, <%- typeof t.segmentMeta[segment.segmentName].segmentNameOverride === 'string' ? `segmentNameOverride: '${t.segmentMeta[segment.segmentName].segmentNameOverride}', ` : '' %><%- segment.segmentType === 'mixin' ? '' : `apiRoot: '${t.segmentMeta[segment.segmentName].forceApiRoot ?? t.apiRoot}'` %> }
 );
   <% })
 }) %>

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

@@ -11,7 +11,7 @@ Object.values(t.schema.segments).filter((segment) => segment.emitSchema).forEach
   Object.keys(segment.controllers).forEach((rpcModuleName) => { %>
 export const <%= rpcModuleName %> = createRPC(
   schema, '<%= segment.segmentName %>', '<%= rpcModuleName %>', fetcher,
-  { validateOnClient, <%- typeof t.segmentMeta[segment.segmentName].segmentNameOverride === 'string' ? `segmentNameOverride: '${t.segmentMeta[segment.segmentName].segmentNameOverride}', ` : '' %><%- segment.segmentType === 'mixin' ? '' : `apiRoot: '${segment.segmentApiRoot ?? t.apiRoot}'` %> }
+  { validateOnClient, <%- typeof t.segmentMeta[segment.segmentName].segmentNameOverride === 'string' ? `segmentNameOverride: '${t.segmentMeta[segment.segmentName].segmentNameOverride}', ` : '' %><%- segment.segmentType === 'mixin' ? '' : `apiRoot: '${t.segmentMeta[segment.segmentName].forceApiRoot ?? t.apiRoot}'` %> }
 );
 <% 
   }); 

package/client-templates/readme/README.md.ejs

@@ -1,5 +1,6 @@
-# <%= t.package.name %> v<%= t.package.version %> ![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white)
+<%= t.readme.banner %>
 
+# <%= t.package.name %> v<%= t.package.version %> ![TypeScript](https://badgen.net/badge/-/TypeScript?icon=typescript&label&labelColor=blue&color=555555)
 
 <%- t.package.description ? `> ${t.package.description}` : '' %>
 

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

@@ -20,7 +20,7 @@ type Options = typeof fetcher extends VovkClientFetcher<infer U> ? U : never;
   Object.keys(segment.controllers).forEach((rpcModuleName) => { %>
 export const <%= rpcModuleName %> = createRPC<<%= segment.segmentType === 'mixin' ? `MixinControllers` : `Controllers${i}` %>["<%= rpcModuleName %>"], Options>(
   schema, '<%= segment.segmentName %>', '<%= rpcModuleName %>', fetcher,
-  { validateOnClient, <%- typeof t.segmentMeta[segment.segmentName].segmentNameOverride === 'string' ? `segmentNameOverride: '${t.segmentMeta[segment.segmentName].segmentNameOverride}', ` : '' %><%- segment.segmentType === 'mixin' ? '' : `apiRoot: '${segment.segmentApiRoot ?? t.apiRoot}'` %> }
+  { validateOnClient, <%- typeof t.segmentMeta[segment.segmentName].segmentNameOverride === 'string' ? `segmentNameOverride: '${t.segmentMeta[segment.segmentName].segmentNameOverride}', ` : '' %><%- segment.segmentType === 'mixin' ? '' : `apiRoot: '${t.segmentMeta[segment.segmentName].forceApiRoot ?? t.apiRoot}'` %> }
 );
 <% }) 
 }) %>

package/dist/bundle/index.mjs

@@ -27,6 +27,8 @@ export async function bundle({ projectInfo, fullSchema, cliBundleOptions, }) {
         forceNothingWrittenLog: true,
         fullSchema,
         locatedSegments,
+        package: bundleConfig.package,
+        readme: bundleConfig.readme,
         cliGenerateOptions: {
             openapiSpec: cliBundleOptions?.openapiSpec,
             openapiGetModuleName: cliBundleOptions?.openapiGetModuleName,

package/dist/generate/generate.d.mts

@@ -1,12 +1,15 @@
-import { type VovkSchema } from 'vovk';
+import { type VovkSchema, type VovkStrictConfig } from 'vovk';
+import type { PackageJson } from 'type-fest';
 import type { ProjectInfo } from '../getProjectInfo/index.mjs';
 import type { GenerateOptions } from '../types.mjs';
 import type { Segment } from '../locateSegments.mjs';
-export declare function generate({ isEnsuringClient, projectInfo, forceNothingWrittenLog, fullSchema, locatedSegments, cliGenerateOptions, }: {
+export declare function generate({ isEnsuringClient, projectInfo, forceNothingWrittenLog, fullSchema, locatedSegments, cliGenerateOptions, package: argPackageJson, readme: argReadme, }: {
     isEnsuringClient?: boolean;
     projectInfo: ProjectInfo;
     forceNothingWrittenLog?: boolean;
     fullSchema: VovkSchema;
     locatedSegments: Segment[];
     cliGenerateOptions?: GenerateOptions;
+    package?: PackageJson;
+    readme?: VovkStrictConfig['bundle']['readme'];
 }): Promise<void>;

package/dist/generate/generate.mjs

@@ -13,6 +13,7 @@ import writeOneClientFile from './writeOneClientFile.mjs';
 import { ROOT_SEGMENT_FILE_NAME } from '../dev/writeOneSegmentSchemaFile.mjs';
 import { getTsconfig } from 'get-tsconfig';
 import { normalizeOpenAPIMixins } from '../utils/normalizeOpenAPIMixins.mjs';
+import { BuiltInTemplateName } from '../getProjectInfo/getConfig/getTemplateDefs.mjs';
 const getIncludedSegmentNames = (config, fullSchema, configKey, cliGenerateOptions) => {
     const segments = Object.values(fullSchema.segments);
     const includeSegments = cliGenerateOptions?.[configKey === 'segmentedClient' ? 'segmentedIncludeSegments' : 'composedIncludeSegments'] ??
@@ -41,18 +42,26 @@ function logClientGenerationResults({ results, log, isEnsuringClient = false, fo
     const writtenResults = results.filter(({ written }) => written);
     const duration = Date.now() - startTime;
     const groupedByDir = _.groupBy(writtenResults, ({ outAbsoluteDir }) => outAbsoluteDir);
+    const logOrDebug = forceNothingWrittenLog ? log.info : log.debug;
     if (writtenResults.length) {
         for (const [outAbsoluteDir, dirResults] of Object.entries(groupedByDir)) {
             const templateNames = _.uniq(dirResults.map(({ templateName }) => templateName));
             log.info(`${clientType} client${isEnsuringClient ? ' placeholder' : ''} is generated to ${chalkHighlightThing(outAbsoluteDir)} from template${templateNames.length !== 1 ? 's' : ''} ${chalkHighlightThing(templateNames.map((s) => `"${s}"`).join(', '))} in ${duration}ms`);
         }
     }
-    else if (!isEnsuringClient && fromTemplates.length) {
-        const logOrDebug = forceNothingWrittenLog ? log.info : log.debug;
-        for (const [outAbsoluteDir, dirResults] of Object.entries(groupedByDir)) {
-            const templateNames = _.uniq(dirResults.map(({ templateName }) => templateName));
-            logOrDebug(`${clientType} client that was generated to ${chalkHighlightThing(outAbsoluteDir)} from template${templateNames.length !== 1 ? 's' : ''} ${chalkHighlightThing(templateNames.map((s) => `"${s}"`).join(', '))} is up to date and doesn't need to be regenerated (${duration}ms)`);
+    else if (fromTemplates.length) {
+        if (!writtenResults.length) {
+            logOrDebug(`${clientType} client${isEnsuringClient ? ' placeholder' : ''} is up to date (${duration}ms)`);
         }
+        else if (!isEnsuringClient) {
+            for (const [outAbsoluteDir, dirResults] of Object.entries(groupedByDir)) {
+                const templateNames = _.uniq(dirResults.map(({ templateName }) => templateName));
+                logOrDebug(`${clientType} client that was generated to ${chalkHighlightThing(outAbsoluteDir)} from template${templateNames.length !== 1 ? 's' : ''} ${chalkHighlightThing(templateNames.map((s) => `"${s}"`).join(', '))} is up to date and doesn't need to be regenerated (${duration}ms)`);
+            }
+        }
+    }
+    else {
+        logOrDebug(`${clientType} client${isEnsuringClient ? ' placeholder' : ''} is not generated because no files were written (${duration}ms)`);
     }
 }
 const cliOptionsToOpenAPIMixins = ({ openapiGetMethodName, openapiGetModuleName, openapiRootUrl, openapiSpec, openapiMixinName, }) => {
@@ -62,7 +71,7 @@ const cliOptionsToOpenAPIMixins = ({ openapiGetMethodName, openapiGetModuleName,
             apiRoot: openapiRootUrl?.[i] ?? '/',
             getModuleName: openapiGetModuleName?.[i] ?? undefined,
             getMethodName: openapiGetMethodName?.[i] ?? 'auto',
-            mixinName: openapiMixinName?.[i] ?? `mixin${i + 1}`, // TODO merge mixins with the same name
+            mixinName: openapiMixinName?.[i],
         };
     }) || []).map(({ source, apiRoot, getModuleName, getMethodName, mixinName }) => [
         mixinName,
@@ -75,25 +84,22 @@ const cliOptionsToOpenAPIMixins = ({ openapiGetMethodName, openapiGetModuleName,
         },
     ]));
 };
-export async function generate({ isEnsuringClient = false, projectInfo, forceNothingWrittenLog, fullSchema, locatedSegments, cliGenerateOptions, }) {
+export async function generate({ isEnsuringClient = false, projectInfo, forceNothingWrittenLog, fullSchema, locatedSegments, cliGenerateOptions, package: argPackageJson, readme: argReadme, }) {
     fullSchema = {
         ...fullSchema,
         // sort segments by name to avoid unnecessary rendering
         segments: Object.fromEntries(Object.entries(fullSchema.segments).sort(([a], [b]) => a.localeCompare(b))),
     };
-    const { config, cwd, log, srcRoot } = projectInfo;
+    const { config, cwd, log, srcRoot, packageJson: rootPackageJson } = projectInfo;
     const allOpenAPIMixins = {
         ...config.openApiMixins,
         ...cliOptionsToOpenAPIMixins(cliGenerateOptions ?? {}),
     };
-    /** @deprecated */
-    let hasMixins = false;
     if (Object.keys(allOpenAPIMixins).length) {
-        const mixins = Object.fromEntries(Object.entries(await normalizeOpenAPIMixins({ mixinModules: allOpenAPIMixins })).map(([mixinName, conf]) => [
+        const mixins = Object.fromEntries(Object.entries(await normalizeOpenAPIMixins({ mixinModules: allOpenAPIMixins, log })).map(([mixinName, conf]) => [
             mixinName,
             openAPIToVovkSchema({ ...conf, mixinName }).segments[mixinName],
         ]));
-        hasMixins = true;
         fullSchema = {
             ...fullSchema,
             segments: {
@@ -119,7 +125,6 @@ export async function generate({ isEnsuringClient = false, projectInfo, forceNot
             config,
             cwd,
             log,
-            hasMixins,
             cliGenerateOptions,
             configKey: 'composedClient',
         });
@@ -136,21 +141,27 @@ export async function generate({ isEnsuringClient = false, projectInfo, forceNot
             });
             const packageJson = await mergePackages({
                 log,
-                cwd,
-                config,
-                packages: [config.composedClient.package, templateDef.composedClient?.package],
+                rootPackageJson,
+                packages: [config.composedClient.package, templateDef.composedClient?.package, argPackageJson],
             });
+            const readme = Object.assign({}, config.composedClient.readme, templateDef.composedClient?.readme, argReadme);
+            const composedFullSchema = pickSegmentFullSchema(fullSchema, segmentNames);
+            const hasMixins = Object.values(composedFullSchema.segments).some((segment) => segment.segmentType === 'mixin');
+            if (templateName === BuiltInTemplateName.mixins && !hasMixins) {
+                return null;
+            }
             const { written } = await writeOneClientFile({
                 cwd,
                 projectInfo,
                 clientTemplateFile,
-                fullSchema: pickSegmentFullSchema(fullSchema, segmentNames),
+                fullSchema: composedFullSchema,
                 prettifyClient: config.prettifyClient,
                 segmentName: null,
                 imports: clientImports.composedClient,
                 templateContent,
                 matterResult,
                 package: packageJson,
+                readme,
                 isEnsuringClient,
                 outCwdRelativeDir,
                 origin: config.origin ?? templateDef?.origin ?? null,
@@ -169,7 +180,7 @@ export async function generate({ isEnsuringClient = false, projectInfo, forceNot
         }));
         if (composedClientTemplateFiles.length) {
             logClientGenerationResults({
-                results: composedClientResults,
+                results: composedClientResults.filter((result) => !!result),
                 log,
                 isEnsuringClient,
                 forceNothingWrittenLog,
@@ -189,7 +200,6 @@ export async function generate({ isEnsuringClient = false, projectInfo, forceNot
             config,
             cwd,
             log,
-            hasMixins,
             cliGenerateOptions,
             configKey: 'segmentedClient',
         });
@@ -206,25 +216,32 @@ export async function generate({ isEnsuringClient = false, projectInfo, forceNot
                     outCwdRelativeDir,
                 });
                 const packageJson = await mergePackages({
-                    cwd,
-                    config,
                     log,
+                    rootPackageJson,
                     packages: [
                         config.segmentedClient.packages?.[segmentName],
                         templateDef.segmentedClient?.packages?.[segmentName],
+                        argPackageJson,
                     ],
                 });
+                const readme = Object.assign({}, config.segmentedClient.readmes?.[segmentName], templateDef.segmentedClient?.readmes?.[segmentName], argReadme);
+                const segmentedFullSchema = pickSegmentFullSchema(fullSchema, [segmentName]);
+                const hasMixins = Object.values(segmentedFullSchema.segments).some((segment) => segment.segmentType === 'mixin');
+                if (templateName === BuiltInTemplateName.mixins && !hasMixins) {
+                    return null;
+                }
                 const { written } = await writeOneClientFile({
                     cwd,
                     projectInfo,
                     clientTemplateFile,
-                    fullSchema: pickSegmentFullSchema(fullSchema, [segmentName]),
+                    fullSchema: segmentedFullSchema,
                     prettifyClient: config.prettifyClient,
                     segmentName,
                     imports: clientImports.segmentedClient[segmentName],
                     templateContent,
                     matterResult,
                     package: packageJson,
+                    readme,
                     isEnsuringClient,
                     outCwdRelativeDir,
                     origin: config.origin ?? templateDef?.origin ?? null,
@@ -243,7 +260,7 @@ export async function generate({ isEnsuringClient = false, projectInfo, forceNot
             // Remove unlisted directories in the output directory
             await removeUnlistedDirectories(outAbsoluteDir, segmentNames.map((s) => s || ROOT_SEGMENT_FILE_NAME));
             return {
-                written: results.some(({ written }) => written),
+                written: results.filter((result) => !!result).some(({ written }) => written),
                 templateName,
                 outAbsoluteDir,
             };

package/dist/generate/getClientTemplateFiles.d.mts

@@ -8,14 +8,12 @@ export interface ClientTemplateFile {
     outCwdRelativeDir: string;
     templateDef: VovkStrictConfig['clientTemplateDefs'][string];
 }
-export default function getClientTemplateFiles({ config, cwd, log, configKey, cliGenerateOptions, hasMixins, }: {
+export default function getClientTemplateFiles({ config, cwd, log, configKey, cliGenerateOptions, }: {
     config: VovkStrictConfig;
     cwd: string;
     log: ProjectInfo['log'];
     configKey: 'composedClient' | 'segmentedClient';
     cliGenerateOptions?: GenerateOptions;
-    /** @deprecated */
-    hasMixins: boolean;
 }): Promise<{
     fromTemplates: string[];
     templateFiles: ClientTemplateFile[];

package/dist/generate/getClientTemplateFiles.mjs

@@ -4,7 +4,7 @@ import resolveAbsoluteModulePath from '../utils/resolveAbsoluteModulePath.mjs';
 import getFileSystemEntryType, { FileSystemEntryType } from '../utils/getFileSystemEntryType.mjs';
 import getPublicModuleNameFromPath from '../utils/getPublicModuleNameFromPath.mjs';
 import { BuiltInTemplateName } from '../getProjectInfo/getConfig/getTemplateDefs.mjs';
-export default async function getClientTemplateFiles({ config, cwd, log, configKey, cliGenerateOptions, hasMixins, }) {
+export default async function getClientTemplateFiles({ config, cwd, log, configKey, cliGenerateOptions, }) {
     const usedTemplateDefs = {};
     const fromTemplates = configKey === 'composedClient'
         ? cliGenerateOptions?.composedFrom || cliGenerateOptions?.segmentedFrom
@@ -14,13 +14,13 @@ export default async function getClientTemplateFiles({ config, cwd, log, configK
             ? (cliGenerateOptions?.segmentedFrom ?? [])
             : config.segmentedClient.fromTemplates;
     const cliOutDir = configKey === 'composedClient' ? cliGenerateOptions?.composedOut : cliGenerateOptions?.segmentedOut;
-    const configOutDir = configKey === 'composedClient' ? config.composedClient.outDir : config.segmentedClient.outDir;
+    const configOutDir = config[configKey].outDir;
     for (const templateName of fromTemplates) {
         if (!(templateName in config.clientTemplateDefs)) {
             throw new Error(`Unknown template name: ${templateName}`);
         }
         let usedDef = config.clientTemplateDefs[templateName];
-        if (usedDef.isTsClient && hasMixins) {
+        if (usedDef.isTsClient) {
             usedDef = {
                 ...usedDef,
                 requires: {

package/dist/generate/mergePackages.d.mts

@@ -1,9 +1,7 @@
 import type { PackageJson } from 'type-fest';
-import type { VovkStrictConfig } from 'vovk';
 import type { ProjectInfo } from '../getProjectInfo/index.mjs';
-export default function mergePackages({ cwd, packages, log, }: {
-    cwd: string;
-    config: VovkStrictConfig;
-    log: ProjectInfo['log'];
+export default function mergePackages({ rootPackageJson, packages, }: {
+    rootPackageJson: PackageJson;
     packages: (PackageJson | undefined)[];
+    log: ProjectInfo['log'];
 }): Promise<PackageJson>;

package/dist/generate/mergePackages.mjs

@@ -1,26 +1,4 @@
 import pick from 'lodash/pick.js';
-import fs from 'node:fs/promises';
-import path from 'node:path';
-let cachedPromise;
-function getPackageJson(cwd, log) {
-    const pkgPath = path.join(cwd, 'package.json');
-    // If we have a cached promise, return it
-    if (cachedPromise) {
-        return cachedPromise;
-    }
-    const promise = fs
-        .readFile(pkgPath, 'utf8')
-        .then((content) => JSON.parse(content))
-        .catch(() => {
-        cachedPromise = undefined;
-        log.warn(`Failed to read package.json at ${pkgPath}. Using a fallback.`);
-        return {
-            name: 'unknown',
-        };
-    });
-    cachedPromise = promise;
-    return promise;
-}
 function mergeTwoPackageJsons(base, additional) {
     const merged = { ...base, ...additional };
     // TODO: Add deep merge for all properties
@@ -38,8 +16,7 @@ function mergeTwoPackageJsons(base, additional) {
     }
     return merged;
 }
-export default async function mergePackages({ cwd, packages, log, }) {
-    const fullPackageJson = await getPackageJson(cwd, log);
+export default async function mergePackages({ rootPackageJson, packages, }) {
     const defaultPackageJson = {
         main: './index.cjs',
         module: './index.mjs',
@@ -56,7 +33,7 @@ export default async function mergePackages({ cwd, packages, log, }) {
             },
         },
     };
-    const pickedPackageJson = pick(fullPackageJson, [
+    const pickedPackageJson = pick(rootPackageJson, [
         'name',
         'version',
         'description',

package/dist/generate/writeOneClientFile.d.mts

@@ -4,7 +4,7 @@ import type { ProjectInfo } from '../getProjectInfo/index.mjs';
 import type { ClientTemplateFile } from './getClientTemplateFiles.mjs';
 import type { ClientImports } from './getTemplateClientImports.mjs';
 import type { Segment } from '../locateSegments.mjs';
-export default function writeOneClientFile({ cwd, projectInfo, clientTemplateFile, fullSchema, prettifyClient, segmentName, imports, templateContent, matterResult: { data, content }, package: packageJson, isEnsuringClient, outCwdRelativeDir, origin, templateDef, locatedSegments, isNodeNextResolution, hasMixins, isVovkProject, }: {
+export default function writeOneClientFile({ cwd, projectInfo, clientTemplateFile, fullSchema, prettifyClient, segmentName, imports, templateContent, matterResult: { data, content }, package: packageJson, readme, isEnsuringClient, outCwdRelativeDir, origin, templateDef, locatedSegments, isNodeNextResolution, hasMixins, isVovkProject, }: {
     cwd: string;
     projectInfo: ProjectInfo;
     clientTemplateFile: ClientTemplateFile;
@@ -20,6 +20,7 @@ export default function writeOneClientFile({ cwd, projectInfo, clientTemplateFil
         content: string;
     };
     package: PackageJson;
+    readme: VovkStrictConfig['bundle']['readme'];
     isEnsuringClient: boolean;
     outCwdRelativeDir: string;
     origin: string | null;

package/dist/generate/writeOneClientFile.mjs

@@ -8,7 +8,7 @@ import TOML from '@iarna/toml';
 import prettify from '../utils/prettify.mjs';
 import { ROOT_SEGMENT_FILE_NAME } from '../dev/writeOneSegmentSchemaFile.mjs';
 import { compileJSONSchemaToTypeScriptType } from '../utils/compileJSONSchemaToTypeScriptType.mjs';
-export default async function writeOneClientFile({ cwd, projectInfo, clientTemplateFile, fullSchema, prettifyClient, segmentName, imports, templateContent, matterResult: { data, content }, package: packageJson, isEnsuringClient, outCwdRelativeDir, origin, templateDef, locatedSegments, isNodeNextResolution, hasMixins, isVovkProject, }) {
+export default async function writeOneClientFile({ cwd, projectInfo, clientTemplateFile, fullSchema, prettifyClient, segmentName, imports, templateContent, matterResult: { data, content }, package: packageJson, readme, isEnsuringClient, outCwdRelativeDir, origin, templateDef, locatedSegments, isNodeNextResolution, hasMixins, isVovkProject, }) {
     const { config, apiRoot } = projectInfo;
     const { templateFilePath, relativeDir } = clientTemplateFile;
     const locatedSegmentsByName = _.keyBy(locatedSegments, 'segmentName');
@@ -23,6 +23,7 @@ export default async function writeOneClientFile({ cwd, projectInfo, clientTempl
         hasMixins,
         isVovkProject,
         package: packageJson,
+        readme,
         ROOT_SEGMENT_FILE_NAME,
         apiRoot: origin ? `${origin}/${config.rootEntry}` : apiRoot,
         imports,
@@ -53,7 +54,7 @@ export default async function writeOneClientFile({ cwd, projectInfo, clientTempl
             return [
                 sName,
                 {
-                    segmentApiRoot: forceApiRoot ??
+                    forceApiRoot: forceApiRoot ??
                         (segmentConfigOrigin || segmentConfigRootEntry
                             ? `${segmentConfigOrigin ?? origin}/${segmentConfigRootEntry ?? config.rootEntry}`
                             : null),

package/dist/getProjectInfo/getConfig/index.d.mts

@@ -22,6 +22,9 @@ export default function getConfig({ configPath, cwd }: {
             includeSegments?: never;
         })) & {
             package?: import("type-fest").PackageJson;
+            readme?: {
+                banner?: string;
+            };
         };
         segmentedClient?: ({
             enabled?: boolean;
@@ -35,6 +38,9 @@ export default function getConfig({ configPath, cwd }: {
             includeSegments?: never;
         })) & {
             packages?: Record<string, import("type-fest").PackageJson>;
+            readmes?: Record<string, {
+                banner?: string;
+            }>;
         };
         bundle?: {
             outDir?: string;
@@ -42,6 +48,10 @@ export default function getConfig({ configPath, cwd }: {
             tsClientOutDir?: string;
             dontDeleteTsClientOutDirAfter?: boolean;
             sourcemap?: boolean;
+            package?: import("type-fest").PackageJson;
+            readme?: {
+                banner?: string;
+            };
         } & ({
             excludeSegments?: never;
             includeSegments?: string[];
@@ -67,7 +77,10 @@ export default function getConfig({ configPath, cwd }: {
             controller?: string;
             [key: string]: string | undefined;
         };
-        libs?: Record<string, import("vovk").KnownAny>;
+        libs?: {
+            ajv: import("vovk").KnownAny;
+            [key: string]: import("vovk").KnownAny;
+        };
         segmentConfig?: false | {
             [x: string]: {
                 origin?: string;
@@ -81,10 +94,14 @@ export default function getConfig({ configPath, cwd }: {
                     file: string;
                 } | {
                     url: string;
-                    cache?: string;
+                    fallback?: string;
                 } | {
                     object: import("openapi3-ts/oas31").OpenAPIObject;
                 };
+                package?: import("type-fest").PackageJson;
+                readme?: {
+                    banner?: string;
+                };
                 apiRoot?: string;
                 getModuleName?: "nestjs-operation-id" | (string & {}) | "api" | import("vovk/mjs/types").GetOpenAPINameFn;
                 getMethodName?: "nestjs-operation-id" | "camel-case-operation-id" | "auto" | import("vovk/mjs/types").GetOpenAPINameFn;

package/dist/getProjectInfo/getConfig/index.mjs

@@ -43,7 +43,6 @@ export default async function getConfig({ configPath, cwd }) {
             outDir: conf.segmentedClient?.outDir ?? path.join(srcRoot ?? '.', 'client'),
         },
         bundle: {
-            ...conf.bundle,
             outDir: conf.bundle?.outDir ?? 'dist',
             tsClientOutDir: conf.bundle?.tsClientOutDir ?? 'tmp_ts_rpc',
             dontDeleteTsClientOutDirAfter: conf.bundle?.dontDeleteTsClientOutDirAfter ?? false,
@@ -52,6 +51,9 @@ export default async function getConfig({ configPath, cwd }) {
                 [BuiltInTemplateName.readme]: '.',
                 [BuiltInTemplateName.packageJson]: '.',
             },
+            package: {},
+            readme: {},
+            ...conf.bundle,
         },
         modulesDir: conf.modulesDir ?? path.join(srcRoot ?? '.', 'modules'),
         schemaOutDir: env.VOVK_SCHEMA_OUT_DIR ?? conf.schemaOutDir ?? './.vovk-schema',
@@ -68,10 +70,7 @@ export default async function getConfig({ configPath, cwd }) {
         },
         libs: conf.libs ?? {},
         segmentConfig: conf.segmentConfig ?? {},
-        openApiMixins: await normalizeOpenAPIMixins({
-            mixinModules: conf.openApiMixins ?? {},
-            cwd,
-        }),
+        openApiMixins: {},
     };
     if (typeof conf.emitConfig === 'undefined') {
         config.emitConfig = ['$schema', 'libs'];
@@ -83,6 +82,11 @@ export default async function getConfig({ configPath, cwd }) {
         config.emitConfig = conf.emitConfig;
     } // else it's false and emitConfig already is []
     const log = getLogger(config.logLevel);
+    config.openApiMixins = await normalizeOpenAPIMixins({
+        mixinModules: conf.openApiMixins ?? {},
+        cwd,
+        log,
+    });
     if (!userConfig) {
         log.warn(`Unable to load config at ${chalkHighlightThing(cwd)}. Using default values. ${error ?? ''}`);
     }

package/dist/getProjectInfo/index.d.mts

@@ -11,6 +11,7 @@ export default function getProjectInfo({ port: givenPort, cwd, configPath, srcRo
     apiDirAbsolutePath: string | null;
     srcRoot: string | null;
     config: import("vovk").VovkStrictConfig;
+    packageJson: import("type-fest").PackageJson;
     log: {
         info: (msg: string) => void;
         warn: (msg: string) => void;

package/dist/getProjectInfo/index.mjs

@@ -1,5 +1,6 @@
 import path from 'node:path';
 import getConfig from './getConfig/index.mjs';
+import { getPackageJson } from '../utils/getPackageJson.mjs';
 export default async function getProjectInfo({ port: givenPort, cwd = process.cwd(), configPath, srcRootRequired = true, } = {}) {
     const port = givenPort?.toString() ?? process.env.PORT ?? '3000';
     // Make PORT available to the config file at getConfig
@@ -8,6 +9,7 @@ export default async function getProjectInfo({ port: givenPort, cwd = process.cw
         configPath,
         cwd,
     });
+    const packageJson = await getPackageJson(cwd, log);
     if (srcRootRequired && !srcRoot) {
         throw new Error(`Could not find app router directory at ${cwd}. Check Next.js docs for more info.`);
     }
@@ -23,6 +25,7 @@ export default async function getProjectInfo({ port: givenPort, cwd = process.cw
         apiDirAbsolutePath,
         srcRoot,
         config,
+        packageJson,
         log,
     };
 }

package/dist/init/createConfig.mjs

@@ -15,9 +15,9 @@ export default async function createConfig({ root, log, options: { validationLib
         controller: 'vovk-cli/module-templates/controller.ts.ejs',
         service: 'vovk-cli/module-templates/service.ts.ejs',
     };
+    config.imports ??= {};
+    config.imports.validateOnClient = validationLibrary === 'vovk-dto' ? 'vovk-dto/validateOnClient' : 'vovk-ajv';
     if (validationLibrary) {
-        config.imports ??= {};
-        config.imports.validateOnClient = 'vovk-ajv';
         try {
             const validationTemplates = await getTemplateFilesFromPackage(validationLibrary, channel);
             Object.assign(moduleTemplates, validationTemplates);

package/dist/init/index.mjs

@@ -19,7 +19,7 @@ export class Init {
     log;
     async #init({ configPaths, pkgJson, }, { useNpm, useYarn, usePnpm, useBun, skipInstall, updateTsConfig, updateScripts, validationLibrary, reactQuery, lang, dryRun, channel, }) {
         const { log, root } = this;
-        const dependencies = ['vovk', 'vovk-client'];
+        const dependencies = ['vovk', 'vovk-client', 'vovk-ajv', 'openapi3-ts'];
         const devDependencies = ['vovk-cli'];
         if (lang?.includes('py')) {
             dependencies.push('vovk-python');
@@ -33,9 +33,8 @@ export class Init {
             log.debug(`Deleted existing config file${configPaths.length > 1 ? 's' : ''} at ${configPaths.join(', ')}`);
         }
         if (validationLibrary) {
-            dependencies.push(validationLibrary, 'vovk-ajv', ...({
+            dependencies.push(validationLibrary, ...({
                 'vovk-zod': ['zod'],
-                'vovk-yup': ['yup'],
                 'vovk-dto': ['class-validator', 'class-transformer', 'dto-mapped-types', 'reflect-metadata'],
             }[validationLibrary] ?? []));
         }
@@ -185,11 +184,6 @@ export class Init {
                                 value: 'vovk-zod',
                                 description: 'Use Zod for data validation',
                             },
-                            {
-                                name: 'vovk-yup',
-                                value: 'vovk-yup',
-                                description: 'Use Yup for data validation',
-                            },
                             {
                                 name: 'vovk-dto',
                                 value: 'vovk-dto',

package/dist/initProgram.mjs

@@ -14,7 +14,7 @@ export function initProgram(program) {
         .option('--update-ts-config', 'update tsconfig.json')
         .option('--update-scripts <mode>', 'update package.json scripts ("implicit" or "explicit")')
         .option('--lang <languages...>', 'generate client for other programming languages by default ("py" for Python and "rs" for Rust are supported)')
-        .option('--validation-library <library>', 'validation library to use ("vovk-zod", "vovk-yup", "vovk-dto" or another); set to "none" to skip')
+        .option('--validation-library <library>', 'validation library to use ("vovk-zod", "vovk-dto" or another); set to "none" to skip')
         .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/utils/getPackageJson.d.mts

@@ -0,0 +1,3 @@
+import { PackageJson } from 'type-fest';
+import type { ProjectInfo } from '../getProjectInfo/index.mjs';
+export declare function getPackageJson(cwd: string, log: ProjectInfo['log']): Promise<PackageJson>;

package/dist/utils/getPackageJson.mjs

@@ -0,0 +1,22 @@
+import fs from 'node:fs/promises';
+import path from 'node:path';
+let cachedPromise;
+export function getPackageJson(cwd, log) {
+    const pkgPath = path.join(cwd, 'package.json');
+    // If we have a cached promise, return it
+    if (cachedPromise) {
+        return cachedPromise;
+    }
+    const promise = fs
+        .readFile(pkgPath, 'utf8')
+        .then((content) => JSON.parse(content))
+        .catch(() => {
+        cachedPromise = undefined;
+        log.warn(`Failed to read package.json at ${pkgPath}. Using a fallback.`);
+        return {
+            name: 'unknown',
+        };
+    });
+    cachedPromise = promise;
+    return promise;
+}

package/dist/utils/normalizeOpenAPIMixins.d.mts

@@ -1,5 +1,7 @@
 import { VovkStrictConfig, type VovkConfig } from 'vovk';
-export declare function normalizeOpenAPIMixins({ mixinModules, cwd, }: {
+import type { ProjectInfo } from '../getProjectInfo/index.mjs';
+export declare function normalizeOpenAPIMixins({ mixinModules, log, cwd, }: {
     mixinModules: NonNullable<VovkConfig['openApiMixins']>;
+    log: ProjectInfo['log'];
     cwd?: string;
 }): Promise<VovkStrictConfig['openApiMixins']>;

package/dist/utils/normalizeOpenAPIMixins.mjs

@@ -1,6 +1,7 @@
 import fs from 'node:fs/promises';
 import path from 'node:path';
 import * as YAML from 'yaml';
+import chalkHighlightThing from './chalkHighlightThing.mjs';
 async function getOpenApiSpecLocal(openApiSpecFilePath, cwd) {
     const openApiSpecAbsolutePath = path.resolve(cwd, openApiSpecFilePath);
     const fileName = path.basename(openApiSpecAbsolutePath);
@@ -10,20 +11,36 @@ async function getOpenApiSpecLocal(openApiSpecFilePath, cwd) {
     const openApiSpecContent = await fs.readFile(openApiSpecAbsolutePath, 'utf8');
     return (fileName.endsWith('.json') ? JSON.parse(openApiSpecContent) : YAML.parse(openApiSpecContent));
 }
-async function getOpenApiSpecRemote(openApiSpecUrl) {
-    const resp = await fetch(openApiSpecUrl);
+async function getOpenApiSpecRemote({ cwd, url, fallback, log, }) {
+    const resp = await fetch(url);
     const text = await resp.text();
     if (!resp.ok) {
-        throw new Error(`Failed to fetch OpenAPI spec from ${openApiSpecUrl}: ${resp.status} ${resp.statusText}`);
+        if (fallback) {
+            log.warn(`Failed to fetch OpenAPI spec from ${chalkHighlightThing(url)}: ${resp.status} ${resp.statusText}. Falling back to ${chalkHighlightThing(fallback)}`);
+            return getOpenApiSpecLocal(fallback, cwd);
+        }
+        throw new Error(`Failed to fetch OpenAPI spec from ${chalkHighlightThing(url)}: ${resp.status} ${resp.statusText}`);
+    }
+    if (fallback) {
+        const fallbackAbsolutePath = path.resolve(cwd, fallback);
+        const existingFallback = await fs.readFile(fallbackAbsolutePath, 'utf8').catch(() => null);
+        if (existingFallback !== text) {
+            await fs.mkdir(path.dirname(fallbackAbsolutePath), { recursive: true });
+            await fs.writeFile(fallbackAbsolutePath, text);
+            log.info(`Saved OpenAPI spec to fallback file ${chalkHighlightThing(fallbackAbsolutePath)}`);
+        }
+        else {
+            log.debug(`OpenAPI spec at ${chalkHighlightThing(url)} is unchanged. Skipping write to fallback file ${chalkHighlightThing(fallbackAbsolutePath)}`);
+        }
     }
     return (text.trim().startsWith('{') || text.trim().startsWith('[') ? JSON.parse(text) : YAML.parse(text));
 }
-export async function normalizeOpenAPIMixins({ mixinModules, cwd = process.cwd(), }) {
+export async function normalizeOpenAPIMixins({ mixinModules, log, cwd = process.cwd(), }) {
     if (mixinModules) {
         const modules = await Promise.all(Object.entries(mixinModules).map(async ([mixinName, { source, apiRoot, getModuleName, getMethodName, errorMessageKey }]) => {
             let openAPIObject;
             if ('url' in source) {
-                openAPIObject = await getOpenApiSpecRemote(source.url);
+                openAPIObject = await getOpenApiSpecRemote({ url: source.url, fallback: source.fallback, log, cwd });
             }
             else if ('file' in source) {
                 openAPIObject = await getOpenApiSpecLocal(source.file, cwd);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vovk-cli",
-  "version": "0.0.1-draft.277",
+  "version": "0.0.1-draft.279",
   "bin": {
     "vovk": "./dist/index.mjs"
   },
@@ -35,7 +35,7 @@
   },
   "homepage": "https://vovk.dev",
   "peerDependencies": {
-    "vovk": "^3.0.0-draft.297"
+    "vovk": "^3.0.0-draft.315"
   },
   "optionalDependencies": {
     "vovk-python": "^0.0.1-draft.41"