opal-security 3.1.3 → 3.2.2

package/oclif.manifest.json

@@ -316,6 +316,34 @@
         "set-url.js"
       ]
     },
+    "whoami": {
+      "aliases": [],
+      "args": {},
+      "description": "Describes current url set, organization name, and logged in user if applicable.",
+      "flags": {
+        "help": {
+          "char": "h",
+          "description": "Show CLI help.",
+          "name": "help",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "whoami",
+      "pluginAlias": "opal-security",
+      "pluginName": "opal-security",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "lib",
+        "commands",
+        "whoami.js"
+      ]
+    },
     "aws:identity": {
       "aliases": [],
       "args": {},
@@ -365,7 +393,7 @@
         },
         "id": {
           "char": "i",
-          "description": "The Opal ID of the resource. You can find this from the URL, e.g. https://opal.dev/resources/[ID]",
+          "description": "The Opal ID of the asset. You can find this from the URL, e.g. https://opal.dev/resources/[ID]",
           "name": "id",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -388,6 +416,70 @@
         "get.js"
       ]
     },
+    "iam-roles:start": {
+      "aliases": [],
+      "args": {},
+      "description": "Starts a session to assume an IAM role.",
+      "examples": [
+        "opal iam-roles:start",
+        "opal iam-roles:start --id 51f7176b-0464-4a6f-8369-e951e187b398",
+        "opal iam-roles:start --id 51f7176b-0464-4a6f-8369-e951e187b398 --profileName \"custom-profile\""
+      ],
+      "flags": {
+        "help": {
+          "char": "h",
+          "description": "Show CLI help.",
+          "name": "help",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "id": {
+          "char": "i",
+          "description": "The Opal ID of the asset. You can find this from the URL, e.g. https://opal.dev/resources/[ID]",
+          "name": "id",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "sessionId": {
+          "char": "s",
+          "description": "The Opal ID of the session to connect to. Uses an existing session that was created via the web flow.",
+          "name": "sessionId",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "refresh": {
+          "char": "r",
+          "description": "Starts a new session even if one already exists. Useful if a session is about to expire.",
+          "name": "refresh",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "profileName": {
+          "description": "Uses a custom AWS profile name for the IAM role. Default value is the role's name.",
+          "name": "profileName",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "iam-roles:start",
+      "pluginAlias": "opal-security",
+      "pluginName": "opal-security",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "lib",
+        "commands",
+        "iam-roles",
+        "start.js"
+      ]
+    },
     "kube-roles:start": {
       "aliases": [],
       "args": {},
@@ -407,7 +499,7 @@
         },
         "id": {
           "char": "i",
-          "description": "The Opal ID of the resource. You can find this from the URL, e.g. https://opal.dev/resources/[ID]",
+          "description": "The Opal ID of the asset. You can find this from the URL, e.g. https://opal.dev/resources/[ID]",
           "name": "id",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -473,7 +565,7 @@
         },
         "id": {
           "char": "i",
-          "description": "The Opal ID of the resource. You can find this from the URL, e.g. https://opal.dev/resources/[ID]",
+          "description": "The Opal ID of the asset. You can find this from the URL, e.g. https://opal.dev/resources/[ID]",
           "name": "id",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -503,11 +595,12 @@
           "type": "boolean"
         },
         "action": {
-          "description": "Method of connecting to the database.\n- psql: Start psql session in shell\n- view: View connection configuration details",
+          "description": "Method of connecting to the database.\n- open: Open external database app\n- psql: Start psql session in shell\n- view: View connection configuration details",
           "name": "action",
           "hasDynamicHelp": false,
           "multiple": false,
           "options": [
+            "open",
             "psql",
             "view"
           ],
@@ -533,10 +626,57 @@
     "request:create": {
       "aliases": [],
       "args": {},
-      "description": "Opens an Opal access request",
-      "flags": {},
+      "description": "Creates an Opal access request via an interactive form",
+      "flags": {
+        "help": {
+          "char": "h",
+          "description": "Show CLI help.",
+          "name": "help",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "assets": {
+          "char": "a",
+          "description": "The ids of the assets (resource, group) to request access to. Append a role name using a colon if needed, e.g. `--assets 123:456`.        \n If not provided, an interactive selection flow will be available to select assets to request.",
+          "name": "assets",
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "type": "option"
+        },
+        "reason": {
+          "char": "r",
+          "description": "The reason for the request, contained in quotes. If not provided, you will be prompted.",
+          "name": "reason",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "duration": {
+          "char": "d",
+          "description": "The duration of access for the request in minutes. Pass in a 0 value for permanent access. If not provided, you will be prompted.",
+          "name": "duration",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "template": {
+          "char": "t",
+          "description": "A request ID of a previously finished request (cancelled/denied/approved) to create a new request based on the completed request.",
+          "name": "template",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "bundle": {
+          "char": "b",
+          "description": "A bundle ID to create a new request based on the assets in the bundle.",
+          "name": "bundle",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
       "hasDynamicHelp": false,
-      "hidden": true,
       "hiddenAliases": [],
       "id": "request:create",
       "pluginAlias": "opal-security",
@@ -555,10 +695,36 @@
     "request:get": {
       "aliases": [],
       "args": {},
-      "description": "Lists access requests",
-      "flags": {},
+      "description": "Fetch details of an access request by request ID",
+      "examples": [
+        "opal request get --id 54052a3e-5375-4392-aeaf-0c6c44c131d4",
+        "opal request get --id 54052a3e-5375-4392-aeaf-0c6c44c131d4 --verbose"
+      ],
+      "flags": {
+        "help": {
+          "char": "h",
+          "description": "Show CLI help.",
+          "name": "help",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "id": {
+          "char": "i",
+          "description": "The Opal ID of the asset. You can find this from the URL, e.g. https://opal.dev/resources/[ID]",
+          "name": "id",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "verbose": {
+          "char": "v",
+          "description": "Enable verbose output, prints full response in JSON format. Defaults to false.",
+          "name": "verbose",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
       "hasDynamicHelp": false,
-      "hidden": true,
       "hiddenAliases": [],
       "id": "request:get",
       "pluginAlias": "opal-security",
@@ -575,35 +741,16 @@
       ]
     },
     "request:list": {
-      "aliases": [],
-      "args": {},
-      "description": "Lists access requests",
-      "flags": {},
-      "hasDynamicHelp": false,
-      "hidden": true,
-      "hiddenAliases": [],
-      "id": "request:list",
-      "pluginAlias": "opal-security",
-      "pluginName": "opal-security",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "isESM": false,
-      "relativePath": [
-        "lib",
-        "commands",
-        "request",
-        "list.js"
-      ]
-    },
-    "iam-roles:start": {
-      "aliases": [],
+      "aliases": [
+        "request:ls"
+      ],
       "args": {},
-      "description": "Starts a session to assume an IAM role.",
+      "description": "Lists your n recent outgoing access requests",
       "examples": [
-        "opal iam-roles:start",
-        "opal iam-roles:start --id 51f7176b-0464-4a6f-8369-e951e187b398",
-        "opal iam-roles:start --id 51f7176b-0464-4a6f-8369-e951e187b398 --profileName \"custom-profile\""
+        "opal request list --n 5",
+        "opal request list --n 5 --pending",
+        "opal request list --n 5 --verbose",
+        "opal request list --n 5 --pending --verbose"
       ],
       "flags": {
         "help": {
@@ -613,40 +760,33 @@
           "allowNo": false,
           "type": "boolean"
         },
-        "id": {
-          "char": "i",
-          "description": "The Opal ID of the resource. You can find this from the URL, e.g. https://opal.dev/resources/[ID]",
-          "name": "id",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "sessionId": {
-          "char": "s",
-          "description": "The Opal ID of the session to connect to. Uses an existing session that was created via the web flow.",
-          "name": "sessionId",
+        "n": {
+          "char": "n",
+          "description": "Defines number of requests to be returned. 1 <= n <= 100.",
+          "name": "n",
+          "default": 10,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
-        "refresh": {
-          "char": "r",
-          "description": "Starts a new session even if one already exists. Useful if a session is about to expire.",
-          "name": "refresh",
+        "pending": {
+          "char": "p",
+          "description": "Show only pending requests. Defaults to false.",
+          "name": "pending",
           "allowNo": false,
           "type": "boolean"
         },
-        "profileName": {
-          "description": "Uses a custom AWS profile name for the IAM role. Default value is the role's name.",
-          "name": "profileName",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
+        "verbose": {
+          "char": "v",
+          "description": "Enable verbose output, prints full response in JSON format. Defaults to false.",
+          "name": "verbose",
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "iam-roles:start",
+      "id": "request:list",
       "pluginAlias": "opal-security",
       "pluginName": "opal-security",
       "pluginType": "core",
@@ -656,8 +796,8 @@
       "relativePath": [
         "lib",
         "commands",
-        "iam-roles",
-        "start.js"
+        "request",
+        "list.js"
       ]
     },
     "resources:get": {
@@ -677,7 +817,7 @@
         },
         "id": {
           "char": "i",
-          "description": "The Opal ID of the resource. You can find this from the URL, e.g. https://opal.dev/resources/[ID]",
+          "description": "The Opal ID of the asset. You can find this from the URL, e.g. https://opal.dev/resources/[ID]",
           "name": "id",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -744,7 +884,7 @@
         },
         "id": {
           "char": "i",
-          "description": "The Opal ID of the resource. You can find this from the URL, e.g. https://opal.dev/resources/[ID]",
+          "description": "The Opal ID of the asset. You can find this from the URL, e.g. https://opal.dev/resources/[ID]",
           "name": "id",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -819,7 +959,7 @@
         },
         "id": {
           "char": "i",
-          "description": "The Opal ID of the resource. You can find this from the URL, e.g. https://opal.dev/resources/[ID]",
+          "description": "The Opal ID of the asset. You can find this from the URL, e.g. https://opal.dev/resources/[ID]",
           "name": "id",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -868,7 +1008,7 @@
         },
         "id": {
           "char": "i",
-          "description": "The Opal ID of the resource. You can find this from the URL, e.g. https://opal.dev/resources/[ID]",
+          "description": "The Opal ID of the asset. You can find this from the URL, e.g. https://opal.dev/resources/[ID]",
           "name": "id",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -907,5 +1047,5 @@
       ]
     }
   },
-  "version": "3.1.3"
+  "version": "3.2.2"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "opal-security",
   "description": "Opal allows you to centrally manage access to all of your sensitive systems.",
-  "version": "3.1.3",
+  "version": "3.2.2",
   "author": "Stephen Cobbe",
   "bin": {
     "opal": "./bin/run"
@@ -16,6 +16,7 @@
     "argon2": "^0.40.1",
     "chalk": "^2.4.2",
     "cli-table3": "^0.6.5",
+    "enquirer": "^2.4.1",
     "graphql": "^15.5.0",
     "inquirer": "^8.2.6",
     "inquirer-autocomplete-prompt": "^2.0.1",
@@ -39,6 +40,7 @@
     "@types/lodash": "^4.14.169",
     "@types/node": "^22.14.0",
     "@types/prettyjson": "0.0.29",
+    "@types/react": "^19.1.4",
     "@types/semver": "^7.3.8",
     "better-npm-audit": "^3.7.3",
     "get-graphql-schema": "^2.1.2",
@@ -60,9 +62,7 @@
     "/scripts"
   ],
   "homepage": "https://github.com/opalsecurity/opal-cli/",
-  "keywords": [
-    "oclif"
-  ],
+  "keywords": ["oclif"],
   "license": "MIT",
   "main": "lib/index.js",
   "oclif": {
@@ -88,7 +88,7 @@
     "prepack": "npm run build && oclif manifest && oclif readme",
     "test": "vitest",
     "coverage": "vitest run --coverage",
-    "version": "oclif readme && git add README.md",
+    "version": "oclif readme && git add README.md && biome check --write",
     "posttest": "biome check",
     "biome-ci": "biome ci --reporter=github",
     "gql-codegen": "graphql-codegen",

package/lib/lib/requests.d.ts

@@ -1,22 +0,0 @@
-import type { NormalizedCacheObject } from "@apollo/client/core";
-import type { ApolloClient } from "@apollo/client/core/ApolloClient";
-import type { Command } from "@oclif/core/lib/command";
-export interface AppNode {
-    appName: string;
-    assets: Map<string, AssetNode>;
-}
-export interface AssetNode {
-    assetName: string;
-    roles?: Map<string, RoleNode>;
-}
-export interface RoleNode {
-    roleName: string;
-}
-export type RequestMap = Map<string, AppNode>;
-export declare function selectRequestableItems(cmd: Command, client: ApolloClient<NormalizedCacheObject>, requestMap: RequestMap): Promise<void>;
-export declare function chooseAssets(cmd: Command, client: ApolloClient<NormalizedCacheObject>, appId: string, requestMap: RequestMap): Promise<void>;
-export declare function chooseRoles(appId: string, assetId: string, requestMap: RequestMap): Promise<void>;
-export declare function doneSelectingAssets(): Promise<boolean>;
-export declare function promptForReason(): Promise<any>;
-export declare function promptForExpiration(): Promise<any>;
-export declare function submitFinalRequest(cmd: Command): Promise<void>;