vovk-cli 0.0.1-draft.13 → 0.0.1-draft.131

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023-present Andrii Gubanov
+Copyright (c) 2023-present Andrey Gubanov
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1 +1,29 @@
-Description is coming soon.
+<p align="center"> 
+  <picture>
+    <source width="300" media="(prefers-color-scheme: dark)" srcset="https://vovk.dev/vovk-logo-white.svg">
+    <source width="300" media="(prefers-color-scheme: light)" srcset="https://vovk.dev/vovk-logo.svg">
+    <img width="300" alt="vovk" src="https://vovk.dev/vovk-logo.svg">
+  </picture><br>
+  <strong>RESTful + RPC = ♥️</strong>
+</p>
+
+<p align="center">
+  Back-end meta-framework for <a href="https://nextjs.org/docs/app">Next.js</a>
+</p>
+
+---
+
+## vovk-cli [![npm version](https://badge.fury.io/js/vovk-cli.svg)](https://www.npmjs.com/package/vovk-cli)
+
+The Vovk.ts CLI that generates schema and client but also provides some useful utilities for the development process.
+
+```sh
+npm install -D vovk-cli
+```
+
+- [vovk dev](https://vovk.dev/cli/vovk-dev) - starts the development script that watches the changes in controllers and regenerates the schema and client.
+- [vovk generate](https://vovk.dev/cli/vovk-generate) - generates the client based on the schema.
+- [vovk init](https://vovk.dev/cli/vovk-init) - initializes the Vovk.ts project.
+- [vovk new](https://vovk.dev/cli/vovk-new) - generates a new controller, service or a custom module.
+
+For more information, please visit the [CLI documentation](https://vovk.dev/cli) or use `npx vovk-cli --help` to get the list of available commands and options.

package/client-templates/fullSchema/fullSchema.cjs.ejs

@@ -0,0 +1,13 @@
+<%- `// auto-generated ${new Date().toISOString()}\n/* eslint-disable */` %>
+const config = require('./<%= t.schemaOutDir %>/config.json');
+const segments = {
+  <% Object.values(t.fullSchema.segments).forEach((segment) => { %>
+    '<%= segment.segmentName %>': require('./<%= t.schemaOutDir %>/<%= t.SEGMENTS_SCHEMA_DIR_NAME %>/<%= segment.segmentName || t.ROOT_SEGMENT_SCHEMA_NAME %>.json'),
+  <% }) %>
+};
+const fullSchema = {
+  config,
+  segments,
+};
+
+module.exports.fullSchema = fullSchema;

package/client-templates/fullSchema/fullSchema.d.cts.ejs

@@ -0,0 +1,11 @@
+<%- `// auto-generated ${new Date().toISOString()}\n/* eslint-disable */` %>
+import { VovkStrictConfig, VovkSegmentSchema } from 'vovk';
+
+export const fullSchema: {
+    config: Partial<VovkStrictConfig>;
+    segments: {
+      <% Object.values(t.fullSchema.segments).forEach((segment) => { %>
+      '<%= segment.segmentName %>': VovkSegmentSchema;
+      <% }) %>
+    };
+};

package/client-templates/main/main.cjs.ejs

@@ -0,0 +1,15 @@
+<%- `// auto-generated ${new Date().toISOString()}\n/* eslint-disable */` %>
+const { fetcher } = require('<%= t.imports.fetcher %>');
+const { createRPC } = require('<%= t.imports.createRPC %>');
+const { fullSchema } = require('./fullSchema.cjs');
+const { validateOnClient = null } = <%- t.imports.validateOnClient ? `require('${t.imports.validateOnClient}')` : '{}'%>;
+const apiRoot = '<%= t.apiRoot %>';
+<% Object.values(t.fullSchema.segments).forEach((segment) => { 
+  Object.keys(segment.controllers).forEach((controllerName) => { %>
+exports.<%= controllerName %> = createRPC(
+  fullSchema, '<%= segment.segmentName %>', '<%= controllerName %>',
+  { fetcher, validateOnClient, defaultOptions: { apiRoot } }
+);
+  <% })
+}) %>
+exports.fullSchema = fullSchema;

package/client-templates/main/main.d.cts.ejs

@@ -0,0 +1,15 @@
+
+<%- `// auto-generated ${new Date().toISOString()}\n/* eslint-disable */` %>
+import type { VovkClientFetcher } from 'vovk';
+import type { fetcher } from '<%= t.imports.fetcher %>';
+import type { createRPC } from '<%= t.imports.createRPC %>';
+<% Object.values(t.fullSchema.segments).forEach((segment, i) => { if(Object.keys(segment.controllers).length) { %>
+import type { Controllers as Controllers<%= i %> } from "<%= t.segmentMeta[segment.segmentName].segmentImportPath %>";
+<% }}) %>
+type Options = typeof fetcher extends VovkClientFetcher<infer U> ? U : never;
+<% Object.values(t.fullSchema.segments).forEach((segment, i) => {
+  Object.keys(segment.controllers).forEach((controllerName) => { %>
+export const <%= controllerName %>: ReturnType<typeof createRPC<Controllers<%= i %>["<%= controllerName %>"], Options>>;
+  <% }) 
+}) %>
+export { fullSchema } from './fullSchema.cjs';

package/client-templates/module/module.d.mts.ejs

@@ -0,0 +1,15 @@
+
+<%- `// auto-generated ${new Date().toISOString()}\n/* eslint-disable */` %>
+import type { VovkClientFetcher } from 'vovk';
+import type { fetcher } from '<%= t.imports.module.fetcher %>';
+import type { createRPC } from '<%= t.imports.module.createRPC %>';
+<% Object.values(t.fullSchema.segments).forEach((segment, i) => { if(Object.keys(segment.controllers).length) { %>
+import type { Controllers as Controllers<%= i %> } from "<%= t.segmentMeta[segment.segmentName].segmentImportPath %>";
+<% }}) %>
+type Options = typeof fetcher extends VovkClientFetcher<infer U> ? U : never;
+<% Object.values(t.fullSchema.segments).forEach((segment, i) => { 
+  Object.keys(segment.controllers).forEach((controllerName) => { %>
+export const <%= controllerName %>: ReturnType<typeof createRPC<Controllers<%= i %>["<%= controllerName %>"], Options>>;
+  <% }) 
+}) %>
+export { fullSchema } from './fullSchema.cjs';

package/client-templates/module/module.mjs.ejs

@@ -0,0 +1,21 @@
+<%- `// auto-generated ${new Date().toISOString()}\n/* eslint-disable */` %>
+import { fetcher } from '<%= t.imports.module.fetcher %>';
+import { createRPC } from '<%= t.imports.module.createRPC %>';
+import { fullSchema } from './fullSchema.cjs';
+<% if (t.imports.module.validateOnClient) { %>
+import { validateOnClient } from '<%= t.imports.module.validateOnClient %>';
+<% } else { %>
+const validateOnClient = undefined;
+<% } %>
+const apiRoot = '<%= t.apiRoot %>';
+<% Object.values(t.fullSchema.segments).forEach((segment, i) => {
+  Object.keys(segment.controllers).forEach((controllerName) => { %>
+export const <%= controllerName %> = createRPC(
+  fullSchema, '<%= segment.segmentName %>', '<%= controllerName %>',
+  { fetcher, validateOnClient, defaultOptions: { apiRoot } }
+);
+<% 
+  }); 
+});
+%>
+export { fullSchema };

package/client-templates/ts/index.ts.ejs

@@ -0,0 +1,24 @@
+<%- `// auto-generated ${new Date().toISOString()}\n/* eslint-disable */` %>
+import type { VovkClientFetcher } from 'vovk';
+import { fetcher } from '<%= t.imports.fetcher %>';
+import { createRPC } from '<%= t.imports.createRPC %>';
+import { fullSchema } from './fullSchema.cjs';
+<% Object.values(t.fullSchema.segments).forEach((segment, i) => { if(Object.keys(segment.controllers).length) { %>
+import type { Controllers as Controllers<%= i %> } from "<%= t.segmentMeta[segment.segmentName].segmentImportPath %>";
+<% }}) %>
+<% if (t.imports.validateOnClient) { %>
+import { validateOnClient } from '<%= t.imports.validateOnClient %>';
+<% } else { %>
+const validateOnClient = undefined;
+<% } %>
+type Options = typeof fetcher extends VovkClientFetcher<infer U> ? U : never;
+const apiRoot = '<%= t.apiRoot %>';
+<% Object.values(t.fullSchema.segments).forEach((segment, i) => { %>
+  <% Object.keys(segment.controllers).forEach((controllerName) => { %>
+export const <%= controllerName %> = createRPC<Controllers<%= i %>["<%= controllerName %>"], Options>(
+  fullSchema, '<%= segment.segmentName %>', '<%= controllerName %>',
+  { fetcher, validateOnClient, defaultOptions: { apiRoot } }
+);
+  <% }) %>
+<% }) %>
+export { fullSchema };

package/dist/dev/diffSegmentSchema.d.mts

@@ -0,0 +1,36 @@
+import type { VovkControllerSchema, VovkSegmentSchema } from 'vovk';
+interface HandlersDiff {
+    nameOfClass: string;
+    added: string[];
+    removed: string[];
+    changed: string[];
+}
+interface ControllersDiff {
+    added: string[];
+    removed: string[];
+    handlers: HandlersDiff[];
+}
+export interface DiffResult {
+    controllers: ControllersDiff;
+}
+export declare function diffHandlers<T extends VovkControllerSchema['handlers']>(oldHandlers: T, newHandlers: T, nameOfClass: string): HandlersDiff;
+export declare function diffControllers<T extends VovkSegmentSchema['controllers']>(oldItems: T, newItems: T): ControllersDiff;
+/**
+example output:
+{
+  controllers: {
+    added: ["ControllerC"],
+    removed: ["ControllerB"],
+    handlers: [
+      {
+        nameOfClass: "ControllerA",
+        added: ["handlerF"],
+        removed: [],
+        changed: ["handlerD"]
+      }
+    ]
+  }
+}
+*/
+export default function diffSegmentSchema(oldJson: VovkSegmentSchema, newJson: VovkSegmentSchema): DiffResult;
+export {};

package/dist/{watcher/diffSchema.mjs → dev/diffSegmentSchema.mjs}

@@ -18,7 +18,7 @@ export function diffHandlers(oldHandlers, newHandlers, nameOfClass) {
     }
     return { nameOfClass, added, removed, changed };
 }
-export function diffWorkersOrControllers(oldItems, newItems) {
+export function diffControllers(oldItems, newItems) {
     const added = [];
     const removed = [];
     const handlersDiff = [];
@@ -27,7 +27,7 @@ export function diffWorkersOrControllers(oldItems, newItems) {
             added.push(item);
         }
         else {
-            const handlers = diffHandlers(oldItems[item]._handlers, newItem._handlers, item);
+            const handlers = diffHandlers(oldItems[item].handlers, newItem.handlers, item);
             if (handlers.added.length || handlers.removed.length || handlers.changed.length) {
                 handlersDiff.push(handlers);
             }
@@ -43,11 +43,6 @@ export function diffWorkersOrControllers(oldItems, newItems) {
 /**
 example output:
 {
-  workers: {
-    added: ["WorkerC"],
-    removed: ["WorkerA"],
-    handlers: []
-  },
   controllers: {
     added: ["ControllerC"],
     removed: ["ControllerB"],
@@ -62,11 +57,8 @@ example output:
   }
 }
 */
-export default function diffSchema(oldJson, newJson) {
-    const workersDiff = diffWorkersOrControllers(oldJson.workers ?? {}, newJson.workers ?? {});
-    const controllersDiff = diffWorkersOrControllers(oldJson.controllers ?? {}, newJson.controllers ?? {});
+export default function diffSegmentSchema(oldJson, newJson) {
     return {
-        workers: workersDiff,
-        controllers: controllersDiff,
+        controllers: diffControllers(oldJson.controllers ?? {}, newJson.controllers ?? {}),
     };
 }

package/dist/{watcher → dev}/ensureSchemaFiles.d.mts

@@ -1,3 +1,6 @@
 import { ProjectInfo } from '../getProjectInfo/index.mjs';
+/**
+ * Ensure that the schema files are created to avoid any import errors.
+ */
 export default function ensureSchemaFiles(projectInfo: ProjectInfo | null, schemaOutAbsolutePath: string, segmentNames: string[]): Promise<void>;
 export declare const debouncedEnsureSchemaFiles: import("lodash").DebouncedFunc<typeof ensureSchemaFiles>;

package/dist/{watcher → dev}/ensureSchemaFiles.mjs

@@ -1,44 +1,26 @@
 import fs from 'node:fs/promises';
 import path from 'node:path';
 import debounce from 'lodash/debounce.js';
-import writeOneSchemaFile, { ROOT_SEGMENT_SCHEMA_NAME } from './writeOneSchemaFile.mjs';
+import writeOneSchemaFile, { SEGMENTS_SCHEMA_DIR_NAME, ROOT_SEGMENT_SCHEMA_NAME, } from './writeOneSegmentSchemaFile.mjs';
 import formatLoggedSegmentName from '../utils/formatLoggedSegmentName.mjs';
+import writeConfigJson from './writeConfigJson.mjs';
+/**
+ * Ensure that the schema files are created to avoid any import errors.
+ */
 export default async function ensureSchemaFiles(projectInfo, schemaOutAbsolutePath, segmentNames) {
     const now = Date.now();
     let hasChanged = false;
-    // Create index.js file
-    const indexContent = `// auto-generated
-${segmentNames
-        .map((segmentName) => {
-        return `module.exports['${segmentName}'] = require('./${segmentName || ROOT_SEGMENT_SCHEMA_NAME}.json');`;
-    })
-        .join('\n')}`;
-    const dTsContent = `// auto-generated
-import type { VovkSchema } from 'vovk';
-declare const segmentSchema: {
-${segmentNames.map((segmentName) => `  '${segmentName}': VovkSchema;`).join('\n')}
-};
-export default segmentSchema;`;
-    const jsAbsolutePath = path.join(schemaOutAbsolutePath, 'index.js');
-    const dTsAbsolutePath = path.join(schemaOutAbsolutePath, 'index.d.ts');
-    const existingJs = await fs.readFile(jsAbsolutePath, 'utf-8').catch(() => null);
-    const existingDTs = await fs.readFile(dTsAbsolutePath, 'utf-8').catch(() => null);
-    await fs.mkdir(schemaOutAbsolutePath, { recursive: true });
-    if (existingJs !== indexContent) {
-        await fs.writeFile(jsAbsolutePath, indexContent);
-    }
-    if (existingDTs !== dTsContent) {
-        await fs.writeFile(dTsAbsolutePath, dTsContent);
-    }
+    const schemaJsonOutAbsolutePath = path.join(schemaOutAbsolutePath, SEGMENTS_SCHEMA_DIR_NAME);
+    await fs.mkdir(schemaJsonOutAbsolutePath, { recursive: true });
+    await writeConfigJson(schemaOutAbsolutePath, projectInfo);
     // Create JSON files (if not exist) with name [segmentName].json (where segmentName can include /, which means the folder structure can be nested)
     await Promise.all(segmentNames.map(async (segmentName) => {
         const { isCreated } = await writeOneSchemaFile({
             schemaOutAbsolutePath,
-            schema: {
+            segmentSchema: {
                 emitSchema: false,
                 segmentName,
                 controllers: {},
-                workers: {},
             },
             skipIfExists: true,
         });
@@ -64,7 +46,7 @@ export default segmentSchema;`;
                 }
             }
             else if (entry.isFile() && entry.name.endsWith('.json')) {
-                const relativePath = path.relative(schemaOutAbsolutePath, absolutePath);
+                const relativePath = path.relative(schemaJsonOutAbsolutePath, absolutePath);
                 const segmentName = relativePath.replace(/\\/g, '/').slice(0, -5); // Remove '.json' extension
                 if (!segmentNames.includes(segmentName) &&
                     !segmentNames.includes(segmentName.replace(ROOT_SEGMENT_SCHEMA_NAME, ''))) {
@@ -76,8 +58,8 @@ export default segmentSchema;`;
         }));
     }
     // Start the recursive deletion from the root directory
-    await deleteUnnecessaryJsonFiles(schemaOutAbsolutePath);
+    await deleteUnnecessaryJsonFiles(schemaJsonOutAbsolutePath);
     if (hasChanged)
-        projectInfo?.log.info(`Schema files updated in ${Date.now() - now}ms`);
+        projectInfo?.log.info(`Created empty schema files in ${Date.now() - now}ms`);
 }
 export const debouncedEnsureSchemaFiles = debounce(ensureSchemaFiles, 1000);

package/dist/dev/index.d.mts

@@ -0,0 +1,6 @@
+export declare class VovkDev {
+    #private;
+    start({ exit }: {
+        exit: boolean;
+    }): Promise<void>;
+}