vovk-cli 0.0.1-draft.39 → 0.0.1-draft.392

package/dist/dev/ensureClient.mjs

@@ -1,31 +0,0 @@
-import path from 'node:path';
-import fs from 'node:fs/promises';
-export default async function ensureClient(projectInfo) {
-    const { config, cwd, log } = projectInfo;
-    const now = Date.now();
-    const clientoOutDirAbsolutePath = path.join(cwd, config.clientOutDir);
-    const dts = `// auto-generated
-// This is a temporary placeholder to avoid errors if client is imported before it's generated.
-// If you still see this text, the client is not generated yet because of an unknown problem.
-// Feel free to report an issue at https://github.com/finom/vovk/issues`;
-    const js = dts;
-    const ts = dts;
-    const localJsAbsolutePath = path.join(clientoOutDirAbsolutePath, 'client.js');
-    const localDtsAbsolutePath = path.join(clientoOutDirAbsolutePath, 'client.d.ts');
-    const localTsAbsolutePath = path.join(clientoOutDirAbsolutePath, 'index.ts');
-    const existingJs = await fs.readFile(localJsAbsolutePath, 'utf-8').catch(() => null);
-    const existingDts = await fs.readFile(localDtsAbsolutePath, 'utf-8').catch(() => null);
-    const existingTs = await fs.readFile(localTsAbsolutePath, 'utf-8').catch(() => null);
-    if (existingJs && existingDts && existingTs) {
-        return { written: false, path: clientoOutDirAbsolutePath };
-    }
-    await fs.mkdir(clientoOutDirAbsolutePath, { recursive: true });
-    if (!existingJs)
-        await fs.writeFile(localJsAbsolutePath, js);
-    if (!existingDts)
-        await fs.writeFile(localDtsAbsolutePath, dts);
-    if (!existingTs)
-        await fs.writeFile(localTsAbsolutePath, ts);
-    log.info(`Empty client files are generated in ${Date.now() - now}ms`);
-    return { written: true, path: clientoOutDirAbsolutePath };
-}

package/dist/dev/isMetadataEmpty.d.mts

@@ -1,2 +0,0 @@
-import type { VovkSchema } from 'vovk';
-export default function isSchemaEmpty(schema: VovkSchema): boolean;

package/dist/dev/isMetadataEmpty.mjs

@@ -1,4 +0,0 @@
-import isEmpty from 'lodash/isEmpty.js';
-export default function isSchemaEmpty(schema) {
-    return isEmpty(schema.controllers) && isEmpty(schema.workers);
-}

package/dist/dev/writeOneSchemaFile.d.mts

@@ -1,11 +0,0 @@
-import type { VovkSchema } from 'vovk';
-import { type DiffResult } from './diffSchema.mjs';
-export declare const ROOT_SEGMENT_SCHEMA_NAME = "_root";
-export default function writeOneSchemaFile({ schemaOutAbsolutePath, schema, skipIfExists, }: {
-    schemaOutAbsolutePath: string;
-    schema: VovkSchema;
-    skipIfExists?: boolean;
-}): Promise<{
-    isCreated: boolean;
-    diffResult: DiffResult | null;
-}>;

package/dist/generateClient.d.mts

@@ -1,7 +0,0 @@
-import type { VovkSchema } from 'vovk';
-import type { ProjectInfo } from './getProjectInfo/index.mjs';
-import type { Segment } from './locateSegments.mjs';
-export default function generateClient(projectInfo: ProjectInfo, segments: Segment[], segmentsSchema: Record<string, VovkSchema>): Promise<{
-    written: boolean;
-    path: string;
-}>;

package/dist/generateClient.mjs

@@ -1,97 +0,0 @@
-import path from 'node:path';
-import fs from 'node:fs/promises';
-import formatLoggedSegmentName from './utils/formatLoggedSegmentName.mjs';
-import prettify from './utils/prettify.mjs';
-export default async function generateClient(projectInfo, segments, segmentsSchema) {
-    const { config, cwd, log, validateOnClientImportPath, apiEntryPoint, fetcherClientImportPath, schemaOutImportPath } = projectInfo;
-    const now = Date.now();
-    const clientoOutDirAbsolutePath = path.join(cwd, config.clientOutDir);
-    let dts = `// auto-generated
-/* eslint-disable */
-import type { clientizeController } from 'vovk/client';
-import type { promisifyWorker } from 'vovk/worker';
-import type { VovkClientFetcher } from 'vovk/client';
-import type fetcher from '${fetcherClientImportPath}';
-
-`;
-    let js = `// auto-generated
-/* eslint-disable */
-const { clientizeController } = require('vovk/client');
-const { promisifyWorker } = require('vovk/worker');
-const { default: fetcher } = require('${fetcherClientImportPath}');
-const schema = require('${schemaOutImportPath}');
-`;
-    let ts = `// auto-generated
-/* eslint-disable */
-import { clientizeController } from 'vovk/client';
-import { promisifyWorker } from 'vovk/worker';
-import type { VovkClientFetcher } from 'vovk/client';
-import fetcher from '${fetcherClientImportPath}';
-import schema from '${schemaOutImportPath}';
-
-`;
-    for (let i = 0; i < segments.length; i++) {
-        const { routeFilePath, segmentName } = segments[i];
-        const schema = segmentsSchema[segmentName];
-        if (!schema) {
-            throw new Error(`Unable to generate client. No schema found for ${formatLoggedSegmentName(segmentName)}`);
-        }
-        if (!schema.emitSchema)
-            continue;
-        const importRouteFilePath = path.relative(config.clientOutDir, routeFilePath);
-        dts += `import type { Controllers as Controllers${i}, Workers as Workers${i} } from "${importRouteFilePath}";\n`;
-        ts += `import type { Controllers as Controllers${i}, Workers as Workers${i} } from "${importRouteFilePath}";\n`;
-    }
-    dts += `
-type Options = typeof fetcher extends VovkClientFetcher<infer U> ? U : never;
-`;
-    ts += `
-${validateOnClientImportPath ? `import validateOnClient from '${validateOnClientImportPath}';\n` : '\nconst validateOnClient = undefined;'}
-type Options = typeof fetcher extends VovkClientFetcher<infer U> ? U : never;
-const apiRoot = '${apiEntryPoint}';
-`;
-    js += `
-const { default: validateOnClient = null } = ${validateOnClientImportPath ? `require('${validateOnClientImportPath}')` : '{}'};
-const apiRoot = '${apiEntryPoint}';
-`;
-    for (let i = 0; i < segments.length; i++) {
-        const { segmentName } = segments[i];
-        const schema = segmentsSchema[segmentName];
-        if (!schema) {
-            throw new Error(`Unable to generate client. No schema found for ${formatLoggedSegmentName(segmentName)}`);
-        }
-        if (!schema.emitSchema)
-            continue;
-        for (const key of Object.keys(schema.controllers)) {
-            dts += `export const ${key}: ReturnType<typeof clientizeController<Controllers${i}["${key}"], Options>>;\n`;
-            js += `exports.${key} = clientizeController(schema['${segmentName}'].controllers.${key}, '${segmentName}', { fetcher, validateOnClient, defaultOptions: { apiRoot } });\n`;
-            ts += `export const ${key} = clientizeController<Controllers${i}["${key}"], Options>(schema['${segmentName}'].controllers.${key}, '${segmentName}', { fetcher, validateOnClient, defaultOptions: { apiRoot } });\n`;
-        }
-        for (const key of Object.keys(schema.workers)) {
-            dts += `export const ${key}: ReturnType<typeof promisifyWorker<Workers${i}["${key}"]>>;\n`;
-            js += `exports.${key} = promisifyWorker(null, schema['${segmentName}'].workers.${key});\n`;
-            ts += `export const ${key} = promisifyWorker<Workers${i}["${key}"]>(null, schema['${segmentName}'].workers.${key});\n`;
-        }
-    }
-    const localJsAbsolutePath = path.join(clientoOutDirAbsolutePath, 'client.js');
-    const localDtsAbsolutePath = path.join(clientoOutDirAbsolutePath, 'client.d.ts');
-    const localTsAbsolutePath = path.join(clientoOutDirAbsolutePath, 'index.ts');
-    const existingJs = await fs.readFile(localJsAbsolutePath, 'utf-8').catch(() => '');
-    const existingDts = await fs.readFile(localDtsAbsolutePath, 'utf-8').catch(() => '');
-    const existingTs = await fs.readFile(localTsAbsolutePath, 'utf-8').catch(() => '');
-    if (config.prettifyClient) {
-        js = await prettify(js, localJsAbsolutePath);
-        dts = await prettify(dts, localDtsAbsolutePath);
-        ts = await prettify(ts, localTsAbsolutePath);
-    }
-    if (existingJs === js && existingDts === dts && existingTs === ts) {
-        log.debug(`Client is up to date and doesn't need to be regenerated (${Date.now() - now}ms)`);
-        return { written: false, path: clientoOutDirAbsolutePath };
-    }
-    await fs.mkdir(clientoOutDirAbsolutePath, { recursive: true });
-    await fs.writeFile(localJsAbsolutePath, js);
-    await fs.writeFile(localDtsAbsolutePath, dts);
-    await fs.writeFile(localTsAbsolutePath, ts);
-    log.info(`Client generated in ${Date.now() - now}ms`);
-    return { written: true, path: clientoOutDirAbsolutePath };
-}

package/dist/getProjectInfo/getConfig.d.mts

@@ -1,11 +0,0 @@
-import type { VovkConfig } from '../types.mjs';
-export default function getConfig({ clientOutDir, cwd }: {
-    clientOutDir?: string;
-    cwd: string;
-}): Promise<{
-    config: Required<VovkConfig>;
-    srcRoot: string;
-    configAbsolutePaths: string[];
-    userConfig: VovkConfig | null;
-    error: Error | undefined;
-}>;

package/dist/getProjectInfo/getConfig.mjs

@@ -1,29 +0,0 @@
-import getUserConfig from './getUserConfig.mjs';
-import getRelativeSrcRoot from './getRelativeSrcRoot.mjs';
-export default async function getConfig({ clientOutDir, cwd }) {
-    const env = process.env;
-    const { configAbsolutePaths, error, userConfig } = await getUserConfig({ cwd });
-    const conf = userConfig ?? {};
-    const srcRoot = await getRelativeSrcRoot({ cwd });
-    const config = {
-        modulesDir: env.VOVK_MODULES_DIR ?? conf.modulesDir ?? './' + [srcRoot, 'modules'].filter(Boolean).join('/'),
-        validateOnClient: env.VOVK_VALIDATE_ON_CLIENT ?? conf.validateOnClient ?? null,
-        validationLibrary: env.VOVK_VALIDATION_LIBRARY ?? conf.validationLibrary ?? null,
-        fetcher: env.VOVK_FETCHER ?? conf.fetcher ?? 'vovk/client/defaultFetcher',
-        schemaOutDir: env.VOVK_SCHEMA_OUT_DIR ?? conf.schemaOutDir ?? './.vovk-schema',
-        clientOutDir: clientOutDir ?? env.VOVK_CLIENT_OUT_DIR ?? conf.clientOutDir ?? './node_modules/.vovk-client',
-        origin: (env.VOVK_ORIGIN ?? conf.origin ?? '').replace(/\/$/, ''), // Remove trailing slash
-        rootEntry: env.VOVK_ROOT_ENTRY ?? conf.rootEntry ?? 'api',
-        rootSegmentModulesDirName: env.VOVK_ROOT_SEGMENT_MODULES_DIR_NAME ?? conf.rootSegmentModulesDirName ?? '',
-        logLevel: env.VOVK_LOG_LEVEL ?? conf.logLevel ?? 'info',
-        prettifyClient: (env.VOVK_PRETTIFY_CLIENT ? !!env.VOVK_PRETTIFY_CLIENT : null) ?? conf.prettifyClient ?? false,
-        devHttps: (env.VOVK_DEV_HTTPS ? !!env.VOVK_DEV_HTTPS : null) ?? conf.devHttps ?? false,
-        templates: {
-            service: 'vovk-cli/templates/service.ejs',
-            controller: 'vovk-cli/templates/controller.ejs',
-            worker: 'vovk-cli/templates/worker.ejs',
-            ...conf.templates,
-        },
-    };
-    return { config, srcRoot, configAbsolutePaths, userConfig, error };
-}

package/dist/getProjectInfo/getConfigAbsolutePaths.d.mts

@@ -1,4 +0,0 @@
-export default function getConfigAbsolutePaths({ cwd, relativePath, }: {
-    cwd: string;
-    relativePath?: string;
-}): Promise<string[]>;

package/dist/postinstall.d.mts

@@ -1 +0,0 @@
-export {};

package/dist/postinstall.mjs

@@ -1,24 +0,0 @@
-import fs from 'node:fs/promises';
-import path from 'node:path';
-/**
- * Checks if a file exists at the given path.
- * @param {string} filePath - The path to the file.
- * @returns {Promise<boolean>} - A promise that resolves to true if the file exists, false otherwise.
- */
-const getFileSystemEntryType = async (filePath) => !!(await fs.stat(filePath).catch(() => false));
-async function postinstall() {
-    const vovk = path.join(import.meta.dirname, '../../.vovk');
-    const js = path.join(vovk, 'client.js');
-    const ts = path.join(vovk, 'client.d.ts');
-    const index = path.join(vovk, 'index.ts');
-    if ((await getFileSystemEntryType(js)) ||
-        (await getFileSystemEntryType(ts)) ||
-        (await getFileSystemEntryType(index))) {
-        return;
-    }
-    await fs.mkdir(vovk, { recursive: true });
-    await fs.writeFile(js, '/* postinstall */');
-    await fs.writeFile(ts, '/* postinstall */');
-    await fs.writeFile(index, '/* postinstall */');
-}
-void postinstall();

package/templates/controller.ejs

@@ -1,52 +0,0 @@
-<% var modulePascalName = _.upperFirst(_.camelCase(moduleName)); %>
-<% var modulePascalNamePlural = pluralize(modulePascalName); %>
-<% var controllerName = modulePascalName + 'Controller'; %>
-<% var compiledName = modulePascalName + 'RPC'; %>
-<% var serviceName = modulePascalName + 'Service'; %>
-<% var prefix = pluralize(_.kebabCase(moduleName).toLowerCase()); %>
----
-dir: <%= getModuleDirName(segmentName, moduleName) %>
-fileName: <%= controllerName + '.ts' %>
-sourceName: <%= controllerName %>
-compiledName: <%= compiledName %>
----
-
-import { prefix, get, put, post, del, type VovkRequest } from 'vovk';
-<% if(withService) { %>
-import <%= serviceName %> from './<%= serviceName %>';
-<% } %>
-
-@prefix('<%= prefix %>')
-export default class <%= controllerName %> {
-    @get()
-    static get<%= modulePascalNamePlural %> = async (req: VovkRequest<null, { search: string }>) => {
-        const search = req.nextUrl.searchParams.get('search');
-        <% if(withService) { %>
-        return <%= serviceName %>.get<%= modulePascalNamePlural %>(search);
-        <% } else { %>
-        return { results: [], search };
-        <% } %>
-    }
-
-    @put(':id')
-    static update<%= modulePascalName %> = async (req: VovkRequest<{ foo: 'bar' | 'baz' }, { q: string }>, params: { id: string }) => {
-        const { id } = params;
-        const body = await req.json();
-        const q = req.nextUrl.searchParams.get('q');
-        <% if(withService) { %>
-        return <%= serviceName %>.update<%= modulePascalName %>(id, q, body);
-        <% } else { %>
-        return { id, body, q };
-        <% } %>
-    };
-
-    @post()
-    static create<%= modulePascalName %> = () => {
-        // ...
-    };
-
-    @del(':id')
-    static delete<%= modulePascalName %> = () => {
-        // ...
-    };
-}

package/templates/service.ejs

@@ -1,27 +0,0 @@
-<% var modulePascalName = _.upperFirst(_.camelCase(moduleName)); %>
-<% var modulePascalNamePlural = pluralize(modulePascalName); %>
-<% var serviceName = modulePascalName + 'Service'; %>
-<% var controllerName = modulePascalName + 'Controller'; %>
----
-dir: <%= getModuleDirName(segmentName, moduleName) %>
-fileName: <%= serviceName + '.ts' %>
----
-
-import type { VovkControllerBody, VovkControllerQuery } from 'vovk';
-import type <%= controllerName %> from './<%= controllerName %>';
-
-export default class <%= serviceName %> {
-  static get<%= modulePascalNamePlural %> = (search: VovkControllerQuery<typeof <%= controllerName %>.get<%= modulePascalNamePlural %>>['search']) => {
-    return { results: [], search };
-  };
-
-  static update<%= modulePascalName %> = (
-    id: string,
-    q: VovkControllerQuery<typeof <%= controllerName %>.update<%= modulePascalName %>>['q'],
-    body: VovkControllerBody<typeof <%= controllerName %>.update<%= modulePascalName %>>
-  ) => {
-    return { id, q, body };
-  };
-
-  // ...
-}

package/templates/worker.ejs

@@ -1,24 +0,0 @@
-<% var modulePascalName = _.upperFirst(_.camelCase(moduleName)); %>
-<% var modulePascalNamePlural = pluralize(modulePascalName); %>
-<% var workerName = modulePascalName + 'Worker'; %>
-<% var compiledName = modulePascalName + 'WPC'; %>
----
-dir: <%= getModuleDirName(segmentName, moduleName) %>
-fileName: <%= workerName + '.ts' %>
-sourceName: <%= workerName %>
-compiledName: <%= compiledName %>
----
-import { worker } from 'vovk';
-
-@worker()
-export default class <%= workerName %> {
-    static heavyComputation = () => {
-       return 'Hello, World';
-    };
-
-    static heavyComputationGenerator = function* () {
-        for(const str of ['Hello', 'World'] as const) {
-            yield str;
-        }
-    };
-}