@oras-project/oci-client 0.18.0-alpha.0

package/index.d.ts

@@ -0,0 +1,678 @@
+/* auto-generated by NAPI-RS */
+/* eslint-disable */
+
+/**
+ * Which binding artifact the generated loader actually loaded: `'native'` for
+ * a native addon, otherwise the `platformArchABI` of the WASI flavor. Every
+ * flavor napi-rs can build is listed, because `NAPI_RS_NATIVE_LIBRARY_PATH`
+ * can point the loader at a WASI artifact this package does not build itself.
+ */
+export declare const __napiBindingTarget: 'native' | 'wasm32-wasi' | 'wasm32-wasip1'
+
+/**
+ * OCI Distribution client for interacting with OCI registries.
+ * Provides pull, push, and manifest operations.
+ *
+ * # Authentication
+ *
+ * Methods that accept an `auth` parameter (`pull`, `push`, `pull_image_manifest`,
+ * `pull_manifest`, `pull_manifest_raw`, `push_manifest_list`, `list_tags`,
+ * `fetch_manifest_digest`, `catalog`, `pull_image_manifest_and_list_digest`,
+ * `pull_manifest_and_config_and_list_digest`) store credentials internally via
+ * the native `store_auth_if_needed` and then use them for the request.
+ *
+ * Methods without an `auth` parameter (`pull_blob`, `pull_blob_to_file`,
+ * `push_blob`, `push_blob_from_file`, `push_manifest`, `blob_exists`,
+ * `mount_blob`, `pull_referrers`) rely on credentials already stored by
+ * a prior explicit-auth call or by [`store_auth`](OciClient::store_auth).
+ */
+export declare class OciClient {
+  /** Create a new OCI client with default configuration. */
+  constructor()
+  /**
+   * Create a new OCI client with custom configuration.
+   *
+   * Throws if the configuration is invalid (e.g. malformed CA certificate,
+   * bad proxy URL). This differs from the parent crate's `Client::new` which
+   * silently falls back to defaults — in Node.js there is no `tracing`
+   * subscriber to surface those warnings, so we fail explicitly instead.
+   */
+  static withConfig(config: ClientConfig): OciClient
+  /**
+   * Explicitly release the underlying connection pool.
+   *
+   * This is **idempotent** — calling `close()` on an already-closed client
+   * is a safe no-op that returns `false`.
+   *
+   * **In-flight operations are not cancelled.** Any async method that already
+   * cloned the inner client will run to completion; only the shared pool
+   * reference held by the `OciClient` is dropped. The connection pool is
+   * fully reclaimed when the last in-flight clone finishes.
+   *
+   * After `close()`, all subsequent method calls will throw `"Client is closed"`.
+   */
+  close(): boolean
+  /**
+   * Pull an image from the registry.
+   *
+   * Wraps native `Client::pull`.
+   *
+   * Returns ImageData containing layers (as Buffers), config, and manifest.
+   */
+  pull(image: string, auth: RegistryAuth, acceptedMediaTypes: Array<string>): Promise<ImageData>
+  /**
+   * Push an image to the registry.
+   *
+   * Wraps native `Client::push`.
+   *
+   * Do not mutate `layers[].data` or `config.data` until this Promise settles.
+   * The Buffers are borrowed for the duration of the upload (same contract as
+   * Node `fs.write` / `socket.write`).
+   *
+   * Returns PushResponse with config and manifest URLs.
+   */
+  push(imageRef: string, layers: Array<ImageLayer>, config: Config, auth: RegistryAuth, manifest?: ImageManifest | undefined | null): Promise<PushResponse>
+  /**
+   * Pull referrers for an artifact (OCI 1.1 Referrers API).
+   *
+   * Wraps native `Client::pull_referrers`.
+   *
+   * Returns an ImageIndex containing the referrers.
+   */
+  pullReferrers(image: string, artifactType?: string | undefined | null): Promise<ImageIndex>
+  /**
+   * Push a manifest list (image index) to the registry.
+   *
+   * Wraps native `Client::push_manifest_list`.
+   *
+   * Returns the manifest URL.
+   */
+  pushManifestList(reference: string, auth: RegistryAuth, manifest: ImageIndex): Promise<string>
+  /**
+   * Pull an image manifest from the registry.
+   *
+   * Wraps native `Client::pull_image_manifest`.
+   *
+   * If a multi-platform Image Index manifest is encountered, a platform-specific
+   * Image manifest will be selected using the client's default platform resolution.
+   *
+   * Returns both the manifest and its digest.
+   */
+  pullImageManifest(image: string, auth: RegistryAuth): Promise<PullImageManifestResult>
+  /**
+   * Store authentication credentials for a registry.
+   *
+   * Wraps native `Client::store_auth_if_needed`: credentials are stored only
+   * if the registry does not already have stored auth. Once stored, all
+   * subsequent operations against the same registry (`pull_blob`, `push_blob`,
+   * `push_manifest`, etc.) will use them automatically.
+   */
+  storeAuth(registry: string, auth: RegistryAuth): Promise<void>
+  /**
+   * Pull a manifest (either image or index) from the registry.
+   * Returns the manifest and its digest.
+   */
+  pullManifest(image: string, auth: RegistryAuth): Promise<PullManifestResult>
+  /** Pull a manifest as raw bytes. */
+  pullManifestRaw(image: string, auth: RegistryAuth, acceptedMediaTypes: Array<string>): Promise<Buffer>
+  /**
+   * Push a manifest to the registry.
+   * Returns the manifest URL.
+   */
+  pushManifest(image: string, manifest: Manifest): Promise<string>
+  /**
+   * Push a blob to the registry.
+   * Returns the blob digest.
+   *
+   * Do not mutate `data` until this Promise settles. The Buffer is borrowed
+   * for the duration of the upload (same contract as Node `fs.write` /
+   * `socket.write`).
+   */
+  pushBlob(image: string, data: Buffer, digest: string): Promise<string>
+  /**
+   * Pull a blob from the registry.
+   * Returns the blob data.
+   */
+  pullBlob(image: string, digest: string): Promise<Buffer>
+  /**
+   * Pull a blob from the registry and write it to `path`.
+   *
+   * The destination file is created or truncated. Bytes are copied from the
+   * registry socket to disk and never enter a JavaScript `Buffer`. The
+   * digest is verified when the write completes.
+   */
+  pullBlobToFile(image: string, digest: string, path: string): Promise<undefined>
+  /**
+   * Push a blob from a file at `path`.
+   *
+   * The file is streamed to the registry. `digest` must be the SHA-256
+   * digest of the file contents (`sha256:<hex>`).
+   */
+  pushBlobFromFile(image: string, path: string, digest: string): Promise<string>
+  /** Check if a blob exists in the registry. */
+  blobExists(image: string, digest: string): Promise<boolean>
+  /** Mount a blob from another repository. */
+  mountBlob(target: string, source: string, digest: string): Promise<undefined>
+  /** List tags for a repository. */
+  listTags(image: string, auth: RegistryAuth, n?: number | undefined | null, last?: string | undefined | null): Promise<Array<string>>
+  /** Fetch manifest digest without downloading the full manifest. */
+  fetchManifestDigest(image: string, auth: RegistryAuth): Promise<string>
+  /**
+   * List available repositories in the registry.
+   * Implements the OCI Distribution Spec catalog endpoint (`/v2/_catalog`).
+   * Supports pagination via `n` (page size) and `last` (last repo from previous page).
+   */
+  catalog(image: string, auth: RegistryAuth, n?: number | undefined | null, last?: string | undefined | null): Promise<Array<string>>
+  /**
+   * Pull an image manifest and the parent manifest list digest from the registry.
+   *
+   * Like `pullImageManifest`, but also returns the digest of the parent
+   * manifest list/image index when the resolved manifest came from one.
+   * This is needed for signature verification on multi-arch images.
+   */
+  pullImageManifestAndListDigest(image: string, auth: RegistryAuth): Promise<PullImageManifestAndListDigestResult>
+  /**
+   * Pull a manifest, its config, and the parent manifest list digest from the registry.
+   *
+   * Returns the image manifest, its digest, the config JSON as a string,
+   * and the parent manifest list/image index digest when applicable.
+   */
+  pullManifestAndConfigAndListDigest(image: string, auth: RegistryAuth): Promise<PullManifestAndConfigAndListDigestResult>
+}
+
+/** Create an anonymous authentication object. */
+export declare function anonymousAuth(): RegistryAuth
+
+/** Create a basic authentication object. */
+export declare function basicAuth(username: string, password: string): RegistryAuth
+
+/** Create a bearer token authentication object. */
+export declare function bearerAuth(token: string): RegistryAuth
+
+/**
+ * A x509 certificate for TLS.
+ * Wraps native `Certificate`.
+ */
+export interface Certificate {
+  /** Which encoding is used by the certificate */
+  encoding: CertificateEncoding
+  /** Certificate data as bytes */
+  data: Buffer
+}
+
+/**
+ * Certificate encoding format.
+ * Wraps native `CertificateEncoding`.
+ */
+export enum CertificateEncoding {
+  /** DER encoded certificate */
+  Der = 'Der',
+  /** PEM encoded certificate */
+  Pem = 'Pem',
+}
+
+/**
+ * Client configuration options.
+ * Wraps native `ClientConfig`.
+ */
+export interface ClientConfig {
+  /** Which protocol the client should use (default: Https) */
+  protocol?: ClientProtocol
+  /** List of registries to exclude from HTTPS (used with HttpsExcept protocol) */
+  httpsExceptRegistries?: Array<string>
+  /**
+   * **DANGER**: Accept invalid TLS certificates (default: false).
+   * Setting this to `true` disables all certificate verification, making
+   * connections vulnerable to man-in-the-middle attacks. Only use for
+   * local development or testing with self-signed certificates.
+   * Prefer `extraRootCertificates` for production self-signed setups.
+   */
+  acceptInvalidCertificates?: boolean
+  /** Use monolithic push for pushing blobs (default: false) */
+  useMonolithicPush?: boolean
+  /** Extra root certificates to trust (for self-signed certificates) */
+  extraRootCertificates?: Array<Certificate>
+  /** Exclusive root certificates -- disables system roots and only uses these */
+  tlsCertsOnly?: Array<Certificate>
+  /** Maximum number of concurrent uploads during push (default: 16) */
+  maxConcurrentUpload?: number
+  /** Maximum number of concurrent downloads during pull (default: 16) */
+  maxConcurrentDownload?: number
+  /** Default token expiration in seconds (default: 60) */
+  defaultTokenExpirationSecs?: number
+  /** Read timeout in milliseconds */
+  readTimeoutMs?: number
+  /** Connect timeout in milliseconds */
+  connectTimeoutMs?: number
+  /** HTTPS proxy URL */
+  httpsProxy?: string
+  /** HTTP proxy URL */
+  httpProxy?: string
+  /** No proxy list (comma-separated) */
+  noProxy?: string
+  /**
+   * Platform filter for multi-platform image selection.
+   * When set, automatically selects the matching platform from Image Index manifests.
+   */
+  platform?: PlatformFilter
+}
+
+/**
+ * Protocol configuration for the client.
+ * Wraps native `ClientProtocol`.
+ */
+export enum ClientProtocol {
+  /** Use HTTP (insecure) */
+  Http = 'Http',
+  /** Use HTTPS (secure, default) */
+  Https = 'Https',
+  /** Use HTTPS except for specified registries */
+  HttpsExcept = 'HttpsExcept',
+}
+
+/**
+ * Configuration object for an image.
+ * Wraps native `Config`.
+ */
+export interface Config {
+  /** The config data as raw bytes */
+  data: Buffer
+  /** The media type of this config */
+  mediaType: string
+  /** Optional annotations for this config */
+  annotations?: Record<string, string>
+}
+
+/** OCI Descriptor - describes a content addressable resource. */
+export interface Descriptor {
+  /** The media type of the referenced content */
+  mediaType: string
+  /** The digest of the targeted content */
+  digest: string
+  /** The size in bytes of the targeted content */
+  size: number
+  /** Optional list of URLs from which this object may be downloaded */
+  urls?: Array<string>
+  /** Optional annotations for this descriptor */
+  annotations?: Record<string, string>
+  /** Optional artifact type when the descriptor points to an artifact */
+  artifactType?: string
+}
+
+export interface ErrorCause {
+  type: string
+  message: string
+  debug: string
+  parsed?: any
+  cause?: ErrorCause
+}
+
+export declare function fromOciError(err: unknown): OciDistributionError | ParseError
+
+/** The mediatype for an image config (manifest) */
+export declare const IMAGE_CONFIG_MEDIA_TYPE: string
+
+/** The mediatype that Docker uses for image configs */
+export declare const IMAGE_DOCKER_CONFIG_MEDIA_TYPE: string
+
+/** The mediatype that Docker uses for a layer that is gzipped */
+export declare const IMAGE_DOCKER_LAYER_GZIP_MEDIA_TYPE: string
+
+/** The mediatype that Docker uses for a layer that is tarred */
+export declare const IMAGE_DOCKER_LAYER_TAR_MEDIA_TYPE: string
+
+/** The mediatype for a layer that is gzipped */
+export declare const IMAGE_LAYER_GZIP_MEDIA_TYPE: string
+
+/** The mediatype for a layer */
+export declare const IMAGE_LAYER_MEDIA_TYPE: string
+
+/** The mediatype for a layer that is nondistributable and gzipped */
+export declare const IMAGE_LAYER_NONDISTRIBUTABLE_GZIP_MEDIA_TYPE: string
+
+/** The mediatype for a layer that is nondistributable */
+export declare const IMAGE_LAYER_NONDISTRIBUTABLE_MEDIA_TYPE: string
+
+/** The mediatype for a Docker v2 schema 2 manifest list */
+export declare const IMAGE_MANIFEST_LIST_MEDIA_TYPE: string
+
+/** The mediatype for a Docker v2 schema 2 manifest */
+export declare const IMAGE_MANIFEST_MEDIA_TYPE: string
+
+/**
+ * Data returned from pulling an image.
+ * Wraps native `ImageData`.
+ */
+export interface ImageData {
+  /** The layers of the image */
+  layers: Array<ImageLayer>
+  /** The digest of the image (if available) */
+  digest?: string
+  /** The configuration object of the image */
+  config: Config
+  /** The manifest (if available) */
+  manifest?: ImageManifest
+}
+
+/** OCI Image Index (manifest list). */
+export interface ImageIndex {
+  /** Schema version (always 2) */
+  schemaVersion: number
+  /** Media type of this manifest */
+  mediaType?: string
+  /** List of manifests for specific platforms */
+  manifests: Array<ManifestEntry>
+  /** Artifact type */
+  artifactType?: string
+  /** Annotations */
+  annotations?: Record<string, string>
+}
+
+/**
+ * An image layer with data and metadata.
+ * Wraps native `ImageLayer`.
+ */
+export interface ImageLayer {
+  /** The layer data as raw bytes */
+  data: Buffer
+  /** The media type of this layer */
+  mediaType: string
+  /** Optional annotations for this layer */
+  annotations?: Record<string, string>
+}
+
+/** OCI Image Manifest. */
+export interface ImageManifest {
+  /** Schema version (always 2) */
+  schemaVersion: number
+  /** Media type of this manifest */
+  mediaType?: string
+  /** The image configuration descriptor */
+  config: Descriptor
+  /** The image layers */
+  layers: Array<Descriptor>
+  /** Subject descriptor (for referrers) */
+  subject?: Descriptor
+  /** Artifact type */
+  artifactType?: string
+  /** Annotations */
+  annotations?: Record<string, string>
+}
+
+/**
+ * OCI Manifest - can be either an Image manifest or an ImageIndex.
+ * Check `manifest_type` to determine which field is populated.
+ */
+export interface Manifest {
+  /** The type of manifest */
+  manifestType: ManifestType
+  /** The image manifest (populated when manifest_type is Image) */
+  image?: ImageManifest
+  /** The image index (populated when manifest_type is ImageIndex) */
+  imageIndex?: ImageIndex
+}
+
+/** An entry in an image index manifest. */
+export interface ManifestEntry {
+  /** Media type of the manifest */
+  mediaType: string
+  /** Digest of the manifest */
+  digest: string
+  /** Size in bytes */
+  size: number
+  /** Platform specification */
+  platform?: PlatformSpec
+  /** Annotations */
+  annotations?: Record<string, string>
+  /** Optional artifact type for referrers */
+  artifactType?: string
+}
+
+/** Manifest type discriminator. */
+export enum ManifestType {
+  /** An OCI image manifest */
+  Image = 'Image',
+  /** An OCI image index (manifest list) */
+  ImageIndex = 'ImageIndex',
+}
+
+/** The mediatype for an OCI image index manifest */
+export declare const OCI_IMAGE_INDEX_MEDIA_TYPE: string
+
+/** The mediatype for an OCI image manifest */
+export declare const OCI_IMAGE_MEDIA_TYPE: string
+
+export type OciBindingError =
+  | { type: 'Distribution'; field0: OciDistributionError }
+  | { type: 'Parse'; field0: ParseError }
+
+export type OciDistributionError =
+  | { type: 'AuthenticationFailure'; message: string; cause?: ErrorCause }
+  | { type: 'ConfigConversionError'; message: string; cause?: ErrorCause }
+  | { type: 'DigestError'; message: string; cause?: ErrorCause }
+  | { type: 'GenericError'; message: string; cause?: ErrorCause }
+  | { type: 'HeaderValueError'; message: string; cause?: ErrorCause }
+  | { type: 'ImageIndexParsingNoPlatformResolverError'; message: string; cause?: ErrorCause }
+  | { type: 'ImageManifestNotFoundError'; message: string; cause?: ErrorCause; image: string }
+  | { type: 'IncompatibleLayerMediaTypeError'; message: string; cause?: ErrorCause }
+  | { type: 'IoError'; message: string; cause?: ErrorCause }
+  | { type: 'JsonError'; message: string; cause?: ErrorCause }
+  | { type: 'ManifestEncodingError'; message: string; cause?: ErrorCause }
+  | { type: 'ManifestParsingError'; message: string; cause?: ErrorCause }
+  | { type: 'PullNoLayersError'; message: string; cause?: ErrorCause }
+  | { type: 'PushLayerNoDataError'; message: string; cause?: ErrorCause }
+  | { type: 'PushNoDataError'; message: string; cause?: ErrorCause }
+  | { type: 'RegistryError'; message: string; cause?: ErrorCause; url: string; errors: Array<OciRegistryError> }
+  | { type: 'RegistryNoDigestError'; message: string; cause?: ErrorCause }
+  | { type: 'RegistryNoLocationError'; message: string; cause?: ErrorCause }
+  | { type: 'RegistryTokenDecodeError'; message: string; cause?: ErrorCause }
+  | { type: 'RequestError'; message: string; cause?: ErrorCause }
+  | { type: 'ServerError'; message: string; cause?: ErrorCause; statusCode: number; url: string; serverMessage: string }
+  | { type: 'SpecViolationError'; message: string; cause?: ErrorCause }
+  | { type: 'UnauthorizedError'; message: string; cause?: ErrorCause; url: string }
+  | { type: 'UrlParseError'; message: string; cause?: ErrorCause }
+  | { type: 'UnsupportedMediaTypeError'; message: string; cause?: ErrorCause }
+  | { type: 'UnsupportedSchemaVersionError'; message: string; cause?: ErrorCause }
+  | { type: 'VersionedParsingError'; message: string; cause?: ErrorCause }
+
+/**
+ * Known OCI Distribution Spec error codes.
+ *
+ * Unknown registry codes are not represented here — they appear as plain
+ * strings on `OciRegistryError.code`.
+ */
+export enum OciErrorCode {
+  BlobUnknown = 'BlobUnknown',
+  BlobUploadInvalid = 'BlobUploadInvalid',
+  BlobUploadUnknown = 'BlobUploadUnknown',
+  DigestInvalid = 'DigestInvalid',
+  ManifestBlobUnknown = 'ManifestBlobUnknown',
+  ManifestInvalid = 'ManifestInvalid',
+  ManifestUnknown = 'ManifestUnknown',
+  ManifestUnverified = 'ManifestUnverified',
+  NameInvalid = 'NameInvalid',
+  NameUnknown = 'NameUnknown',
+  NotFound = 'NotFound',
+  SizeInvalid = 'SizeInvalid',
+  TagInvalid = 'TagInvalid',
+  Unauthorized = 'Unauthorized',
+  Denied = 'Denied',
+  Unsupported = 'Unsupported',
+  Toomanyrequests = 'Toomanyrequests',
+}
+
+export interface OciRegistryError {
+  /**
+   * Known codes are the `OciErrorCode` string values; unknown registry
+   * codes are arbitrary strings. Uses `` `${OciErrorCode}` | (string & {}) ``
+   * so TypeScript expands the enum to a string-literal union (for
+   * autocomplete) without collapsing to plain `string`.
+   */
+  code: `${OciErrorCode}` | (string & {})
+  message: string
+  detail: string
+}
+
+/** Contact details of the people or organization responsible for the image (freeform string) */
+export declare const ORG_OPENCONTAINERS_IMAGE_AUTHORS: string
+
+/** Digest of the image this image is based on (string) */
+export declare const ORG_OPENCONTAINERS_IMAGE_BASE_DIGEST: string
+
+/** Image reference of the image this image is based on (string) */
+export declare const ORG_OPENCONTAINERS_IMAGE_BASE_NAME: string
+
+/** Date and time on which the image was built (string, date-time as defined by RFC 3339) */
+export declare const ORG_OPENCONTAINERS_IMAGE_CREATED: string
+
+/** Human-readable description of the software packaged in the image (string) */
+export declare const ORG_OPENCONTAINERS_IMAGE_DESCRIPTION: string
+
+/** URL to get documentation on the image (string) */
+export declare const ORG_OPENCONTAINERS_IMAGE_DOCUMENTATION: string
+
+/** License(s) under which contained software is distributed as an SPDX License Expression */
+export declare const ORG_OPENCONTAINERS_IMAGE_LICENSES: string
+
+/** Name of the reference for a target (string) */
+export declare const ORG_OPENCONTAINERS_IMAGE_REF_NAME: string
+
+/** Source control revision identifier for the packaged software */
+export declare const ORG_OPENCONTAINERS_IMAGE_REVISION: string
+
+/** URL to get source code for building the image (string) */
+export declare const ORG_OPENCONTAINERS_IMAGE_SOURCE: string
+
+/** Human-readable title of the image (string) */
+export declare const ORG_OPENCONTAINERS_IMAGE_TITLE: string
+
+/** URL to find more information on the image (string) */
+export declare const ORG_OPENCONTAINERS_IMAGE_URL: string
+
+/** Name of the distributing entity, organization or individual */
+export declare const ORG_OPENCONTAINERS_IMAGE_VENDOR: string
+
+/** Version of the packaged software */
+export declare const ORG_OPENCONTAINERS_IMAGE_VERSION: string
+
+export type ParseError =
+  | { type: 'DigestInvalidFormat'; message: string; cause?: ErrorCause }
+  | { type: 'DigestInvalidLength'; message: string; cause?: ErrorCause }
+  | { type: 'DigestUnsupported'; message: string; cause?: ErrorCause }
+  | { type: 'NameContainsUppercase'; message: string; cause?: ErrorCause }
+  | { type: 'NameEmpty'; message: string; cause?: ErrorCause }
+  | { type: 'NameTooLong'; message: string; cause?: ErrorCause }
+  | { type: 'ReferenceInvalidFormat'; message: string; cause?: ErrorCause }
+  | { type: 'TagInvalidFormat'; message: string; cause?: ErrorCause }
+
+/**
+ * Platform filter for selecting a specific platform from multi-platform images.
+ * When set, the client will automatically select the matching platform from Image Index manifests.
+ */
+export interface PlatformFilter {
+  /** Operating system (e.g., "linux", "windows", "darwin") */
+  os: string
+  /** CPU architecture (e.g., "amd64", "arm64", "arm") */
+  architecture: string
+  /** Optional variant (e.g., "v7" for arm/v7) */
+  variant?: string
+}
+
+/** Platform specification for an image. */
+export interface PlatformSpec {
+  /** CPU architecture */
+  architecture: string
+  /** Operating system */
+  os: string
+  /** OS version */
+  osVersion?: string
+  /** OS features */
+  osFeatures?: Array<string>
+  /** CPU variant */
+  variant?: string
+  /** Additional features */
+  features?: Array<string>
+}
+
+/** Result from pull_image_manifest_and_list_digest. */
+export interface PullImageManifestAndListDigestResult {
+  /** The pulled image manifest */
+  manifest: ImageManifest
+  /** The digest of the manifest */
+  digest: string
+  /** The digest of the parent manifest list/image index, if the manifest was resolved from one */
+  listDigest?: string
+}
+
+/** Result from pull_image_manifest containing both manifest and digest. */
+export interface PullImageManifestResult {
+  /** The pulled image manifest */
+  manifest: ImageManifest
+  /** The digest of the manifest */
+  digest: string
+}
+
+/** Result from pull_manifest_and_config_and_list_digest. */
+export interface PullManifestAndConfigAndListDigestResult {
+  /** The pulled image manifest */
+  manifest: ImageManifest
+  /** The digest of the manifest */
+  digest: string
+  /** The config JSON as a string */
+  config: string
+  /** The digest of the parent manifest list/image index, if the manifest was resolved from one */
+  listDigest?: string
+}
+
+/** Result from pull_manifest containing both manifest and digest. */
+export interface PullManifestResult {
+  /** The pulled manifest */
+  manifest: Manifest
+  /** The digest of the manifest */
+  digest: string
+}
+
+/**
+ * Response from pushing an image.
+ * Wraps native `PushResponse`.
+ */
+export interface PushResponse {
+  /** Pullable URL for the config */
+  configUrl: string
+  /** Pullable URL for the manifest */
+  manifestUrl: string
+}
+
+/**
+ * Registry authentication configuration.
+ * Use `auth_type` to specify the authentication method.
+ */
+export interface RegistryAuth {
+  /** The type of authentication to use */
+  authType: RegistryAuthType
+  /** Username for Basic auth (required when auth_type is Basic) */
+  username?: string
+  /** Password for Basic auth (required when auth_type is Basic) */
+  password?: string
+  /** Token for Bearer auth (required when auth_type is Bearer) */
+  token?: string
+}
+
+/**
+ * Authentication method for registry access.
+ * Wraps native `RegistryAuth`.
+ */
+export enum RegistryAuthType {
+  /** Access the registry anonymously */
+  Anonymous = 'Anonymous',
+  /** Access the registry using HTTP Basic authentication */
+  Basic = 'Basic',
+  /** Access the registry using Bearer token authentication */
+  Bearer = 'Bearer',
+}
+
+/** The mediatype for a WASM image config */
+export declare const WASM_CONFIG_MEDIA_TYPE: string
+
+/** The mediatype for WASM layers */
+export declare const WASM_LAYER_MEDIA_TYPE: string