@fgv/ts-json-base 5.1.0-16 → 5.1.0-18

package/dist/packlets/file-tree/fileItem.js

@@ -77,7 +77,9 @@ export class FileItem {
         return captureResult(() => new FileItem(path, hal));
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeFileItem.getIsMutable}
+     * Indicates whether this file can be saved.
+     * @returns `DetailedSuccess` with {@link FileTree.SaveCapability} if the file can be saved,
+     * or `DetailedFailure` with {@link FileTree.SaveFailureReason} if it cannot.
      */
     getIsMutable() {
         if (isMutableAccessors(this._hal)) {
@@ -111,13 +113,17 @@ export class FileItem {
         this._contentType = contentType;
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeFileItem.setContents}
+     * Sets the contents of the file from a JSON value.
+     * @param json - The JSON value to serialize and save.
+     * @returns `Success` if the file was saved, or `Failure` with an error message.
      */
     setContents(json) {
         return captureResult(() => JSON.stringify(json, null, 2)).onSuccess((contents) => this.setRawContents(contents).onSuccess(() => Success.with(json)));
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeFileItem.setRawContents}
+     * Sets the raw contents of the file.
+     * @param contents - The string contents to save.
+     * @returns `Success` if the file was saved, or `Failure` with an error message.
      */
     setRawContents(contents) {
         if (isMutableAccessors(this._hal)) {
@@ -127,7 +133,8 @@ export class FileItem {
         return fail(`${this.absolutePath}: mutation not supported`);
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeFileItem.delete}
+     * Deletes this file from its backing store.
+     * @returns `Success` with `true` if the file was deleted, or `Failure` with an error message.
      */
     delete() {
         if (!isMutableAccessors(this._hal)) {

package/dist/packlets/file-tree/fsTree.js

@@ -44,7 +44,9 @@ export class FsFileTreeAccessors {
         this._mutable = (_b = params === null || params === void 0 ? void 0 : params.mutable) !== null && _b !== void 0 ? _b : false;
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.resolveAbsolutePath}
+     * Resolves paths to an absolute path.
+     * @param paths - Paths to resolve.
+     * @returns The resolved absolute path.
      */
     resolveAbsolutePath(...paths) {
         if (this.prefix && !path.isAbsolute(paths[0])) {
@@ -53,25 +55,34 @@ export class FsFileTreeAccessors {
         return path.resolve(...paths);
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getExtension}
+     * Gets the extension of a path.
+     * @param itemPath - Path to get the extension of.
+     * @returns The extension of the path.
      */
     getExtension(itemPath) {
         return path.extname(itemPath);
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getBaseName}
+     * Gets the base name of a path.
+     * @param itemPath - Path to get the base name of.
+     * @param suffix - Optional suffix to remove from the base name.
+     * @returns The base name of the path.
      */
     getBaseName(itemPath, suffix) {
         return path.basename(itemPath, suffix);
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.joinPaths}
+     * Joins paths together.
+     * @param paths - Paths to join.
+     * @returns The joined paths.
      */
     joinPaths(...paths) {
         return path.join(...paths);
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getItem}
+     * Gets an item from the file tree.
+     * @param itemPath - Path of the item to get.
+     * @returns The item if it exists.
      */
     getItem(itemPath) {
         return captureResult(() => {
@@ -87,13 +98,18 @@ export class FsFileTreeAccessors {
         });
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getFileContents}
+     * Gets the contents of a file in the file tree.
+     * @param filePath - Absolute path of the file.
+     * @returns The contents of the file.
      */
     getFileContents(filePath) {
         return captureResult(() => fs.readFileSync(this.resolveAbsolutePath(filePath), 'utf8'));
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getFileContentType}
+     * Gets the content type of a file in the file tree.
+     * @param filePath - Absolute path of the file.
+     * @param provided - Optional supplied content type.
+     * @returns The content type of the file.
      */
     getFileContentType(filePath, provided) {
         if (provided !== undefined) {
@@ -103,7 +119,9 @@ export class FsFileTreeAccessors {
         return this._inferContentType(filePath);
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getChildren}
+     * Gets the children of a directory in the file tree.
+     * @param dirPath - Path of the directory.
+     * @returns The children of the directory.
      */
     getChildren(dirPath) {
         return captureResult(() => {
@@ -122,7 +140,10 @@ export class FsFileTreeAccessors {
         });
     }
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.fileIsMutable}
+     * Checks if a file at the given path can be saved.
+     * @param path - The path to check.
+     * @returns `DetailedSuccess` with {@link FileTree.SaveCapability} if the file can be saved,
+     * or `DetailedFailure` with {@link FileTree.SaveFailureReason} if it cannot.
      */
     fileIsMutable(path) {
         const absolutePath = this.resolveAbsolutePath(path);
@@ -155,7 +176,10 @@ export class FsFileTreeAccessors {
         }
     }
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.saveFileContents}
+     * Saves the contents to a file at the given path.
+     * @param path - The path of the file to save.
+     * @param contents - The string contents to save.
+     * @returns `Success` if the file was saved, or `Failure` with an error message.
      */
     saveFileContents(path, contents) {
         return this.fileIsMutable(path).asResult.onSuccess(() => {
@@ -167,7 +191,9 @@ export class FsFileTreeAccessors {
         });
     }
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.deleteFile}
+     * Deletes a file at the given path.
+     * @param path - The path of the file to delete.
+     * @returns `Success` with `true` if the file was deleted, or `Failure` with an error message.
      */
     deleteFile(path) {
         return this.fileIsMutable(path).asResult.onSuccess(() => {
@@ -183,7 +209,9 @@ export class FsFileTreeAccessors {
         });
     }
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.createDirectory}
+     * Creates a directory at the given path, including any missing parent directories.
+     * @param dirPath - The path of the directory to create.
+     * @returns `Success` with the absolute path if created, or `Failure` with an error message.
      */
     createDirectory(dirPath) {
         const absolutePath = this.resolveAbsolutePath(dirPath);
@@ -197,7 +225,10 @@ export class FsFileTreeAccessors {
         });
     }
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.deleteDirectory}
+     * Deletes a directory at the given path.
+     * The directory must be empty or the operation will fail.
+     * @param dirPath - The path of the directory to delete.
+     * @returns `Success` with `true` if the directory was deleted, or `Failure` with an error message.
      */
     deleteDirectory(dirPath) {
         return this.fileIsMutable(dirPath).asResult.onSuccess(() => {

package/dist/packlets/file-tree/in-memory/inMemoryTree.js

@@ -135,7 +135,9 @@ export class InMemoryTreeAccessors {
         return captureResult(() => new InMemoryTreeAccessors(files, params));
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.resolveAbsolutePath}
+     * Resolves paths to an absolute path.
+     * @param paths - Paths to resolve.
+     * @returns The resolved absolute path.
      */
     resolveAbsolutePath(...paths) {
         const parts = paths[0].startsWith('/') ? paths : [this._tree.prefix, ...paths];
@@ -143,7 +145,9 @@ export class InMemoryTreeAccessors {
         return `/${joined}`;
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getExtension}
+     * Gets the extension of a path.
+     * @param path - Path to get the extension of.
+     * @returns The extension of the path.
      */
     getExtension(path) {
         const parts = path.split('.');
@@ -153,7 +157,10 @@ export class InMemoryTreeAccessors {
         return `.${parts.pop()}`;
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getBaseName}
+     * Gets the base name of a path.
+     * @param path - Path to get the base name of.
+     * @param suffix - Optional suffix to remove from the base name.
+     * @returns The base name of the path.
      */
     getBaseName(path, suffix) {
         var _a;
@@ -165,7 +172,9 @@ export class InMemoryTreeAccessors {
         return base;
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.joinPaths}
+     * Joins paths together.
+     * @param paths - Paths to join.
+     * @returns The joined paths.
      */
     joinPaths(...paths) {
         var _a;
@@ -173,7 +182,9 @@ export class InMemoryTreeAccessors {
         return ((_a = paths[0]) === null || _a === void 0 ? void 0 : _a.startsWith('/')) ? `/${joined}` : joined;
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getItem}
+     * Gets an item from the file tree.
+     * @param itemPath - Path of the item to get.
+     * @returns The item if it exists.
      */
     getItem(itemPath) {
         const existing = this._tree.byAbsolutePath.get(itemPath);
@@ -188,7 +199,9 @@ export class InMemoryTreeAccessors {
         return fail(`${itemPath}: not found`);
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getFileContents}
+     * Gets the contents of a file in the file tree.
+     * @param path - Absolute path of the file.
+     * @returns The contents of the file.
      */
     getFileContents(path) {
         const absolutePath = this.resolveAbsolutePath(path);
@@ -205,7 +218,10 @@ export class InMemoryTreeAccessors {
         return captureResult(() => JSON.stringify(item.contents));
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getFileContentType}
+     * Gets the content type of a file in the file tree.
+     * @param path - Absolute path of the file.
+     * @param provided - Optional supplied content type.
+     * @returns The content type of the file.
      */
     getFileContentType(path, provided) {
         // If provided contentType is given, use it directly (highest priority)
@@ -228,7 +244,9 @@ export class InMemoryTreeAccessors {
         return this._inferContentType(path);
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getChildren}
+     * Gets the children of a directory in the file tree.
+     * @param path - Path of the directory.
+     * @returns The children of the directory.
      */
     getChildren(path) {
         const item = this._tree.byAbsolutePath.get(path);
@@ -278,7 +296,9 @@ export class InMemoryTreeAccessors {
         });
     }
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.createDirectory}
+     * Creates a directory at the given path, including any missing parent directories.
+     * @param dirPath - The path of the directory to create.
+     * @returns `Success` with the absolute path if created, or `Failure` with an error message.
      */
     createDirectory(dirPath) {
         const absolutePath = this.resolveAbsolutePath(dirPath);
@@ -309,7 +329,10 @@ export class InMemoryTreeAccessors {
         return succeed(absolutePath);
     }
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.fileIsMutable}
+     * Checks if a file at the given path can be saved.
+     * @param path - The path to check.
+     * @returns `DetailedSuccess` with {@link FileTree.SaveCapability} if the file can be saved,
+     * or `DetailedFailure` with {@link FileTree.SaveFailureReason} if it cannot.
      */
     fileIsMutable(path) {
         const absolutePath = this.resolveAbsolutePath(path);
@@ -324,7 +347,9 @@ export class InMemoryTreeAccessors {
         return succeedWithDetail(true, 'transient');
     }
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.deleteFile}
+     * Deletes a file at the given path.
+     * @param path - The path of the file to delete.
+     * @returns `Success` with `true` if the file was deleted, or `Failure` with an error message.
      */
     deleteFile(path) {
         const absolutePath = this.resolveAbsolutePath(path);
@@ -356,7 +381,10 @@ export class InMemoryTreeAccessors {
         return succeed(true);
     }
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.deleteDirectory}
+     * Deletes a directory at the given path.
+     * The directory must be empty or the operation will fail.
+     * @param path - The path of the directory to delete.
+     * @returns `Success` with `true` if the directory was deleted, or `Failure` with an error message.
      */
     deleteDirectory(path) {
         const absolutePath = this.resolveAbsolutePath(path);
@@ -396,7 +424,10 @@ export class InMemoryTreeAccessors {
         return succeed(true);
     }
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.saveFileContents}
+     * Saves the contents to a file at the given path.
+     * @param path - The path of the file to save.
+     * @param contents - The string contents to save.
+     * @returns `Success` if the file was saved, or `Failure` with an error message.
      */
     saveFileContents(path, contents) {
         const isMutable = this.fileIsMutable(path);

package/dist/ts-json-base.d.ts

@@ -345,7 +345,9 @@ declare class FileItem<TCT extends string = string> implements IMutableFileTreeF
      */
     static create<TCT extends string = string>(path: string, hal: IFileTreeAccessors<TCT>): Result<FileItem<TCT>>;
     /**
-     * {@inheritDoc FileTree.IFileTreeFileItem.getIsMutable}
+     * Indicates whether this file can be saved.
+     * @returns `DetailedSuccess` with {@link FileTree.SaveCapability} if the file can be saved,
+     * or `DetailedFailure` with {@link FileTree.SaveFailureReason} if it cannot.
      */
     getIsMutable(): DetailedResult<boolean, SaveDetail>;
     /**
@@ -366,15 +368,20 @@ declare class FileItem<TCT extends string = string> implements IMutableFileTreeF
      */
     setContentType(contentType: TCT | undefined): void;
     /**
-     * {@inheritDoc FileTree.IFileTreeFileItem.setContents}
+     * Sets the contents of the file from a JSON value.
+     * @param json - The JSON value to serialize and save.
+     * @returns `Success` if the file was saved, or `Failure` with an error message.
      */
     setContents(json: JsonValue): Result<JsonValue>;
     /**
-     * {@inheritDoc FileTree.IFileTreeFileItem.setRawContents}
+     * Sets the raw contents of the file.
+     * @param contents - The string contents to save.
+     * @returns `Success` if the file was saved, or `Failure` with an error message.
      */
     setRawContents(contents: string): Result<string>;
     /**
-     * {@inheritDoc FileTree.IFileTreeFileItem.delete}
+     * Deletes this file from its backing store.
+     * @returns `Success` with `true` if the file was deleted, or `Failure` with an error message.
      */
     delete(): Result<boolean>;
     /**
@@ -542,55 +549,86 @@ declare class FsFileTreeAccessors<TCT extends string = string> implements IMutab
      */
     constructor(params?: IFileTreeInitParams<TCT>);
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.resolveAbsolutePath}
+     * Resolves paths to an absolute path.
+     * @param paths - Paths to resolve.
+     * @returns The resolved absolute path.
      */
     resolveAbsolutePath(...paths: string[]): string;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getExtension}
+     * Gets the extension of a path.
+     * @param itemPath - Path to get the extension of.
+     * @returns The extension of the path.
      */
     getExtension(itemPath: string): string;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getBaseName}
+     * Gets the base name of a path.
+     * @param itemPath - Path to get the base name of.
+     * @param suffix - Optional suffix to remove from the base name.
+     * @returns The base name of the path.
      */
     getBaseName(itemPath: string, suffix?: string): string;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.joinPaths}
+     * Joins paths together.
+     * @param paths - Paths to join.
+     * @returns The joined paths.
      */
     joinPaths(...paths: string[]): string;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getItem}
+     * Gets an item from the file tree.
+     * @param itemPath - Path of the item to get.
+     * @returns The item if it exists.
      */
     getItem(itemPath: string): Result<FileTreeItem<TCT>>;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getFileContents}
+     * Gets the contents of a file in the file tree.
+     * @param filePath - Absolute path of the file.
+     * @returns The contents of the file.
      */
     getFileContents(filePath: string): Result<string>;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getFileContentType}
+     * Gets the content type of a file in the file tree.
+     * @param filePath - Absolute path of the file.
+     * @param provided - Optional supplied content type.
+     * @returns The content type of the file.
      */
     getFileContentType(filePath: string, provided?: string): Result<TCT | undefined>;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getChildren}
+     * Gets the children of a directory in the file tree.
+     * @param dirPath - Path of the directory.
+     * @returns The children of the directory.
      */
     getChildren(dirPath: string): Result<ReadonlyArray<FileTreeItem<TCT>>>;
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.fileIsMutable}
+     * Checks if a file at the given path can be saved.
+     * @param path - The path to check.
+     * @returns `DetailedSuccess` with {@link FileTree.SaveCapability} if the file can be saved,
+     * or `DetailedFailure` with {@link FileTree.SaveFailureReason} if it cannot.
      */
     fileIsMutable(path: string): DetailedResult<boolean, SaveDetail>;
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.saveFileContents}
+     * Saves the contents to a file at the given path.
+     * @param path - The path of the file to save.
+     * @param contents - The string contents to save.
+     * @returns `Success` if the file was saved, or `Failure` with an error message.
      */
     saveFileContents(path: string, contents: string): Result<string>;
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.deleteFile}
+     * Deletes a file at the given path.
+     * @param path - The path of the file to delete.
+     * @returns `Success` with `true` if the file was deleted, or `Failure` with an error message.
      */
     deleteFile(path: string): Result<boolean>;
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.createDirectory}
+     * Creates a directory at the given path, including any missing parent directories.
+     * @param dirPath - The path of the directory to create.
+     * @returns `Success` with the absolute path if created, or `Failure` with an error message.
      */
     createDirectory(dirPath: string): Result<string>;
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.deleteDirectory}
+     * Deletes a directory at the given path.
+     * The directory must be empty or the operation will fail.
+     * @param dirPath - The path of the directory to delete.
+     * @returns `Success` with `true` if the directory was deleted, or `Failure` with an error message.
      */
     deleteDirectory(dirPath: string): Result<boolean>;
 }
@@ -1011,56 +1049,87 @@ declare class InMemoryTreeAccessors<TCT extends string = string> implements IMut
      */
     static create<TCT extends string = string>(files: IInMemoryFile<TCT>[], params?: IFileTreeInitParams<TCT>): Result<InMemoryTreeAccessors<TCT>>;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.resolveAbsolutePath}
+     * Resolves paths to an absolute path.
+     * @param paths - Paths to resolve.
+     * @returns The resolved absolute path.
      */
     resolveAbsolutePath(...paths: string[]): string;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getExtension}
+     * Gets the extension of a path.
+     * @param path - Path to get the extension of.
+     * @returns The extension of the path.
      */
     getExtension(path: string): string;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getBaseName}
+     * Gets the base name of a path.
+     * @param path - Path to get the base name of.
+     * @param suffix - Optional suffix to remove from the base name.
+     * @returns The base name of the path.
      */
     getBaseName(path: string, suffix?: string): string;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.joinPaths}
+     * Joins paths together.
+     * @param paths - Paths to join.
+     * @returns The joined paths.
      */
     joinPaths(...paths: string[]): string;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getItem}
+     * Gets an item from the file tree.
+     * @param itemPath - Path of the item to get.
+     * @returns The item if it exists.
      */
     getItem(itemPath: string): Result<FileTreeItem<TCT>>;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getFileContents}
+     * Gets the contents of a file in the file tree.
+     * @param path - Absolute path of the file.
+     * @returns The contents of the file.
      */
     getFileContents(path: string): Result<string>;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getFileContentType}
+     * Gets the content type of a file in the file tree.
+     * @param path - Absolute path of the file.
+     * @param provided - Optional supplied content type.
+     * @returns The content type of the file.
      */
     getFileContentType(path: string, provided?: string): Result<TCT | undefined>;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getChildren}
+     * Gets the children of a directory in the file tree.
+     * @param path - Path of the directory.
+     * @returns The children of the directory.
      */
     getChildren(path: string): Result<ReadonlyArray<FileTreeItem<TCT>>>;
     private _addMutableFile;
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.createDirectory}
+     * Creates a directory at the given path, including any missing parent directories.
+     * @param dirPath - The path of the directory to create.
+     * @returns `Success` with the absolute path if created, or `Failure` with an error message.
      */
     createDirectory(dirPath: string): Result<string>;
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.fileIsMutable}
+     * Checks if a file at the given path can be saved.
+     * @param path - The path to check.
+     * @returns `DetailedSuccess` with {@link FileTree.SaveCapability} if the file can be saved,
+     * or `DetailedFailure` with {@link FileTree.SaveFailureReason} if it cannot.
      */
     fileIsMutable(path: string): DetailedResult<boolean, SaveDetail>;
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.deleteFile}
+     * Deletes a file at the given path.
+     * @param path - The path of the file to delete.
+     * @returns `Success` with `true` if the file was deleted, or `Failure` with an error message.
      */
     deleteFile(path: string): Result<boolean>;
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.deleteDirectory}
+     * Deletes a directory at the given path.
+     * The directory must be empty or the operation will fail.
+     * @param path - The path of the directory to delete.
+     * @returns `Success` with `true` if the directory was deleted, or `Failure` with an error message.
      */
     deleteDirectory(path: string): Result<boolean>;
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.saveFileContents}
+     * Saves the contents to a file at the given path.
+     * @param path - The path of the file to save.
+     * @param contents - The string contents to save.
+     * @returns `Success` if the file was saved, or `Failure` with an error message.
      */
     saveFileContents(path: string, contents: string): Result<string>;
 }

package/lib/packlets/file-tree/fileItem.d.ts

@@ -58,7 +58,9 @@ export declare class FileItem<TCT extends string = string> implements IMutableFi
      */
     static create<TCT extends string = string>(path: string, hal: IFileTreeAccessors<TCT>): Result<FileItem<TCT>>;
     /**
-     * {@inheritDoc FileTree.IFileTreeFileItem.getIsMutable}
+     * Indicates whether this file can be saved.
+     * @returns `DetailedSuccess` with {@link FileTree.SaveCapability} if the file can be saved,
+     * or `DetailedFailure` with {@link FileTree.SaveFailureReason} if it cannot.
      */
     getIsMutable(): DetailedResult<boolean, SaveDetail>;
     /**
@@ -79,15 +81,20 @@ export declare class FileItem<TCT extends string = string> implements IMutableFi
      */
     setContentType(contentType: TCT | undefined): void;
     /**
-     * {@inheritDoc FileTree.IFileTreeFileItem.setContents}
+     * Sets the contents of the file from a JSON value.
+     * @param json - The JSON value to serialize and save.
+     * @returns `Success` if the file was saved, or `Failure` with an error message.
      */
     setContents(json: JsonValue): Result<JsonValue>;
     /**
-     * {@inheritDoc FileTree.IFileTreeFileItem.setRawContents}
+     * Sets the raw contents of the file.
+     * @param contents - The string contents to save.
+     * @returns `Success` if the file was saved, or `Failure` with an error message.
      */
     setRawContents(contents: string): Result<string>;
     /**
-     * {@inheritDoc FileTree.IFileTreeFileItem.delete}
+     * Deletes this file from its backing store.
+     * @returns `Success` with `true` if the file was deleted, or `Failure` with an error message.
      */
     delete(): Result<boolean>;
     /**

package/lib/packlets/file-tree/fileItem.js

@@ -80,7 +80,9 @@ class FileItem {
         return (0, ts_utils_1.captureResult)(() => new FileItem(path, hal));
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeFileItem.getIsMutable}
+     * Indicates whether this file can be saved.
+     * @returns `DetailedSuccess` with {@link FileTree.SaveCapability} if the file can be saved,
+     * or `DetailedFailure` with {@link FileTree.SaveFailureReason} if it cannot.
      */
     getIsMutable() {
         if ((0, fileTreeAccessors_1.isMutableAccessors)(this._hal)) {
@@ -114,13 +116,17 @@ class FileItem {
         this._contentType = contentType;
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeFileItem.setContents}
+     * Sets the contents of the file from a JSON value.
+     * @param json - The JSON value to serialize and save.
+     * @returns `Success` if the file was saved, or `Failure` with an error message.
      */
     setContents(json) {
         return (0, ts_utils_1.captureResult)(() => JSON.stringify(json, null, 2)).onSuccess((contents) => this.setRawContents(contents).onSuccess(() => ts_utils_1.Success.with(json)));
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeFileItem.setRawContents}
+     * Sets the raw contents of the file.
+     * @param contents - The string contents to save.
+     * @returns `Success` if the file was saved, or `Failure` with an error message.
      */
     setRawContents(contents) {
         if ((0, fileTreeAccessors_1.isMutableAccessors)(this._hal)) {
@@ -130,7 +136,8 @@ class FileItem {
         return (0, ts_utils_1.fail)(`${this.absolutePath}: mutation not supported`);
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeFileItem.delete}
+     * Deletes this file from its backing store.
+     * @returns `Success` with `true` if the file was deleted, or `Failure` with an error message.
      */
     delete() {
         if (!(0, fileTreeAccessors_1.isMutableAccessors)(this._hal)) {

package/lib/packlets/file-tree/fsTree.d.ts

@@ -26,55 +26,86 @@ export declare class FsFileTreeAccessors<TCT extends string = string> implements
      */
     constructor(params?: IFileTreeInitParams<TCT>);
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.resolveAbsolutePath}
+     * Resolves paths to an absolute path.
+     * @param paths - Paths to resolve.
+     * @returns The resolved absolute path.
      */
     resolveAbsolutePath(...paths: string[]): string;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getExtension}
+     * Gets the extension of a path.
+     * @param itemPath - Path to get the extension of.
+     * @returns The extension of the path.
      */
     getExtension(itemPath: string): string;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getBaseName}
+     * Gets the base name of a path.
+     * @param itemPath - Path to get the base name of.
+     * @param suffix - Optional suffix to remove from the base name.
+     * @returns The base name of the path.
      */
     getBaseName(itemPath: string, suffix?: string): string;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.joinPaths}
+     * Joins paths together.
+     * @param paths - Paths to join.
+     * @returns The joined paths.
      */
     joinPaths(...paths: string[]): string;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getItem}
+     * Gets an item from the file tree.
+     * @param itemPath - Path of the item to get.
+     * @returns The item if it exists.
      */
     getItem(itemPath: string): Result<FileTreeItem<TCT>>;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getFileContents}
+     * Gets the contents of a file in the file tree.
+     * @param filePath - Absolute path of the file.
+     * @returns The contents of the file.
      */
     getFileContents(filePath: string): Result<string>;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getFileContentType}
+     * Gets the content type of a file in the file tree.
+     * @param filePath - Absolute path of the file.
+     * @param provided - Optional supplied content type.
+     * @returns The content type of the file.
      */
     getFileContentType(filePath: string, provided?: string): Result<TCT | undefined>;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getChildren}
+     * Gets the children of a directory in the file tree.
+     * @param dirPath - Path of the directory.
+     * @returns The children of the directory.
      */
     getChildren(dirPath: string): Result<ReadonlyArray<FileTreeItem<TCT>>>;
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.fileIsMutable}
+     * Checks if a file at the given path can be saved.
+     * @param path - The path to check.
+     * @returns `DetailedSuccess` with {@link FileTree.SaveCapability} if the file can be saved,
+     * or `DetailedFailure` with {@link FileTree.SaveFailureReason} if it cannot.
      */
     fileIsMutable(path: string): DetailedResult<boolean, SaveDetail>;
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.saveFileContents}
+     * Saves the contents to a file at the given path.
+     * @param path - The path of the file to save.
+     * @param contents - The string contents to save.
+     * @returns `Success` if the file was saved, or `Failure` with an error message.
      */
     saveFileContents(path: string, contents: string): Result<string>;
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.deleteFile}
+     * Deletes a file at the given path.
+     * @param path - The path of the file to delete.
+     * @returns `Success` with `true` if the file was deleted, or `Failure` with an error message.
      */
     deleteFile(path: string): Result<boolean>;
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.createDirectory}
+     * Creates a directory at the given path, including any missing parent directories.
+     * @param dirPath - The path of the directory to create.
+     * @returns `Success` with the absolute path if created, or `Failure` with an error message.
      */
     createDirectory(dirPath: string): Result<string>;
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.deleteDirectory}
+     * Deletes a directory at the given path.
+     * The directory must be empty or the operation will fail.
+     * @param dirPath - The path of the directory to delete.
+     * @returns `Success` with `true` if the directory was deleted, or `Failure` with an error message.
      */
     deleteDirectory(dirPath: string): Result<boolean>;
 }

package/lib/packlets/file-tree/fsTree.js

@@ -50,7 +50,9 @@ class FsFileTreeAccessors {
         this._mutable = (_b = params === null || params === void 0 ? void 0 : params.mutable) !== null && _b !== void 0 ? _b : false;
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.resolveAbsolutePath}
+     * Resolves paths to an absolute path.
+     * @param paths - Paths to resolve.
+     * @returns The resolved absolute path.
      */
     resolveAbsolutePath(...paths) {
         if (this.prefix && !path_1.default.isAbsolute(paths[0])) {
@@ -59,25 +61,34 @@ class FsFileTreeAccessors {
         return path_1.default.resolve(...paths);
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getExtension}
+     * Gets the extension of a path.
+     * @param itemPath - Path to get the extension of.
+     * @returns The extension of the path.
      */
     getExtension(itemPath) {
         return path_1.default.extname(itemPath);
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getBaseName}
+     * Gets the base name of a path.
+     * @param itemPath - Path to get the base name of.
+     * @param suffix - Optional suffix to remove from the base name.
+     * @returns The base name of the path.
      */
     getBaseName(itemPath, suffix) {
         return path_1.default.basename(itemPath, suffix);
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.joinPaths}
+     * Joins paths together.
+     * @param paths - Paths to join.
+     * @returns The joined paths.
      */
     joinPaths(...paths) {
         return path_1.default.join(...paths);
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getItem}
+     * Gets an item from the file tree.
+     * @param itemPath - Path of the item to get.
+     * @returns The item if it exists.
      */
     getItem(itemPath) {
         return (0, ts_utils_1.captureResult)(() => {
@@ -93,13 +104,18 @@ class FsFileTreeAccessors {
         });
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getFileContents}
+     * Gets the contents of a file in the file tree.
+     * @param filePath - Absolute path of the file.
+     * @returns The contents of the file.
      */
     getFileContents(filePath) {
         return (0, ts_utils_1.captureResult)(() => fs_1.default.readFileSync(this.resolveAbsolutePath(filePath), 'utf8'));
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getFileContentType}
+     * Gets the content type of a file in the file tree.
+     * @param filePath - Absolute path of the file.
+     * @param provided - Optional supplied content type.
+     * @returns The content type of the file.
      */
     getFileContentType(filePath, provided) {
         if (provided !== undefined) {
@@ -109,7 +125,9 @@ class FsFileTreeAccessors {
         return this._inferContentType(filePath);
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getChildren}
+     * Gets the children of a directory in the file tree.
+     * @param dirPath - Path of the directory.
+     * @returns The children of the directory.
      */
     getChildren(dirPath) {
         return (0, ts_utils_1.captureResult)(() => {
@@ -128,7 +146,10 @@ class FsFileTreeAccessors {
         });
     }
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.fileIsMutable}
+     * Checks if a file at the given path can be saved.
+     * @param path - The path to check.
+     * @returns `DetailedSuccess` with {@link FileTree.SaveCapability} if the file can be saved,
+     * or `DetailedFailure` with {@link FileTree.SaveFailureReason} if it cannot.
      */
     fileIsMutable(path) {
         const absolutePath = this.resolveAbsolutePath(path);
@@ -161,7 +182,10 @@ class FsFileTreeAccessors {
         }
     }
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.saveFileContents}
+     * Saves the contents to a file at the given path.
+     * @param path - The path of the file to save.
+     * @param contents - The string contents to save.
+     * @returns `Success` if the file was saved, or `Failure` with an error message.
      */
     saveFileContents(path, contents) {
         return this.fileIsMutable(path).asResult.onSuccess(() => {
@@ -173,7 +197,9 @@ class FsFileTreeAccessors {
         });
     }
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.deleteFile}
+     * Deletes a file at the given path.
+     * @param path - The path of the file to delete.
+     * @returns `Success` with `true` if the file was deleted, or `Failure` with an error message.
      */
     deleteFile(path) {
         return this.fileIsMutable(path).asResult.onSuccess(() => {
@@ -189,7 +215,9 @@ class FsFileTreeAccessors {
         });
     }
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.createDirectory}
+     * Creates a directory at the given path, including any missing parent directories.
+     * @param dirPath - The path of the directory to create.
+     * @returns `Success` with the absolute path if created, or `Failure` with an error message.
      */
     createDirectory(dirPath) {
         const absolutePath = this.resolveAbsolutePath(dirPath);
@@ -203,7 +231,10 @@ class FsFileTreeAccessors {
         });
     }
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.deleteDirectory}
+     * Deletes a directory at the given path.
+     * The directory must be empty or the operation will fail.
+     * @param dirPath - The path of the directory to delete.
+     * @returns `Success` with `true` if the directory was deleted, or `Failure` with an error message.
      */
     deleteDirectory(dirPath) {
         return this.fileIsMutable(dirPath).asResult.onSuccess(() => {

package/lib/packlets/file-tree/in-memory/inMemoryTree.d.ts

@@ -51,56 +51,87 @@ export declare class InMemoryTreeAccessors<TCT extends string = string> implemen
      */
     static create<TCT extends string = string>(files: IInMemoryFile<TCT>[], params?: IFileTreeInitParams<TCT>): Result<InMemoryTreeAccessors<TCT>>;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.resolveAbsolutePath}
+     * Resolves paths to an absolute path.
+     * @param paths - Paths to resolve.
+     * @returns The resolved absolute path.
      */
     resolveAbsolutePath(...paths: string[]): string;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getExtension}
+     * Gets the extension of a path.
+     * @param path - Path to get the extension of.
+     * @returns The extension of the path.
      */
     getExtension(path: string): string;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getBaseName}
+     * Gets the base name of a path.
+     * @param path - Path to get the base name of.
+     * @param suffix - Optional suffix to remove from the base name.
+     * @returns The base name of the path.
      */
     getBaseName(path: string, suffix?: string): string;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.joinPaths}
+     * Joins paths together.
+     * @param paths - Paths to join.
+     * @returns The joined paths.
      */
     joinPaths(...paths: string[]): string;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getItem}
+     * Gets an item from the file tree.
+     * @param itemPath - Path of the item to get.
+     * @returns The item if it exists.
      */
     getItem(itemPath: string): Result<FileTreeItem<TCT>>;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getFileContents}
+     * Gets the contents of a file in the file tree.
+     * @param path - Absolute path of the file.
+     * @returns The contents of the file.
      */
     getFileContents(path: string): Result<string>;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getFileContentType}
+     * Gets the content type of a file in the file tree.
+     * @param path - Absolute path of the file.
+     * @param provided - Optional supplied content type.
+     * @returns The content type of the file.
      */
     getFileContentType(path: string, provided?: string): Result<TCT | undefined>;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getChildren}
+     * Gets the children of a directory in the file tree.
+     * @param path - Path of the directory.
+     * @returns The children of the directory.
      */
     getChildren(path: string): Result<ReadonlyArray<FileTreeItem<TCT>>>;
     private _addMutableFile;
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.createDirectory}
+     * Creates a directory at the given path, including any missing parent directories.
+     * @param dirPath - The path of the directory to create.
+     * @returns `Success` with the absolute path if created, or `Failure` with an error message.
      */
     createDirectory(dirPath: string): Result<string>;
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.fileIsMutable}
+     * Checks if a file at the given path can be saved.
+     * @param path - The path to check.
+     * @returns `DetailedSuccess` with {@link FileTree.SaveCapability} if the file can be saved,
+     * or `DetailedFailure` with {@link FileTree.SaveFailureReason} if it cannot.
      */
     fileIsMutable(path: string): DetailedResult<boolean, SaveDetail>;
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.deleteFile}
+     * Deletes a file at the given path.
+     * @param path - The path of the file to delete.
+     * @returns `Success` with `true` if the file was deleted, or `Failure` with an error message.
      */
     deleteFile(path: string): Result<boolean>;
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.deleteDirectory}
+     * Deletes a directory at the given path.
+     * The directory must be empty or the operation will fail.
+     * @param path - The path of the directory to delete.
+     * @returns `Success` with `true` if the directory was deleted, or `Failure` with an error message.
      */
     deleteDirectory(path: string): Result<boolean>;
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.saveFileContents}
+     * Saves the contents to a file at the given path.
+     * @param path - The path of the file to save.
+     * @param contents - The string contents to save.
+     * @returns `Success` if the file was saved, or `Failure` with an error message.
      */
     saveFileContents(path: string, contents: string): Result<string>;
 }

package/lib/packlets/file-tree/in-memory/inMemoryTree.js

@@ -138,7 +138,9 @@ class InMemoryTreeAccessors {
         return (0, ts_utils_1.captureResult)(() => new InMemoryTreeAccessors(files, params));
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.resolveAbsolutePath}
+     * Resolves paths to an absolute path.
+     * @param paths - Paths to resolve.
+     * @returns The resolved absolute path.
      */
     resolveAbsolutePath(...paths) {
         const parts = paths[0].startsWith('/') ? paths : [this._tree.prefix, ...paths];
@@ -146,7 +148,9 @@ class InMemoryTreeAccessors {
         return `/${joined}`;
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getExtension}
+     * Gets the extension of a path.
+     * @param path - Path to get the extension of.
+     * @returns The extension of the path.
      */
     getExtension(path) {
         const parts = path.split('.');
@@ -156,7 +160,10 @@ class InMemoryTreeAccessors {
         return `.${parts.pop()}`;
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getBaseName}
+     * Gets the base name of a path.
+     * @param path - Path to get the base name of.
+     * @param suffix - Optional suffix to remove from the base name.
+     * @returns The base name of the path.
      */
     getBaseName(path, suffix) {
         var _a;
@@ -168,7 +175,9 @@ class InMemoryTreeAccessors {
         return base;
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.joinPaths}
+     * Joins paths together.
+     * @param paths - Paths to join.
+     * @returns The joined paths.
      */
     joinPaths(...paths) {
         var _a;
@@ -176,7 +185,9 @@ class InMemoryTreeAccessors {
         return ((_a = paths[0]) === null || _a === void 0 ? void 0 : _a.startsWith('/')) ? `/${joined}` : joined;
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getItem}
+     * Gets an item from the file tree.
+     * @param itemPath - Path of the item to get.
+     * @returns The item if it exists.
      */
     getItem(itemPath) {
         const existing = this._tree.byAbsolutePath.get(itemPath);
@@ -191,7 +202,9 @@ class InMemoryTreeAccessors {
         return (0, ts_utils_1.fail)(`${itemPath}: not found`);
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getFileContents}
+     * Gets the contents of a file in the file tree.
+     * @param path - Absolute path of the file.
+     * @returns The contents of the file.
      */
     getFileContents(path) {
         const absolutePath = this.resolveAbsolutePath(path);
@@ -208,7 +221,10 @@ class InMemoryTreeAccessors {
         return (0, ts_utils_1.captureResult)(() => JSON.stringify(item.contents));
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getFileContentType}
+     * Gets the content type of a file in the file tree.
+     * @param path - Absolute path of the file.
+     * @param provided - Optional supplied content type.
+     * @returns The content type of the file.
      */
     getFileContentType(path, provided) {
         // If provided contentType is given, use it directly (highest priority)
@@ -231,7 +247,9 @@ class InMemoryTreeAccessors {
         return this._inferContentType(path);
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getChildren}
+     * Gets the children of a directory in the file tree.
+     * @param path - Path of the directory.
+     * @returns The children of the directory.
      */
     getChildren(path) {
         const item = this._tree.byAbsolutePath.get(path);
@@ -281,7 +299,9 @@ class InMemoryTreeAccessors {
         });
     }
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.createDirectory}
+     * Creates a directory at the given path, including any missing parent directories.
+     * @param dirPath - The path of the directory to create.
+     * @returns `Success` with the absolute path if created, or `Failure` with an error message.
      */
     createDirectory(dirPath) {
         const absolutePath = this.resolveAbsolutePath(dirPath);
@@ -312,7 +332,10 @@ class InMemoryTreeAccessors {
         return (0, ts_utils_1.succeed)(absolutePath);
     }
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.fileIsMutable}
+     * Checks if a file at the given path can be saved.
+     * @param path - The path to check.
+     * @returns `DetailedSuccess` with {@link FileTree.SaveCapability} if the file can be saved,
+     * or `DetailedFailure` with {@link FileTree.SaveFailureReason} if it cannot.
      */
     fileIsMutable(path) {
         const absolutePath = this.resolveAbsolutePath(path);
@@ -327,7 +350,9 @@ class InMemoryTreeAccessors {
         return (0, ts_utils_1.succeedWithDetail)(true, 'transient');
     }
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.deleteFile}
+     * Deletes a file at the given path.
+     * @param path - The path of the file to delete.
+     * @returns `Success` with `true` if the file was deleted, or `Failure` with an error message.
      */
     deleteFile(path) {
         const absolutePath = this.resolveAbsolutePath(path);
@@ -359,7 +384,10 @@ class InMemoryTreeAccessors {
         return (0, ts_utils_1.succeed)(true);
     }
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.deleteDirectory}
+     * Deletes a directory at the given path.
+     * The directory must be empty or the operation will fail.
+     * @param path - The path of the directory to delete.
+     * @returns `Success` with `true` if the directory was deleted, or `Failure` with an error message.
      */
     deleteDirectory(path) {
         const absolutePath = this.resolveAbsolutePath(path);
@@ -399,7 +427,10 @@ class InMemoryTreeAccessors {
         return (0, ts_utils_1.succeed)(true);
     }
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.saveFileContents}
+     * Saves the contents to a file at the given path.
+     * @param path - The path of the file to save.
+     * @param contents - The string contents to save.
+     * @returns `Success` if the file was saved, or `Failure` with an error message.
      */
     saveFileContents(path, contents) {
         const isMutable = this.fileIsMutable(path);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fgv/ts-json-base",
-  "version": "5.1.0-16",
+  "version": "5.1.0-18",
   "description": "Typescript types and basic functions for working with json",
   "main": "lib/index.js",
   "types": "dist/ts-json-base.d.ts",
@@ -55,13 +55,13 @@
     "@rushstack/heft-node-rig": "2.11.27",
     "@microsoft/api-extractor": "^7.55.2",
     "typedoc": "~0.28.16",
-    "@fgv/ts-utils": "5.1.0-16",
-    "@fgv/ts-utils-jest": "5.1.0-16",
-    "@fgv/heft-dual-rig": "5.1.0-16",
-    "@fgv/typedoc-compact-theme": "5.1.0-16"
+    "@fgv/ts-utils": "5.1.0-18",
+    "@fgv/heft-dual-rig": "5.1.0-18",
+    "@fgv/typedoc-compact-theme": "5.1.0-18",
+    "@fgv/ts-utils-jest": "5.1.0-18"
   },
   "peerDependencies": {
-    "@fgv/ts-utils": "5.1.0-16"
+    "@fgv/ts-utils": "5.1.0-18"
   },
   "dependencies": {
     "luxon": "^3.7.2"