vovk-cli 0.0.1-beta.7 → 0.0.1-beta.71

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 (166) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +37 -1
  3. package/client-templates/jsBase/index.d.mts.ejs +21 -0
  4. package/client-templates/jsBase/index.mjs.ejs +18 -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/openapiJs/openapi.d.ts.ejs +4 -0
  8. package/client-templates/openapiJs/openapi.js.ejs +4 -0
  9. package/client-templates/openapiJson/openapi.json.ejs +1 -0
  10. package/client-templates/openapiTs/openapi.ts.ejs +4 -0
  11. package/client-templates/packageJson/package.json.ejs +1 -0
  12. package/client-templates/readme/README.md.ejs +39 -0
  13. package/client-templates/schemaJs/schema.d.js.ejs +10 -0
  14. package/client-templates/schemaJs/schema.js.ejs +29 -0
  15. package/client-templates/schemaJson/schema.json.ejs +1 -0
  16. package/client-templates/schemaTs/schema.ts.ejs +28 -0
  17. package/client-templates/tsBase/index.ts.ejs +27 -0
  18. package/dist/bundle/index.d.mts +8 -0
  19. package/dist/bundle/index.mjs +76 -0
  20. package/dist/dev/diffSegmentSchema.d.mts +36 -0
  21. package/dist/{server/diffMetadata.mjs → dev/diffSegmentSchema.mjs} +4 -12
  22. package/dist/dev/ensureSchemaFiles.d.mts +6 -0
  23. package/dist/dev/ensureSchemaFiles.mjs +67 -0
  24. package/dist/dev/index.d.mts +8 -0
  25. package/dist/dev/index.mjs +399 -0
  26. package/dist/dev/logDiffResult.d.mts +3 -0
  27. package/dist/dev/logDiffResult.mjs +57 -0
  28. package/dist/dev/writeMetaJson.d.mts +2 -0
  29. package/dist/dev/writeMetaJson.mjs +19 -0
  30. package/dist/dev/writeOneSegmentSchemaFile.d.mts +12 -0
  31. package/dist/dev/writeOneSegmentSchemaFile.mjs +32 -0
  32. package/dist/generate/ensureClient.d.mts +3 -0
  33. package/dist/generate/ensureClient.mjs +28 -0
  34. package/dist/generate/generate.d.mts +13 -0
  35. package/dist/generate/generate.mjs +306 -0
  36. package/dist/generate/getClientTemplateFiles.d.mts +20 -0
  37. package/dist/generate/getClientTemplateFiles.mjs +85 -0
  38. package/dist/generate/getProjectFullSchema.d.mts +9 -0
  39. package/dist/generate/getProjectFullSchema.mjs +64 -0
  40. package/dist/generate/getTemplateClientImports.d.mts +18 -0
  41. package/dist/generate/getTemplateClientImports.mjs +36 -0
  42. package/dist/generate/index.d.mts +33 -0
  43. package/dist/generate/index.mjs +186 -0
  44. package/dist/generate/writeOneClientFile.d.mts +43 -0
  45. package/dist/generate/writeOneClientFile.mjs +148 -0
  46. package/dist/getProjectInfo/getConfig/getConfigAbsolutePaths.d.mts +5 -0
  47. package/dist/getProjectInfo/getConfig/getConfigAbsolutePaths.mjs +25 -0
  48. package/dist/getProjectInfo/getConfig/getRelativeSrcRoot.d.mts +3 -0
  49. package/dist/getProjectInfo/getConfig/getRelativeSrcRoot.mjs +12 -0
  50. package/dist/getProjectInfo/getConfig/getTemplateDefs.d.mts +25 -0
  51. package/dist/getProjectInfo/getConfig/getTemplateDefs.mjs +168 -0
  52. package/dist/getProjectInfo/getConfig/getUserConfig.d.mts +9 -0
  53. package/dist/getProjectInfo/getConfig/getUserConfig.mjs +143 -0
  54. package/dist/getProjectInfo/getConfig/index.d.mts +15 -0
  55. package/dist/getProjectInfo/getConfig/index.mjs +92 -0
  56. package/dist/getProjectInfo/getMetaSchema.d.mts +4 -0
  57. package/dist/getProjectInfo/getMetaSchema.mjs +12 -0
  58. package/dist/getProjectInfo/index.d.mts +16 -13
  59. package/dist/getProjectInfo/index.mjs +28 -32
  60. package/dist/index.d.mts +4 -3
  61. package/dist/index.mjs +153 -37
  62. package/dist/init/checkTSConfigForExperimentalDecorators.d.mts +1 -0
  63. package/dist/init/checkTSConfigForExperimentalDecorators.mjs +15 -0
  64. package/dist/init/createConfig.d.mts +11 -0
  65. package/dist/init/createConfig.mjs +65 -0
  66. package/dist/init/index.d.mts +8 -0
  67. package/dist/init/index.mjs +257 -0
  68. package/dist/init/installDependencies.d.mts +12 -0
  69. package/dist/init/installDependencies.mjs +32 -0
  70. package/dist/init/logUpdateDependenciesError.d.mts +11 -0
  71. package/dist/init/logUpdateDependenciesError.mjs +49 -0
  72. package/dist/init/updateDependenciesWithoutInstalling.d.mts +9 -0
  73. package/dist/init/updateDependenciesWithoutInstalling.mjs +60 -0
  74. package/dist/init/updateNPMScripts.d.mts +8 -0
  75. package/dist/init/updateNPMScripts.mjs +21 -0
  76. package/dist/init/updateTypeScriptConfig.d.mts +4 -0
  77. package/dist/init/updateTypeScriptConfig.mjs +19 -0
  78. package/dist/new/addClassToSegmentCode.d.mts +5 -0
  79. package/dist/new/addClassToSegmentCode.mjs +36 -0
  80. package/dist/new/addCommonTerms.d.mts +1 -0
  81. package/dist/new/addCommonTerms.mjs +92 -0
  82. package/dist/new/index.d.mts +3 -0
  83. package/dist/new/index.mjs +38 -0
  84. package/dist/new/newModule.d.mts +12 -0
  85. package/dist/new/newModule.mjs +119 -0
  86. package/dist/new/newSegment.d.mts +8 -0
  87. package/dist/new/newSegment.mjs +42 -0
  88. package/dist/new/render.d.mts +13 -0
  89. package/dist/new/render.mjs +57 -0
  90. package/dist/types.d.mts +91 -24
  91. package/dist/utils/chalkHighlightThing.d.mts +1 -0
  92. package/dist/utils/chalkHighlightThing.mjs +4 -0
  93. package/dist/utils/compileJSONSchemaToTypeScriptType.d.mts +5 -0
  94. package/dist/utils/compileJSONSchemaToTypeScriptType.mjs +9 -0
  95. package/dist/utils/compileTs.d.mts +12 -0
  96. package/dist/utils/compileTs.mjs +261 -0
  97. package/dist/utils/debounceWithArgs.d.mts +1 -2
  98. package/dist/utils/debounceWithArgs.mjs +25 -9
  99. package/dist/utils/formatLoggedSegmentName.d.mts +6 -0
  100. package/dist/utils/formatLoggedSegmentName.mjs +8 -0
  101. package/dist/utils/generateFnName.d.mts +23 -0
  102. package/dist/utils/generateFnName.mjs +76 -0
  103. package/dist/utils/getAvailablePort.d.mts +1 -2
  104. package/dist/utils/getAvailablePort.mjs +4 -4
  105. package/dist/utils/getFileSystemEntryType.d.mts +5 -0
  106. package/dist/utils/getFileSystemEntryType.mjs +23 -0
  107. package/dist/utils/getLogger.d.mts +8 -0
  108. package/dist/utils/getLogger.mjs +13 -0
  109. package/dist/utils/getNPMPackageMetadata.d.mts +17 -0
  110. package/dist/utils/getNPMPackageMetadata.mjs +9 -0
  111. package/dist/utils/getPackageJson.d.mts +3 -0
  112. package/dist/utils/getPackageJson.mjs +23 -0
  113. package/dist/utils/getPublicModuleNameFromPath.d.mts +4 -0
  114. package/dist/utils/getPublicModuleNameFromPath.mjs +9 -0
  115. package/dist/utils/locateSegments.d.mts +12 -0
  116. package/dist/{locateSegments.mjs → utils/locateSegments.mjs} +18 -8
  117. package/dist/utils/normalizeOpenAPIMixin.d.mts +15 -0
  118. package/dist/utils/normalizeOpenAPIMixin.mjs +96 -0
  119. package/dist/utils/pickSegmentFullSchema.d.mts +3 -0
  120. package/dist/utils/pickSegmentFullSchema.mjs +15 -0
  121. package/dist/utils/prettify.d.mts +1 -0
  122. package/dist/utils/prettify.mjs +10 -0
  123. package/dist/utils/removeUnlistedDirectories.d.mts +9 -0
  124. package/dist/utils/removeUnlistedDirectories.mjs +60 -0
  125. package/dist/utils/resolveAbsoluteModulePath.d.mts +2 -0
  126. package/dist/utils/resolveAbsoluteModulePath.mjs +32 -0
  127. package/dist/utils/updateConfigProperty.d.mts +2 -0
  128. package/dist/utils/updateConfigProperty.mjs +131 -0
  129. package/module-templates/arktype/controller.ts.ejs +97 -0
  130. package/module-templates/type/controller.ts.ejs +82 -0
  131. package/module-templates/type/service.ts.ejs +43 -0
  132. package/module-templates/valibot/controller.ts.ejs +97 -0
  133. package/module-templates/zod/controller.ts.ejs +104 -0
  134. package/package.json +61 -13
  135. package/dist/getProjectInfo/directoryExists.d.mts +0 -1
  136. package/dist/getProjectInfo/directoryExists.mjs +0 -10
  137. package/dist/getProjectInfo/getConfig.d.mts +0 -7
  138. package/dist/getProjectInfo/getConfig.mjs +0 -23
  139. package/dist/getProjectInfo/getCwdPath.d.mts +0 -1
  140. package/dist/getProjectInfo/getCwdPath.mjs +0 -13
  141. package/dist/getProjectInfo/getSrcRoot.d.mts +0 -1
  142. package/dist/getProjectInfo/getSrcRoot.mjs +0 -13
  143. package/dist/getProjectInfo/readConfig.d.mts +0 -3
  144. package/dist/getProjectInfo/readConfig.mjs +0 -35
  145. package/dist/init.d.mts +0 -2
  146. package/dist/init.mjs +0 -171
  147. package/dist/locateSegments.d.mts +0 -5
  148. package/dist/postinstall.d.mts +0 -1
  149. package/dist/postinstall.mjs +0 -22
  150. package/dist/server/createMetadataServer.d.mts +0 -5
  151. package/dist/server/createMetadataServer.mjs +0 -25
  152. package/dist/server/diffMetadata.d.mts +0 -43
  153. package/dist/server/ensureMetadataFiles.d.mts +0 -3
  154. package/dist/server/ensureMetadataFiles.mjs +0 -70
  155. package/dist/server/generateClient.d.mts +0 -7
  156. package/dist/server/generateClient.mjs +0 -92
  157. package/dist/server/index.d.mts +0 -6
  158. package/dist/server/index.mjs +0 -256
  159. package/dist/server/isMetadataEmpty.d.mts +0 -2
  160. package/dist/server/isMetadataEmpty.mjs +0 -4
  161. package/dist/server/logDiffResult.d.mts +0 -3
  162. package/dist/server/logDiffResult.mjs +0 -78
  163. package/dist/server/writeOneMetadataFile.d.mts +0 -11
  164. package/dist/server/writeOneMetadataFile.mjs +0 -27
  165. package/dist/utils/fileExists.d.mts +0 -1
  166. package/dist/utils/fileExists.mjs +0 -10
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,37 @@
1
- Description is coming soon.
1
+ <p align="center">
2
+ <a href="https://vovk.dev">
3
+ <picture>
4
+ <source width="300" media="(prefers-color-scheme: dark)" srcset="https://vovk.dev/vovk-logo-white.svg">
5
+ <source width="300" media="(prefers-color-scheme: light)" srcset="https://vovk.dev/vovk-logo.svg">
6
+ <img width="300" alt="vovk" src="https://vovk.dev/vovk-logo.svg">
7
+ </picture>
8
+ </a>
9
+ <br>
10
+ <strong>Back-end Framework for Next.js App Router</strong>
11
+ <br />
12
+ <a href="https://vovk.dev/">Documentation</a>
13
+ &nbsp;&nbsp;
14
+ <a href="https://vovk.dev/quick-install">Quick Start</a>
15
+ &nbsp;&nbsp;
16
+ <a href="https://vovk.dev/performance">Performance</a>
17
+ </p>
18
+
19
+ ---
20
+
21
+ ## vovk-cli [![npm version](https://badge.fury.io/js/vovk-cli.svg)](https://www.npmjs.com/package/vovk-cli)
22
+
23
+ Vovk.ts CLI that will be used as a devDependency in a Vovk.ts app.
24
+
25
+ ```sh
26
+ npm install -D vovk-cli
27
+ ```
28
+
29
+ - [vovk dev](https://vovk.dev/dev) - starts the development script that watches the changes in [controllers](https://vovk.dev/controller) and regenerates the [schema](https://vovk.dev/schema) and [client](https://vovk.dev/typescript)
30
+ - [vovk generate](https://vovk.dev/generate) - generates the client based on the schema
31
+ - [vovk bundle](https://vovk.dev/bundle) - bundles the client with [tsdown](https://tsdown.dev/)
32
+ - [vovk init](https://vovk.dev/init) - initializes a new Vovk.ts project
33
+ - [vovk new](https://vovk.dev/new) - generates a new controller, service or a custom module
34
+
35
+ ```sh
36
+ npx vovk-cli --help
37
+ ```
@@ -0,0 +1,21 @@
1
+ <%- t.getFirstLineBanner() %>
2
+ import type { VovkFetcher } from 'vovk/fetcher';
3
+ import type { createRPC } from '<%= t.commonImports.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].fetcher %>').fetcher extends VovkFetcher<infer U> ? U : never>>;
16
+ <% })
17
+ }) %>
18
+ export { schema } from './schema.cjs';
19
+ <% if (t.hasMixins) { %>
20
+ export { Mixins };
21
+ <% } %>
@@ -0,0 +1,18 @@
1
+ <%- t.getFirstLineBanner() %>
2
+ import { createRPC } from '<%= t.commonImports.createRPC %>';
3
+ import { schema } from './schema.js';
4
+ <% Object.entries(t.reExports).forEach(([reExportWhat, reExportFrom]) => { %>
5
+ export { <%= reExportWhat %> } from '<%= reExportFrom %>';
6
+ <% }) %>
7
+ <% Object.values(t.schema.segments).filter((segment) => segment.emitSchema).forEach((segment, i) => { %>
8
+ <% Object.keys(segment.controllers).forEach((rpcModuleName) => {
9
+ const apiRoot = t.segmentMeta[segment.segmentName].forceApiRoot ?? t.apiRoot; %>
10
+ export const <%= rpcModuleName %> = createRPC(
11
+ schema, '<%= segment.segmentName %>', '<%= rpcModuleName %>', import('<%- t.segmentImports[segment.segmentName].fetcher %>'),
12
+ { validateOnClient: <%- t.segmentImports[segment.segmentName].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 ? `apiRoot: '${apiRoot}'` : '' %> }
13
+ );
14
+ <%
15
+ });
16
+ });
17
+ %>
18
+ export { schema };
@@ -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,4 @@
1
+ <%- t.getFirstLineBanner() %>
2
+ import type { OpenAPIObject } from 'openapi3-ts/oas31';
3
+
4
+ export const openapi: OpenAPIObject;
@@ -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.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.operationObject?.summary ? `> ${handlerSchema.operationObject.summary}` : '' %>
22
+
23
+ <%- handlerSchema.operationObject?.description ? `${handlerSchema.operationObject.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,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,29 @@
1
+ <%- t.getFirstLineBanner() %>
2
+ <% if(t.isVovkProject) { %>
3
+ import meta from './<%= t.schemaOutDir %>/_meta.json' with { type: 'json' };
4
+ <% } else { %>
5
+ const meta = <%- JSON.stringify(t.schema.meta, null, 2) %>;
6
+ <% } %>
7
+
8
+ <% if(t.hasMixins) { %>
9
+ import mixins from './mixins.json' with { type: 'json' };
10
+ <% } %>
11
+ <% Object.values(t.schema.segments).filter((segment) => segment.emitSchema && segment.segmentType !== 'mixin').forEach((segment, i) => { %>
12
+ import schema<%= i %> from './<%= t.schemaOutDir %>/<%= segment.segmentName || t.ROOT_SEGMENT_FILE_NAME %>.json' with { type: 'json' };
13
+ <% }) %>
14
+
15
+ const segments = {<% Object.values(t.schema.segments).filter((segment) => segment.emitSchema && segment.segmentType !== 'mixin').forEach((segment, i) => { %>
16
+ '<%= segment.segmentName %>': schema<%= i %>,
17
+ <% }) %>
18
+ <% if(t.hasMixins) { %>
19
+ ...mixins,
20
+ <% } %>
21
+ };
22
+
23
+ const schema = {
24
+ $schema: '<%- t.VovkSchemaIdEnum.SCHEMA %>',
25
+ segments,
26
+ meta,
27
+ };
28
+
29
+ export { schema };
@@ -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.schema.meta, 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/fetcher';
3
+ import { createRPC } from '<%= t.commonImports.createRPC %>';
4
+ import { schema } from './schema<%= t.nodeNextResolutionExt.ts %>';
5
+ <% Object.values(t.schema.segments).filter((segment) => segment.emitSchema).forEach((segment, i) => { if(segment.segmentType !== 'mixin') { %>
6
+ import type { Controllers as Controllers<%= i %> } from "<%= t.segmentMeta[segment.segmentName].segmentImportPath %>";
7
+ <% }
8
+ });
9
+ if (t.hasMixins) { %>
10
+ import type { Controllers as MixinControllers, Mixins } from "./mixins.d.ts";
11
+ <% } %>
12
+ <% Object.entries(t.reExports).forEach(([reExportWhat, reExportFrom]) => { %>
13
+ export { <%= reExportWhat %> } from '<%= reExportFrom %>';
14
+ <% }) %>
15
+ <% Object.values(t.schema.segments).filter((segment) => segment.emitSchema).forEach((segment, i) => {
16
+ Object.keys(segment.controllers).forEach((rpcModuleName) => {
17
+ const apiRoot = t.segmentMeta[segment.segmentName].forceApiRoot ?? t.apiRoot; %>
18
+ export const <%= rpcModuleName %> = createRPC<<%= segment.segmentType === 'mixin' ? `MixinControllers` : `Controllers${i}` %>["<%= rpcModuleName %>"], typeof import('<%- t.segmentImports[segment.segmentName].fetcher %>').fetcher extends VovkFetcher<infer U> ? U : never>(
19
+ schema, '<%= segment.segmentName %>', '<%= rpcModuleName %>', import('<%- t.segmentImports[segment.segmentName].fetcher %>'),
20
+ { validateOnClient: <%- t.segmentImports[segment.segmentName].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 ? `apiRoot: '${apiRoot}'` : '' %> }
21
+ );
22
+ <% })
23
+ }) %>
24
+ export { schema };
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,76 @@
1
+ import path from 'node:path';
2
+ import fs from 'node:fs/promises';
3
+ import groupBy from 'lodash/groupBy.js';
4
+ import { generate } from '../generate/generate.mjs';
5
+ import { BuiltInTemplateName } from '../getProjectInfo/getConfig/getTemplateDefs.mjs';
6
+ import { chalkHighlightThing } from '../utils/chalkHighlightThing.mjs';
7
+ import { locateSegments } from '../utils/locateSegments.mjs';
8
+ export async function bundle({ projectInfo, fullSchema, cliBundleOptions, }) {
9
+ const { config, log, cwd, apiDirAbsolutePath } = projectInfo;
10
+ const locatedSegments = await locateSegments({ dir: apiDirAbsolutePath, config, log });
11
+ const { bundle: bundleConfig } = config;
12
+ const keepPrebundleDir = cliBundleOptions?.keepPrebundleDir ?? bundleConfig?.keepPrebundleDir ?? false;
13
+ const prebundleOutDirAbsolute = path.resolve(cwd, cliBundleOptions?.prebundleOutDir ?? bundleConfig.prebundleOutDir);
14
+ const entry = path.join(prebundleOutDirAbsolute, 'index.ts');
15
+ const outDir = cliBundleOptions?.outDir ?? bundleConfig.outDir;
16
+ if (!outDir) {
17
+ throw new Error('No output directory specified for bundling');
18
+ }
19
+ const outDirAbsolute = path.resolve(cwd, outDir);
20
+ await generate({
21
+ isEnsuringClient: false,
22
+ isBundle: true,
23
+ projectInfo,
24
+ forceNothingWrittenLog: true,
25
+ fullSchema,
26
+ locatedSegments,
27
+ cliGenerateOptions: {
28
+ schemaPath: cliBundleOptions?.schemaPath,
29
+ origin: cliBundleOptions?.origin,
30
+ openapiSpec: cliBundleOptions?.openapiSpec,
31
+ openapiGetModuleName: cliBundleOptions?.openapiGetModuleName,
32
+ openapiGetMethodName: cliBundleOptions?.openapiGetMethodName,
33
+ openapiRootUrl: cliBundleOptions?.openapiRootUrl,
34
+ openapiMixinName: cliBundleOptions?.openapiMixinName,
35
+ openapiFallback: cliBundleOptions?.openapiFallback,
36
+ composedFrom: [BuiltInTemplateName.tsBase],
37
+ composedOut: prebundleOutDirAbsolute,
38
+ composedOnly: true,
39
+ composedIncludeSegments: cliBundleOptions.includeSegments ?? bundleConfig.includeSegments,
40
+ composedExcludeSegments: cliBundleOptions.excludeSegments ?? bundleConfig.excludeSegments,
41
+ },
42
+ });
43
+ log.debug(`Bundling ${chalkHighlightThing(entry)} to ${chalkHighlightThing(outDirAbsolute)}`);
44
+ await bundleConfig.build({
45
+ outDir: outDirAbsolute,
46
+ prebundleDir: prebundleOutDirAbsolute,
47
+ entry,
48
+ });
49
+ log.debug(`Bundled index.ts to ${chalkHighlightThing(outDirAbsolute)}`);
50
+ const requiresGroup = groupBy(Object.entries(bundleConfig.requires), ([, relativePath]) => relativePath);
51
+ for (const [relativePath, group] of Object.entries(requiresGroup)) {
52
+ await generate({
53
+ isEnsuringClient: false,
54
+ isBundle: true,
55
+ projectInfo,
56
+ forceNothingWrittenLog: true,
57
+ fullSchema,
58
+ locatedSegments,
59
+ cliGenerateOptions: {
60
+ schemaPath: cliBundleOptions?.schemaPath,
61
+ origin: cliBundleOptions?.origin,
62
+ composedFrom: group.map(([templateName]) => templateName),
63
+ composedOut: path.resolve(outDirAbsolute, relativePath),
64
+ composedOnly: true,
65
+ },
66
+ });
67
+ }
68
+ if (!keepPrebundleDir) {
69
+ await fs.rm(prebundleOutDirAbsolute, { recursive: true, force: true });
70
+ log.debug(`Deleted temporary TypeScript client output directory: ${chalkHighlightThing(prebundleOutDirAbsolute)}`);
71
+ }
72
+ else {
73
+ log.debug(`Temporary TypeScript client output directory not deleted because it is marked to keep: ${chalkHighlightThing(prebundleOutDirAbsolute)}`);
74
+ }
75
+ log.info(`Bundled TypeScript client to ${chalkHighlightThing(outDirAbsolute)}`);
76
+ }
@@ -0,0 +1,36 @@
1
+ import type { VovkControllerSchema, VovkSegmentSchema } from 'vovk/internal';
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 declare 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 diffMetadata(oldJson, newJson) {
66
- const workersDiff = diffWorkersOrControllers(oldJson.workers ?? {}, newJson.workers ?? {});
67
- const controllersDiff = diffWorkersOrControllers(oldJson.controllers ?? {}, newJson.controllers ?? {});
60
+ export function diffSegmentSchema(oldJson, newJson) {
68
61
  return {
69
- workers: workersDiff,
70
- controllers: controllersDiff,
62
+ controllers: diffControllers(oldJson.controllers ?? {}, newJson.controllers ?? {}),
71
63
  };
72
64
  }
@@ -0,0 +1,6 @@
1
+ import { ProjectInfo } from '../getProjectInfo/index.mjs';
2
+ /**
3
+ * Ensure that the schema files are created to avoid any import errors.
4
+ */
5
+ export declare function ensureSchemaFiles(projectInfo: ProjectInfo, schemaOutAbsolutePath: string, segmentNames: string[]): Promise<void>;
6
+ export declare const debouncedEnsureSchemaFiles: import("lodash").DebouncedFunc<typeof ensureSchemaFiles>;
@@ -0,0 +1,67 @@
1
+ import fs from 'node:fs/promises';
2
+ import path from 'node:path';
3
+ import debounce from 'lodash/debounce.js';
4
+ import { VovkSchemaIdEnum } from 'vovk/internal';
5
+ import { writeOneSegmentSchemaFile, META_FILE_NAME, ROOT_SEGMENT_FILE_NAME } from './writeOneSegmentSchemaFile.mjs';
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
+ */
11
+ export async function ensureSchemaFiles(projectInfo, schemaOutAbsolutePath, segmentNames) {
12
+ const now = Date.now();
13
+ let hasChanged = false;
14
+ await fs.mkdir(schemaOutAbsolutePath, { recursive: true });
15
+ await writeMetaJson(schemaOutAbsolutePath, projectInfo);
16
+ // Create JSON files (if not exist) with name [segmentName].json (where segmentName can include /, which means the folder structure can be nested)
17
+ await Promise.all(segmentNames.map(async (segmentName) => {
18
+ const { isCreated } = await writeOneSegmentSchemaFile({
19
+ schemaOutAbsolutePath,
20
+ segmentSchema: {
21
+ $schema: VovkSchemaIdEnum.SEGMENT,
22
+ emitSchema: false,
23
+ segmentName,
24
+ segmentType: 'segment',
25
+ controllers: {},
26
+ },
27
+ skipIfExists: true,
28
+ });
29
+ if (isCreated) {
30
+ projectInfo?.log.debug(`Created empty schema file for ${formatLoggedSegmentName(segmentName)}`);
31
+ hasChanged = true;
32
+ }
33
+ }));
34
+ // Recursive function to delete unnecessary JSON files and folders
35
+ async function deleteUnnecessaryJsonFiles(dirPath, allow = [`${META_FILE_NAME}.json`]) {
36
+ const entries = await fs.readdir(dirPath, { withFileTypes: true });
37
+ await Promise.all(entries.map(async (entry) => {
38
+ const absolutePath = path.join(dirPath, entry.name);
39
+ if (entry.isDirectory()) {
40
+ // Recursively delete unnecessary files and folders within nested directories
41
+ await deleteUnnecessaryJsonFiles(absolutePath);
42
+ // Check if the directory is empty after deletion and remove it if so
43
+ const remainingEntries = await fs.readdir(absolutePath);
44
+ if (remainingEntries.length === 0) {
45
+ await fs.rmdir(absolutePath);
46
+ projectInfo?.log.debug(`Deleted unnecessary schema directory "${absolutePath}"`);
47
+ hasChanged = true;
48
+ }
49
+ }
50
+ else if (entry.isFile() && entry.name.endsWith('.json')) {
51
+ const relativePath = path.relative(schemaOutAbsolutePath, absolutePath);
52
+ const segmentName = relativePath.replace(/\\/g, '/').slice(0, -5); // Remove '.json' extension
53
+ if (!segmentNames.includes(segmentName) &&
54
+ !segmentNames.includes(segmentName.replace(ROOT_SEGMENT_FILE_NAME, '')) &&
55
+ !allow.includes(entry.name)) {
56
+ await fs.unlink(absolutePath);
57
+ projectInfo?.log.debug(`Deleted unnecessary schema file for ${formatLoggedSegmentName(segmentName)}`);
58
+ hasChanged = true;
59
+ }
60
+ }
61
+ }));
62
+ }
63
+ await deleteUnnecessaryJsonFiles(schemaOutAbsolutePath);
64
+ if (hasChanged)
65
+ projectInfo?.log.info(`Created empty schema files in ${Date.now() - now}ms`);
66
+ }
67
+ export const debouncedEnsureSchemaFiles = debounce(ensureSchemaFiles, 1000);
@@ -0,0 +1,8 @@
1
+ import type { DevOptions } from '../types.mjs';
2
+ export declare class VovkDev {
3
+ #private;
4
+ constructor({ schemaOut, devHttps, logLevel }: Pick<DevOptions, 'schemaOut' | 'devHttps' | 'logLevel'>);
5
+ start({ exit }: {
6
+ exit: boolean;
7
+ }): Promise<void>;
8
+ }