Docs db - get connection string (#128)

* Docs db - get connection string

* Example is back

* v4.7.2

* rename to database

* linter fixes

Author: shaikatzz

README.md

@@ -16,7 +16,7 @@ $ npm install -g @mondaycom/apps-cli
 $ mapps COMMAND
 running command...
 $ mapps (--version)
-@mondaycom/apps-cli/4.7.0 darwin-arm64 node-v18.12.1
+@mondaycom/apps-cli/4.7.2 darwin-arm64 node-v18.12.1
 $ mapps --help [COMMAND]
 USAGE
   $ mapps COMMAND
@@ -43,6 +43,7 @@ USAGE
 * [`mapps code:push`](#mapps-codepush)
 * [`mapps code:secret`](#mapps-codesecret)
 * [`mapps code:status`](#mapps-codestatus)
+* [`mapps database:connection-string`](#mapps-databaseconnection-string)
 * [`mapps help [COMMANDS]`](#mapps-help-commands)
 * [`mapps init`](#mapps-init)
 * [`mapps scheduler:create`](#mapps-schedulercreate)
@@ -71,7 +72,7 @@ DESCRIPTION
   [@mondaydotcomorg/setup-api](https://github.com/mondaycom/monday-graphql-api/tree/main/packages/setup-api)
 ```
 
-_See code: [src/commands/api/generate.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.0/src/commands/api/generate.ts)_
+_See code: [src/commands/api/generate.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.2/src/commands/api/generate.ts)_
 
 ## `mapps app-features:build`
 
@@ -101,7 +102,7 @@ EXAMPLES
   $ mapps app-features:build -a APP_ID -i APP_VERSION_ID -d APP_FEATURE_ID  -t BUILD_TYPE -u CUSTOM_URL
 ```
 
-_See code: [src/commands/app-features/build.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.0/src/commands/app-features/build.ts)_
+_See code: [src/commands/app-features/build.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.2/src/commands/app-features/build.ts)_
 
 ## `mapps app-features:create`
 
@@ -128,7 +129,7 @@ EXAMPLES
   $ mapps app-features:create -a APP_ID -i APP_VERSION_ID -t APP-FEATURE-TYPE
 ```
 
-_See code: [src/commands/app-features/create.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.0/src/commands/app-features/create.ts)_
+_See code: [src/commands/app-features/create.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.2/src/commands/app-features/create.ts)_
 
 ## `mapps app-features:list`
 
@@ -153,7 +154,7 @@ EXAMPLES
   $ mapps app-features:list -a APP_ID -i APP_VERSION_ID
 ```
 
-_See code: [src/commands/app-features/list.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.0/src/commands/app-features/list.ts)_
+_See code: [src/commands/app-features/list.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.2/src/commands/app-features/list.ts)_
 
 ## `mapps app-version:builds`
 
@@ -177,7 +178,7 @@ EXAMPLES
   $ mapps app-version:builds -i APP_VERSION_ID
 ```
 
-_See code: [src/commands/app-version/builds.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.0/src/commands/app-version/builds.ts)_
+_See code: [src/commands/app-version/builds.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.2/src/commands/app-version/builds.ts)_
 
 ## `mapps app-version:list`
 
@@ -201,7 +202,7 @@ EXAMPLES
   $ mapps app-version:list
 ```
 
-_See code: [src/commands/app-version/list.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.0/src/commands/app-version/list.ts)_
+_See code: [src/commands/app-version/list.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.2/src/commands/app-version/list.ts)_
 
 ## `mapps app:create`
 
@@ -228,7 +229,7 @@ EXAMPLES
   $ mapps app:create -n NEW_APP_NAME
 ```
 
-_See code: [src/commands/app/create.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.0/src/commands/app/create.ts)_
+_See code: [src/commands/app/create.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.2/src/commands/app/create.ts)_
 
 ## `mapps app:deploy`
 
@@ -258,7 +259,7 @@ EXAMPLES
   $ mapps app:deploy
 ```
 
-_See code: [src/commands/app/deploy.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.0/src/commands/app/deploy.ts)_
+_See code: [src/commands/app/deploy.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.2/src/commands/app/deploy.ts)_
 
 ## `mapps app:list`
 
@@ -279,7 +280,7 @@ EXAMPLES
   $ mapps app:list
 ```
 
-_See code: [src/commands/app/list.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.0/src/commands/app/list.ts)_
+_See code: [src/commands/app/list.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.2/src/commands/app/list.ts)_
 
 ## `mapps app:promote`
 
@@ -306,7 +307,7 @@ EXAMPLES
   $ mapps app:promote
 ```
 
-_See code: [src/commands/app/promote.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.0/src/commands/app/promote.ts)_
+_See code: [src/commands/app/promote.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.2/src/commands/app/promote.ts)_
 
 ## `mapps autocomplete [SHELL]`
 
@@ -368,7 +369,7 @@ EXAMPLES
   $ mapps code:env
 ```
 
-_See code: [src/commands/code/env.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.0/src/commands/code/env.ts)_
+_See code: [src/commands/code/env.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.2/src/commands/code/env.ts)_
 
 ## `mapps code:logs`
 
@@ -403,7 +404,7 @@ EXAMPLES
   $ mapps code:logs -i APP_VERSION_ID -t LOGS_TYPE
 ```
 
-_See code: [src/commands/code/logs.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.0/src/commands/code/logs.ts)_
+_See code: [src/commands/code/logs.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.2/src/commands/code/logs.ts)_
 
 ## `mapps code:push`
 
@@ -438,7 +439,7 @@ EXAMPLES
   $ mapps code:push -a APP_ID_TO_PUSH
 ```
 
-_See code: [src/commands/code/push.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.0/src/commands/code/push.ts)_
+_See code: [src/commands/code/push.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.2/src/commands/code/push.ts)_
 
 ## `mapps code:secret`
 
@@ -469,7 +470,7 @@ EXAMPLES
   $ mapps code:secret
 ```
 
-_See code: [src/commands/code/secret.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.0/src/commands/code/secret.ts)_
+_See code: [src/commands/code/secret.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.2/src/commands/code/secret.ts)_
 
 ## `mapps code:status`
 
@@ -495,18 +496,42 @@ EXAMPLES
   $ mapps code:status -i APP_VERSION_ID
 ```
 
-_See code: [src/commands/code/status.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.0/src/commands/code/status.ts)_
+_See code: [src/commands/code/status.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.2/src/commands/code/status.ts)_
+
+## `mapps database:connection-string`
+
+Get the connection string for your app database.
+
+```
+USAGE
+  $ mapps database:connection-string [--verbose] [--print-command] [-a <value>]
+
+FLAGS
+  -a, --appId=<value>  Select the app that you wish to retrieve the connection string for
+
+GLOBAL FLAGS
+  --print-command  Print the command that was executed (optional).
+  --verbose        Print advanced logs (optional).
+
+DESCRIPTION
+  Get the connection string for your app database.
+
+EXAMPLES
+  $ mapps database:connection-string -a APP_ID
+```
+
+_See code: [src/commands/database/connection-string.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.2/src/commands/database/connection-string.ts)_
 
 ## `mapps help [COMMANDS]`
 
 Display help for mapps.
 
 ```
 USAGE
-  $ mapps help [COMMANDS...] [-n]
+  $ mapps help [COMMANDS] [-n]
 
 ARGUMENTS
-  COMMANDS...  Command to show help for.
+  COMMANDS  Command to show help for.
 
 FLAGS
   -n, --nested-commands  Include all nested commands in the output.
@@ -540,7 +565,7 @@ EXAMPLES
   $ mapps init -t SECRET_TOKEN
 ```
 
-_See code: [src/commands/init/index.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.0/src/commands/init/index.ts)_
+_See code: [src/commands/init/index.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.2/src/commands/init/index.ts)_
 
 ## `mapps scheduler:create`
 
@@ -578,7 +603,7 @@ EXAMPLES
   $ mapps scheduler:create -a APP_ID -s "0 * * * *" -u "/my-endpoint" -r 3 -b 10 -t 60
 ```
 
-_See code: [src/commands/scheduler/create.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.0/src/commands/scheduler/create.ts)_
+_See code: [src/commands/scheduler/create.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.2/src/commands/scheduler/create.ts)_
 
 ## `mapps scheduler:delete`
 
@@ -605,7 +630,7 @@ EXAMPLES
   $ mapps scheduler:delete -a APP_ID -n "my-job"
 ```
 
-_See code: [src/commands/scheduler/delete.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.0/src/commands/scheduler/delete.ts)_
+_See code: [src/commands/scheduler/delete.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.2/src/commands/scheduler/delete.ts)_
 
 ## `mapps scheduler:list`
 
@@ -629,7 +654,7 @@ EXAMPLES
   $ mapps scheduler:list -a APP_ID
 ```
 
-_See code: [src/commands/scheduler/list.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.0/src/commands/scheduler/list.ts)_
+_See code: [src/commands/scheduler/list.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.2/src/commands/scheduler/list.ts)_
 
 ## `mapps scheduler:run`
 
@@ -656,7 +681,7 @@ EXAMPLES
   $ mapps scheduler:run -a APP_ID -n "my-job"
 ```
 
-_See code: [src/commands/scheduler/run.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.0/src/commands/scheduler/run.ts)_
+_See code: [src/commands/scheduler/run.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.2/src/commands/scheduler/run.ts)_
 
 ## `mapps scheduler:update`
 
@@ -694,7 +719,7 @@ EXAMPLES
   $ mapps scheduler:update -a APP_ID -n "my-job" -d "My description" -r 3 -b 10 -t 60
 ```
 
-_See code: [src/commands/scheduler/update.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.0/src/commands/scheduler/update.ts)_
+_See code: [src/commands/scheduler/update.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.2/src/commands/scheduler/update.ts)_
 
 ## `mapps storage:export`
 
@@ -721,7 +746,7 @@ EXAMPLES
   $ mapps storage:export -a APP_ID -c CLIENT_ACCOUNT_ID -d FILE_FULL_PATH -f FILE_FORMAT
 ```
 
-_See code: [src/commands/storage/export.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.0/src/commands/storage/export.ts)_
+_See code: [src/commands/storage/export.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.2/src/commands/storage/export.ts)_
 
 ## `mapps storage:remove-data`
 
@@ -747,7 +772,7 @@ EXAMPLES
   $ mapps storage:remove-data -a APP_ID -c CLIENT_ACCOUNT_ID
 ```
 
-_See code: [src/commands/storage/remove-data.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.0/src/commands/storage/remove-data.ts)_
+_See code: [src/commands/storage/remove-data.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.2/src/commands/storage/remove-data.ts)_
 
 ## `mapps storage:search`
 
@@ -773,7 +798,7 @@ EXAMPLES
   $ mapps storage:search -a APP_ID -c CLIENT_ACCOUNT_ID -t TERM
 ```
 
-_See code: [src/commands/storage/search.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.0/src/commands/storage/search.ts)_
+_See code: [src/commands/storage/search.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.2/src/commands/storage/search.ts)_
 
 ## `mapps tunnel:create`
 
@@ -804,5 +829,5 @@ EXAMPLES
   $ mapps tunnel:create -p PORT_FOR_TUNNEL -a APP_ID_FOR_TUNNEL
 ```
 
-_See code: [src/commands/tunnel/create.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.0/src/commands/tunnel/create.ts)_
+_See code: [src/commands/tunnel/create.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.2/src/commands/tunnel/create.ts)_
 <!-- commandsstop -->

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mondaycom/apps-cli",
-  "version": "4.7.1",
+  "version": "4.7.2",
   "description": "A cli tool to manage apps (and monday-code projects) in monday.com",
   "author": "monday.com Apps Team",
   "type": "module",
@@ -134,6 +134,9 @@
       },
       "app-version": {
         "description": "Perform operations related to app versions in monday.com"
+      },
+      "database": {
+        "description": "Perform operations related to app database"
       }
     },
     "hooks": {

src/commands/database/connection-string.ts

@@ -0,0 +1,51 @@
+import { Flags } from '@oclif/core';
+import chalk from 'chalk';
+
+import { AuthenticatedCommand } from 'commands-base/authenticated-command';
+import { VAR_UNKNOWN } from 'consts/messages';
+import { getDatabaseConnectionString } from 'services/database-service';
+import { DynamicChoicesService } from 'services/dynamic-choices-service';
+import { HttpError } from 'types/errors';
+import { AppId } from 'types/general';
+import logger from 'utils/logger';
+
+export default class ConnectionString extends AuthenticatedCommand {
+  static description = 'Get the connection string for your app database.';
+
+  static examples = ['<%= config.bin %> <%= command.id %> -a APP_ID'];
+
+  static flags = ConnectionString.serializeFlags({
+    appId: Flags.integer({
+      char: 'a',
+      description: 'Select the app that you wish to retrieve the connection string for',
+    }),
+  });
+
+  public async run(): Promise<void> {
+    const { flags } = await this.parse(ConnectionString);
+    let { appId } = flags;
+    try {
+      if (!appId) {
+        appId = await DynamicChoicesService.chooseApp();
+      }
+
+      const result = await getDatabaseConnectionString(appId);
+
+      logger.log(chalk.green('✓ Connection string retrieved successfully:'));
+      logger.log(chalk.cyan(result.connectionString));
+
+      this.preparePrintCommand(this, { appId });
+    } catch (error: unknown) {
+      logger.debug(error);
+      if (error instanceof HttpError) {
+        logger.error(`\n ${chalk.italic(chalk.red(error.message))}`);
+      } else {
+        logger.error(
+          `An unknown error happened while fetching connection string for app id - "${appId || VAR_UNKNOWN}"`,
+        );
+      }
+
+      process.exit(1);
+    }
+  }
+}

src/consts/urls.ts

@@ -122,3 +122,7 @@ export const pullPromoteStatusUrl = (path: string): string => {
 export const appSchedulerUrl = (appId: AppId): string => {
   return `${BASE_MONDAY_CODE_URL}/${appId}/scheduler`;
 };
+
+export const appStorageConnectionStringUrl = (appId: AppId): string => {
+  return `${BASE_MONDAY_CODE_URL}/${appId}/storage/connection-string`;
+};

src/services/database-service.ts

@@ -0,0 +1,33 @@
+import { appStorageConnectionStringUrl } from 'consts/urls';
+import { execute } from 'services/api-service';
+import { databaseConnectionStringResponseSchema } from 'services/schemas/database-service-schemas';
+import { HttpError } from 'types/errors';
+import { AppId } from 'types/general';
+import { HttpMethodTypes } from 'types/services/api-service';
+import { DatabaseConnectionStringResponseSchema } from 'types/services/database-service';
+import logger from 'utils/logger';
+import { appsUrlBuilder } from 'utils/urls-builder';
+
+export const getDatabaseConnectionString = async (appId: AppId): Promise<DatabaseConnectionStringResponseSchema> => {
+  const DEBUG_TAG = 'get_database_connection_string';
+  try {
+    const baseUrl = appStorageConnectionStringUrl(appId);
+    const url = appsUrlBuilder(baseUrl);
+    const response = await execute<DatabaseConnectionStringResponseSchema>(
+      {
+        url,
+        headers: { Accept: 'application/json' },
+        method: HttpMethodTypes.GET,
+      },
+      databaseConnectionStringResponseSchema,
+    );
+    return response;
+  } catch (error: any | HttpError) {
+    logger.debug(error, DEBUG_TAG);
+    if (error instanceof HttpError) {
+      throw error;
+    }
+
+    throw new Error('Failed to fetch database connection string.');
+  }
+};

src/services/schemas/database-service-schemas.ts

@@ -0,0 +1,9 @@
+import { z } from 'zod';
+
+import { baseResponseHttpMetaDataSchema } from 'services/schemas/api-service-schemas';
+
+export const databaseConnectionStringResponseSchema = z
+  .object({
+    connectionString: z.string(),
+  })
+  .merge(baseResponseHttpMetaDataSchema);