arri 0.43.2 → 0.45.0

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.
@@ -0,0 +1,436 @@
1
+ 'use strict';
2
+
3
+ const fs = require('node:fs');
4
+ const fs$1 = require('node:fs/promises');
5
+ const codegenUtils = require('@arrirpc/codegen-utils');
6
+ const listhen = require('@joshmossas/listhen');
7
+ const c12 = require('c12');
8
+ const citty = require('citty');
9
+ const esbuild = require('esbuild');
10
+ const ofetch = require('ofetch');
11
+ const path = require('pathe');
12
+ const consola = require('consola');
13
+ const prettier = require('prettier');
14
+ const scule = require('scule');
15
+
16
+ function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
17
+
18
+ function _interopNamespaceCompat(e) {
19
+ if (e && typeof e === 'object' && 'default' in e) return e;
20
+ const n = Object.create(null);
21
+ if (e) {
22
+ for (const k in e) {
23
+ n[k] = e[k];
24
+ }
25
+ }
26
+ n.default = e;
27
+ return n;
28
+ }
29
+
30
+ const fs__default = /*#__PURE__*/_interopDefaultCompat(fs$1);
31
+ const esbuild__namespace = /*#__PURE__*/_interopNamespaceCompat(esbuild);
32
+ const path__default = /*#__PURE__*/_interopDefaultCompat(path);
33
+ const prettier__default = /*#__PURE__*/_interopDefaultCompat(prettier);
34
+
35
+ function isArriConfig(input) {
36
+ if (typeof input !== "object" || input === null) {
37
+ return false;
38
+ }
39
+ if ("generators" in input) {
40
+ if (!Array.isArray(input.generators)) {
41
+ return false;
42
+ }
43
+ }
44
+ if ("port" in input) {
45
+ if (typeof input.port !== "number") {
46
+ return false;
47
+ }
48
+ if (Number.isNaN(input.port)) {
49
+ return false;
50
+ }
51
+ }
52
+ if ("entry" in input && typeof input.entry !== "string") {
53
+ return false;
54
+ }
55
+ return true;
56
+ }
57
+ function isResolvedArriConfig(input) {
58
+ if (!isArriConfig(input)) {
59
+ return false;
60
+ }
61
+ return typeof input.rootDir === "string" && typeof input.srcDir === "string" && (typeof input.procedureDir === "string" || typeof input.procedureDir === "boolean") && Array.isArray(input.procedureGlobPatterns) && Array.isArray(input.generators);
62
+ }
63
+ const defaultConfig = {
64
+ port: 3e3,
65
+ rootDir: ".",
66
+ srcDir: "src",
67
+ entry: "app.ts",
68
+ serverEntry: "",
69
+ procedureDir: "procedures",
70
+ procedureGlobPatterns: ["**/*.rpc.ts"],
71
+ generators: [],
72
+ buildDir: ".arri",
73
+ esbuild: {},
74
+ https: false,
75
+ http2: false,
76
+ devServer: {}
77
+ };
78
+ function defineConfig(config) {
79
+ return {
80
+ port: config.port ?? defaultConfig.port,
81
+ rootDir: config.rootDir ?? defaultConfig.rootDir,
82
+ srcDir: config.srcDir ?? defaultConfig.srcDir,
83
+ entry: config.entry ?? defaultConfig.entry,
84
+ procedureDir: config.procedureDir ?? defaultConfig.procedureDir,
85
+ procedureGlobPatterns: config.procedureGlobPatterns ?? defaultConfig.procedureGlobPatterns,
86
+ generators: config.generators ?? defaultConfig.generators,
87
+ buildDir: config.buildDir ?? defaultConfig.buildDir,
88
+ esbuild: config.esbuild ?? defaultConfig.esbuild,
89
+ serverEntry: config.serverEntry ?? "",
90
+ https: config.https ?? false,
91
+ http2: config.http2 ?? false,
92
+ devServer: config.devServer ?? {}
93
+ };
94
+ }
95
+
96
+ const logger = consola.createConsola().withTag("arri");
97
+ const GEN_APP_FILE = "__arri_app.ts";
98
+ const GEN_SERVER_ENTRY_FILE = "__arri_server.ts";
99
+ const OUT_APP_FILE = "app.mjs";
100
+ const OUT_SERVER_ENTRY = "server.mjs";
101
+ const OUT_CODEGEN = "codegen.mjs";
102
+ async function setupWorkingDir(config) {
103
+ const arriDir = path__default.resolve(config.rootDir, config.buildDir);
104
+ const outDir = path__default.resolve(config.rootDir, ".output");
105
+ if (fs.existsSync(arriDir)) {
106
+ await fs__default.rm(arriDir, { recursive: true, force: true });
107
+ }
108
+ if (fs.existsSync(outDir)) {
109
+ await fs__default.rm(outDir, { recursive: true, force: true });
110
+ }
111
+ await fs__default.mkdir(arriDir);
112
+ await fs__default.mkdir(outDir);
113
+ }
114
+ async function createAppWithRoutesModule(config) {
115
+ const glob = await import('globby');
116
+ const appModule = path__default.resolve(config.rootDir, config.srcDir, config.entry);
117
+ const appImportParts = path__default.relative(path__default.resolve(config.rootDir, config.buildDir), appModule).split(".");
118
+ appImportParts.pop();
119
+ const routes = [];
120
+ const existingRoutes = [];
121
+ await Promise.all(
122
+ config.procedureGlobPatterns.map(async (pattern) => {
123
+ const results = await getFsRouteBatch(glob.globby, pattern, config);
124
+ for (const result of results) {
125
+ if (!existingRoutes.includes(result.name)) {
126
+ routes.push(result);
127
+ existingRoutes.push(result.name);
128
+ }
129
+ }
130
+ })
131
+ );
132
+ routes.sort((a, b) => a.name < b.name ? -1 : 1);
133
+ const module = await prettier__default.format(
134
+ `import sourceMapSupport from 'source-map-support';
135
+ sourceMapSupport.install();
136
+ import app from '${appImportParts.join(".")}';
137
+ ${routes.map(
138
+ (route) => `import ${route.importName} from '${route.importPath}';`
139
+ ).join("\n")}
140
+ const routes: {id: string; route: any}[] = [${routes.map(
141
+ (route) => `{ id: '${route.name}', route: ${route.importName} }`
142
+ ).join(",\n")}
143
+ ];
144
+ for(const route of routes) {
145
+ if(route.route.transport === 'http') {
146
+ app.rpc({
147
+ name: route.id,
148
+ ...route.route,
149
+ });
150
+ continue;
151
+ }
152
+ if (route.route.transport === 'ws') {
153
+ app.wsRpc({
154
+ name: route.id,
155
+ ...route.route,
156
+ });
157
+ continue;
158
+ }
159
+ }
160
+ export default app`,
161
+ { parser: "typescript", tabWidth: 4 }
162
+ );
163
+ await fs__default.writeFile(
164
+ path__default.resolve(config.rootDir, config.buildDir, GEN_APP_FILE),
165
+ module
166
+ );
167
+ }
168
+ async function getFsRouteBatch(glob, globPattern, config) {
169
+ if (!config.procedureDir) {
170
+ return [];
171
+ }
172
+ const target = `${config.rootDir}/${config.srcDir}/${config.procedureDir}/${globPattern}`.split("//").join("/").split("//").join("/");
173
+ const files = await glob(target, {
174
+ onlyFiles: true
175
+ });
176
+ const routes = [];
177
+ for (const file of files) {
178
+ const meta = getRpcMetaFromPath(config, file);
179
+ if (meta) {
180
+ const importParts = path__default.relative(path__default.resolve(config.rootDir, config.buildDir), file).split(".");
181
+ importParts.pop();
182
+ importParts.push("js");
183
+ routes.push({
184
+ name: meta.id,
185
+ importName: scule.camelCase(meta.id.split(".").join("_")),
186
+ importPath: `./${importParts.join(".")}`
187
+ });
188
+ }
189
+ }
190
+ return routes;
191
+ }
192
+ const disallowedNameChars = "~`!@#$%^&*()-+=[]{}\\|:;\"'<>,./";
193
+ const getRpcMetaFromPath = (config, filePath) => {
194
+ if (!config.procedureDir) {
195
+ return void 0;
196
+ }
197
+ const resolvedFilePath = filePath.split("./").join("/");
198
+ const parts = resolvedFilePath.split("/");
199
+ const reversedParts = [...parts].reverse();
200
+ const nameParts = [];
201
+ for (const part of reversedParts) {
202
+ if (part === config.procedureDir) {
203
+ break;
204
+ }
205
+ nameParts.push(part);
206
+ }
207
+ const fileName = nameParts.reverse().pop() ?? "";
208
+ const serviceParts = nameParts.filter((part) => part.trim().length > 0).map((part) => codegenUtils.removeDisallowedChars(part, disallowedNameChars));
209
+ const fileNameParts = fileName.split(".");
210
+ if (!fileNameParts.length) {
211
+ return void 0;
212
+ }
213
+ const rpcName = codegenUtils.removeDisallowedChars(
214
+ fileNameParts[0],
215
+ disallowedNameChars
216
+ );
217
+ const httpParts = [
218
+ ...serviceParts.map((part) => scule.kebabCase(part)),
219
+ scule.kebabCase(rpcName)
220
+ ];
221
+ return {
222
+ id: [...serviceParts, rpcName].join("."),
223
+ httpPath: `/${httpParts.join("/")}`
224
+ };
225
+ };
226
+ function isInsideDir(dir, parentDir) {
227
+ if (path__default.resolve(dir).startsWith(path__default.resolve(parentDir))) {
228
+ return true;
229
+ }
230
+ return false;
231
+ }
232
+
233
+ const DEV_ENDPOINT_ROOT = `/__arri_dev__`;
234
+ const DEV_DEFINITION_ENDPOINT = `${DEV_ENDPOINT_ROOT}/__definition`;
235
+ const dev = citty.defineCommand({
236
+ meta: {
237
+ name: "dev",
238
+ description: "Start the arri dev server"
239
+ },
240
+ args: {
241
+ config: {
242
+ type: "string",
243
+ description: "Path to the arri config file",
244
+ alias: "c",
245
+ default: "./arri.config.ts"
246
+ }
247
+ },
248
+ async run({ args }) {
249
+ process.env.ARRI_DEV_MODE = "true";
250
+ const { config } = await c12.loadConfig({
251
+ configFile: path__default.resolve(args.config)
252
+ });
253
+ if (!isResolvedArriConfig(config)) {
254
+ throw new Error("Unable to find config");
255
+ }
256
+ const appEntry = path__default.resolve(
257
+ config.rootDir,
258
+ config.srcDir,
259
+ config.entry
260
+ );
261
+ if (!fs.existsSync(appEntry)) {
262
+ throw new Error(`Unable to find entry at ${appEntry}`);
263
+ }
264
+ await startDevServer(config);
265
+ }
266
+ });
267
+ const startListener = (config, showQr = false) => listhen.listenAndWatch(path__default.resolve(config.rootDir, ".output", OUT_SERVER_ENTRY), {
268
+ public: true,
269
+ port: config.port,
270
+ logger,
271
+ qr: showQr,
272
+ https: config.https,
273
+ http2: config.http2,
274
+ ws: true
275
+ });
276
+ async function bundleFilesContext(config) {
277
+ const serverContent = `import app from './${OUT_APP_FILE}';
278
+
279
+ export default app.h3App;`;
280
+ await fs__default.writeFile(
281
+ path__default.resolve(config.rootDir, ".output", OUT_SERVER_ENTRY),
282
+ serverContent
283
+ );
284
+ return await esbuild__namespace.context({
285
+ ...config.esbuild,
286
+ entryPoints: [
287
+ path__default.resolve(config.rootDir, config.buildDir, GEN_APP_FILE)
288
+ ],
289
+ outfile: path__default.resolve(config.rootDir, ".output", OUT_APP_FILE),
290
+ format: "esm",
291
+ bundle: true,
292
+ packages: "external",
293
+ sourcemap: config.esbuild.sourcemap ?? true,
294
+ target: config.esbuild.target ?? "node20",
295
+ platform: config.esbuild.platform ?? "node"
296
+ });
297
+ }
298
+ async function startDevServer(config) {
299
+ await setupWorkingDir(config);
300
+ const watcher = await import('chokidar');
301
+ let fileWatcher;
302
+ await Promise.all([
303
+ createEntryModule(config),
304
+ createAppWithRoutesModule(config)
305
+ ]);
306
+ const context = await bundleFilesContext(config);
307
+ await context.rebuild();
308
+ const listener = await startListener(config, true);
309
+ setTimeout(async () => {
310
+ await generateClients(config);
311
+ }, 1e3);
312
+ const cleanExit = async () => {
313
+ process.exit();
314
+ };
315
+ process.on("exit", async () => {
316
+ await Promise.allSettled([
317
+ listener.close(),
318
+ fileWatcher?.close(),
319
+ context.dispose()
320
+ ]);
321
+ });
322
+ process.on("SIGINT", cleanExit);
323
+ process.on("SIGTERM", cleanExit);
324
+ async function load(isRestart, reason) {
325
+ if (fileWatcher) {
326
+ await fileWatcher.close();
327
+ }
328
+ const srcDir = path__default.resolve(config.rootDir ?? "", config.srcDir);
329
+ const dirsToWatch = [srcDir];
330
+ if (config.esbuild.alias) {
331
+ for (const key of Object.keys(config.esbuild.alias)) {
332
+ const alias = config.esbuild.alias[key];
333
+ if (alias) {
334
+ if (!isInsideDir(alias, srcDir)) {
335
+ dirsToWatch.push(alias);
336
+ }
337
+ }
338
+ }
339
+ }
340
+ if (config.devServer.additionalWatchDirs?.length) {
341
+ for (const dir of config.devServer.additionalWatchDirs) {
342
+ dirsToWatch.push(dir);
343
+ }
344
+ }
345
+ const buildDir = path__default.resolve(config.rootDir, config.buildDir);
346
+ const outDir = path__default.resolve(config.rootDir, ".output");
347
+ fileWatcher = watcher.watch(dirsToWatch, {
348
+ ignoreInitial: true,
349
+ ignored: [
350
+ buildDir,
351
+ outDir,
352
+ "**/.output",
353
+ "**/dist/**",
354
+ "**/node_modules/**",
355
+ "**/.git/**"
356
+ ]
357
+ });
358
+ fileWatcher.on("all", async (eventName, path2) => {
359
+ if (eventName === "addDir" || eventName === "add") {
360
+ return;
361
+ }
362
+ await createAppWithRoutesModule(config);
363
+ let bundleCreated = false;
364
+ try {
365
+ logger.log(
366
+ "Change detected. Bundling files and restarting server...."
367
+ );
368
+ await context.rebuild();
369
+ bundleCreated = true;
370
+ } catch (err) {
371
+ logger.error("ERROR", err);
372
+ bundleCreated = false;
373
+ }
374
+ if (bundleCreated && config.generators.length) {
375
+ setTimeout(async () => {
376
+ await generateClients(config);
377
+ bundleCreated = false;
378
+ }, 1e3);
379
+ }
380
+ });
381
+ }
382
+ await load();
383
+ }
384
+ async function generateClients(config) {
385
+ try {
386
+ const protocol = config.https === true || typeof config.https === "object" ? "https" : "http";
387
+ if (protocol === "https") {
388
+ process.env.NODE_TLS_REJECT_UNAUTHORIZED = "0";
389
+ }
390
+ const result = await ofetch.ofetch(
391
+ `${protocol}://127.0.0.1:${config.port}${DEV_DEFINITION_ENDPOINT}`
392
+ );
393
+ if (!codegenUtils.isAppDefinition(result)) {
394
+ return;
395
+ }
396
+ logger.log(`Generating client code...`);
397
+ const clientCount = config.generators.length;
398
+ await Promise.allSettled(
399
+ config.generators.map(
400
+ (generator) => generator.generator(result, true)
401
+ )
402
+ );
403
+ logger.success(
404
+ `Generated ${clientCount} client${clientCount === 1 ? "" : "s"}`
405
+ );
406
+ } catch (err) {
407
+ logger.error(err);
408
+ }
409
+ }
410
+ async function createEntryModule(config) {
411
+ const appModule = path__default.resolve(config.rootDir, config.srcDir, config.entry);
412
+ const appImportParts = path__default.relative(path__default.resolve(config.rootDir, config.srcDir), appModule).split(".");
413
+ appImportParts.pop();
414
+ const virtualEntry = `import { toNodeListener } from 'h3';
415
+ import app from './${GEN_APP_FILE}';
416
+
417
+ export default app.h3App;`;
418
+ await fs__default.writeFile(
419
+ path__default.resolve(config.rootDir, config.buildDir, GEN_SERVER_ENTRY_FILE),
420
+ virtualEntry
421
+ );
422
+ }
423
+
424
+ exports.DEV_DEFINITION_ENDPOINT = DEV_DEFINITION_ENDPOINT;
425
+ exports.GEN_APP_FILE = GEN_APP_FILE;
426
+ exports.OUT_APP_FILE = OUT_APP_FILE;
427
+ exports.OUT_CODEGEN = OUT_CODEGEN;
428
+ exports.OUT_SERVER_ENTRY = OUT_SERVER_ENTRY;
429
+ exports.createAppWithRoutesModule = createAppWithRoutesModule;
430
+ exports.defaultConfig = defaultConfig;
431
+ exports.defineConfig = defineConfig;
432
+ exports.dev = dev;
433
+ exports.isArriConfig = isArriConfig;
434
+ exports.isResolvedArriConfig = isResolvedArriConfig;
435
+ exports.logger = logger;
436
+ exports.setupWorkingDir = setupWorkingDir;