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

package/src/v1/model.ts

@@ -0,0 +1,236 @@
+// 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';
+
+/**
+ * State of inferred scope collection (autoscope) for an external PAT.
+ * Mirrored in databricks.identity.AutoscopeState in common/principal-context/api/proto/tokendetails.proto.
+ * Token store and token management proto can depend on this.
+ * Principal context proto should NOT depend on this proto definitions because too many services depend on the principal context proto.
+ */
+export enum AutoscopeState {
+  AUTOSCOPE_STATE_UNSPECIFIED = 'AUTOSCOPE_STATE_UNSPECIFIED',
+  AUTOSCOPE_STATE_DISABLED = 'AUTOSCOPE_STATE_DISABLED',
+  AUTOSCOPE_STATE_RUNNING = 'AUTOSCOPE_STATE_RUNNING',
+  AUTOSCOPE_STATE_COMPLETED = 'AUTOSCOPE_STATE_COMPLETED',
+  AUTOSCOPE_STATE_BACKFILLED = 'AUTOSCOPE_STATE_BACKFILLED',
+  AUTOSCOPE_STATE_USER_SELECTED = 'AUTOSCOPE_STATE_USER_SELECTED',
+  AUTOSCOPE_STATE_API_NOT_COVERED = 'AUTOSCOPE_STATE_API_NOT_COVERED',
+}
+
+export interface CreateTokenRequest {
+  /**
+   * The lifetime of the token, in seconds.
+   *
+   * If the lifetime is not specified, this token remains valid for 2 years.
+   */
+  lifetimeSeconds?: bigint | undefined;
+  /** Optional description to attach to the token. */
+  comment?: string | undefined;
+  /** Optional scopes of the token. */
+  scopes?: string[] | undefined;
+  /**
+   * Whether to enable autoscoping for this token. When true, the token will
+   * automatically collect inferred API path scopes as it is used.
+   */
+  autoscopeEnabled?: boolean | undefined;
+}
+
+// eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
+export interface CreateTokenRequest_Response {
+  /** The value of the new token. */
+  tokenValue?: string | undefined;
+  /** The information for the new token. */
+  tokenInfo?: PublicTokenInfo | undefined;
+}
+
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
+export interface ListTokensRequest {}
+
+// eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
+export interface ListTokensRequest_Response {
+  /** The information for each token. */
+  tokenInfos?: PublicTokenInfo[] | undefined;
+}
+
+export interface PublicTokenInfo {
+  /** The ID of this token. */
+  tokenId?: string | undefined;
+  /** Server time (in epoch milliseconds) when the token was created. */
+  creationTime?: bigint | undefined;
+  /** Server time (in epoch milliseconds) when the token will expire, or -1 if not applicable. */
+  expiryTime?: bigint | undefined;
+  /** Comment the token was created with, if applicable. */
+  comment?: string | undefined;
+  /** Scope of the token was created with, if applicable. */
+  scopes?: string[] | undefined;
+  /** Output only. The autoscope state of this token. */
+  autoscopeState?: AutoscopeState | undefined;
+  /** Output only. Inferred API path scopes collected for this token when autoscope is enabled. */
+  inferredScopes?: string[] | undefined;
+  /** Output only. Scopes inferred from offline backfill processing. */
+  backfillScopes?: string[] | undefined;
+}
+
+export interface RevokeTokenRequest {
+  /** The ID of the token to be revoked. */
+  tokenId?: string | undefined;
+}
+
+// eslint-disable-next-line @typescript-eslint/naming-convention, @typescript-eslint/no-empty-object-type -- Proto-style nested message name.
+export interface RevokeTokenRequest_Response {}
+
+/**
+ * For the list of supported token scopes, see
+ * https://docs.databricks.com/api/workspace/api/scopes.
+ */
+export interface UpdateTokenRequest {
+  /** The SHA-256 hash of the token to be updated. */
+  tokenId?: string | undefined;
+  token?: PublicTokenInfo | undefined;
+  /** A list of field name under token, For example, {"update_mask": "comment,scopes"} */
+  updateMask?: FieldMask<PublicTokenInfo> | undefined;
+}
+
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
+export interface UpdateTokenResponse {}
+
+// eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
+export const unmarshalCreateTokenRequest_ResponseSchema: z.ZodType<CreateTokenRequest_Response> =
+  z
+    .object({
+      token_value: z.string().optional(),
+      token_info: z.lazy(() => unmarshalPublicTokenInfoSchema).optional(),
+    })
+    .transform(d => ({
+      tokenValue: d.token_value,
+      tokenInfo: d.token_info,
+    }));
+
+// eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
+export const unmarshalListTokensRequest_ResponseSchema: z.ZodType<ListTokensRequest_Response> =
+  z
+    .object({
+      token_infos: z
+        .array(z.lazy(() => unmarshalPublicTokenInfoSchema))
+        .optional(),
+    })
+    .transform(d => ({
+      tokenInfos: d.token_infos,
+    }));
+
+export const unmarshalPublicTokenInfoSchema: z.ZodType<PublicTokenInfo> = z
+  .object({
+    token_id: z.string().optional(),
+    creation_time: z
+      .union([z.number(), z.bigint()])
+      .transform(v => BigInt(v))
+      .optional(),
+    expiry_time: z
+      .union([z.number(), z.bigint()])
+      .transform(v => BigInt(v))
+      .optional(),
+    comment: z.string().optional(),
+    scopes: z.array(z.string()).optional(),
+    autoscope_state: z.enum(AutoscopeState).optional(),
+    inferred_scopes: z.array(z.string()).optional(),
+    backfill_scopes: z.array(z.string()).optional(),
+  })
+  .transform(d => ({
+    tokenId: d.token_id,
+    creationTime: d.creation_time,
+    expiryTime: d.expiry_time,
+    comment: d.comment,
+    scopes: d.scopes,
+    autoscopeState: d.autoscope_state,
+    inferredScopes: d.inferred_scopes,
+    backfillScopes: d.backfill_scopes,
+  }));
+
+// eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
+export const unmarshalRevokeTokenRequest_ResponseSchema: z.ZodType<RevokeTokenRequest_Response> =
+  z.object({});
+
+export const unmarshalUpdateTokenResponseSchema: z.ZodType<UpdateTokenResponse> =
+  z.object({});
+
+export const marshalCreateTokenRequestSchema: z.ZodType = z
+  .object({
+    lifetimeSeconds: z.bigint().optional(),
+    comment: z.string().optional(),
+    scopes: z.array(z.string()).optional(),
+    autoscopeEnabled: z.boolean().optional(),
+  })
+  .transform(d => ({
+    lifetime_seconds: d.lifetimeSeconds,
+    comment: d.comment,
+    scopes: d.scopes,
+    autoscope_enabled: d.autoscopeEnabled,
+  }));
+
+export const marshalPublicTokenInfoSchema: z.ZodType = z
+  .object({
+    tokenId: z.string().optional(),
+    creationTime: z.bigint().optional(),
+    expiryTime: z.bigint().optional(),
+    comment: z.string().optional(),
+    scopes: z.array(z.string()).optional(),
+    autoscopeState: z.enum(AutoscopeState).optional(),
+    inferredScopes: z.array(z.string()).optional(),
+    backfillScopes: z.array(z.string()).optional(),
+  })
+  .transform(d => ({
+    token_id: d.tokenId,
+    creation_time: d.creationTime,
+    expiry_time: d.expiryTime,
+    comment: d.comment,
+    scopes: d.scopes,
+    autoscope_state: d.autoscopeState,
+    inferred_scopes: d.inferredScopes,
+    backfill_scopes: d.backfillScopes,
+  }));
+
+export const marshalRevokeTokenRequestSchema: z.ZodType = z
+  .object({
+    tokenId: z.string().optional(),
+  })
+  .transform(d => ({
+    token_id: d.tokenId,
+  }));
+
+export const marshalUpdateTokenRequestSchema: z.ZodType = z
+  .object({
+    tokenId: z.string().optional(),
+    token: z.lazy(() => marshalPublicTokenInfoSchema).optional(),
+    updateMask: z
+      .any()
+      .transform((m: FieldMask) => m.toString())
+      .optional(),
+  })
+  .transform(d => ({
+    token_id: d.tokenId,
+    token: d.token,
+    update_mask: d.updateMask,
+  }));
+
+const publicTokenInfoFieldMaskSchema: FieldMaskSchema = {
+  autoscopeState: {wire: 'autoscope_state'},
+  backfillScopes: {wire: 'backfill_scopes'},
+  comment: {wire: 'comment'},
+  creationTime: {wire: 'creation_time'},
+  expiryTime: {wire: 'expiry_time'},
+  inferredScopes: {wire: 'inferred_scopes'},
+  scopes: {wire: 'scopes'},
+  tokenId: {wire: 'token_id'},
+};
+
+export function publicTokenInfoFieldMask(
+  ...paths: string[]
+): FieldMask<PublicTokenInfo> {
+  return FieldMask.build<PublicTokenInfo>(
+    paths,
+    publicTokenInfoFieldMaskSchema
+  );
+}

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 {Call, Options} from '@databricks/sdk-core/api';
+import {execute} from '@databricks/sdk-core/api';
+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: Call,
+  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 = {};