@unownplain/anthelion-komac 0.0.51 → 0.0.52

package/index.d.ts

@@ -1,211 +1,215 @@
 /* auto-generated by NAPI-RS */
 /* eslint-disable */
 /**
- * Analyze an installer from a URL and return installer analysis information.
+ * Reusable Komac client.
  *
- * When the installer is a ZIP, `matches` can be used to select nested installer
- * files. Plain strings are matched as case-insensitive substrings, while values
- * containing glob metacharacters are matched as glob patterns.
- *
- * # Errors
- *
- * Returns `InvalidArg` if `url` is invalid.
- * Returns `GenericFailure` if downloading or analyzing the installer fails.
+ * A client owns the HTTP connection pools used for GitHub requests and installer downloads.
+ * Create one client per process and share it across operations.
  */
-export declare function analyzeInstaller(url: string, matches?: Array<string> | undefined | null): Promise<AnalyzeInstallerResult>
+export declare class Komac {
+  /** Create a reusable client. If omitted, `githubToken` falls back to `GITHUB_TOKEN`. */
+  constructor(options?: KomacOptions | undefined | null)
+  /** Download and analyze one installer artifact. */
+  analyzeInstaller(request: AnalyzeInstallerRequest): Promise<AnalyzedArtifact>
+  /** Download and analyze several installer artifacts concurrently. */
+  analyzeInstallers(request: AnalyzeInstallersRequest): Promise<Array<AnalyzedArtifact>>
+  /** Find an existing pull request for a package version. */
+  findPullRequest(query: PullRequestQuery): Promise<PullRequest | null>
+  /** Fetch normalized notes from a GitHub release. */
+  getGithubReleaseNotes(release: GitHubRelease): Promise<string | null>
+  /** Generate manifests for an updated package and optionally submit them as a pull request. */
+  updatePackage(request: UpdatePackageRequest): Promise<UpdatePackageResult>
+}
+
+/** Analysis of one downloaded artifact. */
+export interface AnalyzedArtifact {
+  /** Final installer URL used by the downloader. */
+  url: string
+  /** SHA-256 digest of the downloaded bytes. */
+  sha256: string
+  /** HTTP last-modified date, when supplied by the server. */
+  releaseDate?: string
+  /** File version metadata detected in the artifact. */
+  versions: DetectedVersions
+  /** Installers represented by this artifact, including selected nested installers. */
+  installers: Array<AnalyzedInstaller>
+}
+
+/** Installer information detected during analysis. */
+export interface AnalyzedInstaller {
+  /** Installer locale, if present. */
+  locale?: string
+  /** Installer architecture. */
+  architecture: 'x86' | 'x64' | 'arm' | 'arm64' | 'neutral'
+  /** Installer type, if detected. */
+  installerType?: string
+  /** Nested installer type, if present. */
+  nestedInstallerType?: string
+  /** Relative paths of nested installer files within an archive. */
+  nestedInstallerFiles: Array<string>
+  /** Apps and Features / ARP entries detected for this installer. */
+  appsAndFeaturesEntries: Array<AppsAndFeaturesEntry>
+  /** Install scope, if present. */
+  scope?: string
+}
 
-/** Result of the analyze installer operation. */
-export interface AnalyzeInstallerResult {
-  /** Detected installer information. */
-  analysis: Array<InstallerAnalysis>
-  /** PE `FileVersion` string from the version info resource, if present. */
-  fileVersion?: string
-  /** PE `ProductVersion` string from the version info resource, if present. */
-  productVersion?: string
+/** Options for analyzing one installer artifact. */
+export interface AnalyzeInstallerRequest {
+  /** Artifact to download and analyze. */
+  installer: string | InstallerSource
 }
 
-/** Apps and Features / ARP entry information detected during analysis. */
-export interface AppsAndFeaturesEntryAnalysis {
-  /** Display name registered in Apps and Features, if present. */
+/** Options for analyzing several installer artifacts in one concurrent operation. */
+export interface AnalyzeInstallersRequest {
+  /** Artifacts to download and analyze. */
+  installers: Array<string | InstallerSource>
+}
+
+/** Apps and Features / ARP metadata detected during analysis. */
+export interface AppsAndFeaturesEntry {
   displayName?: string
-  /** Publisher registered in Apps and Features, if present. */
   publisher?: string
-  /** Display version registered in Apps and Features, if present. */
   displayVersion?: string
-  /** Product code registered in Apps and Features, if present. */
   productCode?: string
-  /** Upgrade code registered in Apps and Features, if present. */
   upgradeCode?: string
-  /** Installer type registered in Apps and Features, if present. */
   installerType?: string
 }
 
-/** Existing pull request metadata. */
-export interface ExistingPullRequestResult {
-  /** The URL of the existing pull request */
-  pullRequestUrl: string
-  /** The GitHub login of the user or bot that created the pull request */
-  createdBy: string
-  /** Whether the pull request was created by the authenticated user */
-  createdByAuthenticatedUser: boolean
-  /** The current state of the pull request (`open`, `closed`, or `merged`) */
-  state: string
-  /** The pull request creation timestamp in RFC3339 format */
-  createdAt: string
+/** Newly created pull request links. */
+export interface CreatedPullRequest {
+  url: string
+  diffUrl: string
 }
 
-/**
- * Get an existing pull request for a package version in winget-pkgs.
- *
- * # Errors
- *
- * Returns `InvalidArg` if `package_identifier` or `version` are invalid.
- * Returns `GenericFailure` if creating the GitHub client or querying pull requests fails.
- */
-export declare function getExistingPullRequest(options: GetExistingPullRequestOptions): Promise<ExistingPullRequestResult | null>
+/** Version metadata detected while inspecting an installer. */
+export interface DetectedVersions {
+  /** PE `FileVersion`, if present. */
+  file?: string
+  /** PE `ProductVersion`, if present. */
+  product?: string
+}
 
-/** Options for get existing pull request. */
-export interface GetExistingPullRequestOptions {
-  /** The package's unique identifier (e.g. "Microsoft.VisualStudioCode") */
-  packageIdentifier: string
-  /** The package version to search for */
-  version: string
+/** Generated manifest file. */
+export interface GeneratedManifest {
+  /** File path within the package repository. */
+  path: string
+  /** YAML manifest content. */
+  yaml: string
+}
+
+/** Identifies a GitHub release. */
+export interface GitHubRelease {
+  owner: string
+  repository: string
+  tag: string
+}
+
+/** A downloadable installer artifact. */
+export interface InstallerSource {
+  /** Installer URL without an encoded architecture suffix. */
+  url: string
+  /** Override architecture detection for this artifact. */
+  architecture?: 'x86' | 'x64' | 'arm' | 'arm64' | 'neutral'
+  /** ZIP entry patterns to analyze instead of automatic nested-installer selection. */
+  nestedInstallerMatches?: Array<string>
+}
+
+/** Configuration shared by every operation performed by a `Komac` client. */
+export interface KomacOptions {
   /**
-   * GitHub personal access token with the `public_repo` scope.
-   * If omitted, `GITHUB_TOKEN` from the environment is used.
+   * GitHub token used by repository operations. Defaults to `GITHUB_TOKEN`.
+   * Installer analysis does not require a token.
    */
-  token?: string
-  /** Ignore pull requests not created by the authenticated user. */
-  ignorePullRequestsCreatedByOtherUsers?: boolean
+  githubToken?: string
+  /**
+   * Maximum number of installers downloaded or analyzed concurrently.
+   * Defaults to the number of available logical CPUs.
+   */
+  downloadConcurrency?: number
 }
 
 /**
- * Fetch, normalize, and return release notes for a GitHub release tag.
- *
- * # Errors
+ * Parse a YAML document into a JavaScript value.
  *
- * Returns `GenericFailure` if creating the GitHub client or fetching release data fails.
- * Returns an error from token resolution when no usable token is available.
- */
-export declare function getFormattedGithubReleaseNotes(owner: string, repo: string, tag: string, token?: string | undefined | null): Promise<string | null>
-
-/**
- * Convert HTML release notes content to plain text.
+ * The core schema resolves YAML scalar types. The failsafe schema preserves all scalars as
+ * strings. Duplicate mapping keys are rejected in both modes.
  *
  * # Errors
  *
- * Returns `GenericFailure` if the conversion task panics.
+ * Throws a `YAMLParseError` if the input is not a single valid YAML document or contains
+ * duplicate mapping keys. The error includes `code`, `pos`, `linePos`, and `location` properties.
  */
-export declare function htmlToPlainText(html: string): Promise<string | null>
+export declare function parseYaml(input: string, schema?: 'core' | 'failsafe'): unknown
 
-/** Installer information detected during analysis. */
-export interface InstallerAnalysis {
-  /** Installer locale (if present). */
-  installerLocale?: string
-  /** Installer architecture. */
-  architecture: string
-  /** Installer type (if detected). */
-  installerType?: string
-  /** Nested installer type (if present). */
-  nestedInstallerType?: string
-  /** Nested installer files within archives. */
-  nestedInstallerFiles: Array<NestedInstallerFileAnalysis>
-  /** Apps and Features / ARP entries detected for this installer. */
-  appsAndFeaturesEntries: Array<AppsAndFeaturesEntryAnalysis>
-  /** Install scope (if present). */
-  scope?: string
-  /** Installer download URL. */
-  installerUrl: string
-  /** Installer SHA-256 hash. */
-  installerSha256: string
-  /** Installer release date, if available. */
-  releaseDate?: string
+/** Existing pull request metadata. */
+export interface PullRequest {
+  url: string
+  author: string
+  authoredByCurrentUser: boolean
+  state: 'open' | 'closed' | 'merged'
+  /** RFC 3339 creation timestamp. */
+  createdAt: string
 }
 
-/** A single manifest file change. */
-export interface ManifestChange {
-  /** The file path within the winget-pkgs repository */
-  path: string
-  /** The YAML content of the manifest */
-  content: string
+/** Query for an existing WinGet pull request. */
+export interface PullRequestQuery {
+  packageIdentifier: string
+  version: string
+  /** Restrict results to pull requests authored by the authenticated user. */
+  authoredByCurrentUserOnly?: boolean
 }
 
-/**
- * Convert Markdown release notes content to plain text.
- *
- * # Errors
- *
- * Returns `GenericFailure` if the conversion task panics.
- */
-export declare function markdownToPlainText(markdown: string): Promise<string | null>
-
-/** Nested installer file information. */
-export interface NestedInstallerFileAnalysis {
-  /** Relative path to the nested installer file. */
-  relativeFilePath: string
+/** Release notes fields to apply to the default locale manifest. */
+export interface ReleaseNotesInput {
+  text?: string
+  url?: string
 }
 
-/**
- * Update an existing package version in winget-pkgs.
- *
- * # Errors
- *
- * Returns `InvalidArg` when provided arguments are invalid (identifier, URLs, versions, or selectors).
- * Returns `GenericFailure` when downloading installers, analyzing content, loading manifests,
- * or creating the pull request fails.
- */
-export declare function updateVersion(options: UpdateVersionOptions): Promise<UpdateVersionResult>
+/** Convert HTML or Markdown release notes to plain text without blocking the JavaScript event loop. */
+export declare function releaseNotesToPlainText(content: string, format: 'markdown' | 'html'): Promise<string | null>
 
-/** Options for update version. */
-export interface UpdateVersionOptions {
-  /** The package's unique identifier (e.g. "Microsoft.VisualStudioCode") */
-  packageIdentifier: string
-  /**
-   * The new package version.
-   *
-   * You can also pass one of:
-   * - `displayVersion`
-   * - `productVersion`
-   * - `fileVersion`
-   *
-   * In that case, the version will be resolved from installer analysis.
-   */
+/** Existing package version to replace. */
+export interface ReplacementSelection {
+  target: 'latest' | 'version'
+  /** Required only when `target` is `version`. */
+  value?: string
+}
+
+/** Package version created by an update. */
+export interface UpdatedPackage {
+  identifier: string
   version: string
-  /** List of installer URLs (may include "|architecture" suffix) */
-  urls: Array<string>
-  /**
-   * ZIP nested installer match patterns used during installer analysis.
-   * These matches also affect `displayVersion`, `productVersion`, and
-   * `fileVersion` version selector resolution.
-   *
-   * Plain strings are matched as case-insensitive substrings, while values
-   * containing glob metacharacters are matched as glob patterns.
-   */
-  installerMatches?: Array<string>
-  /** URL to the release notes */
-  releaseNotesUrl?: string
-  /** Release notes text for the manifest */
-  releaseNotes?: string
-  /** Run without submitting a PR */
-  dryRun?: boolean
-  /** Version to replace (use "latest" for the latest version) */
-  replace?: string
-  /** Look for the package under fonts instead of probing manifests first */
-  font?: boolean
-  /** GitHub personal access token with the `public_repo` scope */
-  token?: string
-}
-
-/** Result of the update version operation. */
-export interface UpdateVersionResult {
-  /** The URL of the created pull request, if submitted */
-  pullRequestUrl?: string
-  /** The winget-diff view URL for the created pull request, if submitted */
-  diffViewUrl?: string
-  /** The generated manifest changes as a list of (path, content) pairs */
-  changes: Array<ManifestChange>
-  /** The package identifier that was updated */
+}
+
+/** Update an existing package using newly published installers. */
+export interface UpdatePackageRequest {
+  /** Package identifier, for example `Microsoft.VisualStudioCode`. */
   packageIdentifier: string
-  /** The version that was created */
-  version: string
+  /** How to determine the new package version. */
+version: string | { source: 'explicit'; value: string } | { source: 'display' | 'product' | 'file' }
+/** New installer artifacts. */
+installers: Array<string | InstallerSource>
+/** Release notes fields for the default locale manifest. */
+releaseNotes?: ReleaseNotesInput
+/** Existing version to remove in the same pull request. */
+replace?: { target: 'latest' } | { target: 'version'; value: string }
+/** Package layout. Defaults to `auto`, which probes standard manifests before fonts. */
+packageKind?: 'auto' | 'standard' | 'font'
+/** Generate manifests locally or submit them as a pull request. */
+mode: 'generate' | 'submit'
+}
+
+/** Result of generating or submitting a package update. */
+export interface UpdatePackageResult {
+  package: UpdatedPackage
+  manifests: Array<GeneratedManifest>
+  /** Present only when `mode` was `submit` and pull-request creation succeeded. */
+  pullRequest?: CreatedPullRequest
+}
+
+/** Explicit or installer-derived package version selection. */
+export interface VersionSelection {
+  source: 'explicit' | 'display' | 'product' | 'file'
+  /** Required only when `source` is `explicit`. */
+  value?: string
 }

package/index.js

@@ -590,10 +590,7 @@ if (!nativeBinding) {
   throw new Error(`Failed to load native binding`)
 }
 
-const { analyzeInstaller, getExistingPullRequest, getFormattedGithubReleaseNotes, htmlToPlainText, markdownToPlainText, updateVersion } = nativeBinding
-export { analyzeInstaller }
-export { getExistingPullRequest }
-export { getFormattedGithubReleaseNotes }
-export { htmlToPlainText }
-export { markdownToPlainText }
-export { updateVersion }
+const { Komac, parseYaml, releaseNotesToPlainText } = nativeBinding
+export { Komac }
+export { parseYaml }
+export { releaseNotesToPlainText }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unownplain/anthelion-komac",
-  "version": "0.0.51",
+  "version": "0.0.52",
   "description": "komac JS bindings for Anthelion",
   "license": "GPL-3.0-or-later",
   "repository": {
@@ -41,13 +41,13 @@
     "node": ">=22.0.0"
   },
   "optionalDependencies": {
-    "@unownplain/anthelion-komac-win32-x64-msvc": "0.0.51",
-    "@unownplain/anthelion-komac-darwin-x64": "0.0.51",
-    "@unownplain/anthelion-komac-linux-x64-gnu": "0.0.51",
-    "@unownplain/anthelion-komac-linux-x64-musl": "0.0.51",
-    "@unownplain/anthelion-komac-darwin-arm64": "0.0.51",
-    "@unownplain/anthelion-komac-linux-arm64-gnu": "0.0.51",
-    "@unownplain/anthelion-komac-linux-arm64-musl": "0.0.51",
-    "@unownplain/anthelion-komac-win32-arm64-msvc": "0.0.51"
+    "@unownplain/anthelion-komac-win32-x64-msvc": "0.0.52",
+    "@unownplain/anthelion-komac-darwin-x64": "0.0.52",
+    "@unownplain/anthelion-komac-linux-x64-gnu": "0.0.52",
+    "@unownplain/anthelion-komac-linux-x64-musl": "0.0.52",
+    "@unownplain/anthelion-komac-darwin-arm64": "0.0.52",
+    "@unownplain/anthelion-komac-linux-arm64-gnu": "0.0.52",
+    "@unownplain/anthelion-komac-linux-arm64-musl": "0.0.52",
+    "@unownplain/anthelion-komac-win32-arm64-msvc": "0.0.52"
   }
 }