@jsonjoy.com/json-pack 1.21.0 → 17.59.0

package/lib/nfs/v4/server/operations/ByteRangeLock.js.map

@@ -1 +1 @@
-{"version":3,"file":"ByteRangeLock.js","sourceRoot":"","sources":["../../../../../src/nfs/v4/server/operations/ByteRangeLock.ts"],"names":[],"mappings":";;;AAMA,MAAa,aAAa;IACxB,YAKkB,OAA4B,EAM5B,IAAY,EAOZ,QAAgB,EAMhB,MAAc,EAMd,MAAc,EAOd,YAAoB;QAhCpB,YAAO,GAAP,OAAO,CAAqB;QAM5B,SAAI,GAAJ,IAAI,CAAQ;QAOZ,aAAQ,GAAR,QAAQ,CAAQ;QAMhB,WAAM,GAAN,MAAM,CAAQ;QAMd,WAAM,GAAN,MAAM,CAAQ;QAOd,iBAAY,GAAZ,YAAY,CAAQ;IACnC,CAAC;IAQG,QAAQ,CAAC,MAAc,EAAE,MAAc;QAC5C,MAAM,UAAU,GAAG,MAAM,CAAC,oBAAoB,CAAC,CAAC;QAChD,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QACpF,MAAM,QAAQ,GAAG,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,MAAM,GAAG,QAAQ,IAAI,MAAM,GAAG,OAAO,CAAC;IACpD,CAAC;CACF;AArDD,sCAqDC"}
+{"version":3,"file":"ByteRangeLock.js","sourceRoot":"","sources":["../../../../../src/nfs/v4/server/operations/ByteRangeLock.ts"],"names":[],"mappings":";;;AAEA;;;GAGG;AACH,MAAa,aAAa;IACxB;IACE;;;OAGG;IACa,OAA4B;IAE5C;;;OAGG;IACa,IAAY;IAE5B;;;;OAIG;IACa,QAAgB;IAEhC;;;OAGG;IACa,MAAc;IAE9B;;;OAGG;IACa,MAAc;IAE9B;;;;OAIG;IACa,YAAoB;QAhCpB,YAAO,GAAP,OAAO,CAAqB;QAM5B,SAAI,GAAJ,IAAI,CAAQ;QAOZ,aAAQ,GAAR,QAAQ,CAAQ;QAMhB,WAAM,GAAN,MAAM,CAAQ;QAMd,WAAM,GAAN,MAAM,CAAQ;QAOd,iBAAY,GAAZ,YAAY,CAAQ;IACnC,CAAC;IAEJ;;;;;OAKG;IACI,QAAQ,CAAC,MAAc,EAAE,MAAc;QAC5C,MAAM,UAAU,GAAG,MAAM,CAAC,oBAAoB,CAAC,CAAC;QAChD,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QACpF,MAAM,QAAQ,GAAG,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,MAAM,GAAG,QAAQ,IAAI,MAAM,GAAG,OAAO,CAAC;IACpD,CAAC;CACF;AArDD,sCAqDC"}

package/lib/nfs/v4/server/operations/ClientRecord.d.ts

@@ -1,13 +1,110 @@
 import type * as msg from '../../messages';
 import type * as struct from '../../structs';
+/** Client state record for NFS v4 client registration. */
 export declare class ClientRecord {
+    /**
+     * Principal associated with this client (from RPC credentials).
+     */
     readonly principal: string;
+    /**
+     * Client verifier - used to detect client reboots.
+     * If client sends SETCLIENTID with same clientIdString but different verifier,
+     * it indicates the client rebooted and old state should be discarded.
+     * Size 8 bytes (NFS4_VERIFIER_SIZE) buffer.
+     */
     readonly verifier: Uint8Array;
+    /**
+     * Client identifier string - globally unique client identity.
+     * Typically contains hostname or other unique data.
+     * Used to find existing client records across SETCLIENTID calls.
+     */
     readonly clientIdString: Uint8Array;
+    /**
+     * Callback information - RPC program number and network address.
+     * Used by server to initiate callbacks to client (e.g., for delegation recalls).
+     * Server opens new TCP connection to client using this address when needed.
+     */
     readonly callback: struct.Nfsv4CbClient;
+    /**
+     * Callback identifier - client-provided value.
+     * Sent by server in callback RPCs to help client distinguish which
+     * server is calling back (useful if client talks to multiple servers).
+     */
     readonly callbackIdent: number;
+    /**
+     * SETCLIENTID confirmation verifier - random 8-byte token.
+     * Generated by server, returned to client, must be echoed back in
+     * SETCLIENTID_CONFIRM to prove client received the SETCLIENTID response.
+     * Prevents race conditions and stale client ID reuse.
+     *
+     *     const NFS4_VERIFIER_SIZE        = 8;
+     *     typedef opaque  verifier4[NFS4_VERIFIER_SIZE];
+     */
     readonly setclientidConfirm: Uint8Array;
+    /**
+     * Cached SETCLIENTID response for duplicate request handling.
+     * If a client repeats a SETCLIENTID request (same clientIdString and verifier),
+     * server can return this cached response instead of creating a new record.
+     * This helps handle network retries and duplicate requests gracefully.
+     */
     cache: msg.Nfsv4SetclientidResponse | undefined;
+    /**
+     * Last time this client renewed its lease (in milliseconds since epoch).
+     * Per RFC 7530 §9.5, any stateful operation from the client renews the lease.
+     * The server must track this to detect expired leases and revoke client state.
+     */
     lastRenew: number;
-    constructor(principal: string, verifier: Uint8Array, clientIdString: Uint8Array, callback: struct.Nfsv4CbClient, callbackIdent: number, setclientidConfirm: Uint8Array, cache?: msg.Nfsv4SetclientidResponse | undefined, lastRenew?: number);
+    constructor(
+    /**
+     * Principal associated with this client (from RPC credentials).
+     */
+    principal: string, 
+    /**
+     * Client verifier - used to detect client reboots.
+     * If client sends SETCLIENTID with same clientIdString but different verifier,
+     * it indicates the client rebooted and old state should be discarded.
+     * Size 8 bytes (NFS4_VERIFIER_SIZE) buffer.
+     */
+    verifier: Uint8Array, 
+    /**
+     * Client identifier string - globally unique client identity.
+     * Typically contains hostname or other unique data.
+     * Used to find existing client records across SETCLIENTID calls.
+     */
+    clientIdString: Uint8Array, 
+    /**
+     * Callback information - RPC program number and network address.
+     * Used by server to initiate callbacks to client (e.g., for delegation recalls).
+     * Server opens new TCP connection to client using this address when needed.
+     */
+    callback: struct.Nfsv4CbClient, 
+    /**
+     * Callback identifier - client-provided value.
+     * Sent by server in callback RPCs to help client distinguish which
+     * server is calling back (useful if client talks to multiple servers).
+     */
+    callbackIdent: number, 
+    /**
+     * SETCLIENTID confirmation verifier - random 8-byte token.
+     * Generated by server, returned to client, must be echoed back in
+     * SETCLIENTID_CONFIRM to prove client received the SETCLIENTID response.
+     * Prevents race conditions and stale client ID reuse.
+     *
+     *     const NFS4_VERIFIER_SIZE        = 8;
+     *     typedef opaque  verifier4[NFS4_VERIFIER_SIZE];
+     */
+    setclientidConfirm: Uint8Array, 
+    /**
+     * Cached SETCLIENTID response for duplicate request handling.
+     * If a client repeats a SETCLIENTID request (same clientIdString and verifier),
+     * server can return this cached response instead of creating a new record.
+     * This helps handle network retries and duplicate requests gracefully.
+     */
+    cache?: msg.Nfsv4SetclientidResponse | undefined, 
+    /**
+     * Last time this client renewed its lease (in milliseconds since epoch).
+     * Per RFC 7530 §9.5, any stateful operation from the client renews the lease.
+     * The server must track this to detect expired leases and revoke client state.
+     */
+    lastRenew?: number);
 }

package/lib/nfs/v4/server/operations/ClientRecord.js

@@ -1,8 +1,61 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ClientRecord = void 0;
+/** Client state record for NFS v4 client registration. */
 class ClientRecord {
-    constructor(principal, verifier, clientIdString, callback, callbackIdent, setclientidConfirm, cache = undefined, lastRenew = Date.now()) {
+    constructor(
+    /**
+     * Principal associated with this client (from RPC credentials).
+     */
+    principal, 
+    /**
+     * Client verifier - used to detect client reboots.
+     * If client sends SETCLIENTID with same clientIdString but different verifier,
+     * it indicates the client rebooted and old state should be discarded.
+     * Size 8 bytes (NFS4_VERIFIER_SIZE) buffer.
+     */
+    verifier, 
+    /**
+     * Client identifier string - globally unique client identity.
+     * Typically contains hostname or other unique data.
+     * Used to find existing client records across SETCLIENTID calls.
+     */
+    clientIdString, 
+    /**
+     * Callback information - RPC program number and network address.
+     * Used by server to initiate callbacks to client (e.g., for delegation recalls).
+     * Server opens new TCP connection to client using this address when needed.
+     */
+    callback, 
+    /**
+     * Callback identifier - client-provided value.
+     * Sent by server in callback RPCs to help client distinguish which
+     * server is calling back (useful if client talks to multiple servers).
+     */
+    callbackIdent, 
+    /**
+     * SETCLIENTID confirmation verifier - random 8-byte token.
+     * Generated by server, returned to client, must be echoed back in
+     * SETCLIENTID_CONFIRM to prove client received the SETCLIENTID response.
+     * Prevents race conditions and stale client ID reuse.
+     *
+     *     const NFS4_VERIFIER_SIZE        = 8;
+     *     typedef opaque  verifier4[NFS4_VERIFIER_SIZE];
+     */
+    setclientidConfirm, 
+    /**
+     * Cached SETCLIENTID response for duplicate request handling.
+     * If a client repeats a SETCLIENTID request (same clientIdString and verifier),
+     * server can return this cached response instead of creating a new record.
+     * This helps handle network retries and duplicate requests gracefully.
+     */
+    cache = undefined, 
+    /**
+     * Last time this client renewed its lease (in milliseconds since epoch).
+     * Per RFC 7530 §9.5, any stateful operation from the client renews the lease.
+     * The server must track this to detect expired leases and revoke client state.
+     */
+    lastRenew = Date.now()) {
         this.principal = principal;
         this.verifier = verifier;
         this.clientIdString = clientIdString;

package/lib/nfs/v4/server/operations/ClientRecord.js.map

@@ -1 +1 @@
-{"version":3,"file":"ClientRecord.js","sourceRoot":"","sources":["../../../../../src/nfs/v4/server/operations/ClientRecord.ts"],"names":[],"mappings":";;;AAIA,MAAa,YAAY;IACvB,YAIkB,SAAiB,EAQjB,QAAoB,EAOpB,cAA0B,EAO1B,QAA8B,EAO9B,aAAqB,EAWrB,kBAA8B,EAQvC,QAAkD,SAAS,EAO3D,YAAoB,IAAI,CAAC,GAAG,EAAE;QAvDrB,cAAS,GAAT,SAAS,CAAQ;QAQjB,aAAQ,GAAR,QAAQ,CAAY;QAOpB,mBAAc,GAAd,cAAc,CAAY;QAO1B,aAAQ,GAAR,QAAQ,CAAsB;QAO9B,kBAAa,GAAb,aAAa,CAAQ;QAWrB,uBAAkB,GAAlB,kBAAkB,CAAY;QAQvC,UAAK,GAAL,KAAK,CAAsD;QAO3D,cAAS,GAAT,SAAS,CAAqB;IACpC,CAAC;CACL;AA9DD,oCA8DC"}
+{"version":3,"file":"ClientRecord.js","sourceRoot":"","sources":["../../../../../src/nfs/v4/server/operations/ClientRecord.ts"],"names":[],"mappings":";;;AAGA,0DAA0D;AAC1D,MAAa,YAAY;IACvB;IACE;;OAEG;IACa,SAAiB;IAEjC;;;;;OAKG;IACa,QAAoB;IAEpC;;;;OAIG;IACa,cAA0B;IAE1C;;;;OAIG;IACa,QAA8B;IAE9C;;;;OAIG;IACa,aAAqB;IAErC;;;;;;;;OAQG;IACa,kBAA8B;IAE9C;;;;;OAKG;IACI,QAAkD,SAAS;IAElE;;;;OAIG;IACI,YAAoB,IAAI,CAAC,GAAG,EAAE;QAvDrB,cAAS,GAAT,SAAS,CAAQ;QAQjB,aAAQ,GAAR,QAAQ,CAAY;QAOpB,mBAAc,GAAd,cAAc,CAAY;QAO1B,aAAQ,GAAR,QAAQ,CAAsB;QAO9B,kBAAa,GAAb,aAAa,CAAQ;QAWrB,uBAAkB,GAAlB,kBAAkB,CAAY;QAQvC,UAAK,GAAL,KAAK,CAAsD;QAO3D,cAAS,GAAT,SAAS,CAAqB;IACpC,CAAC;CACL;AA9DD,oCA8DC"}

package/lib/nfs/v4/server/operations/FilesystemStats.d.ts

@@ -1,9 +1,30 @@
+/**
+ * Filesystem statistics for NFSv4 space and file count attributes.
+ */
 export declare class FilesystemStats {
+    /** Available space in bytes for unprivileged users */
     readonly spaceAvail: bigint;
+    /** Free space in bytes on the filesystem */
     readonly spaceFree: bigint;
+    /** Total space in bytes on the filesystem */
     readonly spaceTotal: bigint;
+    /** Available file slots (inodes) */
     readonly filesAvail: bigint;
+    /** Free file slots (inodes) */
     readonly filesFree: bigint;
+    /** Total file slots (inodes) */
     readonly filesTotal: bigint;
-    constructor(spaceAvail: bigint, spaceFree: bigint, spaceTotal: bigint, filesAvail: bigint, filesFree: bigint, filesTotal: bigint);
+    constructor(
+    /** Available space in bytes for unprivileged users */
+    spaceAvail: bigint, 
+    /** Free space in bytes on the filesystem */
+    spaceFree: bigint, 
+    /** Total space in bytes on the filesystem */
+    spaceTotal: bigint, 
+    /** Available file slots (inodes) */
+    filesAvail: bigint, 
+    /** Free file slots (inodes) */
+    filesFree: bigint, 
+    /** Total file slots (inodes) */
+    filesTotal: bigint);
 }

package/lib/nfs/v4/server/operations/FilesystemStats.js

@@ -1,8 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FilesystemStats = void 0;
+/**
+ * Filesystem statistics for NFSv4 space and file count attributes.
+ */
 class FilesystemStats {
-    constructor(spaceAvail, spaceFree, spaceTotal, filesAvail, filesFree, filesTotal) {
+    constructor(
+    /** Available space in bytes for unprivileged users */
+    spaceAvail, 
+    /** Free space in bytes on the filesystem */
+    spaceFree, 
+    /** Total space in bytes on the filesystem */
+    spaceTotal, 
+    /** Available file slots (inodes) */
+    filesAvail, 
+    /** Free file slots (inodes) */
+    filesFree, 
+    /** Total file slots (inodes) */
+    filesTotal) {
         this.spaceAvail = spaceAvail;
         this.spaceFree = spaceFree;
         this.spaceTotal = spaceTotal;

package/lib/nfs/v4/server/operations/FilesystemStats.js.map

@@ -1 +1 @@
-{"version":3,"file":"FilesystemStats.js","sourceRoot":"","sources":["../../../../../src/nfs/v4/server/operations/FilesystemStats.ts"],"names":[],"mappings":";;;AAGA,MAAa,eAAe;IAC1B,YAEkB,UAAkB,EAElB,SAAiB,EAEjB,UAAkB,EAElB,UAAkB,EAElB,SAAiB,EAEjB,UAAkB;QAVlB,eAAU,GAAV,UAAU,CAAQ;QAElB,cAAS,GAAT,SAAS,CAAQ;QAEjB,eAAU,GAAV,UAAU,CAAQ;QAElB,eAAU,GAAV,UAAU,CAAQ;QAElB,cAAS,GAAT,SAAS,CAAQ;QAEjB,eAAU,GAAV,UAAU,CAAQ;IACjC,CAAC;CACL;AAfD,0CAeC"}
+{"version":3,"file":"FilesystemStats.js","sourceRoot":"","sources":["../../../../../src/nfs/v4/server/operations/FilesystemStats.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,MAAa,eAAe;IAC1B;IACE,sDAAsD;IACtC,UAAkB;IAClC,4CAA4C;IAC5B,SAAiB;IACjC,6CAA6C;IAC7B,UAAkB;IAClC,oCAAoC;IACpB,UAAkB;IAClC,+BAA+B;IACf,SAAiB;IACjC,gCAAgC;IAChB,UAAkB;QAVlB,eAAU,GAAV,UAAU,CAAQ;QAElB,cAAS,GAAT,SAAS,CAAQ;QAEjB,eAAU,GAAV,UAAU,CAAQ;QAElB,eAAU,GAAV,UAAU,CAAQ;QAElB,cAAS,GAAT,SAAS,CAAQ;QAEjB,eAAU,GAAV,UAAU,CAAQ;IACjC,CAAC;CACL;AAfD,0CAeC"}

package/lib/nfs/v4/server/operations/LockOwnerState.d.ts

@@ -1,9 +1,82 @@
+/**
+ * Lock-owner state record for NFSv4 LOCK operations.
+ * A lock-owner represents a single entity (process, thread) on a client
+ * that can acquire byte-range locks on files. Tracks all locks held by this owner.
+ */
 export declare class LockOwnerState {
+    /**
+     * Client ID that owns this lock-owner.
+     * Links the owner back to the specific NFS client that created it.
+     */
     readonly clientid: bigint;
+    /**
+     * Opaque lock-owner identifier provided by the client.
+     * Typically represents a process or thread ID on the client.
+     * Combined with clientid, uniquely identifies this lock-owner.
+     */
     readonly owner: Uint8Array;
+    /**
+     * Sequence number for operations from this lock-owner.
+     * Used to serialize LOCK/LOCKU operations.
+     * Incremented after each successful stateful operation.
+     * Server rejects operations with incorrect sequence numbers to prevent replays.
+     */
     seqid: number;
+    /**
+     * Set of lock keys for all byte-range locks currently held by this owner.
+     * Format: lock keys are `${stateid}:${offset}:${length}`.
+     * Used to track all active locks and clean them up if the owner goes away.
+     */
     readonly locks: Set<string>;
-    lastResponse?: any;
+    /**
+     * Cached response from the last successful operation.
+     * Per RFC 7530 §9.1.7, when a client retries with the same seqid (replay),
+     * the server must return the cached response instead of re-executing the operation.
+     * This ensures idempotency for LOCK and LOCKU operations.
+     */
+    lastResponse?: any | undefined;
+    /**
+     * Signature of the last request to validate true replays.
+     * Used to detect mismatched replays where the client reuses a seqid but changes
+     * the request parameters, which must be rejected with NFS4ERR_BAD_SEQID.
+     */
     lastRequestKey?: string | undefined;
-    constructor(clientid: bigint, owner: Uint8Array, seqid: number, locks?: Set<string>, lastResponse?: any, lastRequestKey?: string | undefined);
+    constructor(
+    /**
+     * Client ID that owns this lock-owner.
+     * Links the owner back to the specific NFS client that created it.
+     */
+    clientid: bigint, 
+    /**
+     * Opaque lock-owner identifier provided by the client.
+     * Typically represents a process or thread ID on the client.
+     * Combined with clientid, uniquely identifies this lock-owner.
+     */
+    owner: Uint8Array, 
+    /**
+     * Sequence number for operations from this lock-owner.
+     * Used to serialize LOCK/LOCKU operations.
+     * Incremented after each successful stateful operation.
+     * Server rejects operations with incorrect sequence numbers to prevent replays.
+     */
+    seqid: number, 
+    /**
+     * Set of lock keys for all byte-range locks currently held by this owner.
+     * Format: lock keys are `${stateid}:${offset}:${length}`.
+     * Used to track all active locks and clean them up if the owner goes away.
+     */
+    locks?: Set<string>, 
+    /**
+     * Cached response from the last successful operation.
+     * Per RFC 7530 §9.1.7, when a client retries with the same seqid (replay),
+     * the server must return the cached response instead of re-executing the operation.
+     * This ensures idempotency for LOCK and LOCKU operations.
+     */
+    lastResponse?: any | undefined, 
+    /**
+     * Signature of the last request to validate true replays.
+     * Used to detect mismatched replays where the client reuses a seqid but changes
+     * the request parameters, which must be rejected with NFS4ERR_BAD_SEQID.
+     */
+    lastRequestKey?: string | undefined);
 }

package/lib/nfs/v4/server/operations/LockOwnerState.js

@@ -1,8 +1,50 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LockOwnerState = void 0;
+/**
+ * Lock-owner state record for NFSv4 LOCK operations.
+ * A lock-owner represents a single entity (process, thread) on a client
+ * that can acquire byte-range locks on files. Tracks all locks held by this owner.
+ */
 class LockOwnerState {
-    constructor(clientid, owner, seqid, locks = new Set(), lastResponse, lastRequestKey) {
+    constructor(
+    /**
+     * Client ID that owns this lock-owner.
+     * Links the owner back to the specific NFS client that created it.
+     */
+    clientid, 
+    /**
+     * Opaque lock-owner identifier provided by the client.
+     * Typically represents a process or thread ID on the client.
+     * Combined with clientid, uniquely identifies this lock-owner.
+     */
+    owner, 
+    /**
+     * Sequence number for operations from this lock-owner.
+     * Used to serialize LOCK/LOCKU operations.
+     * Incremented after each successful stateful operation.
+     * Server rejects operations with incorrect sequence numbers to prevent replays.
+     */
+    seqid, 
+    /**
+     * Set of lock keys for all byte-range locks currently held by this owner.
+     * Format: lock keys are `${stateid}:${offset}:${length}`.
+     * Used to track all active locks and clean them up if the owner goes away.
+     */
+    locks = new Set(), 
+    /**
+     * Cached response from the last successful operation.
+     * Per RFC 7530 §9.1.7, when a client retries with the same seqid (replay),
+     * the server must return the cached response instead of re-executing the operation.
+     * This ensures idempotency for LOCK and LOCKU operations.
+     */
+    lastResponse, 
+    /**
+     * Signature of the last request to validate true replays.
+     * Used to detect mismatched replays where the client reuses a seqid but changes
+     * the request parameters, which must be rejected with NFS4ERR_BAD_SEQID.
+     */
+    lastRequestKey) {
         this.clientid = clientid;
         this.owner = owner;
         this.seqid = seqid;

package/lib/nfs/v4/server/operations/LockOwnerState.js.map

@@ -1 +1 @@
-{"version":3,"file":"LockOwnerState.js","sourceRoot":"","sources":["../../../../../src/nfs/v4/server/operations/LockOwnerState.ts"],"names":[],"mappings":";;;AAKA,MAAa,cAAc;IACzB,YAKkB,QAAgB,EAOhB,KAAiB,EAQ1B,KAAa,EAOJ,QAAqB,IAAI,GAAG,EAAE,EAQvC,YAAkB,EAOlB,cAAuB;QArCd,aAAQ,GAAR,QAAQ,CAAQ;QAOhB,UAAK,GAAL,KAAK,CAAY;QAQ1B,UAAK,GAAL,KAAK,CAAQ;QAOJ,UAAK,GAAL,KAAK,CAAyB;QAQvC,iBAAY,GAAZ,YAAY,CAAM;QAOlB,mBAAc,GAAd,cAAc,CAAS;IAC7B,CAAC;CACL;AA7CD,wCA6CC"}
+{"version":3,"file":"LockOwnerState.js","sourceRoot":"","sources":["../../../../../src/nfs/v4/server/operations/LockOwnerState.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACH,MAAa,cAAc;IACzB;IACE;;;OAGG;IACa,QAAgB;IAEhC;;;;OAIG;IACa,KAAiB;IAEjC;;;;;OAKG;IACI,KAAa;IAEpB;;;;OAIG;IACa,QAAqB,IAAI,GAAG,EAAE;IAE9C;;;;;OAKG;IACI,YAAkB;IAEzB;;;;OAIG;IACI,cAAuB;QArCd,aAAQ,GAAR,QAAQ,CAAQ;QAOhB,UAAK,GAAL,KAAK,CAAY;QAQ1B,UAAK,GAAL,KAAK,CAAQ;QAOJ,UAAK,GAAL,KAAK,CAAyB;QAQvC,iBAAY,GAAZ,YAAY,CAAM;QAOlB,mBAAc,GAAd,cAAc,CAAS;IAC7B,CAAC;CACL;AA7CD,wCA6CC"}

package/lib/nfs/v4/server/operations/LockStateid.d.ts

@@ -1,10 +1,64 @@
 import * as struct from '../../structs';
+/**
+ * Lock stateid record for NFSv4 lock operations.
+ * Per RFC 7530 §9.1.4.1, all locks held on a particular file by a particular
+ * owner share a single stateid, with the seqid incremented on each LOCK/LOCKU.
+ * The stateid remains valid even after all locks are freed, as long as the
+ * associated open file remains open.
+ */
 export declare class LockStateid {
+    /**
+     * The "other" field of the stateid (96 bits).
+     * Uniquely identifies this lock-owner+file combination.
+     * Remains constant across all LOCK/LOCKU operations.
+     */
     readonly other: Uint8Array;
+    /**
+     * Current seqid value for this lock stateid.
+     * Incremented on each LOCK or LOCKU operation that affects locks.
+     * Starts at 1 when first created.
+     */
     seqid: number;
+    /**
+     * Key identifying the lock-owner that owns this stateid.
+     * Format: `${clientid}:${hex(owner)}`.
+     */
     readonly lockOwnerKey: string;
+    /**
+     * Absolute file system path of the file this stateid applies to.
+     * A lock-owner can have different stateids for different files.
+     */
     readonly path: string;
-    constructor(other: Uint8Array, seqid: number, lockOwnerKey: string, path: string);
+    constructor(
+    /**
+     * The "other" field of the stateid (96 bits).
+     * Uniquely identifies this lock-owner+file combination.
+     * Remains constant across all LOCK/LOCKU operations.
+     */
+    other: Uint8Array, 
+    /**
+     * Current seqid value for this lock stateid.
+     * Incremented on each LOCK or LOCKU operation that affects locks.
+     * Starts at 1 when first created.
+     */
+    seqid: number, 
+    /**
+     * Key identifying the lock-owner that owns this stateid.
+     * Format: `${clientid}:${hex(owner)}`.
+     */
+    lockOwnerKey: string, 
+    /**
+     * Absolute file system path of the file this stateid applies to.
+     * A lock-owner can have different stateids for different files.
+     */
+    path: string);
+    /**
+     * Get the full stateid with current seqid.
+     */
     toStateid(): struct.Nfsv4Stateid;
+    /**
+     * Increment seqid and return new stateid.
+     * Per RFC 7530, seqid wraps from 0xFFFFFFFF to 1 (not 0).
+     */
     incrementAndGetStateid(): struct.Nfsv4Stateid;
 }

package/lib/nfs/v4/server/operations/LockStateid.js

@@ -3,16 +3,52 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.LockStateid = void 0;
 const tslib_1 = require("tslib");
 const struct = tslib_1.__importStar(require("../../structs"));
+/**
+ * Lock stateid record for NFSv4 lock operations.
+ * Per RFC 7530 §9.1.4.1, all locks held on a particular file by a particular
+ * owner share a single stateid, with the seqid incremented on each LOCK/LOCKU.
+ * The stateid remains valid even after all locks are freed, as long as the
+ * associated open file remains open.
+ */
 class LockStateid {
-    constructor(other, seqid, lockOwnerKey, path) {
+    constructor(
+    /**
+     * The "other" field of the stateid (96 bits).
+     * Uniquely identifies this lock-owner+file combination.
+     * Remains constant across all LOCK/LOCKU operations.
+     */
+    other, 
+    /**
+     * Current seqid value for this lock stateid.
+     * Incremented on each LOCK or LOCKU operation that affects locks.
+     * Starts at 1 when first created.
+     */
+    seqid, 
+    /**
+     * Key identifying the lock-owner that owns this stateid.
+     * Format: `${clientid}:${hex(owner)}`.
+     */
+    lockOwnerKey, 
+    /**
+     * Absolute file system path of the file this stateid applies to.
+     * A lock-owner can have different stateids for different files.
+     */
+    path) {
         this.other = other;
         this.seqid = seqid;
         this.lockOwnerKey = lockOwnerKey;
         this.path = path;
     }
+    /**
+     * Get the full stateid with current seqid.
+     */
     toStateid() {
         return new struct.Nfsv4Stateid(this.seqid, this.other);
     }
+    /**
+     * Increment seqid and return new stateid.
+     * Per RFC 7530, seqid wraps from 0xFFFFFFFF to 1 (not 0).
+     */
     incrementAndGetStateid() {
         this.seqid = this.seqid === 0xffffffff ? 1 : this.seqid + 1;
         return this.toStateid();

package/lib/nfs/v4/server/operations/LockStateid.js.map

@@ -1 +1 @@
-{"version":3,"file":"LockStateid.js","sourceRoot":"","sources":["../../../../../src/nfs/v4/server/operations/LockStateid.ts"],"names":[],"mappings":";;;;AAAA,8DAAwC;AASxC,MAAa,WAAW;IACtB,YAMkB,KAAiB,EAO1B,KAAa,EAMJ,YAAoB,EAMpB,IAAY;QAnBZ,UAAK,GAAL,KAAK,CAAY;QAO1B,UAAK,GAAL,KAAK,CAAQ;QAMJ,iBAAY,GAAZ,YAAY,CAAQ;QAMpB,SAAI,GAAJ,IAAI,CAAQ;IAC3B,CAAC;IAKJ,SAAS;QACP,OAAO,IAAI,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;IACzD,CAAC;IAMD,sBAAsB;QACpB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;QAC5D,OAAO,IAAI,CAAC,SAAS,EAAE,CAAC;IAC1B,CAAC;CACF;AA5CD,kCA4CC"}
+{"version":3,"file":"LockStateid.js","sourceRoot":"","sources":["../../../../../src/nfs/v4/server/operations/LockStateid.ts"],"names":[],"mappings":";;;;AAAA,8DAAwC;AAExC;;;;;;GAMG;AACH,MAAa,WAAW;IACtB;IACE;;;;OAIG;IACa,KAAiB;IAEjC;;;;OAIG;IACI,KAAa;IAEpB;;;OAGG;IACa,YAAoB;IAEpC;;;OAGG;IACa,IAAY;QAnBZ,UAAK,GAAL,KAAK,CAAY;QAO1B,UAAK,GAAL,KAAK,CAAQ;QAMJ,iBAAY,GAAZ,YAAY,CAAQ;QAMpB,SAAI,GAAJ,IAAI,CAAQ;IAC3B,CAAC;IAEJ;;OAEG;IACH,SAAS;QACP,OAAO,IAAI,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;IACzD,CAAC;IAED;;;OAGG;IACH,sBAAsB;QACpB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;QAC5D,OAAO,IAAI,CAAC,SAAS,EAAE,CAAC;IAC1B,CAAC;CACF;AA5CD,kCA4CC"}

package/lib/nfs/v4/server/operations/Nfsv4Operations.d.ts

@@ -1,4 +1,4 @@
-import * as msg from '../../messages';
+import type * as msg from '../../messages';
 import type { Nfsv4CompoundProcCtx } from '../Nfsv4CompoundProcCtx';
 export type Nfsv4OperationCtx = Pick<Nfsv4CompoundProcCtx, 'cfh' | 'sfh' | 'req' | 'getPrincipal' | 'connection'>;
 export type Nfsv4OperationFn<Req extends msg.Nfsv4Request, Res extends msg.Nfsv4Response> = (request: Req, ctx: Nfsv4OperationCtx) => Promise<Res>;
@@ -35,6 +35,7 @@ export interface Nfsv4Operations {
     SAVEFH: Nfsv4OperationFn<msg.Nfsv4SavefhRequest, msg.Nfsv4SavefhResponse>;
     SECINFO: Nfsv4OperationFn<msg.Nfsv4SecinfoRequest, msg.Nfsv4SecinfoResponse>;
     SETATTR: Nfsv4OperationFn<msg.Nfsv4SetattrRequest, msg.Nfsv4SetattrResponse>;
+    /** @see {@link https://datatracker.ietf.org/doc/html/rfc7530#section-16.33} */
     SETCLIENTID: Nfsv4OperationFn<msg.Nfsv4SetclientidRequest, msg.Nfsv4SetclientidResponse>;
     SETCLIENTID_CONFIRM: Nfsv4OperationFn<msg.Nfsv4SetclientidConfirmRequest, msg.Nfsv4SetclientidConfirmResponse>;
     VERIFY: Nfsv4OperationFn<msg.Nfsv4VerifyRequest, msg.Nfsv4VerifyResponse>;

package/lib/nfs/v4/server/operations/Nfsv4OperationsNotImpl.d.ts

@@ -1,5 +1,5 @@
-import * as msg from '../../messages';
-import { Nfsv4OperationCtx, Nfsv4Operations } from './Nfsv4Operations';
+import type * as msg from '../../messages';
+import type { Nfsv4OperationCtx, Nfsv4Operations } from './Nfsv4Operations';
 export declare class Nfsv4OperationsNotImpl implements Nfsv4Operations {
     ACCESS(request: msg.Nfsv4AccessRequest, ctx: Nfsv4OperationCtx): Promise<msg.Nfsv4AccessResponse>;
     CLOSE(request: msg.Nfsv4CloseRequest, ctx: Nfsv4OperationCtx): Promise<msg.Nfsv4CloseResponse>;

package/lib/nfs/v4/server/operations/OpenFileState.d.ts

@@ -1,14 +1,102 @@
-/// <reference types="node" />
 import type * as struct from '../../structs';
 import type { FileHandle } from 'node:fs/promises';
+/**
+ * Open file state record for NFSv4 OPEN operations.
+ * Tracks state for an individual file that has been opened by a client,
+ * including the stateid, file descriptor, share reservations, and confirmation status.
+ */
 export declare class OpenFileState {
+    /**
+     * Stateid assigned to this open file.
+     * Used by client to identify this particular open in subsequent operations
+     * (CLOSE, OPEN_DOWNGRADE, READ, WRITE, etc.).
+     */
     readonly stateid: struct.Nfsv4Stateid;
+    /**
+     * Absolute file system path of the opened file.
+     * Used to identify the file and check for share reservation conflicts.
+     */
     readonly path: string;
+    /**
+     * Node.js file descriptor/handle for the opened file.
+     * Used to perform I/O operations and must be closed when the file is closed.
+     */
     readonly fd: FileHandle;
+    /**
+     * Share access mode - which operations this open allows.
+     * Bitwise OR of OPEN4_SHARE_ACCESS_READ, OPEN4_SHARE_ACCESS_WRITE.
+     * Controls what the opener can do with the file.
+     */
     shareAccess: number;
+    /**
+     * Share deny mode - which operations this open denies to others.
+     * Bitwise OR of OPEN4_SHARE_DENY_READ, OPEN4_SHARE_DENY_WRITE, or OPEN4_SHARE_DENY_NONE.
+     * Controls what conflicting operations are blocked for other opens.
+     */
     shareDeny: number;
+    /**
+     * Key identifying the open-owner that opened this file.
+     * Format: `${clientid}:${base64(owner)}`.
+     * Links this open back to the owner for sequence number management.
+     */
     readonly openOwnerKey: string;
+    /**
+     * Sequence number for this open.
+     * Used to detect replayed or out-of-order operations.
+     * Incremented on OPEN_CONFIRM and OPEN_DOWNGRADE.
+     */
     seqid: number;
+    /**
+     * Whether this open has been confirmed via OPEN_CONFIRM.
+     * NFSv4.0 requires new opens from new open-owners to be confirmed.
+     * Once confirmed, the open can be used for READ/WRITE operations.
+     */
     confirmed: boolean;
-    constructor(stateid: struct.Nfsv4Stateid, path: string, fd: FileHandle, shareAccess: number, shareDeny: number, openOwnerKey: string, seqid: number, confirmed: boolean);
+    constructor(
+    /**
+     * Stateid assigned to this open file.
+     * Used by client to identify this particular open in subsequent operations
+     * (CLOSE, OPEN_DOWNGRADE, READ, WRITE, etc.).
+     */
+    stateid: struct.Nfsv4Stateid, 
+    /**
+     * Absolute file system path of the opened file.
+     * Used to identify the file and check for share reservation conflicts.
+     */
+    path: string, 
+    /**
+     * Node.js file descriptor/handle for the opened file.
+     * Used to perform I/O operations and must be closed when the file is closed.
+     */
+    fd: FileHandle, 
+    /**
+     * Share access mode - which operations this open allows.
+     * Bitwise OR of OPEN4_SHARE_ACCESS_READ, OPEN4_SHARE_ACCESS_WRITE.
+     * Controls what the opener can do with the file.
+     */
+    shareAccess: number, 
+    /**
+     * Share deny mode - which operations this open denies to others.
+     * Bitwise OR of OPEN4_SHARE_DENY_READ, OPEN4_SHARE_DENY_WRITE, or OPEN4_SHARE_DENY_NONE.
+     * Controls what conflicting operations are blocked for other opens.
+     */
+    shareDeny: number, 
+    /**
+     * Key identifying the open-owner that opened this file.
+     * Format: `${clientid}:${base64(owner)}`.
+     * Links this open back to the owner for sequence number management.
+     */
+    openOwnerKey: string, 
+    /**
+     * Sequence number for this open.
+     * Used to detect replayed or out-of-order operations.
+     * Incremented on OPEN_CONFIRM and OPEN_DOWNGRADE.
+     */
+    seqid: number, 
+    /**
+     * Whether this open has been confirmed via OPEN_CONFIRM.
+     * NFSv4.0 requires new opens from new open-owners to be confirmed.
+     * Once confirmed, the open can be used for READ/WRITE operations.
+     */
+    confirmed: boolean);
 }