@databricks/sdk-repos 0.1.0-dev.3 → 0.1.0-dev.5

package/src/v1/client.ts

@@ -1,253 +0,0 @@
-// Code generated from API definition by Databricks SDK Generator. DO NOT EDIT.
-
-import {VERSION as AUTH_VERSION} from '@databricks/sdk-auth';
-import {createDefault} from '@databricks/sdk-core/clientinfo';
-import type {Logger} from '@databricks/sdk-core/logger';
-import {NoOpLogger} from '@databricks/sdk-core/logger';
-import type {CallOptions} from '@databricks/sdk-options/call';
-import type {ClientOptions} from '@databricks/sdk-options/client';
-import type {HttpClient} from '@databricks/sdk-core/http';
-import {newHttpClient} from './transport';
-import {
-  buildHttpRequest,
-  executeCall,
-  executeHttpCall,
-  marshalRequest,
-  parseResponse,
-} from './utils';
-import pkgJson from '../../package.json' with {type: 'json'};
-import type {
-  CreateRepoRequest,
-  CreateRepoResponse,
-  DeleteProjectRequest,
-  DeleteProjectResponse,
-  GetRepoRequest,
-  GetRepoResponse,
-  ListReposRequest,
-  ListReposResponse,
-  RepoInfo,
-  UpdateRepoRequest,
-  UpdateRepoResponse,
-} from './model';
-import {
-  marshalCreateRepoRequestSchema,
-  marshalUpdateRepoRequestSchema,
-  unmarshalCreateRepoResponseSchema,
-  unmarshalDeleteProjectResponseSchema,
-  unmarshalGetRepoResponseSchema,
-  unmarshalListReposResponseSchema,
-  unmarshalUpdateRepoResponseSchema,
-} from './model';
-
-// Package identity segment for this client to be used in the User-Agent header.
-const PACKAGE_SEGMENT = {
-  key: 'sdk-js-' + pkgJson.name.replace(/^@[^/]+\/sdk-/, ''),
-  value: pkgJson.version,
-};
-
-export class ReposClient {
-  private readonly host: string;
-  // Workspace ID used to route workspace-level calls on unified hosts (SPOG).
-  // When set, workspace-level methods send X-Databricks-Org-Id on every
-  // request.
-  private readonly workspaceId: string | undefined;
-  private readonly httpClient: HttpClient;
-  private readonly logger: Logger;
-  // User-Agent header value. Composed once at construction from
-  // createDefault() merged with this package's identity and the active
-  // credential's name.
-  private readonly userAgent: string;
-
-  constructor(options: ClientOptions) {
-    if (options.host === undefined) {
-      throw new Error('Host is required.');
-    }
-    this.host = options.host.replace(/\/$/, '');
-    this.workspaceId = options.workspaceId;
-    this.logger = options.logger ?? new NoOpLogger();
-    const info = createDefault()
-      .with(PACKAGE_SEGMENT)
-      .with({key: 'sdk-js-auth', value: AUTH_VERSION})
-      .with({key: 'auth', value: options.credentials?.name() ?? 'default'});
-    this.userAgent = info.toString();
-    this.httpClient = newHttpClient(options);
-  }
-
-  /**
-   * Creates a repo in the workspace and links it to the remote Git repo specified.
-   * Note that repos created programmatically must be linked to a remote Git repo, unlike repos
-   * created in the browser.
-   */
-  async createRepo(
-    req: CreateRepoRequest,
-    options?: CallOptions
-  ): Promise<CreateRepoResponse> {
-    const url = `${this.host}/api/2.0/repos`;
-    const body = marshalRequest(req, marshalCreateRepoRequestSchema);
-    let resp: CreateRepoResponse | undefined;
-    const call = async (callSignal?: AbortSignal): Promise<void> => {
-      const headers = new Headers({'Content-Type': 'application/json'});
-      if (this.workspaceId !== undefined) {
-        headers.set('X-Databricks-Org-Id', this.workspaceId);
-      }
-      headers.set('User-Agent', this.userAgent);
-      const httpReq = buildHttpRequest('POST', url, headers, callSignal, body);
-      const respBody = await executeHttpCall({
-        request: httpReq,
-        httpClient: this.httpClient,
-        logger: this.logger,
-      });
-      resp = parseResponse(respBody, unmarshalCreateRepoResponseSchema);
-    };
-    await executeCall(call, options);
-    if (resp === undefined) {
-      throw new Error('operation completed without a result.');
-    }
-    return resp;
-  }
-
-  /** Deletes the specified repo. */
-  async deleteProject(
-    req: DeleteProjectRequest,
-    options?: CallOptions
-  ): Promise<DeleteProjectResponse> {
-    const url = `${this.host}/api/2.0/repos/${String(req.id ?? '')}`;
-    let resp: DeleteProjectResponse | undefined;
-    const call = async (callSignal?: AbortSignal): Promise<void> => {
-      const headers = new Headers();
-      if (this.workspaceId !== undefined) {
-        headers.set('X-Databricks-Org-Id', this.workspaceId);
-      }
-      headers.set('User-Agent', this.userAgent);
-      const httpReq = buildHttpRequest('DELETE', url, headers, callSignal);
-      const respBody = await executeHttpCall({
-        request: httpReq,
-        httpClient: this.httpClient,
-        logger: this.logger,
-      });
-      resp = parseResponse(respBody, unmarshalDeleteProjectResponseSchema);
-    };
-    await executeCall(call, options);
-    if (resp === undefined) {
-      throw new Error('operation completed without a result.');
-    }
-    return resp;
-  }
-
-  /** Returns the repo with the given repo ID. */
-  async getRepo(
-    req: GetRepoRequest,
-    options?: CallOptions
-  ): Promise<GetRepoResponse> {
-    const url = `${this.host}/api/2.0/repos/${String(req.id ?? '')}`;
-    let resp: GetRepoResponse | undefined;
-    const call = async (callSignal?: AbortSignal): Promise<void> => {
-      const headers = new Headers();
-      if (this.workspaceId !== undefined) {
-        headers.set('X-Databricks-Org-Id', this.workspaceId);
-      }
-      headers.set('User-Agent', this.userAgent);
-      const httpReq = buildHttpRequest('GET', url, headers, callSignal);
-      const respBody = await executeHttpCall({
-        request: httpReq,
-        httpClient: this.httpClient,
-        logger: this.logger,
-      });
-      resp = parseResponse(respBody, unmarshalGetRepoResponseSchema);
-    };
-    await executeCall(call, options);
-    if (resp === undefined) {
-      throw new Error('operation completed without a result.');
-    }
-    return resp;
-  }
-
-  /**
-   * Returns repos that the calling user has Manage permissions on.
-   * Use `next_page_token` to iterate through additional pages.
-   */
-  async listRepos(
-    req: ListReposRequest,
-    options?: CallOptions
-  ): Promise<ListReposResponse> {
-    const url = `${this.host}/api/2.0/repos`;
-    const params = new URLSearchParams();
-    if (req.pathPrefix !== undefined) {
-      params.append('path_prefix', req.pathPrefix);
-    }
-    if (req.nextPageToken !== undefined) {
-      params.append('next_page_token', req.nextPageToken);
-    }
-    const query = params.toString();
-    const fullUrl = query !== '' ? `${url}?${query}` : url;
-    let resp: ListReposResponse | undefined;
-    const call = async (callSignal?: AbortSignal): Promise<void> => {
-      const headers = new Headers();
-      if (this.workspaceId !== undefined) {
-        headers.set('X-Databricks-Org-Id', this.workspaceId);
-      }
-      headers.set('User-Agent', this.userAgent);
-      const httpReq = buildHttpRequest('GET', fullUrl, headers, callSignal);
-      const respBody = await executeHttpCall({
-        request: httpReq,
-        httpClient: this.httpClient,
-        logger: this.logger,
-      });
-      resp = parseResponse(respBody, unmarshalListReposResponseSchema);
-    };
-    await executeCall(call, options);
-    if (resp === undefined) {
-      throw new Error('operation completed without a result.');
-    }
-    return resp;
-  }
-
-  async *listReposIter(
-    req: ListReposRequest,
-    options?: CallOptions
-  ): AsyncGenerator<RepoInfo> {
-    const pageReq: ListReposRequest = {...req};
-    for (;;) {
-      const resp = await this.listRepos(pageReq, options);
-      for (const item of resp.repos ?? []) {
-        yield item;
-      }
-      if (resp.nextPageToken === undefined || resp.nextPageToken === '') {
-        return;
-      }
-      pageReq.nextPageToken = resp.nextPageToken;
-    }
-  }
-
-  /**
-   * Updates the repo to a different branch or tag, or updates the repo to the latest commit on
-   * the same branch.
-   */
-  async updateRepo(
-    req: UpdateRepoRequest,
-    options?: CallOptions
-  ): Promise<UpdateRepoResponse> {
-    const url = `${this.host}/api/2.0/repos/${String(req.id ?? '')}`;
-    const body = marshalRequest(req, marshalUpdateRepoRequestSchema);
-    let resp: UpdateRepoResponse | undefined;
-    const call = async (callSignal?: AbortSignal): Promise<void> => {
-      const headers = new Headers({'Content-Type': 'application/json'});
-      if (this.workspaceId !== undefined) {
-        headers.set('X-Databricks-Org-Id', this.workspaceId);
-      }
-      headers.set('User-Agent', this.userAgent);
-      const httpReq = buildHttpRequest('PATCH', url, headers, callSignal, body);
-      const respBody = await executeHttpCall({
-        request: httpReq,
-        httpClient: this.httpClient,
-        logger: this.logger,
-      });
-      resp = parseResponse(respBody, unmarshalUpdateRepoResponseSchema);
-    };
-    await executeCall(call, options);
-    if (resp === undefined) {
-      throw new Error('operation completed without a result.');
-    }
-    return resp;
-  }
-}

package/src/v1/index.ts

@@ -1,19 +0,0 @@
-// Code generated from API definition by Databricks SDK Generator. DO NOT EDIT.
-
-export {ReposClient} from './client';
-
-export type {
-  CreateRepoRequest,
-  CreateRepoResponse,
-  DeleteProjectRequest,
-  DeleteProjectResponse,
-  GetRepoRequest,
-  GetRepoResponse,
-  ListReposRequest,
-  ListReposResponse,
-  RepoInfo,
-  SparseCheckout,
-  SparseCheckoutUpdate,
-  UpdateRepoRequest,
-  UpdateRepoResponse,
-} from './model';

package/src/v1/model.ts

@@ -1,306 +0,0 @@
-// 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;
-}
-
-export interface CreateRepoResponse {
-  /** 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/no-empty-object-type
-export interface DeleteProjectResponse {}
-
-export interface GetRepoRequest {
-  /** ID of the Git folder (repo) object in the workspace. */
-  id?: bigint | undefined;
-}
-
-export interface GetRepoResponse {
-  /** 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;
-}
-
-export interface ListReposResponse {
-  /** 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/no-empty-object-type
-export interface UpdateRepoResponse {}
-
-export const unmarshalCreateRepoResponseSchema: z.ZodType<CreateRepoResponse> =
-  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 unmarshalDeleteProjectResponseSchema: z.ZodType<DeleteProjectResponse> =
-  z.object({});
-
-export const unmarshalGetRepoResponseSchema: z.ZodType<GetRepoResponse> = 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 unmarshalListReposResponseSchema: z.ZodType<ListReposResponse> = 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,
-  }));
-
-export const unmarshalUpdateRepoResponseSchema: z.ZodType<UpdateRepoResponse> =
-  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

@@ -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});
-  }
-}