vovk-cli 0.0.1-draft.28 → 0.0.1-draft.280

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 (132) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +29 -1
  3. package/client-templates/cjs/index.cjs.ejs +14 -0
  4. package/client-templates/cjs/index.d.cts.ejs +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 +20 -0
  9. package/client-templates/packageJson/package.json.ejs +1 -0
  10. package/client-templates/readme/README.md.ejs +36 -0
  11. package/client-templates/schemaCjs/schema.cjs.ejs +26 -0
  12. package/client-templates/schemaCjs/schema.d.cts.ejs +10 -0
  13. package/client-templates/schemaJson/schema.json.ejs +1 -0
  14. package/client-templates/schemaTs/schema.ts.ejs +35 -0
  15. package/client-templates/ts/index.ts.ejs +30 -0
  16. package/dist/bundle/index.d.mts +8 -0
  17. package/dist/bundle/index.mjs +88 -0
  18. package/dist/dev/diffSegmentSchema.d.mts +36 -0
  19. package/dist/dev/{diffSchema.mjs → diffSegmentSchema.mjs} +4 -12
  20. package/dist/dev/ensureSchemaFiles.d.mts +3 -0
  21. package/dist/dev/ensureSchemaFiles.mjs +15 -31
  22. package/dist/dev/index.d.mts +5 -2
  23. package/dist/dev/index.mjs +173 -78
  24. package/dist/dev/logDiffResult.d.mts +1 -1
  25. package/dist/dev/logDiffResult.mjs +6 -43
  26. package/dist/dev/writeMetaJson.d.mts +2 -0
  27. package/dist/dev/writeMetaJson.mjs +17 -0
  28. package/dist/dev/writeOneSegmentSchemaFile.d.mts +12 -0
  29. package/dist/dev/{writeOneSchemaFile.mjs → writeOneSegmentSchemaFile.mjs} +10 -6
  30. package/dist/generate/ensureClient.d.mts +3 -0
  31. package/dist/generate/ensureClient.mjs +32 -0
  32. package/dist/generate/generate.d.mts +15 -0
  33. package/dist/generate/generate.mjs +283 -0
  34. package/dist/generate/getClientTemplateFiles.d.mts +20 -0
  35. package/dist/generate/getClientTemplateFiles.mjs +89 -0
  36. package/dist/generate/getProjectFullSchema.d.mts +3 -0
  37. package/dist/generate/getProjectFullSchema.mjs +64 -0
  38. package/dist/generate/getTemplateClientImports.d.mts +18 -0
  39. package/dist/generate/getTemplateClientImports.mjs +38 -0
  40. package/dist/generate/index.d.mts +33 -0
  41. package/dist/generate/index.mjs +185 -0
  42. package/dist/generate/mergePackages.d.mts +7 -0
  43. package/dist/generate/mergePackages.mjs +55 -0
  44. package/dist/generate/writeOneClientFile.d.mts +34 -0
  45. package/dist/generate/writeOneClientFile.mjs +102 -0
  46. package/dist/getProjectInfo/getConfig/getConfigAbsolutePaths.d.mts +5 -0
  47. package/dist/getProjectInfo/{getConfigAbsolutePaths.mjs → getConfig/getConfigAbsolutePaths.mjs} +4 -1
  48. package/dist/getProjectInfo/{getRelativeSrcRoot.d.mts → getConfig/getRelativeSrcRoot.d.mts} +1 -1
  49. package/dist/getProjectInfo/{getRelativeSrcRoot.mjs → getConfig/getRelativeSrcRoot.mjs} +2 -2
  50. package/dist/getProjectInfo/getConfig/getTemplateDefs.d.mts +16 -0
  51. package/dist/getProjectInfo/getConfig/getTemplateDefs.mjs +98 -0
  52. package/dist/getProjectInfo/{getUserConfig.d.mts → getConfig/getUserConfig.d.mts} +3 -2
  53. package/dist/getProjectInfo/{getUserConfig.mjs → getConfig/getUserConfig.mjs} +6 -4
  54. package/dist/getProjectInfo/{importUncachedModule.mjs → getConfig/importUncachedModule.mjs} +1 -5
  55. package/dist/getProjectInfo/{importUncachedModuleWorker.mjs → getConfig/importUncachedModuleWorker.mjs} +0 -1
  56. package/dist/getProjectInfo/getConfig/index.d.mts +119 -0
  57. package/dist/getProjectInfo/getConfig/index.mjs +94 -0
  58. package/dist/getProjectInfo/index.d.mts +8 -9
  59. package/dist/getProjectInfo/index.mjs +16 -22
  60. package/dist/index.d.mts +2 -2
  61. package/dist/index.mjs +95 -37
  62. package/dist/init/createConfig.d.mts +2 -2
  63. package/dist/init/createConfig.mjs +18 -12
  64. package/dist/init/getTemplateFilesFromPackage.mjs +10 -5
  65. package/dist/init/index.d.mts +2 -2
  66. package/dist/init/index.mjs +90 -60
  67. package/dist/init/installDependencies.mjs +4 -2
  68. package/dist/init/logUpdateDependenciesError.d.mts +3 -1
  69. package/dist/init/logUpdateDependenciesError.mjs +7 -1
  70. package/dist/init/updateDependenciesWithoutInstalling.mjs +39 -9
  71. package/dist/init/updateNPMScripts.d.mts +3 -1
  72. package/dist/init/updateNPMScripts.mjs +10 -7
  73. package/dist/init/updateTypeScriptConfig.d.mts +4 -1
  74. package/dist/init/updateTypeScriptConfig.mjs +11 -7
  75. package/dist/initProgram.d.mts +1 -1
  76. package/dist/initProgram.mjs +17 -16
  77. package/dist/locateSegments.d.mts +8 -1
  78. package/dist/locateSegments.mjs +14 -4
  79. package/dist/new/addClassToSegmentCode.d.mts +1 -2
  80. package/dist/new/addClassToSegmentCode.mjs +3 -3
  81. package/dist/new/addCommonTerms.mjs +1 -0
  82. package/dist/new/index.d.mts +1 -1
  83. package/dist/new/index.mjs +3 -2
  84. package/dist/new/newModule.d.mts +2 -1
  85. package/dist/new/newModule.mjs +18 -16
  86. package/dist/new/newSegment.d.mts +2 -1
  87. package/dist/new/newSegment.mjs +19 -10
  88. package/dist/new/render.d.mts +7 -3
  89. package/dist/new/render.mjs +29 -8
  90. package/dist/types.d.mts +50 -41
  91. package/dist/utils/compileJSONSchemaToTypeScriptType.d.mts +5 -0
  92. package/dist/utils/compileJSONSchemaToTypeScriptType.mjs +9 -0
  93. package/dist/utils/compileTs.d.mts +12 -0
  94. package/dist/utils/compileTs.mjs +261 -0
  95. package/dist/utils/debounceWithArgs.d.mts +2 -2
  96. package/dist/utils/debounceWithArgs.mjs +24 -9
  97. package/dist/utils/formatLoggedSegmentName.d.mts +3 -1
  98. package/dist/utils/formatLoggedSegmentName.mjs +3 -2
  99. package/dist/utils/getAvailablePort.mjs +1 -1
  100. package/dist/utils/getPackageJson.d.mts +3 -0
  101. package/dist/utils/getPackageJson.mjs +22 -0
  102. package/dist/utils/getPublicModuleNameFromPath.d.mts +4 -0
  103. package/dist/utils/getPublicModuleNameFromPath.mjs +9 -0
  104. package/dist/utils/normalizeOpenAPIMixins.d.mts +7 -0
  105. package/dist/utils/normalizeOpenAPIMixins.mjs +66 -0
  106. package/dist/utils/pickSegmentFullSchema.d.mts +3 -0
  107. package/dist/utils/pickSegmentFullSchema.mjs +15 -0
  108. package/dist/utils/removeUnlistedDirectories.d.mts +10 -0
  109. package/dist/utils/removeUnlistedDirectories.mjs +61 -0
  110. package/dist/utils/resolveAbsoluteModulePath.d.mts +2 -0
  111. package/dist/utils/resolveAbsoluteModulePath.mjs +32 -0
  112. package/module-templates/controller.ts.ejs +56 -0
  113. package/module-templates/service.ts.ejs +28 -0
  114. package/package.json +41 -22
  115. package/dist/dev/diffSchema.d.mts +0 -43
  116. package/dist/dev/ensureClient.d.mts +0 -5
  117. package/dist/dev/ensureClient.mjs +0 -31
  118. package/dist/dev/isMetadataEmpty.d.mts +0 -2
  119. package/dist/dev/isMetadataEmpty.mjs +0 -4
  120. package/dist/dev/writeOneSchemaFile.d.mts +0 -11
  121. package/dist/generateClient.d.mts +0 -7
  122. package/dist/generateClient.mjs +0 -97
  123. package/dist/getProjectInfo/getConfig.d.mts +0 -11
  124. package/dist/getProjectInfo/getConfig.mjs +0 -29
  125. package/dist/getProjectInfo/getConfigAbsolutePaths.d.mts +0 -4
  126. package/dist/postinstall.d.mts +0 -1
  127. package/dist/postinstall.mjs +0 -24
  128. package/templates/controller.ejs +0 -51
  129. package/templates/service.ejs +0 -27
  130. package/templates/worker.ejs +0 -24
  131. /package/dist/getProjectInfo/{importUncachedModule.d.mts → getConfig/importUncachedModule.d.mts} +0 -0
  132. /package/dist/getProjectInfo/{importUncachedModuleWorker.d.mts → getConfig/importUncachedModuleWorker.d.mts} +0 -0
@@ -1,32 +1,51 @@
1
1
  import fs from 'node:fs/promises';
2
2
  import path from 'node:path';
3
+ import { VovkSchemaIdEnum } from 'vovk';
3
4
  import * as chokidar from 'chokidar';
4
5
  import { Agent, setGlobalDispatcher } from 'undici';
5
6
  import keyBy from 'lodash/keyBy.js';
6
7
  import capitalize from 'lodash/capitalize.js';
7
8
  import debounce from 'lodash/debounce.js';
9
+ import once from 'lodash/once.js';
8
10
  import isEmpty from 'lodash/isEmpty.js';
9
- import { debouncedEnsureSchemaFiles } from './ensureSchemaFiles.mjs';
10
- import writeOneSchemaFile from './writeOneSchemaFile.mjs';
11
+ import ensureSchemaFiles, { debouncedEnsureSchemaFiles } from './ensureSchemaFiles.mjs';
12
+ import writeOneSegmentSchemaFile from './writeOneSegmentSchemaFile.mjs';
11
13
  import logDiffResult from './logDiffResult.mjs';
12
- import ensureClient from './ensureClient.mjs';
14
+ import ensureClient from '../generate/ensureClient.mjs';
13
15
  import getProjectInfo from '../getProjectInfo/index.mjs';
14
- import generateClient from '../generateClient.mjs';
15
- import locateSegments from '../locateSegments.mjs';
16
+ import { generate } from '../generate/generate.mjs';
17
+ import { locateSegments } from '../locateSegments.mjs';
16
18
  import debounceWithArgs from '../utils/debounceWithArgs.mjs';
17
19
  import formatLoggedSegmentName from '../utils/formatLoggedSegmentName.mjs';
20
+ import writeMetaJson from './writeMetaJson.mjs';
18
21
  export class VovkDev {
19
22
  #projectInfo;
20
23
  #segments = [];
21
- #schemas = {};
24
+ #fullSchema = {
25
+ $schema: VovkSchemaIdEnum.SCHEMA,
26
+ segments: {},
27
+ meta: {
28
+ $schema: VovkSchemaIdEnum.META,
29
+ config: {
30
+ $schema: VovkSchemaIdEnum.CONFIG,
31
+ },
32
+ },
33
+ };
22
34
  #isWatching = false;
23
35
  #modulesWatcher = null;
24
36
  #segmentWatcher = null;
25
- #watchSegments = () => {
37
+ #onFirstTimeGenerate = null;
38
+ #schemaOut = null;
39
+ constructor({ schemaOut }) {
40
+ this.#schemaOut = schemaOut ?? null;
41
+ }
42
+ #watchSegments = (callback) => {
26
43
  const segmentReg = /\/?\[\[\.\.\.[a-zA-Z-_]+\]\]\/route.ts$/;
27
- const { cwd, log, config, apiDir } = this.#projectInfo;
28
- const schemaOutAbsolutePath = path.join(cwd, config.schemaOutDir);
29
- const apiDirAbsolutePath = path.join(cwd, apiDir);
44
+ const { cwd, log, config, apiDirAbsolutePath } = this.#projectInfo;
45
+ if (!apiDirAbsolutePath) {
46
+ throw new Error('Unable to watch segments. It looks like CWD is not a Next.js app.');
47
+ }
48
+ const schemaOutAbsolutePath = path.resolve(cwd, this.#schemaOut ?? config.schemaOutDir);
30
49
  const getSegmentName = (filePath) => path.relative(apiDirAbsolutePath, filePath).replace(segmentReg, '');
31
50
  log.debug(`Watching segments at ${apiDirAbsolutePath}`);
32
51
  this.#segmentWatcher = chokidar
@@ -40,7 +59,13 @@ export class VovkDev {
40
59
  const segmentName = getSegmentName(filePath);
41
60
  this.#segments = this.#segments.find((s) => s.segmentName === segmentName)
42
61
  ? this.#segments
43
- : [...this.#segments, { routeFilePath: filePath, segmentName }];
62
+ : [
63
+ ...this.#segments,
64
+ {
65
+ routeFilePath: filePath,
66
+ segmentName,
67
+ },
68
+ ];
44
69
  log.info(`${capitalize(formatLoggedSegmentName(segmentName))} has been added`);
45
70
  log.debug(`Full list of segments: ${this.#segments.map((s) => s.segmentName).join(', ')}`);
46
71
  void debouncedEnsureSchemaFiles(this.#projectInfo, schemaOutAbsolutePath, this.#segments.map((s) => s.segmentName));
@@ -54,14 +79,22 @@ export class VovkDev {
54
79
  })
55
80
  .on('addDir', async (dirPath) => {
56
81
  log.debug(`Directory ${dirPath} has been added to segments folder`);
57
- this.#segments = await locateSegments(apiDirAbsolutePath);
82
+ this.#segments = await locateSegments({
83
+ dir: apiDirAbsolutePath,
84
+ config,
85
+ log: this.#projectInfo.log,
86
+ });
58
87
  for (const { segmentName } of this.#segments) {
59
88
  void this.#requestSchema(segmentName);
60
89
  }
61
90
  })
62
91
  .on('unlinkDir', async (dirPath) => {
63
92
  log.debug(`Directory ${dirPath} has been removed from segments folder`);
64
- this.#segments = await locateSegments(apiDirAbsolutePath);
93
+ this.#segments = await locateSegments({
94
+ dir: apiDirAbsolutePath,
95
+ config,
96
+ log: this.#projectInfo.log,
97
+ });
65
98
  for (const { segmentName } of this.#segments) {
66
99
  void this.#requestSchema(segmentName);
67
100
  }
@@ -77,13 +110,14 @@ export class VovkDev {
77
110
  }
78
111
  })
79
112
  .on('ready', () => {
113
+ callback();
80
114
  log.debug('Segments watcher is ready');
81
115
  })
82
116
  .on('error', (error) => {
83
117
  log.error(`Error watching segments folder: ${error?.message ?? 'Unknown error'}`);
84
118
  });
85
119
  };
86
- #watchModules = () => {
120
+ #watchModules = (callback) => {
87
121
  const { config, cwd, log } = this.#projectInfo;
88
122
  const modulesDirAbsolutePath = path.join(cwd, config.modulesDir);
89
123
  log.debug(`Watching modules at ${modulesDirAbsolutePath}`);
@@ -115,30 +149,49 @@ export class VovkDev {
115
149
  }
116
150
  })
117
151
  .on('ready', () => {
152
+ callback();
118
153
  log.debug('Modules watcher is ready');
119
154
  })
120
155
  .on('error', (error) => {
121
156
  log.error(`Error watching modules folder: ${error?.message ?? 'Unknown error'}`);
122
157
  });
123
158
  };
124
- #watchConfig = () => {
159
+ #watchConfig = (callback) => {
125
160
  const { log, cwd } = this.#projectInfo;
126
161
  log.debug(`Watching config files`);
127
162
  let isInitial = true;
128
163
  let isReady = false;
129
164
  const handle = debounce(async () => {
130
165
  this.#projectInfo = await getProjectInfo();
131
- if (!isInitial) {
132
- log.info('Config file has been updated');
133
- isInitial = false;
134
- }
166
+ const { config, apiDirAbsolutePath } = this.#projectInfo;
167
+ this.#segments = await locateSegments({ dir: apiDirAbsolutePath, config, log });
135
168
  await this.#modulesWatcher?.close();
136
169
  await this.#segmentWatcher?.close();
137
- this.#watchModules();
138
- this.#watchSegments();
170
+ await Promise.all([
171
+ new Promise((resolve) => this.#watchModules(() => resolve(0))),
172
+ new Promise((resolve) => this.#watchSegments(() => resolve(0))),
173
+ ]);
174
+ const schemaOutAbsolutePath = path.join(cwd, this.#schemaOut ?? this.#projectInfo.config.schemaOutDir);
175
+ if (isInitial) {
176
+ callback();
177
+ }
178
+ else {
179
+ log.info('Config file has been updated');
180
+ this.#generate();
181
+ }
182
+ await writeMetaJson(schemaOutAbsolutePath, this.#projectInfo);
183
+ isInitial = false;
139
184
  }, 1000);
140
185
  chokidar
141
- .watch(['vovk.config.{js,mjs,cjs}', '.config/vovk.config.{js,mjs,cjs}'], {
186
+ // .watch(['vovk.config.{js,mjs,cjs}', '.config/vovk.config.{js,mjs,cjs}'], {
187
+ .watch([
188
+ 'vovk.config.js',
189
+ 'vovk.config.mjs',
190
+ 'vovk.config.cjs',
191
+ '.config/vovk.config.js',
192
+ '.config/vovk.config.mjs',
193
+ '.config/vovk.config.cjs',
194
+ ], {
142
195
  persistent: true,
143
196
  cwd,
144
197
  ignoreInitial: false,
@@ -157,14 +210,13 @@ export class VovkDev {
157
210
  .on('error', (error) => log.error(`Error watching config files: ${error?.message ?? 'Unknown error'}`));
158
211
  void handle();
159
212
  };
160
- async #watch() {
213
+ async #watch(callback) {
161
214
  if (this.#isWatching)
162
215
  throw new Error('Already watching');
163
216
  const { log } = this.#projectInfo;
164
217
  log.debug(`Starting segments and modules watcher. Detected initial segments: ${JSON.stringify(this.#segments.map((s) => s.segmentName))}.`);
165
- await ensureClient(this.#projectInfo);
166
218
  // automatically watches segments and modules
167
- this.#watchConfig();
219
+ this.#watchConfig(callback);
168
220
  }
169
221
  #processControllerChange = async (filePath) => {
170
222
  const { log } = this.#projectInfo;
@@ -175,72 +227,78 @@ export class VovkDev {
175
227
  }
176
228
  const nameOfClasReg = /\bclass\s+([A-Za-z_]\w*)(?:\s*<[^>]*>)?\s*\{/g;
177
229
  const namesOfClasses = [...code.matchAll(nameOfClasReg)].map((match) => match[1]);
178
- const importRegex = /import\s*{[^}]*\b(get|post|put|del|head|options|worker)\b[^}]*}\s*from\s*['"]vovk['"]/;
230
+ const importRegex = /import\s*{[^}]*\b(get|post|put|del|head|options)\b[^}]*}\s*from\s*['"]vovk['"]/;
179
231
  if (importRegex.test(code) && namesOfClasses.length) {
180
232
  const affectedSegments = this.#segments.filter((s) => {
181
- const schema = this.#schemas[s.segmentName];
182
- if (!schema)
233
+ const segmentSchema = this.#fullSchema.segments[s.segmentName];
234
+ if (!segmentSchema)
183
235
  return false;
184
- const controllersByOriginalName = keyBy(schema.controllers, '_originalControllerName');
185
- const workersByOriginalName = keyBy(schema.workers, '_originalWorkerName');
186
- return namesOfClasses.some((name) => schema.controllers[name] ||
187
- schema.workers[name] ||
188
- controllersByOriginalName[name] ||
189
- workersByOriginalName[name]);
236
+ const controllersByOriginalName = keyBy(segmentSchema.controllers, 'originalControllerName');
237
+ return namesOfClasses.some((name) => segmentSchema.controllers[name] || controllersByOriginalName[name]);
190
238
  });
191
239
  if (affectedSegments.length) {
192
- log.debug(`A file with controller or worker ${namesOfClasses.join(', ')} have been modified at path "${filePath}". Segment(s) affected: ${JSON.stringify(affectedSegments.map((s) => s.segmentName))}`);
240
+ log.debug(`A file with controller ${namesOfClasses.join(', ')} have been modified at path "${filePath}". Segment(s) affected: ${JSON.stringify(affectedSegments.map((s) => s.segmentName))}`);
193
241
  for (const segment of affectedSegments) {
194
242
  await this.#requestSchema(segment.segmentName);
195
243
  }
196
244
  }
245
+ else {
246
+ log.debug(`The class ${namesOfClasses.join(', ')} does not belong to any segment`);
247
+ }
197
248
  }
198
249
  else {
199
- log.debug(`The file does not contain any controller or worker`);
250
+ log.debug(`The file ${filePath} does not contain any controller`);
200
251
  }
201
252
  };
202
253
  #requestSchema = debounceWithArgs(async (segmentName) => {
203
- const { apiEntryPoint, log, port, config } = this.#projectInfo;
254
+ const { apiRoot, log, port, config } = this.#projectInfo;
204
255
  const { devHttps } = config;
205
- const endpoint = `${apiEntryPoint.startsWith(`http${devHttps ? 's' : ''}://`) ? apiEntryPoint : `http${devHttps ? 's' : ''}://localhost:${port}${apiEntryPoint}`}/${segmentName ? `${segmentName}/` : ''}_schema_`;
256
+ const endpoint = `${apiRoot.startsWith(`http${devHttps ? 's' : ''}://`) ? apiRoot : `http${devHttps ? 's' : ''}://localhost:${port}${apiRoot}`}/${segmentName ? `${segmentName}/` : ''}_schema_`;
206
257
  log.debug(`Requesting schema for ${formatLoggedSegmentName(segmentName)} at ${endpoint}`);
207
- const resp = await fetch(endpoint);
208
- if (resp.status !== 200) {
209
- const probableCause = {
210
- 404: 'The segment is not compiled.',
211
- 500: 'Syntax error in one of controllers.',
212
- }[resp.status];
213
- log.warn(`Schema request to ${formatLoggedSegmentName(segmentName)} failed with status code ${resp.status} but expected 200.${probableCause ? ` Probable cause: ${probableCause}` : ''}`);
214
- return;
215
- }
216
- let schema = null;
217
258
  try {
218
- ({ schema } = (await resp.json()));
259
+ const resp = await fetch(endpoint);
260
+ if (resp.status !== 200) {
261
+ const probableCause = {
262
+ 404: 'The segment did not compile or config.origin is wrong.',
263
+ }[resp.status];
264
+ log.warn(`Schema request to ${formatLoggedSegmentName(segmentName)} failed with status code ${resp.status} but expected 200.${probableCause ? ` Probable cause: ${probableCause}` : ''}`);
265
+ return { isError: true };
266
+ }
267
+ let segmentSchema = null;
268
+ try {
269
+ ({ schema: segmentSchema } = (await resp.json()));
270
+ }
271
+ catch (error) {
272
+ log.error(`Error parsing schema for ${formatLoggedSegmentName(segmentName)}: ${error?.message}`);
273
+ }
274
+ await this.#handleSegmentSchema(segmentName, segmentSchema);
219
275
  }
220
276
  catch (error) {
221
- log.error(`Error parsing schema for ${formatLoggedSegmentName(segmentName)}: ${error.message}`);
277
+ log.error(`Error requesting schema for ${formatLoggedSegmentName(segmentName)} at ${endpoint}: ${error?.message}`);
278
+ return { isError: true };
222
279
  }
223
- await this.#handleSchema(schema);
280
+ return { isError: false };
224
281
  }, 500);
225
- async #handleSchema(schema) {
282
+ #generate = debounce(() => generate({ projectInfo: this.#projectInfo, fullSchema: this.#fullSchema, locatedSegments: this.#segments }).then(this.#onFirstTimeGenerate), 1000);
283
+ async #handleSegmentSchema(segmentName, segmentSchema) {
226
284
  const { log, config, cwd } = this.#projectInfo;
227
- if (!schema) {
228
- log.warn('Segment schema is null');
285
+ if (!segmentSchema) {
286
+ log.warn(`${formatLoggedSegmentName(segmentName)} schema is null`);
229
287
  return;
230
288
  }
231
- log.debug(`Handling received schema from ${formatLoggedSegmentName(schema.segmentName)}`);
232
- const schemaOutAbsolutePath = path.join(cwd, config.schemaOutDir);
233
- const segment = this.#segments.find((s) => s.segmentName === schema.segmentName);
289
+ log.debug(`Handling received schema from ${formatLoggedSegmentName(segmentName)}`);
290
+ const schemaOutAbsolutePath = path.resolve(cwd, this.#schemaOut ?? config.schemaOutDir);
291
+ const segment = this.#segments.find((s) => s.segmentName === segmentName);
234
292
  if (!segment) {
235
- log.warn(`Segment "${schema.segmentName}" not found`);
293
+ log.warn(`${formatLoggedSegmentName(segmentName)} not found`);
236
294
  return;
237
295
  }
238
- this.#schemas[schema.segmentName] = schema;
239
- if (schema.emitSchema) {
296
+ this.#fullSchema.segments[segmentName] = segmentSchema;
297
+ if (segmentSchema.emitSchema) {
240
298
  const now = Date.now();
241
- const { diffResult } = await writeOneSchemaFile({
299
+ const { diffResult } = await writeOneSegmentSchemaFile({
242
300
  schemaOutAbsolutePath,
243
- schema,
301
+ segmentSchema,
244
302
  skipIfExists: false,
245
303
  });
246
304
  const timeTook = Date.now() - now;
@@ -249,17 +307,25 @@ export class VovkDev {
249
307
  log.info(`Schema for ${formatLoggedSegmentName(segment.segmentName)} has been updated in ${timeTook}ms`);
250
308
  }
251
309
  }
252
- else if (schema && (!isEmpty(schema.controllers) || !isEmpty(schema.workers))) {
253
- log.error(`Non-empty schema provided for ${formatLoggedSegmentName(segment.segmentName)} but emitSchema is false`);
310
+ else if (segmentSchema && !isEmpty(segmentSchema.controllers)) {
311
+ log.error(`Non-empty schema provided for ${formatLoggedSegmentName(segment.segmentName)} but "emitSchema" is false`);
254
312
  }
255
- if (this.#segments.every((s) => this.#schemas[s.segmentName])) {
313
+ if (this.#segments.every((s) => this.#fullSchema.segments[s.segmentName])) {
256
314
  log.debug(`All segments with "emitSchema" have schema.`);
257
- await generateClient(this.#projectInfo, this.#segments, this.#schemas);
315
+ this.#generate();
258
316
  }
259
317
  }
260
- async start({ clientOutDir } = {}) {
261
- this.#projectInfo = await getProjectInfo({ clientOutDir });
262
- const { log, config, cwd, apiDir } = this.#projectInfo;
318
+ async start({ exit }) {
319
+ const now = Date.now();
320
+ this.#projectInfo = await getProjectInfo();
321
+ const { log, config, cwd, apiDirAbsolutePath } = this.#projectInfo;
322
+ this.#segments = await locateSegments({ dir: apiDirAbsolutePath, config, log });
323
+ log.info('Starting...');
324
+ if (exit) {
325
+ this.#onFirstTimeGenerate = once(() => {
326
+ log.info('The schemas and the RPC client have been generated. Exiting...');
327
+ });
328
+ }
263
329
  if (config.devHttps) {
264
330
  const agent = new Agent({
265
331
  connect: {
@@ -274,20 +340,49 @@ export class VovkDev {
274
340
  process.on('unhandledRejection', (reason) => {
275
341
  log.error(`Unhandled Rejection: ${String(reason)}`);
276
342
  });
277
- const apiDirAbsolutePath = path.join(cwd, apiDir);
278
- const schemaOutAbsolutePath = path.join(cwd, config.schemaOutDir);
279
- this.#segments = await locateSegments(apiDirAbsolutePath);
280
- await debouncedEnsureSchemaFiles(this.#projectInfo, schemaOutAbsolutePath, this.#segments.map((s) => s.segmentName));
281
- // Request schema every segment in 5 seconds in order to update schema and start watching
343
+ const schemaOutAbsolutePath = path.resolve(cwd, this.#schemaOut ?? config.schemaOutDir);
344
+ const segmentNames = this.#segments.map((s) => s.segmentName);
345
+ await ensureSchemaFiles(this.#projectInfo, schemaOutAbsolutePath, segmentNames);
346
+ await ensureClient(this.#projectInfo, this.#segments);
347
+ const MAX_ATTEMPTS = 5;
348
+ const DELAY = 5000;
349
+ // Request schema every segment in 5 seconds in order to update schema on start
282
350
  setTimeout(() => {
283
351
  for (const { segmentName } of this.#segments) {
284
- void this.#requestSchema(segmentName);
352
+ let attempts = 0;
353
+ void this.#requestSchema(segmentName).then(({ isError }) => {
354
+ if (isError) {
355
+ const interval = setInterval(() => {
356
+ attempts++;
357
+ if (attempts >= MAX_ATTEMPTS) {
358
+ clearInterval(interval);
359
+ log.error(`Failed to request schema for ${formatLoggedSegmentName(segmentName)} after ${MAX_ATTEMPTS} attempts`);
360
+ return;
361
+ }
362
+ void this.#requestSchema(segmentName).then(({ isError: isError2 }) => {
363
+ if (!isError2) {
364
+ clearInterval(interval);
365
+ log.info(`Requested schema for ${formatLoggedSegmentName(segmentName)} after ${attempts} attempts`);
366
+ }
367
+ });
368
+ }, DELAY);
369
+ }
370
+ });
285
371
  }
286
- this.#watch();
287
- }, 5000);
372
+ }, DELAY);
373
+ if (!exit) {
374
+ this.#watch(() => {
375
+ log.info(`Ready in ${Date.now() - now}ms. Making initial requests for schemas in a moment...`);
376
+ });
377
+ }
378
+ else {
379
+ log.info(`Ready in ${Date.now() - now}ms. Making requests for schemas in a moment...`);
380
+ }
288
381
  }
289
382
  }
290
383
  const env = process.env;
291
384
  if (env.__VOVK_START_WATCHER_IN_STANDALONE_MODE__ === 'true') {
292
- void new VovkDev().start();
385
+ void new VovkDev({ schemaOut: env.__VOVK_SCHEMA_OUT_FLAG__ || undefined }).start({
386
+ exit: env.__VOVK_EXIT__ === 'true',
387
+ });
293
388
  }
@@ -1,3 +1,3 @@
1
- import type { DiffResult } from './diffSchema.mjs';
1
+ import type { DiffResult } from './diffSegmentSchema.mjs';
2
2
  import type { ProjectInfo } from '../getProjectInfo/index.mjs';
3
3
  export default function logDiffResult(segmentName: string, diffResult: DiffResult, projectInfo: ProjectInfo): void;
@@ -3,23 +3,6 @@ import formatLoggedSegmentName from '../utils/formatLoggedSegmentName.mjs';
3
3
  import chalkHighlightThing from '../utils/chalkHighlightThing.mjs';
4
4
  export default function logDiffResult(segmentName, diffResult, projectInfo) {
5
5
  const diffNormalized = [];
6
- diffResult.workers.added.forEach((name) => {
7
- diffNormalized.push({ what: 'worker', type: 'added', name });
8
- });
9
- diffResult.workers.removed.forEach((name) => {
10
- diffNormalized.push({ what: 'worker', type: 'removed', name });
11
- });
12
- diffResult.workers.handlers.forEach((handler) => {
13
- handler.added.forEach((name) => {
14
- diffNormalized.push({ what: 'workerHandler', type: 'added', name: `${handler.nameOfClass}.${name}` });
15
- });
16
- handler.removed.forEach((name) => {
17
- diffNormalized.push({ what: 'workerHandler', type: 'removed', name: `${handler.nameOfClass}.${name}` });
18
- });
19
- handler.changed.forEach((name) => {
20
- diffNormalized.push({ what: 'workerHandler', type: 'changed', name: `${handler.nameOfClass}.${name}` });
21
- });
22
- });
23
6
  diffResult.controllers.added.forEach((name) => {
24
7
  diffNormalized.push({ what: 'controller', type: 'added', name });
25
8
  });
@@ -37,52 +20,32 @@ export default function logDiffResult(segmentName, diffResult, projectInfo) {
37
20
  diffNormalized.push({ what: 'controllerHandler', type: 'changed', name: `${handler.nameOfClass}.${name}` });
38
21
  });
39
22
  });
40
- const LIMIT = diffNormalized.length < 12 ? diffNormalized.length : 10;
23
+ const LIMIT = diffNormalized.length < 17 ? diffNormalized.length : 15;
41
24
  const addedText = chalk.green('added');
42
25
  const removedText = chalk.red('removed');
43
26
  const changedText = chalk.cyan('changed');
44
27
  for (const diffNormalizedItem of diffNormalized.slice(0, LIMIT)) {
45
28
  switch (diffNormalizedItem.what) {
46
- case 'worker':
47
- switch (diffNormalizedItem.type) {
48
- case 'added':
49
- projectInfo.log.info(`Schema for worker ${chalkHighlightThing(diffNormalizedItem.name)} has been ${addedText} at ${formatLoggedSegmentName(segmentName)}`);
50
- break;
51
- case 'removed':
52
- projectInfo.log.info(`Schema for worker ${chalkHighlightThing(diffNormalizedItem.name)} has been ${removedText} from ${formatLoggedSegmentName(segmentName)}`);
53
- break;
54
- }
55
- break;
56
29
  case 'controller':
57
30
  switch (diffNormalizedItem.type) {
58
31
  case 'added':
59
- projectInfo.log.info(`Schema for controller ${chalkHighlightThing(diffNormalizedItem.name)} has been ${addedText} at ${formatLoggedSegmentName(segmentName)}`);
60
- break;
61
- case 'removed':
62
- projectInfo.log.info(`Schema for controller ${chalkHighlightThing(diffNormalizedItem.name)} has been ${removedText} from ${formatLoggedSegmentName(segmentName)}`);
63
- break;
64
- }
65
- break;
66
- case 'workerHandler':
67
- switch (diffNormalizedItem.type) {
68
- case 'added':
69
- projectInfo.log.info(`Schema for worker method ${chalkHighlightThing(diffNormalizedItem.name)} has been ${addedText} at ${formatLoggedSegmentName(segmentName)}`);
32
+ projectInfo.log.info(`Schema for RPC module ${chalkHighlightThing(diffNormalizedItem.name)} has been ${addedText} at ${formatLoggedSegmentName(segmentName)}`);
70
33
  break;
71
34
  case 'removed':
72
- projectInfo.log.info(`Schema for worker method ${chalkHighlightThing(diffNormalizedItem.name)} has been ${removedText} from ${formatLoggedSegmentName(segmentName)}`);
35
+ projectInfo.log.info(`Schema for RPC module ${chalkHighlightThing(diffNormalizedItem.name)} has been ${removedText} from ${formatLoggedSegmentName(segmentName)}`);
73
36
  break;
74
37
  }
75
38
  break;
76
39
  case 'controllerHandler':
77
40
  switch (diffNormalizedItem.type) {
78
41
  case 'added':
79
- projectInfo.log.info(`Schema for controller method ${chalkHighlightThing(diffNormalizedItem.name)} has been ${addedText} at ${formatLoggedSegmentName(segmentName)}`);
42
+ projectInfo.log.info(`Schema for RPC method ${chalkHighlightThing(diffNormalizedItem.name)} has been ${addedText} at ${formatLoggedSegmentName(segmentName)}`);
80
43
  break;
81
44
  case 'removed':
82
- projectInfo.log.info(`Schema for controller method ${chalkHighlightThing(diffNormalizedItem.name)} has been ${removedText} from ${formatLoggedSegmentName(segmentName)}`);
45
+ projectInfo.log.info(`Schema for RPC method ${chalkHighlightThing(diffNormalizedItem.name)} has been ${removedText} from ${formatLoggedSegmentName(segmentName)}`);
83
46
  break;
84
47
  case 'changed':
85
- projectInfo.log.info(`Schema for controller method ${chalkHighlightThing(diffNormalizedItem.name)} has been ${changedText} at ${formatLoggedSegmentName(segmentName)}`);
48
+ projectInfo.log.info(`Schema for RPC method ${chalkHighlightThing(diffNormalizedItem.name)} has been ${changedText} at ${formatLoggedSegmentName(segmentName)}`);
86
49
  break;
87
50
  }
88
51
  break;
@@ -0,0 +1,2 @@
1
+ import type { ProjectInfo } from '../getProjectInfo/index.mjs';
2
+ export default function writeMetaJson(schemaOutAbsolutePath: string, projectInfo: ProjectInfo | null): Promise<void>;
@@ -0,0 +1,17 @@
1
+ import fs from 'node:fs/promises';
2
+ import path from 'node:path';
3
+ import pick from 'lodash/pick.js';
4
+ import { META_FILE_NAME } from './writeOneSegmentSchemaFile.mjs';
5
+ import chalkHighlightThing from '../utils/chalkHighlightThing.mjs';
6
+ export default async function writeMetaJson(schemaOutAbsolutePath, projectInfo) {
7
+ const metaJsonPath = path.join(schemaOutAbsolutePath, META_FILE_NAME + '.json');
8
+ const metaStr = JSON.stringify({ config: projectInfo ? pick(projectInfo.config, projectInfo.config.emitConfig) : {} }, null, 2);
9
+ const existingStr = await fs.readFile(metaJsonPath, 'utf-8').catch(() => null);
10
+ if (existingStr !== metaStr) {
11
+ await fs.writeFile(metaJsonPath, metaStr);
12
+ projectInfo?.log.info(`Meta JSON is written to ${chalkHighlightThing(metaJsonPath)}`);
13
+ }
14
+ else {
15
+ projectInfo?.log.debug(`Meta JSON is up to date at ${chalkHighlightThing(metaJsonPath)}`);
16
+ }
17
+ }
@@ -0,0 +1,12 @@
1
+ import type { VovkSegmentSchema } from 'vovk';
2
+ import { type DiffResult } from './diffSegmentSchema.mjs';
3
+ export declare const ROOT_SEGMENT_FILE_NAME = "root";
4
+ export declare const META_FILE_NAME = "_meta";
5
+ export default function writeOneSegmentSchemaFile({ schemaOutAbsolutePath, segmentSchema, skipIfExists, }: {
6
+ schemaOutAbsolutePath: string;
7
+ segmentSchema: VovkSegmentSchema;
8
+ skipIfExists?: boolean;
9
+ }): Promise<{
10
+ isCreated: boolean;
11
+ diffResult: DiffResult | null;
12
+ }>;
@@ -1,10 +1,11 @@
1
1
  import path from 'node:path';
2
2
  import fs from 'node:fs/promises';
3
- import diffSchema from './diffSchema.mjs';
3
+ import diffSegmentSchema from './diffSegmentSchema.mjs';
4
4
  import getFileSystemEntryType from '../utils/getFileSystemEntryType.mjs';
5
- export const ROOT_SEGMENT_SCHEMA_NAME = '_root';
6
- export default async function writeOneSchemaFile({ schemaOutAbsolutePath, schema, skipIfExists = false, }) {
7
- const segmentPath = path.join(schemaOutAbsolutePath, `${schema.segmentName || ROOT_SEGMENT_SCHEMA_NAME}.json`);
5
+ export const ROOT_SEGMENT_FILE_NAME = 'root';
6
+ export const META_FILE_NAME = '_meta';
7
+ export default async function writeOneSegmentSchemaFile({ schemaOutAbsolutePath, segmentSchema, skipIfExists = false, }) {
8
+ const segmentPath = path.join(schemaOutAbsolutePath, `${segmentSchema.segmentName || ROOT_SEGMENT_FILE_NAME}.json`);
8
9
  if (skipIfExists && (await getFileSystemEntryType(segmentPath))) {
9
10
  try {
10
11
  await fs.stat(segmentPath);
@@ -15,14 +16,17 @@ export default async function writeOneSchemaFile({ schemaOutAbsolutePath, schema
15
16
  }
16
17
  }
17
18
  await fs.mkdir(path.dirname(segmentPath), { recursive: true });
18
- const schemaStr = JSON.stringify(schema, null, 2);
19
+ const schemaStr = JSON.stringify(segmentSchema, null, 2);
19
20
  const existing = await fs.readFile(segmentPath, 'utf-8').catch(() => null);
20
21
  if (existing === schemaStr) {
21
22
  return { isCreated: false, diffResult: null };
22
23
  }
23
24
  await fs.writeFile(segmentPath, schemaStr);
24
25
  if (existing) {
25
- return { isCreated: false, diffResult: diffSchema(JSON.parse(existing), schema) };
26
+ return {
27
+ isCreated: false,
28
+ diffResult: diffSegmentSchema(JSON.parse(existing), segmentSchema),
29
+ };
26
30
  }
27
31
  return { isCreated: true, diffResult: null };
28
32
  }
@@ -0,0 +1,3 @@
1
+ import type { ProjectInfo } from '../getProjectInfo/index.mjs';
2
+ import type { Segment } from '../locateSegments.mjs';
3
+ export default function ensureClient(projectInfo: ProjectInfo, locatedSegments: Segment[]): Promise<void>;
@@ -0,0 +1,32 @@
1
+ import { VovkSchemaIdEnum } from 'vovk';
2
+ import { generate } from './generate.mjs';
3
+ const getEmptySegmentRecordSchema = (segmentNames) => {
4
+ const result = {};
5
+ for (const segmentName of segmentNames) {
6
+ result[segmentName] = {
7
+ $schema: VovkSchemaIdEnum.SEGMENT,
8
+ segmentName,
9
+ segmentType: 'segment',
10
+ emitSchema: false,
11
+ controllers: {},
12
+ };
13
+ }
14
+ return result;
15
+ };
16
+ export default async function ensureClient(projectInfo, locatedSegments) {
17
+ return generate({
18
+ isEnsuringClient: true,
19
+ projectInfo,
20
+ fullSchema: {
21
+ $schema: VovkSchemaIdEnum.SCHEMA,
22
+ segments: getEmptySegmentRecordSchema(locatedSegments.map(({ segmentName }) => segmentName)),
23
+ meta: {
24
+ $schema: VovkSchemaIdEnum.META,
25
+ config: {
26
+ $schema: VovkSchemaIdEnum.CONFIG,
27
+ },
28
+ },
29
+ },
30
+ locatedSegments,
31
+ });
32
+ }
@@ -0,0 +1,15 @@
1
+ import { type VovkSchema, type VovkStrictConfig } from 'vovk';
2
+ import type { PackageJson } from 'type-fest';
3
+ import type { ProjectInfo } from '../getProjectInfo/index.mjs';
4
+ import type { GenerateOptions } from '../types.mjs';
5
+ import type { Segment } from '../locateSegments.mjs';
6
+ export declare function generate({ isEnsuringClient, projectInfo, forceNothingWrittenLog, fullSchema, locatedSegments, cliGenerateOptions, package: argPackageJson, readme: argReadme, }: {
7
+ isEnsuringClient?: boolean;
8
+ projectInfo: ProjectInfo;
9
+ forceNothingWrittenLog?: boolean;
10
+ fullSchema: VovkSchema;
11
+ locatedSegments: Segment[];
12
+ cliGenerateOptions?: GenerateOptions;
13
+ package?: PackageJson;
14
+ readme?: VovkStrictConfig['bundle']['readme'];
15
+ }): Promise<void>;