rename region into residency

Author: tatomyr

docs/commands/login.md

@@ -32,14 +32,14 @@ Note that logging in with **Reunite** API does not allow you to use the `push` c
 
 ## Options
 
-| Option                   | Type    | Description                                                                                                                                        |
-| ------------------------ | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
-| --config                 | string  | Specify path to the [configuration file](../configuration/index.md).                                                                               |
-| --help                   | boolean | Show help.                                                                                                                                         |
-| --region, --residency -r | string  | Specify the residency of the application. Supported values: `us`, `eu`. The `eu` region is limited to enterprise customers. Default value is `us`. |
-| --verbose                | boolean | Display additional output.                                                                                                                         |
-| --version                | boolean | Show version number.                                                                                                                               |
-| --next                   | boolean | Authenticate through Reunite API.                                                                                                                  |
+| Option                    | Type    | Description                                                                                                                                                  |
+| ------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| --config                  | string  | Specify path to the [configuration file](../configuration/index.md).                                                                                         |
+| --help                    | boolean | Show help.                                                                                                                                                   |
+| --residency, --region, -r | string  | Specify the application's residency. Supported values: `us`, `eu`, or a full URL. The `eu` region is limited to enterprise customers. Default value is `us`. |
+| --verbose                 | boolean | Display additional output.                                                                                                                                   |
+| --version                 | boolean | Show version number.                                                                                                                                         |
+| --next                    | boolean | Authenticate through Reunite API.                                                                                                                            |
 
 ## Examples
 

packages/cli/src/commands/auth.ts

@@ -18,29 +18,29 @@ export function promptClientToken(domain: string) {
 
 export type LoginOptions = {
   verbose?: boolean;
-  region?: string;
+  residency?: string;
   config?: string;
   next?: boolean;
 };
 
 export async function handleLogin({ argv, config, version }: CommandArgs<LoginOptions>) {
   if (argv.next) {
     try {
-      const reuniteUrl = getReuniteUrl(argv.region);
+      const reuniteUrl = getReuniteUrl(argv.residency);
       const oauthClient = new RedoclyOAuthClient('redocly-cli', version);
       await oauthClient.login(reuniteUrl);
     } catch {
-      if (argv.region) {
-        const reuniteUrl = getReuniteUrl(argv.region);
+      if (argv.residency) {
+        const reuniteUrl = getReuniteUrl(argv.residency);
         exitWithError(`❌ Connection to ${reuniteUrl} failed.`);
       } else {
         exitWithError(`❌ Login failed. Please check your credentials and try again.`);
       }
     }
   } else {
     try {
-      const region = argv.region || config.region;
-      const client = new RedoclyClient(region as Region);
+      const region = (argv.residency as Region) || config.region;
+      const client = new RedoclyClient(region);
       const clientToken = await promptClientToken(client.domain);
       process.stdout.write(gray('\n  Logging in...\n'));
       await client.login(clientToken, argv.verbose);

packages/cli/src/index.ts

@@ -611,9 +611,9 @@ yargs
           description: 'Include additional output.',
           type: 'boolean',
         },
-        region: {
-          description: 'Residency of the application. Defaults to US.',
-          alias: ['r', 'residency'],
+        residency: {
+          description: 'Residency of the application. Defaults to `us`.',
+          alias: ['r', 'region'],
           type: 'string',
         },
         config: {