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

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/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/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'] ??
@@ -86,14 +87,11 @@ export async function generate({ isEnsuringClient = false, projectInfo, forceNot
         ...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 +117,6 @@ export async function generate({ isEnsuringClient = false, projectInfo, forceNot
             config,
             cwd,
             log,
-            hasMixins,
             cliGenerateOptions,
             configKey: 'composedClient',
         });
@@ -140,11 +137,16 @@ export async function generate({ isEnsuringClient = false, projectInfo, forceNot
                 config,
                 packages: [config.composedClient.package, templateDef.composedClient?.package],
             });
+            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,
@@ -169,7 +171,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 +191,6 @@ export async function generate({ isEnsuringClient = false, projectInfo, forceNot
             config,
             cwd,
             log,
-            hasMixins,
             cliGenerateOptions,
             configKey: 'segmentedClient',
         });
@@ -214,11 +215,16 @@ export async function generate({ isEnsuringClient = false, projectInfo, forceNot
                         templateDef.segmentedClient?.packages?.[segmentName],
                     ],
                 });
+                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],
@@ -243,7 +249,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/writeOneClientFile.mjs

@@ -53,7 +53,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

@@ -67,7 +67,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 +84,11 @@ 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;
                 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

@@ -68,10 +68,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 +80,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/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.278",
   "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.298"
   },
   "optionalDependencies": {
     "vovk-python": "^0.0.1-draft.41"