@databricks/sdk-uc-workspacebindings 0.0.0-dev → 0.1.0-dev.2

package/src/v1/model.ts

@@ -0,0 +1,193 @@
+// Code generated from API definition by Databricks SDK Generator. DO NOT EDIT.
+
+import {z} from 'zod';
+
+/** Using `BINDING_TYPE_` prefix here to avoid conflict with `TableOperation` enum in `credentials_common.proto`. */
+export enum BindingType {
+  BINDING_TYPE_UNSPECIFIED = 'BINDING_TYPE_UNSPECIFIED',
+  BINDING_TYPE_READ_WRITE = 'BINDING_TYPE_READ_WRITE',
+  BINDING_TYPE_READ_ONLY = 'BINDING_TYPE_READ_ONLY',
+}
+
+export interface GetCatalogWorkspaceBindingsRequest {
+  /** The name of the catalog. */
+  catalogName?: string | undefined;
+}
+
+// eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
+export interface GetCatalogWorkspaceBindingsRequest_Response {
+  /** A list of workspace IDs */
+  workspaces?: bigint[] | undefined;
+}
+
+export interface GetWorkspaceBindingsRequest {
+  /** The type of the securable to bind to a workspace (catalog, storage_credential, credential, or external_location). */
+  securableType?: string | undefined;
+  /** The name of the securable. */
+  securableFullName?: string | undefined;
+  /**
+   * Maximum number of workspace bindings to return.
+   * - When set to 0, the page length is set to a server configured value (recommended);
+   * - When set to a value greater than 0, the page length is the minimum of this value and a server configured value;
+   * - When set to a value less than 0, an invalid parameter error is returned;
+   * - If not set, all the workspace bindings are returned (not recommended).
+   */
+  maxResults?: number | undefined;
+  /** Opaque pagination token to go to next page based on previous query. */
+  pageToken?: string | undefined;
+}
+
+// eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
+export interface GetWorkspaceBindingsRequest_Response {
+  /** List of workspace bindings */
+  bindings?: WorkspaceBindingInfo[] | undefined;
+  /**
+   * Opaque token to retrieve the next page of results. Absent if there are no more pages.
+   * __page_token__ should be set to this value for the next request (for the next page of results).
+   */
+  nextPageToken?: string | undefined;
+}
+
+export interface UpdateCatalogWorkspaceBindingsRequest {
+  /** The name of the catalog. */
+  catalogName?: string | undefined;
+  /** A list of workspace IDs. */
+  assignWorkspaces?: bigint[] | undefined;
+  /** A list of workspace IDs. */
+  unassignWorkspaces?: bigint[] | undefined;
+}
+
+// eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
+export interface UpdateCatalogWorkspaceBindingsRequest_Response {
+  /** A list of workspace IDs */
+  workspaces?: bigint[] | undefined;
+}
+
+export interface UpdateWorkspaceBindingsRequest {
+  /** The type of the securable to bind to a workspace (catalog, storage_credential, credential, or external_location). */
+  securableType?: string | undefined;
+  /** The name of the securable. */
+  securableFullName?: string | undefined;
+  /**
+   * List of workspace bindings to add. If a binding for the workspace already exists with a
+   * different binding_type, adding it again with a new binding_type will update the existing
+   * binding (e.g., from READ_WRITE to READ_ONLY).
+   */
+  add?: WorkspaceBindingInfo[] | undefined;
+  /** List of workspace bindings to remove. */
+  remove?: WorkspaceBindingInfo[] | undefined;
+}
+
+/** A list of workspace IDs that are bound to the securable */
+// eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
+export interface UpdateWorkspaceBindingsRequest_Response {
+  /** List of workspace bindings. */
+  bindings?: WorkspaceBindingInfo[] | undefined;
+}
+
+export interface WorkspaceBindingInfo {
+  /** Required */
+  workspaceId?: bigint | undefined;
+  /** One of READ_WRITE/READ_ONLY. Default is READ_WRITE. */
+  bindingType?: BindingType | undefined;
+}
+
+// eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
+export const unmarshalGetCatalogWorkspaceBindingsRequest_ResponseSchema: z.ZodType<GetCatalogWorkspaceBindingsRequest_Response> =
+  z
+    .object({
+      workspaces: z
+        .array(z.union([z.number(), z.bigint()]).transform(v => BigInt(v)))
+        .optional(),
+    })
+    .transform(d => ({
+      workspaces: d.workspaces,
+    }));
+
+// eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
+export const unmarshalGetWorkspaceBindingsRequest_ResponseSchema: z.ZodType<GetWorkspaceBindingsRequest_Response> =
+  z
+    .object({
+      bindings: z
+        .array(z.lazy(() => unmarshalWorkspaceBindingInfoSchema))
+        .optional(),
+      next_page_token: z.string().optional(),
+    })
+    .transform(d => ({
+      bindings: d.bindings,
+      nextPageToken: d.next_page_token,
+    }));
+
+// eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
+export const unmarshalUpdateCatalogWorkspaceBindingsRequest_ResponseSchema: z.ZodType<UpdateCatalogWorkspaceBindingsRequest_Response> =
+  z
+    .object({
+      workspaces: z
+        .array(z.union([z.number(), z.bigint()]).transform(v => BigInt(v)))
+        .optional(),
+    })
+    .transform(d => ({
+      workspaces: d.workspaces,
+    }));
+
+// eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
+export const unmarshalUpdateWorkspaceBindingsRequest_ResponseSchema: z.ZodType<UpdateWorkspaceBindingsRequest_Response> =
+  z
+    .object({
+      bindings: z
+        .array(z.lazy(() => unmarshalWorkspaceBindingInfoSchema))
+        .optional(),
+    })
+    .transform(d => ({
+      bindings: d.bindings,
+    }));
+
+export const unmarshalWorkspaceBindingInfoSchema: z.ZodType<WorkspaceBindingInfo> =
+  z
+    .object({
+      workspace_id: z
+        .union([z.number(), z.bigint()])
+        .transform(v => BigInt(v))
+        .optional(),
+      binding_type: z.enum(BindingType).optional(),
+    })
+    .transform(d => ({
+      workspaceId: d.workspace_id,
+      bindingType: d.binding_type,
+    }));
+
+export const marshalUpdateCatalogWorkspaceBindingsRequestSchema: z.ZodType = z
+  .object({
+    catalogName: z.string().optional(),
+    assignWorkspaces: z.array(z.bigint()).optional(),
+    unassignWorkspaces: z.array(z.bigint()).optional(),
+  })
+  .transform(d => ({
+    catalog_name: d.catalogName,
+    assign_workspaces: d.assignWorkspaces,
+    unassign_workspaces: d.unassignWorkspaces,
+  }));
+
+export const marshalUpdateWorkspaceBindingsRequestSchema: z.ZodType = z
+  .object({
+    securableType: z.string().optional(),
+    securableFullName: z.string().optional(),
+    add: z.array(z.lazy(() => marshalWorkspaceBindingInfoSchema)).optional(),
+    remove: z.array(z.lazy(() => marshalWorkspaceBindingInfoSchema)).optional(),
+  })
+  .transform(d => ({
+    securable_type: d.securableType,
+    securable_full_name: d.securableFullName,
+    add: d.add,
+    remove: d.remove,
+  }));
+
+export const marshalWorkspaceBindingInfoSchema: z.ZodType = z
+  .object({
+    workspaceId: z.bigint().optional(),
+    bindingType: z.enum(BindingType).optional(),
+  })
+  .transform(d => ({
+    workspace_id: d.workspaceId,
+    binding_type: d.bindingType,
+  }));

package/src/v1/transport.ts

@@ -0,0 +1,73 @@
+// Code generated from API definition by Databricks SDK Generator. DO NOT EDIT.
+
+import type {Credentials} from '@databricks/sdk-auth';
+import {defaultCredentials} from '@databricks/sdk-auth/credentials';
+import type {
+  HttpClient,
+  HttpRequest,
+  HttpResponse,
+} from '@databricks/sdk-core/http';
+import {newFetchHttpClient} from '@databricks/sdk-core/http';
+import type {ClientOptions} from '@databricks/sdk-options/client';
+
+/** Creates a new HTTP client with the given options. */
+export function newHttpClient(options?: ClientOptions): HttpClient {
+  const opts = options ?? {};
+
+  // If an HTTP client is provided, use it as-is. Throw if other options are
+  // also set, since they would be silently ignored.
+  if (opts.httpClient !== undefined) {
+    if (opts.credentials !== undefined || opts.timeout !== undefined) {
+      throw new Error(
+        'httpClient cannot be combined with credentials or timeout'
+      );
+    }
+    return opts.httpClient;
+  }
+
+  const credentials = opts.credentials ?? defaultCredentials();
+
+  const base = newFetchHttpClient();
+  let client: HttpClient = new AuthHttpClient(base, credentials);
+
+  if (opts.timeout !== undefined) {
+    client = new TimeoutHttpClient(client, opts.timeout);
+  }
+
+  return client;
+}
+
+/** Wraps an HttpClient and adds authentication headers to requests. */
+class AuthHttpClient implements HttpClient {
+  constructor(
+    private readonly base: HttpClient,
+    private readonly credentials: Credentials
+  ) {}
+
+  async send(request: HttpRequest): Promise<HttpResponse> {
+    const authHeaders = await this.credentials.authHeaders();
+    // Do not modify the original request.
+    const headers = new Headers(request.headers);
+    for (const h of authHeaders) {
+      headers.set(h.key, h.value);
+    }
+    return this.base.send({...request, headers});
+  }
+}
+
+/** Wraps an HttpClient and applies a default timeout to requests. */
+class TimeoutHttpClient implements HttpClient {
+  constructor(
+    private readonly base: HttpClient,
+    private readonly timeout: number
+  ) {}
+
+  async send(request: HttpRequest): Promise<HttpResponse> {
+    const timeoutSignal = AbortSignal.timeout(this.timeout);
+    const signal =
+      request.signal !== undefined
+        ? AbortSignal.any([request.signal, timeoutSignal])
+        : timeoutSignal;
+    return this.base.send({...request, signal});
+  }
+}

package/src/v1/utils.ts

@@ -0,0 +1,156 @@
+// Code generated from API definition by Databricks SDK Generator. DO NOT EDIT.
+
+import type {Options} from '@databricks/sdk-core/ops';
+import {execute} from '@databricks/sdk-core/ops';
+import {ApiError} from '@databricks/sdk-core/apierror';
+import type {
+  HttpClient,
+  HttpRequest,
+  HttpResponse,
+} from '@databricks/sdk-core/http';
+import type {Logger} from '@databricks/sdk-core/logger';
+import type {CallOptions} from '@databricks/sdk-options/call';
+import JSONBig from 'json-bigint';
+import type {z} from 'zod';
+
+// JSON codec that preserves int64 precision. On the way in, large integer
+// literals come back as bigint instead of being rounded to JS Number. On the
+// way out, bigint values are emitted as raw JSON number digits.
+const jsonBigint = JSONBig({useNativeBigInt: true});
+
+export interface HttpCallOptions {
+  readonly request: HttpRequest;
+  readonly httpClient: HttpClient;
+  readonly logger: Logger;
+}
+
+/**
+ * Translates public CallOptions to the internal Options shape accepted by
+ * execute(). Even though the shapes match today, this isolates the public
+ * API from the executor's internal type so they can diverge.
+ */
+export async function executeCall(
+  call: (signal?: AbortSignal) => Promise<void>,
+  options?: CallOptions
+): Promise<void> {
+  const opts: Options = {
+    ...(options?.retrier !== undefined && {retrier: options.retrier}),
+    ...(options?.rateLimiter !== undefined && {
+      rateLimiter: options.rateLimiter,
+    }),
+    ...(options?.timeout !== undefined && {timeout: options.timeout}),
+  };
+  return execute(options?.signal, call, opts);
+}
+
+async function readAll(
+  body: ReadableStream<Uint8Array> | null
+): Promise<Uint8Array> {
+  if (body === null) {
+    return new Uint8Array(0);
+  }
+  const reader = body.getReader();
+  const chunks: Uint8Array[] = [];
+  for (;;) {
+    const {done, value} = await reader.read();
+    if (done) {
+      break;
+    }
+    chunks.push(value);
+  }
+  const totalLength = chunks.reduce((acc, chunk) => acc + chunk.length, 0);
+  const result = new Uint8Array(totalLength);
+  let offset = 0;
+  for (const chunk of chunks) {
+    result.set(chunk, offset);
+    offset += chunk.length;
+  }
+  return result;
+}
+
+export async function executeHttpCall(
+  opts: HttpCallOptions
+): Promise<Uint8Array> {
+  opts.logger.debug('HTTP request', {
+    method: opts.request.method,
+    url: opts.request.url,
+  });
+
+  let resp: HttpResponse;
+  try {
+    resp = await opts.httpClient.send(opts.request);
+  } catch (e: unknown) {
+    opts.logger.debug('HTTP request failed');
+    throw e;
+  }
+
+  const body = await readAll(resp.body);
+
+  opts.logger.debug('HTTP response', {
+    statusCode: resp.statusCode,
+    body: new TextDecoder().decode(body),
+  });
+
+  const apiErr = ApiError.fromHttpError(resp.statusCode, resp.headers, body);
+  if (apiErr !== undefined) {
+    throw apiErr;
+  }
+
+  return body;
+}
+
+export function buildHttpRequest(
+  method: string,
+  url: string,
+  headers: Headers,
+  signal?: AbortSignal,
+  body?: string | ReadableStream<Uint8Array>
+): HttpRequest {
+  const req: HttpRequest = {url, method, headers};
+  if (body !== undefined) {
+    req.body = body;
+  }
+  if (signal !== undefined) {
+    req.signal = signal;
+  }
+  return req;
+}
+
+export function parseResponse<T>(body: Uint8Array, schema: z.ZodType<T>): T {
+  const text = new TextDecoder().decode(body);
+  const parsed: unknown = jsonBigint.parse(text);
+  return schema.parse(parsed);
+}
+
+export function marshalRequest(data: unknown, schema: z.ZodType): string {
+  return jsonBigint.stringify(schema.parse(data));
+}
+
+export function flattenQueryParams(
+  prefix: string,
+  value: unknown,
+  params: URLSearchParams
+): void {
+  if (value === null || value === undefined) {
+    return;
+  }
+  if (Array.isArray(value)) {
+    // arrays of objects are not yet supported
+    for (const item of value) {
+      params.append(prefix, String(item));
+    }
+  } else if (typeof value === 'object') {
+    for (const [key, val] of Object.entries(value as Record<string, unknown>)) {
+      flattenQueryParams(`${prefix}.${key}`, val, params);
+    }
+  } else if (
+    typeof value === 'string' ||
+    typeof value === 'number' ||
+    typeof value === 'boolean' ||
+    typeof value === 'bigint'
+  ) {
+    params.append(prefix, String(value));
+  } else {
+    throw new Error(`Unsupported query parameter type: ${typeof value}`);
+  }
+}

package/README.md

@@ -1 +0,0 @@
-This is a placeholder release used to enable OIDC trusted publishing. Real code lands in a later version.

package/index.js

@@ -1 +0,0 @@
-module.exports = {};