@databricks/sdk-options 0.34.0 → 0.35.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.
@@ -1,36 +1,35 @@
1
- /**
2
- * Options used to configure individual calls against the Databricks API.
3
- *
4
- * @packageDocumentation
5
- */
6
- import type { Limiter, Retrier } from '@databricks/sdk-core/ops';
1
+ import { Limiter, Retrier } from "@databricks/sdk-core/ops";
2
+
3
+ //#region src/call/index.d.ts
7
4
  /** Options that configure a single call against the Databricks API. */
8
- export interface CallOptions {
9
- /**
10
- * Cancels the call when aborted. If {@link CallOptions.timeout} is also
11
- * set, the call is cancelled when either the signal aborts or the timeout
12
- * elapses, whichever happens first.
13
- */
14
- signal?: AbortSignal;
15
- /**
16
- * Provides a fresh {@link Retrier} for each call. The function is invoked
17
- * once per call and must be safe to invoke concurrently. The returned
18
- * retrier must be fresh within the context of a single call (e.g. no need
19
- * to reset a backoff policy).
20
- *
21
- * If omitted, the call is not retried.
22
- */
23
- retrier?: () => Retrier;
24
- /**
25
- * Rate limiter applied before each call attempt. If omitted, the call is
26
- * not rate limited.
27
- */
28
- rateLimiter?: Limiter;
29
- /**
30
- * Timeout, in milliseconds, that covers the entire execution including
31
- * retries. If the signal already has a deadline, it is updated to the
32
- * minimum of the signal's deadline and this timeout.
33
- */
34
- timeout?: number;
5
+ interface CallOptions {
6
+ /**
7
+ * Cancels the call when aborted. If {@link CallOptions.timeout} is also
8
+ * set, the call is cancelled when either the signal aborts or the timeout
9
+ * elapses, whichever happens first.
10
+ */
11
+ signal?: AbortSignal;
12
+ /**
13
+ * Provides a fresh {@link Retrier} for each call. The function is invoked
14
+ * once per call and must be safe to invoke concurrently. The returned
15
+ * retrier must be fresh within the context of a single call (e.g. no need
16
+ * to reset a backoff policy).
17
+ *
18
+ * If omitted, the call is not retried.
19
+ */
20
+ retrier?: () => Retrier;
21
+ /**
22
+ * Rate limiter applied before each call attempt. If omitted, the call is
23
+ * not rate limited.
24
+ */
25
+ rateLimiter?: Limiter;
26
+ /**
27
+ * Timeout, in milliseconds, that covers the entire execution including
28
+ * retries. If the signal already has a deadline, it is updated to the
29
+ * minimum of the signal's deadline and this timeout.
30
+ */
31
+ timeout?: number;
35
32
  }
33
+ //#endregion
34
+ export { CallOptions };
36
35
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/call/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAC,OAAO,EAAE,OAAO,EAAC,MAAM,0BAA0B,CAAC;AAE/D,uEAAuE;AACvE,MAAM,WAAW,WAAW;IAC1B;;;;OAIG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;IAErB;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,MAAM,OAAO,CAAC;IAExB;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB"}
1
+ {"version":3,"file":"index.d.ts","names":[],"sources":["../../src/call/index.ts"],"mappings":";;;;UASiB,WAAA;EAsBD;;;;;EAhBd,MAAA,GAAS,WAAA;EAUO;;;;;;;;EAAhB,OAAA,SAAgB,OAAA;;;;;EAMhB,WAAA,GAAc,OAAA;;;;;;EAOd,OAAA;AAAA"}
@@ -1,7 +0,0 @@
1
- /**
2
- * Options used to configure individual calls against the Databricks API.
3
- *
4
- * @packageDocumentation
5
- */
6
- export {};
7
- //# sourceMappingURL=index.js.map
@@ -1,56 +1,55 @@
1
- /**
2
- * Options used to configure Databricks API clients.
3
- *
4
- * @packageDocumentation
5
- */
6
- import type { Credentials } from '@databricks/sdk-auth';
7
- import type { HttpClient } from '@databricks/sdk-core/http';
8
- import type { Logger } from '@databricks/sdk-core/logger';
9
- import type { ProfileOptions } from '@databricks/sdk-core/profiles';
1
+ import { Credentials } from "@databricks/sdk-auth";
2
+ import { HttpClient } from "@databricks/sdk-core/http";
3
+ import { Logger } from "@databricks/sdk-core/logger";
4
+ import { ProfileOptions } from "@databricks/sdk-core/profiles";
5
+
6
+ //#region src/client/index.d.ts
10
7
  /** Options that configure a Databricks API client. */
11
- export interface ClientOptions {
12
- /** Host for the client. */
13
- host?: string;
14
- /**
15
- * Default Databricks account ID for account-level API paths that contain
16
- * an `{account_id}` segment. The request's own `accountId` field takes
17
- * precedence; this option is only consulted when the request leaves it
18
- * unset.
19
- */
20
- accountId?: string;
21
- /**
22
- * Databricks workspace ID used to route workspace-level API calls on
23
- * unified hosts (SPOG). When set, workspace-level methods send the
24
- * `X-Databricks-Workspace-Id` header on every request. Accepts either a
25
- * classic numeric workspace ID or another workspace identifier format that
26
- * the server understands. Ignored by clients that only expose account-level
27
- * methods.
28
- */
29
- workspaceId?: string;
30
- /**
31
- * Base HTTP client used as the transport. Replaces the default fetch-based
32
- * client (e.g. for a proxy, custom TLS, or instrumentation).
33
- */
34
- httpClient?: HttpClient;
35
- /** Credentials used to authenticate requests. */
36
- credentials?: Credentials;
37
- /**
38
- * Overall API call timeout, in milliseconds, applied by default to every
39
- * request issued through the client.
40
- */
41
- timeout?: number;
42
- /** Logger used to record diagnostic messages. */
43
- logger?: Logger;
44
- /**
45
- * Controls how a configuration profile fills the options left unset above.
46
- *
47
- * Profile resolution is enabled by default: the config file
48
- * (~/.databrickscfg or `$DATABRICKS_CONFIG_FILE`) and DATABRICKS_*
49
- * environment variables supply `host`, `accountId`, `workspaceId`, and
50
- * credentials whenever the caller does not set them explicitly. Explicit
51
- * values always win. Disable the file with `noProfile`, the environment
52
- * with `disableEnv`, or select a specific `profile`/`configFile`.
53
- */
54
- profileOptions?: ProfileOptions;
8
+ interface ClientOptions {
9
+ /** Host for the client. */
10
+ host?: string;
11
+ /**
12
+ * Default Databricks account ID for account-level API paths that contain
13
+ * an `{account_id}` segment. The request's own `accountId` field takes
14
+ * precedence; this option is only consulted when the request leaves it
15
+ * unset.
16
+ */
17
+ accountId?: string;
18
+ /**
19
+ * Databricks workspace ID used to route workspace-level API calls on
20
+ * unified hosts (SPOG). When set, workspace-level methods send the
21
+ * `X-Databricks-Workspace-Id` header on every request. Accepts either a
22
+ * classic numeric workspace ID or another workspace identifier format that
23
+ * the server understands. Ignored by clients that only expose account-level
24
+ * methods.
25
+ */
26
+ workspaceId?: string;
27
+ /**
28
+ * Base HTTP client used as the transport. Replaces the default fetch-based
29
+ * client (e.g. for a proxy, custom TLS, or instrumentation).
30
+ */
31
+ httpClient?: HttpClient;
32
+ /** Credentials used to authenticate requests. */
33
+ credentials?: Credentials;
34
+ /**
35
+ * Overall API call timeout, in milliseconds, applied by default to every
36
+ * request issued through the client.
37
+ */
38
+ timeout?: number;
39
+ /** Logger used to record diagnostic messages. */
40
+ logger?: Logger;
41
+ /**
42
+ * Controls how a configuration profile fills the options left unset above.
43
+ *
44
+ * Profile resolution is enabled by default: the config file
45
+ * (~/.databrickscfg or `$DATABRICKS_CONFIG_FILE`) and DATABRICKS_*
46
+ * environment variables supply `host`, `accountId`, `workspaceId`, and
47
+ * credentials whenever the caller does not set them explicitly. Explicit
48
+ * values always win. Disable the file with `noProfile`, the environment
49
+ * with `disableEnv`, or select a specific `profile`/`configFile`.
50
+ */
51
+ profileOptions?: ProfileOptions;
55
52
  }
53
+ //#endregion
54
+ export { ClientOptions };
56
55
  //# 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;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;;;;;;;OAOG;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"}
1
+ {"version":3,"file":"index.d.ts","names":[],"sources":["../../src/client/index.ts"],"mappings":";;;;;;;UAYiB,aAAA;EAsCN;EApCT,IAAA;EAgD+B;;;;;;EAxC/B,SAAA;EAmBA;;;;;;;;EATA,WAAA;;;;;EAMA,UAAA,GAAa,UAAA;;EAGb,WAAA,GAAc,WAAA;;;;;EAMd,OAAA;;EAGA,MAAA,GAAS,MAAA;;;;;;;;;;;EAYT,cAAA,GAAiB,cAAA;AAAA"}
@@ -1,7 +0,0 @@
1
- /**
2
- * Options used to configure Databricks API clients.
3
- *
4
- * @packageDocumentation
5
- */
6
- export {};
7
- //# sourceMappingURL=index.js.map
@@ -1,3 +1,4 @@
1
+ //#region src/lro/index.d.ts
1
2
  /**
2
3
  * Options used to configure waiting on a long-running operation.
3
4
  *
@@ -11,18 +12,20 @@
11
12
  * retry strategy) are intentionally omitted to keep the surface focused on
12
13
  * the only thing callers reliably need: bounding how long to wait.
13
14
  */
14
- export interface LroOptions {
15
- /**
16
- * Cancels the wait when aborted. If {@link LroOptions.timeout} is also
17
- * set, the wait is cancelled when either the signal aborts or the timeout
18
- * elapses, whichever happens first.
19
- */
20
- signal?: AbortSignal;
21
- /**
22
- * Total timeout, in milliseconds, that bounds the entire wait, including
23
- * all polling attempts. If the signal already has a deadline, it is
24
- * updated to the minimum of the signal's deadline and this timeout.
25
- */
26
- timeout?: number;
15
+ interface LroOptions {
16
+ /**
17
+ * Cancels the wait when aborted. If {@link LroOptions.timeout} is also
18
+ * set, the wait is cancelled when either the signal aborts or the timeout
19
+ * elapses, whichever happens first.
20
+ */
21
+ signal?: AbortSignal;
22
+ /**
23
+ * Total timeout, in milliseconds, that bounds the entire wait, including
24
+ * all polling attempts. If the signal already has a deadline, it is
25
+ * updated to the minimum of the signal's deadline and this timeout.
26
+ */
27
+ timeout?: number;
27
28
  }
29
+ //#endregion
30
+ export { LroOptions };
28
31
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/lro/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;;;;GAOG;AACH,MAAM,WAAW,UAAU;IACzB;;;;OAIG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;IAErB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB"}
1
+ {"version":3,"file":"index.d.ts","names":[],"sources":["../../src/lro/index.ts"],"mappings":";;AAcA;;;;;;;;;;;;UAAiB,UAAA;;;;;;EAMf,MAAA,GAAS,WAAA;;;;;;EAOT,OAAA;AAAA"}
package/dist/lro/index.js CHANGED
@@ -1,7 +0,0 @@
1
- /**
2
- * Options used to configure waiting on a long-running operation.
3
- *
4
- * @packageDocumentation
5
- */
6
- export {};
7
- //# sourceMappingURL=index.js.map
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@databricks/sdk-options",
3
- "version": "0.34.0",
3
+ "version": "0.35.0",
4
4
  "description": "Options for configuring Databricks API clients and individual calls.",
5
5
  "type": "module",
6
6
  "exports": {
@@ -25,7 +25,7 @@
25
25
  "LICENSE"
26
26
  ],
27
27
  "scripts": {
28
- "build": "tsc -b",
28
+ "build": "tsdown",
29
29
  "lint": "eslint src tests --ext .ts",
30
30
  "lint:fix": "eslint src tests --ext .ts --fix",
31
31
  "format": "prettier --write \"src/**/*.ts\" \"tests/**/*.ts\"",
@@ -41,7 +41,7 @@
41
41
  "node": ">=22.0.0"
42
42
  },
43
43
  "dependencies": {
44
- "@databricks/sdk-auth": ">=0.34.0 <1.0.0",
45
- "@databricks/sdk-core": ">=0.34.0 <1.0.0"
44
+ "@databricks/sdk-auth": ">=0.35.0 <1.0.0",
45
+ "@databricks/sdk-core": ">=0.35.0 <1.0.0"
46
46
  }
47
47
  }
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/call/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/lro/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG"}