arri 0.57.3 → 0.57.5

package/README.md

@@ -5,19 +5,62 @@ Command line interface for ARRI-RPC
 ## Table of Contents
 
 -   [Commands](#commands)
+-   [Running code generators](#running-code-generators)
 -   [Usage with @arrirpc/server](#usage-with-arrirpcserver)
 
 ## Commands
 
 Run `arri --help` to get a full list of commands
 
-| Cmd                  | Description                                                                                                                                    |
-| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
-| codegen [input-file] | Run generate clients specified in the `arri.config.ts`. See [here](/README.md#creating-schemas-for-custom-server-implementations) for details. |
-| init [dir]           | Scaffold an arri app/library                                                                                                                   |
-| list                 | List available arri versions                                                                                                                   |
-| use [version]        | Update arri dependencies to a specific version (checks recursively for package.json, pubspec.yaml, cargo.toml, etc)                            |
-| version              | Print current CLI version                                                                                                                      |
+| Cmd                  | Description                                                                                                         |
+| -------------------- | ------------------------------------------------------------------------------------------------------------------- |
+| codegen [input-file] | Run generate clients specified in the `arri.config.ts`. See [here](#running-arri-codegen) for details.              |
+| init [dir]           | Scaffold an arri app/library                                                                                        |
+| list                 | List available arri versions                                                                                        |
+| use [version]        | Update arri dependencies to a specific version (checks recursively for package.json, pubspec.yaml, cargo.toml, etc) |
+| version              | Print current CLI version                                                                                           |
+
+## Running code generators
+
+Before running codegen you need to setup a valid Arri Config
+
+```ts
+// arri.config.ts
+import { defineConfig, generators } from "arri";
+
+export default defineConfig({
+    generators: [
+        generators.dartClient({
+            clientName: "Client",
+            outputPath: "<some-output-file>",
+        }),
+        generators.typescriptClient({
+            clientName: "Client",
+            outputPath: "<some-output-file>",
+        }),
+        // etc...
+    ],
+});
+```
+
+Run the codegen command
+
+```bash
+# run generators from an app definition file
+# app definition files can be TS, JS, or JSON
+arri codegen AppDefinition.ts
+arri codegen AppDefinition.json
+
+# run generators from an app definition JSON http endpoint
+arri codegen https://example.com/__definition
+```
+
+### Codegen Flags
+
+| Flag     | Aliases | Description                                                                                                               |
+| -------- | ------- | ------------------------------------------------------------------------------------------------------------------------- |
+| --config | -c      | Path to an arri config. Default is `arri.config.ts`                                                                       |
+| --watch  | -w      | Watch an app definition file for changes. Only works on files. It will throw an error if invoked against an HTTP endpoint |
 
 ## Usage with @arrirpc/server
 

package/dist/cli.cjs

@@ -11,7 +11,8 @@ const esbuild = require('esbuild');
 const esbuildPluginReplace = require('esbuild-plugin-replace');
 const path = require('pathe');
 const prettier = require('prettier');
-const dev = require('./shared/arri.976d7393.cjs');
+const dev = require('./shared/arri.09919c6d.cjs');
+const chokidar = require('chokidar');
 const ofetch = require('ofetch');
 const Degit = require('degit');
 const enquirer = require('enquirer');
@@ -95,11 +96,14 @@ async function startBuild(config, skipCodeGen = false) {
     );
     const def = JSON.parse(fs.readFileSync(defJson, { encoding: "utf-8" }));
     if (codegenUtils.isAppDefinition(def) && clientCount > 0) {
-      dev.logger.log(`Generating ${clientCount} clients`);
+      const startTime = (/* @__PURE__ */ new Date()).getTime();
+      dev.logger.log(`Generating ${clientCount} client(s)...`);
       await Promise.all(
         config.generators.map((plugin) => plugin.generator(def))
       );
-      dev.logger.log(`${clientCount} clients generated`);
+      dev.logger.log(
+        `${clientCount} client(s) generated in ${( new Date()).getTime() - startTime}ms`
+      );
     } else {
       dev.logger.warn(
         "No client generators specified. Skipping client codegen."
@@ -212,7 +216,8 @@ async function createCodegenEntryFile(config) {
     writeFileSync(
         path.resolve(__dirname, "../.output", "__definition.json"),
         JSON.stringify(def),
-    );`,
+    );
+    process.exit(0);`,
     { tabWidth: 4, parser: "typescript" }
   );
   await fs__default.writeFile(
@@ -236,74 +241,136 @@ const codegen = citty.defineCommand({
       type: "string",
       alias: ["c"],
       default: "arri.config.ts"
+    },
+    watch: {
+      type: "boolean",
+      alias: ["w"],
+      default: false
     }
   },
   async run({ args }) {
+    if (!fs__default$1.existsSync(path__default.resolve(args.config))) {
+      dev.logger.error(
+        `Unable to load arri config at ${args.config}. Please specify a valid config path with --config`
+      );
+      process.exit(1);
+    }
+    const { config } = await c12.loadConfig({
+      configFile: path__default.resolve(args.config)
+    });
+    if (!dev.isArriConfig(config)) {
+      dev.logger.error(`Invalid arri config at ${args.config}`);
+      process.exit(1);
+    }
+    if (!config.generators?.length) {
+      dev.logger.error(`No generators specified in ${args.config}`);
+      process.exit(1);
+    }
     const isUrl = args.schema.startsWith("http://") || args.schema.startsWith("https://");
-    const isTs = args.schema.endsWith(".ts");
-    const isJs = args.schema.endsWith(".js");
     let def;
     if (isUrl) {
+      if (args.watch)
+        throw new Error("Cannot watch a URL");
       const result = await ofetch.ofetch(args.schema);
       if (!codegenUtils.isAppDefinition(result)) {
         throw new Error(`Invalid App Definition at ${args.schema}`);
       }
       def = result;
     } else {
-      if (!fs__default$1.existsSync(args.schema)) {
-        throw new Error(`Unable to find ${args.schema}`);
-      }
-      if (isTs || isJs) {
-        const schemaResult = await c12.loadConfig({
-          configFile: args.schema
-        });
-        if (!codegenUtils.isAppDefinition(schemaResult.config)) {
-          throw new Error(`Invalid App Definition at ${args.schema}`);
+      try {
+        def = await getAppDefinitionFromFile(args.schema);
+      } catch (err) {
+        if (!args.watch) {
+          throw err;
         }
-        def = schemaResult.config;
-      } else {
-        const jsonString = JSON.parse(
-          fs__default$1.readFileSync(args.schema, { encoding: "utf-8" })
-        );
-        if (!codegenUtils.isAppDefinition(jsonString)) {
-          throw new Error(`Invalid App Definition at ${args.schema}`);
-        }
-        def = jsonString;
+        dev.logger.error(err);
       }
     }
-    if (!def) {
+    if (!def && !args.watch) {
       throw new Error(`Unable to find App Definition at ${args.schema}`);
     }
-    if (!fs__default$1.existsSync(path__default.resolve(args.config))) {
-      throw new Error(
-        `Unable to load arri config at ${args.config}. Please specify a valid config path with --config`
+    if (def) {
+      const initialStartTime = /* @__PURE__ */ new Date();
+      await runGenerators(def, config.generators ?? []);
+      dev.logger.success(
+        `Generators completed in ${( new Date()).getTime() - initialStartTime.getTime()}ms`
       );
     }
-    const configPath = path__default.resolve(args.config);
-    const { config } = await c12.loadConfig({ configFile: configPath });
-    if (!dev.isArriConfig(config)) {
-      throw new Error(`Invalid arri config at ${args.config}`);
-    }
-    if (!config.generators?.length) {
-      dev.logger.warn(`No generators specified in ${args.config}`);
-      process.exit(1);
+    if (!args.watch)
+      process.exit(0);
+    const watcher = chokidar.watch(args.schema, { ignoreInitial: true });
+    dev.logger.info(`Watching ${args.schema} for changes...`);
+    watcher.on("add", async (_, __) => {
+      try {
+        dev.logger.info(`Change detected`);
+        const startTime = /* @__PURE__ */ new Date();
+        await runGenerators(
+          await getAppDefinitionFromFile(args.schema),
+          config.generators ?? []
+        );
+        dev.logger.success(
+          `Generators completed in ${( new Date()).getTime() - startTime.getTime()}ms`
+        );
+      } catch (err) {
+        dev.logger.error(err);
+      }
+    });
+    watcher.on("change", async (_, __) => {
+      try {
+        dev.logger.info(`Change detected in AppDefinition file.`);
+        const startTime = /* @__PURE__ */ new Date();
+        await runGenerators(
+          await getAppDefinitionFromFile(args.schema),
+          config.generators ?? []
+        );
+        dev.logger.success(
+          `Generators completed in ${( new Date()).getTime() - startTime.getTime()}ms`
+        );
+      } catch (err) {
+        dev.logger.error(err);
+      }
+    });
+  }
+});
+async function getAppDefinitionFromFile(file) {
+  if (!fs__default$1.existsSync(file)) {
+    throw new Error(`Unable to find ${file}`);
+  }
+  const isTs = file.endsWith(".ts");
+  const isJs = file.endsWith(".js");
+  if (isTs || isJs) {
+    const schemaResult = await c12.loadConfig({
+      configFile: file
+    });
+    if (!codegenUtils.isAppDefinition(schemaResult.config)) {
+      throw new Error(`Invalid App Definition at ${file}`);
     }
-    dev.logger.info(`Generating ${config.generators?.length} client(s)`);
-    await Promise.allSettled(
-      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-      config.generators.map(
-        (gen) => gen.generator(
-          def ?? {
-            schemaVersion: "0.0.6",
-            procedures: {},
-            definitions: {}
-          }
-        )
-      )
+    return schemaResult.config;
+  } else {
+    const parsingResult = JSON.parse(
+      fs__default$1.readFileSync(file, { encoding: "utf-8" })
     );
-    process.exit(0);
+    if (!codegenUtils.isAppDefinition(parsingResult)) {
+      throw new Error(`Invalid App Definition at ${file}`);
+    }
+    return parsingResult;
   }
-});
+}
+async function runGenerators(def, generators) {
+  dev.logger.info(`Generating ${generators?.length} client(s)`);
+  await Promise.allSettled(
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    generators.map(
+      (gen) => gen.generator(
+        def ?? {
+          schemaVersion: "0.0.6",
+          procedures: {},
+          definitions: {}
+        }
+      )
+    )
+  );
+}
 
 const init = citty.defineCommand({
   meta: {

package/dist/cli.mjs

@@ -9,7 +9,8 @@ import { build as build$1 } from 'esbuild';
 import { replace } from 'esbuild-plugin-replace';
 import path from 'pathe';
 import prettier from 'prettier';
-import { d as defaultConfig, l as logger, s as setupWorkingDir, c as createAppWithRoutesModule, O as OUT_CODEGEN, e as OUT_SERVER_ENTRY, G as GEN_APP_FILE, f as OUT_APP_FILE, i as isArriConfig, g as getArriPackageMetadata, h as dev } from './shared/arri.1de410ff.mjs';
+import { d as defaultConfig, l as logger, s as setupWorkingDir, c as createAppWithRoutesModule, O as OUT_CODEGEN, e as OUT_SERVER_ENTRY, G as GEN_APP_FILE, f as OUT_APP_FILE, i as isArriConfig, g as getArriPackageMetadata, h as dev } from './shared/arri.339f2f92.mjs';
+import { watch } from 'chokidar';
 import { ofetch } from 'ofetch';
 import Degit from 'degit';
 import enquirer from 'enquirer';
@@ -82,11 +83,14 @@ async function startBuild(config, skipCodeGen = false) {
     );
     const def = JSON.parse(readFileSync(defJson, { encoding: "utf-8" }));
     if (isAppDefinition(def) && clientCount > 0) {
-      logger.log(`Generating ${clientCount} clients`);
+      const startTime = (/* @__PURE__ */ new Date()).getTime();
+      logger.log(`Generating ${clientCount} client(s)...`);
       await Promise.all(
         config.generators.map((plugin) => plugin.generator(def))
       );
-      logger.log(`${clientCount} clients generated`);
+      logger.log(
+        `${clientCount} client(s) generated in ${( new Date()).getTime() - startTime}ms`
+      );
     } else {
       logger.warn(
         "No client generators specified. Skipping client codegen."
@@ -199,7 +203,8 @@ async function createCodegenEntryFile(config) {
     writeFileSync(
         path.resolve(__dirname, "../.output", "__definition.json"),
         JSON.stringify(def),
-    );`,
+    );
+    process.exit(0);`,
     { tabWidth: 4, parser: "typescript" }
   );
   await fs.writeFile(
@@ -223,74 +228,136 @@ const codegen = defineCommand({
       type: "string",
       alias: ["c"],
       default: "arri.config.ts"
+    },
+    watch: {
+      type: "boolean",
+      alias: ["w"],
+      default: false
     }
   },
   async run({ args }) {
+    if (!fs$1.existsSync(path.resolve(args.config))) {
+      logger.error(
+        `Unable to load arri config at ${args.config}. Please specify a valid config path with --config`
+      );
+      process.exit(1);
+    }
+    const { config } = await loadConfig({
+      configFile: path.resolve(args.config)
+    });
+    if (!isArriConfig(config)) {
+      logger.error(`Invalid arri config at ${args.config}`);
+      process.exit(1);
+    }
+    if (!config.generators?.length) {
+      logger.error(`No generators specified in ${args.config}`);
+      process.exit(1);
+    }
     const isUrl = args.schema.startsWith("http://") || args.schema.startsWith("https://");
-    const isTs = args.schema.endsWith(".ts");
-    const isJs = args.schema.endsWith(".js");
     let def;
     if (isUrl) {
+      if (args.watch)
+        throw new Error("Cannot watch a URL");
       const result = await ofetch(args.schema);
       if (!isAppDefinition(result)) {
         throw new Error(`Invalid App Definition at ${args.schema}`);
       }
       def = result;
     } else {
-      if (!fs$1.existsSync(args.schema)) {
-        throw new Error(`Unable to find ${args.schema}`);
-      }
-      if (isTs || isJs) {
-        const schemaResult = await loadConfig({
-          configFile: args.schema
-        });
-        if (!isAppDefinition(schemaResult.config)) {
-          throw new Error(`Invalid App Definition at ${args.schema}`);
+      try {
+        def = await getAppDefinitionFromFile(args.schema);
+      } catch (err) {
+        if (!args.watch) {
+          throw err;
         }
-        def = schemaResult.config;
-      } else {
-        const jsonString = JSON.parse(
-          fs$1.readFileSync(args.schema, { encoding: "utf-8" })
-        );
-        if (!isAppDefinition(jsonString)) {
-          throw new Error(`Invalid App Definition at ${args.schema}`);
-        }
-        def = jsonString;
+        logger.error(err);
       }
     }
-    if (!def) {
+    if (!def && !args.watch) {
       throw new Error(`Unable to find App Definition at ${args.schema}`);
     }
-    if (!fs$1.existsSync(path.resolve(args.config))) {
-      throw new Error(
-        `Unable to load arri config at ${args.config}. Please specify a valid config path with --config`
+    if (def) {
+      const initialStartTime = /* @__PURE__ */ new Date();
+      await runGenerators(def, config.generators ?? []);
+      logger.success(
+        `Generators completed in ${( new Date()).getTime() - initialStartTime.getTime()}ms`
       );
     }
-    const configPath = path.resolve(args.config);
-    const { config } = await loadConfig({ configFile: configPath });
-    if (!isArriConfig(config)) {
-      throw new Error(`Invalid arri config at ${args.config}`);
-    }
-    if (!config.generators?.length) {
-      logger.warn(`No generators specified in ${args.config}`);
-      process.exit(1);
+    if (!args.watch)
+      process.exit(0);
+    const watcher = watch(args.schema, { ignoreInitial: true });
+    logger.info(`Watching ${args.schema} for changes...`);
+    watcher.on("add", async (_, __) => {
+      try {
+        logger.info(`Change detected`);
+        const startTime = /* @__PURE__ */ new Date();
+        await runGenerators(
+          await getAppDefinitionFromFile(args.schema),
+          config.generators ?? []
+        );
+        logger.success(
+          `Generators completed in ${( new Date()).getTime() - startTime.getTime()}ms`
+        );
+      } catch (err) {
+        logger.error(err);
+      }
+    });
+    watcher.on("change", async (_, __) => {
+      try {
+        logger.info(`Change detected in AppDefinition file.`);
+        const startTime = /* @__PURE__ */ new Date();
+        await runGenerators(
+          await getAppDefinitionFromFile(args.schema),
+          config.generators ?? []
+        );
+        logger.success(
+          `Generators completed in ${( new Date()).getTime() - startTime.getTime()}ms`
+        );
+      } catch (err) {
+        logger.error(err);
+      }
+    });
+  }
+});
+async function getAppDefinitionFromFile(file) {
+  if (!fs$1.existsSync(file)) {
+    throw new Error(`Unable to find ${file}`);
+  }
+  const isTs = file.endsWith(".ts");
+  const isJs = file.endsWith(".js");
+  if (isTs || isJs) {
+    const schemaResult = await loadConfig({
+      configFile: file
+    });
+    if (!isAppDefinition(schemaResult.config)) {
+      throw new Error(`Invalid App Definition at ${file}`);
     }
-    logger.info(`Generating ${config.generators?.length} client(s)`);
-    await Promise.allSettled(
-      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-      config.generators.map(
-        (gen) => gen.generator(
-          def ?? {
-            schemaVersion: "0.0.6",
-            procedures: {},
-            definitions: {}
-          }
-        )
-      )
+    return schemaResult.config;
+  } else {
+    const parsingResult = JSON.parse(
+      fs$1.readFileSync(file, { encoding: "utf-8" })
     );
-    process.exit(0);
+    if (!isAppDefinition(parsingResult)) {
+      throw new Error(`Invalid App Definition at ${file}`);
+    }
+    return parsingResult;
   }
-});
+}
+async function runGenerators(def, generators) {
+  logger.info(`Generating ${generators?.length} client(s)`);
+  await Promise.allSettled(
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    generators.map(
+      (gen) => gen.generator(
+        def ?? {
+          schemaVersion: "0.0.6",
+          procedures: {},
+          definitions: {}
+        }
+      )
+    )
+  );
+}
 
 const init = defineCommand({
   meta: {

package/dist/index.cjs

@@ -4,7 +4,7 @@ const codegenDart = require('@arrirpc/codegen-dart');
 const codegenKotlin = require('@arrirpc/codegen-kotlin');
 const codegenRust = require('@arrirpc/codegen-rust');
 const codegenTs = require('@arrirpc/codegen-ts');
-const dev = require('./shared/arri.976d7393.cjs');
+const dev = require('./shared/arri.09919c6d.cjs');
 const codegenUtils = require('@arrirpc/codegen-utils');
 require('node:fs');
 require('@joshmossas/listhen');

package/dist/index.d.cts

@@ -34,6 +34,11 @@ interface ArriConfig {
          * Use this to add directories outside of the srcDir that should trigger a dev server reload
          */
         additionalWatchDirs?: string[];
+        /**
+         * If you want to serve both https and http on the dev server
+         */
+        httpWithHttps?: boolean;
+        httpWithHttpsPort?: number;
     };
 }
 declare function isArriConfig(input: unknown): input is ArriConfig;

package/dist/index.d.mts

@@ -34,6 +34,11 @@ interface ArriConfig {
          * Use this to add directories outside of the srcDir that should trigger a dev server reload
          */
         additionalWatchDirs?: string[];
+        /**
+         * If you want to serve both https and http on the dev server
+         */
+        httpWithHttps?: boolean;
+        httpWithHttpsPort?: number;
     };
 }
 declare function isArriConfig(input: unknown): input is ArriConfig;

package/dist/index.d.ts

@@ -34,6 +34,11 @@ interface ArriConfig {
          * Use this to add directories outside of the srcDir that should trigger a dev server reload
          */
         additionalWatchDirs?: string[];
+        /**
+         * If you want to serve both https and http on the dev server
+         */
+        httpWithHttps?: boolean;
+        httpWithHttpsPort?: number;
     };
 }
 declare function isArriConfig(input: unknown): input is ArriConfig;

package/dist/index.mjs

@@ -2,7 +2,7 @@ import { dartClientGenerator } from '@arrirpc/codegen-dart';
 import { kotlinClientGenerator } from '@arrirpc/codegen-kotlin';
 import { rustClientGenerator } from '@arrirpc/codegen-rust';
 import { typescriptClientGenerator } from '@arrirpc/codegen-ts';
-export { D as DEV_DEFINITION_ENDPOINT, d as defaultConfig, b as defineConfig, i as isArriConfig, a as isResolvedArriConfig } from './shared/arri.1de410ff.mjs';
+export { D as DEV_DEFINITION_ENDPOINT, d as defaultConfig, b as defineConfig, i as isArriConfig, a as isResolvedArriConfig } from './shared/arri.339f2f92.mjs';
 export { createAppDefinition } from '@arrirpc/codegen-utils';
 import 'node:fs';
 import '@joshmossas/listhen';

package/dist/shared/{arri.976d7393.cjs → arri.09919c6d.cjs}

@@ -364,6 +364,28 @@ async function createDevServer(config) {
       }
     }
   });
+  let secondaryListener;
+  if (config.devServer.httpWithHttps) {
+    secondaryListener = await listhen.listen(h3.toNodeListener(app), {
+      port: config.devServer.httpWithHttpsPort ?? config.port + 1,
+      https: false,
+      http2: config.http2,
+      public: true,
+      ws: {
+        resolve(info) {
+          if (ws?.resolve) {
+            return ws.resolve(info);
+          }
+          return {};
+        }
+      },
+      qr: false,
+      showURL: false
+    });
+    logger.info(
+      `Serving unencrypted traffic from port ${secondaryListener.address.port}`
+    );
+  }
   async function reload() {
     const appEntry = (await import(path__default.resolve(
       config.rootDir,
@@ -378,6 +400,7 @@ async function createDevServer(config) {
   return {
     h3App: app,
     listener,
+    secondaryListener,
     reload,
     ws
   };

package/dist/shared/{arri.1de410ff.mjs → arri.339f2f92.mjs}

@@ -343,6 +343,28 @@ async function createDevServer(config) {
       }
     }
   });
+  let secondaryListener;
+  if (config.devServer.httpWithHttps) {
+    secondaryListener = await listen(toNodeListener(app), {
+      port: config.devServer.httpWithHttpsPort ?? config.port + 1,
+      https: false,
+      http2: config.http2,
+      public: true,
+      ws: {
+        resolve(info) {
+          if (ws?.resolve) {
+            return ws.resolve(info);
+          }
+          return {};
+        }
+      },
+      qr: false,
+      showURL: false
+    });
+    logger.info(
+      `Serving unencrypted traffic from port ${secondaryListener.address.port}`
+    );
+  }
   async function reload() {
     const appEntry = (await import(path.resolve(
       config.rootDir,
@@ -357,6 +379,7 @@ async function createDevServer(config) {
   return {
     h3App: app,
     listener,
+    secondaryListener,
     reload,
     ws
   };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "arri",
-  "version": "0.57.3",
+  "version": "0.57.5",
   "type": "module",
   "license": "MIT",
   "author": {
@@ -39,12 +39,12 @@
     "ofetch": "^1.3.4",
     "pathe": "^1.1.2",
     "prettier": "^3.3.3",
-    "@arrirpc/codegen-dart": "0.57.3",
-    "@arrirpc/codegen-rust": "0.57.3",
-    "@arrirpc/codegen-kotlin": "0.57.3",
-    "@arrirpc/codegen-ts": "0.57.3",
-    "@arrirpc/schema": "0.57.3",
-    "@arrirpc/codegen-utils": "0.57.3"
+    "@arrirpc/codegen-dart": "0.57.5",
+    "@arrirpc/codegen-rust": "0.57.5",
+    "@arrirpc/codegen-ts": "0.57.5",
+    "@arrirpc/codegen-utils": "0.57.5",
+    "@arrirpc/schema": "0.57.5",
+    "@arrirpc/codegen-kotlin": "0.57.5"
   },
   "devDependencies": {
     "@types/degit": "^2.8.6"