API reference#

import { publishUpdate } from '@sigx/lynx-updates-publisher';
import type {
  PublishUpdateOptions,
  PublishUpdateResult,
  PublishPlatform,
} from '@sigx/lynx-updates-publisher';

export function publishUpdate(opts: PublishUpdateOptions): Promise<PublishUpdateResult>;

export interface PublishUpdateOptions {
  /** Project root. Used to resolve relative paths and the sidecar. */
  cwd: string;
  /** Bundle path (absolute, or relative to `cwd`). Default: `dist/main.lynx.bundle`. */
  bundle?: string;
  /** Output directory (absolute, or relative to `cwd`). Default: `updates-dist`. */
  out?: string;
  /** Release channel. Default: `'production'`. */
  channel?: string;
  /** Human-readable JS app version stamped on the entry. Default: `'0.0.0'`. */
  appVersion?: string;
  /** Mark this update mandatory (blocking UI + forced install). Default: false. */
  mandatory?: boolean;
  /** Release notes attached as `metadata.releaseNotes`. */
  notes?: string;
  /**
   * Override the runtime-version fingerprint for BOTH platforms. Takes
   * precedence over `runtimeVersions` and the sidecar.
   */
  runtimeVersion?: string;
  /**
   * Explicit per-platform runtime-version fingerprints. Takes precedence over
   * the `.sigx/runtime-versions.json` sidecar — provide this in CI when the
   * fingerprints are computed elsewhere.
   */
  runtimeVersions?: { android?: string; ios?: string };
}

export interface PublishUpdateResult {
  /** Content-addressed update id (`sha256.slice(0, 16)`). */
  updateId: string;
  /** Full hex SHA-256 of the bundle bytes (verified natively after download). */
  sha256: string;
  /** Relative bundle URL written into the manifest entries. */
  bundleUrl: string;
  /** Absolute path the bundle was read from. */
  bundlePath: string;
  /** Absolute path of the written `manifest.json`. */
  manifestPath: string;
  /** Resolved release channel. */
  channel: string;
  /** Resolved app version stamped on the entries. */
  appVersion: string;
  /** Bundle size in bytes. */
  sizeBytes: number;
  /** Whether the entries were marked mandatory. */
  mandatory: boolean;
  /** ISO-8601 timestamp stamped on the published entries. */
  createdAt: string;
  /** The (platform, runtimeVersion) entries written this publish. */
  runtimeVersions: Array<{ platform: PublishPlatform; runtimeVersion: string }>;
}

export type PublishPlatform = 'android' | 'ios';