@databricks/sdk-options 0.1.0-dev.4 → 0.1.0-dev.6

package/dist/client/index.d.ts

@@ -6,6 +6,7 @@
 import type { Credentials } from '@databricks/sdk-auth';
 import type { HttpClient } from '@databricks/sdk-core/http';
 import type { Logger } from '@databricks/sdk-core/logger';
+import type { ProfileOptions } from '@databricks/sdk-core/profiles';
 /** Options that configure a Databricks API client. */
 export interface ClientOptions {
     /** Host for the client. */
@@ -25,9 +26,8 @@ export interface ClientOptions {
      */
     workspaceId?: string;
     /**
-     * A pre-configured HTTP client to use when making HTTP requests.
-     *
-     * Important: When set, this option ignores all other options.
+     * Base HTTP client used as the transport. Replaces the default fetch-based
+     * client (e.g. for a proxy, custom TLS, or instrumentation).
      */
     httpClient?: HttpClient;
     /** Credentials used to authenticate requests. */
@@ -39,5 +39,16 @@ export interface ClientOptions {
     timeout?: number;
     /** Logger used to record diagnostic messages. */
     logger?: Logger;
+    /**
+     * Controls how a configuration profile fills the options left unset above.
+     *
+     * Profile resolution is enabled by default: the config file
+     * (~/.databrickscfg or `$DATABRICKS_CONFIG_FILE`) and DATABRICKS_*
+     * environment variables supply `host`, `accountId`, `workspaceId`, and
+     * credentials whenever the caller does not set them explicitly. Explicit
+     * values always win. Disable the file with `noProfile`, the environment
+     * with `disableEnv`, or select a specific `profile`/`configFile`.
+     */
+    profileOptions?: ProfileOptions;
 }
 //# sourceMappingURL=index.d.ts.map

package/dist/client/index.d.ts.map

@@ -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"}
+{"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

@@ -1,6 +1,6 @@
 {
   "name": "@databricks/sdk-options",
-  "version": "0.1.0-dev.4",
+  "version": "0.1.0-dev.6",
   "description": "Options for configuring Databricks API clients and individual calls.",
   "type": "module",
   "exports": {
@@ -22,7 +22,6 @@
   },
   "files": [
     "dist",
-    "src",
     "LICENSE"
   ],
   "scripts": {
@@ -42,7 +41,7 @@
     "node": ">=22.0.0"
   },
   "dependencies": {
-    "@databricks/sdk-auth": ">=0.1.0-dev.4 <1.0.0",
-    "@databricks/sdk-core": ">=0.1.0-dev.5 <1.0.0"
+    "@databricks/sdk-auth": ">=0.1.0-dev.6 <1.0.0",
+    "@databricks/sdk-core": ">=0.1.0-dev.7 <1.0.0"
   }
 }

package/src/call/index.ts

@@ -1,40 +0,0 @@
-/**
- * Options used to configure individual calls against the Databricks API.
- *
- * @packageDocumentation
- */
-
-import type {Limiter, Retrier} from '@databricks/sdk-core/ops';
-
-/** Options that configure a single call against the Databricks API. */
-export interface CallOptions {
-  /**
-   * Cancels the call when aborted. If {@link CallOptions.timeout} is also
-   * set, the call is cancelled when either the signal aborts or the timeout
-   * elapses, whichever happens first.
-   */
-  signal?: AbortSignal;
-
-  /**
-   * Provides a fresh {@link Retrier} for each call. The function is invoked
-   * once per call and must be safe to invoke concurrently. The returned
-   * retrier must be fresh within the context of a single call (e.g. no need
-   * to reset a backoff policy).
-   *
-   * If omitted, the call is not retried.
-   */
-  retrier?: () => Retrier;
-
-  /**
-   * Rate limiter applied before each call attempt. If omitted, the call is
-   * not rate limited.
-   */
-  rateLimiter?: Limiter;
-
-  /**
-   * Timeout, in milliseconds, that covers the entire execution including
-   * retries. If the signal already has a deadline, it is updated to the
-   * minimum of the signal's deadline and this timeout.
-   */
-  timeout?: number;
-}

package/src/client/index.ts

@@ -1,50 +0,0 @@
-/**
- * Options used to configure Databricks API clients.
- *
- * @packageDocumentation
- */
-
-import type {Credentials} from '@databricks/sdk-auth';
-import type {HttpClient} from '@databricks/sdk-core/http';
-import type {Logger} from '@databricks/sdk-core/logger';
-
-/** Options that configure a Databricks API client. */
-export interface ClientOptions {
-  /** Host for the client. */
-  host?: string;
-
-  /**
-   * Default Databricks account ID for account-level API paths that contain
-   * an `{account_id}` segment. The request's own `accountId` field takes
-   * precedence; this option is only consulted when the request leaves it
-   * unset.
-   */
-  accountId?: string;
-
-  /**
-   * Databricks workspace ID used to route workspace-level API calls on
-   * unified hosts (SPOG). When set, workspace-level methods send the
-   * `X-Databricks-Org-Id` header on every request. Ignored by clients that
-   * only expose account-level methods.
-   */
-  workspaceId?: string;
-
-  /**
-   * A pre-configured HTTP client to use when making HTTP requests.
-   *
-   * Important: When set, this option ignores all other options.
-   */
-  httpClient?: HttpClient;
-
-  /** Credentials used to authenticate requests. */
-  credentials?: Credentials;
-
-  /**
-   * Overall API call timeout, in milliseconds, applied by default to every
-   * request issued through the client.
-   */
-  timeout?: number;
-
-  /** Logger used to record diagnostic messages. */
-  logger?: Logger;
-}

package/src/lro/index.ts

@@ -1,29 +0,0 @@
-/**
- * Options used to configure waiting on a long-running operation.
- *
- * @packageDocumentation
- */
-
-/**
- * Options that configure waiting on a long-running operation.
- *
- * A wait may issue many polling calls under the hood; these options apply to
- * the entire wait, not to any single poll. Per-poll knobs (rate limiting,
- * retry strategy) are intentionally omitted to keep the surface focused on
- * the only thing callers reliably need: bounding how long to wait.
- */
-export interface LroOptions {
-  /**
-   * Cancels the wait when aborted. If {@link LroOptions.timeout} is also
-   * set, the wait is cancelled when either the signal aborts or the timeout
-   * elapses, whichever happens first.
-   */
-  signal?: AbortSignal;
-
-  /**
-   * Total timeout, in milliseconds, that bounds the entire wait, including
-   * all polling attempts. If the signal already has a deadline, it is
-   * updated to the minimum of the signal's deadline and this timeout.
-   */
-  timeout?: number;
-}