vovk-cli 0.0.1-draft.21 → 0.0.1-draft.211

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (125) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +29 -1
  3. package/client-templates/cjs/index.cjs.ejs +14 -0
  4. package/client-templates/cjs/index.d.cts.ejs +23 -0
  5. package/client-templates/mjs/index.d.mts.ejs +23 -0
  6. package/client-templates/mjs/index.mjs.ejs +20 -0
  7. package/client-templates/packageJson/package.json.ejs +1 -0
  8. package/client-templates/readme/README.md.ejs +35 -0
  9. package/client-templates/schemaCjs/schema.cjs.ejs +20 -0
  10. package/client-templates/schemaCjs/schema.d.cts.ejs +10 -0
  11. package/client-templates/schemaJson/schema.json.ejs +1 -0
  12. package/client-templates/schemaTs/schema.ts.ejs +22 -0
  13. package/client-templates/standaloneTypesTs/types.d.ts.ejs +13 -0
  14. package/client-templates/ts/index.ts.ejs +31 -0
  15. package/dist/bundle/index.d.mts +8 -0
  16. package/dist/bundle/index.mjs +83 -0
  17. package/dist/dev/diffSegmentSchema.d.mts +36 -0
  18. package/dist/dev/{diffSchema.mjs → diffSegmentSchema.mjs} +4 -12
  19. package/dist/dev/ensureSchemaFiles.d.mts +3 -0
  20. package/dist/dev/ensureSchemaFiles.mjs +14 -31
  21. package/dist/dev/index.d.mts +5 -2
  22. package/dist/dev/index.mjs +173 -78
  23. package/dist/dev/logDiffResult.d.mts +1 -1
  24. package/dist/dev/logDiffResult.mjs +6 -43
  25. package/dist/dev/writeMetaJson.d.mts +2 -0
  26. package/dist/dev/writeMetaJson.mjs +17 -0
  27. package/dist/dev/writeOneSegmentSchemaFile.d.mts +12 -0
  28. package/dist/dev/{writeOneSchemaFile.mjs → writeOneSegmentSchemaFile.mjs} +10 -6
  29. package/dist/generate/ensureClient.d.mts +3 -0
  30. package/dist/generate/ensureClient.mjs +31 -0
  31. package/dist/generate/generate.d.mts +12 -0
  32. package/dist/generate/generate.mjs +219 -0
  33. package/dist/generate/getClientTemplateFiles.d.mts +21 -0
  34. package/dist/generate/getClientTemplateFiles.mjs +88 -0
  35. package/dist/generate/getProjectFullSchema.d.mts +3 -0
  36. package/dist/generate/getProjectFullSchema.mjs +64 -0
  37. package/dist/generate/getTemplateClientImports.d.mts +18 -0
  38. package/dist/generate/getTemplateClientImports.mjs +38 -0
  39. package/dist/generate/index.d.mts +40 -0
  40. package/dist/generate/index.mjs +216 -0
  41. package/dist/generate/mergePackages.d.mts +9 -0
  42. package/dist/generate/mergePackages.mjs +78 -0
  43. package/dist/generate/writeOneClientFile.d.mts +32 -0
  44. package/dist/generate/writeOneClientFile.mjs +98 -0
  45. package/dist/getProjectInfo/getConfig/getConfigAbsolutePaths.d.mts +5 -0
  46. package/dist/getProjectInfo/{getConfigAbsolutePaths.mjs → getConfig/getConfigAbsolutePaths.mjs} +4 -1
  47. package/dist/getProjectInfo/{getRelativeSrcRoot.d.mts → getConfig/getRelativeSrcRoot.d.mts} +1 -1
  48. package/dist/getProjectInfo/{getRelativeSrcRoot.mjs → getConfig/getRelativeSrcRoot.mjs} +2 -2
  49. package/dist/getProjectInfo/getConfig/getTemplateDefs.d.mts +15 -0
  50. package/dist/getProjectInfo/getConfig/getTemplateDefs.mjs +94 -0
  51. package/dist/getProjectInfo/{getUserConfig.d.mts → getConfig/getUserConfig.d.mts} +3 -2
  52. package/dist/getProjectInfo/{getUserConfig.mjs → getConfig/getUserConfig.mjs} +6 -4
  53. package/dist/getProjectInfo/{importUncachedModule.mjs → getConfig/importUncachedModule.mjs} +1 -5
  54. package/dist/getProjectInfo/{importUncachedModuleWorker.mjs → getConfig/importUncachedModuleWorker.mjs} +0 -1
  55. package/dist/getProjectInfo/getConfig/index.d.mts +17 -0
  56. package/dist/getProjectInfo/getConfig/index.mjs +83 -0
  57. package/dist/getProjectInfo/index.d.mts +7 -9
  58. package/dist/getProjectInfo/index.mjs +13 -22
  59. package/dist/index.d.mts +2 -2
  60. package/dist/index.mjs +90 -38
  61. package/dist/init/createConfig.d.mts +2 -2
  62. package/dist/init/createConfig.mjs +18 -12
  63. package/dist/init/getTemplateFilesFromPackage.mjs +7 -5
  64. package/dist/init/index.d.mts +2 -2
  65. package/dist/init/index.mjs +89 -53
  66. package/dist/init/installDependencies.mjs +4 -2
  67. package/dist/init/logUpdateDependenciesError.d.mts +3 -1
  68. package/dist/init/logUpdateDependenciesError.mjs +7 -1
  69. package/dist/init/updateDependenciesWithoutInstalling.mjs +41 -13
  70. package/dist/init/updateNPMScripts.d.mts +3 -1
  71. package/dist/init/updateNPMScripts.mjs +10 -7
  72. package/dist/init/updateTypeScriptConfig.d.mts +4 -1
  73. package/dist/init/updateTypeScriptConfig.mjs +11 -7
  74. package/dist/initProgram.d.mts +1 -1
  75. package/dist/initProgram.mjs +17 -16
  76. package/dist/locateSegments.d.mts +8 -1
  77. package/dist/locateSegments.mjs +14 -4
  78. package/dist/new/addClassToSegmentCode.d.mts +1 -2
  79. package/dist/new/addClassToSegmentCode.mjs +3 -3
  80. package/dist/new/addCommonTerms.mjs +1 -0
  81. package/dist/new/index.d.mts +1 -1
  82. package/dist/new/index.mjs +3 -2
  83. package/dist/new/newModule.d.mts +2 -1
  84. package/dist/new/newModule.mjs +18 -16
  85. package/dist/new/newSegment.d.mts +2 -1
  86. package/dist/new/newSegment.mjs +21 -10
  87. package/dist/new/render.d.mts +7 -3
  88. package/dist/new/render.mjs +29 -8
  89. package/dist/types.d.mts +42 -41
  90. package/dist/utils/convertJSONSchemaToTypeScriptDef.d.mts +2 -0
  91. package/dist/utils/convertJSONSchemaToTypeScriptDef.mjs +153 -0
  92. package/dist/utils/debounceWithArgs.d.mts +2 -2
  93. package/dist/utils/debounceWithArgs.mjs +24 -9
  94. package/dist/utils/formatLoggedSegmentName.d.mts +2 -1
  95. package/dist/utils/formatLoggedSegmentName.mjs +2 -2
  96. package/dist/utils/getAvailablePort.mjs +1 -1
  97. package/dist/utils/getPublicModuleNameFromPath.d.mts +4 -0
  98. package/dist/utils/getPublicModuleNameFromPath.mjs +9 -0
  99. package/dist/utils/pickSegmentFullSchema.d.mts +3 -0
  100. package/dist/utils/pickSegmentFullSchema.mjs +15 -0
  101. package/dist/utils/removeUnlistedDirectories.d.mts +10 -0
  102. package/dist/utils/removeUnlistedDirectories.mjs +61 -0
  103. package/dist/utils/resolveAbsoluteModulePath.d.mts +2 -0
  104. package/dist/utils/resolveAbsoluteModulePath.mjs +32 -0
  105. package/module-templates/Controller.ts.ejs +50 -0
  106. package/module-templates/Service.ts.ejs +28 -0
  107. package/package.json +38 -21
  108. package/dist/dev/diffSchema.d.mts +0 -43
  109. package/dist/dev/ensureClient.d.mts +0 -5
  110. package/dist/dev/ensureClient.mjs +0 -31
  111. package/dist/dev/isMetadataEmpty.d.mts +0 -2
  112. package/dist/dev/isMetadataEmpty.mjs +0 -4
  113. package/dist/dev/writeOneSchemaFile.d.mts +0 -11
  114. package/dist/generateClient.d.mts +0 -7
  115. package/dist/generateClient.mjs +0 -97
  116. package/dist/getProjectInfo/getConfig.d.mts +0 -11
  117. package/dist/getProjectInfo/getConfig.mjs +0 -29
  118. package/dist/getProjectInfo/getConfigAbsolutePaths.d.mts +0 -4
  119. package/dist/postinstall.d.mts +0 -1
  120. package/dist/postinstall.mjs +0 -24
  121. package/templates/controller.ejs +0 -51
  122. package/templates/service.ejs +0 -27
  123. package/templates/worker.ejs +0 -24
  124. /package/dist/getProjectInfo/{importUncachedModule.d.mts → getConfig/importUncachedModule.d.mts} +0 -0
  125. /package/dist/getProjectInfo/{importUncachedModuleWorker.d.mts → getConfig/importUncachedModuleWorker.d.mts} +0 -0
package/LICENSE CHANGED
@@ -1,6 +1,6 @@
1
1
  MIT License
2
2
 
3
- Copyright (c) 2023-present Andrii Gubanov
3
+ Copyright (c) 2023-present Andrey Gubanov
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  of this software and associated documentation files (the "Software"), to deal
package/README.md CHANGED
@@ -1 +1,29 @@
1
- Description is coming soon.
1
+ <p align="center">
2
+ <picture>
3
+ <source width="300" media="(prefers-color-scheme: dark)" srcset="https://vovk.dev/vovk-logo-white.svg">
4
+ <source width="300" media="(prefers-color-scheme: light)" srcset="https://vovk.dev/vovk-logo.svg">
5
+ <img width="300" alt="vovk" src="https://vovk.dev/vovk-logo.svg">
6
+ </picture><br>
7
+ <strong>RESTful + RPC = ♥️</strong>
8
+ </p>
9
+
10
+ <p align="center">
11
+ Back-end meta-framework for <a href="https://nextjs.org/docs/app">Next.js</a>
12
+ </p>
13
+
14
+ ---
15
+
16
+ ## vovk-cli [![npm version](https://badge.fury.io/js/vovk-cli.svg)](https://www.npmjs.com/package/vovk-cli)
17
+
18
+ The Vovk.ts CLI that generates schema and client but also provides some useful utilities for the development process.
19
+
20
+ ```sh
21
+ npm install -D vovk-cli
22
+ ```
23
+
24
+ - [vovk dev](https://vovk.dev/cli/vovk-dev) - starts the development script that watches the changes in controllers and regenerates the schema and client.
25
+ - [vovk generate](https://vovk.dev/cli/vovk-generate) - generates the client based on the schema.
26
+ - [vovk init](https://vovk.dev/cli/vovk-init) - initializes the Vovk.ts project.
27
+ - [vovk new](https://vovk.dev/cli/vovk-new) - generates a new controller, service or a custom module.
28
+
29
+ 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.
@@ -0,0 +1,14 @@
1
+ <%- `// auto-generated by Vovk.ts ${new Date().toISOString()}` %>
2
+ const { fetcher } = require('<%= t.imports.fetcher %>');
3
+ const { createRPC } = require('<%= t.imports.createRPC %>');
4
+ const { schema } = require('./schema.cjs');
5
+ const { validateOnClient = null } = <%- t.imports.validateOnClient ? `require('${t.imports.validateOnClient}')` : '{}'%>;
6
+ <% Object.values(t.schema.segments).filter((segment) => segment.emitSchema).forEach((segment) => {
7
+ Object.keys(segment.controllers).forEach((rpcModuleName) => { %>
8
+ exports.<%= rpcModuleName %> = createRPC(
9
+ schema, '<%= segment.segmentName %>', '<%= rpcModuleName %>',
10
+ { fetcher, validateOnClient, <%- typeof t.segmentMeta[segment.segmentName].segmentNameOverride === 'string' ? `segmentNameOverride: '${t.segmentMeta[segment.segmentName].segmentNameOverride}', ` : '' %>defaultOptions: { apiRoot: '<%= segment.segmentApiRoot ?? t.apiRoot %>' } }
11
+ );
12
+ <% })
13
+ }) %>
14
+ exports.schema = schema;
@@ -0,0 +1,23 @@
1
+
2
+ <%- `// auto-generated by Vovk.ts ${new Date().toISOString()}` %>
3
+ import type { VovkClientFetcher } from 'vovk';
4
+ import type { fetcher } from '<%= t.imports.module.fetcher %>';
5
+ import type { createRPC } from '<%= t.imports.module.createRPC %>';
6
+ <% if(t.isTsStandalone) { %>
7
+ import type {
8
+ <% Object.values(t.schema.segments).filter((segment) => segment.emitSchema).forEach((segment, i) => { %>
9
+ Segment<%= i %> as Controllers<%= i %>
10
+ <% }) %>
11
+ } from './types.d<%= t.nodeNextResolutionExt.ts %>';
12
+ <% } else { %>
13
+ <% Object.values(t.schema.segments).filter((segment) => segment.emitSchema).forEach((segment, i) => { %>
14
+ import type { Controllers as Controllers<%= i %> } from "<%= t.segmentMeta[segment.segmentName].segmentImportPath %>";
15
+ <% }) %>
16
+ <% } %>
17
+ type Options = typeof fetcher extends VovkClientFetcher<infer U> ? U : never;
18
+ <% Object.values(t.schema.segments).filter((segment) => segment.emitSchema).forEach((segment, i) => {
19
+ Object.keys(segment.controllers).forEach((rpcModuleName) => { %>
20
+ export const <%= rpcModuleName %>: ReturnType<typeof createRPC<Controllers<%= i %>["<%= rpcModuleName %>"], Options>>;
21
+ <% })
22
+ }) %>
23
+ export { schema } from './schema.cjs';
@@ -0,0 +1,23 @@
1
+
2
+ <%- `// auto-generated by Vovk.ts ${new Date().toISOString()}` %>
3
+ import type { VovkClientFetcher } from 'vovk';
4
+ import type { fetcher } from '<%= t.imports.module.fetcher %>';
5
+ import type { createRPC } from '<%= t.imports.module.createRPC %>';
6
+ <% if(t.isTsStandalone) { %>
7
+ import type {
8
+ <% Object.values(t.schema.segments).filter((segment) => segment.emitSchema).forEach((segment, i) => { %>
9
+ Segment<%= i %> as Controllers<%= i %>
10
+ <% }) %>
11
+ } from './types.d<%= t.nodeNextResolutionExt.ts %>';
12
+ <% } else { %>
13
+ <% Object.values(t.schema.segments).filter((segment) => segment.emitSchema).forEach((segment, i) => { %>
14
+ import type { Controllers as Controllers<%= i %> } from "<%= t.segmentMeta[segment.segmentName].segmentImportPath %>";
15
+ <% }) %>
16
+ <% } %>
17
+ type Options = typeof fetcher extends VovkClientFetcher<infer U> ? U : never;
18
+ <% Object.values(t.schema.segments).filter((segment) => segment.emitSchema).forEach((segment, i) => {
19
+ Object.keys(segment.controllers).forEach((rpcModuleName) => { %>
20
+ export const <%= rpcModuleName %>: ReturnType<typeof createRPC<Controllers<%= i %>["<%= rpcModuleName %>"], Options>>;
21
+ <% })
22
+ }) %>
23
+ export { schema } from './schema.cjs';
@@ -0,0 +1,20 @@
1
+ <%- `// auto-generated by Vovk.ts ${new Date().toISOString()}` %>
2
+ import { fetcher } from '<%= t.imports.module.fetcher %>';
3
+ import { createRPC } from '<%= t.imports.module.createRPC %>';
4
+ import { schema } from './schema.cjs';
5
+ <% if (t.imports.module.validateOnClient) { %>
6
+ import { validateOnClient } from '<%= t.imports.module.validateOnClient %>';
7
+ <% } else { %>
8
+ const validateOnClient = undefined;
9
+ <% } %>
10
+ <% Object.values(t.schema.segments).filter((segment) => segment.emitSchema).forEach((segment, i) => {
11
+ Object.keys(segment.controllers).forEach((rpcModuleName) => { %>
12
+ export const <%= rpcModuleName %> = createRPC(
13
+ schema, '<%= segment.segmentName %>', '<%= rpcModuleName %>',
14
+ { fetcher, validateOnClient, <%- typeof t.segmentMeta[segment.segmentName].segmentNameOverride === 'string' ? `segmentNameOverride: '${t.segmentMeta[segment.segmentName].segmentNameOverride}', ` : '' %>defaultOptions: { apiRoot: '<%= segment.segmentApiRoot ?? t.apiRoot %>' } }
15
+ );
16
+ <%
17
+ });
18
+ });
19
+ %>
20
+ export { schema };
@@ -0,0 +1 @@
1
+ <%- JSON.stringify(t.package, null, 2) %>
@@ -0,0 +1,35 @@
1
+ # <%= t.package.name %> v<%= t.package.version %> ![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white)
2
+
3
+
4
+ <%- t.package.description ? `> ${t.package.description}` : '' %>
5
+
6
+ <%- t.package.license ? `License: **${t.package.license}**` : '' %>
7
+
8
+ ```bash
9
+ # Install the package
10
+ npm install <%= t.package.name %>
11
+ ```
12
+
13
+ <% Object.entries(t.schema.segments).forEach(([segmentName, segment]) => {
14
+ Object.values(segment.controllers).forEach((controllerSchema) => { %>
15
+
16
+ ## <%= controllerSchema.rpcModuleName %>
17
+ <% Object.entries(controllerSchema.handlers).forEach(([handlerName, handlerSchema]) => { %>
18
+ ### <%= controllerSchema.rpcModuleName %>.<%= handlerName %>
19
+ <%- handlerSchema.openapi?.summary ? `> ${handlerSchema.openapi.summary}` : '' %>
20
+
21
+ <%- handlerSchema.openapi?.description ? `${handlerSchema.openapi.description}` : '' %>
22
+
23
+ `<%= handlerSchema.httpMethod %> <%= [t.apiRoot, segmentName, controllerSchema.prefix, handlerSchema.path].filter(Boolean).join('/') %>`
24
+
25
+ ```ts
26
+ <%- t.createCodeExamples({
27
+ handlerSchema,
28
+ handlerName,
29
+ controllerSchema,
30
+ package: t.package,
31
+ }).ts %>
32
+ ```
33
+ <% }) %>
34
+ <% }) %>
35
+ <% }) %>
@@ -0,0 +1,20 @@
1
+ <%- `// auto-generated by Vovk.ts ${new Date().toISOString()}` %>
2
+ <% if(t.isTsStandalone) { %>
3
+ const schema = require('./schema.json');
4
+ module.exports.schema = schema;
5
+ <% } else { %>
6
+ const meta = require('./<%= t.schemaOutDir %>/_meta.json');
7
+ const segments = {<% Object.values(t.schema.segments).filter((segment) => segment.emitSchema).forEach((segment) => { %>
8
+ '<%= segment.segmentName %>': require('./<%= t.schemaOutDir %>/<%= segment.segmentName || t.ROOT_SEGMENT_FILE_NAME %>.json'),<% }) %>
9
+ };
10
+ const schema = {
11
+ $schema: '<%- t.VovkSchemaIdEnum.SCHEMA %>',
12
+ segments,
13
+ meta: {
14
+ apiRoot: '<%= t.apiRoot %>', // for debugging purposes
15
+ ...meta
16
+ }
17
+ };
18
+
19
+ module.exports.schema = schema;
20
+ <% } %>
@@ -0,0 +1,10 @@
1
+ <%- `// auto-generated by Vovk.ts ${new Date().toISOString()}` %>
2
+ import type { VovkMetaSchema, VovkSegmentSchema, VovkSchemaIdEnum } from 'vovk';
3
+
4
+ export const schema: {
5
+ $schema: '<%- t.VovkSchemaIdEnum.SCHEMA %>';
6
+ meta: VovkMetaSchema;
7
+ segments: {<% Object.values(t.schema.segments).filter((segment) => segment.emitSchema).forEach((segment) => { %>
8
+ '<%= segment.segmentName %>': VovkSegmentSchema;<% }) %>
9
+ };
10
+ };
@@ -0,0 +1 @@
1
+ <%- JSON.stringify(t.schema, null, 2) %>
@@ -0,0 +1,22 @@
1
+ <%- `// auto-generated by Vovk.ts ${new Date().toISOString()}` %>
2
+ <% if(t.isTsStandalone) { %>
3
+ import schema from './schema.json' with { type: "json" };
4
+ export { schema };
5
+ <% } else { %>
6
+ import meta from './<%= t.schemaOutDir %>/_meta.json' with { type: "json" };
7
+ <% Object.values(t.schema.segments).filter((segment) => segment.emitSchema).forEach((segment, i) => { %>
8
+ import segment<%= i %> from './<%= t.schemaOutDir %>/<%= segment.segmentName || t.ROOT_SEGMENT_FILE_NAME %>.json' with { type: "json" };
9
+ <% }) %>
10
+ const segments = {<% Object.values(t.schema.segments).filter((segment) => segment.emitSchema).forEach((segment, i) => { %>
11
+ '<%= segment.segmentName %>': segment<%= i %>,<% }) %>
12
+ };
13
+
14
+ export const schema = {
15
+ $schema: '<%- t.VovkSchemaIdEnum.SCHEMA %>',
16
+ segments,
17
+ meta: {
18
+ apiRoot: '<%= t.apiRoot %>', // for debugging purposes
19
+ ...meta,
20
+ }
21
+ };
22
+ <% } %>
@@ -0,0 +1,13 @@
1
+ import type { VovkRequest, VovkStreamAsyncIterable, KnownAny } from 'vovk';
2
+ <% Object.entries(t.schema.segments).forEach(([segmentName, segment], i) => { %>
3
+ export type Segment<%= i %> = {
4
+ <% Object.values(segment.controllers).forEach((controllerSchema) => { %>
5
+ <%= controllerSchema.originalControllerName ?? controllerSchema.rpcModuleName + 'Controller' %>: {
6
+ <% Object.entries(controllerSchema.handlers).forEach(([handlerName, handler]) => { %>
7
+ <%= handlerName %>: (req: VovkRequest<<%- t.convertJSONSchemaToTypeScriptDef(handler.validation?.body) ?? 'KnownAny' %>, <%- t.convertJSONSchemaToTypeScriptDef(handler.validation?.query) ?? 'KnownAny' %>, <%- t.convertJSONSchemaToTypeScriptDef(handler.validation?.params ?? 'KnownAny') %>>) => <%- handler.validation?.output ? `Promise<${t.convertJSONSchemaToTypeScriptDef(handler.validation?.body)}>` : handler.validation?.iteration ? `Promise<VovkStreamAsyncIterable<${t.convertJSONSchemaToTypeScriptDef(handler.validation?.iteration)}>>` : 'Promise<KnownAny>' %>,
8
+ <% }) %>
9
+ };
10
+ <% }) %>
11
+ };
12
+ <% }) %>
13
+
@@ -0,0 +1,31 @@
1
+ <%- `// auto-generated by Vovk.ts ${new Date().toISOString()}` %>
2
+ import type { VovkClientFetcher } from 'vovk';
3
+ import { fetcher } from '<%= t.imports.fetcher %>';
4
+ import { createRPC } from '<%= t.imports.createRPC %>';
5
+ import { schema } from './schema<%= t.nodeNextResolutionExt.ts %>';
6
+ <% if(t.isTsStandalone) { %>
7
+ import type {
8
+ <% Object.values(t.schema.segments).filter((segment) => segment.emitSchema).forEach((segment, i) => { %>
9
+ Segment<%= i %> as Controllers<%= i %>
10
+ <% }) %>
11
+ } from './types.d<%= t.nodeNextResolutionExt.ts %>';
12
+ <% } else { %>
13
+ <% Object.values(t.schema.segments).filter((segment) => segment.emitSchema).forEach((segment, i) => { %>
14
+ import type { Controllers as Controllers<%= i %> } from "<%= t.segmentMeta[segment.segmentName].segmentImportPath %>";
15
+ <% }) %>
16
+ <% } %>
17
+ <% if (t.imports.validateOnClient) { %>
18
+ import { validateOnClient } from '<%= t.imports.validateOnClient %>';
19
+ <% } else { %>
20
+ const validateOnClient = undefined;
21
+ <% } %>
22
+ type Options = typeof fetcher extends VovkClientFetcher<infer U> ? U : never;
23
+ <% Object.values(t.schema.segments).filter((segment) => segment.emitSchema).forEach((segment, i) => {
24
+ Object.keys(segment.controllers).forEach((rpcModuleName) => { %>
25
+ export const <%= rpcModuleName %> = createRPC<Controllers<%= i %>["<%= rpcModuleName %>"], Options>(
26
+ schema, '<%= segment.segmentName %>', '<%= rpcModuleName %>',
27
+ { fetcher, validateOnClient, <%- typeof t.segmentMeta[segment.segmentName].segmentNameOverride === 'string' ? `segmentNameOverride: '${t.segmentMeta[segment.segmentName].segmentNameOverride}', ` : '' %>defaultOptions: { apiRoot: '<%= segment.segmentApiRoot ?? t.apiRoot %>' } }
28
+ );
29
+ <% })
30
+ }) %>
31
+ export { schema };
@@ -0,0 +1,8 @@
1
+ import type { VovkSchema } from 'vovk';
2
+ import type { ProjectInfo } from '../getProjectInfo/index.mjs';
3
+ import type { BundleOptions } from '../types.mjs';
4
+ export declare function bundle({ projectInfo, fullSchema, cliBundleOptions, }: {
5
+ projectInfo: ProjectInfo;
6
+ fullSchema: VovkSchema;
7
+ cliBundleOptions: BundleOptions;
8
+ }): Promise<void>;
@@ -0,0 +1,83 @@
1
+ import path from 'node:path';
2
+ import fs from 'node:fs/promises';
3
+ import { build } from 'tsdown';
4
+ import groupBy from 'lodash/groupBy.js';
5
+ import { generate } from '../generate/generate.mjs';
6
+ import { BuiltInTemplateName } from '../getProjectInfo/getConfig/getTemplateDefs.mjs';
7
+ import chalkHighlightThing from '../utils/chalkHighlightThing.mjs';
8
+ import { locateSegments } from '../locateSegments.mjs';
9
+ export async function bundle({ projectInfo, fullSchema, cliBundleOptions, }) {
10
+ const { config, log, cwd, apiDirAbsolutePath } = projectInfo;
11
+ const locatedSegments = await locateSegments({ dir: apiDirAbsolutePath, config, log });
12
+ const { bundle: bundleConfig } = config;
13
+ const tsFullClientOutAbsoluteDirInput = path.join(cwd, bundleConfig.tsClientOutDir);
14
+ const tsClientOutDir = cliBundleOptions?.tsClientOutDir ?? bundleConfig.tsClientOutDir;
15
+ const dontDeleteTsClientOutDirAfter = cliBundleOptions?.dontDeleteTsClientOutDirAfter ?? bundleConfig?.dontDeleteTsClientOutDirAfter ?? false;
16
+ const sourcemap = cliBundleOptions?.sourcemap ?? bundleConfig?.sourcemap;
17
+ if (!tsClientOutDir) {
18
+ throw new Error('No output directory specified for composed client');
19
+ }
20
+ const outDir = cliBundleOptions?.outDir ?? bundleConfig.outDir;
21
+ if (!outDir) {
22
+ throw new Error('No output directory specified for bundling');
23
+ }
24
+ await generate({
25
+ isEnsuringClient: false,
26
+ projectInfo,
27
+ forceNothingWrittenLog: true,
28
+ fullSchema,
29
+ locatedSegments,
30
+ cliGenerateOptions: {
31
+ openapiSpec: cliBundleOptions?.openapiSpec,
32
+ composedFrom: [BuiltInTemplateName.ts],
33
+ composedOut: tsClientOutDir,
34
+ composedOnly: true,
35
+ composedIncludeSegments: cliBundleOptions.includeSegments ?? bundleConfig.includeSegments,
36
+ composedExcludeSegments: cliBundleOptions.excludeSegments ?? bundleConfig.excludeSegments,
37
+ forceTsStandalone: cliBundleOptions.forceTsStandalone,
38
+ },
39
+ });
40
+ await build({
41
+ entry: path.join(tsFullClientOutAbsoluteDirInput, './index.ts'),
42
+ dts: true,
43
+ format: ['cjs', 'esm'],
44
+ fixedExtension: true,
45
+ outDir,
46
+ sourcemap: bundleConfig.sourcemap,
47
+ });
48
+ const outDirAbsolute = path.resolve(cwd, outDir);
49
+ log.debug(`Bundled index.ts to ${chalkHighlightThing(outDirAbsolute)}`);
50
+ await build({
51
+ entry: path.join(tsFullClientOutAbsoluteDirInput, './schema.ts'),
52
+ dts: true,
53
+ format: ['cjs'],
54
+ fixedExtension: true,
55
+ outDir,
56
+ clean: false,
57
+ sourcemap,
58
+ });
59
+ log.debug(`Bundled schema.ts to ${chalkHighlightThing(outDirAbsolute)}`);
60
+ const requiresGroup = groupBy(Object.entries(bundleConfig.requires), ([, relativePath]) => relativePath);
61
+ for (const [relativePath, group] of Object.entries(requiresGroup)) {
62
+ await generate({
63
+ isEnsuringClient: false,
64
+ projectInfo,
65
+ forceNothingWrittenLog: true,
66
+ fullSchema,
67
+ locatedSegments,
68
+ cliGenerateOptions: {
69
+ composedFrom: group.map(([templateName]) => templateName),
70
+ composedOut: path.resolve(outDir, relativePath),
71
+ composedOnly: true,
72
+ },
73
+ });
74
+ }
75
+ if (!dontDeleteTsClientOutDirAfter) {
76
+ await fs.rm(tsFullClientOutAbsoluteDirInput, { recursive: true, force: true });
77
+ log.debug(`Deleted temporary TypeScript client output directory: ${chalkHighlightThing(tsFullClientOutAbsoluteDirInput)}`);
78
+ }
79
+ else {
80
+ log.debug(`Temporary TypeScript client output directory not deleted: ${chalkHighlightThing(tsFullClientOutAbsoluteDirInput)}`);
81
+ }
82
+ log.info(`Bundled TypeScript client to ${chalkHighlightThing(outDirAbsolute)}`);
83
+ }
@@ -0,0 +1,36 @@
1
+ import type { VovkControllerSchema, VovkSegmentSchema } from 'vovk';
2
+ interface HandlersDiff {
3
+ nameOfClass: string;
4
+ added: string[];
5
+ removed: string[];
6
+ changed: string[];
7
+ }
8
+ interface ControllersDiff {
9
+ added: string[];
10
+ removed: string[];
11
+ handlers: HandlersDiff[];
12
+ }
13
+ export interface DiffResult {
14
+ controllers: ControllersDiff;
15
+ }
16
+ export declare function diffHandlers<T extends VovkControllerSchema['handlers']>(oldHandlers: T, newHandlers: T, nameOfClass: string): HandlersDiff;
17
+ export declare function diffControllers<T extends VovkSegmentSchema['controllers']>(oldItems: T, newItems: T): ControllersDiff;
18
+ /**
19
+ example output:
20
+ {
21
+ controllers: {
22
+ added: ["ControllerC"],
23
+ removed: ["ControllerB"],
24
+ handlers: [
25
+ {
26
+ nameOfClass: "ControllerA",
27
+ added: ["handlerF"],
28
+ removed: [],
29
+ changed: ["handlerD"]
30
+ }
31
+ ]
32
+ }
33
+ }
34
+ */
35
+ export default function diffSegmentSchema(oldJson: VovkSegmentSchema, newJson: VovkSegmentSchema): DiffResult;
36
+ export {};
@@ -18,7 +18,7 @@ export function diffHandlers(oldHandlers, newHandlers, nameOfClass) {
18
18
  }
19
19
  return { nameOfClass, added, removed, changed };
20
20
  }
21
- export function diffWorkersOrControllers(oldItems, newItems) {
21
+ export function diffControllers(oldItems, newItems) {
22
22
  const added = [];
23
23
  const removed = [];
24
24
  const handlersDiff = [];
@@ -27,7 +27,7 @@ export function diffWorkersOrControllers(oldItems, newItems) {
27
27
  added.push(item);
28
28
  }
29
29
  else {
30
- const handlers = diffHandlers(oldItems[item]._handlers, newItem._handlers, item);
30
+ const handlers = diffHandlers(oldItems[item].handlers, newItem.handlers, item);
31
31
  if (handlers.added.length || handlers.removed.length || handlers.changed.length) {
32
32
  handlersDiff.push(handlers);
33
33
  }
@@ -43,11 +43,6 @@ export function diffWorkersOrControllers(oldItems, newItems) {
43
43
  /**
44
44
  example output:
45
45
  {
46
- workers: {
47
- added: ["WorkerC"],
48
- removed: ["WorkerA"],
49
- handlers: []
50
- },
51
46
  controllers: {
52
47
  added: ["ControllerC"],
53
48
  removed: ["ControllerB"],
@@ -62,11 +57,8 @@ example output:
62
57
  }
63
58
  }
64
59
  */
65
- export default function diffSchema(oldJson, newJson) {
66
- const workersDiff = diffWorkersOrControllers(oldJson.workers ?? {}, newJson.workers ?? {});
67
- const controllersDiff = diffWorkersOrControllers(oldJson.controllers ?? {}, newJson.controllers ?? {});
60
+ export default function diffSegmentSchema(oldJson, newJson) {
68
61
  return {
69
- workers: workersDiff,
70
- controllers: controllersDiff,
62
+ controllers: diffControllers(oldJson.controllers ?? {}, newJson.controllers ?? {}),
71
63
  };
72
64
  }
@@ -1,3 +1,6 @@
1
1
  import { ProjectInfo } from '../getProjectInfo/index.mjs';
2
+ /**
3
+ * Ensure that the schema files are created to avoid any import errors.
4
+ */
2
5
  export default function ensureSchemaFiles(projectInfo: ProjectInfo | null, schemaOutAbsolutePath: string, segmentNames: string[]): Promise<void>;
3
6
  export declare const debouncedEnsureSchemaFiles: import("lodash").DebouncedFunc<typeof ensureSchemaFiles>;
@@ -1,44 +1,27 @@
1
1
  import fs from 'node:fs/promises';
2
2
  import path from 'node:path';
3
3
  import debounce from 'lodash/debounce.js';
4
- import writeOneSchemaFile, { ROOT_SEGMENT_SCHEMA_NAME } from './writeOneSchemaFile.mjs';
4
+ import { VovkSchemaIdEnum } from 'vovk';
5
+ import writeOneSegmentSchemaFile, { META_FILE_NAME, ROOT_SEGMENT_FILE_NAME } from './writeOneSegmentSchemaFile.mjs';
5
6
  import formatLoggedSegmentName from '../utils/formatLoggedSegmentName.mjs';
7
+ import writeMetaJson from './writeMetaJson.mjs';
8
+ /**
9
+ * Ensure that the schema files are created to avoid any import errors.
10
+ */
6
11
  export default async function ensureSchemaFiles(projectInfo, schemaOutAbsolutePath, segmentNames) {
7
12
  const now = Date.now();
8
13
  let hasChanged = false;
9
- // Create index.js file
10
- const indexContent = `// auto-generated
11
- ${segmentNames
12
- .map((segmentName) => {
13
- return `module.exports['${segmentName}'] = require('./${segmentName || ROOT_SEGMENT_SCHEMA_NAME}.json');`;
14
- })
15
- .join('\n')}`;
16
- const dTsContent = `// auto-generated
17
- import type { VovkSchema } from 'vovk';
18
- declare const segmentSchema: {
19
- ${segmentNames.map((segmentName) => ` '${segmentName}': VovkSchema;`).join('\n')}
20
- };
21
- export default segmentSchema;`;
22
- const jsAbsolutePath = path.join(schemaOutAbsolutePath, 'index.js');
23
- const dTsAbsolutePath = path.join(schemaOutAbsolutePath, 'index.d.ts');
24
- const existingJs = await fs.readFile(jsAbsolutePath, 'utf-8').catch(() => null);
25
- const existingDTs = await fs.readFile(dTsAbsolutePath, 'utf-8').catch(() => null);
26
14
  await fs.mkdir(schemaOutAbsolutePath, { recursive: true });
27
- if (existingJs !== indexContent) {
28
- await fs.writeFile(jsAbsolutePath, indexContent);
29
- }
30
- if (existingDTs !== dTsContent) {
31
- await fs.writeFile(dTsAbsolutePath, dTsContent);
32
- }
15
+ await writeMetaJson(schemaOutAbsolutePath, projectInfo);
33
16
  // Create JSON files (if not exist) with name [segmentName].json (where segmentName can include /, which means the folder structure can be nested)
34
17
  await Promise.all(segmentNames.map(async (segmentName) => {
35
- const { isCreated } = await writeOneSchemaFile({
18
+ const { isCreated } = await writeOneSegmentSchemaFile({
36
19
  schemaOutAbsolutePath,
37
- schema: {
20
+ segmentSchema: {
21
+ $schema: VovkSchemaIdEnum.SEGMENT,
38
22
  emitSchema: false,
39
23
  segmentName,
40
24
  controllers: {},
41
- workers: {},
42
25
  },
43
26
  skipIfExists: true,
44
27
  });
@@ -48,7 +31,7 @@ export default segmentSchema;`;
48
31
  }
49
32
  }));
50
33
  // Recursive function to delete unnecessary JSON files and folders
51
- async function deleteUnnecessaryJsonFiles(dirPath) {
34
+ async function deleteUnnecessaryJsonFiles(dirPath, allow = [`${META_FILE_NAME}.json`]) {
52
35
  const entries = await fs.readdir(dirPath, { withFileTypes: true });
53
36
  await Promise.all(entries.map(async (entry) => {
54
37
  const absolutePath = path.join(dirPath, entry.name);
@@ -67,7 +50,8 @@ export default segmentSchema;`;
67
50
  const relativePath = path.relative(schemaOutAbsolutePath, absolutePath);
68
51
  const segmentName = relativePath.replace(/\\/g, '/').slice(0, -5); // Remove '.json' extension
69
52
  if (!segmentNames.includes(segmentName) &&
70
- !segmentNames.includes(segmentName.replace(ROOT_SEGMENT_SCHEMA_NAME, ''))) {
53
+ !segmentNames.includes(segmentName.replace(ROOT_SEGMENT_FILE_NAME, '')) &&
54
+ !allow.includes(entry.name)) {
71
55
  await fs.unlink(absolutePath);
72
56
  projectInfo?.log.debug(`Deleted unnecessary schema file for ${formatLoggedSegmentName(segmentName)}`);
73
57
  hasChanged = true;
@@ -75,9 +59,8 @@ export default segmentSchema;`;
75
59
  }
76
60
  }));
77
61
  }
78
- // Start the recursive deletion from the root directory
79
62
  await deleteUnnecessaryJsonFiles(schemaOutAbsolutePath);
80
63
  if (hasChanged)
81
- projectInfo?.log.info(`Schema files updated in ${Date.now() - now}ms`);
64
+ projectInfo?.log.info(`Created empty schema files in ${Date.now() - now}ms`);
82
65
  }
83
66
  export const debouncedEnsureSchemaFiles = debounce(ensureSchemaFiles, 1000);
@@ -1,6 +1,9 @@
1
1
  export declare class VovkDev {
2
2
  #private;
3
- start({ clientOutDir }?: {
4
- clientOutDir?: string;
3
+ constructor({ schemaOut }: {
4
+ schemaOut: string | undefined;
5
+ });
6
+ start({ exit }: {
7
+ exit: boolean;
5
8
  }): Promise<void>;
6
9
  }