@databricks/sdk-uc-rfa 0.1.0-dev.3 → 0.1.0-dev.5

package/src/v1/model.ts

@@ -1,384 +0,0 @@
-// Code generated from API definition by Databricks SDK Generator. DO NOT EDIT.
-
-import {FieldMask} from '@databricks/sdk-core/wkt';
-import type {FieldMaskSchema} from '@databricks/sdk-core/wkt';
-import {z} from 'zod';
-
-export enum DestinationType {
-  DESTINATION_TYPE_UNSPECIFIED = 'DESTINATION_TYPE_UNSPECIFIED',
-  EMAIL = 'EMAIL',
-  SLACK = 'SLACK',
-  GENERIC_WEBHOOK = 'GENERIC_WEBHOOK',
-  MICROSOFT_TEAMS = 'MICROSOFT_TEAMS',
-  URL = 'URL',
-}
-
-export enum PrincipalType {
-  PRINCIPAL_TYPE_UNSPECIFIED = 'PRINCIPAL_TYPE_UNSPECIFIED',
-  USER_PRINCIPAL = 'USER_PRINCIPAL',
-  GROUP_PRINCIPAL = 'GROUP_PRINCIPAL',
-  SERVICE_PRINCIPAL = 'SERVICE_PRINCIPAL',
-}
-
-/** The type of Unity Catalog securable. */
-export enum SecurableType {
-  CATALOG = 'CATALOG',
-  SCHEMA = 'SCHEMA',
-  TABLE = 'TABLE',
-  STORAGE_CREDENTIAL = 'STORAGE_CREDENTIAL',
-  EXTERNAL_LOCATION = 'EXTERNAL_LOCATION',
-  FUNCTION = 'FUNCTION',
-  SHARE = 'SHARE',
-  PROVIDER = 'PROVIDER',
-  RECIPIENT = 'RECIPIENT',
-  CLEAN_ROOM = 'CLEAN_ROOM',
-  METASTORE = 'METASTORE',
-  PIPELINE = 'PIPELINE',
-  VOLUME = 'VOLUME',
-  CONNECTION = 'CONNECTION',
-  CREDENTIAL = 'CREDENTIAL',
-  EXTERNAL_METADATA = 'EXTERNAL_METADATA',
-  /** TODO: [UC-2980] Staging tables aren't full-fleged securables yet. */
-  STAGING_TABLE = 'STAGING_TABLE',
-}
-
-export enum SpecialDestination {
-  SPECIAL_DESTINATION_UNSPECIFIED = 'SPECIAL_DESTINATION_UNSPECIFIED',
-  SPECIAL_DESTINATION_CATALOG_OWNER = 'SPECIAL_DESTINATION_CATALOG_OWNER',
-  SPECIAL_DESTINATION_EXTERNAL_LOCATION_OWNER = 'SPECIAL_DESTINATION_EXTERNAL_LOCATION_OWNER',
-  SPECIAL_DESTINATION_CONNECTION_OWNER = 'SPECIAL_DESTINATION_CONNECTION_OWNER',
-  SPECIAL_DESTINATION_CREDENTIAL_OWNER = 'SPECIAL_DESTINATION_CREDENTIAL_OWNER',
-  SPECIAL_DESTINATION_METASTORE_OWNER = 'SPECIAL_DESTINATION_METASTORE_OWNER',
-}
-
-export interface AccessRequestDestinations {
-  /** The access request destinations for the securable. */
-  destinations?: NotificationDestination[] | undefined;
-  /** The securable for which the access request destinations are being modified or read. */
-  securable?: Securable | undefined;
-  /**
-   * Indicates whether any destinations are hidden from the caller due to a lack of permissions.
-   * This value is true if the caller does not have permission to see all destinations.
-   */
-  areAnyDestinationsHidden?: boolean | undefined;
-  /**
-   * The source securable from which the destinations are inherited. Either the same value as securable (if destination
-   * is set directly on the securable) or the nearest parent securable with destinations set.
-   */
-  destinationSourceSecurable?: Securable | undefined;
-  /** The type of the securable. Redundant with the type in the securable object, but necessary for Terraform integration */
-  securableType?: string | undefined;
-  /** The full name of the securable. Redundant with the name in the securable object, but necessary for Terraform integration */
-  fullName?: string | undefined;
-}
-
-export interface BatchCreateAccessRequestsRequest {
-  /**
-   * A list of individual access requests, where each request corresponds to
-   * a set of permissions being requested on a list of securables for a specified principal.
-   *
-   * At most 30 requests per API call.
-   */
-  requests?: CreateAccessRequest[] | undefined;
-}
-
-export interface BatchCreateAccessRequestsResponse {
-  /** The access request destinations for each securable object the principal requested. */
-  responses?: CreateAccessRequestResponse[] | undefined;
-}
-
-export interface CreateAccessRequest {
-  /**
-   * Optional. The principal this request is for.
-   * Empty `behalf_of` defaults to the requester's identity.
-   *
-   * Principals must be unique across the API call.
-   */
-  behalfOf?: Principal | undefined;
-  /**
-   * Optional. Comment associated with the request.
-   *
-   * At most 200 characters, can only contain lowercase/uppercase
-   * letters (a-z, A-Z), numbers (0-9), punctuation, and spaces.
-   */
-  comment?: string | undefined;
-  /**
-   * List of securables and their corresponding requested UC privileges.
-   *
-   * At most 30 securables can be requested for a principal per batched call.
-   * Each securable can only be requested once per principal.
-   */
-  securablePermissions?: SecurablePermissions[] | undefined;
-}
-
-export interface CreateAccessRequestResponse {
-  /** The principal the request was made on behalf of. */
-  behalfOf?: Principal | undefined;
-  /** The access request destinations for all the securables the principal requested. */
-  requestDestinations?: AccessRequestDestinations[] | undefined;
-}
-
-export interface GetAccessRequestDestinationsRequest {
-  /** The type of the securable. */
-  securableType?: string | undefined;
-  /** The full name of the securable. */
-  fullName?: string | undefined;
-}
-
-export interface NotificationDestination {
-  /**
-   * The identifier for the destination. This is the email address for EMAIL destinations, the URL for URL destinations,
-   * or the unique <Databricks> notification destination ID for all other external destinations.
-   */
-  destinationId?: string | undefined;
-  /** The type of the destination. */
-  destinationType?: DestinationType | undefined;
-  /**
-   * This field is used to denote whether the destination is the email of the owner of the securable object.
-   * The special destination cannot be assigned to a securable and only represents the default destination of the securable.
-   * The securable types that support default special destinations are: "catalog", "external_location", "connection", "credential", and "metastore".
-   * The **destination_type** of a **special_destination** is always EMAIL.
-   */
-  specialDestination?: SpecialDestination | undefined;
-}
-
-export interface Principal {
-  /** <Databricks> user, group or service principal ID. */
-  id?: string | undefined;
-  principalType?: PrincipalType | undefined;
-}
-
-/**
- * Generic definition of a securable, which is uniquely defined in a metastore
- * by its type and full name.
- */
-export interface Securable {
-  /**
-   * Required. The type of securable (catalog/schema/table).
-   * Optional if resource_name is present.
-   */
-  type?: SecurableType | undefined;
-  /**
-   * Required. The full name of the catalog/schema/table.
-   * Optional if resource_name is present.
-   */
-  fullName?: string | undefined;
-  /**
-   * Optional. The name of the Share object that contains the securable when the securable is
-   * getting shared in D2D Delta Sharing.
-   */
-  providerShare?: string | undefined;
-}
-
-export interface SecurablePermissions {
-  /** The securable for which the access request destinations are being requested. */
-  securable?: Securable | undefined;
-  /** List of requested Unity Catalog permissions. */
-  permissions?: string[] | undefined;
-}
-
-export interface UpdateAccessRequestDestinationsRequest {
-  /**
-   * The access request destinations to assign to the securable.
-   * For each destination, a **destination_id** and **destination_type** must be defined.
-   */
-  accessRequestDestinations?: AccessRequestDestinations | undefined;
-  updateMask?: FieldMask<AccessRequestDestinations> | undefined;
-}
-
-export const unmarshalAccessRequestDestinationsSchema: z.ZodType<AccessRequestDestinations> =
-  z
-    .object({
-      destinations: z
-        .array(z.lazy(() => unmarshalNotificationDestinationSchema))
-        .optional(),
-      securable: z.lazy(() => unmarshalSecurableSchema).optional(),
-      are_any_destinations_hidden: z.boolean().optional(),
-      destination_source_securable: z
-        .lazy(() => unmarshalSecurableSchema)
-        .optional(),
-      securable_type: z.string().optional(),
-      full_name: z.string().optional(),
-    })
-    .transform(d => ({
-      destinations: d.destinations,
-      securable: d.securable,
-      areAnyDestinationsHidden: d.are_any_destinations_hidden,
-      destinationSourceSecurable: d.destination_source_securable,
-      securableType: d.securable_type,
-      fullName: d.full_name,
-    }));
-
-export const unmarshalBatchCreateAccessRequestsResponseSchema: z.ZodType<BatchCreateAccessRequestsResponse> =
-  z
-    .object({
-      responses: z
-        .array(z.lazy(() => unmarshalCreateAccessRequestResponseSchema))
-        .optional(),
-    })
-    .transform(d => ({
-      responses: d.responses,
-    }));
-
-export const unmarshalCreateAccessRequestResponseSchema: z.ZodType<CreateAccessRequestResponse> =
-  z
-    .object({
-      behalf_of: z.lazy(() => unmarshalPrincipalSchema).optional(),
-      request_destinations: z
-        .array(z.lazy(() => unmarshalAccessRequestDestinationsSchema))
-        .optional(),
-    })
-    .transform(d => ({
-      behalfOf: d.behalf_of,
-      requestDestinations: d.request_destinations,
-    }));
-
-export const unmarshalNotificationDestinationSchema: z.ZodType<NotificationDestination> =
-  z
-    .object({
-      destination_id: z.string().optional(),
-      destination_type: z.enum(DestinationType).optional(),
-      special_destination: z.enum(SpecialDestination).optional(),
-    })
-    .transform(d => ({
-      destinationId: d.destination_id,
-      destinationType: d.destination_type,
-      specialDestination: d.special_destination,
-    }));
-
-export const unmarshalPrincipalSchema: z.ZodType<Principal> = z
-  .object({
-    id: z.string().optional(),
-    principal_type: z.enum(PrincipalType).optional(),
-  })
-  .transform(d => ({
-    id: d.id,
-    principalType: d.principal_type,
-  }));
-
-export const unmarshalSecurableSchema: z.ZodType<Securable> = z
-  .object({
-    type: z.enum(SecurableType).optional(),
-    full_name: z.string().optional(),
-    provider_share: z.string().optional(),
-  })
-  .transform(d => ({
-    type: d.type,
-    fullName: d.full_name,
-    providerShare: d.provider_share,
-  }));
-
-export const marshalAccessRequestDestinationsSchema: z.ZodType = z
-  .object({
-    destinations: z
-      .array(z.lazy(() => marshalNotificationDestinationSchema))
-      .optional(),
-    securable: z.lazy(() => marshalSecurableSchema).optional(),
-    areAnyDestinationsHidden: z.boolean().optional(),
-    destinationSourceSecurable: z.lazy(() => marshalSecurableSchema).optional(),
-    securableType: z.string().optional(),
-    fullName: z.string().optional(),
-  })
-  .transform(d => ({
-    destinations: d.destinations,
-    securable: d.securable,
-    are_any_destinations_hidden: d.areAnyDestinationsHidden,
-    destination_source_securable: d.destinationSourceSecurable,
-    securable_type: d.securableType,
-    full_name: d.fullName,
-  }));
-
-export const marshalBatchCreateAccessRequestsRequestSchema: z.ZodType = z
-  .object({
-    requests: z
-      .array(z.lazy(() => marshalCreateAccessRequestSchema))
-      .optional(),
-  })
-  .transform(d => ({
-    requests: d.requests,
-  }));
-
-export const marshalCreateAccessRequestSchema: z.ZodType = z
-  .object({
-    behalfOf: z.lazy(() => marshalPrincipalSchema).optional(),
-    comment: z.string().optional(),
-    securablePermissions: z
-      .array(z.lazy(() => marshalSecurablePermissionsSchema))
-      .optional(),
-  })
-  .transform(d => ({
-    behalf_of: d.behalfOf,
-    comment: d.comment,
-    securable_permissions: d.securablePermissions,
-  }));
-
-export const marshalNotificationDestinationSchema: z.ZodType = z
-  .object({
-    destinationId: z.string().optional(),
-    destinationType: z.enum(DestinationType).optional(),
-    specialDestination: z.enum(SpecialDestination).optional(),
-  })
-  .transform(d => ({
-    destination_id: d.destinationId,
-    destination_type: d.destinationType,
-    special_destination: d.specialDestination,
-  }));
-
-export const marshalPrincipalSchema: z.ZodType = z
-  .object({
-    id: z.string().optional(),
-    principalType: z.enum(PrincipalType).optional(),
-  })
-  .transform(d => ({
-    id: d.id,
-    principal_type: d.principalType,
-  }));
-
-export const marshalSecurableSchema: z.ZodType = z
-  .object({
-    type: z.enum(SecurableType).optional(),
-    fullName: z.string().optional(),
-    providerShare: z.string().optional(),
-  })
-  .transform(d => ({
-    type: d.type,
-    full_name: d.fullName,
-    provider_share: d.providerShare,
-  }));
-
-export const marshalSecurablePermissionsSchema: z.ZodType = z
-  .object({
-    securable: z.lazy(() => marshalSecurableSchema).optional(),
-    permissions: z.array(z.string()).optional(),
-  })
-  .transform(d => ({
-    securable: d.securable,
-    permissions: d.permissions,
-  }));
-
-const accessRequestDestinationsFieldMaskSchema: FieldMaskSchema = {
-  areAnyDestinationsHidden: {wire: 'are_any_destinations_hidden'},
-  destinationSourceSecurable: {
-    wire: 'destination_source_securable',
-    children: () => securableFieldMaskSchema,
-  },
-  destinations: {wire: 'destinations'},
-  fullName: {wire: 'full_name'},
-  securable: {wire: 'securable', children: () => securableFieldMaskSchema},
-  securableType: {wire: 'securable_type'},
-};
-
-export function accessRequestDestinationsFieldMask(
-  ...paths: string[]
-): FieldMask<AccessRequestDestinations> {
-  return FieldMask.build<AccessRequestDestinations>(
-    paths,
-    accessRequestDestinationsFieldMaskSchema
-  );
-}
-
-const securableFieldMaskSchema: FieldMaskSchema = {
-  fullName: {wire: 'full_name'},
-  providerShare: {wire: 'provider_share'},
-  type: {wire: 'type'},
-};

package/src/v1/transport.ts

@@ -1,73 +0,0 @@
-// 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

@@ -1,156 +0,0 @@
-// 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}`);
-  }
-}