@linxin666/dsh-remote-web-ui 0.4.2 → 0.4.4

package/lib/types/update.d.ts

@@ -1,282 +0,0 @@
-/**
- * Remote update support for the dsh-web family — host half. Detects the
- * installed aggregate package (@linxin666/dsh-web-all), or the directly
- * installed family packages when the aggregate is absent, probes npm for newer
- * releases, and runs `pnpm update --latest` inside the owning dsh profile.
- *
- * Pure logic with injected seams (manifest reading, registry fetches, process
- * spawning) so the whole surface is unit-testable without touching disk,
- * network, or a real profile.
- */
-import { spawn } from 'node:child_process';
-/** npm registry base used for version probes. */
-export declare const NPM_REGISTRY = "https://registry.npmjs.org";
-/** The family scope every dsh-web package is published under. */
-export declare const FAMILY_SCOPE = "@linxin666/";
-/** The aggregate package that is the canonical update entry point. */
-export declare const AGGREGATE_PACKAGE = "@linxin666/dsh-web-all";
-/** Fallback anchor: this plugin's own package when the aggregate is absent. */
-export declare const SELF_PACKAGE = "@linxin666/dsh-remote-web-ui";
-/** GitHub repository used to surface human-readable release notes. */
-export declare const UPDATE_RELEASE_REPO = "zhu1090093659/dsh-web";
-/** Release-notes cache freshness window (host process). */
-export declare const RELEASE_NOTES_CACHE_TTL_MS: number;
-/** A parsed semantic version (prerelease identifiers kept as strings). */
-export interface SemverParts {
-    major: number;
-    minor: number;
-    patch: number;
-    /** Dot-split prerelease identifiers; empty when absent. */
-    prerelease: string[];
-}
-/**
- * Parse a semantic version string (leading `v` tolerated, build metadata
- * ignored). Returns undefined for unparseable input.
- * @param value - the version string, e.g. `0.1.10` or `0.1.11-rc.1`.
- * @returns the parsed parts, or undefined.
- */
-export declare function parseSemver(value: string): SemverParts | undefined;
-/**
- * Compare two semantic versions per the semver precedence rules (a release
- * outranks any of its prereleases; numeric prerelease identifiers compare
- * numerically and sort below alphanumeric ones). An unparseable version sorts
- * below every parseable one; two unparseable versions compare equal.
- * @param a - first version.
- * @param b - second version.
- * @returns negative when a < b, 0 when equal, positive when a > b.
- */
-export declare function compareVersions(a: string, b: string): number;
-/** The found dsh profile owning an installed package. */
-export interface FoundProfile {
-    /** Profile name (e.g. `web`). */
-    name: string;
-    /** Absolute profile directory. */
-    dir: string;
-}
-/**
- * Locate the owning dsh profile by walking up from an installed package's
- * manifest until a manifest named `dsh-profile-*` appears (the profile
- * directory is the first ancestor whose package.json carries that name).
- * @param anchorManifestPath - absolute path of the anchor package.json.
- * @returns the profile name/dir, or undefined when not profile-installed.
- */
-export declare function findProfile(anchorManifestPath: string): FoundProfile | undefined;
-/** A package version spec in a manifest dependencies map. */
-type DependencySpec = string | {
-    version: string;
-} | undefined;
-/** Whether a dependency spec is a local link/file/dev-mode install. */
-export declare function isLinkedSpec(spec: DependencySpec): boolean;
-/** One package's current-vs-latest comparison. */
-export interface UpdatePackageStatus {
-    /** Package name. */
-    name: string;
-    /** Locally installed version. */
-    current: string;
-    /** Latest npm release — undefined when the registry probe failed. */
-    latest?: string;
-    /** Whether npm carries a strictly newer release. */
-    outdated: boolean;
-}
-/** Structured release-note sections shown in the update panel. */
-export interface UpdateReleaseNotes {
-    /** Version the notes describe. */
-    version: string;
-    /** New feature bullets. */
-    features: string[];
-    /** Bug-fix bullets. */
-    fixes: string[];
-    /** Other-change bullets. */
-    other: string[];
-}
-/** The full update-status snapshot served to the browser half. */
-export interface UpdateStatus {
-    /** npm = registry-managed (updatable); link = local dev install; missing = no anchor package. */
-    mode: 'npm' | 'link' | 'missing';
-    /** Owning profile name (npm mode). */
-    profileName?: string;
-    /** The anchor package the update targets. */
-    anchor?: string;
-    /** Per-package version comparison (anchor first). */
-    packages: UpdatePackageStatus[];
-    /** True when any package has a newer npm release. */
-    outdated: boolean;
-    /** Human-readable release notes for the target release, when available. */
-    notes?: UpdateReleaseNotes;
-    /** Whole-check failure (e.g. registry unreachable). */
-    error?: string;
-}
-/** Dependency-injection seam for checkUpdates (testable without network). */
-export interface UpdateCheckDeps {
-    /** Absolute path of the anchor package manifest, when resolvable. */
-    anchorManifestPath?: string;
-    /** Resolve a package.json specifier to its absolute path (host require). */
-    resolve(specifier: string): string | undefined;
-    /** Probe one package's latest npm version; undefined on failure. */
-    fetchLatest(name: string): Promise<string | undefined>;
-    /** Fetch structured release notes for one target version, when available. */
-    fetchReleaseNotes?(version: string): Promise<UpdateReleaseNotes | undefined>;
-}
-/**
- * Resolve the anchor package's manifest path. The aggregate package is the
- * canonical entry point; this plugin's own package is the fallback. Both a
- * throwing resolve and an undefined return mean "not installed" and move on
- * to the next candidate.
- * @param resolve - a Node resolve implementation scoped to the host process.
- * @returns the absolute manifest path, or undefined when neither is installed.
- */
-export declare function resolveAnchorManifest(resolve: (specifier: string) => string | undefined): string | undefined;
-/** The resolved update target: the profile pnpm runs in plus the package list. */
-export interface UpdateTarget {
-    /** Owning profile name. */
-    profileName: string;
-    /** Absolute profile directory pnpm runs in. */
-    profileDir: string;
-    /** The package names pnpm updates (anchor first). */
-    packages: string[];
-}
-/**
- * Resolve what an update would touch: the owning profile directory and the
- * family package list. Fails with an error code when the anchor is missing
- * ('not-found') or is a local dev install ('link').
- * @param deps - the anchor manifest path (resolveAnchorManifest output).
- * @returns the target, or the failure code.
- */
-export declare function resolveUpdateTarget(deps: {
-    anchorManifestPath?: string;
-}): UpdateTarget | {
-    error: 'not-found' | 'link';
-};
-/** Family children of the anchor: its dependencies under the family scope. */
-export declare function familyChildren(anchorManifest: Record<string, unknown>): string[];
-/** Concurrent registry probes in flight for one update-status call. */
-export declare const UPDATE_PROBE_CONCURRENCY = 4;
-/**
- * Probe every package's latest version with a bounded number of requests in
- * flight, preserving the caller's order in the result.
- * @param names - package names to probe.
- * @param fetchLatest - the probe for one package (returns undefined on failure).
- * @returns one result per name, in the input order.
- */
-export declare function probeLatestVersions(names: readonly string[], fetchLatest: (name: string) => Promise<string | undefined>): Promise<(string | undefined)[]>;
-/**
- * Probe the npm registry for one package's latest release.
- * @param name - the package name (scope slash URL-encoded).
- * @param fetchImpl - the fetch implementation (global fetch in the host).
- * @param timeoutMs - probe timeout.
- * @returns the latest version string, or undefined on any failure.
- */
-export declare function fetchLatestVersion(name: string, fetchImpl: (url: string, init?: RequestInit) => Promise<{
-    ok: boolean;
-    json(): Promise<unknown>;
-}>, timeoutMs?: number): Promise<string | undefined>;
-export declare function parseReleaseNotesBody(version: string, body: string): UpdateReleaseNotes | undefined;
-/**
- * Fetch and parse the GitHub Release for one `dsh-web` version.
- * @param version - the npm release version (without the `v` prefix).
- * @param fetchImpl - injected fetch; global `fetch` in the host.
- * @param timeoutMs - hard timeout for the GitHub API probe.
- * @returns structured notes, or undefined when unavailable.
- */
-export declare function fetchGitHubReleaseNotes(version: string, fetchImpl?: (url: string, init?: RequestInit) => Promise<{
-    ok: boolean;
-    json(): Promise<unknown>;
-}>, timeoutMs?: number): Promise<UpdateReleaseNotes | undefined>;
-/**
- * Build the update status: locate the anchor, detect the install mode, and
- * compare every family package against the npm registry.
- * @param deps - manifest resolution + registry probe seams.
- * @returns the status snapshot.
- */
-export declare function checkUpdates(deps: UpdateCheckDeps): Promise<UpdateStatus>;
-/** Structured failure codes the browser half translates. */
-export type UpdateErrorCode = 
-/** pnpm is not on PATH. */
-'pnpm-missing'
-/** The install exceeded the hard timeout. */
- | 'timeout'
-/** The anchor package is not installed. */
- | 'not-found'
-/** The anchor is a local link/dev install pnpm cannot update. */
- | 'link'
-/** pnpm exited non-zero. */
- | 'pnpm-failed'
-/** pnpm exited 0 but the installed versions did not move. */
- | 'stale'
-/** pnpm exited 0 but the post-run version check could not verify the install. */
- | 'verify-failed';
-/** Result of one update run. */
-export interface UpdateRunResult {
-    ok: boolean;
-    /** pnpm exit code (null when the process never started or was killed). */
-    exitCode: number | null;
-    /** Captured pnpm output tail (diagnostics for the panel). */
-    output: string;
-    /** Human-readable failure description (fallback copy). */
-    error?: string;
-    /** Structured failure code (translated by the browser half). */
-    errorCode?: UpdateErrorCode;
-}
-/** Dependency-injection seam for runUpdate. */
-export interface UpdateRunDeps {
-    /** The profile directory pnpm runs in. */
-    profileDir: string;
-    /** The package names pnpm updates. */
-    packages: readonly string[];
-    /** Spawn seam (defaults to child_process.spawn). */
-    spawnImpl?: typeof spawn;
-    /** Hard timeout; the child is killed on expiry. */
-    timeoutMs?: number;
-    /** Platform override (defaults to process.platform; test seam). */
-    platform?: NodeJS.Platform;
-    /** Process-group kill seam (defaults to process.kill; test seam). */
-    killImpl?: KillImpl;
-}
-/** Seam for the process-group kill (tests inject a recorder). */
-export type KillImpl = (pid: number, signal: NodeJS.Signals) => void;
-/**
- * Run the update inside the profile directory. Tries pnpm first, falls back
- * to corepack and then npx when the previous command is missing (ENOENT);
- * all candidates share one hard timeout and keep accumulating output.
- * @param deps - profile dir, package list, and spawn/timeout seams.
- * @returns the outcome with captured output.
- */
-export declare function runUpdate(deps: UpdateRunDeps): Promise<UpdateRunResult>;
-/** Seam set for the verified update run (run + post-run status check). */
-export interface UpdateRunVerifiedDeps {
-    /** The pnpm run (profile dir + package list). */
-    run: UpdateRunDeps;
-    /** The post-run status check (same seams as checkUpdates). */
-    check: UpdateCheckDeps;
-}
-/**
- * Run the update, then verify the installed versions actually moved. pnpm
- * exits 0 even when it silently kept the installed versions — runUpdate
- * overrides pnpm 11's `minimumReleaseAge` gate (default 24 h) with
- * `--config.minimumReleaseAge=0`, but an older pnpm without the override or
- * another silent no-op can still keep versions in place — so a green exit
- * alone must not report a misleading "update complete". Re-read the
- * installed versions afterwards and surface a `stale` failure (with the
- * captured pnpm output) when nothing moved, so the panel can tell the user
- * how to unblock the gate instead of claiming success.
- *
- * The stale decision anchors on the pre-run installed versions, not on the
- * registry latest: under a lenient gate pnpm may move 0.1.12 -> 0.1.13 while
- * latest stays 0.1.15 — that is a real update, not stale. The post-run anchor
- * path is re-resolved rather than reused from boot time: pnpm removes the old
- * version's .pnpm directory on update, so a boot-time captured path would
- * fail to read and collapse a successful update into a bogus 'missing'.
- *
- * A green exit whose verification has nothing to compare (registry probe
- * outage, missing anchor, non-npm mode) is reported as `verify-failed` — it
- * must never read as success. A green exit where no package moved but the
- * post-run check could not prove the install is fully current (a partial
- * probe failure hides whether a gate kept something back) is also
- * `verify-failed`: it must not collapse into a success either.
- * @param deps - the run and check seams.
- * @returns the run result; `stale` when exit 0 left every version in place,
- * `verify-failed` when the post-run check could not verify anything.
- */
-export declare function runUpdateVerified(deps: UpdateRunVerifiedDeps): Promise<UpdateRunResult>;
-export {};
-//# sourceMappingURL=update.d.ts.map

package/lib/types/update.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"update.d.ts","sourceRoot":"","sources":["../../src/update.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAIH,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAA;AAI1C,iDAAiD;AACjD,eAAO,MAAM,YAAY,+BAA+B,CAAA;AAExD,iEAAiE;AACjE,eAAO,MAAM,YAAY,gBAAgB,CAAA;AAEzC,sEAAsE;AACtE,eAAO,MAAM,iBAAiB,2BAA2B,CAAA;AAEzD,+EAA+E;AAC/E,eAAO,MAAM,YAAY,iCAAiC,CAAA;AAE1D,sEAAsE;AACtE,eAAO,MAAM,mBAAmB,0BAA0B,CAAA;AAE1D,2DAA2D;AAC3D,eAAO,MAAM,0BAA0B,QAAc,CAAA;AAQrD,0EAA0E;AAC1E,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,2DAA2D;IAC3D,UAAU,EAAE,MAAM,EAAE,CAAA;CACrB;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS,CASlE;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CA2B5D;AAYD,yDAAyD;AACzD,MAAM,WAAW,YAAY;IAC3B,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,kCAAkC;IAClC,GAAG,EAAE,MAAM,CAAA;CACZ;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,kBAAkB,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,CAahF;AAED,6DAA6D;AAC7D,KAAK,cAAc,GAAG,MAAM,GAAG;IAAE,OAAO,EAAE,MAAM,CAAA;CAAE,GAAG,SAAS,CAAA;AAE9D,uEAAuE;AACvE,wBAAgB,YAAY,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAG1D;AAcD,kDAAkD;AAClD,MAAM,WAAW,mBAAmB;IAClC,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAA;IACZ,iCAAiC;IACjC,OAAO,EAAE,MAAM,CAAA;IACf,qEAAqE;IACrE,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,oDAAoD;IACpD,QAAQ,EAAE,OAAO,CAAA;CAClB;AAED,kEAAkE;AAClE,MAAM,WAAW,kBAAkB;IACjC,kCAAkC;IAClC,OAAO,EAAE,MAAM,CAAA;IACf,2BAA2B;IAC3B,QAAQ,EAAE,MAAM,EAAE,CAAA;IAClB,uBAAuB;IACvB,KAAK,EAAE,MAAM,EAAE,CAAA;IACf,4BAA4B;IAC5B,KAAK,EAAE,MAAM,EAAE,CAAA;CAChB;AAED,kEAAkE;AAClE,MAAM,WAAW,YAAY;IAC3B,iGAAiG;IACjG,IAAI,EAAE,KAAK,GAAG,MAAM,GAAG,SAAS,CAAA;IAChC,sCAAsC;IACtC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,6CAA6C;IAC7C,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,qDAAqD;IACrD,QAAQ,EAAE,mBAAmB,EAAE,CAAA;IAC/B,qDAAqD;IACrD,QAAQ,EAAE,OAAO,CAAA;IACjB,2EAA2E;IAC3E,KAAK,CAAC,EAAE,kBAAkB,CAAA;IAC1B,uDAAuD;IACvD,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,6EAA6E;AAC7E,MAAM,WAAW,eAAe;IAC9B,qEAAqE;IACrE,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,4EAA4E;IAC5E,OAAO,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;IAC9C,oEAAoE;IACpE,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;IACtD,6EAA6E;IAC7E,iBAAiB,CAAC,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,GAAG,SAAS,CAAC,CAAA;CAC7E;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CACnC,OAAO,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,GACjD,MAAM,GAAG,SAAS,CAUpB;AAED,kFAAkF;AAClF,MAAM,WAAW,YAAY;IAC3B,2BAA2B;IAC3B,WAAW,EAAE,MAAM,CAAA;IACnB,+CAA+C;IAC/C,UAAU,EAAE,MAAM,CAAA;IAClB,qDAAqD;IACrD,QAAQ,EAAE,MAAM,EAAE,CAAA;CACnB;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CACjC,IAAI,EAAE;IAAE,kBAAkB,CAAC,EAAE,MAAM,CAAA;CAAE,GACpC,YAAY,GAAG;IAAE,KAAK,EAAE,WAAW,GAAG,MAAM,CAAA;CAAE,CAoBhD;AAED,8EAA8E;AAC9E,wBAAgB,cAAc,CAAC,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,EAAE,CAQhF;AAiBD,uEAAuE;AACvE,eAAO,MAAM,wBAAwB,IAAI,CAAA;AAEzC;;;;;;GAMG;AACH,wBAAsB,mBAAmB,CACvC,KAAK,EAAE,SAAS,MAAM,EAAE,EACxB,WAAW,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,GACzD,OAAO,CAAC,CAAC,MAAM,GAAG,SAAS,CAAC,EAAE,CAAC,CAajC;AAED;;;;;;GAMG;AACH,wBAAsB,kBAAkB,CACtC,IAAI,EAAE,MAAM,EACZ,SAAS,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC;IAAE,EAAE,EAAE,OAAO,CAAC;IAAC,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC,CAAA;CAAE,CAAC,EAClG,SAAS,SAAS,GACjB,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAiB7B;AA8CD,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,kBAAkB,GAAG,SAAS,CAMnG;AAED;;;;;;GAMG;AACH,wBAAsB,uBAAuB,CAC3C,OAAO,EAAE,MAAM,EACf,SAAS,GAAE,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC;IAAE,EAAE,EAAE,OAAO,CAAC;IAAC,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC,CAAA;CAAE,CAAS,EAC1G,SAAS,SAAS,GACjB,OAAO,CAAC,kBAAkB,GAAG,SAAS,CAAC,CAqBzC;AA4BD;;;;;GAKG;AACH,wBAAsB,YAAY,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,YAAY,CAAC,CAiE/E;AAED,4DAA4D;AAC5D,MAAM,MAAM,eAAe;AACzB,2BAA2B;AACzB,cAAc;AAChB,6CAA6C;GAC3C,SAAS;AACX,2CAA2C;GACzC,WAAW;AACb,iEAAiE;GAC/D,MAAM;AACR,4BAA4B;GAC1B,aAAa;AACf,6DAA6D;GAC3D,OAAO;AACT,iFAAiF;GAC/E,eAAe,CAAA;AAEnB,gCAAgC;AAChC,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,OAAO,CAAA;IACX,0EAA0E;IAC1E,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,6DAA6D;IAC7D,MAAM,EAAE,MAAM,CAAA;IACd,0DAA0D;IAC1D,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,gEAAgE;IAChE,SAAS,CAAC,EAAE,eAAe,CAAA;CAC5B;AAED,+CAA+C;AAC/C,MAAM,WAAW,aAAa;IAC5B,0CAA0C;IAC1C,UAAU,EAAE,MAAM,CAAA;IAClB,sCAAsC;IACtC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAA;IAC3B,oDAAoD;IACpD,SAAS,CAAC,EAAE,OAAO,KAAK,CAAA;IACxB,mDAAmD;IACnD,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,mEAAmE;IACnE,QAAQ,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAA;IAC1B,qEAAqE;IACrE,QAAQ,CAAC,EAAE,QAAQ,CAAA;CACpB;AAaD,iEAAiE;AACjE,MAAM,MAAM,QAAQ,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,OAAO,KAAK,IAAI,CAAA;AAgCpE;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,eAAe,CAAC,CAmKvE;AAED,0EAA0E;AAC1E,MAAM,WAAW,qBAAqB;IACpC,iDAAiD;IACjD,GAAG,EAAE,aAAa,CAAA;IAClB,8DAA8D;IAC9D,KAAK,EAAE,eAAe,CAAA;CACvB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAsB,iBAAiB,CAAC,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,eAAe,CAAC,CAgE7F"}