@databricks/sdk-instanceprofiles 0.0.0-dev → 0.1.0-dev.1

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.
@@ -0,0 +1,57 @@
1
+ // Code generated from API definition by Databricks SDK Generator. DO NOT EDIT.
2
+ import { defaultCredentials } from '@databricks/sdk-auth/credentials';
3
+ import { newFetchHttpClient } from '@databricks/sdk-core/http';
4
+ /** Creates a new HTTP client with the given options. */
5
+ export function newHttpClient(options) {
6
+ const opts = options ?? {};
7
+ // If an HTTP client is provided, use it as-is. Throw if other options are
8
+ // also set, since they would be silently ignored.
9
+ if (opts.httpClient !== undefined) {
10
+ if (opts.credentials !== undefined || opts.timeout !== undefined) {
11
+ throw new Error('httpClient cannot be combined with credentials or timeout');
12
+ }
13
+ return opts.httpClient;
14
+ }
15
+ const credentials = opts.credentials ?? defaultCredentials();
16
+ const base = newFetchHttpClient();
17
+ let client = new AuthHttpClient(base, credentials);
18
+ if (opts.timeout !== undefined) {
19
+ client = new TimeoutHttpClient(client, opts.timeout);
20
+ }
21
+ return client;
22
+ }
23
+ /** Wraps an HttpClient and adds authentication headers to requests. */
24
+ class AuthHttpClient {
25
+ base;
26
+ credentials;
27
+ constructor(base, credentials) {
28
+ this.base = base;
29
+ this.credentials = credentials;
30
+ }
31
+ async send(request) {
32
+ const authHeaders = await this.credentials.authHeaders();
33
+ // Do not modify the original request.
34
+ const headers = new Headers(request.headers);
35
+ for (const h of authHeaders) {
36
+ headers.set(h.key, h.value);
37
+ }
38
+ return this.base.send({ ...request, headers });
39
+ }
40
+ }
41
+ /** Wraps an HttpClient and applies a default timeout to requests. */
42
+ class TimeoutHttpClient {
43
+ base;
44
+ timeout;
45
+ constructor(base, timeout) {
46
+ this.base = base;
47
+ this.timeout = timeout;
48
+ }
49
+ async send(request) {
50
+ const timeoutSignal = AbortSignal.timeout(this.timeout);
51
+ const signal = request.signal !== undefined
52
+ ? AbortSignal.any([request.signal, timeoutSignal])
53
+ : timeoutSignal;
54
+ return this.base.send({ ...request, signal });
55
+ }
56
+ }
57
+ //# sourceMappingURL=transport.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"transport.js","sourceRoot":"","sources":["../../src/v2/transport.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAG/E,OAAO,EAAC,kBAAkB,EAAC,MAAM,kCAAkC,CAAC;AAMpE,OAAO,EAAC,kBAAkB,EAAC,MAAM,2BAA2B,CAAC;AAG7D,wDAAwD;AACxD,MAAM,UAAU,aAAa,CAAC,OAAuB;IACnD,MAAM,IAAI,GAAG,OAAO,IAAI,EAAE,CAAC;IAE3B,0EAA0E;IAC1E,kDAAkD;IAClD,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;QAClC,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACjE,MAAM,IAAI,KAAK,CACb,2DAA2D,CAC5D,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,kBAAkB,EAAE,CAAC;IAE7D,MAAM,IAAI,GAAG,kBAAkB,EAAE,CAAC;IAClC,IAAI,MAAM,GAAe,IAAI,cAAc,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IAE/D,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QAC/B,MAAM,GAAG,IAAI,iBAAiB,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACvD,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,uEAAuE;AACvE,MAAM,cAAc;IAEC;IACA;IAFnB,YACmB,IAAgB,EAChB,WAAwB;QADxB,SAAI,GAAJ,IAAI,CAAY;QAChB,gBAAW,GAAX,WAAW,CAAa;IACxC,CAAC;IAEJ,KAAK,CAAC,IAAI,CAAC,OAAoB;QAC7B,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,CAAC;QACzD,sCAAsC;QACtC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAC7C,KAAK,MAAM,CAAC,IAAI,WAAW,EAAE,CAAC;YAC5B,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC;QAC9B,CAAC;QACD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAC,GAAG,OAAO,EAAE,OAAO,EAAC,CAAC,CAAC;IAC/C,CAAC;CACF;AAED,qEAAqE;AACrE,MAAM,iBAAiB;IAEF;IACA;IAFnB,YACmB,IAAgB,EAChB,OAAe;QADf,SAAI,GAAJ,IAAI,CAAY;QAChB,YAAO,GAAP,OAAO,CAAQ;IAC/B,CAAC;IAEJ,KAAK,CAAC,IAAI,CAAC,OAAoB;QAC7B,MAAM,aAAa,GAAG,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxD,MAAM,MAAM,GACV,OAAO,CAAC,MAAM,KAAK,SAAS;YAC1B,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;YAClD,CAAC,CAAC,aAAa,CAAC;QACpB,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAC,GAAG,OAAO,EAAE,MAAM,EAAC,CAAC,CAAC;IAC9C,CAAC;CACF"}
@@ -0,0 +1,22 @@
1
+ import type { Call } from '@databricks/sdk-core/api';
2
+ import type { HttpClient, HttpRequest } from '@databricks/sdk-core/http';
3
+ import type { Logger } from '@databricks/sdk-core/logger';
4
+ import type { CallOptions } from '@databricks/sdk-options/call';
5
+ import type { z } from 'zod';
6
+ export interface HttpCallOptions {
7
+ readonly request: HttpRequest;
8
+ readonly httpClient: HttpClient;
9
+ readonly logger: Logger;
10
+ }
11
+ /**
12
+ * Translates public CallOptions to the internal Options shape accepted by
13
+ * execute(). Even though the shapes match today, this isolates the public
14
+ * API from the executor's internal type so they can diverge.
15
+ */
16
+ export declare function executeCall(call: Call, options?: CallOptions): Promise<void>;
17
+ export declare function executeHttpCall(opts: HttpCallOptions): Promise<Uint8Array>;
18
+ export declare function buildHttpRequest(method: string, url: string, headers: Headers, signal?: AbortSignal, body?: string | ReadableStream<Uint8Array>): HttpRequest;
19
+ export declare function parseResponse<T>(body: Uint8Array, schema: z.ZodType<T>): T;
20
+ export declare function marshalRequest(data: unknown, schema: z.ZodType): string;
21
+ export declare function flattenQueryParams(prefix: string, value: unknown, params: URLSearchParams): void;
22
+ //# sourceMappingURL=utils.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/v2/utils.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAC,IAAI,EAAU,MAAM,0BAA0B,CAAC;AAG5D,OAAO,KAAK,EACV,UAAU,EACV,WAAW,EAEZ,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,6BAA6B,CAAC;AACxD,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,8BAA8B,CAAC;AAE9D,OAAO,KAAK,EAAC,CAAC,EAAC,MAAM,KAAK,CAAC;AAO3B,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC;IAC9B,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;IAChC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAED;;;;GAIG;AACH,wBAAsB,WAAW,CAC/B,IAAI,EAAE,IAAI,EACV,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,IAAI,CAAC,CASf;AA2BD,wBAAsB,eAAe,CACnC,IAAI,EAAE,eAAe,GACpB,OAAO,CAAC,UAAU,CAAC,CA2BrB;AAED,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,OAAO,EAChB,MAAM,CAAC,EAAE,WAAW,EACpB,IAAI,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,UAAU,CAAC,GACzC,WAAW,CASb;AAED,wBAAgB,aAAa,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAI1E;AAED,wBAAgB,cAAc,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,OAAO,GAAG,MAAM,CAEvE;AAED,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,eAAe,GACtB,IAAI,CAuBN"}
@@ -0,0 +1,113 @@
1
+ // Code generated from API definition by Databricks SDK Generator. DO NOT EDIT.
2
+ import { execute } from '@databricks/sdk-core/api';
3
+ import { ApiError } from '@databricks/sdk-core/apierror';
4
+ import JSONBig from 'json-bigint';
5
+ // JSON codec that preserves int64 precision. On the way in, large integer
6
+ // literals come back as bigint instead of being rounded to JS Number. On the
7
+ // way out, bigint values are emitted as raw JSON number digits.
8
+ const jsonBigint = JSONBig({ useNativeBigInt: true });
9
+ /**
10
+ * Translates public CallOptions to the internal Options shape accepted by
11
+ * execute(). Even though the shapes match today, this isolates the public
12
+ * API from the executor's internal type so they can diverge.
13
+ */
14
+ export async function executeCall(call, options) {
15
+ const opts = {
16
+ ...(options?.retrier !== undefined && { retrier: options.retrier }),
17
+ ...(options?.rateLimiter !== undefined && {
18
+ rateLimiter: options.rateLimiter,
19
+ }),
20
+ ...(options?.timeout !== undefined && { timeout: options.timeout }),
21
+ };
22
+ return execute(options?.signal, call, opts);
23
+ }
24
+ async function readAll(body) {
25
+ if (body === null) {
26
+ return new Uint8Array(0);
27
+ }
28
+ const reader = body.getReader();
29
+ const chunks = [];
30
+ for (;;) {
31
+ const { done, value } = await reader.read();
32
+ if (done) {
33
+ break;
34
+ }
35
+ chunks.push(value);
36
+ }
37
+ const totalLength = chunks.reduce((acc, chunk) => acc + chunk.length, 0);
38
+ const result = new Uint8Array(totalLength);
39
+ let offset = 0;
40
+ for (const chunk of chunks) {
41
+ result.set(chunk, offset);
42
+ offset += chunk.length;
43
+ }
44
+ return result;
45
+ }
46
+ export async function executeHttpCall(opts) {
47
+ opts.logger.debug('HTTP request', {
48
+ method: opts.request.method,
49
+ url: opts.request.url,
50
+ });
51
+ let resp;
52
+ try {
53
+ resp = await opts.httpClient.send(opts.request);
54
+ }
55
+ catch (e) {
56
+ opts.logger.debug('HTTP request failed');
57
+ throw e;
58
+ }
59
+ const body = await readAll(resp.body);
60
+ opts.logger.debug('HTTP response', {
61
+ statusCode: resp.statusCode,
62
+ body: new TextDecoder().decode(body),
63
+ });
64
+ const apiErr = ApiError.fromHttpError(resp.statusCode, resp.headers, body);
65
+ if (apiErr !== undefined) {
66
+ throw apiErr;
67
+ }
68
+ return body;
69
+ }
70
+ export function buildHttpRequest(method, url, headers, signal, body) {
71
+ const req = { url, method, headers };
72
+ if (body !== undefined) {
73
+ req.body = body;
74
+ }
75
+ if (signal !== undefined) {
76
+ req.signal = signal;
77
+ }
78
+ return req;
79
+ }
80
+ export function parseResponse(body, schema) {
81
+ const text = new TextDecoder().decode(body);
82
+ const parsed = jsonBigint.parse(text);
83
+ return schema.parse(parsed);
84
+ }
85
+ export function marshalRequest(data, schema) {
86
+ return jsonBigint.stringify(schema.parse(data));
87
+ }
88
+ export function flattenQueryParams(prefix, value, params) {
89
+ if (value === null || value === undefined) {
90
+ return;
91
+ }
92
+ if (Array.isArray(value)) {
93
+ // arrays of objects are not yet supported
94
+ for (const item of value) {
95
+ params.append(prefix, String(item));
96
+ }
97
+ }
98
+ else if (typeof value === 'object') {
99
+ for (const [key, val] of Object.entries(value)) {
100
+ flattenQueryParams(`${prefix}.${key}`, val, params);
101
+ }
102
+ }
103
+ else if (typeof value === 'string' ||
104
+ typeof value === 'number' ||
105
+ typeof value === 'boolean' ||
106
+ typeof value === 'bigint') {
107
+ params.append(prefix, String(value));
108
+ }
109
+ else {
110
+ throw new Error(`Unsupported query parameter type: ${typeof value}`);
111
+ }
112
+ }
113
+ //# sourceMappingURL=utils.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/v2/utils.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAG/E,OAAO,EAAC,OAAO,EAAC,MAAM,0BAA0B,CAAC;AACjD,OAAO,EAAC,QAAQ,EAAC,MAAM,+BAA+B,CAAC;AAQvD,OAAO,OAAO,MAAM,aAAa,CAAC;AAGlC,0EAA0E;AAC1E,6EAA6E;AAC7E,gEAAgE;AAChE,MAAM,UAAU,GAAG,OAAO,CAAC,EAAC,eAAe,EAAE,IAAI,EAAC,CAAC,CAAC;AAQpD;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,IAAU,EACV,OAAqB;IAErB,MAAM,IAAI,GAAY;QACpB,GAAG,CAAC,OAAO,EAAE,OAAO,KAAK,SAAS,IAAI,EAAC,OAAO,EAAE,OAAO,CAAC,OAAO,EAAC,CAAC;QACjE,GAAG,CAAC,OAAO,EAAE,WAAW,KAAK,SAAS,IAAI;YACxC,WAAW,EAAE,OAAO,CAAC,WAAW;SACjC,CAAC;QACF,GAAG,CAAC,OAAO,EAAE,OAAO,KAAK,SAAS,IAAI,EAAC,OAAO,EAAE,OAAO,CAAC,OAAO,EAAC,CAAC;KAClE,CAAC;IACF,OAAO,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;AAC9C,CAAC;AAED,KAAK,UAAU,OAAO,CACpB,IAAuC;IAEvC,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QAClB,OAAO,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC;IAC3B,CAAC;IACD,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;IAChC,MAAM,MAAM,GAAiB,EAAE,CAAC;IAChC,SAAS,CAAC;QACR,MAAM,EAAC,IAAI,EAAE,KAAK,EAAC,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;QAC1C,IAAI,IAAI,EAAE,CAAC;YACT,MAAM;QACR,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACrB,CAAC;IACD,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IACzE,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,WAAW,CAAC,CAAC;IAC3C,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC1B,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC;IACzB,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,IAAqB;IAErB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,cAAc,EAAE;QAChC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM;QAC3B,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG;KACtB,CAAC,CAAC;IAEH,IAAI,IAAkB,CAAC;IACvB,IAAI,CAAC;QACH,IAAI,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAClD,CAAC;IAAC,OAAO,CAAU,EAAE,CAAC;QACpB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACzC,MAAM,CAAC,CAAC;IACV,CAAC;IAED,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAEtC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,EAAE;QACjC,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,IAAI,EAAE,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC;KACrC,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAC3E,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,MAAM,MAAM,CAAC;IACf,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,UAAU,gBAAgB,CAC9B,MAAc,EACd,GAAW,EACX,OAAgB,EAChB,MAAoB,EACpB,IAA0C;IAE1C,MAAM,GAAG,GAAgB,EAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAC,CAAC;IAChD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC;IAClB,CAAC;IACD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC;IACtB,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,UAAU,aAAa,CAAI,IAAgB,EAAE,MAAoB;IACrE,MAAM,IAAI,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC5C,MAAM,MAAM,GAAY,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC/C,OAAO,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;AAC9B,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,IAAa,EAAE,MAAiB;IAC7D,OAAO,UAAU,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;AAClD,CAAC;AAED,MAAM,UAAU,kBAAkB,CAChC,MAAc,EACd,KAAc,EACd,MAAuB;IAEvB,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QAC1C,OAAO;IACT,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,0CAA0C;QAC1C,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;QACtC,CAAC;IACH,CAAC;SAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACrC,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAgC,CAAC,EAAE,CAAC;YAC1E,kBAAkB,CAAC,GAAG,MAAM,IAAI,GAAG,EAAE,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;QACtD,CAAC;IACH,CAAC;SAAM,IACL,OAAO,KAAK,KAAK,QAAQ;QACzB,OAAO,KAAK,KAAK,QAAQ;QACzB,OAAO,KAAK,KAAK,SAAS;QAC1B,OAAO,KAAK,KAAK,QAAQ,EACzB,CAAC;QACD,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACvC,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,KAAK,CAAC,qCAAqC,OAAO,KAAK,EAAE,CAAC,CAAC;IACvE,CAAC;AACH,CAAC"}
package/package.json CHANGED
@@ -1,7 +1,41 @@
1
1
  {
2
2
  "name": "@databricks/sdk-instanceprofiles",
3
- "version": "0.0.0-dev",
4
- "description": "Bootstrap placeholder; real contents in a later release.",
5
- "main": "index.js",
6
- "license": "Apache-2.0"
3
+ "version": "0.1.0-dev.1",
4
+ "description": "",
5
+ "type": "module",
6
+ "exports": {
7
+ "./v2": {
8
+ "types": "./dist/v2/index.d.ts",
9
+ "import": "./dist/v2/index.js"
10
+ }
11
+ },
12
+ "files": [
13
+ "dist",
14
+ "src",
15
+ "LICENSE"
16
+ ],
17
+ "scripts": {
18
+ "build": "tsc -b",
19
+ "lint": "eslint src --ext .ts",
20
+ "lint:fix": "eslint src --ext .ts --fix",
21
+ "format": "prettier --write \"src/**/*.ts\"",
22
+ "format:check": "prettier --check \"src/**/*.ts\"",
23
+ "typecheck": "tsc --noEmit",
24
+ "clean": "rm -rf dist tsconfig.tsbuildinfo",
25
+ "test": "echo 'no tests'",
26
+ "test:browser": "echo 'no tests'"
27
+ },
28
+ "author": "Databricks",
29
+ "license": "Apache-2.0",
30
+ "dependencies": {
31
+ "@databricks/sdk-auth": ">=0.1.0-dev.2 <1.0.0",
32
+ "@databricks/sdk-core": ">=0.1.0-dev.3 <1.0.0",
33
+ "@databricks/sdk-options": ">=0.1.0-dev.2 <1.0.0",
34
+ "@js-temporal/polyfill": "^0.5.0",
35
+ "json-bigint": "^1.0.0",
36
+ "zod": "^4.3.6"
37
+ },
38
+ "engines": {
39
+ "node": ">=22.0.0"
40
+ }
7
41
  }
@@ -0,0 +1,227 @@
1
+ // Code generated from API definition by Databricks SDK Generator. DO NOT EDIT.
2
+
3
+ import {VERSION as AUTH_VERSION} from '@databricks/sdk-auth';
4
+ import type {Call} from '@databricks/sdk-core/api';
5
+ import {createDefault} from '@databricks/sdk-core/clientinfo';
6
+ import type {Logger} from '@databricks/sdk-core/logger';
7
+ import {NoOpLogger} from '@databricks/sdk-core/logger';
8
+ import type {CallOptions} from '@databricks/sdk-options/call';
9
+ import type {ClientOptions} from '@databricks/sdk-options/client';
10
+ import type {HttpClient} from '@databricks/sdk-core/http';
11
+ import {newHttpClient} from './transport';
12
+ import {
13
+ buildHttpRequest,
14
+ executeCall,
15
+ executeHttpCall,
16
+ marshalRequest,
17
+ parseResponse,
18
+ } from './utils';
19
+ import pkgJson from '../../package.json' with {type: 'json'};
20
+ import type {
21
+ AddInstanceProfileRequest,
22
+ AddInstanceProfileRequest_Response,
23
+ EditInstanceProfileRequest,
24
+ EditInstanceProfileRequest_Response,
25
+ ListInstanceProfilesRequest,
26
+ ListInstanceProfilesRequest_Response,
27
+ RemoveInstanceProfileRequest,
28
+ RemoveInstanceProfileRequest_Response,
29
+ } from './model';
30
+ import {
31
+ marshalAddInstanceProfileRequestSchema,
32
+ marshalEditInstanceProfileRequestSchema,
33
+ marshalRemoveInstanceProfileRequestSchema,
34
+ unmarshalAddInstanceProfileRequest_ResponseSchema,
35
+ unmarshalEditInstanceProfileRequest_ResponseSchema,
36
+ unmarshalListInstanceProfilesRequest_ResponseSchema,
37
+ unmarshalRemoveInstanceProfileRequest_ResponseSchema,
38
+ } from './model';
39
+
40
+ // Package identity segment for this client to be used in the User-Agent header.
41
+ const PACKAGE_SEGMENT = {
42
+ key: 'sdk-js-' + pkgJson.name.replace(/^@[^/]+\/sdk-/, ''),
43
+ value: pkgJson.version,
44
+ };
45
+
46
+ export class InstanceprofilesClient {
47
+ private readonly host: string;
48
+ // Workspace ID used to route workspace-level calls on unified hosts (SPOG).
49
+ // When set, workspace-level methods send X-Databricks-Org-Id on every
50
+ // request.
51
+ private readonly workspaceId: string | undefined;
52
+ private readonly httpClient: HttpClient;
53
+ private readonly logger: Logger;
54
+ // User-Agent header value. Composed once at construction from
55
+ // createDefault() merged with this package's identity and the active
56
+ // credential's name.
57
+ private readonly userAgent: string;
58
+
59
+ constructor(options: ClientOptions) {
60
+ if (options.host === undefined) {
61
+ throw new Error('Host is required.');
62
+ }
63
+ this.host = options.host.replace(/\/$/, '');
64
+ this.workspaceId = options.workspaceId;
65
+ this.logger = options.logger ?? new NoOpLogger();
66
+ const info = createDefault()
67
+ .with(PACKAGE_SEGMENT)
68
+ .with({key: 'sdk-js-auth', value: AUTH_VERSION})
69
+ .with({key: 'auth', value: options.credentials?.name() ?? 'default'});
70
+ this.userAgent = info.toString();
71
+ this.httpClient = newHttpClient(options);
72
+ }
73
+
74
+ /**
75
+ * Registers an instance profile in <Databricks>. In the UI, you can then give users the permission
76
+ * to use this instance profile when launching clusters.
77
+ *
78
+ * This API is only available to admin users.
79
+ */
80
+ async addInstanceProfile(
81
+ req: AddInstanceProfileRequest,
82
+ options?: CallOptions
83
+ ): Promise<AddInstanceProfileRequest_Response> {
84
+ const url = `${this.host}/api/2.0/instance-profiles/add`;
85
+ const body = marshalRequest(req, marshalAddInstanceProfileRequestSchema);
86
+ let resp: AddInstanceProfileRequest_Response | undefined;
87
+ const call: Call = async (callSignal?: AbortSignal): Promise<void> => {
88
+ const headers = new Headers({'Content-Type': 'application/json'});
89
+ if (this.workspaceId !== undefined) {
90
+ headers.set('X-Databricks-Org-Id', this.workspaceId);
91
+ }
92
+ headers.set('User-Agent', this.userAgent);
93
+ const httpReq = buildHttpRequest('POST', url, headers, callSignal, body);
94
+ const respBody = await executeHttpCall({
95
+ request: httpReq,
96
+ httpClient: this.httpClient,
97
+ logger: this.logger,
98
+ });
99
+ resp = parseResponse(
100
+ respBody,
101
+ unmarshalAddInstanceProfileRequest_ResponseSchema
102
+ );
103
+ };
104
+ await executeCall(call, options);
105
+ if (resp === undefined) {
106
+ throw new Error('API call completed without a result.');
107
+ }
108
+ return resp;
109
+ }
110
+
111
+ /**
112
+ * The only supported field to change is the optional IAM role ARN associated with
113
+ * the instance profile. It is required to specify the IAM role ARN if both of
114
+ * the following are true:
115
+ *
116
+ * * Your role name and instance profile name do not match. The name is the part
117
+ * after the last slash in each ARN.
118
+ * * You want to use the instance profile with [Databricks SQL Serverless](/sql/admin/serverless.html).
119
+ *
120
+ * To understand where these fields are in the AWS console, see
121
+ * [Enable serverless SQL warehouses](/sql/admin/serverless.html).
122
+ *
123
+ * This API is only available to admin users.
124
+ */
125
+ async editInstanceProfile(
126
+ req: EditInstanceProfileRequest,
127
+ options?: CallOptions
128
+ ): Promise<EditInstanceProfileRequest_Response> {
129
+ const url = `${this.host}/api/2.0/instance-profiles/edit`;
130
+ const body = marshalRequest(req, marshalEditInstanceProfileRequestSchema);
131
+ let resp: EditInstanceProfileRequest_Response | undefined;
132
+ const call: Call = async (callSignal?: AbortSignal): Promise<void> => {
133
+ const headers = new Headers({'Content-Type': 'application/json'});
134
+ if (this.workspaceId !== undefined) {
135
+ headers.set('X-Databricks-Org-Id', this.workspaceId);
136
+ }
137
+ headers.set('User-Agent', this.userAgent);
138
+ const httpReq = buildHttpRequest('POST', url, headers, callSignal, body);
139
+ const respBody = await executeHttpCall({
140
+ request: httpReq,
141
+ httpClient: this.httpClient,
142
+ logger: this.logger,
143
+ });
144
+ resp = parseResponse(
145
+ respBody,
146
+ unmarshalEditInstanceProfileRequest_ResponseSchema
147
+ );
148
+ };
149
+ await executeCall(call, options);
150
+ if (resp === undefined) {
151
+ throw new Error('API call completed without a result.');
152
+ }
153
+ return resp;
154
+ }
155
+
156
+ /**
157
+ * List the instance profiles that the calling user can use to launch a cluster.
158
+ *
159
+ * This API is available to all users.
160
+ */
161
+ async listInstanceProfiles(
162
+ _req: ListInstanceProfilesRequest,
163
+ options?: CallOptions
164
+ ): Promise<ListInstanceProfilesRequest_Response> {
165
+ const url = `${this.host}/api/2.0/instance-profiles/list`;
166
+ let resp: ListInstanceProfilesRequest_Response | undefined;
167
+ const call: Call = async (callSignal?: AbortSignal): Promise<void> => {
168
+ const headers = new Headers();
169
+ if (this.workspaceId !== undefined) {
170
+ headers.set('X-Databricks-Org-Id', this.workspaceId);
171
+ }
172
+ headers.set('User-Agent', this.userAgent);
173
+ const httpReq = buildHttpRequest('GET', url, headers, callSignal);
174
+ const respBody = await executeHttpCall({
175
+ request: httpReq,
176
+ httpClient: this.httpClient,
177
+ logger: this.logger,
178
+ });
179
+ resp = parseResponse(
180
+ respBody,
181
+ unmarshalListInstanceProfilesRequest_ResponseSchema
182
+ );
183
+ };
184
+ await executeCall(call, options);
185
+ if (resp === undefined) {
186
+ throw new Error('API call completed without a result.');
187
+ }
188
+ return resp;
189
+ }
190
+
191
+ /**
192
+ * Remove the instance profile with the provided ARN.
193
+ * Existing clusters with this instance profile will continue to function.
194
+ *
195
+ * This API is only accessible to admin users.
196
+ */
197
+ async removeInstanceProfile(
198
+ req: RemoveInstanceProfileRequest,
199
+ options?: CallOptions
200
+ ): Promise<RemoveInstanceProfileRequest_Response> {
201
+ const url = `${this.host}/api/2.0/instance-profiles/remove`;
202
+ const body = marshalRequest(req, marshalRemoveInstanceProfileRequestSchema);
203
+ let resp: RemoveInstanceProfileRequest_Response | undefined;
204
+ const call: Call = async (callSignal?: AbortSignal): Promise<void> => {
205
+ const headers = new Headers({'Content-Type': 'application/json'});
206
+ if (this.workspaceId !== undefined) {
207
+ headers.set('X-Databricks-Org-Id', this.workspaceId);
208
+ }
209
+ headers.set('User-Agent', this.userAgent);
210
+ const httpReq = buildHttpRequest('POST', url, headers, callSignal, body);
211
+ const respBody = await executeHttpCall({
212
+ request: httpReq,
213
+ httpClient: this.httpClient,
214
+ logger: this.logger,
215
+ });
216
+ resp = parseResponse(
217
+ respBody,
218
+ unmarshalRemoveInstanceProfileRequest_ResponseSchema
219
+ );
220
+ };
221
+ await executeCall(call, options);
222
+ if (resp === undefined) {
223
+ throw new Error('API call completed without a result.');
224
+ }
225
+ return resp;
226
+ }
227
+ }
@@ -0,0 +1,15 @@
1
+ // Code generated from API definition by Databricks SDK Generator. DO NOT EDIT.
2
+
3
+ export {InstanceprofilesClient} from './client';
4
+
5
+ export type {
6
+ AddInstanceProfileRequest,
7
+ AddInstanceProfileRequest_Response,
8
+ EditInstanceProfileRequest,
9
+ EditInstanceProfileRequest_Response,
10
+ InstanceProfile,
11
+ ListInstanceProfilesRequest,
12
+ ListInstanceProfilesRequest_Response,
13
+ RemoveInstanceProfileRequest,
14
+ RemoveInstanceProfileRequest_Response,
15
+ } from './model';
@@ -0,0 +1,171 @@
1
+ // Code generated from API definition by Databricks SDK Generator. DO NOT EDIT.
2
+
3
+ import {z} from 'zod';
4
+
5
+ export interface AddInstanceProfileRequest {
6
+ /**
7
+ * By default, <Databricks> validates that it has sufficient permissions to launch
8
+ * instances with the instance profile. This validation uses AWS dry-run mode for
9
+ * the RunInstances API. If validation fails with an error message that does not
10
+ * indicate an IAM related permission issue,
11
+ * (e.g. “Your requested instance type is not supported in your requested availability zone”),
12
+ * you can pass this flag to skip the validation and forcibly add the instance profile.
13
+ */
14
+ skipValidation?: boolean | undefined;
15
+ /** The AWS ARN of the instance profile to register with <Databricks>. This field is required. */
16
+ instanceProfileArn?: string | undefined;
17
+ /**
18
+ * Boolean flag indicating whether the instance profile should only be used in credential
19
+ * passthrough scenarios. If true, it means the instance profile contains an meta IAM role
20
+ * which could assume a wide range of roles. Therefore it should always be used with
21
+ * authorization.
22
+ * This field is optional, the default value is `false`.
23
+ */
24
+ isMetaInstanceProfile?: boolean | undefined;
25
+ /**
26
+ * The AWS IAM role ARN of the role associated with the instance profile.
27
+ * This field is required if your role name and instance profile name do
28
+ * not match and you want to use the instance profile with
29
+ * [Databricks SQL Serverless](/sql/admin/serverless.html).
30
+ *
31
+ * Otherwise, this field is optional.
32
+ */
33
+ iamRoleArn?: string | undefined;
34
+ }
35
+
36
+ // eslint-disable-next-line @typescript-eslint/naming-convention, @typescript-eslint/no-empty-object-type -- Proto-style nested message name.
37
+ export interface AddInstanceProfileRequest_Response {}
38
+
39
+ export interface EditInstanceProfileRequest {
40
+ /** The AWS ARN of the instance profile to register with <Databricks>. This field is required. */
41
+ instanceProfileArn?: string | undefined;
42
+ /**
43
+ * Boolean flag indicating whether the instance profile should only be used in credential
44
+ * passthrough scenarios. If true, it means the instance profile contains an meta IAM role
45
+ * which could assume a wide range of roles. Therefore it should always be used with
46
+ * authorization.
47
+ * This field is optional, the default value is `false`.
48
+ */
49
+ isMetaInstanceProfile?: boolean | undefined;
50
+ /**
51
+ * The AWS IAM role ARN of the role associated with the instance profile.
52
+ * This field is required if your role name and instance profile name do
53
+ * not match and you want to use the instance profile with
54
+ * [Databricks SQL Serverless](/sql/admin/serverless.html).
55
+ *
56
+ * Otherwise, this field is optional.
57
+ */
58
+ iamRoleArn?: string | undefined;
59
+ }
60
+
61
+ // eslint-disable-next-line @typescript-eslint/naming-convention, @typescript-eslint/no-empty-object-type -- Proto-style nested message name.
62
+ export interface EditInstanceProfileRequest_Response {}
63
+
64
+ export interface InstanceProfile {
65
+ /** The AWS ARN of the instance profile to register with <Databricks>. This field is required. */
66
+ instanceProfileArn?: string | undefined;
67
+ /**
68
+ * Boolean flag indicating whether the instance profile should only be used in credential
69
+ * passthrough scenarios. If true, it means the instance profile contains an meta IAM role
70
+ * which could assume a wide range of roles. Therefore it should always be used with
71
+ * authorization.
72
+ * This field is optional, the default value is `false`.
73
+ */
74
+ isMetaInstanceProfile?: boolean | undefined;
75
+ /**
76
+ * The AWS IAM role ARN of the role associated with the instance profile.
77
+ * This field is required if your role name and instance profile name do
78
+ * not match and you want to use the instance profile with
79
+ * [Databricks SQL Serverless](/sql/admin/serverless.html).
80
+ *
81
+ * Otherwise, this field is optional.
82
+ */
83
+ iamRoleArn?: string | undefined;
84
+ }
85
+
86
+ // eslint-disable-next-line @typescript-eslint/no-empty-object-type
87
+ export interface ListInstanceProfilesRequest {}
88
+
89
+ // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
90
+ export interface ListInstanceProfilesRequest_Response {
91
+ /** A list of instance profiles that the user can access. */
92
+ instanceProfiles?: InstanceProfile[] | undefined;
93
+ }
94
+
95
+ export interface RemoveInstanceProfileRequest {
96
+ /** The ARN of the instance profile to remove. This field is required. */
97
+ instanceProfileArn?: string | undefined;
98
+ }
99
+
100
+ // eslint-disable-next-line @typescript-eslint/naming-convention, @typescript-eslint/no-empty-object-type -- Proto-style nested message name.
101
+ export interface RemoveInstanceProfileRequest_Response {}
102
+
103
+ // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
104
+ export const unmarshalAddInstanceProfileRequest_ResponseSchema: z.ZodType<AddInstanceProfileRequest_Response> =
105
+ z.object({});
106
+
107
+ // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
108
+ export const unmarshalEditInstanceProfileRequest_ResponseSchema: z.ZodType<EditInstanceProfileRequest_Response> =
109
+ z.object({});
110
+
111
+ export const unmarshalInstanceProfileSchema: z.ZodType<InstanceProfile> = z
112
+ .object({
113
+ instance_profile_arn: z.string().optional(),
114
+ is_meta_instance_profile: z.boolean().optional(),
115
+ iam_role_arn: z.string().optional(),
116
+ })
117
+ .transform(d => ({
118
+ instanceProfileArn: d.instance_profile_arn,
119
+ isMetaInstanceProfile: d.is_meta_instance_profile,
120
+ iamRoleArn: d.iam_role_arn,
121
+ }));
122
+
123
+ // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
124
+ export const unmarshalListInstanceProfilesRequest_ResponseSchema: z.ZodType<ListInstanceProfilesRequest_Response> =
125
+ z
126
+ .object({
127
+ instance_profiles: z
128
+ .array(z.lazy(() => unmarshalInstanceProfileSchema))
129
+ .optional(),
130
+ })
131
+ .transform(d => ({
132
+ instanceProfiles: d.instance_profiles,
133
+ }));
134
+
135
+ // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
136
+ export const unmarshalRemoveInstanceProfileRequest_ResponseSchema: z.ZodType<RemoveInstanceProfileRequest_Response> =
137
+ z.object({});
138
+
139
+ export const marshalAddInstanceProfileRequestSchema: z.ZodType = z
140
+ .object({
141
+ skipValidation: z.boolean().optional(),
142
+ instanceProfileArn: z.string().optional(),
143
+ isMetaInstanceProfile: z.boolean().optional(),
144
+ iamRoleArn: z.string().optional(),
145
+ })
146
+ .transform(d => ({
147
+ skip_validation: d.skipValidation,
148
+ instance_profile_arn: d.instanceProfileArn,
149
+ is_meta_instance_profile: d.isMetaInstanceProfile,
150
+ iam_role_arn: d.iamRoleArn,
151
+ }));
152
+
153
+ export const marshalEditInstanceProfileRequestSchema: z.ZodType = z
154
+ .object({
155
+ instanceProfileArn: z.string().optional(),
156
+ isMetaInstanceProfile: z.boolean().optional(),
157
+ iamRoleArn: z.string().optional(),
158
+ })
159
+ .transform(d => ({
160
+ instance_profile_arn: d.instanceProfileArn,
161
+ is_meta_instance_profile: d.isMetaInstanceProfile,
162
+ iam_role_arn: d.iamRoleArn,
163
+ }));
164
+
165
+ export const marshalRemoveInstanceProfileRequestSchema: z.ZodType = z
166
+ .object({
167
+ instanceProfileArn: z.string().optional(),
168
+ })
169
+ .transform(d => ({
170
+ instance_profile_arn: d.instanceProfileArn,
171
+ }));