@databricks/sdk-repos 0.0.0-dev → 0.1.0-dev.2

package/src/v1/index.ts

@@ -0,0 +1,19 @@
+// Code generated from API definition by Databricks SDK Generator. DO NOT EDIT.
+
+export {ReposClient} from './client';
+
+export type {
+  CreateRepoRequest,
+  CreateRepoRequest_Response,
+  DeleteProjectRequest,
+  DeleteProjectRequest_Response,
+  GetRepoRequest,
+  GetRepoRequest_Response,
+  ListReposRequest,
+  ListReposRequest_Response,
+  RepoInfo,
+  SparseCheckout,
+  SparseCheckoutUpdate,
+  UpdateRepoRequest,
+  UpdateRepoRequest_Response,
+} from './model';

package/src/v1/model.ts

@@ -0,0 +1,316 @@
+// Code generated from API definition by Databricks SDK Generator. DO NOT EDIT.
+
+import {z} from 'zod';
+
+export interface CreateRepoRequest {
+  /** URL of the Git repository to be linked. */
+  url?: string | undefined;
+  /**
+   * Git provider. This field is case-insensitive. The available Git providers are `gitHub`,
+   * `bitbucketCloud`, `gitLab`, `azureDevOpsServices` (Azure DevOps Services, including
+   * Microsoft Entra ID authentication), `gitHubEnterprise`, `bitbucketServer` (Bitbucket
+   * Data Center), `gitLabEnterpriseEdition` (GitLab Self-Managed), and `awsCodeCommit`
+   * (deprecated by AWS, not accepting new customers).
+   */
+  provider?: string | undefined;
+  /**
+   * Desired path for the repo in the workspace. Almost any path in the workspace can be chosen.
+   * If repo is created in `/Repos`, path must be in the format `/Repos/{folder}/{repo-name}`.
+   */
+  path?: string | undefined;
+  /**
+   * If specified, the repo will be created with sparse checkout enabled. You cannot enable/disable
+   * sparse checkout after the repo is created.
+   */
+  sparseCheckout?: SparseCheckout | undefined;
+}
+
+// eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
+export interface CreateRepoRequest_Response {
+  /** ID of the Git folder (repo) object in the workspace. */
+  id?: bigint | undefined;
+  /** Path of the Git folder (repo) in the workspace. */
+  path?: string | undefined;
+  /** URL of the linked Git repository. */
+  url?: string | undefined;
+  /**
+   * Git provider of the linked Git repository, e.g. `gitHub`, `azureDevOpsServices`,
+   * `bitbucketServer` (Bitbucket Data Center), `gitLabEnterpriseEdition` (GitLab
+   * Self-Managed), or `awsCodeCommit` (deprecated).
+   */
+  provider?: string | undefined;
+  /** Branch that the Git folder (repo) is checked out to. */
+  branch?: string | undefined;
+  /** SHA-1 hash representing the commit ID of the current HEAD of the Git folder (repo). */
+  headCommitId?: string | undefined;
+  /** Sparse checkout settings for the Git folder (repo). */
+  sparseCheckout?: SparseCheckout | undefined;
+}
+
+export interface DeleteProjectRequest {
+  /** The ID for the corresponding repo to delete. */
+  id?: bigint | undefined;
+}
+
+// eslint-disable-next-line @typescript-eslint/naming-convention, @typescript-eslint/no-empty-object-type -- Proto-style nested message name.
+export interface DeleteProjectRequest_Response {}
+
+export interface GetRepoRequest {
+  /** ID of the Git folder (repo) object in the workspace. */
+  id?: bigint | undefined;
+}
+
+// eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
+export interface GetRepoRequest_Response {
+  /** ID of the Git folder (repo) object in the workspace. */
+  id?: bigint | undefined;
+  /** Path of the Git folder (repo) in the workspace. */
+  path?: string | undefined;
+  /** URL of the linked Git repository. */
+  url?: string | undefined;
+  /**
+   * Git provider of the linked Git repository, e.g. `gitHub`, `azureDevOpsServices`,
+   * `bitbucketServer` (Bitbucket Data Center), `gitLabEnterpriseEdition` (GitLab
+   * Self-Managed), or `awsCodeCommit` (deprecated).
+   */
+  provider?: string | undefined;
+  /** Branch that the local version of the repo is checked out to. */
+  branch?: string | undefined;
+  /** SHA-1 hash representing the commit ID of the current HEAD of the repo. */
+  headCommitId?: string | undefined;
+  /** Sparse checkout settings for the Git folder (repo). */
+  sparseCheckout?: SparseCheckout | undefined;
+}
+
+export interface ListReposRequest {
+  /**
+   * Filters repos that have paths starting with the given path prefix.
+   * If not provided or when provided an effectively empty prefix (`/` or `/Workspace`)
+   * Git folders (repos) from `/Workspace/Repos` will be served.
+   */
+  pathPrefix?: string | undefined;
+  /**
+   * Token used to get the next page of results. If not specified, returns the first page of
+   * results as well as a next page token if there are more results.
+   */
+  nextPageToken?: string | undefined;
+}
+
+// eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
+export interface ListReposRequest_Response {
+  /** List of Git folders (repos). */
+  repos?: RepoInfo[] | undefined;
+  /**
+   * Token that can be specified as a query parameter to the `GET /repos` endpoint to retrieve
+   * the next page of results.
+   */
+  nextPageToken?: string | undefined;
+}
+
+/** Git folder (repo) information. */
+export interface RepoInfo {
+  /** Id of the git folder (repo) in the Workspace. */
+  id?: bigint | undefined;
+  /** Root path of the git folder (repo) in the Workspace. */
+  path?: string | undefined;
+  /** URL of the remote git repository. */
+  url?: string | undefined;
+  /**
+   * Git provider of the remote git repository, e.g. `gitHub`, `azureDevOpsServices`,
+   * `bitbucketServer` (Bitbucket Data Center), `gitLabEnterpriseEdition` (GitLab
+   * Self-Managed), or `awsCodeCommit` (deprecated).
+   */
+  provider?: string | undefined;
+  /** Name of the current git branch of the git folder (repo). */
+  branch?: string | undefined;
+  /** Current git commit id of the git folder (repo). */
+  headCommitId?: string | undefined;
+  /** Sparse checkout config for the git folder (repo). */
+  sparseCheckout?: SparseCheckout | undefined;
+}
+
+/** Sparse checkout configuration, it contains options like cone patterns. */
+export interface SparseCheckout {
+  /**
+   * List of sparse checkout cone patterns, see
+   * [cone mode handling](https://git-scm.com/docs/git-sparse-checkout#_internalscone_mode_handling)
+   * for details.
+   */
+  patterns?: string[] | undefined;
+}
+
+/** Sparse checkout configuration, it contains options like cone patterns. */
+export interface SparseCheckoutUpdate {
+  /**
+   * List of sparse checkout cone patterns, see
+   * [cone mode handling](https://git-scm.com/docs/git-sparse-checkout#_internalscone_mode_handling)
+   * for details.
+   */
+  patterns?: string[] | undefined;
+}
+
+export interface UpdateRepoRequest {
+  /** ID of the Git folder (repo) object in the workspace. */
+  id?: bigint | undefined;
+  /** Branch that the local version of the repo is checked out to. */
+  branch?: string | undefined;
+  /**
+   * Tag that the local version of the repo is checked out to. Updating the repo to a tag puts
+   * the repo in a detached HEAD state. Before committing new changes, you must update the repo to
+   * a branch instead of the detached HEAD.
+   */
+  tag?: string | undefined;
+  /**
+   * If specified, update the sparse checkout settings. The update will fail if sparse checkout is
+   * not enabled for the repo.
+   */
+  sparseCheckout?: SparseCheckoutUpdate | undefined;
+}
+
+// eslint-disable-next-line @typescript-eslint/naming-convention, @typescript-eslint/no-empty-object-type -- Proto-style nested message name.
+export interface UpdateRepoRequest_Response {}
+
+// eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
+export const unmarshalCreateRepoRequest_ResponseSchema: z.ZodType<CreateRepoRequest_Response> =
+  z
+    .object({
+      id: z
+        .union([z.number(), z.bigint()])
+        .transform(v => BigInt(v))
+        .optional(),
+      path: z.string().optional(),
+      url: z.string().optional(),
+      provider: z.string().optional(),
+      branch: z.string().optional(),
+      head_commit_id: z.string().optional(),
+      sparse_checkout: z.lazy(() => unmarshalSparseCheckoutSchema).optional(),
+    })
+    .transform(d => ({
+      id: d.id,
+      path: d.path,
+      url: d.url,
+      provider: d.provider,
+      branch: d.branch,
+      headCommitId: d.head_commit_id,
+      sparseCheckout: d.sparse_checkout,
+    }));
+
+// eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
+export const unmarshalDeleteProjectRequest_ResponseSchema: z.ZodType<DeleteProjectRequest_Response> =
+  z.object({});
+
+// eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
+export const unmarshalGetRepoRequest_ResponseSchema: z.ZodType<GetRepoRequest_Response> =
+  z
+    .object({
+      id: z
+        .union([z.number(), z.bigint()])
+        .transform(v => BigInt(v))
+        .optional(),
+      path: z.string().optional(),
+      url: z.string().optional(),
+      provider: z.string().optional(),
+      branch: z.string().optional(),
+      head_commit_id: z.string().optional(),
+      sparse_checkout: z.lazy(() => unmarshalSparseCheckoutSchema).optional(),
+    })
+    .transform(d => ({
+      id: d.id,
+      path: d.path,
+      url: d.url,
+      provider: d.provider,
+      branch: d.branch,
+      headCommitId: d.head_commit_id,
+      sparseCheckout: d.sparse_checkout,
+    }));
+
+// eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
+export const unmarshalListReposRequest_ResponseSchema: z.ZodType<ListReposRequest_Response> =
+  z
+    .object({
+      repos: z.array(z.lazy(() => unmarshalRepoInfoSchema)).optional(),
+      next_page_token: z.string().optional(),
+    })
+    .transform(d => ({
+      repos: d.repos,
+      nextPageToken: d.next_page_token,
+    }));
+
+export const unmarshalRepoInfoSchema: z.ZodType<RepoInfo> = z
+  .object({
+    id: z
+      .union([z.number(), z.bigint()])
+      .transform(v => BigInt(v))
+      .optional(),
+    path: z.string().optional(),
+    url: z.string().optional(),
+    provider: z.string().optional(),
+    branch: z.string().optional(),
+    head_commit_id: z.string().optional(),
+    sparse_checkout: z.lazy(() => unmarshalSparseCheckoutSchema).optional(),
+  })
+  .transform(d => ({
+    id: d.id,
+    path: d.path,
+    url: d.url,
+    provider: d.provider,
+    branch: d.branch,
+    headCommitId: d.head_commit_id,
+    sparseCheckout: d.sparse_checkout,
+  }));
+
+export const unmarshalSparseCheckoutSchema: z.ZodType<SparseCheckout> = z
+  .object({
+    patterns: z.array(z.string()).optional(),
+  })
+  .transform(d => ({
+    patterns: d.patterns,
+  }));
+
+// eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
+export const unmarshalUpdateRepoRequest_ResponseSchema: z.ZodType<UpdateRepoRequest_Response> =
+  z.object({});
+
+export const marshalCreateRepoRequestSchema: z.ZodType = z
+  .object({
+    url: z.string().optional(),
+    provider: z.string().optional(),
+    path: z.string().optional(),
+    sparseCheckout: z.lazy(() => marshalSparseCheckoutSchema).optional(),
+  })
+  .transform(d => ({
+    url: d.url,
+    provider: d.provider,
+    path: d.path,
+    sparse_checkout: d.sparseCheckout,
+  }));
+
+export const marshalSparseCheckoutSchema: z.ZodType = z
+  .object({
+    patterns: z.array(z.string()).optional(),
+  })
+  .transform(d => ({
+    patterns: d.patterns,
+  }));
+
+export const marshalSparseCheckoutUpdateSchema: z.ZodType = z
+  .object({
+    patterns: z.array(z.string()).optional(),
+  })
+  .transform(d => ({
+    patterns: d.patterns,
+  }));
+
+export const marshalUpdateRepoRequestSchema: z.ZodType = z
+  .object({
+    id: z.bigint().optional(),
+    branch: z.string().optional(),
+    tag: z.string().optional(),
+    sparseCheckout: z.lazy(() => marshalSparseCheckoutUpdateSchema).optional(),
+  })
+  .transform(d => ({
+    id: d.id,
+    branch: d.branch,
+    tag: d.tag,
+    sparse_checkout: d.sparseCheckout,
+  }));

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 = {};