@software-dlc/cli 0.157.2

package/dist/packages-browse.d.ts

@@ -0,0 +1,107 @@
+import { type ContentHash, type ContentType, type ContentTypeRegistry, type GraphPackageVersionDocument, type PackageSource } from '@software-dlc/graph/packages';
+/** Splits `@scope/name@1.2.0` into its coordinate and version; the version is optional. */
+export declare function parsePackageSpec(spec: string): {
+    coordinate: string;
+    version: string | null;
+};
+/**
+ * Browsing graph packages offline (docs/specs/graph-packages.md, Browsing and Offline to online):
+ * `sdlc packages list|show|diff` read the bundled snapshot (generated/graph-packages, which the
+ * build writes from graph-packages.lock.json) and the download cache, with no account and no
+ * network. `sdlc packages fetch` reads public indexes and downloads newer versions into the cache.
+ * Every document is checked against its content hash before it is shown.
+ */
+export declare const BROWSE_ACTIONS: string[];
+export declare const PACKAGES_BROWSE_USAGE: string;
+type Output = {
+    write(text: string): unknown;
+};
+export type PackagesBrowseContext = {
+    env?: NodeJS.ProcessEnv;
+    fetchImpl?: typeof fetch;
+    stdout?: Output;
+    stderr?: Output;
+    /** The bundled snapshot folder; by default the one built beside this module. */
+    snapshotDir?: string;
+    /** The content types this sdlc knows; by default the published registry. */
+    registry?: ContentTypeRegistry;
+};
+/** The bundled snapshot as built: `generated/graph-packages` of the installed package. */
+export declare function defaultGraphPackagesSnapshotDir(): string;
+export type HeldVersion = {
+    version: string;
+    content_hash: ContentHash;
+    source: 'bundled' | 'cached';
+    document: GraphPackageVersionDocument;
+};
+export type IndexedVersion = {
+    version: string;
+    content_hash: string;
+    withdrawn: boolean;
+    withdrawn_reason: string | null;
+};
+export type LocalPackage = {
+    id: string;
+    /** As the newest document held, or the fetched index when it is newer. */
+    coordinate: string;
+    content_type: string;
+    owner_slug: string;
+    display_name: string;
+    description: string | null;
+    /** Newest first. */
+    held: HeldVersion[];
+    /** The last public index `fetch` kept, or null when none was fetched. */
+    index: {
+        visibility: string | null;
+        versions: IndexedVersion[];
+        latest: string | null;
+    } | null;
+};
+export type LocalPackages = {
+    packages: LocalPackage[];
+    /** Problems that did not stop the read: a tampered or unreadable cache file, a missing snapshot. */
+    warnings: string[];
+};
+/**
+ * Every package held here: the bundled snapshot's versions, then the download cache's, each
+ * checked against its content hash. A bundled version that fails its hash is an error (the install
+ * is damaged); a cached one is reported and skipped.
+ */
+export declare function readLocalPackages(options: {
+    snapshotDir: string;
+    cacheDir: string;
+}): LocalPackages;
+/**
+ * The resolver's package source over what is held here (graph-packages.md, Local resolution).
+ * Every held document was checked against its hash when it was read. Neither a version
+ * document nor the public index carries the import policy yet, so it is unknown here.
+ */
+export declare function localPackageSource(local: LocalPackages): PackageSource;
+/** The package a coordinate (or package id) names, or a refusal naming what is held. */
+export declare function findLocalPackage(local: LocalPackages, name: string): LocalPackage;
+export declare function withdrawnOf(entry: LocalPackage, version: string): IndexedVersion | null;
+/** The version `show` opens by default: the index's latest when held, else the newest held that is not withdrawn. */
+export declare function defaultHeldVersion(entry: LocalPackage): HeldVersion;
+export declare function heldVersion(entry: LocalPackage, version: string): HeldVersion;
+/** A content type this sdlc does not know: its content drawn by the default view, unmarked. */
+export declare function contentTypeFor(registry: ContentTypeRegistry, id: string): {
+    type: ContentType;
+    known: boolean;
+};
+export type LineageLink = {
+    package_id: string;
+    version: string;
+    mode: string;
+    /** The coordinate, when the base is held here. */
+    coordinate: string | null;
+    available: boolean;
+};
+/** The base chain of a version, as far as the bases are held here, at most eight links. */
+export declare function lineageOf(local: LocalPackages, document: GraphPackageVersionDocument): {
+    links: LineageLink[];
+    truncated: boolean;
+};
+/** `sdlc packages list|show|diff|fetch`: the exit code. */
+export declare function runPackagesBrowseCommand(args: string[], context?: PackagesBrowseContext): Promise<number>;
+export {};
+//# sourceMappingURL=packages-browse.d.ts.map

package/dist/packages-browse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"packages-browse.d.ts","sourceRoot":"","sources":["../src/packages-browse.ts"],"names":[],"mappings":"AAMA,OAAO,EAUL,KAAK,WAAW,EAChB,KAAK,WAAW,EAChB,KAAK,mBAAmB,EACxB,KAAK,2BAA2B,EAEhC,KAAK,aAAa,EAEnB,MAAM,8BAA8B,CAAC;AAmBtC,2FAA2F;AAC3F,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG;IAC9C,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB,CAQA;AAED;;;;;;GAMG;AAEH,eAAO,MAAM,cAAc,UAAoC,CAAC;AAEhE,eAAO,MAAM,qBAAqB,QAWsB,CAAC;AAEzD,KAAK,MAAM,GAAG;IAAE,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAAC;AAE/C,MAAM,MAAM,qBAAqB,GAAG;IAClC,GAAG,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;IACxB,SAAS,CAAC,EAAE,OAAO,KAAK,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gFAAgF;IAChF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,4EAA4E;IAC5E,QAAQ,CAAC,EAAE,mBAAmB,CAAC;CAChC,CAAC;AAEF,0FAA0F;AAC1F,wBAAgB,+BAA+B,IAAI,MAAM,CAExD;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,WAAW,CAAC;IAC1B,MAAM,EAAE,SAAS,GAAG,QAAQ,CAAC;IAC7B,QAAQ,EAAE,2BAA2B,CAAC;CACvC,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,OAAO,CAAC;IACnB,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,0EAA0E;IAC1E,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,oBAAoB;IACpB,IAAI,EAAE,WAAW,EAAE,CAAC;IACpB,yEAAyE;IACzE,KAAK,EAAE;QACL,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAC1B,QAAQ,EAAE,cAAc,EAAE,CAAC;QAC3B,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB,GAAG,IAAI,CAAC;CACV,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,QAAQ,EAAE,YAAY,EAAE,CAAC;IACzB,oGAAoG;IACpG,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE;IACzC,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;CAClB,GAAG,aAAa,CA+EhB;AAqGD;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,aAAa,GAAG,aAAa,CAYtE;AAED,wFAAwF;AACxF,wBAAgB,gBAAgB,CAC9B,KAAK,EAAE,aAAa,EACpB,IAAI,EAAE,MAAM,GACX,YAAY,CASd;AAED,wBAAgB,WAAW,CACzB,KAAK,EAAE,YAAY,EACnB,OAAO,EAAE,MAAM,GACd,cAAc,GAAG,IAAI,CAGvB;AAED,qHAAqH;AACrH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,YAAY,GAAG,WAAW,CAUnE;AAeD,wBAAgB,WAAW,CAAC,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,GAAG,WAAW,CAM7E;AAED,+FAA+F;AAC/F,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,mBAAmB,EAC7B,EAAE,EAAE,MAAM,GACT;IACD,IAAI,EAAE,WAAW,CAAC;IAClB,KAAK,EAAE,OAAO,CAAC;CAChB,CAmBA;AAID,MAAM,MAAM,WAAW,GAAG;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,kDAAkD;IAClD,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,SAAS,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,2FAA2F;AAC3F,wBAAgB,SAAS,CACvB,KAAK,EAAE,aAAa,EACpB,QAAQ,EAAE,2BAA2B,GACpC;IAAE,KAAK,EAAE,WAAW,EAAE,CAAC;IAAC,SAAS,EAAE,OAAO,CAAA;CAAE,CAmB9C;AAED,2DAA2D;AAC3D,wBAAsB,wBAAwB,CAC5C,IAAI,EAAE,MAAM,EAAE,EACd,OAAO,GAAE,qBAA0B,GAClC,OAAO,CAAC,MAAM,CAAC,CAwDjB"}