vovk-cli 0.0.1-draft.36 → 0.0.1-draft.361

package/dist/locateSegments.mjs

@@ -1,10 +1,20 @@
 import fs from 'node:fs/promises';
 import path from 'node:path';
 import getFileSystemEntryType from './utils/getFileSystemEntryType.mjs';
-export default async function locateSegments(dir, rootDir = dir) {
+export async function locateSegments({ dir, rootDir, config, log, }) {
     let results = [];
+    if (!dir)
+        return results; // If dir is null, return empty results because this isn't a Next.js app
+    rootDir = rootDir ?? dir;
+    let list = [];
     // Read the contents of the directory
-    const list = await fs.readdir(dir);
+    try {
+        list = (await fs.readdir(dir)).toSorted();
+    }
+    catch {
+        // do nothing
+        return results;
+    }
     // Iterate through each item in the directory
     for (const file of list) {
         const filePath = path.join(dir, file);
@@ -21,7 +31,7 @@ export default async function locateSegments(dir, rootDir = dir) {
                 }
             }
             // Recursively search inside subdirectories
-            const subDirResults = await locateSegments(filePath, rootDir);
+            const subDirResults = await locateSegments({ dir: filePath, rootDir, config, log });
             results = results.concat(subDirResults);
         }
     }

package/dist/new/addClassToSegmentCode.d.mts

@@ -1,6 +1,5 @@
-export default function addClassToSegmentCode(segmentSourceCode: string, { sourceName, compiledName, type, importPath, }: {
+export default function addClassToSegmentCode(segmentSourceCode: string, { sourceName, compiledName, importPath, }: {
     sourceName: string;
     compiledName: string;
-    type: 'worker' | 'controller';
     importPath: string;
 }): string;

package/dist/new/addClassToSegmentCode.mjs

@@ -1,5 +1,5 @@
 import { Project, QuoteKind, SyntaxKind } from 'ts-morph';
-export default function addClassToSegmentCode(segmentSourceCode, { sourceName, compiledName, type, importPath, }) {
+export default function addClassToSegmentCode(segmentSourceCode, { sourceName, compiledName, importPath, }) {
     const project = new Project({
         manipulationSettings: {
             quoteKind: QuoteKind.Single,
@@ -16,8 +16,8 @@ export default function addClassToSegmentCode(segmentSourceCode, { sourceName, c
             moduleSpecifier: importPath,
         });
     }
-    // Get the variable declaration for controllers or workers
-    const variableDeclaration = sourceFile.getVariableDeclaration(`${type}s`);
+    // Get the variable declaration for controllers
+    const variableDeclaration = sourceFile.getVariableDeclaration('controllers');
     if (variableDeclaration) {
         const initializer = variableDeclaration.getInitializer();
         if (initializer && initializer.getKind() === SyntaxKind.ObjectLiteralExpression) {

package/dist/new/index.d.mts

@@ -1,2 +1,3 @@
 import type { NewOptions } from '../types.mjs';
-export default function newComponents(components: string[], { dryRun, dir, templates, overwrite, noSegmentUpdate }: NewOptions): Promise<void>;
+import type { ProjectInfo } from '../getProjectInfo/index.mts';
+export declare function newComponents(components: string[], projectInfo: ProjectInfo, { dryRun, dir, templates, overwrite, noSegmentUpdate, empty, static: isStaticSegment }: NewOptions): Promise<void>;

package/dist/new/index.mjs

@@ -1,6 +1,6 @@
 import newModule from './newModule.mjs';
 import newSegment from './newSegment.mjs';
-export default async function newComponents(components, { dryRun, dir, templates, overwrite, noSegmentUpdate }) {
+export async function newComponents(components, projectInfo, { dryRun, dir, templates, overwrite, noSegmentUpdate, empty, static: isStaticSegment }) {
     if (components[0] === 'segment' || components[0] === 'segments') {
         // vovk new segment [segmentName]
         let segmentNames = components
@@ -10,7 +10,7 @@ export default async function newComponents(components, { dryRun, dir, templates
             segmentNames = [''];
         }
         for (const segmentName of segmentNames) {
-            await newSegment({ segmentName, overwrite, dryRun });
+            await newSegment({ projectInfo, segmentName, isStaticSegment, overwrite, dryRun });
         }
     }
     else {
@@ -24,6 +24,7 @@ export default async function newComponents(components, { dryRun, dir, templates
             throw new Error('A module name with an optional segment cannot be empty');
         }
         await newModule({
+            projectInfo,
             what,
             moduleNameWithOptionalSegment,
             dir,
@@ -31,6 +32,7 @@ export default async function newComponents(components, { dryRun, dir, templates
             overwrite,
             noSegmentUpdate,
             dryRun,
+            empty,
         });
     }
 }

package/dist/new/newModule.d.mts

@@ -1,4 +1,6 @@
-export default function newModule({ what, moduleNameWithOptionalSegment, dryRun, dir: dirFlag, templates: templatesFlag, noSegmentUpdate, overwrite, }: {
+import type { ProjectInfo } from '../getProjectInfo/index.mjs';
+export default function newModule({ projectInfo, what, moduleNameWithOptionalSegment, dryRun, dir: dirFlag, templates: templatesFlag, noSegmentUpdate, overwrite, empty, }: {
+    projectInfo: ProjectInfo;
     what: string[];
     moduleNameWithOptionalSegment: string;
     dryRun?: boolean;
@@ -6,4 +8,5 @@ export default function newModule({ what, moduleNameWithOptionalSegment, dryRun,
     templates?: string[];
     noSegmentUpdate?: boolean;
     overwrite?: boolean;
+    empty?: boolean;
 }): Promise<void>;

package/dist/new/newModule.mjs

@@ -1,13 +1,14 @@
 import path from 'node:path';
 import fs from 'node:fs/promises';
+import { getTsconfig } from 'get-tsconfig';
 import render from './render.mjs';
 import addClassToSegmentCode from './addClassToSegmentCode.mjs';
-import getProjectInfo from '../getProjectInfo/index.mjs';
-import locateSegments from '../locateSegments.mjs';
 import chalkHighlightThing from '../utils/chalkHighlightThing.mjs';
 import formatLoggedSegmentName from '../utils/formatLoggedSegmentName.mjs';
 import getFileSystemEntryType from '../utils/getFileSystemEntryType.mjs';
 import prettify from '../utils/prettify.mjs';
+import resolveAbsoluteModulePath from '../utils/resolveAbsoluteModulePath.mjs';
+import { locateSegments } from '../locateSegments.mjs';
 function splitByLast(str, delimiter = '/') {
     const index = str.lastIndexOf(delimiter);
     if (index === -1) {
@@ -18,19 +19,19 @@ function splitByLast(str, delimiter = '/') {
     const after = str.substring(index + delimiter.length);
     return [before, after];
 }
-export default async function newModule({ what, moduleNameWithOptionalSegment, dryRun, dir: dirFlag, templates: templatesFlag, noSegmentUpdate, overwrite, }) {
-    const { config, log, apiDir, cwd } = await getProjectInfo();
-    let templates = config.templates;
+export default async function newModule({ projectInfo, what, moduleNameWithOptionalSegment, dryRun, dir: dirFlag, templates: templatesFlag, noSegmentUpdate, overwrite, empty, }) {
+    const { config, log, cwd, apiDirAbsolutePath } = projectInfo;
+    const segments = await locateSegments({ dir: apiDirAbsolutePath, config, log });
+    const isNodeNextResolution = ['node16', 'nodenext'].includes((await getTsconfig(cwd)?.config?.compilerOptions?.moduleResolution?.toLowerCase()) ?? '');
+    let templates = config.moduleTemplates;
     const [segmentName, moduleName] = splitByLast(moduleNameWithOptionalSegment);
-    // replace c by controller, s by service, w by worker, everything else keeps the same
+    // replace c by controller, s by service, everything else keeps the same
     what = what.map((s) => {
         switch (s) {
             case 'c':
                 return 'controller';
             case 's':
                 return 'service';
-            case 'w':
-                return 'worker';
             default:
                 return s;
         }
@@ -49,16 +50,13 @@ export default async function newModule({ what, moduleNameWithOptionalSegment, d
             throw new Error(`Template for "${type}" not found`);
         }
     }
-    const segments = await locateSegments(apiDir);
     const segment = segments.find((s) => s.segmentName === segmentName);
     if (!segment) {
         throw new Error(`Unable to create module. Segment "${segmentName}" not found. Run "vovk new segment ${segmentName}" to create it`);
     }
     for (const type of what) {
         const templatePath = templates[type];
-        const templateAbsolutePath = templatePath.startsWith('/') || templatePath.startsWith('.')
-            ? path.resolve(cwd, templatePath)
-            : path.resolve(cwd, './node_modules', templatePath);
+        const templateAbsolutePath = resolveAbsoluteModulePath(templatePath, cwd);
         const templateCode = await fs.readFile(templateAbsolutePath, 'utf-8');
         const { dir: renderedDir, fileName, sourceName, compiledName, code, } = await render(templateCode, {
             cwd,
@@ -66,6 +64,9 @@ export default async function newModule({ what, moduleNameWithOptionalSegment, d
             withService: what.includes('service'),
             segmentName,
             moduleName,
+            empty,
+            templateFileName: templateAbsolutePath,
+            isNodeNextResolution,
         });
         const dir = dirFlag || renderedDir;
         if (!dir) {
@@ -84,24 +85,24 @@ export default async function newModule({ what, moduleNameWithOptionalSegment, d
             else {
                 await fs.mkdir(absoluteModuleDir, { recursive: true });
                 await fs.writeFile(absoluteModulePath, prettiedCode);
-                log.info(`Created ${chalkHighlightThing(fileName)} using ${chalkHighlightThing(`"${type}"`)} template for ${formatLoggedSegmentName(segmentName)}`);
+                log.info(`Created${empty ? ' empty' : ''} ${chalkHighlightThing(absoluteModulePath)} using ${chalkHighlightThing(`"${type}"`)} template for ${formatLoggedSegmentName(segmentName)}`);
             }
         }
-        if (type === 'controller' || type === 'worker') {
+        if (type === 'controller') {
             if (!sourceName) {
                 throw new Error(`The template for "${type}" does not provide a sourceName`);
             }
             if (!compiledName) {
-                throw new Error('The template for "${type}" does not provide a compiledName');
+                throw new Error(`The template for "${type}" does not provide a compiledName`);
             }
             const { routeFilePath } = segment;
             const segmentSourceCode = await fs.readFile(routeFilePath, 'utf-8');
-            const importPath = path.relative(path.dirname(routeFilePath), absoluteModulePath).replace(/\.(ts|tsx)$/, '');
+            let importPath = path.relative(path.dirname(routeFilePath) + '/', absoluteModulePath).replace(/\.(ts|tsx)$/, '');
+            importPath += isNodeNextResolution ? '.ts' : '';
             if (!noSegmentUpdate) {
                 const newSegmentCode = await prettify(addClassToSegmentCode(segmentSourceCode, {
                     sourceName,
                     compiledName,
-                    type,
                     importPath,
                 }), routeFilePath);
                 if (!dryRun) {

package/dist/new/newSegment.d.mts

@@ -1,5 +1,8 @@
-export default function newSegment({ segmentName, overwrite, dryRun, }: {
+import type { ProjectInfo } from '../getProjectInfo/index.mjs';
+export default function newSegment({ projectInfo, segmentName, isStaticSegment, overwrite, dryRun, }: {
+    projectInfo: ProjectInfo;
     segmentName: string;
+    isStaticSegment?: boolean;
     overwrite?: boolean;
     dryRun?: boolean;
 }): Promise<void>;

package/dist/new/newSegment.mjs

@@ -1,27 +1,33 @@
 import path from 'node:path';
 import fs from 'node:fs/promises';
-import getProjectInfo from '../getProjectInfo/index.mjs';
 import getFileSystemEntryType from '../utils/getFileSystemEntryType.mjs';
 import chalkHighlightThing from '../utils/chalkHighlightThing.mjs';
 import formatLoggedSegmentName from '../utils/formatLoggedSegmentName.mjs';
 import prettify from '../utils/prettify.mjs';
-export default async function newSegment({ segmentName, overwrite, dryRun, }) {
-    const { apiDir, cwd, log } = await getProjectInfo();
-    const absoluteSegmentRoutePath = path.join(cwd, apiDir, segmentName, '[[...vovk]]/route.ts');
+import chalk from 'chalk';
+export default async function newSegment({ projectInfo, segmentName, isStaticSegment, overwrite, dryRun, }) {
+    const { apiDirAbsolutePath, log, config } = projectInfo;
+    if (!apiDirAbsolutePath) {
+        throw new Error('No API directory found. Please ensure you are in a Nest.js project.');
+    }
+    const absoluteSegmentRoutePath = path.join(apiDirAbsolutePath, segmentName, '[[...vovk]]/route.ts');
     if (!overwrite && (await getFileSystemEntryType(absoluteSegmentRoutePath))) {
         throw new Error(`Unable to create new segment. ${formatLoggedSegmentName(segmentName, { upperFirst: true })} already exists.`);
     }
-    const code = await prettify(`import { initVovk } from 'vovk';
+    const code = await prettify(`import { initSegment${isStaticSegment ? ', generateStaticAPI' : ''} } from 'vovk';
 
 const controllers = {};
-const workers = {};
 
 export type Controllers = typeof controllers;
-export type Workers = typeof workers;
-
-export const { GET, POST, PATCH, PUT, HEAD, OPTIONS, DELETE } = initVovk({
+${isStaticSegment
+        ? `
+export function generateStaticParams() {
+  return generateStaticAPI(controllers);
+}
+`
+        : ''}
+export const { GET${isStaticSegment ? '' : ', POST, PATCH, PUT, HEAD, OPTIONS, DELETE'} } = initSegment({
 ${segmentName ? `  segmentName: '${segmentName}',\n` : ''}  emitSchema: true,
-  workers,
   controllers,
 });
 `, absoluteSegmentRoutePath);
@@ -29,5 +35,7 @@ ${segmentName ? `  segmentName: '${segmentName}',\n` : ''}  emitSchema: true,
         await fs.mkdir(path.dirname(absoluteSegmentRoutePath), { recursive: true });
         await fs.writeFile(absoluteSegmentRoutePath, code);
     }
-    log.info(`${formatLoggedSegmentName(segmentName, { upperFirst: true })} created at ${absoluteSegmentRoutePath}. Run ${chalkHighlightThing(`vovk new controller ${[segmentName, 'someName'].filter(Boolean).join('/')}`)} to create a new controller`);
+    log.info(`${formatLoggedSegmentName(segmentName, { upperFirst: true, isStatic: isStaticSegment })} created at ${absoluteSegmentRoutePath}.`);
+    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 ${path.join(config.modulesDir, dir)} folder for this segment`);
 }

package/dist/new/render.d.mts

@@ -1,8 +1,12 @@
-import type { VovkConfig, VovkModuleRenderResult } from '../types.mjs';
-export default function render(codeTemplate: string, { config, withService, segmentName, moduleName, }: {
+import type { VovkStrictConfig } from 'vovk';
+import type { VovkModuleRenderResult } from '../types.mjs';
+export default function render(codeTemplate: string, { config, withService, segmentName, moduleName, empty, templateFileName, isNodeNextResolution, }: {
     cwd: string;
-    config: VovkConfig;
+    config: VovkStrictConfig;
     withService: boolean;
     segmentName: string;
     moduleName: string;
+    empty?: boolean;
+    templateFileName: string;
+    isNodeNextResolution: boolean;
 }): Promise<VovkModuleRenderResult>;

package/dist/new/render.mjs

@@ -4,25 +4,46 @@ import _ from 'lodash';
 import pluralize from 'pluralize';
 import addCommonTerms from './addCommonTerms.mjs';
 addCommonTerms();
-export default async function render(codeTemplate, { config, withService, segmentName, moduleName, }) {
+export default async function render(codeTemplate, { config, withService, segmentName, moduleName, empty, templateFileName, isNodeNextResolution, }) {
     const getModuleDirName = (givenSegmentName, givenModuleName) => [config.modulesDir, givenSegmentName || config.rootSegmentModulesDirName, _.camelCase(givenModuleName)]
         .filter(Boolean)
         .join('/');
-    const templateVars = {
-        // input
+    const theThing = _.camelCase(moduleName);
+    const TheThing = _.upperFirst(theThing);
+    const the_thing = _.snakeCase(moduleName);
+    const THE_THING = _.toUpper(the_thing);
+    const the__thing = _.kebabCase(moduleName);
+    const t = {
+        // module name variations
+        moduleName,
+        theThing,
+        theThings: pluralize(theThing),
+        TheThing,
+        TheThings: pluralize(TheThing),
+        the_thing,
+        the_things: pluralize(the_thing),
+        THE_THING,
+        THE_THINGS: pluralize(THE_THING),
+        'the-thing': the__thing,
+        'the-things': pluralize(the__thing),
+        // data
         config,
         withService,
         segmentName,
-        moduleName,
-        // utils
-        getModuleDirName,
+        nodeNextResolutionExt: {
+            ts: isNodeNextResolution ? '.ts' : '',
+            js: isNodeNextResolution ? '.js' : '',
+            cjs: isNodeNextResolution ? '.cjs' : '',
+            mjs: isNodeNextResolution ? '.mjs' : '',
+        },
+        defaultDir: getModuleDirName(segmentName, theThing),
         // libraries
         _, // lodash
         pluralize,
     };
-    const parsed = matter((await ejs.render(codeTemplate, templateVars, { async: true })).trim());
+    const parsed = matter((await ejs.render(codeTemplate, { t }, { async: true, filename: templateFileName })).trim());
     const { dir, fileName, sourceName, compiledName } = parsed.data;
-    const code = parsed.content;
+    const code = empty ? (sourceName ? `export default class ${sourceName} {}` : '') : parsed.content;
     return {
         dir,
         fileName,

package/dist/types.d.mts

@@ -1,42 +1,6 @@
 import type { LogLevelNames } from 'loglevel';
-export type KnownAny = any;
-export type VovkDevEnv = {
-    PORT?: string;
-    VOVK_CLIENT_OUT_DIR?: string;
-    VOVK_SCHEMA_OUT_DIR?: string;
-    VOVK_FETCHER?: string;
-    VOVK_VALIDATE_ON_CLIENT?: string;
-    VOVK_MODULES_DIR?: string;
-    VOVK_VALIDATION_LIBRARY?: string;
-    VOVK_ORIGIN?: string;
-    VOVK_ROOT_ENTRY?: string;
-    VOVK_API_ENTRY_POINT?: string;
-    VOVK_ROOT_SEGMENT_MODULES_DIR_NAME?: string;
-    VOVK_LOG_LEVEL?: LogLevelNames;
-    VOVK_PRETTIFY_CLIENT?: string;
-    VOVK_DEV_HTTPS?: string;
-    __VOVK_START_WATCHER_IN_STANDALONE_MODE__?: 'true';
-};
-export type VovkConfig = {
-    clientOutDir?: string;
-    schemaOutDir?: string;
-    fetcher?: string;
-    validateOnClient?: string | null;
-    modulesDir?: string;
-    validationLibrary?: string | null;
-    rootEntry?: string;
-    origin?: string;
-    rootSegmentModulesDirName?: string;
-    logLevel?: LogLevelNames;
-    prettifyClient?: boolean;
-    devHttps?: boolean;
-    templates?: {
-        service?: string;
-        controller?: string;
-        worker?: string;
-        [key: string]: string | undefined;
-    };
-};
+import type { build } from 'tsdown';
+import type { VovkStrictConfig } from 'vovk';
 export type VovkModuleRenderResult = {
     fileName: string;
     dir: string;
@@ -45,14 +9,53 @@ export type VovkModuleRenderResult = {
     code: string;
 };
 export interface DevOptions {
+    schemaOut?: string;
     nextDev?: boolean;
+    exit?: boolean;
+    devHttps?: boolean;
+    logLevel?: LogLevelNames;
 }
 export interface GenerateOptions {
-    clientOut?: string;
+    prettify?: boolean;
+    configPath?: string;
+    schemaPath?: string;
+    origin?: string;
+    openapiSpec?: string[];
+    openapiGetModuleName?: string[];
+    openapiGetMethodName?: string[];
+    openapiRootUrl?: string[];
+    openapiMixinName?: string[];
+    openapiFallback?: string[];
+    watch?: boolean | string;
+    composedFrom?: string[];
+    composedOut?: string;
+    composedOnly?: boolean;
+    composedIncludeSegments?: string[];
+    composedExcludeSegments?: string[];
+    segmentedFrom?: string[];
+    segmentedOut?: string;
+    segmentedOnly?: boolean;
+    segmentedIncludeSegments?: string[];
+    segmentedExcludeSegments?: string[];
+    logLevel?: LogLevelNames;
+}
+export interface BundleOptions extends Partial<Pick<VovkStrictConfig['bundle'], 'prebundleOutDir' | 'keepPrebundleDir' | 'includeSegments' | 'excludeSegments'>> {
+    configPath?: string;
+    schemaPath?: string;
+    schema?: string;
+    outDir?: string;
+    origin?: string;
+    tsconfig?: string;
+    openapiSpec?: string[];
+    openapiGetModuleName?: string[];
+    openapiGetMethodName?: string[];
+    openapiRootUrl?: string[];
+    openapiMixinName?: string[];
+    logLevel?: LogLevelNames;
 }
 export interface InitOptions {
+    prefix?: string;
     yes?: boolean;
-    logLevel: LogLevelNames;
     useNpm?: boolean;
     useYarn?: boolean;
     usePnpm?: boolean;
@@ -60,10 +63,11 @@ export interface InitOptions {
     skipInstall?: boolean;
     updateTsConfig?: boolean;
     updateScripts?: 'implicit' | 'explicit';
-    validationLibrary?: string | null;
-    validateOnClient?: boolean;
+    validationLibrary?: 'zod' | 'yup' | 'class-validator' | 'valibot' | 'arktype' | null;
     dryRun?: boolean;
+    lang?: string[];
     channel?: 'latest' | 'beta' | 'draft';
+    logLevel?: LogLevelNames;
 }
 export interface NewOptions {
     dryRun?: boolean;
@@ -71,4 +75,22 @@ export interface NewOptions {
     dir?: string;
     overwrite?: boolean;
     noSegmentUpdate?: boolean;
+    empty?: boolean;
+    static?: boolean;
+    logLevel?: LogLevelNames;
+}
+export type VovkEnv = {
+    PORT?: string;
+    VOVK_SCHEMA_OUT_DIR?: string;
+    VOVK_ORIGIN?: string;
+    VOVK_ROOT_ENTRY?: string;
+    VOVK_API_ENTRY_POINT?: string;
+    __VOVK_START_WATCHER_IN_STANDALONE_MODE__?: 'true';
+    __VOVK_SCHEMA_OUT_FLAG__?: string;
+    __VOVK_DEV_HTTPS_FLAG__?: 'true' | 'false';
+    __VOVK_EXIT__?: 'true' | 'false';
+    __VOVK_LOG_LEVEL__?: LogLevelNames;
+};
+declare global {
+    var TSdownBuildOptions: Parameters<typeof build>[0];
 }

package/dist/utils/compileJSONSchemaToTypeScriptType.d.mts

@@ -0,0 +1,5 @@
+import type { OpenAPIObject } from 'openapi3-ts/oas31';
+import type { JSONSchema7 } from 'json-schema';
+export declare function compileJSONSchemaToTypeScriptType(schema: JSONSchema7, typeName: string, components?: NonNullable<OpenAPIObject['components']>, options?: {
+    dontCreateRefTypes?: boolean;
+}): string;

package/dist/utils/compileJSONSchemaToTypeScriptType.mjs

@@ -0,0 +1,9 @@
+import { compileTs } from './compileTs.mjs';
+export function compileJSONSchemaToTypeScriptType(schema, typeName, components = {}, options = {}) {
+    if (!schema)
+        return '';
+    if ('tsType' in schema && typeof schema.tsType === 'string')
+        return `export type ${typeName} = ${schema.tsType};\n`;
+    const tsType = compileTs({ schema: { ...schema, components }, name: typeName, ...options });
+    return tsType;
+}

package/dist/utils/compileTs.d.mts

@@ -0,0 +1,12 @@
+import { JSONSchema7 } from 'json-schema';
+import { OpenAPIObject } from 'openapi3-ts/oas31';
+interface CompileOptions {
+    name: string;
+    schema: JSONSchema7 & {
+        components?: OpenAPIObject['components'];
+    };
+    refs?: Map<string, JSONSchema7>;
+    dontCreateRefTypes?: boolean;
+}
+export declare function compileTs(options: CompileOptions): string;
+export {};