@stim-cli/core 1.13.0 → 1.15.0

package/dist/ownership-claim-Xxxr9MPp.d.mts

@@ -0,0 +1,152 @@
+import { r as ProcessRecord } from "./process-identity-BTyww2Xj.mjs";
+//#region ownership-claim.d.ts
+type ClaimMode = "exclusive" | "shared";
+interface ClaimDetails {
+  readonly [key: string]: unknown;
+}
+interface ClaimOwner {
+  pid: number;
+  processToken: string;
+}
+interface ClaimHolder {
+  path: string;
+  claimId: string;
+  mode: ClaimMode;
+  owner: ClaimOwner;
+  startedAt: string;
+  details: ClaimDetails;
+  child: ClaimOwner | null;
+  childDeclared: boolean;
+}
+interface ClaimHandle {
+  root: string;
+  path: string;
+  claimId: string;
+  mode: ClaimMode;
+  owner: ClaimOwner;
+  startedAt: string;
+  details: ClaimDetails;
+  label: string;
+}
+interface ClaimAttempt {
+  acquired?: ClaimHandle;
+  held?: ClaimHolder;
+  waitingFor?: ClaimHolder[];
+  pending?: ClaimHandle;
+  reaped: ClaimHolder[];
+}
+interface ClaimSetState {
+  exclusive: ClaimHolder | null;
+  shared: ClaimHolder[];
+  reaped: ClaimHolder[];
+}
+interface ClaimProblem {
+  path: string;
+  reason: string;
+}
+interface ClaimSurvey {
+  live: ClaimHolder[];
+  dead: ClaimHolder[];
+  unresolved: ClaimProblem[];
+  orphans: string[];
+}
+interface ClaimOptions {
+  root: string;
+  mode: ClaimMode;
+  details?: ClaimDetails;
+  label?: string;
+}
+declare const CLAIM_REFUSED = "STIM_CLAIM_REFUSED";
+declare const CLAIM_UNAVAILABLE = "STIM_CLAIM_UNAVAILABLE";
+declare class ClaimRefusedError extends Error {
+  readonly code: string;
+  readonly claimPath: string;
+  readonly reason: string;
+  readonly removeCommand: string;
+  constructor({ claimPath, root, reason, label, blockingFile }: {
+    claimPath: string;
+    root: string;
+    reason: string;
+    label: string;
+    blockingFile?: boolean;
+  });
+}
+declare class ClaimUnavailableError extends Error {
+  readonly code: string;
+  readonly reason: string;
+  readonly remedy: string;
+  constructor(reason: string, { claimPath }?: {
+    claimPath?: string;
+  });
+}
+/**
+ * The command that clears one surveyed claim: targeted at the claim's own file when the path names one,
+ * and quoted, because this text is printed for a human to copy into a shell and a path with a space in
+ * it would otherwise name several targets.
+ */
+declare function claimRemoveCommand(path: string): string;
+declare function isClaimRefusal(err: unknown): err is ClaimRefusedError;
+declare function isClaimUnavailable(err: unknown): err is ClaimUnavailableError;
+interface ClaimFailure {
+  code: string;
+  message: string;
+  remedy: string;
+}
+/** Convert an unresolved claim, unavailable identity or inaccessible warm claim store into command recovery guidance. */
+declare function claimFailure(err: unknown, retryCommand: string | null): ClaimFailure | null;
+declare function exclusiveClaimDir(root: string): string;
+declare function sharedClaimDir(root: string): string;
+/**
+ * Whether any member of the process group `pid` leads is alive. A recorded child is resolved through
+ * its group rather than through the one process, so a package manager's postinstall descendant keeps
+ * the claim after the manager exits. A pgid, unlike a ProcessRecord, carries no identity: a recycled
+ * one reads as alive, which holds a claim longer than it needs to be held and never frees a live one.
+ */
+declare function processGroupAlive(pid: number): boolean;
+type Liveness = "live" | "dead" | "unknown";
+declare function claimLiveness(holder: ClaimHolder): Liveness;
+/** Classify every claim in a claim set without removing anything and without refusing. */
+declare function readClaimSet(root: string): ClaimSurvey;
+declare function inspectClaimSet(root: string, { label }?: {
+  label?: string;
+}): ClaimSetState;
+type ClaimSetClearance = {
+  status: "cleared";
+} | {
+  status: "held";
+  holder: ClaimHolder | null;
+} | {
+  status: "refused";
+  reason: string;
+} | {
+  status: "failed";
+  reason: string;
+};
+/**
+ * Remove a claim set that holds nothing. Takes the set's own exclusive claim first and removes the set
+ * only through the token-verified unlink and empty-directory removals that releasing a claim performs,
+ * so a claim published between the survey that reported the set stale and this call is kept, not
+ * deleted; a set whose state cannot be established is refused rather than removed.
+ */
+declare function clearFreeClaimSet({ root, label }: {
+  root: string;
+  label?: string;
+}): ClaimSetClearance;
+declare function tryAcquireClaim({ root, mode, details, label }: ClaimOptions): ClaimAttempt;
+declare function settleClaim(pending: ClaimHandle): ClaimAttempt;
+declare function releaseClaim(handle: ClaimHandle | null | undefined): boolean;
+/**
+ * Declare that this claim is about to spawn the process that does the real work, before the spawn.
+ * A claim marked this way and left without a child record reads as unresolvable rather than as free,
+ * so a parent killed between the spawn and the record cannot release a claim its child still needs.
+ */
+declare function markClaimChildPending(handle: ClaimHandle): void;
+/**
+ * Record the spawned process that holds this claim. Spawn it with `detached: true` so it leads its own
+ * process group: the claim then reads as held while any member of that group is alive, which is what
+ * keeps a package manager's postinstall child covered after the manager itself exits.
+ */
+declare function setClaimChild(handle: ClaimHandle, record: ProcessRecord): void;
+declare function clearClaimChild(handle: ClaimHandle): void;
+//#endregion
+export { setClaimChild as A, inspectClaimSet as C, processGroupAlive as D, markClaimChildPending as E, sharedClaimDir as M, tryAcquireClaim as N, readClaimSet as O, exclusiveClaimDir as S, isClaimUnavailable as T, claimFailure as _, ClaimFailure as a, clearClaimChild as b, ClaimMode as c, ClaimProblem as d, ClaimRefusedError as f, ClaimUnavailableError as g, ClaimSurvey as h, ClaimDetails as i, settleClaim as j, releaseClaim as k, ClaimOptions as l, ClaimSetState as m, CLAIM_UNAVAILABLE as n, ClaimHandle as o, ClaimSetClearance as p, ClaimAttempt as r, ClaimHolder as s, CLAIM_REFUSED as t, ClaimOwner as u, claimLiveness as v, isClaimRefusal as w, clearFreeClaimSet as x, claimRemoveCommand as y };

package/dist/ownership-claim.d.mts

@@ -1,152 +1,2 @@
-import { ProcessRecord } from "./process-identity.mjs";
-//#region ownership-claim.d.ts
-type ClaimMode = "exclusive" | "shared";
-interface ClaimDetails {
-  readonly [key: string]: unknown;
-}
-interface ClaimOwner {
-  pid: number;
-  processToken: string;
-}
-interface ClaimHolder {
-  path: string;
-  claimId: string;
-  mode: ClaimMode;
-  owner: ClaimOwner;
-  startedAt: string;
-  details: ClaimDetails;
-  child: ClaimOwner | null;
-  childDeclared: boolean;
-}
-interface ClaimHandle {
-  root: string;
-  path: string;
-  claimId: string;
-  mode: ClaimMode;
-  owner: ClaimOwner;
-  startedAt: string;
-  details: ClaimDetails;
-  label: string;
-}
-interface ClaimAttempt {
-  acquired?: ClaimHandle;
-  held?: ClaimHolder;
-  waitingFor?: ClaimHolder[];
-  pending?: ClaimHandle;
-  reaped: ClaimHolder[];
-}
-interface ClaimSetState {
-  exclusive: ClaimHolder | null;
-  shared: ClaimHolder[];
-  reaped: ClaimHolder[];
-}
-interface ClaimProblem {
-  path: string;
-  reason: string;
-}
-interface ClaimSurvey {
-  live: ClaimHolder[];
-  dead: ClaimHolder[];
-  unresolved: ClaimProblem[];
-  orphans: string[];
-}
-interface ClaimOptions {
-  root: string;
-  mode: ClaimMode;
-  details?: ClaimDetails;
-  label?: string;
-}
-declare const CLAIM_REFUSED = "STIM_CLAIM_REFUSED";
-declare const CLAIM_UNAVAILABLE = "STIM_CLAIM_UNAVAILABLE";
-declare class ClaimRefusedError extends Error {
-  readonly code: string;
-  readonly claimPath: string;
-  readonly reason: string;
-  readonly removeCommand: string;
-  constructor({ claimPath, root, reason, label, blockingFile }: {
-    claimPath: string;
-    root: string;
-    reason: string;
-    label: string;
-    blockingFile?: boolean;
-  });
-}
-declare class ClaimUnavailableError extends Error {
-  readonly code: string;
-  readonly reason: string;
-  readonly remedy: string;
-  constructor(reason: string, { claimPath }?: {
-    claimPath?: string;
-  });
-}
-/**
- * The command that clears one surveyed claim: targeted at the claim's own file when the path names one,
- * and quoted, because this text is printed for a human to copy into a shell and a path with a space in
- * it would otherwise name several targets.
- */
-declare function claimRemoveCommand(path: string): string;
-declare function isClaimRefusal(err: unknown): err is ClaimRefusedError;
-declare function isClaimUnavailable(err: unknown): err is ClaimUnavailableError;
-interface ClaimFailure {
-  code: string;
-  message: string;
-  remedy: string;
-}
-/** Convert an unresolved claim, unavailable identity or inaccessible warm claim store into command recovery guidance. */
-declare function claimFailure(err: unknown, retryCommand: string | null): ClaimFailure | null;
-declare function exclusiveClaimDir(root: string): string;
-declare function sharedClaimDir(root: string): string;
-/**
- * Whether any member of the process group `pid` leads is alive. A recorded child is resolved through
- * its group rather than through the one process, so a package manager's postinstall descendant keeps
- * the claim after the manager exits. A pgid, unlike a ProcessRecord, carries no identity: a recycled
- * one reads as alive, which holds a claim longer than it needs to be held and never frees a live one.
- */
-declare function processGroupAlive(pid: number): boolean;
-type Liveness = "live" | "dead" | "unknown";
-declare function claimLiveness(holder: ClaimHolder): Liveness;
-/** Classify every claim in a claim set without removing anything and without refusing. */
-declare function readClaimSet(root: string): ClaimSurvey;
-declare function inspectClaimSet(root: string, { label }?: {
-  label?: string;
-}): ClaimSetState;
-type ClaimSetClearance = {
-  status: "cleared";
-} | {
-  status: "held";
-  holder: ClaimHolder | null;
-} | {
-  status: "refused";
-  reason: string;
-} | {
-  status: "failed";
-  reason: string;
-};
-/**
- * Remove a claim set that holds nothing. Takes the set's own exclusive claim first and removes the set
- * only through the token-verified unlink and empty-directory removals that releasing a claim performs,
- * so a claim published between the survey that reported the set stale and this call is kept, not
- * deleted; a set whose state cannot be established is refused rather than removed.
- */
-declare function clearFreeClaimSet({ root, label }: {
-  root: string;
-  label?: string;
-}): ClaimSetClearance;
-declare function tryAcquireClaim({ root, mode, details, label }: ClaimOptions): ClaimAttempt;
-declare function settleClaim(pending: ClaimHandle): ClaimAttempt;
-declare function releaseClaim(handle: ClaimHandle | null | undefined): boolean;
-/**
- * Declare that this claim is about to spawn the process that does the real work, before the spawn.
- * A claim marked this way and left without a child record reads as unresolvable rather than as free,
- * so a parent killed between the spawn and the record cannot release a claim its child still needs.
- */
-declare function markClaimChildPending(handle: ClaimHandle): void;
-/**
- * Record the spawned process that holds this claim. Spawn it with `detached: true` so it leads its own
- * process group: the claim then reads as held while any member of that group is alive, which is what
- * keeps a package manager's postinstall child covered after the manager itself exits.
- */
-declare function setClaimChild(handle: ClaimHandle, record: ProcessRecord): void;
-declare function clearClaimChild(handle: ClaimHandle): void;
-//#endregion
+import { A as setClaimChild, C as inspectClaimSet, D as processGroupAlive, E as markClaimChildPending, M as sharedClaimDir, N as tryAcquireClaim, O as readClaimSet, S as exclusiveClaimDir, T as isClaimUnavailable, _ as claimFailure, a as ClaimFailure, b as clearClaimChild, c as ClaimMode, d as ClaimProblem, f as ClaimRefusedError, g as ClaimUnavailableError, h as ClaimSurvey, i as ClaimDetails, j as settleClaim, k as releaseClaim, l as ClaimOptions, m as ClaimSetState, n as CLAIM_UNAVAILABLE, o as ClaimHandle, p as ClaimSetClearance, r as ClaimAttempt, s as ClaimHolder, t as CLAIM_REFUSED, u as ClaimOwner, v as claimLiveness, w as isClaimRefusal, x as clearFreeClaimSet, y as claimRemoveCommand } from "./ownership-claim-Xxxr9MPp.mjs";
 export { CLAIM_REFUSED, CLAIM_UNAVAILABLE, ClaimAttempt, ClaimDetails, ClaimFailure, ClaimHandle, ClaimHolder, ClaimMode, ClaimOptions, ClaimOwner, ClaimProblem, ClaimRefusedError, ClaimSetClearance, ClaimSetState, ClaimSurvey, ClaimUnavailableError, claimFailure, claimLiveness, claimRemoveCommand, clearClaimChild, clearFreeClaimSet, exclusiveClaimDir, inspectClaimSet, isClaimRefusal, isClaimUnavailable, markClaimChildPending, processGroupAlive, readClaimSet, releaseClaim, setClaimChild, settleClaim, sharedClaimDir, tryAcquireClaim };