@databricks/sdk-options 0.1.0-dev.5 → 0.2.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.
package/README.md CHANGED
@@ -1,11 +1,7 @@
1
1
  # Databricks SDK Options for JavaScript
2
2
 
3
- > [!WARNING]
4
- > ## PREVIEW - NOT FOR PRODUCTION USE
3
+ > [!NOTE]
5
4
  >
6
- > **This SDK is in preview and is subject to change without notice.**
5
+ > ## Beta
7
6
  >
8
- > - **Do NOT use in production environments**
9
- > - **Breaking changes may occur at any time**
10
- > - **APIs are experimental and unstable**
11
- > - **Use for development and testing only**
7
+ > **This SDK is in Beta and is supported for production use cases.** Interfaces might still change slightly before GA (e.g. name standardization and minor ergonomic tweaks). We are keen to hear feedback from early adopters — please [file issues](https://github.com/databricks/sdk-js/issues), and we will address them.
@@ -6,6 +6,7 @@
6
6
  import type { Credentials } from '@databricks/sdk-auth';
7
7
  import type { HttpClient } from '@databricks/sdk-core/http';
8
8
  import type { Logger } from '@databricks/sdk-core/logger';
9
+ import type { ProfileOptions } from '@databricks/sdk-core/profiles';
9
10
  /** Options that configure a Databricks API client. */
10
11
  export interface ClientOptions {
11
12
  /** Host for the client. */
@@ -25,9 +26,8 @@ export interface ClientOptions {
25
26
  */
26
27
  workspaceId?: string;
27
28
  /**
28
- * A pre-configured HTTP client to use when making HTTP requests.
29
- *
30
- * Important: When set, this option ignores all other options.
29
+ * Base HTTP client used as the transport. Replaces the default fetch-based
30
+ * client (e.g. for a proxy, custom TLS, or instrumentation).
31
31
  */
32
32
  httpClient?: HttpClient;
33
33
  /** Credentials used to authenticate requests. */
@@ -39,5 +39,16 @@ export interface ClientOptions {
39
39
  timeout?: number;
40
40
  /** Logger used to record diagnostic messages. */
41
41
  logger?: Logger;
42
+ /**
43
+ * Controls how a configuration profile fills the options left unset above.
44
+ *
45
+ * Profile resolution is enabled by default: the config file
46
+ * (~/.databrickscfg or `$DATABRICKS_CONFIG_FILE`) and DATABRICKS_*
47
+ * environment variables supply `host`, `accountId`, `workspaceId`, and
48
+ * credentials whenever the caller does not set them explicitly. Explicit
49
+ * values always win. Disable the file with `noProfile`, the environment
50
+ * with `disableEnv`, or select a specific `profile`/`configFile`.
51
+ */
52
+ profileOptions?: ProfileOptions;
42
53
  }
43
54
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,sBAAsB,CAAC;AACtD,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,2BAA2B,CAAC;AAC1D,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,6BAA6B,CAAC;AAExD,sDAAsD;AACtD,MAAM,WAAW,aAAa;IAC5B,2BAA2B;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB,iDAAiD;IACjD,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,iDAAiD;IACjD,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,sBAAsB,CAAC;AACtD,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,2BAA2B,CAAC;AAC1D,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,6BAA6B,CAAC;AACxD,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,+BAA+B,CAAC;AAElE,sDAAsD;AACtD,MAAM,WAAW,aAAa;IAC5B,2BAA2B;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB,iDAAiD;IACjD,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,iDAAiD;IACjD,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;;;;;OASG;IACH,cAAc,CAAC,EAAE,cAAc,CAAC;CACjC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@databricks/sdk-options",
3
- "version": "0.1.0-dev.5",
3
+ "version": "0.2.0",
4
4
  "description": "Options for configuring Databricks API clients and individual calls.",
5
5
  "type": "module",
6
6
  "exports": {
@@ -41,7 +41,7 @@
41
41
  "node": ">=22.0.0"
42
42
  },
43
43
  "dependencies": {
44
- "@databricks/sdk-auth": ">=0.1.0-dev.5 <1.0.0",
45
- "@databricks/sdk-core": ">=0.1.0-dev.6 <1.0.0"
44
+ "@databricks/sdk-auth": ">=0.2.0 <1.0.0",
45
+ "@databricks/sdk-core": ">=0.2.0 <1.0.0"
46
46
  }
47
47
  }