@paklo/core 0.1.0

package/dist/node/azure.d.ts

@@ -0,0 +1,338 @@
+import { D as DependabotUpdatePullRequest, Yt as DependabotConfig, ft as DependabotDependency, gt as DependabotExistingPR, mt as DependabotExistingGroupPR, r as DependabotCreatePullRequest, t as DependabotClosePullRequest, yn as VariableFinderFn } from "./index-DP9JfUPG.js";
+import "./index-3wZw74Ah.js";
+import * as zod_v40 from "zod/v4";
+import * as zod_v4_core0 from "zod/v4/core";
+
+//#region src/azure/types.d.ts
+declare enum VersionControlChangeType {
+  None = 0,
+  Add = 1,
+  Edit = 2,
+  Encoding = 4,
+  Rename = 8,
+  Delete = 16,
+  Undelete = 32,
+  Branch = 64,
+  Merge = 128,
+  Lock = 256,
+  Rollback = 512,
+  SourceRename = 1024,
+  TargetRename = 2048,
+  Property = 4096,
+  All = 8191,
+}
+declare enum GitPullRequestMergeStrategy {
+  NoFastForward = 1,
+  Squash = 2,
+  Rebase = 3,
+  RebaseMerge = 4,
+}
+declare enum CommentThreadStatus {
+  Unknown = 0,
+  Active = 1,
+  Fixed = 2,
+  WontFix = 3,
+  Closed = 4,
+  ByDesign = 5,
+  Pending = 6,
+}
+declare enum CommentType {
+  Unknown = 0,
+  Text = 1,
+  CodeChange = 2,
+  System = 3,
+}
+declare enum ItemContentType {
+  RawText = 0,
+  Base64Encoded = 1,
+}
+declare enum PullRequestAsyncStatus {
+  NotSet = 0,
+  Queued = 1,
+  Conflicts = 2,
+  Succeeded = 3,
+  RejectedByPolicy = 4,
+  Failure = 5,
+}
+declare enum PullRequestStatus {
+  NotSet = 0,
+  Active = 1,
+  Abandoned = 2,
+  Completed = 3,
+  All = 4,
+}
+interface IdentityRefWithVote {
+  id?: string;
+  displayName?: string;
+  uniqueName?: string;
+  url?: string;
+  imageUrl?: string;
+  vote?: number;
+  hasDeclined?: boolean;
+  isFlagged?: boolean;
+  isRequired?: boolean;
+}
+//#endregion
+//#region src/azure/models.d.ts
+/**
+ * Pull request property names used to store metadata about the pull request.
+ * https://learn.microsoft.com/en-us/rest/api/azure/devops/git/pull-request-properties
+ */
+declare const DEVOPS_PR_PROPERTY_MICROSOFT_GIT_SOURCE_REF_NAME = "Microsoft.Git.PullRequest.SourceRefName";
+declare const DEVOPS_PR_PROPERTY_DEPENDABOT_PACKAGE_MANAGER = "Dependabot.PackageManager";
+declare const DEVOPS_PR_PROPERTY_DEPENDABOT_DEPENDENCIES = "Dependabot.Dependencies";
+/**
+ * File change
+ */
+interface IFileChange {
+  changeType: VersionControlChangeType;
+  path: string;
+  content: string;
+  encoding: string;
+}
+/**
+ * Pull request properties
+ */
+interface IPullRequestProperties {
+  id: number;
+  properties?: {
+    name: string;
+    value: string;
+  }[];
+}
+/**
+ * Pull request creation request
+ */
+interface ICreatePullRequest {
+  project: string;
+  repository: string;
+  source: {
+    commit: string;
+    branch: string;
+  };
+  target: {
+    branch: string;
+  };
+  author?: {
+    email: string;
+    name: string;
+  };
+  title: string;
+  description: string;
+  commitMessage: string;
+  autoComplete?: {
+    ignorePolicyConfigIds?: number[];
+    mergeStrategy?: GitPullRequestMergeStrategy;
+  };
+  assignees?: string[];
+  labels?: string[];
+  workItems?: string[];
+  changes: IFileChange[];
+  properties?: {
+    name: string;
+    value: string;
+  }[];
+}
+/**
+ * Pull request update request
+ */
+interface IUpdatePullRequest {
+  project: string;
+  repository: string;
+  pullRequestId: number;
+  commit: string;
+  author?: {
+    email: string;
+    name: string;
+  };
+  changes: IFileChange[];
+  skipIfDraft?: boolean;
+  skipIfCommitsFromAuthorsOtherThan?: string;
+  skipIfNotBehindTargetBranch?: boolean;
+}
+/**
+ * Pull request approval request
+ */
+interface IApprovePullRequest {
+  project: string;
+  repository: string;
+  pullRequestId: number;
+}
+/**
+ * Pull request abandon request
+ */
+interface IAbandonPullRequest {
+  project: string;
+  repository: string;
+  pullRequestId: number;
+  comment?: string;
+  deleteSourceBranch?: boolean;
+}
+//#endregion
+//#region src/azure/url-parts.d.ts
+type AzureDevOpsUrl = {
+  /** URL of the organisation. This may lack the project name */
+  url: URL;
+  /** Organisation URL hostname */
+  hostname: string;
+  /** Organisation API endpoint URL */
+  'api-endpoint': string;
+  /** Project ID or Name */
+  project: string;
+  /** Repository ID or Name */
+  repository: string;
+  /** Slug of the repository e.g. `contoso/prj1/_git/repo1`, `tfs/contoso/prj1/_git/repo1` */
+  'repository-slug': string;
+};
+declare function extractUrlParts({
+  organisationUrl,
+  project,
+  repository
+}: {
+  organisationUrl: string;
+  project: string;
+  repository: string;
+}): AzureDevOpsUrl;
+//#endregion
+//#region src/azure/client.d.ts
+/** Azure DevOps REST API client. */
+declare class AzureDevOpsWebApiClient {
+  private readonly organisationApiUrl;
+  private readonly identityApiUrl;
+  private readonly accessToken;
+  private readonly debug;
+  private authenticatedUserId?;
+  private resolvedUserIds;
+  static API_VERSION: string;
+  static API_VERSION_PREVIEW: string;
+  constructor(url: AzureDevOpsUrl, accessToken: string, debug?: boolean);
+  /**
+   * Get the identity of the authenticated user.
+   * @returns
+   */
+  getUserId(): Promise<string>;
+  /**
+   * Get the identity id from a user name, email, or group name.
+   * Requires scope "Identity (Read)" (vso.identity).
+   * @param userNameEmailOrGroupName
+   * @returns
+   */
+  resolveIdentityId(userNameEmailOrGroupName: string): Promise<string | undefined>;
+  /**
+   * Get the default branch for a repository.
+   * Requires scope "Code (Read)" (vso.code).
+   * @param project
+   * @param repository
+   * @returns
+   */
+  getDefaultBranch(project: string, repository: string): Promise<string | undefined>;
+  /**
+   * Get the list of branch names for a repository.
+   * Requires scope "Code (Read)" (vso.code).
+   * @param project
+   * @param repository
+   * @returns
+   */
+  getBranchNames(project: string, repository: string): Promise<string[] | undefined>;
+  /**
+   * Get the properties for all active pull request created by the supplied user.
+   * Requires scope "Code (Read)" (vso.code).
+   * @param project
+   * @param repository
+   * @param creator
+   * @returns
+   */
+  getActivePullRequestProperties(project: string, repository: string, creator: string): Promise<IPullRequestProperties[]>;
+  /**
+   * Create a new pull request.
+   * Requires scope "Code (Write)" (vso.code_write).
+   * Requires scope "Identity (Read)" (vso.identity), if assignees are specified.
+   * @param pr
+   * @returns
+   */
+  createPullRequest(pr: ICreatePullRequest): Promise<number | null>;
+  /**
+   * Update a pull request.
+   * Requires scope "Code (Read & Write)" (vso.code, vso.code_write).
+   * @param pr
+   * @returns
+   */
+  updatePullRequest(pr: IUpdatePullRequest): Promise<boolean>;
+  /**
+   * Approve a pull request.
+   * Requires scope "Code (Write)" (vso.code_write).
+   * @param pr
+   * @returns
+   */
+  approvePullRequest(pr: IApprovePullRequest): Promise<boolean>;
+  /**
+   * Abandon a pull request.
+   * Requires scope "Code (Write)" (vso.code_write).
+   * @param pr
+   * @returns
+   */
+  abandonPullRequest(pr: IAbandonPullRequest): Promise<boolean>;
+  private restApiGet;
+  private restApiPost;
+  private restApiPut;
+  private restApiPatch;
+}
+declare function sendRestApiRequestWithRetry(method: string, url: string, payload: unknown, requestAsync: () => Promise<Response>, isDebug?: boolean, retryCount?: number, retryDelay?: number): Promise<any>;
+//#endregion
+//#region src/azure/config.d.ts
+/**
+ * Parse the dependabot config YAML file to specify update configuration.
+ * The file should be located at any of `POSSIBLE_CONFIG_FILE_PATHS`.
+ *
+ * To view YAML file format, visit
+ * https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates#allow
+ *
+ * @returns {DependabotConfig} config - the dependabot configuration
+ */
+declare function getDependabotConfig({
+  url,
+  token,
+  remote,
+  rootDir,
+  variableFinder
+}: {
+  url: AzureDevOpsUrl;
+  token: string;
+  /**
+   * Whether to fetch the configuration file via the REST API (true) or look for it locally (false).
+   */
+  remote: boolean;
+  rootDir?: string;
+  variableFinder: VariableFinderFn;
+}): Promise<DependabotConfig>;
+//#endregion
+//#region src/azure/utils.d.ts
+declare function normalizeFilePath(path: string): string;
+declare function normalizeBranchName(branch?: string): string | undefined;
+declare const DependenciesPrPropertySchema: zod_v40.ZodUnion<[zod_v40.ZodArray<zod_v40.ZodObject<{
+  'dependency-name': zod_v40.ZodString;
+  'dependency-version': zod_v40.ZodOptional<zod_v40.ZodNullable<zod_v40.ZodString>>;
+  directory: zod_v40.ZodOptional<zod_v40.ZodNullable<zod_v40.ZodString>>;
+  removed: zod_v40.ZodOptional<zod_v40.ZodNullable<zod_v40.ZodBoolean>>;
+}, zod_v4_core0.$strip>>, zod_v40.ZodObject<{
+  'dependency-group-name': zod_v40.ZodString;
+  dependencies: zod_v40.ZodArray<zod_v40.ZodObject<{
+    'dependency-name': zod_v40.ZodString;
+    'dependency-version': zod_v40.ZodOptional<zod_v40.ZodNullable<zod_v40.ZodString>>;
+    directory: zod_v40.ZodOptional<zod_v40.ZodNullable<zod_v40.ZodString>>;
+    removed: zod_v40.ZodOptional<zod_v40.ZodNullable<zod_v40.ZodBoolean>>;
+  }, zod_v4_core0.$strip>>;
+}, zod_v4_core0.$strip>]>;
+declare function buildPullRequestProperties(packageManager: string, dependencies: DependabotExistingPR[] | DependabotExistingGroupPR): {
+  name: string;
+  value: string;
+}[];
+declare function parsePullRequestProperties(pullRequests: IPullRequestProperties[], packageManager: string | null): Record<string, DependabotExistingPR[] | DependabotExistingGroupPR>;
+declare function getPullRequestForDependencyNames(existingPullRequests: IPullRequestProperties[], packageManager: string, dependencyNames: string[]): IPullRequestProperties | undefined;
+declare function getPullRequestChangedFilesForOutputData(data: DependabotCreatePullRequest | DependabotUpdatePullRequest): IFileChange[];
+declare function getPullRequestCloseReasonForOutputData(data: DependabotClosePullRequest): string | undefined;
+declare function getPullRequestDependenciesPropertyValueForOutputData(data: DependabotCreatePullRequest): DependabotExistingPR[] | DependabotExistingGroupPR;
+declare function getPullRequestDescription(packageManager: string, body: string | null | undefined, dependencies: DependabotDependency[]): string;
+//#endregion
+export { type AzureDevOpsUrl, AzureDevOpsWebApiClient, CommentThreadStatus, CommentType, DEVOPS_PR_PROPERTY_DEPENDABOT_DEPENDENCIES, DEVOPS_PR_PROPERTY_DEPENDABOT_PACKAGE_MANAGER, DEVOPS_PR_PROPERTY_MICROSOFT_GIT_SOURCE_REF_NAME, DependenciesPrPropertySchema, GitPullRequestMergeStrategy, IAbandonPullRequest, IApprovePullRequest, ICreatePullRequest, IFileChange, IPullRequestProperties, IUpdatePullRequest, IdentityRefWithVote, ItemContentType, PullRequestAsyncStatus, PullRequestStatus, VersionControlChangeType, buildPullRequestProperties, extractUrlParts, getDependabotConfig, getPullRequestChangedFilesForOutputData, getPullRequestCloseReasonForOutputData, getPullRequestDependenciesPropertyValueForOutputData, getPullRequestDescription, getPullRequestForDependencyNames, normalizeBranchName, normalizeFilePath, parsePullRequestProperties, sendRestApiRequestWithRetry };
+//# sourceMappingURL=azure.d.ts.map