vovk-cli 0.0.1-draft.34 → 0.0.1-draft.341

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 (140) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +29 -1
  3. package/client-templates/cjs/index.cjs.ejs +20 -0
  4. package/client-templates/cjs/index.d.cts.ejs +23 -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 +23 -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 +23 -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 +31 -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 +102 -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 +192 -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 +292 -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 +10 -0
  41. package/dist/generate/getProjectFullSchema.mjs +64 -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 +191 -0
  46. package/dist/generate/writeOneClientFile.d.mts +40 -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 +76 -0
  58. package/dist/getProjectInfo/getConfig/index.mjs +91 -0
  59. package/dist/getProjectInfo/getMetaSchema.d.mts +36 -0
  60. package/dist/getProjectInfo/getMetaSchema.mjs +35 -0
  61. package/dist/getProjectInfo/index.d.mts +14 -9
  62. package/dist/getProjectInfo/index.mjs +24 -23
  63. package/dist/index.d.mts +2 -2
  64. package/dist/index.mjs +119 -40
  65. package/dist/init/createConfig.d.mts +2 -2
  66. package/dist/init/createConfig.mjs +39 -13
  67. package/dist/init/createStandardSchemaValidatorFile.d.mts +4 -0
  68. package/dist/init/createStandardSchemaValidatorFile.mjs +39 -0
  69. package/dist/init/getTemplateFilesFromPackage.mjs +10 -5
  70. package/dist/init/index.d.mts +2 -2
  71. package/dist/init/index.mjs +114 -66
  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 +4 -2
  88. package/dist/new/newModule.d.mts +4 -1
  89. package/dist/new/newModule.mjs +18 -17
  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 +29 -8
  94. package/dist/types.d.mts +64 -42
  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/formatLoggedSegmentName.d.mts +3 -1
  102. package/dist/utils/formatLoggedSegmentName.mjs +3 -2
  103. package/dist/utils/generateFnName.d.mts +23 -0
  104. package/dist/utils/generateFnName.mjs +76 -0
  105. package/dist/utils/getPackageJson.d.mts +3 -0
  106. package/dist/utils/getPackageJson.mjs +22 -0
  107. package/dist/utils/getPublicModuleNameFromPath.d.mts +4 -0
  108. package/dist/utils/getPublicModuleNameFromPath.mjs +9 -0
  109. package/dist/utils/normalizeOpenAPIMixin.d.mts +14 -0
  110. package/dist/utils/normalizeOpenAPIMixin.mjs +114 -0
  111. package/dist/utils/pickSegmentFullSchema.d.mts +3 -0
  112. package/dist/utils/pickSegmentFullSchema.mjs +15 -0
  113. package/dist/utils/removeUnlistedDirectories.d.mts +10 -0
  114. package/dist/utils/removeUnlistedDirectories.mjs +61 -0
  115. package/dist/utils/resolveAbsoluteModulePath.d.mts +2 -0
  116. package/dist/utils/resolveAbsoluteModulePath.mjs +32 -0
  117. package/module-templates/arktype/controller.ts.ejs +68 -0
  118. package/module-templates/type/controller.ts.ejs +56 -0
  119. package/module-templates/type/service.ts.ejs +28 -0
  120. package/module-templates/valibot/controller.ts.ejs +68 -0
  121. package/package.json +35 -22
  122. package/dist/dev/diffSchema.d.mts +0 -43
  123. package/dist/dev/ensureClient.d.mts +0 -5
  124. package/dist/dev/ensureClient.mjs +0 -31
  125. package/dist/dev/isMetadataEmpty.d.mts +0 -2
  126. package/dist/dev/isMetadataEmpty.mjs +0 -4
  127. package/dist/dev/writeOneSchemaFile.d.mts +0 -11
  128. package/dist/generateClient.d.mts +0 -7
  129. package/dist/generateClient.mjs +0 -99
  130. package/dist/getProjectInfo/getConfig.d.mts +0 -11
  131. package/dist/getProjectInfo/getConfig.mjs +0 -29
  132. package/dist/getProjectInfo/getConfigAbsolutePaths.d.mts +0 -4
  133. package/dist/postinstall.d.mts +0 -1
  134. package/dist/postinstall.mjs +0 -24
  135. package/templates/controller.ejs +0 -52
  136. package/templates/service.ejs +0 -27
  137. package/templates/worker.ejs +0 -24
  138. /package/dist/getProjectInfo/{importUncachedModule.d.mts → getConfig/importUncachedModule.d.mts} +0 -0
  139. /package/dist/getProjectInfo/{importUncachedModuleWorker.d.mts → getConfig/importUncachedModuleWorker.d.mts} +0 -0
  140. /package/dist/getProjectInfo/{importUncachedModuleWorker.mjs → getConfig/importUncachedModuleWorker.mjs} +0 -0
@@ -0,0 +1,4 @@
1
+ export declare function createStandardSchemaValidatorFile({ root, validationLibrary, }: {
2
+ root: string;
3
+ validationLibrary: 'arktype' | 'valibot';
4
+ }): Promise<void>;
@@ -0,0 +1,39 @@
1
+ import fs from 'fs/promises';
2
+ import path from 'path';
3
+ import getRelativeSrcRoot from '../getProjectInfo/getConfig/getRelativeSrcRoot.mjs';
4
+ function getCode(validationLibrary) {
5
+ if (validationLibrary === 'valibot') {
6
+ return `
7
+ import { createStandardValidation, KnownAny } from 'vovk';
8
+ import { toJsonSchema } from '@valibot/to-json-schema';
9
+ import * as v from 'valibot';
10
+
11
+ const withValibot = createStandardValidation({
12
+ toJSONSchema: (model: v.BaseSchema<KnownAny, KnownAny, KnownAny>) => toJsonSchema(model),
13
+ });
14
+
15
+ export default withValibot;
16
+ `.trimStart();
17
+ }
18
+ if (validationLibrary === 'arktype') {
19
+ return `
20
+ import { createStandardValidation } from 'vovk';
21
+ import { type } from 'arktype';
22
+
23
+ const withArk = createStandardValidation({
24
+ toJSONSchema: (model: type) => model.toJsonSchema(),
25
+ });
26
+
27
+ export default withArk;
28
+ `.trimStart();
29
+ }
30
+ throw new Error(`Unknown validation library: ${validationLibrary}`);
31
+ }
32
+ export async function createStandardSchemaValidatorFile({ root, validationLibrary, }) {
33
+ const code = getCode(validationLibrary);
34
+ const srcRoot = (await getRelativeSrcRoot({ cwd: root })) ?? '.';
35
+ const libDir = path.resolve(root, srcRoot, 'lib');
36
+ const filePath = path.join(libDir, `${validationLibrary === 'arktype' ? 'withArk' : 'withValibot'}.ts`);
37
+ await fs.mkdir(libDir, { recursive: true });
38
+ await fs.writeFile(filePath, code);
39
+ }
@@ -2,7 +2,6 @@ import { Readable } from 'node:stream';
2
2
  import { createGunzip } from 'node:zlib';
3
3
  import tar from 'tar-stream';
4
4
  import getNPMPackageMetadata from '../utils/getNPMPackageMetadata.mjs';
5
- // Crereated with AI
6
5
  /**
7
6
  * Retrieves a list of files in the 'templates' folder of an NPM package.
8
7
  * @param packageName - The name of the NPM package.
@@ -22,8 +21,14 @@ export default async function getTemplateFilesFromPackage(packageName, channel =
22
21
  // Extract the tarball in memory and collect template files
23
22
  const templateFiles = await extractTemplatesFromTarball(tarballBuffer);
24
23
  const entries = templateFiles
25
- .filter((fileName) => fileName.startsWith('templates/') && !fileName.endsWith('/') && fileName.endsWith('.ejs'))
26
- .map((fileName) => [fileName.substring('templates/'.length).replace(/\.ejs$/, ''), `${packageName}/${fileName}`]);
24
+ .filter((fileName) => fileName.startsWith('module-templates/') && !fileName.endsWith('/') && fileName.endsWith('.ts.ejs'))
25
+ .map((fileName) => [
26
+ fileName
27
+ .substring('module-templates/'.length)
28
+ .replace(/\.ts\.ejs$/, '')
29
+ .toLowerCase(),
30
+ `${packageName}/${fileName}`,
31
+ ]);
27
32
  return Object.fromEntries(entries);
28
33
  }
29
34
  /**
@@ -37,8 +42,8 @@ function extractTemplatesFromTarball(tarballBuffer) {
37
42
  const files = [];
38
43
  extract.on('entry', (header, stream, next) => {
39
44
  const filePath = header.name;
40
- // Check if the file is in the 'templates' folder
41
- if (filePath.startsWith('package/templates/')) {
45
+ // Check if the file is in the 'module-templates' folder
46
+ if (filePath.startsWith('package/module-templates/')) {
42
47
  files.push(filePath.replace('package/', ''));
43
48
  }
44
49
  stream.on('end', () => next());
@@ -1,8 +1,8 @@
1
- import type { InitOptions } from '../types.mjs';
2
1
  import getLogger from '../utils/getLogger.mjs';
2
+ import type { InitOptions } from '../types.mjs';
3
3
  export declare class Init {
4
4
  #private;
5
5
  root: string;
6
6
  log: ReturnType<typeof getLogger>;
7
- main(prefix: string, { yes, logLevel, useNpm, useYarn, usePnpm, useBun, skipInstall, updateTsConfig, updateScripts, validationLibrary, validateOnClient, dryRun, channel, }: InitOptions): Promise<void>;
7
+ main({ prefix, yes, logLevel, useNpm, useYarn, usePnpm, useBun, skipInstall, updateTsConfig, updateScripts, validationLibrary, lang, dryRun, channel, }: InitOptions): Promise<void>;
8
8
  }
@@ -1,42 +1,57 @@
1
- import { confirm, select } from '@inquirer/prompts';
1
+ import { confirm, select, checkbox } from '@inquirer/prompts';
2
2
  import path from 'node:path';
3
3
  import fs from 'node:fs/promises';
4
- import getConfigPaths from '../getProjectInfo/getConfigAbsolutePaths.mjs';
5
4
  import chalk from 'chalk';
5
+ import NPMCliPackageJson from '@npmcli/package-json';
6
+ import getConfigPaths from '../getProjectInfo/getConfig/getConfigAbsolutePaths.mjs';
6
7
  import getFileSystemEntryType from '../utils/getFileSystemEntryType.mjs';
7
8
  import installDependencies, { getPackageManager } from './installDependencies.mjs';
8
9
  import getLogger from '../utils/getLogger.mjs';
9
10
  import createConfig from './createConfig.mjs';
10
- import updateNPMScripts from './updateNPMScripts.mjs';
11
+ import updateNPMScripts, { getDevScript } from './updateNPMScripts.mjs';
11
12
  import checkTSConfigForExperimentalDecorators from './checkTSConfigForExperimentalDecorators.mjs';
12
13
  import updateTypeScriptConfig from './updateTypeScriptConfig.mjs';
13
14
  import updateDependenciesWithoutInstalling from './updateDependenciesWithoutInstalling.mjs';
14
15
  import logUpdateDependenciesError from './logUpdateDependenciesError.mjs';
15
16
  import chalkHighlightThing from '../utils/chalkHighlightThing.mjs';
17
+ import { createStandardSchemaValidatorFile } from './createStandardSchemaValidatorFile.mjs';
16
18
  export class Init {
17
19
  root;
18
20
  log;
19
- async #init({ configPaths, }, { useNpm, useYarn, usePnpm, useBun, skipInstall, updateTsConfig, updateScripts, validationLibrary, validateOnClient, dryRun, channel, }) {
21
+ async #init({ configPaths, pkgJson, }, { useNpm, useYarn, usePnpm, useBun, skipInstall, updateTsConfig, updateScripts, validationLibrary, lang, dryRun, channel, }) {
20
22
  const { log, root } = this;
21
- const dependencies = ['vovk', 'vovk-client'];
23
+ const dependencies = ['vovk', 'vovk-client', 'openapi3-ts', 'vovk-ajv', 'ajv'];
22
24
  const devDependencies = ['vovk-cli'];
25
+ if (lang?.includes('py')) {
26
+ devDependencies.push('vovk-python');
27
+ }
28
+ if (lang?.includes('rs')) {
29
+ devDependencies.push('vovk-rust');
30
+ }
23
31
  // delete older config files
24
32
  if (configPaths.length) {
25
33
  await Promise.all(configPaths.map((configPath) => fs.rm(configPath)));
26
34
  log.debug(`Deleted existing config file${configPaths.length > 1 ? 's' : ''} at ${configPaths.join(', ')}`);
27
35
  }
28
36
  if (validationLibrary) {
29
- dependencies.push(validationLibrary);
30
37
  dependencies.push(...({
31
- 'vovk-zod': ['zod'],
32
- 'vovk-yup': ['yup'],
33
- 'vovk-dto': ['class-validator', 'class-transformer'],
38
+ zod: ['zod', 'vovk-zod'],
39
+ 'class-validator': [
40
+ 'class-validator',
41
+ 'class-transformer',
42
+ 'dto-mapped-types',
43
+ 'reflect-metadata',
44
+ 'vovk-dto',
45
+ ],
46
+ yup: ['yup', 'vovk-yup'],
47
+ valibot: ['valibot', '@valibot/to-json-schema'],
48
+ arktype: ['arktype'],
34
49
  }[validationLibrary] ?? []));
35
50
  }
36
51
  if (updateScripts) {
37
52
  try {
38
53
  if (!dryRun)
39
- await updateNPMScripts(root, updateScripts);
54
+ await updateNPMScripts(pkgJson, root, updateScripts);
40
55
  log.info('Updated scripts at package.json');
41
56
  }
42
57
  catch (error) {
@@ -48,9 +63,17 @@ export class Init {
48
63
  }
49
64
  if (updateTsConfig) {
50
65
  try {
66
+ const compilerOptions = {
67
+ experimentalDecorators: true,
68
+ };
69
+ if (validationLibrary === 'class-validator') {
70
+ compilerOptions.emitDecoratorMetadata = true;
71
+ }
51
72
  if (!dryRun)
52
- await updateTypeScriptConfig(root);
53
- log.info('Added "experimentalDecorators" to tsconfig.json');
73
+ await updateTypeScriptConfig(root, compilerOptions);
74
+ log.info(`Added ${Object.keys(compilerOptions)
75
+ .map((k) => `"${k}"`)
76
+ .join(' and ')} to tsconfig.json`);
54
77
  }
55
78
  catch (error) {
56
79
  log.error(`Failed to update tsconfig.json: ${error.message}`);
@@ -70,7 +93,17 @@ export class Init {
70
93
  }
71
94
  catch (e) {
72
95
  const error = e;
73
- logUpdateDependenciesError({ log, error, useNpm, useYarn, usePnpm, useBun, dependencies, devDependencies });
96
+ logUpdateDependenciesError({
97
+ log,
98
+ error,
99
+ useNpm,
100
+ useYarn,
101
+ usePnpm,
102
+ useBun,
103
+ dependencies,
104
+ devDependencies,
105
+ channel,
106
+ });
74
107
  }
75
108
  if (depsUpdated) {
76
109
  const packageManager = getPackageManager({ useNpm, useYarn, usePnpm, useBun });
@@ -92,32 +125,40 @@ export class Init {
92
125
  log.info('Dependencies installed successfully');
93
126
  }
94
127
  catch (error) {
95
- log.warn(`Failed to install dependencies: ${error.message}. Please, install them manually with ${chalkHighlightThing(packageManager + ' install')}`);
128
+ log.warn(`Failed to install dependencies. ${error.message}. Please, install them manually with ${chalkHighlightThing(packageManager + ' install')}`);
96
129
  }
97
130
  }
98
131
  }
99
132
  }
133
+ if (validationLibrary === 'valibot' || validationLibrary === 'arktype') {
134
+ createStandardSchemaValidatorFile({
135
+ root,
136
+ validationLibrary,
137
+ });
138
+ }
100
139
  try {
101
140
  const { configAbsolutePath } = await createConfig({
102
141
  root,
103
142
  log,
104
- options: { validationLibrary, validateOnClient, channel, dryRun },
143
+ options: { validationLibrary, channel, lang, dryRun },
105
144
  });
106
- log.info('Config created successfully at ' + configAbsolutePath);
145
+ log.info('Config created successfully at ' + chalkHighlightThing(configAbsolutePath));
107
146
  }
108
147
  catch (error) {
109
148
  log.error(`Failed to create config: ${error.message}`);
110
149
  }
111
150
  }
112
- async main(prefix, { yes, logLevel, useNpm, useYarn, usePnpm, useBun, skipInstall, updateTsConfig, updateScripts, validationLibrary, validateOnClient, dryRun, channel, }) {
151
+ async main({ prefix, yes, logLevel, useNpm, useYarn, usePnpm, useBun, skipInstall, updateTsConfig, updateScripts, validationLibrary, lang, dryRun, channel, }) {
113
152
  const cwd = process.cwd();
114
- const root = path.resolve(cwd, prefix);
115
- const log = getLogger(logLevel);
153
+ const root = path.resolve(cwd, prefix ?? '.');
154
+ const log = getLogger(logLevel ?? 'info');
155
+ const pkgJson = await NPMCliPackageJson.load(root);
116
156
  this.root = root;
117
157
  this.log = log;
118
158
  const configPaths = await getConfigPaths({ cwd, relativePath: prefix });
119
159
  if (yes) {
120
- return this.#init({ configPaths }, {
160
+ return this.#init({ configPaths, pkgJson, cwd }, {
161
+ prefix: prefix ?? '.',
121
162
  useNpm: useNpm ?? (!useYarn && !usePnpm && !useBun),
122
163
  useYarn: useYarn ?? false,
123
164
  usePnpm: usePnpm ?? false,
@@ -125,10 +166,10 @@ export class Init {
125
166
  skipInstall: skipInstall ?? false,
126
167
  updateTsConfig: updateTsConfig ?? true,
127
168
  updateScripts: updateScripts ?? 'implicit',
128
- validationLibrary: validationLibrary?.toLocaleLowerCase() === 'none' ? null : (validationLibrary ?? 'vovk-zod'),
129
- validateOnClient: validateOnClient ?? true,
169
+ validationLibrary: validationLibrary?.toLocaleLowerCase() === 'none' ? null : (validationLibrary ?? 'zod'),
130
170
  dryRun: dryRun ?? false,
131
171
  channel: channel ?? 'latest',
172
+ lang: lang ?? [],
132
173
  });
133
174
  }
134
175
  if (!(await getFileSystemEntryType(path.join(root, 'package.json')))) {
@@ -149,71 +190,78 @@ export class Init {
149
190
  : (validationLibrary ??
150
191
  (await select({
151
192
  message: 'Choose validation library',
152
- default: 'vovk-zod',
193
+ default: 'zod',
153
194
  choices: [
154
195
  {
155
- name: 'vovk-zod',
156
- value: 'vovk-zod',
196
+ name: 'Zod',
197
+ value: 'zod',
157
198
  description: 'Use Zod for data validation',
158
199
  },
159
200
  {
160
- name: 'vovk-yup',
161
- value: 'vovk-yup',
162
- description: 'Use Yup for data validation',
201
+ name: 'class-validator',
202
+ value: 'class-validator',
203
+ description: 'Use class-validator for data validation',
163
204
  },
164
205
  {
165
- name: 'vovk-dto',
166
- value: 'vovk-dto',
167
- description: 'Use class-validator and class-transformer for data validation',
206
+ name: 'ArkType',
207
+ value: 'arktype',
208
+ description: 'Use ArkType for data validation.',
209
+ },
210
+ {
211
+ name: 'Valibot',
212
+ value: 'valibot',
213
+ description: 'Use Valibot for data validation.',
168
214
  },
169
215
  { name: 'None', value: null, description: 'Install validation library later' },
170
216
  ],
171
217
  })));
172
- if (validationLibrary) {
173
- validateOnClient =
174
- validateOnClient ??
175
- (await confirm({
176
- message: 'Do you want to enable client validation?',
177
- }));
178
- }
179
- updateScripts =
180
- updateScripts ??
181
- (await select({
182
- message: 'Do you want to update package.json by adding "generate" and "dev" NPM scripts?',
183
- default: 'implicit',
184
- choices: [
185
- {
186
- name: 'Yes, use "concurrently" implicitly',
187
- value: 'implicit',
188
- description: `The "dev" script will use "concurrently" API to run "next dev" and "vovk dev" commands together and automatically find an available port ${chalk.whiteBright.bold(`"vovk dev --next-dev"`)}`,
189
- },
190
- {
191
- name: 'Yes, use "concurrently" explicitly',
192
- value: 'explicit',
193
- description: `The "dev" script will use pre-defined PORT variable and run "next dev" and "vovk dev" as "concurrently" CLI arguments ${chalk.whiteBright.bold(`"PORT=3000 concurrently 'next dev' 'vovk dev' --kill-others"`)}`,
194
- },
195
- {
196
- name: 'No',
197
- value: undefined,
198
- description: 'Add the NPM scripts manually',
199
- },
200
- ],
201
- }));
218
+ updateScripts ??= await select({
219
+ message: 'Do you want to update "dev" and add "prebuild" NPM scripts at package.json?',
220
+ default: 'implicit',
221
+ choices: [
222
+ {
223
+ name: 'Yes, use "concurrently" implicitly',
224
+ value: 'implicit',
225
+ description: `The "dev" script will use "concurrently" API to run "next dev" and "vovk dev" commands together and automatically find an available port ${chalk.whiteBright.bold(`"${getDevScript(pkgJson, 'implicit')}"`)} and the "prebuild" script will run "vovk generate"`,
226
+ },
227
+ {
228
+ name: 'Yes, use "concurrently" explicitly',
229
+ value: 'explicit',
230
+ description: `The "dev" script will use pre-defined PORT variable and run "next dev" and "vovk dev" as "concurrently" CLI arguments ${chalk.whiteBright.bold(`"${getDevScript(pkgJson, 'explicit')}"`)} and the "prebuild" script will run "vovk generate"`,
231
+ },
232
+ {
233
+ name: 'No',
234
+ value: undefined,
235
+ description: 'Add the NPM scripts manually',
236
+ },
237
+ ],
238
+ });
202
239
  if (typeof updateTsConfig === 'undefined') {
203
240
  let shouldAsk = false;
204
241
  try {
205
- shouldAsk = !(await checkTSConfigForExperimentalDecorators(root));
242
+ shouldAsk = !(await checkTSConfigForExperimentalDecorators(root)); // TODO also check for emitDecoratorMetadata when vovk-dto is used
206
243
  }
207
244
  catch (error) {
208
- log.error(`Failed to check tsconfig.json for experimentalDecorators: ${error.message}`);
245
+ log.error(`Failed to check tsconfig.json for "experimentalDecorators": ${error.message}`);
209
246
  }
210
247
  if (shouldAsk) {
248
+ const keys = ['experimentalDecorators'];
249
+ if (validationLibrary === 'class-validator') {
250
+ keys.push('emitDecoratorMetadata');
251
+ }
211
252
  updateTsConfig = await confirm({
212
- message: 'Do you want to add experimentalDecorators to tsconfig.json?',
253
+ message: `Do you want to add ${keys.map((k) => `"${k}"`).join(' and ')} to tsconfig.json? (recommended)`,
213
254
  });
214
255
  }
215
256
  }
216
- await this.#init({ configPaths }, {
257
+ lang ??= await checkbox({
258
+ message: 'Do you want to generate RPC client for other languages besides TypeScript (experimental)?',
259
+ choices: [
260
+ { name: 'Python', value: 'py' },
261
+ { name: 'Rust', value: 'rs' },
262
+ ],
263
+ });
264
+ await this.#init({ configPaths, pkgJson, cwd }, {
217
265
  useNpm: useNpm ?? (!useYarn && !usePnpm && !useBun),
218
266
  useYarn: useYarn ?? false,
219
267
  usePnpm: usePnpm ?? false,
@@ -222,7 +270,7 @@ export class Init {
222
270
  updateTsConfig,
223
271
  updateScripts,
224
272
  validationLibrary,
225
- validateOnClient,
273
+ lang,
226
274
  dryRun,
227
275
  channel,
228
276
  });
@@ -1,4 +1,5 @@
1
1
  import { spawn } from 'node:child_process';
2
+ import chalkHighlightThing from '../utils/chalkHighlightThing.mjs';
2
3
  export function getPackageManager(options) {
3
4
  if (options.useNpm)
4
5
  return 'npm';
@@ -12,9 +13,10 @@ export function getPackageManager(options) {
12
13
  }
13
14
  export default async function installDependencies({ log, cwd, options, }) {
14
15
  const packageManager = getPackageManager(options);
15
- log.info(`Installing dependencies at ${cwd} using ${packageManager}...`);
16
+ log.info(`Installing dependencies at ${chalkHighlightThing(cwd)} using ${chalkHighlightThing(packageManager)}...`);
16
17
  await new Promise((resolve, reject) => {
17
- const child = spawn(packageManager, ['install'], { cwd, stdio: 'inherit' });
18
+ const args = packageManager === 'yarn' ? ['install', '--non-interactive'] : ['install'];
19
+ const child = spawn(packageManager, args, { cwd, stdio: 'inherit' });
18
20
  child.on('close', (code) => {
19
21
  if (code === 0) {
20
22
  resolve();
@@ -1,5 +1,6 @@
1
+ import type { InitOptions } from '../types.mjs';
1
2
  import type getLogger from '../utils/getLogger.mjs';
2
- export default function logUpdateDependenciesError({ useNpm, useYarn, usePnpm, useBun, log, dependencies, devDependencies, error, }: {
3
+ export default function logUpdateDependenciesError({ useNpm, useYarn, usePnpm, useBun, log, dependencies, devDependencies, error, channel, }: {
3
4
  useNpm?: boolean;
4
5
  useYarn?: boolean;
5
6
  usePnpm?: boolean;
@@ -8,4 +9,5 @@ export default function logUpdateDependenciesError({ useNpm, useYarn, usePnpm, u
8
9
  dependencies: string[];
9
10
  devDependencies: string[];
10
11
  error: Error;
12
+ channel: InitOptions['channel'];
11
13
  }): void;
@@ -1,8 +1,14 @@
1
1
  import chalkHighlightThing from '../utils/chalkHighlightThing.mjs';
2
2
  import { getPackageManager } from './installDependencies.mjs';
3
- export default function logUpdateDependenciesError({ useNpm, useYarn, usePnpm, useBun, log, dependencies, devDependencies, error, }) {
3
+ export default function logUpdateDependenciesError({ useNpm, useYarn, usePnpm, useBun, log, dependencies, devDependencies, error, channel, }) {
4
4
  const packageManager = getPackageManager({ useNpm, useYarn, usePnpm, useBun });
5
5
  const installCommands = [];
6
+ const addChannel = (packageName) => {
7
+ const isVovk = packageName.startsWith('vovk') && packageName !== 'dto-mapped-types';
8
+ return isVovk ? (!channel || channel !== 'latest' ? `${packageName}@${channel}` : packageName) : packageName;
9
+ };
10
+ dependencies = dependencies.map(addChannel);
11
+ devDependencies = devDependencies.map(addChannel);
6
12
  if (dependencies.length > 0) {
7
13
  let depInstallCmd = '';
8
14
  switch (packageManager) {
@@ -2,22 +2,52 @@ import fs from 'node:fs/promises';
2
2
  import path from 'node:path';
3
3
  import chalk from 'chalk';
4
4
  import getNPMPackageMetadata from '../utils/getNPMPackageMetadata.mjs';
5
- async function updateDeps({ packageJson, packageNames, channel, key, }) {
5
+ async function updateDeps({ packageJson, packageNames, channel, key, log, }) {
6
6
  return Promise.all(packageNames.map(async (packageName) => {
7
- const metadata = await getNPMPackageMetadata(packageName);
8
- const isVovk = packageName.startsWith('vovk');
9
- const latestVersion = metadata['dist-tags'][isVovk ? (channel ?? 'latest') : 'latest'];
10
- if (!packageJson[key]) {
11
- packageJson[key] = {};
7
+ let name;
8
+ let version;
9
+ if (packageName.startsWith('@')) {
10
+ // Handle scoped packages (@org/name@version)
11
+ const lastAtIndex = packageName.lastIndexOf('@');
12
+ if (lastAtIndex > 0) {
13
+ name = packageName.substring(0, lastAtIndex);
14
+ version = packageName.substring(lastAtIndex + 1);
15
+ }
16
+ else {
17
+ name = packageName;
18
+ version = undefined;
19
+ }
20
+ }
21
+ else {
22
+ // Handle regular packages (name@version)
23
+ const parts = packageName.split('@');
24
+ name = parts[0];
25
+ version = parts[1];
26
+ }
27
+ if (version) {
28
+ packageJson[key] ??= {};
29
+ packageJson[key][name] = version;
30
+ return;
12
31
  }
13
- packageJson[key][packageName] = `^${latestVersion}`;
32
+ let metadata;
33
+ try {
34
+ metadata = await getNPMPackageMetadata(name);
35
+ }
36
+ catch (error) {
37
+ log.error(`Failed to fetch metadata for package ${name}@${channel ?? 'latest'}: ${error}`);
38
+ return;
39
+ }
40
+ const isVovk = name.startsWith('vovk') && name !== 'dto-mapped-types';
41
+ const latestVersion = metadata['dist-tags'][isVovk ? (channel ?? 'latest') : 'latest'];
42
+ packageJson[key] ??= {};
43
+ packageJson[key][name] = `^${latestVersion}`;
14
44
  }));
15
45
  }
16
46
  export default async function updateDependenciesWithoutInstalling({ log, dir, dependencyNames, devDependencyNames, channel, }) {
17
47
  const packageJsonPath = path.join(dir, 'package.json');
18
48
  const packageJson = JSON.parse(await fs.readFile(packageJsonPath, 'utf-8'));
19
- await updateDeps({ packageJson, packageNames: dependencyNames, channel, key: 'dependencies' });
20
- await updateDeps({ packageJson, packageNames: devDependencyNames, channel, key: 'devDependencies' });
49
+ await updateDeps({ packageJson, packageNames: dependencyNames, channel, log, key: 'dependencies' });
50
+ await updateDeps({ packageJson, packageNames: devDependencyNames, channel, log, key: 'devDependencies' });
21
51
  await fs.writeFile(packageJsonPath, JSON.stringify(packageJson, null, 2));
22
52
  log.info('Added dependencies to package.json:');
23
53
  for (const dependency of dependencyNames) {
@@ -1 +1,3 @@
1
- export default function updateNPMScripts(root: string, updateScriptsMode: 'implicit' | 'explicit'): Promise<void>;
1
+ import NPMCliPackageJson from '@npmcli/package-json';
2
+ export declare function getDevScript(pkgJson: NPMCliPackageJson, updateScriptsMode: 'implicit' | 'explicit'): string;
3
+ export default function updateNPMScripts(pkgJson: NPMCliPackageJson, root: string, updateScriptsMode: 'implicit' | 'explicit'): Promise<void>;
@@ -1,13 +1,16 @@
1
- import NPMCliPackageJson from '@npmcli/package-json';
2
- export default async function updateNPMScripts(root, updateScriptsMode) {
3
- const pkgJson = await NPMCliPackageJson.load(root);
1
+ export function getDevScript(pkgJson, updateScriptsMode) {
2
+ const nextDev = pkgJson.content.scripts?.dev ?? 'next dev';
3
+ const nextDevFlags = nextDev.replace('next dev', '').trim();
4
+ return updateScriptsMode === 'explicit'
5
+ ? `PORT=3000 concurrently '${nextDev}' 'vovk dev' --kill-others`
6
+ : `vovk dev --next-dev${nextDevFlags ? ` -- ${nextDevFlags}` : ''}`;
7
+ }
8
+ export default async function updateNPMScripts(pkgJson, root, updateScriptsMode) {
4
9
  pkgJson.update({
5
10
  scripts: {
6
11
  ...pkgJson.content.scripts,
7
- generate: 'vovk generate',
8
- dev: updateScriptsMode === 'explicit'
9
- ? "PORT=3000 concurrently 'next dev' 'vovk dev' --kill-others"
10
- : 'vovk dev --next-dev',
12
+ dev: getDevScript(pkgJson, updateScriptsMode),
13
+ prebuild: 'vovk generate',
11
14
  },
12
15
  });
13
16
  await pkgJson.save();
@@ -1 +1,4 @@
1
- export default function updateTypeScriptConfig(root: string): Promise<void>;
1
+ export default function updateTypeScriptConfig(root: string, compilerOptions: {
2
+ experimentalDecorators?: true;
3
+ emitDecoratorMetadata?: true;
4
+ }): Promise<void>;
@@ -2,14 +2,18 @@ import path from 'node:path';
2
2
  import fs from 'node:fs/promises';
3
3
  import * as jsonc from 'jsonc-parser';
4
4
  import prettify from '../utils/prettify.mjs';
5
- export default async function updateTypeScriptConfig(root) {
5
+ export default async function updateTypeScriptConfig(root, compilerOptions) {
6
6
  const tsconfigPath = path.join(root, 'tsconfig.json');
7
7
  const tsconfigContent = await fs.readFile(tsconfigPath, 'utf8');
8
- // Use jsonc-parser to generate edits and modify the experimentalDecorators property
9
- const edits = jsonc.modify(tsconfigContent, ['compilerOptions', 'experimentalDecorators'], true, {
10
- formattingOptions: {},
11
- });
12
- // Apply the edits to the original content
13
- const updatedContent = await prettify(jsonc.applyEdits(tsconfigContent, edits), tsconfigPath);
8
+ let updatedContent = tsconfigContent;
9
+ // Apply each compiler option
10
+ for (const [key, value] of Object.entries(compilerOptions)) {
11
+ const edits = jsonc.modify(updatedContent, ['compilerOptions', key], value, {
12
+ formattingOptions: {},
13
+ });
14
+ updatedContent = jsonc.applyEdits(updatedContent, edits);
15
+ }
16
+ // Prettify the final content
17
+ updatedContent = await prettify(updatedContent, tsconfigPath);
14
18
  await fs.writeFile(tsconfigPath, updatedContent, 'utf8');
15
19
  }
@@ -1,2 +1,2 @@
1
1
  import { Command } from 'commander';
2
- export default function initProgram(program: Command): Command;
2
+ export declare function initProgram(program: Command): Command;
@@ -1,21 +1,21 @@
1
1
  import { Init } from './init/index.mjs';
2
2
  // reused at vovk-init
3
- export default function initProgram(program) {
3
+ export function initProgram(program) {
4
4
  return program
5
- .argument('[prefix]', 'Directory to initialize project in', '.')
6
- .description('Initialize Vovk project')
7
- .option('-y, --yes', 'Skip all prompts and use default values')
8
- .option('--log-level <level>', 'Set log level', 'info')
9
- .option('--use-npm', 'Use npm as package manager')
10
- .option('--use-yarn', 'Use yarn as package manager')
11
- .option('--use-pnpm', 'Use pnpm as package manager')
12
- .option('--use-bun', 'Use bun as package manager')
13
- .option('--skip-install', 'Skip installing dependencies')
14
- .option('--update-ts-config', 'Update tsconfig.json')
15
- .option('--update-scripts <mode>', 'Update package.json scripts ("implicit" or "explicit")')
16
- .option('--validation-library <library>', 'Validation library to use ("vovk-zod", "vovk-yup", "vovk-dto" or another). Set to "none" to skip validation')
17
- .option('--validate-on-client', 'Path to validateOnClient file')
18
- .option('--channel <channel>', 'Channel to use for fetching packages', 'latest')
19
- .option('--dry-run', 'Do not write files to disk')
20
- .action((prefix = '.', options) => new Init().main(prefix, options));
5
+ .description('Initialize Vovk.ts at existing Next.js project')
6
+ .option('--prefix <prefix>', 'directory to initialize project in')
7
+ .option('-y, --yes', 'skip all prompts and use default values')
8
+ .option('--log-level <level>', 'set log level', 'info')
9
+ .option('--use-npm', 'use npm as package manager')
10
+ .option('--use-yarn', 'use yarn as package manager')
11
+ .option('--use-pnpm', 'use pnpm as package manager')
12
+ .option('--use-bun', 'use bun as package manager')
13
+ .option('--skip-install', 'skip installing dependencies')
14
+ .option('--update-ts-config', 'update tsconfig.json')
15
+ .option('--update-scripts <mode>', 'update package.json scripts ("implicit" or "explicit")')
16
+ .option('--lang <languages...>', 'generate client for other programming languages by default ("py" for Python and "rs" for Rust are supported)')
17
+ .option('--validation-library <library>', 'validation library to use ("zod", "class-validator", "valibot", "arktype" or another); set to "none" to skip')
18
+ .option('--channel <channel>', 'channel to use for fetching packages', 'latest')
19
+ .option('--dry-run', 'do not write files to disk')
20
+ .action((options) => new Init().main(options));
21
21
  }
@@ -1,5 +1,12 @@
1
+ import type { VovkStrictConfig } from 'vovk';
2
+ import type { ProjectInfo } from './getProjectInfo/index.mjs';
1
3
  export type Segment = {
2
4
  routeFilePath: string;
3
5
  segmentName: string;
4
6
  };
5
- export default function locateSegments(dir: string, rootDir?: string): Promise<Segment[]>;
7
+ export declare function locateSegments({ dir, rootDir, config, log, }: {
8
+ dir: string | null;
9
+ rootDir?: string;
10
+ config: VovkStrictConfig | null;
11
+ log: ProjectInfo['log'];
12
+ }): Promise<Segment[]>;