@sap/datasphere-cli 2024.24.0 → 2024.25.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.
Files changed (2) hide show
  1. package/CHANGELOG.md +65 -0
  2. package/package.json +2 -2
package/CHANGELOG.md CHANGED
@@ -5,6 +5,71 @@ All notable changes to this project SAP Datasphere Command-Line Interface (DS CL
5
5
  The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
6
  and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
7
 
8
+ ## 2024.25.0
9
+
10
+ ### Added
11
+
12
+ - Support for Node v22.
13
+
14
+ - New command `<cli> config secrets check` has been added to the CLI. This command allows you to verify whether the secrets file used to run commands is consistent.
15
+
16
+ Examples for inconsistent secrets files:
17
+
18
+ ```bash
19
+ $ datasphere config secrets check
20
+ ✔ Please enter the path to the secrets file: … secrets.json
21
+ the provided secrets file is not consistent. the secrets file is missing either property access_token or properties refresh_token, client_id and client_secret
22
+ Failed to check secrets file consistency
23
+ ```
24
+
25
+ ```bash
26
+ $ datasphere config secrets check
27
+ ✔ Please enter the path to the secrets file: … secrets.json
28
+ the provided secrets file is not consistent. the secrets file is missing either property tenantUrl or properties authorization_url and token_url
29
+ Failed to check secrets file consistency
30
+ ```
31
+
32
+ Example for consistent secrets file:
33
+
34
+ ```bash
35
+ $ datasphere config secrets check
36
+ ✔ Please enter the path to the secrets file: … secrets.json
37
+ the secrets file is consistent
38
+ ```
39
+
40
+ - Support for the authorization flow `client_credentials`. When logging in, users can now explicitly use the `client_credentials` flow. The help shows the available option to specify the authorization flow.
41
+
42
+ ```bash
43
+ % datasphere login --help
44
+ Usage: datasphere login [options]
45
+
46
+ log in to your account using interactive OAuth authentication
47
+
48
+ Options:
49
+ -H, --host <host> specifies the url where the tenant is hosted (optional)
50
+ -A, --authorization-url <url> authorization url for interactive oauth session authentication (optional)
51
+ -t, --token-url <url> token url for interactive oauth session authentication (optional)
52
+ -c, --client-id <id> client id for interactive oauth session authentication (optional)
53
+ -C, --client-secret <secret> client secret for interactive oauth session authentication (optional)
54
+ -a, --access-token <token> access token for interactive oauth session authentication (optional)
55
+ -b, --code <code> code for oauth token retrieval (optional)
56
+ -r, --refresh-token <token> refresh token for interactive oauth session authentication (optional)
57
+ -s, --secrets-file <file> path to secrets file (optional)
58
+ -B, --browser <browser> specifies the browser to open (optional) (choices: "chrome", "firefox", "edge", default: "chrome")
59
+ -d, --authorization-flow <authorization-flow> specifies the authorization flow to use (optional) (choices: "authorization_code", "client_credentials", default: "authorization_code")
60
+ -h, --help display help for command
61
+
62
+ Only command-specific options are listed here. To learn more about available generic options, visit https://tinyurl.com/yck8vv4w
63
+ ```
64
+
65
+ There's a new option `-d, --authorization-flow <authorization-flow> specifies the authorization flow to use (optional) (choices: "authorization_code", "client_credentials", default: "authorization_code")`.
66
+
67
+ By default, the authorization flow `authorization_code` is used which was also the implicit default before. If users create a technical OAuth client, they must set the authorization flow to `client_credentials` explicitly.
68
+
69
+ `% datasphere login --authorization-flow client_credentials ...`
70
+
71
+ - When using option `--secrets-file` and the file containing the secrets does not exist or is not in a valid JSON format, the CLI now shows an error to the user: `The secrets file at location /path/to/secrets.json could not be read and JSON.parse'd. Does the file exist and is it a valid JSON file?`
72
+
8
73
  ## 2024.23.0
9
74
 
10
75
  ### Fixed
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sap/datasphere-cli",
3
- "version": "2024.24.0",
3
+ "version": "2024.25.0",
4
4
  "description": "Command-Line Interface for SAP Datasphere.",
5
5
  "license": "SEE LICENSE IN LICENSE",
6
6
  "author": "SAP SE",
@@ -19,6 +19,6 @@
19
19
  "datasphere-cli"
20
20
  ],
21
21
  "dependencies": {
22
- "@sap/cli-core": "2024.23.0"
22
+ "@sap/cli-core": "2024.24.0"
23
23
  }
24
24
  }