vovk-cli 0.0.1-draft.1 → 0.0.1-draft.100

package/templates/service.ejs

@@ -1,7 +1,27 @@
-<% var ServiceName = _.upperFirst(_.camelCase(moduleName) + 'Service'; %>
-
+<% const vars = {
+  ControllerName: t.TheThing + 'Controller',
+  ServiceName: t.TheThing + 'Service',
+}; %>
 ---
-filePath: <%= getModulePath(segmentName, moduleName, ServiceName + '.ts') %> # Relative to "modules" dir
+dir: <%= t.defaultDir %>
+fileName: <%= vars.ServiceName + '.ts' %>
 ---
 
-// TO DO: Implement <%= ServiceName %>
+import type { VovkControllerBody, VovkControllerQuery } from 'vovk';
+import type <%= vars.ControllerName %> from './<%= vars.ControllerName %>';
+
+export default class <%= vars.ServiceName %> {
+  static get<%= t.TheThings %> = (search: VovkControllerQuery<typeof <%= vars.ControllerName %>.get<%= t.TheThings %>>['search']) => {
+    return { results: [], search };
+  };
+
+  static update<%= t.TheThing %> = (
+    id: string,
+    q: VovkControllerQuery<typeof <%= vars.ControllerName %>.update<%= t.TheThing %>>['q'],
+    body: VovkControllerBody<typeof <%= vars.ControllerName %>.update<%= t.TheThing %>>
+  ) => {
+    return { id, q, body };
+  };
+
+  // ...
+}

package/dist/generateClient.d.mts

@@ -1,7 +0,0 @@
-import type { ProjectInfo } from './getProjectInfo/index.mjs';
-import type { Segment } from './locateSegments.mjs';
-import type { VovkSchema } from 'vovk';
-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 'path';
-import fs from '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 prefix = '${apiEntryPoint}';
-`;
-    js += `
-const { default: validateOnClient = null } = ${validateOnClientImportPath ? `require('${validateOnClientImportPath}')` : '{}'};
-const prefix = '${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: { prefix } });\n`;
-            ts += `export const ${key} = clientizeController<Controllers${i}["${key}"], Options>(schema['${segmentName}'].controllers.${key}, '${segmentName}', { fetcher, validateOnClient, defaultOptions: { prefix } });\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/directoryExists.d.mts

@@ -1 +0,0 @@
-export default function directoryExists(dir: string): Promise<boolean>;

package/dist/getProjectInfo/directoryExists.mjs

@@ -1,10 +0,0 @@
-import fs from 'fs/promises';
-export default async function directoryExists(dir) {
-    try {
-        const stats = await fs.stat(dir);
-        return stats.isDirectory();
-    }
-    catch (error) {
-        return false;
-    }
-}

package/dist/watcher/diffSchema.d.mts

@@ -1,43 +0,0 @@
-import type { VovkSchema } from 'vovk';
-import { _VovkControllerSchema, _VovkWorkerSchema } from 'vovk/types';
-interface HandlersDiff {
-    nameOfClass: string;
-    added: string[];
-    removed: string[];
-    changed: string[];
-}
-interface WorkersOrControllersDiff {
-    added: string[];
-    removed: string[];
-    handlers: HandlersDiff[];
-}
-export interface DiffResult {
-    workers: WorkersOrControllersDiff;
-    controllers: WorkersOrControllersDiff;
-}
-export declare function diffHandlers<T extends _VovkWorkerSchema['_handlers'] | _VovkControllerSchema['_handlers']>(oldHandlers: T, newHandlers: T, nameOfClass: string): HandlersDiff;
-export declare function diffWorkersOrControllers<T extends VovkSchema['controllers'] | VovkSchema['workers']>(oldItems: T, newItems: T): WorkersOrControllersDiff;
-/**
-example output:
-{
-  workers: {
-    added: ["WorkerC"],
-    removed: ["WorkerA"],
-    handlers: []
-  },
-  controllers: {
-    added: ["ControllerC"],
-    removed: ["ControllerB"],
-    handlers: [
-      {
-        nameOfClass: "ControllerA",
-        added: ["handlerF"],
-        removed: [],
-        changed: ["handlerD"]
-      }
-    ]
-  }
-}
-*/
-export default function diffSchema(oldJson: VovkSchema, newJson: VovkSchema): DiffResult;
-export {};

package/dist/watcher/index.d.mts

@@ -1,6 +0,0 @@
-export declare class VovkCLIWatcher {
-    #private;
-    start({ clientOutDir }?: {
-        clientOutDir?: string;
-    }): Promise<void>;
-}

package/dist/watcher/logDiffResult.mjs

@@ -1,90 +0,0 @@
-import formatLoggedSegmentName from '../utils/formatLoggedSegmentName.mjs';
-import chalkHighlightThing from '../utils/chalkHighlightThing.mjs';
-export default function logDiffResult(segmentName, diffResult, projectInfo) {
-    const diffNormalized = [];
-    diffResult.workers.added.forEach((name) => {
-        diffNormalized.push({ what: 'worker', type: 'added', name });
-    });
-    diffResult.workers.removed.forEach((name) => {
-        diffNormalized.push({ what: 'worker', type: 'removed', name });
-    });
-    diffResult.workers.handlers.forEach((handler) => {
-        handler.added.forEach((name) => {
-            diffNormalized.push({ what: 'workerHandler', type: 'added', name: `${handler.nameOfClass}.${name}` });
-        });
-        handler.removed.forEach((name) => {
-            diffNormalized.push({ what: 'workerHandler', type: 'removed', name: `${handler.nameOfClass}.${name}` });
-        });
-        handler.changed.forEach((name) => {
-            diffNormalized.push({ what: 'workerHandler', type: 'changed', name: `${handler.nameOfClass}.${name}` });
-        });
-    });
-    diffResult.controllers.added.forEach((name) => {
-        diffNormalized.push({ what: 'controller', type: 'added', name });
-    });
-    diffResult.controllers.removed.forEach((name) => {
-        diffNormalized.push({ what: 'controller', type: 'removed', name });
-    });
-    diffResult.controllers.handlers.forEach((handler) => {
-        handler.added.forEach((name) => {
-            diffNormalized.push({ what: 'controllerHandler', type: 'added', name: `${handler.nameOfClass}.${name}` });
-        });
-        handler.removed.forEach((name) => {
-            diffNormalized.push({ what: 'controllerHandler', type: 'removed', name: `${handler.nameOfClass}.${name}` });
-        });
-        handler.changed.forEach((name) => {
-            diffNormalized.push({ what: 'controllerHandler', type: 'changed', name: `${handler.nameOfClass}.${name}` });
-        });
-    });
-    const LIMIT = diffNormalized.length < 12 ? diffNormalized.length : 10;
-    for (const diffNormalizedItem of diffNormalized.slice(0, LIMIT)) {
-        switch (diffNormalizedItem.what) {
-            case 'worker':
-                switch (diffNormalizedItem.type) {
-                    case 'added':
-                        projectInfo.log.info(`Schema for worker ${chalkHighlightThing(diffNormalizedItem.name)} has been added at ${formatLoggedSegmentName(segmentName)}`);
-                        break;
-                    case 'removed':
-                        projectInfo.log.info(`Schema for worker ${chalkHighlightThing(diffNormalizedItem.name)} has been removed from ${formatLoggedSegmentName(segmentName)}`);
-                        break;
-                }
-                break;
-            case 'controller':
-                switch (diffNormalizedItem.type) {
-                    case 'added':
-                        projectInfo.log.info(`Schema for controller ${chalkHighlightThing(diffNormalizedItem.name)} has been added at ${formatLoggedSegmentName(segmentName)}`);
-                        break;
-                    case 'removed':
-                        projectInfo.log.info(`Schema for controller ${chalkHighlightThing(diffNormalizedItem.name)} has been removed from ${formatLoggedSegmentName(segmentName)}`);
-                        break;
-                }
-                break;
-            case 'workerHandler':
-                switch (diffNormalizedItem.type) {
-                    case 'added':
-                        projectInfo.log.info(`Schema for worker method ${chalkHighlightThing(diffNormalizedItem.name)} has been added at ${formatLoggedSegmentName(segmentName)}`);
-                        break;
-                    case 'removed':
-                        projectInfo.log.info(`Schema for worker method ${chalkHighlightThing(diffNormalizedItem.name)} has been removed from ${formatLoggedSegmentName(segmentName)}`);
-                        break;
-                }
-                break;
-            case 'controllerHandler':
-                switch (diffNormalizedItem.type) {
-                    case 'added':
-                        projectInfo.log.info(`Schema for controller method ${chalkHighlightThing(diffNormalizedItem.name)} has been added at ${formatLoggedSegmentName(segmentName)}`);
-                        break;
-                    case 'removed':
-                        projectInfo.log.info(`Schema for controller method ${chalkHighlightThing(diffNormalizedItem.name)} has been removed from ${formatLoggedSegmentName(segmentName)}`);
-                        break;
-                    case 'changed':
-                        projectInfo.log.info(`Schema for controller method ${chalkHighlightThing(diffNormalizedItem.name)} has been changed at ${formatLoggedSegmentName(segmentName)}`);
-                        break;
-                }
-                break;
-        }
-    }
-    if (diffNormalized.length > LIMIT) {
-        projectInfo.log.info(`... and ${diffNormalized.length - LIMIT} more changes`);
-    }
-}

package/templates/worker.ejs

@@ -1 +0,0 @@
-// TODO

package/templates_old/MyThingController.c.only.template.ts

@@ -1,32 +0,0 @@
-import { prefix, get, put, post, del, type VovkRequest } from 'vovk';
-
-@prefix('my-things')
-export default class MyThingController {
-  @get()
-  static getMyThingsExample = (req: VovkRequest<null, { q: string }>) => {
-    const q = req.nextUrl.searchParams.get('q');
-    return { q };
-  };
-
-  @put(':id')
-  static updateMyThingExample = 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');
-
-    return { id, q, body };
-  };
-
-  @post()
-  static createMyThingExample = () => {
-    // ...
-  };
-
-  @del(':id')
-  static deleteMyThingExample = () => {
-    // ...
-  };
-}

package/templates_old/MyThingController.c.template.ts

@@ -1,34 +0,0 @@
-import { prefix, get, put, post, del, type VovkRequest } from 'vovk';
-import MyThingService from './MyThingService.s.template';
-
-@prefix('my-things')
-export default class MyThingController {
-  @get()
-  static getMyThingsExample(req: VovkRequest<null, { q: string }>) {
-    const q = req.nextUrl.searchParams.get('q');
-
-    return MyThingService.getMyThingsExample(q);
-  }
-
-  @put(':id')
-  static updateMyThingExample = 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');
-
-    return MyThingService.updateMyThingExample(id, q, body);
-  };
-
-  @post()
-  static createMyThingExample = () => {
-    // ...
-  };
-
-  @del(':id')
-  static deleteMyThingExample = () => {
-    // ...
-  };
-}

package/templates_old/MyThingService.s.template.ts

@@ -1,18 +0,0 @@
-import type { VovkControllerBody, VovkControllerQuery } from 'vovk';
-import type MyThingController from './MyThingController.c.template';
-
-export default class MyThingService {
-  static getMyThingsExample = (q: VovkControllerQuery<typeof MyThingController.getMyThingsExample>['q']) => {
-    return { q };
-  };
-
-  static updateMyThingExample = (
-    id: string,
-    q: VovkControllerQuery<typeof MyThingController.updateMyThingExample>['q'],
-    body: VovkControllerBody<typeof MyThingController.updateMyThingExample>
-  ) => {
-    return { id, q, body };
-  };
-
-  // ...
-}

package/templates_old/controller.ejs

@@ -1,85 +0,0 @@
-<% var modulePascalName = _.upperFirst(_.camelCase(moduleName)); %>
-<% var modulePascalNamePlural = pluralize(modulePascalName); %>
-<% var ControllerName = modulePascalName + 'Controller'; %>
-<% var RPCName = modulePascalName + 'RPC'; %>
-<% var ServiceName = modulePascalName + 'Service'; %>
----
-# Relative to modules dir
-fileName: <%= getFileDir(segmentName, moduleName) + ControllerName + '.ts' %>
-className: <%= ControllerName %> # Used to define a controller in a segment
-rpcName: <%= RPCName %> # Used to define an exported RPC class in a segment
----
-
-import { prefix, get, put, post, del<%= !config.validationLibrary ? ', type VovkRequest' : '' %> } from 'vovk';
-<% if(withService) { %>
-import <%= ServiceName %> from './<%= ServiceName %>';
-<% } %>
-<% if(config.validationLibrary === 'vovk-zod') { %>
-import { withZod } from 'vovk-zod';
-import { z } from 'zod';
-<% } %>
-
-@prefix('<%= _.kebabCase(moduleName).toLowerCase() %>')
-export default class <%= ControllerName %> {
-    @get()
-    <% if(config.validationLibrary === 'vovk-zod') { %>
-    async get<%= modulePascalNamePlural %> = withZod(null, z.object({ q: z.string() }), (req) => {
-        const q = req.nextUrl.searchParams.get('q');
-        <% if(withService) { %>
-        return <%= ServiceName %>.getMyThingsExample(q);
-        <% } else { %>
-        return { q };
-        <% } %>
-    });
-    <% } else { %>
-    static get<%= modulePascalNamePlural %> = async (req: VovkRequest<null, { q: string }>) => {
-        const q = req.nextUrl.searchParams.get('q');
-        <% if(withService) { %>
-        return <%= ServiceName %>.getMyThingsExample(q);
-        <% } else { %>
-        return { q };
-        <% } %>
-    }
-    <% } %>
-
-    @put(':id')
-    <% if(config.validationLibrary === 'vovk-zod') { %>
-    static update<%= modulePascalNamePlural %> = withZod(
-        z.object({
-        foo: z.union([z.literal('bar'), z.literal('baz')]),
-        }),
-        z.object({ q: z.string() }),
-        async (req, params: { id: string }) => {
-        const { id } = params;
-        const body = await req.json();
-        const q = req.nextUrl.searchParams.get('q');
-        <% if(withService) { %>
-        return MyThingService.updateMyThingExample(id, q, body);
-        <% } else { %>
-        return { id, body, q };
-        <% } %>
-        }
-    );
-    <% } else { %>
-    static update<%= modulePascalNamePlural %> = 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 MyThingService.updateMyThingExample(id, q, body);
-        <% } else { %>
-        return { id, body, q };
-        <% } %>
-    };
-    <% } %>
-
-    @post()
-    static create<%= modulePascalNamePlural %> = () => {
-        // ...
-    };
-
-    @del(':id')
-    static delete<%= modulePascalNamePlural %> = () => {
-        // ...
-    };
-}

package/templates_old/service.ejs

@@ -1,9 +0,0 @@
-<% var modulePascalName = _.upperFirst(_.camelCase(moduleName); %>
-<% var ServiceName = modulePascalName + 'Service'; %>
-
----
-# Relative to modules dir
-fileName: <%= getFileDir(segmentName, moduleName) + ServiceName + '.ts' %>
----
-
-// TO DO: Implement <%= ServiceName %>

package/templates_old/worker.ejs

@@ -1,9 +0,0 @@
-<% var modulePascalName = _.upperFirst(_.camelCase(moduleName); %>
-<% var WorkerName = modulePascalName + 'Worker'; %>
-
----
-# Relative to modules dir
-fileName: <%= getFileDir(segmentName, moduleName) + WorkerName + '.ts' %>
----
-
-// TO DO: Implement <%= WorkerName %>

package/templates_old/zod/MyThingController.c.only.template.ts

@@ -1,32 +0,0 @@
-import { prefix, get, put, post, del, type VovkRequest } from 'vovk';
-
-@prefix('my-thing')
-export default class MyThingController {
-  @get()
-  static getMyThingsExample = (req: VovkRequest<null, { q: string }>) => {
-    const q = req.nextUrl.searchParams.get('q');
-    return { q };
-  };
-
-  @put(':id')
-  static updateMyThingExample = 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');
-
-    return { id, q, body };
-  };
-
-  @post()
-  static createMyThingExample = () => {
-    // ...
-  };
-
-  @del(':id')
-  static deleteMyThingExample = () => {
-    // ...
-  };
-}

package/templates_old/zod/MyThingController.c.template.ts

@@ -1,39 +0,0 @@
-import { prefix, get, put, post, del } from 'vovk';
-import { z } from 'zod';
-import { withZod } from 'vovk-zod';
-import MyThingService from './MyThingService.s.template';
-
-@prefix('my-thing')
-export default class MyThingController {
-  @get()
-  static getMyThingsExample = withZod(null, z.object({ q: z.string() }), (req) => {
-    const q = req.nextUrl.searchParams.get('q');
-
-    return MyThingService.getMyThingsExample(q);
-  });
-
-  @put(':id')
-  static updateMyThingExample = withZod(
-    z.object({
-      foo: z.union([z.literal('bar'), z.literal('baz')]),
-    }),
-    z.object({ q: z.string() }),
-    async (req, params: { id: string }) => {
-      const { id } = params;
-      const body = await req.json();
-      const q = req.nextUrl.searchParams.get('q');
-
-      return MyThingService.updateMyThingExample(id, q, body);
-    }
-  );
-
-  @post()
-  static async createMyThingExample() {
-    // ...
-  }
-
-  @del(':id')
-  static deleteMyThingExample() {
-    // ...
-  }
-}

package/templates_old/zod/MyThingService.s.template.ts

@@ -1,18 +0,0 @@
-import type { VovkControllerBody, VovkControllerQuery } from 'vovk';
-import type MyThingController from './MyThingController.c.template';
-
-export default class MyThingService {
-  static getMyThingsExample = (q: VovkControllerQuery<typeof MyThingController.getMyThingsExample>['q']) => {
-    return { q };
-  };
-
-  static updateMyThingExample = (
-    id: string,
-    q: VovkControllerQuery<typeof MyThingController.updateMyThingExample>['q'],
-    body: VovkControllerBody<typeof MyThingController.updateMyThingExample>
-  ) => {
-    return { id, q, body };
-  };
-
-  // ...
-}