@kanonak-protocol/cli 8.2.0 → 8.4.0

package/dist/commands/install.d.ts

@@ -9,7 +9,9 @@ import { FileCache } from '../cache/FileCache.js';
  * Installing `publisher/package` installs exactly the version that lock pins
  * plus the closure it pins, verifying every fetched file against the lock's
  * sha256 before caching (the `npm ci` model). There is no version-range
- * selection: the publisher's lock IS the resolution.
+ * selection here: the publisher's lock IS the resolution. `kanonak lock`
+ * writes a folder's lock from the ranges its packages state, and
+ * `kanonak install` with no package installs exactly that lock.
  *
  * Where the bytes come from is the consumer's choice when it configured
  * package URL templates (#130): a new install records the template's URL in
@@ -28,7 +30,9 @@ import { FileCache } from '../cache/FileCache.js';
  *
  * A refusal throws; the CLI reports it and exits 1.
  */
-export declare function installCommand(packageRef?: string): Promise<void>;
+export declare function installCommand(packageRef?: string, options?: {
+    frozen?: boolean;
+}): Promise<void>;
 /**
  * Ensure a pinned package is in the cache: a cache hit is verified against the
  * lock's integrity; a miss is fetched through `publisherIndex` (the user's

package/dist/commands/lock.d.ts

@@ -0,0 +1,21 @@
+import { KanonakParser } from '@kanonak-protocol/sdk';
+import type { KanonakDocument } from '@kanonak-protocol/types/document/models';
+/**
+ * `kanonak lock` — write the `kanonak.lock` of the packages in this folder.
+ *
+ * Every dependency import, transitively, is locked at the newest version
+ * every range on its package admits, from the publishers' locks and their
+ * lines (`resolveLock`). Every range is resolved again each time the lock is
+ * written, so its diff shows each move for review. Every version is checked
+ * against its sha256 and cached, and `kanonak install` then installs exactly
+ * what the lock pins.
+ *
+ * The lock is the folder's packages' and nothing else's: an entry none of
+ * them reaches, such as one `kanonak install {publisher}/{package}` added,
+ * leaves it. Where the bytes come from is the consumer's choice when it
+ * configured package URL templates (#130). A refusal throws; the CLI reports
+ * it and exits 1.
+ */
+export declare function lockCommand(): Promise<void>;
+/** The Kanonak packages in `folder`, each parsed; one that doesn't parse throws, naming its file. */
+export declare function readPackages(folder: string, parser: KanonakParser): KanonakDocument[];

package/dist/commands/upgrade.d.ts

@@ -0,0 +1,17 @@
+/**
+ * `kanonak upgrade` — raise each import's floor in the newest version of every
+ * package in this folder to the newest version its range admits, and import
+ * each built-in home whose terms it names, as a new version of the package
+ * (`planUpgrade`). Upgrading is editing the text: what a version reads is
+ * stated in it, so a newer dependency reaches a package only through a
+ * version that states it.
+ *
+ * A source named for its version, `{version}.kan.yml` or
+ * `{package}@{version}.kan.yml`, is a published version whose bytes never
+ * change, so the new version is written beside it under its own name. Any
+ * other source is the package's one file, and is edited in place. With
+ * `check`, nothing is written, and it exits 1 when anything would change.
+ */
+export declare function upgradeCommand(options: {
+    check?: boolean;
+}): Promise<void>;