vovk-cli 0.0.1-draft.302 → 0.0.1-draft.306

package/dist/dev/index.d.mts

@@ -1,8 +1,7 @@
+import type { DevOptions } from '../types.mjs';
 export declare class VovkDev {
     #private;
-    constructor({ schemaOut }: {
-        schemaOut: string | undefined;
-    });
+    constructor({ schemaOut, devHttps }: Pick<DevOptions, 'schemaOut' | 'devHttps'>);
     start({ exit }: {
         exit: boolean;
     }): Promise<void>;

package/dist/dev/index.mjs

@@ -36,8 +36,10 @@ export class VovkDev {
     #segmentWatcher = null;
     #onFirstTimeGenerate = null;
     #schemaOut = null;
-    constructor({ schemaOut }) {
+    #devHttps;
+    constructor({ schemaOut, devHttps }) {
         this.#schemaOut = schemaOut ?? null;
+        this.#devHttps = devHttps ?? false;
     }
     #watchSegments = (callback) => {
         const segmentReg = /\/?\[\[\.\.\.[a-zA-Z-_]+\]\]\/route.ts$/;
@@ -252,7 +254,7 @@ export class VovkDev {
     };
     #requestSchema = debounceWithArgs(async (segmentName) => {
         const { apiRoot, log, port, config } = this.#projectInfo;
-        const { devHttps } = config;
+        const devHttps = this.#devHttps ?? config.devHttps;
         const endpoint = `${apiRoot.startsWith(`http${devHttps ? 's' : ''}://`) ? apiRoot : `http${devHttps ? 's' : ''}://localhost:${port}${apiRoot}`}/${segmentName ? `${segmentName}/` : ''}_schema_`;
         log.debug(`Requesting schema for ${formatLoggedSegmentName(segmentName)} at ${endpoint}`);
         try {
@@ -326,7 +328,8 @@ export class VovkDev {
                 log.info('The schemas and the RPC client have been generated. Exiting...');
             });
         }
-        if (config.devHttps) {
+        const devHttps = this.#devHttps ?? config.devHttps;
+        if (devHttps) {
             const agent = new Agent({
                 connect: {
                     rejectUnauthorized: false,
@@ -382,7 +385,10 @@ export class VovkDev {
 }
 const env = process.env;
 if (env.__VOVK_START_WATCHER_IN_STANDALONE_MODE__ === 'true') {
-    void new VovkDev({ schemaOut: env.__VOVK_SCHEMA_OUT_FLAG__ || undefined }).start({
+    void new VovkDev({
+        schemaOut: env.__VOVK_SCHEMA_OUT_FLAG__ || undefined,
+        devHttps: env.__VOVK_DEV_HTTPS_FLAG__ === 'true',
+    }).start({
         exit: env.__VOVK_EXIT__ === 'true',
     });
 }

package/dist/dev/writeMetaJson.mjs

@@ -5,7 +5,7 @@ import { META_FILE_NAME } from './writeOneSegmentSchemaFile.mjs';
 import chalkHighlightThing from '../utils/chalkHighlightThing.mjs';
 export default async function writeMetaJson(schemaOutAbsolutePath, projectInfo) {
     const metaJsonPath = path.join(schemaOutAbsolutePath, META_FILE_NAME + '.json');
-    const metaStr = JSON.stringify({ config: projectInfo ? pick(projectInfo.config, projectInfo.config.emitConfig) : {} }, null, 2);
+    const metaStr = JSON.stringify({ config: projectInfo ? pick(projectInfo.config, [...projectInfo.config.emitConfig, '$schema']) : {} }, null, 2);
     const existingStr = await fs.readFile(metaJsonPath, 'utf-8').catch(() => null);
     if (existingStr !== metaStr) {
         await fs.writeFile(metaJsonPath, metaStr);

package/dist/generate/getClientTemplateFiles.mjs

@@ -3,7 +3,6 @@ import { glob } from 'glob';
 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, }) {
     const usedTemplateDefs = {};
     const fromTemplates = configKey === 'composedClient'
@@ -19,19 +18,8 @@ export default async function getClientTemplateFiles({ config, cwd, log, configK
         if (!(templateName in config.clientTemplateDefs)) {
             throw new Error(`Unknown template name: ${templateName}`);
         }
-        let usedDef = config.clientTemplateDefs[templateName];
-        if (usedDef.isTsClient) {
-            usedDef = {
-                ...usedDef,
-                requires: {
-                    ...usedDef.requires,
-                    [BuiltInTemplateName.mixins]: '.',
-                },
-            };
-        }
-        usedTemplateDefs[templateName] = usedDef;
+        usedTemplateDefs[templateName] = config.clientTemplateDefs[templateName];
     }
-    // $openapi['github']['components']['schemas']['User'];
     const templateFiles = [];
     const entries = Object.entries(usedTemplateDefs);
     for (let i = 0; i < entries.length; i++) {
@@ -49,6 +37,7 @@ export default async function getClientTemplateFiles({ config, cwd, log, configK
         }
         const defOutDir = configKey === 'composedClient' ? templateDef.composedClient?.outDir : templateDef.segmentedClient?.outDir;
         let files = [];
+        const outCwdRelativeDir = forceOutCwdRelativeDir ?? cliOutDir ?? defOutDir ?? configOutDir;
         if (templateAbsolutePath) {
             if (entryType === FileSystemEntryType.FILE) {
                 files = [{ filePath: templateAbsolutePath, isSingleFileTemplate: true }];
@@ -64,7 +53,6 @@ export default async function getClientTemplateFiles({ config, cwd, log, configK
                 log.error(`Template "${templateAbsolutePath}" not found`);
                 continue;
             }
-            const outCwdRelativeDir = forceOutCwdRelativeDir ?? cliOutDir ?? defOutDir ?? configOutDir;
             for (const { filePath, isSingleFileTemplate } of files) {
                 templateFiles.push({
                     templateName,
@@ -74,14 +62,14 @@ export default async function getClientTemplateFiles({ config, cwd, log, configK
                     templateDef,
                 });
             }
-            if (templateDef.requires) {
-                for (const [tName, reqRelativeDir] of Object.entries(templateDef.requires)) {
-                    const def = config.clientTemplateDefs[tName];
-                    if (!def) {
-                        throw new Error(`Template "${tName}" required by "${templateName}" not found`);
-                    }
-                    entries.push([tName, def, path.join(outCwdRelativeDir, reqRelativeDir)]);
+        }
+        if (templateDef.requires) {
+            for (const [tName, reqRelativeDir] of Object.entries(templateDef.requires)) {
+                const def = config.clientTemplateDefs[tName];
+                if (!def) {
+                    throw new Error(`Template "${tName}" required by "${templateName}" not found`);
                 }
+                entries.push([tName, def, path.join(outCwdRelativeDir, reqRelativeDir)]);
             }
         }
     }

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

@@ -12,9 +12,11 @@ export declare enum BuiltInTemplateName {
     mixins = "mixins",
     rsSrc = "rsSrc",
     rsPkg = "rsPkg",
+    rsReadme = "rsReadme",
     rs = "rs",
     pySrc = "pySrc",
     pyPkg = "pyPkg",
+    pyReadme = "pyReadme",
     py = "py"
 }
 export default function getTemplateDefs(userTemplateDefs?: VovkStrictConfig['clientTemplateDefs']): VovkStrictConfig['clientTemplateDefs'];

package/dist/getProjectInfo/getConfig/getTemplateDefs.mjs

@@ -17,9 +17,11 @@ export var BuiltInTemplateName;
     // other languages (packages installed separately)
     BuiltInTemplateName["rsSrc"] = "rsSrc";
     BuiltInTemplateName["rsPkg"] = "rsPkg";
+    BuiltInTemplateName["rsReadme"] = "rsReadme";
     BuiltInTemplateName["rs"] = "rs";
     BuiltInTemplateName["pySrc"] = "pySrc";
     BuiltInTemplateName["pyPkg"] = "pyPkg";
+    BuiltInTemplateName["pyReadme"] = "pyReadme";
     BuiltInTemplateName["py"] = "py";
 })(BuiltInTemplateName || (BuiltInTemplateName = {}));
 export default function getTemplateDefs(userTemplateDefs = {}) {
@@ -27,18 +29,24 @@ export default function getTemplateDefs(userTemplateDefs = {}) {
     const builtInDefs = {
         [BuiltInTemplateName.ts]: {
             templatePath: `vovk-cli/client-templates/${BuiltInTemplateName.ts}/`,
-            requires: { [BuiltInTemplateName.schemaTs]: '.' },
-            isTsClient: true,
+            requires: {
+                [BuiltInTemplateName.schemaTs]: '.',
+                [BuiltInTemplateName.mixins]: '.', // used conditionally if OpenAPI mixins are used
+            },
         },
         [BuiltInTemplateName.cjs]: {
             templatePath: `vovk-cli/client-templates/${BuiltInTemplateName.cjs}/`,
-            requires: { [BuiltInTemplateName.schemaCjs]: '.' },
-            isTsClient: true,
+            requires: {
+                [BuiltInTemplateName.schemaCjs]: '.',
+                [BuiltInTemplateName.mixins]: '.', // used conditionally if OpenAPI mixins are used
+            },
         },
         [BuiltInTemplateName.mjs]: {
             templatePath: `vovk-cli/client-templates/${BuiltInTemplateName.mjs}/`,
-            requires: { [BuiltInTemplateName.schemaCjs]: '.' },
-            isTsClient: true,
+            requires: {
+                [BuiltInTemplateName.schemaCjs]: '.',
+                [BuiltInTemplateName.mixins]: '.', // used conditionally if OpenAPI mixins are used
+            },
         },
         [BuiltInTemplateName.schemaTs]: {
             templatePath: `vovk-cli/client-templates/${BuiltInTemplateName.schemaTs}/`,
@@ -66,6 +74,12 @@ export default function getTemplateDefs(userTemplateDefs = {}) {
         },
         [BuiltInTemplateName.rsPkg]: {
             templatePath: `vovk-rust/client-templates/${BuiltInTemplateName.rsPkg}/`,
+            requires: {
+                [BuiltInTemplateName.rsReadme]: './',
+            },
+        },
+        [BuiltInTemplateName.rsReadme]: {
+            templatePath: `vovk-rust/client-templates/${BuiltInTemplateName.rsReadme}/`,
         },
         [BuiltInTemplateName.rs]: {
             composedClient: {
@@ -84,6 +98,12 @@ export default function getTemplateDefs(userTemplateDefs = {}) {
         },
         [BuiltInTemplateName.pyPkg]: {
             templatePath: `vovk-python/client-templates/${BuiltInTemplateName.pyPkg}/`,
+            requires: {
+                [BuiltInTemplateName.pyReadme]: './',
+            },
+        },
+        [BuiltInTemplateName.pyReadme]: {
+            templatePath: `vovk-python/client-templates/${BuiltInTemplateName.pyReadme}/`,
         },
         [BuiltInTemplateName.py]: {
             composedClient: {

package/dist/getProjectInfo/getConfig/index.mjs

@@ -75,7 +75,7 @@ export default async function getConfig({ configPath, cwd }) {
         openApiMixins: {},
     };
     if (typeof conf.emitConfig === 'undefined') {
-        config.emitConfig = ['$schema', 'libs'];
+        config.emitConfig = ['libs'];
     }
     else if (conf.emitConfig === true) {
         config.emitConfig = Object.keys(config);

package/dist/index.mjs

@@ -24,8 +24,9 @@ program
     .option('--next-dev', 'start schema watcher and Next.js with automatic port allocation')
     .option('--exit', 'kill the processe when schema and client is generated')
     .option('--schema-out <path>', 'path to schema output directory (default: .vovk-schema)')
+    .option('--https, --dev-https', 'use HTTPS for the dev server (default: false)')
     .action(async (nextArgs, options) => {
-    const { nextDev, exit = false, schemaOut } = options;
+    const { nextDev, exit = false, schemaOut, devHttps } = options;
     const portAttempts = 30;
     const PORT = !nextDev
         ? process.env.PORT
@@ -52,6 +53,7 @@ program
                     PORT,
                     __VOVK_START_WATCHER_IN_STANDALONE_MODE__: 'true',
                     __VOVK_SCHEMA_OUT_FLAG__: schemaOut ?? '',
+                    __VOVK_DEV_HTTPS_FLAG__: devHttps ? 'true' : 'false',
                     __VOVK_EXIT__: exit ? 'true' : 'false',
                 },
             },
@@ -68,7 +70,7 @@ program
         }
     }
     else {
-        void new VovkDev({ schemaOut }).start({ exit });
+        void new VovkDev({ schemaOut, devHttps }).start({ exit });
     }
 });
 program

package/dist/types.d.mts

@@ -11,6 +11,7 @@ export interface DevOptions {
     schemaOut?: string;
     nextDev?: boolean;
     exit?: boolean;
+    devHttps?: boolean;
 }
 export interface GenerateOptions {
     prettify?: boolean;
@@ -80,5 +81,6 @@ export type VovkEnv = {
     VOVK_DEV_HTTPS?: string;
     __VOVK_START_WATCHER_IN_STANDALONE_MODE__?: 'true';
     __VOVK_SCHEMA_OUT_FLAG__?: string;
+    __VOVK_DEV_HTTPS_FLAG__?: 'true' | 'false';
     __VOVK_EXIT__?: 'true' | 'false';
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vovk-cli",
-  "version": "0.0.1-draft.302",
+  "version": "0.0.1-draft.306",
   "bin": {
     "vovk": "./dist/index.mjs"
   },
@@ -35,10 +35,10 @@
   },
   "homepage": "https://vovk.dev",
   "peerDependencies": {
-    "vovk": "^3.0.0-draft.348"
+    "vovk": "^3.0.0-draft.351"
   },
   "optionalDependencies": {
-    "vovk-python": "^0.0.1-draft.55"
+    "vovk-python": "^0.0.1-draft.56"
   },
   "dependencies": {
     "@iarna/toml": "^2.2.5",