@fgv/ts-json-base 5.0.2 → 5.1.0-1

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

@@ -94,6 +94,14 @@ class InMemoryDirectory {
         this._children.set(name, child);
         return (0, ts_utils_1.succeed)(child);
     }
+    /**
+     * Removes a child from the directory.
+     * @param name - The name of the child to remove.
+     * @returns `true` if the child was found and removed, `false` otherwise.
+     */
+    removeChild(name) {
+        return this._children.delete(name);
+    }
     /**
      * Gets the absolute path for a child of this directory with the supplied
      * name.
@@ -174,6 +182,29 @@ class TreeBuilder {
             return (0, ts_utils_1.succeed)(file);
         });
     }
+    /**
+     * Ensures a directory exists at the given absolute path, creating
+     * intermediate directories as needed.
+     * @param absolutePath - The absolute path of the directory.
+     * @returns `Success` with the directory if successful, or
+     * `Failure` with an error message otherwise.
+     * @public
+     */
+    addDirectory(absolutePath) {
+        const parts = absolutePath.split('/').filter((p) => p.length > 0);
+        let dir = this.root;
+        for (const part of parts) {
+            const result = dir.getOrAddDirectory(part);
+            if (result.isFailure()) {
+                return (0, ts_utils_1.fail)(result.message);
+            }
+            dir = result.value;
+            if (!this.byAbsolutePath.has(dir.absolutePath)) {
+                this.byAbsolutePath.set(dir.absolutePath, dir);
+            }
+        }
+        return (0, ts_utils_1.succeed)(dir);
+    }
 }
 exports.TreeBuilder = TreeBuilder;
 //# sourceMappingURL=treeBuilder.js.map

package/lib/packlets/file-tree/index.browser.d.ts

@@ -2,6 +2,7 @@ export * from './fileTreeAccessors';
 export * from './fileTree';
 export * from './directoryItem';
 export * from './fileItem';
+export * from './filterSpec';
 export * from './in-memory';
 export { inMemory } from './fileTreeHelpers.inMemory';
 //# sourceMappingURL=index.browser.d.ts.map

package/lib/packlets/file-tree/index.browser.js

@@ -42,6 +42,7 @@ __exportStar(require("./fileTreeAccessors"), exports);
 __exportStar(require("./fileTree"), exports);
 __exportStar(require("./directoryItem"), exports);
 __exportStar(require("./fileItem"), exports);
+__exportStar(require("./filterSpec"), exports);
 // Export in-memory implementations for web compatibility
 __exportStar(require("./in-memory"), exports);
 var fileTreeHelpers_inMemory_1 = require("./fileTreeHelpers.inMemory");

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

@@ -2,6 +2,7 @@ export * from './fileTreeAccessors';
 export * from './fileTree';
 export * from './directoryItem';
 export * from './fileItem';
+export * from './filterSpec';
 export * from './fileTreeHelpers';
 export { inMemory } from './fileTreeHelpers.inMemory';
 export * from './in-memory';

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

@@ -41,6 +41,7 @@ __exportStar(require("./fileTreeAccessors"), exports);
 __exportStar(require("./fileTree"), exports);
 __exportStar(require("./directoryItem"), exports);
 __exportStar(require("./fileItem"), exports);
+__exportStar(require("./filterSpec"), exports);
 // Export tree-shakeable helpers (filesystem ones will be shaken out if not used)
 __exportStar(require("./fileTreeHelpers"), exports);
 var fileTreeHelpers_inMemory_1 = require("./fileTreeHelpers.inMemory");

package/lib/packlets/json-file/file.d.ts

@@ -2,7 +2,7 @@ import { Converter, Result } from '@fgv/ts-utils';
 import { JsonValue } from '../json';
 import { IJsonFsDirectoryOptions, IJsonFsDirectoryToMapOptions, IReadDirectoryItem } from './jsonFsHelper';
 /**
- * {@inheritdoc JsonFile.JsonFsHelper.readJsonFileSync}
+ * {@inheritDoc JsonFile.JsonFsHelper.readJsonFileSync}
  * @public
  */
 export declare function readJsonFileSync(srcPath: string): Result<JsonValue>;

package/lib/packlets/json-file/file.js

@@ -29,7 +29,7 @@ exports.writeJsonFileSync = writeJsonFileSync;
 const jsonFsHelper_1 = require("./jsonFsHelper");
 const jsonLike_1 = require("./jsonLike");
 /**
- * {@inheritdoc JsonFile.JsonFsHelper.readJsonFileSync}
+ * {@inheritDoc JsonFile.JsonFsHelper.readJsonFileSync}
  * @public
  */
 function readJsonFileSync(srcPath) {

package/lib/packlets/json-file/jsonFsHelper.d.ts

@@ -74,7 +74,7 @@ export declare class JsonFsHelper {
     readonly config: IJsonFsHelperConfig;
     /**
      * Construct a new {@link JsonFile.JsonFsHelper | JsonFsHelper}.
-     * @param json - Optional {@link JsonFile.IJsonLike | IJsonLike} used to process strings
+     * @param init - Optional {@link JsonFile.JsonFsHelperInitOptions | init options} to construct
      * and JSON values.
      */
     constructor(init?: JsonFsHelperInitOptions);

package/lib/packlets/json-file/jsonFsHelper.js

@@ -54,7 +54,7 @@ exports.DefaultJsonFsHelperConfig = {
 class JsonFsHelper {
     /**
      * Construct a new {@link JsonFile.JsonFsHelper | JsonFsHelper}.
-     * @param json - Optional {@link JsonFile.IJsonLike | IJsonLike} used to process strings
+     * @param init - Optional {@link JsonFile.JsonFsHelperInitOptions | init options} to construct
      * and JSON values.
      */
     constructor(init) {

package/lib/packlets/validators/validators.d.ts

@@ -38,42 +38,42 @@ export declare const jsonArray: Validator<JsonArray, IJsonValidatorContext>;
  */
 export declare const jsonValue: Validator<JsonValue, IJsonValidatorContext>;
 /**
- * A {@link Validation.Classes.StringValidator | StringValidator} which validates a string in place.
+ * A `StringValidator` which validates a string in place.
  * Accepts {@link Validators.IJsonValidatorContext | IJsonValidatorContext} but ignores it.
  * @public
  */
 export declare const string: Validation.Classes.StringValidator<string, IJsonValidatorContext>;
 /**
- * A {@link Validation.Classes.NumberValidator | NumberValidator} which validates a number in place.
+ * A `NumberValidator` which validates a number in place.
  * Accepts {@link Validators.IJsonValidatorContext | IJsonValidatorContext} but ignores it.
  * @public
  */
-export declare const number: Validator<number, IJsonValidatorContext>;
+export declare const number: Validation.Classes.NumberValidator<number, IJsonValidatorContext>;
 /**
- * A {@link Validation.Classes.BooleanValidator | BooleanValidator} which validates a boolean in place.
- * Accepts {@link Validators.IJsonValidatorContext | IJsonValidatorContext} but ignores it.
+ * A `BooleanValidator` which validates a boolean in place.
+ * Accepts `IJsonValidatorContext` but ignores it.
  * @public
  */
 export declare const boolean: Validator<boolean, IJsonValidatorContext>;
 /**
  * Helper to create a validator for a literal value.
- * Accepts {@link Validators.IJsonValidatorContext | IJsonValidatorContext} but ignores it.
+ * Accepts `IJsonValidatorContext` but ignores it.
  * Mirrors the behavior of `@fgv/ts-utils`.
  * @public
  */
 export declare function literal<T>(value: T): Validator<T, IJsonValidatorContext>;
 /**
- * Helper function to create a {@link Validator | Validator} which validates `unknown` to one of a set of
+ * Helper function to create a `Validator` which validates `unknown` to one of a set of
  * supplied enumerated values. Anything else fails.
  *
  * @remarks
- * This JSON variant accepts an {@link Validators.IJsonValidatorContext | IJsonValidatorContext} OR
+ * This JSON variant accepts an `IJsonValidatorContext` OR
  * a `ReadonlyArray<T>` as its validation context. If the context is an array, it is used to override the
  * allowed values for that validation; otherwise, the original `values` supplied at creation time are used.
  *
  * @param values - Array of allowed values.
  * @param message - Optional custom failure message.
- * @returns A new {@link Validator | Validator} returning `<T>`.
+ * @returns A new `Validator` returning `<T>`.
  * @public
  */
 export declare function enumeratedValue<T>(values: ReadonlyArray<T>, message?: string): Validator<T, IJsonValidatorContext | ReadonlyArray<T>>;

package/lib/packlets/validators/validators.js

@@ -125,26 +125,26 @@ exports.jsonValue = new ts_utils_1.Validation.Base.GenericValidator({
     }
 });
 /**
- * A {@link Validation.Classes.StringValidator | StringValidator} which validates a string in place.
+ * A `StringValidator` which validates a string in place.
  * Accepts {@link Validators.IJsonValidatorContext | IJsonValidatorContext} but ignores it.
  * @public
  */
 exports.string = new ts_utils_1.Validation.Classes.StringValidator();
 /**
- * A {@link Validation.Classes.NumberValidator | NumberValidator} which validates a number in place.
+ * A `NumberValidator` which validates a number in place.
  * Accepts {@link Validators.IJsonValidatorContext | IJsonValidatorContext} but ignores it.
  * @public
  */
 exports.number = new ts_utils_1.Validation.Classes.NumberValidator();
 /**
- * A {@link Validation.Classes.BooleanValidator | BooleanValidator} which validates a boolean in place.
- * Accepts {@link Validators.IJsonValidatorContext | IJsonValidatorContext} but ignores it.
+ * A `BooleanValidator` which validates a boolean in place.
+ * Accepts `IJsonValidatorContext` but ignores it.
  * @public
  */
 exports.boolean = new ts_utils_1.Validation.Classes.BooleanValidator();
 /**
  * Helper to create a validator for a literal value.
- * Accepts {@link Validators.IJsonValidatorContext | IJsonValidatorContext} but ignores it.
+ * Accepts `IJsonValidatorContext` but ignores it.
  * Mirrors the behavior of `@fgv/ts-utils`.
  * @public
  */
@@ -156,17 +156,17 @@ function literal(value) {
     });
 }
 /**
- * Helper function to create a {@link Validator | Validator} which validates `unknown` to one of a set of
+ * Helper function to create a `Validator` which validates `unknown` to one of a set of
  * supplied enumerated values. Anything else fails.
  *
  * @remarks
- * This JSON variant accepts an {@link Validators.IJsonValidatorContext | IJsonValidatorContext} OR
+ * This JSON variant accepts an `IJsonValidatorContext` OR
  * a `ReadonlyArray<T>` as its validation context. If the context is an array, it is used to override the
  * allowed values for that validation; otherwise, the original `values` supplied at creation time are used.
  *
  * @param values - Array of allowed values.
  * @param message - Optional custom failure message.
- * @returns A new {@link Validator | Validator} returning `<T>`.
+ * @returns A new `Validator` returning `<T>`.
  * @public
  */
 function enumeratedValue(values, message) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fgv/ts-json-base",
-  "version": "5.0.2",
+  "version": "5.1.0-1",
   "description": "Typescript types and basic functions for working with json",
   "main": "lib/index.js",
   "types": "dist/ts-json-base.d.ts",
@@ -17,6 +17,17 @@
       "types": "./dist/ts-json-base.d.ts"
     }
   },
+  "scripts": {
+    "build": "heft build --clean",
+    "clean": "heft clean",
+    "test": "heft test --clean",
+    "build-docs": "typedoc --options ./config/typedoc.json",
+    "build-all": "rushx build; rushx build-docs",
+    "test-handles": "jest --runInBand --detectOpenHandles",
+    "clean-jest": "jest --clear-cache",
+    "lint": "eslint src --ext .ts",
+    "fixlint": "eslint src --ext .ts --fix"
+  },
   "keywords": [
     "typescript",
     "json"
@@ -29,37 +40,37 @@
   "homepage": "https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base#readme",
   "sideEffects": false,
   "devDependencies": {
+    "@fgv/ts-utils": "workspace:*",
+    "@fgv/ts-utils-jest": "workspace:*",
     "@types/jest": "^29.5.14",
     "@types/node": "^20.14.9",
-    "@typescript-eslint/eslint-plugin": "^8.46.2",
-    "@typescript-eslint/parser": "^8.46.2",
-    "eslint": "^9.39.0",
+    "@typescript-eslint/eslint-plugin": "^8.52.0",
+    "@typescript-eslint/parser": "^8.52.0",
+    "eslint": "^9.39.2",
     "eslint-plugin-import": "^2.32.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^7.2.1",
     "jest": "^29.7.0",
     "jest-extended": "^4.0.2",
-    "rimraf": "^6.1.0",
-    "ts-jest": "^29.4.5",
+    "rimraf": "^6.1.2",
+    "ts-jest": "^29.4.6",
     "ts-node": "^10.9.2",
     "typescript": "5.9.3",
     "eslint-plugin-n": "^17.23.1",
-    "@rushstack/heft": "1.1.3",
-    "@rushstack/heft-jest-plugin": "1.1.3",
+    "@rushstack/heft": "1.2.6",
+    "@rushstack/heft-jest-plugin": "1.2.6",
     "@types/heft-jest": "1.0.6",
-    "@microsoft/api-documenter": "^7.27.3",
+    "@microsoft/api-documenter": "^7.28.2",
     "@rushstack/eslint-patch": "1.14.1",
-    "@rushstack/eslint-config": "4.5.3",
-    "eslint-plugin-tsdoc": "~0.4.0",
+    "@rushstack/eslint-config": "4.6.4",
+    "eslint-plugin-tsdoc": "~0.5.2",
     "@types/luxon": "^3.7.1",
-    "@rushstack/heft-node-rig": "2.11.4",
-    "@microsoft/api-extractor": "^7.53.3",
-    "@fgv/ts-utils": "5.0.2",
-    "@fgv/heft-dual-rig": "0.1.0",
-    "@fgv/ts-utils-jest": "5.0.2"
+    "@fgv/heft-dual-rig": "workspace:*",
+    "@rushstack/heft-node-rig": "2.11.26",
+    "@microsoft/api-extractor": "^7.55.2"
   },
   "peerDependencies": {
-    "@fgv/ts-utils": "5.0.2"
+    "@fgv/ts-utils": "workspace:*"
   },
   "dependencies": {
     "luxon": "^3.7.2"
@@ -67,17 +78,5 @@
   "repository": {
     "type": "git",
     "url": "https://github.com/ErikFortune/fgv.git"
-  },
-  "scripts": {
-    "build": "heft build --clean",
-    "clean": "heft clean",
-    "test": "heft test --clean",
-    "build-docs": "api-documenter markdown --input-folder ./temp --output-folder docs",
-    "build-all": "rushx build; rushx build-docs",
-    "test-handles": "jest --runInBand --detectOpenHandles",
-    "clean-jest": "jest --clear-cache",
-    "coverage": "jest --coverage --no-cache",
-    "lint": "eslint src --ext .ts",
-    "fixlint": "eslint src --ext .ts --fix"
   }
-}
+}

package/dist/test/fixtures/file-tree/docs/api/reference.json

@@ -1 +0,0 @@
-{ "endpoints": [] }