vovk-cli 0.0.1-draft.37 → 0.0.1-draft.370

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 (142) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +29 -1
  3. package/client-templates/cjs/index.cjs.ejs +19 -0
  4. package/client-templates/cjs/index.d.cts.ejs +22 -0
  5. package/client-templates/mixins/mixins.d.ts.ejs +64 -0
  6. package/client-templates/mixins/mixins.json.ejs +1 -0
  7. package/client-templates/mjs/index.d.mts.ejs +22 -0
  8. package/client-templates/mjs/index.mjs.ejs +18 -0
  9. package/client-templates/openapiCjs/openapi.cjs.ejs +4 -0
  10. package/client-templates/openapiCjs/openapi.d.cts.ejs +4 -0
  11. package/client-templates/openapiJson/openapi.json.ejs +1 -0
  12. package/client-templates/openapiTs/openapi.ts.ejs +4 -0
  13. package/client-templates/packageJson/package.json.ejs +1 -0
  14. package/client-templates/readme/README.md.ejs +39 -0
  15. package/client-templates/schemaCjs/schema.cjs.ejs +24 -0
  16. package/client-templates/schemaCjs/schema.d.cts.ejs +10 -0
  17. package/client-templates/schemaJson/schema.json.ejs +1 -0
  18. package/client-templates/schemaTs/schema.ts.ejs +28 -0
  19. package/client-templates/ts/index.ts.ejs +27 -0
  20. package/dist/bundle/index.d.mts +8 -0
  21. package/dist/bundle/index.mjs +103 -0
  22. package/dist/dev/diffSegmentSchema.d.mts +36 -0
  23. package/dist/dev/{diffSchema.mjs → diffSegmentSchema.mjs} +3 -11
  24. package/dist/dev/ensureSchemaFiles.d.mts +4 -1
  25. package/dist/dev/ensureSchemaFiles.mjs +15 -31
  26. package/dist/dev/index.d.mts +5 -1
  27. package/dist/dev/index.mjs +191 -80
  28. package/dist/dev/logDiffResult.d.mts +1 -1
  29. package/dist/dev/logDiffResult.mjs +6 -43
  30. package/dist/dev/writeMetaJson.d.mts +2 -0
  31. package/dist/dev/writeMetaJson.mjs +20 -0
  32. package/dist/dev/writeOneSegmentSchemaFile.d.mts +12 -0
  33. package/dist/dev/{writeOneSchemaFile.mjs → writeOneSegmentSchemaFile.mjs} +10 -6
  34. package/dist/generate/ensureClient.d.mts +3 -0
  35. package/dist/generate/ensureClient.mjs +28 -0
  36. package/dist/generate/generate.d.mts +13 -0
  37. package/dist/generate/generate.mjs +306 -0
  38. package/dist/generate/getClientTemplateFiles.d.mts +20 -0
  39. package/dist/generate/getClientTemplateFiles.mjs +85 -0
  40. package/dist/generate/getProjectFullSchema.d.mts +8 -0
  41. package/dist/generate/getProjectFullSchema.mjs +66 -0
  42. package/dist/generate/getTemplateClientImports.d.mts +19 -0
  43. package/dist/generate/getTemplateClientImports.mjs +49 -0
  44. package/dist/generate/index.d.mts +33 -0
  45. package/dist/generate/index.mjs +186 -0
  46. package/dist/generate/writeOneClientFile.d.mts +42 -0
  47. package/dist/generate/writeOneClientFile.mjs +139 -0
  48. package/dist/getProjectInfo/getConfig/getConfigAbsolutePaths.d.mts +5 -0
  49. package/dist/getProjectInfo/{getConfigAbsolutePaths.mjs → getConfig/getConfigAbsolutePaths.mjs} +4 -1
  50. package/dist/getProjectInfo/{getRelativeSrcRoot.d.mts → getConfig/getRelativeSrcRoot.d.mts} +1 -1
  51. package/dist/getProjectInfo/{getRelativeSrcRoot.mjs → getConfig/getRelativeSrcRoot.mjs} +2 -2
  52. package/dist/getProjectInfo/getConfig/getTemplateDefs.d.mts +24 -0
  53. package/dist/getProjectInfo/getConfig/getTemplateDefs.mjs +165 -0
  54. package/dist/getProjectInfo/{getUserConfig.d.mts → getConfig/getUserConfig.d.mts} +3 -2
  55. package/dist/getProjectInfo/{getUserConfig.mjs → getConfig/getUserConfig.mjs} +3 -3
  56. package/dist/getProjectInfo/{importUncachedModule.mjs → getConfig/importUncachedModule.mjs} +1 -4
  57. package/dist/getProjectInfo/getConfig/index.d.mts +78 -0
  58. package/dist/getProjectInfo/getConfig/index.mjs +91 -0
  59. package/dist/getProjectInfo/getMetaSchema.d.mts +8 -0
  60. package/dist/getProjectInfo/getMetaSchema.mjs +27 -0
  61. package/dist/getProjectInfo/index.d.mts +14 -9
  62. package/dist/getProjectInfo/index.mjs +24 -22
  63. package/dist/index.d.mts +2 -2
  64. package/dist/index.mjs +117 -35
  65. package/dist/init/createConfig.d.mts +2 -2
  66. package/dist/init/createConfig.mjs +40 -13
  67. package/dist/init/createStandardSchemaValidatorFile.d.mts +4 -0
  68. package/dist/init/createStandardSchemaValidatorFile.mjs +52 -0
  69. package/dist/init/getTemplateFilesFromPackage.mjs +10 -5
  70. package/dist/init/index.d.mts +2 -2
  71. package/dist/init/index.mjs +123 -72
  72. package/dist/init/installDependencies.mjs +4 -2
  73. package/dist/init/logUpdateDependenciesError.d.mts +3 -1
  74. package/dist/init/logUpdateDependenciesError.mjs +7 -1
  75. package/dist/init/updateDependenciesWithoutInstalling.mjs +39 -9
  76. package/dist/init/updateNPMScripts.d.mts +3 -1
  77. package/dist/init/updateNPMScripts.mjs +10 -7
  78. package/dist/init/updateTypeScriptConfig.d.mts +4 -1
  79. package/dist/init/updateTypeScriptConfig.mjs +11 -7
  80. package/dist/initProgram.d.mts +1 -1
  81. package/dist/initProgram.mjs +17 -17
  82. package/dist/locateSegments.d.mts +8 -1
  83. package/dist/locateSegments.mjs +13 -3
  84. package/dist/new/addClassToSegmentCode.d.mts +1 -2
  85. package/dist/new/addClassToSegmentCode.mjs +3 -3
  86. package/dist/new/index.d.mts +2 -1
  87. package/dist/new/index.mjs +5 -3
  88. package/dist/new/newModule.d.mts +5 -2
  89. package/dist/new/newModule.mjs +23 -22
  90. package/dist/new/newSegment.d.mts +4 -1
  91. package/dist/new/newSegment.mjs +19 -11
  92. package/dist/new/render.d.mts +7 -3
  93. package/dist/new/render.mjs +31 -10
  94. package/dist/types.d.mts +66 -44
  95. package/dist/utils/compileJSONSchemaToTypeScriptType.d.mts +5 -0
  96. package/dist/utils/compileJSONSchemaToTypeScriptType.mjs +9 -0
  97. package/dist/utils/compileTs.d.mts +12 -0
  98. package/dist/utils/compileTs.mjs +261 -0
  99. package/dist/utils/debounceWithArgs.d.mts +2 -2
  100. package/dist/utils/debounceWithArgs.mjs +24 -6
  101. package/dist/utils/deepExtend.d.mts +54 -0
  102. package/dist/utils/deepExtend.mjs +129 -0
  103. package/dist/utils/formatLoggedSegmentName.d.mts +3 -1
  104. package/dist/utils/formatLoggedSegmentName.mjs +3 -2
  105. package/dist/utils/generateFnName.d.mts +23 -0
  106. package/dist/utils/generateFnName.mjs +76 -0
  107. package/dist/utils/getPackageJson.d.mts +3 -0
  108. package/dist/utils/getPackageJson.mjs +22 -0
  109. package/dist/utils/getPublicModuleNameFromPath.d.mts +4 -0
  110. package/dist/utils/getPublicModuleNameFromPath.mjs +9 -0
  111. package/dist/utils/normalizeOpenAPIMixin.d.mts +14 -0
  112. package/dist/utils/normalizeOpenAPIMixin.mjs +114 -0
  113. package/dist/utils/pickSegmentFullSchema.d.mts +3 -0
  114. package/dist/utils/pickSegmentFullSchema.mjs +15 -0
  115. package/dist/utils/removeUnlistedDirectories.d.mts +10 -0
  116. package/dist/utils/removeUnlistedDirectories.mjs +61 -0
  117. package/dist/utils/resolveAbsoluteModulePath.d.mts +2 -0
  118. package/dist/utils/resolveAbsoluteModulePath.mjs +32 -0
  119. package/module-templates/arktype/controller.ts.ejs +68 -0
  120. package/module-templates/type/controller.ts.ejs +56 -0
  121. package/module-templates/type/service.ts.ejs +28 -0
  122. package/module-templates/valibot/controller.ts.ejs +68 -0
  123. package/package.json +40 -22
  124. package/dist/dev/diffSchema.d.mts +0 -43
  125. package/dist/dev/ensureClient.d.mts +0 -5
  126. package/dist/dev/ensureClient.mjs +0 -31
  127. package/dist/dev/isMetadataEmpty.d.mts +0 -2
  128. package/dist/dev/isMetadataEmpty.mjs +0 -4
  129. package/dist/dev/writeOneSchemaFile.d.mts +0 -11
  130. package/dist/generateClient.d.mts +0 -7
  131. package/dist/generateClient.mjs +0 -97
  132. package/dist/getProjectInfo/getConfig.d.mts +0 -11
  133. package/dist/getProjectInfo/getConfig.mjs +0 -29
  134. package/dist/getProjectInfo/getConfigAbsolutePaths.d.mts +0 -4
  135. package/dist/postinstall.d.mts +0 -1
  136. package/dist/postinstall.mjs +0 -24
  137. package/templates/controller.ejs +0 -52
  138. package/templates/service.ejs +0 -27
  139. package/templates/worker.ejs +0 -24
  140. /package/dist/getProjectInfo/{importUncachedModule.d.mts → getConfig/importUncachedModule.d.mts} +0 -0
  141. /package/dist/getProjectInfo/{importUncachedModuleWorker.d.mts → getConfig/importUncachedModuleWorker.d.mts} +0 -0
  142. /package/dist/getProjectInfo/{importUncachedModuleWorker.mjs → getConfig/importUncachedModuleWorker.mjs} +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,19 @@
1
+ <%- t.getFirstLineBanner() %>
2
+ const { createRPC } = require('<%= t.commonImports.createRPC %>');
3
+ const { schema } = require('./schema.cjs');
4
+ const { openapi } = require('./openapi.cjs');
5
+ <% Object.entries(t.reExports).forEach(([reExportWhatCommaDivisible, reExportFrom]) => {
6
+ reExportWhatCommaDivisible.split(/\s*,\s*/).forEach((reExportWhat) => { %>
7
+ exports['<%= reExportWhat.split(/\s+as\s+/)[1] ?? reExportWhat %>'] = require('<%= reExportFrom %>')['<%= reExportWhat.split(/\s+as\s+/)[0] %>'];
8
+ <% })
9
+ }) %>
10
+ <% Object.values(t.schema.segments).filter((segment) => segment.emitSchema).forEach((segment) => { %>
11
+ <% Object.keys(segment.controllers).forEach((rpcModuleName) => { %>
12
+ exports.<%= rpcModuleName %> = createRPC(
13
+ schema, '<%= segment.segmentName %>', '<%= rpcModuleName %>', require('<%= t.segmentImports[segment.segmentName].fetcher %>').fetcher,
14
+ { validateOnClient: <%- t.segmentImports[segment.segmentName].validateOnClient ? `require('${t.segmentImports[segment.segmentName].validateOnClient}').validateOnClient` : 'undefined' %>, <%- typeof t.segmentMeta[segment.segmentName].segmentNameOverride === 'string' ? `segmentNameOverride: '${t.segmentMeta[segment.segmentName].segmentNameOverride}', ` : '' %><%- segment.segmentType === 'mixin' ? '' : `apiRoot: '${t.segmentMeta[segment.segmentName].forceApiRoot ?? t.apiRoot}'` %> }
15
+ );
16
+ <% })
17
+ }) %>
18
+ exports.schema = schema;
19
+ exports.openapi = openapi;
@@ -0,0 +1,22 @@
1
+ <%- t.getFirstLineBanner() %>
2
+ import type { VovkFetcher } from 'vovk';
3
+ import type { createRPC } from '<%= t.commonImports.module.createRPC %>';
4
+ <% Object.values(t.schema.segments).filter((segment) => segment.emitSchema).forEach((segment, i) => { if(segment.segmentType !== 'mixin') { %>
5
+ import type { Controllers as Controllers<%= i %> } from "<%= t.segmentMeta[segment.segmentName].segmentImportPath %>";
6
+ <% }}) %>
7
+ <% if (t.hasMixins) { %>
8
+ import type { Controllers as MixinControllers, Mixins } from "./mixins";
9
+ <% } %>
10
+ <% Object.entries(t.reExports).forEach(([reExportWhat, reExportFrom]) => { %>
11
+ export { <%= reExportWhat %> } from '<%= reExportFrom %>';
12
+ <% }) %>
13
+ <% Object.values(t.schema.segments).filter((segment) => segment.emitSchema).forEach((segment, i) => { %>
14
+ <% Object.keys(segment.controllers).forEach((rpcModuleName) => { %>
15
+ export const <%= rpcModuleName %>: ReturnType<typeof createRPC<<%= segment.segmentType === 'mixin' ? `MixinControllers` : `Controllers${i}` %>["<%= rpcModuleName %>"], typeof import('<%- t.segmentImports[segment.segmentName].module.fetcher %>').fetcher extends VovkFetcher<infer U> ? U : never>>;
16
+ <% })
17
+ }) %>
18
+ export { schema } from './schema.cjs';
19
+ export { openapi } from './openapi.cjs';
20
+ <% if (t.hasMixins) { %>
21
+ export { Mixins };
22
+ <% } %>
@@ -0,0 +1,64 @@
1
+ <%- t.getFirstLineBanner() %>
2
+ import type { VovkRequest, VovkStreamAsyncIterable, KnownAny } from 'vovk';
3
+
4
+ <% const mixins = Object.values(t.schema.segments).filter((segment) => segment.emitSchema && segment.segmentType === 'mixin'); %>
5
+
6
+ export namespace Mixins {
7
+ <% for (const segment of mixins) { %>
8
+ <% if(segment.meta?.openAPIObject?.components?.schemas) { %>
9
+ export namespace <%= t._.upperFirst(t._.camelCase(segment.segmentName)) %> {
10
+ <% for (const [componentName, componentSchema] of Object.entries(segment.meta.openAPIObject.components.schemas)) { %>
11
+ <%- t.compileJSONSchemaToTypeScriptType(componentSchema, componentName, segment.meta.openAPIObject.components, { dontCreateRefTypes: true }) %>
12
+ <% } %>
13
+ }
14
+ <% } %>
15
+ <% } %>
16
+ }
17
+
18
+ export namespace Types {
19
+ <% for (const segment of mixins) { %>
20
+ export namespace <%= t._.upperFirst(t._.camelCase(segment.segmentName)) %> {
21
+ <% for (const [controllerName, controllerSchema] of Object.entries(segment.controllers)) { %>
22
+ export namespace <%= controllerSchema.rpcModuleName %> {
23
+ <% for (const [handlerName, handlerSchema] of Object.entries(controllerSchema.handlers)) { %>
24
+ export namespace <%= t._.upperFirst(handlerName) %> {
25
+ <%- t.compileJSONSchemaToTypeScriptType(handlerSchema.validation?.body, 'Body') %>
26
+ <%- t.compileJSONSchemaToTypeScriptType(handlerSchema.validation?.query, 'Query') %>
27
+ <%- t.compileJSONSchemaToTypeScriptType(handlerSchema.validation?.params, 'Params') %>
28
+ <%- t.compileJSONSchemaToTypeScriptType(handlerSchema.validation?.output, 'Output') %>
29
+ <%- t.compileJSONSchemaToTypeScriptType(handlerSchema.validation?.iteration, 'Iteration') %>
30
+ }
31
+ <% } %>
32
+ }
33
+ <% } %>
34
+ }
35
+ <% } %>
36
+ }
37
+
38
+ <% const getType = (segment, controllerSchema, handlerName, validationType) => {
39
+ const segmentNs = t._.upperFirst(t._.camelCase(segment.segmentName));
40
+ const controllerNs = controllerSchema.rpcModuleName;
41
+ const handlerNs = t._.upperFirst(handlerName);
42
+ const typeName = t._.upperFirst(validationType);
43
+ const handlerSchema = controllerSchema.handlers[handlerName];
44
+ if(handlerSchema.validation?.[validationType] ) {
45
+ return 'Types.' + segmentNs + '.' + controllerNs + '.' + handlerNs + '.' + typeName;
46
+ }
47
+ return 'null';
48
+ } %>
49
+
50
+ export type Controllers = {
51
+ <% for (const segment of Object.values(t.schema.segments).filter((segment) => segment.emitSchema && segment.segmentType === 'mixin')) { %>
52
+ <% for (const controllerSchema of Object.values(segment.controllers)) { %>
53
+ <%= controllerSchema.rpcModuleName %>: {
54
+ <% for (const [handlerName, handlerSchema] of Object.entries(controllerSchema.handlers)) { %>
55
+ <%= handlerName %>: (req: VovkRequest<
56
+ <%- getType(segment, controllerSchema, handlerName, 'body') %>,
57
+ <%- getType(segment, controllerSchema, handlerName, 'query') %>,
58
+ <%- getType(segment, controllerSchema, handlerName, 'params') %>
59
+ >) => <%- handlerSchema.validation?.output ? `Promise<${getType(segment, controllerSchema, handlerName, 'output')}>` : handlerSchema.validation?.iteration ? `Promise<VovkStreamAsyncIterable<${getType(segment, controllerSchema, handlerName, 'iteration')}>>` : 'Promise<KnownAny>' %>,
60
+ <% } %>
61
+ };
62
+ <% } %>
63
+ <% } %>
64
+ };
@@ -0,0 +1 @@
1
+ <%- JSON.stringify(t._.pickBy(t.schema.segments, (segment) => segment.segmentType === 'mixin'), null, 2) %>
@@ -0,0 +1,22 @@
1
+ <%- t.getFirstLineBanner() %>
2
+ import type { VovkFetcher } from 'vovk';
3
+ import type { createRPC } from '<%= t.commonImports.module.createRPC %>';
4
+ <% Object.values(t.schema.segments).filter((segment) => segment.emitSchema).forEach((segment, i) => { if(segment.segmentType !== 'mixin') { %>
5
+ import type { Controllers as Controllers<%= i %> } from "<%= t.segmentMeta[segment.segmentName].segmentImportPath %>";
6
+ <% }}) %>
7
+ <% if (t.hasMixins) { %>
8
+ import type { Controllers as MixinControllers, Mixins } from "./mixins";
9
+ <% } %>
10
+ <% Object.entries(t.reExports).forEach(([reExportWhat, reExportFrom]) => { %>
11
+ export { <%= reExportWhat %> } from '<%= reExportFrom %>';
12
+ <% }) %>
13
+ <% Object.values(t.schema.segments).filter((segment) => segment.emitSchema).forEach((segment, i) => { %>
14
+ <% Object.keys(segment.controllers).forEach((rpcModuleName) => { %>
15
+ export const <%= rpcModuleName %>: ReturnType<typeof createRPC<<%= segment.segmentType === 'mixin' ? `MixinControllers` : `Controllers${i}` %>["<%= rpcModuleName %>"], typeof import('<%- t.segmentImports[segment.segmentName].module.fetcher %>').fetcher extends VovkFetcher<infer U> ? U : never>>;
16
+ <% })
17
+ }) %>
18
+ export { schema } from './schema.cjs';
19
+ export { openapi } from './openapi.cjs';
20
+ <% if (t.hasMixins) { %>
21
+ export { Mixins };
22
+ <% } %>
@@ -0,0 +1,18 @@
1
+ <%- t.getFirstLineBanner() %>
2
+ import { createRPC } from '<%= t.commonImports.module.createRPC %>';
3
+ import { schema } from './schema.cjs';
4
+ import { openapi } from './openapi.cjs';
5
+ <% Object.entries(t.reExports).forEach(([reExportWhat, reExportFrom]) => { %>
6
+ export { <%= reExportWhat %> } from '<%= reExportFrom %>';
7
+ <% }) %>
8
+ <% Object.values(t.schema.segments).filter((segment) => segment.emitSchema).forEach((segment, i) => { %>
9
+ <% Object.keys(segment.controllers).forEach((rpcModuleName) => { %>
10
+ export const <%= rpcModuleName %> = createRPC(
11
+ schema, '<%= segment.segmentName %>', '<%= rpcModuleName %>', import('<%- t.segmentImports[segment.segmentName].module.fetcher %>'),
12
+ { validateOnClient: <%- t.segmentImports[segment.segmentName].module.validateOnClient ? `import('${t.segmentImports[segment.segmentName].validateOnClient}')` : 'undefined' %>, <%- typeof t.segmentMeta[segment.segmentName].segmentNameOverride === 'string' ? `segmentNameOverride: '${t.segmentMeta[segment.segmentName].segmentNameOverride}', ` : '' %><%- segment.segmentType === 'mixin' ? '' : `apiRoot: '${t.segmentMeta[segment.segmentName].forceApiRoot ?? t.apiRoot}'` %> }
13
+ );
14
+ <%
15
+ });
16
+ });
17
+ %>
18
+ export { schema, openapi };
@@ -0,0 +1,4 @@
1
+ <%- t.getFirstLineBanner() %>
2
+ const openapi = require('./openapi.json');
3
+
4
+ module.exports.openapi = openapi;
@@ -0,0 +1,4 @@
1
+ <%- t.getFirstLineBanner() %>
2
+ import type { OpenAPIObject } from 'openapi3-ts/oas31';
3
+
4
+ export const openapi: OpenAPIObject;
@@ -0,0 +1 @@
1
+ <%- JSON.stringify(t.openapi, null, 2) %>
@@ -0,0 +1,4 @@
1
+ <%- t.getFirstLineBanner() %>
2
+ import openapi from './openapi.json' with { type: "json" };
3
+
4
+ export { openapi };
@@ -0,0 +1 @@
1
+ <%- JSON.stringify(t.package, null, 2) %>
@@ -0,0 +1,39 @@
1
+ <%- t.getFirstLineBanner('html') %>
2
+ <%- t.readme.banner %>
3
+
4
+ # <%= t.package.name %> v<%= t.package.version %> [![TypeScript](https://badgen.net/badge/-/TypeScript?icon=typescript&label&labelColor=blue&color=555555)](https://www.typescriptlang.org/) [![Vovk.ts](https://badgen.net/badge/Built%20with/Vovk.ts/333333?icon=https://vovk.dev/icon-white.svg)](https://vovk.dev)
5
+
6
+ <%- t.readme.description ?? (`${t.package.description ? `> ${t.package.description}` : ''}`) %>
7
+
8
+ <%- t.package.license ? `License: **${t.package.license}**` : '' %>
9
+
10
+ ```bash
11
+ # Install the package
12
+ <%= t.readme.installCommand ?? `npm install ${t.package.name}` %>
13
+ ```
14
+
15
+ <% Object.entries(t.schema.segments).forEach(([segmentName, segment]) => {
16
+ Object.values(segment.controllers).forEach((controllerSchema) => { %>
17
+
18
+ ## <%= controllerSchema.rpcModuleName %>
19
+ <% Object.entries(controllerSchema.handlers).forEach(([handlerName, handlerSchema]) => { %>
20
+ ### <%= controllerSchema.rpcModuleName %>.<%= handlerName %>
21
+ <%- handlerSchema.openapi?.summary ? `> ${handlerSchema.openapi.summary}` : '' %>
22
+
23
+ <%- handlerSchema.openapi?.description ? `${handlerSchema.openapi.description}` : '' %>
24
+
25
+ <% const forceApiRoot = t.segmentMeta[segment.segmentName].forceApiRoot ?? controllerSchema.forceApiRoot; %>
26
+ `<%= handlerSchema.httpMethod %> <%= [...(forceApiRoot ? [forceApiRoot] : [t.apiRoot, segmentName]), controllerSchema.prefix, handlerSchema.path].map((part, i) => i > 0 ? t._.trim(part, '/') : part).filter(Boolean).join('/') %>`
27
+
28
+ ```ts
29
+ <%- t.createCodeSamples({
30
+ handlerSchema,
31
+ handlerName,
32
+ controllerSchema,
33
+ package: t.package,
34
+ config: t.samples,
35
+ }).ts %>
36
+ ```
37
+ <% }) %>
38
+ <% }) %>
39
+ <% }) %>
@@ -0,0 +1,24 @@
1
+ <%- t.getFirstLineBanner() %>
2
+ <% if(t.isVovkProject) { %>
3
+ const meta = require('./<%= t.schemaOutDir %>/_meta.json');
4
+ <% } else { %>
5
+ const meta = <%- JSON.stringify(t.publicMeta, null, 2) %>;
6
+ <% } %>
7
+
8
+ <% if(t.hasMixins) { %>
9
+ const mixins = require('./mixins.json');
10
+ <% } %>
11
+ const segments = {<% Object.values(t.schema.segments).filter((segment) => segment.emitSchema && segment.segmentType !== 'mixin').forEach((segment) => { %>
12
+ '<%= segment.segmentName %>': require('./<%= t.schemaOutDir %>/<%= segment.segmentName || t.ROOT_SEGMENT_FILE_NAME %>.json'),
13
+ <% }) %>
14
+ <% if(t.hasMixins) { %>
15
+ ...mixins,
16
+ <% } %>
17
+ };
18
+ const schema = {
19
+ $schema: '<%- t.VovkSchemaIdEnum.SCHEMA %>',
20
+ segments,
21
+ meta,
22
+ };
23
+
24
+ module.exports.schema = schema;
@@ -0,0 +1,10 @@
1
+ <%- t.getFirstLineBanner() %>
2
+ import type { VovkMetaSchema, VovkSegmentSchema } 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,28 @@
1
+ <%- t.getFirstLineBanner() %>
2
+ <% if(t.hasMixins) { %>
3
+ import mixins from './mixins.json' with { type: "json" };
4
+ import type { Mixins } from './mixins.d.ts';
5
+ <% } %>
6
+ <% Object.values(t.schema.segments).filter((segment) => segment.emitSchema && segment.segmentType !== 'mixin').forEach((segment, i) => { %>
7
+ import segment<%= i %> from './<%= t.schemaOutDir %>/<%= segment.segmentName || t.ROOT_SEGMENT_FILE_NAME %>.json' with { type: "json" };
8
+ <% }); %>
9
+ <% if(t.isVovkProject) { %>
10
+ import meta from './<%= t.schemaOutDir %>/_meta.json' with { type: "json" };
11
+ <% } else { %>
12
+ const meta = <%- JSON.stringify(t.publicMeta, null, 2) %>;
13
+ <% } %>
14
+ const segments = {<% Object.values(t.schema.segments).filter((segment) => segment.emitSchema && segment.segmentType !== 'mixin').forEach((segment, i) => { %>
15
+ '<%= segment.segmentName %>': segment<%= i %>,<% }) %>
16
+ <% if(t.hasMixins) { %>
17
+ ...mixins,
18
+ <% } %>
19
+ };
20
+
21
+ export const schema = {
22
+ $schema: '<%- t.VovkSchemaIdEnum.SCHEMA %>',
23
+ segments,
24
+ meta,
25
+ };
26
+ <% if (t.hasMixins) { %>
27
+ export { Mixins };
28
+ <% } %>
@@ -0,0 +1,27 @@
1
+ <%- t.getFirstLineBanner() %>
2
+ import type { VovkFetcher } from 'vovk';
3
+ import { createRPC } from '<%= t.commonImports.module.createRPC %>';
4
+ import { schema } from './schema<%= t.nodeNextResolutionExt.ts %>';
5
+ import { openapi } from './openapi<%= t.nodeNextResolutionExt.ts %>';
6
+ <% Object.values(t.schema.segments).filter((segment) => segment.emitSchema).forEach((segment, i) => { if(segment.segmentType !== 'mixin') { %>
7
+ import type { Controllers as Controllers<%= i %> } from "<%= t.segmentMeta[segment.segmentName].segmentImportPath %>";
8
+ <% }
9
+ });
10
+ if (t.hasMixins) { %>
11
+ import type { Controllers as MixinControllers, Mixins } from "./mixins.d.ts";
12
+ <% } %>
13
+ <% Object.entries(t.reExports).forEach(([reExportWhat, reExportFrom]) => { %>
14
+ export { <%= reExportWhat %> } from '<%= reExportFrom %>';
15
+ <% }) %>
16
+ <% Object.values(t.schema.segments).filter((segment) => segment.emitSchema).forEach((segment, i) => { %>
17
+ <% Object.keys(segment.controllers).forEach((rpcModuleName) => { %>
18
+ export const <%= rpcModuleName %> = createRPC<<%= segment.segmentType === 'mixin' ? `MixinControllers` : `Controllers${i}` %>["<%= rpcModuleName %>"], typeof import('<%- t.segmentImports[segment.segmentName].module.fetcher %>').fetcher extends VovkFetcher<infer U> ? U : never>(
19
+ schema, '<%= segment.segmentName %>', '<%= rpcModuleName %>', import('<%- t.segmentImports[segment.segmentName].module.fetcher %>'),
20
+ { validateOnClient: <%- t.segmentImports[segment.segmentName].module.validateOnClient ? `import('${t.segmentImports[segment.segmentName].validateOnClient}')` : 'undefined' %>, <%- typeof t.segmentMeta[segment.segmentName].segmentNameOverride === 'string' ? `segmentNameOverride: '${t.segmentMeta[segment.segmentName].segmentNameOverride}', ` : '' %><%- segment.segmentType === 'mixin' ? '' : `apiRoot: '${t.segmentMeta[segment.segmentName].forceApiRoot ?? t.apiRoot}'` %> }
21
+ );
22
+ <% })
23
+ }) %>
24
+ export { schema, openapi };
25
+ <% if (t.hasMixins) { %>
26
+ export { Mixins };
27
+ <% } %>
@@ -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,103 @@
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.prebundleOutDir);
14
+ const prebundleOutDir = cliBundleOptions?.prebundleOutDir ?? bundleConfig.prebundleOutDir;
15
+ const keepPrebundleDir = cliBundleOptions?.keepPrebundleDir ?? bundleConfig?.keepPrebundleDir ?? false;
16
+ if (!prebundleOutDir) {
17
+ throw new Error('No output directory specified for composed client');
18
+ }
19
+ const outDir = cliBundleOptions?.outDir ?? bundleConfig.tsdownBuildOptions.outDir;
20
+ const tsconfig = cliBundleOptions?.tsconfig ?? bundleConfig.tsdownBuildOptions.tsconfig;
21
+ if (!outDir) {
22
+ throw new Error('No output directory specified for bundling');
23
+ }
24
+ const outDirAbsolute = path.resolve(cwd, outDir);
25
+ await generate({
26
+ isEnsuringClient: false,
27
+ isBundle: true,
28
+ projectInfo,
29
+ forceNothingWrittenLog: true,
30
+ fullSchema,
31
+ locatedSegments,
32
+ cliGenerateOptions: {
33
+ schemaPath: cliBundleOptions?.schemaPath,
34
+ origin: cliBundleOptions?.origin,
35
+ openapiSpec: cliBundleOptions?.openapiSpec,
36
+ openapiGetModuleName: cliBundleOptions?.openapiGetModuleName,
37
+ openapiGetMethodName: cliBundleOptions?.openapiGetMethodName,
38
+ openapiRootUrl: cliBundleOptions?.openapiRootUrl,
39
+ composedFrom: [BuiltInTemplateName.ts],
40
+ composedOut: prebundleOutDir,
41
+ composedOnly: true,
42
+ composedIncludeSegments: cliBundleOptions.includeSegments ?? bundleConfig.includeSegments,
43
+ composedExcludeSegments: cliBundleOptions.excludeSegments ?? bundleConfig.excludeSegments,
44
+ },
45
+ });
46
+ await build({
47
+ entry: path.join(tsFullClientOutAbsoluteDirInput, './index.ts'),
48
+ dts: true,
49
+ format: ['cjs', 'esm'],
50
+ hash: false,
51
+ fixedExtension: true,
52
+ clean: true,
53
+ ...bundleConfig.tsdownBuildOptions,
54
+ outDir: outDirAbsolute,
55
+ tsconfig,
56
+ });
57
+ log.debug(`Bundled index.ts to ${chalkHighlightThing(outDirAbsolute)}`);
58
+ await build({
59
+ entry: path.join(tsFullClientOutAbsoluteDirInput, './schema.ts'),
60
+ dts: true,
61
+ format: ['cjs'],
62
+ fixedExtension: true,
63
+ outDir: outDirAbsolute,
64
+ clean: false,
65
+ tsconfig,
66
+ });
67
+ log.debug(`Bundled schema.ts to ${chalkHighlightThing(outDirAbsolute)}`);
68
+ await build({
69
+ entry: path.join(tsFullClientOutAbsoluteDirInput, './openapi.ts'),
70
+ dts: true,
71
+ format: ['cjs'],
72
+ fixedExtension: true,
73
+ outDir: outDirAbsolute,
74
+ clean: false,
75
+ tsconfig,
76
+ });
77
+ log.debug(`Bundled openapi.ts to ${chalkHighlightThing(outDirAbsolute)}`);
78
+ const requiresGroup = groupBy(Object.entries(bundleConfig.requires), ([, relativePath]) => relativePath);
79
+ for (const [relativePath, group] of Object.entries(requiresGroup)) {
80
+ await generate({
81
+ isEnsuringClient: false,
82
+ projectInfo,
83
+ forceNothingWrittenLog: true,
84
+ fullSchema,
85
+ locatedSegments,
86
+ cliGenerateOptions: {
87
+ schemaPath: cliBundleOptions?.schemaPath,
88
+ origin: cliBundleOptions?.origin,
89
+ composedFrom: group.map(([templateName]) => templateName),
90
+ composedOut: path.resolve(outDirAbsolute, relativePath),
91
+ composedOnly: true,
92
+ },
93
+ });
94
+ }
95
+ if (!keepPrebundleDir) {
96
+ await fs.rm(tsFullClientOutAbsoluteDirInput, { recursive: true, force: true });
97
+ log.debug(`Deleted temporary TypeScript client output directory: ${chalkHighlightThing(tsFullClientOutAbsoluteDirInput)}`);
98
+ }
99
+ else {
100
+ log.debug(`Temporary TypeScript client output directory not deleted: ${chalkHighlightThing(tsFullClientOutAbsoluteDirInput)}`);
101
+ }
102
+ log.info(`Bundled TypeScript client to ${chalkHighlightThing(outDirAbsolute)}`);
103
+ }
@@ -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 = [];
@@ -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
- export default function ensureSchemaFiles(projectInfo: ProjectInfo | null, schemaOutAbsolutePath: string, segmentNames: string[]): Promise<void>;
2
+ /**
3
+ * Ensure that the schema files are created to avoid any import errors.
4
+ */
5
+ export default function ensureSchemaFiles(projectInfo: ProjectInfo, schemaOutAbsolutePath: string, segmentNames: string[]): Promise<void>;
3
6
  export declare const debouncedEnsureSchemaFiles: import("lodash").DebouncedFunc<typeof ensureSchemaFiles>;
@@ -1,44 +1,28 @@
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,
24
+ segmentType: 'segment',
40
25
  controllers: {},
41
- workers: {},
42
26
  },
43
27
  skipIfExists: true,
44
28
  });
@@ -48,7 +32,7 @@ export default segmentSchema;`;
48
32
  }
49
33
  }));
50
34
  // Recursive function to delete unnecessary JSON files and folders
51
- async function deleteUnnecessaryJsonFiles(dirPath) {
35
+ async function deleteUnnecessaryJsonFiles(dirPath, allow = [`${META_FILE_NAME}.json`]) {
52
36
  const entries = await fs.readdir(dirPath, { withFileTypes: true });
53
37
  await Promise.all(entries.map(async (entry) => {
54
38
  const absolutePath = path.join(dirPath, entry.name);
@@ -67,7 +51,8 @@ export default segmentSchema;`;
67
51
  const relativePath = path.relative(schemaOutAbsolutePath, absolutePath);
68
52
  const segmentName = relativePath.replace(/\\/g, '/').slice(0, -5); // Remove '.json' extension
69
53
  if (!segmentNames.includes(segmentName) &&
70
- !segmentNames.includes(segmentName.replace(ROOT_SEGMENT_SCHEMA_NAME, ''))) {
54
+ !segmentNames.includes(segmentName.replace(ROOT_SEGMENT_FILE_NAME, '')) &&
55
+ !allow.includes(entry.name)) {
71
56
  await fs.unlink(absolutePath);
72
57
  projectInfo?.log.debug(`Deleted unnecessary schema file for ${formatLoggedSegmentName(segmentName)}`);
73
58
  hasChanged = true;
@@ -75,9 +60,8 @@ export default segmentSchema;`;
75
60
  }
76
61
  }));
77
62
  }
78
- // Start the recursive deletion from the root directory
79
63
  await deleteUnnecessaryJsonFiles(schemaOutAbsolutePath);
80
64
  if (hasChanged)
81
- projectInfo?.log.info(`Schema files updated in ${Date.now() - now}ms`);
65
+ projectInfo?.log.info(`Created empty schema files in ${Date.now() - now}ms`);
82
66
  }
83
67
  export const debouncedEnsureSchemaFiles = debounce(ensureSchemaFiles, 1000);