@fgv/ts-json-base 5.1.0-2 → 5.1.0-20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (113) hide show
  1. package/dist/index.browser.js.map +1 -0
  2. package/dist/index.js.map +1 -0
  3. package/dist/packlets/converters/converters.js.map +1 -0
  4. package/dist/packlets/converters/index.js.map +1 -0
  5. package/dist/packlets/file-tree/directoryItem.js.map +1 -0
  6. package/dist/packlets/file-tree/fileItem.js +11 -4
  7. package/dist/packlets/file-tree/fileItem.js.map +1 -0
  8. package/dist/packlets/file-tree/fileTree.js.map +1 -0
  9. package/dist/packlets/file-tree/fileTreeAccessors.js.map +1 -0
  10. package/dist/packlets/file-tree/fileTreeHelpers.inMemory.js.map +1 -0
  11. package/dist/packlets/file-tree/fileTreeHelpers.js.map +1 -0
  12. package/dist/packlets/file-tree/filterSpec.js.map +1 -0
  13. package/dist/packlets/file-tree/fsTree.js +44 -13
  14. package/dist/packlets/file-tree/fsTree.js.map +1 -0
  15. package/dist/packlets/file-tree/in-memory/inMemoryTree.js +44 -13
  16. package/dist/packlets/file-tree/in-memory/inMemoryTree.js.map +1 -0
  17. package/dist/packlets/file-tree/in-memory/index.js.map +1 -0
  18. package/dist/packlets/file-tree/in-memory/treeBuilder.js.map +1 -0
  19. package/dist/packlets/file-tree/index.browser.js.map +1 -0
  20. package/dist/packlets/file-tree/index.js.map +1 -0
  21. package/dist/packlets/json/common.js.map +1 -0
  22. package/dist/packlets/json/index.js.map +1 -0
  23. package/dist/packlets/json-compatible/common.js.map +1 -0
  24. package/dist/packlets/json-compatible/converters.js.map +1 -0
  25. package/dist/packlets/json-compatible/index.js.map +1 -0
  26. package/dist/packlets/json-compatible/validators.js.map +1 -0
  27. package/dist/packlets/json-file/file.js.map +1 -0
  28. package/dist/packlets/json-file/index.browser.js.map +1 -0
  29. package/dist/packlets/json-file/index.js.map +1 -0
  30. package/dist/packlets/json-file/jsonFsHelper.js.map +1 -0
  31. package/dist/packlets/json-file/jsonLike.js.map +1 -0
  32. package/dist/packlets/json-file/jsonTreeHelper.js.map +1 -0
  33. package/dist/packlets/validators/index.js.map +1 -0
  34. package/dist/packlets/validators/validators.js.map +1 -0
  35. package/dist/ts-json-base.d.ts +99 -30
  36. package/dist/tsdoc-metadata.json +1 -1
  37. package/lib/index.browser.d.ts.map +1 -0
  38. package/lib/index.browser.js.map +1 -0
  39. package/lib/index.d.ts.map +1 -0
  40. package/lib/index.js.map +1 -0
  41. package/lib/packlets/converters/converters.d.ts.map +1 -0
  42. package/lib/packlets/converters/converters.js.map +1 -0
  43. package/lib/packlets/converters/index.d.ts.map +1 -0
  44. package/lib/packlets/converters/index.js.map +1 -0
  45. package/lib/packlets/file-tree/directoryItem.d.ts.map +1 -0
  46. package/lib/packlets/file-tree/directoryItem.js.map +1 -0
  47. package/lib/packlets/file-tree/fileItem.d.ts +11 -4
  48. package/lib/packlets/file-tree/fileItem.d.ts.map +1 -0
  49. package/lib/packlets/file-tree/fileItem.js +11 -4
  50. package/lib/packlets/file-tree/fileItem.js.map +1 -0
  51. package/lib/packlets/file-tree/fileTree.d.ts.map +1 -0
  52. package/lib/packlets/file-tree/fileTree.js.map +1 -0
  53. package/lib/packlets/file-tree/fileTreeAccessors.d.ts.map +1 -0
  54. package/lib/packlets/file-tree/fileTreeAccessors.js.map +1 -0
  55. package/lib/packlets/file-tree/fileTreeHelpers.d.ts.map +1 -0
  56. package/lib/packlets/file-tree/fileTreeHelpers.inMemory.d.ts.map +1 -0
  57. package/lib/packlets/file-tree/fileTreeHelpers.inMemory.js.map +1 -0
  58. package/lib/packlets/file-tree/fileTreeHelpers.js.map +1 -0
  59. package/lib/packlets/file-tree/filterSpec.d.ts.map +1 -0
  60. package/lib/packlets/file-tree/filterSpec.js.map +1 -0
  61. package/lib/packlets/file-tree/fsTree.d.ts +44 -13
  62. package/lib/packlets/file-tree/fsTree.d.ts.map +1 -0
  63. package/lib/packlets/file-tree/fsTree.js +44 -13
  64. package/lib/packlets/file-tree/fsTree.js.map +1 -0
  65. package/lib/packlets/file-tree/in-memory/inMemoryTree.d.ts +44 -13
  66. package/lib/packlets/file-tree/in-memory/inMemoryTree.d.ts.map +1 -0
  67. package/lib/packlets/file-tree/in-memory/inMemoryTree.js +44 -13
  68. package/lib/packlets/file-tree/in-memory/inMemoryTree.js.map +1 -0
  69. package/lib/packlets/file-tree/in-memory/index.d.ts.map +1 -0
  70. package/lib/packlets/file-tree/in-memory/index.js.map +1 -0
  71. package/lib/packlets/file-tree/in-memory/treeBuilder.d.ts.map +1 -0
  72. package/lib/packlets/file-tree/in-memory/treeBuilder.js.map +1 -0
  73. package/lib/packlets/file-tree/index.browser.d.ts.map +1 -0
  74. package/lib/packlets/file-tree/index.browser.js.map +1 -0
  75. package/lib/packlets/file-tree/index.d.ts.map +1 -0
  76. package/lib/packlets/file-tree/index.js.map +1 -0
  77. package/lib/packlets/json/common.d.ts.map +1 -0
  78. package/lib/packlets/json/common.js.map +1 -0
  79. package/lib/packlets/json/index.d.ts.map +1 -0
  80. package/lib/packlets/json/index.js.map +1 -0
  81. package/lib/packlets/json-compatible/common.d.ts.map +1 -0
  82. package/lib/packlets/json-compatible/common.js.map +1 -0
  83. package/lib/packlets/json-compatible/converters.d.ts.map +1 -0
  84. package/lib/packlets/json-compatible/converters.js.map +1 -0
  85. package/lib/packlets/json-compatible/index.d.ts.map +1 -0
  86. package/lib/packlets/json-compatible/index.js.map +1 -0
  87. package/lib/packlets/json-compatible/validators.d.ts.map +1 -0
  88. package/lib/packlets/json-compatible/validators.js.map +1 -0
  89. package/lib/packlets/json-file/file.d.ts.map +1 -0
  90. package/lib/packlets/json-file/file.js.map +1 -0
  91. package/lib/packlets/json-file/index.browser.d.ts.map +1 -0
  92. package/lib/packlets/json-file/index.browser.js.map +1 -0
  93. package/lib/packlets/json-file/index.d.ts.map +1 -0
  94. package/lib/packlets/json-file/index.js.map +1 -0
  95. package/lib/packlets/json-file/jsonFsHelper.d.ts.map +1 -0
  96. package/lib/packlets/json-file/jsonFsHelper.js.map +1 -0
  97. package/lib/packlets/json-file/jsonLike.d.ts.map +1 -0
  98. package/lib/packlets/json-file/jsonLike.js.map +1 -0
  99. package/lib/packlets/json-file/jsonTreeHelper.d.ts.map +1 -0
  100. package/lib/packlets/json-file/jsonTreeHelper.js.map +1 -0
  101. package/lib/packlets/validators/index.d.ts.map +1 -0
  102. package/lib/packlets/validators/index.js.map +1 -0
  103. package/lib/packlets/validators/validators.d.ts.map +1 -0
  104. package/lib/packlets/validators/validators.js.map +1 -0
  105. package/package.json +22 -20
  106. package/dist/test/fixtures/file-tree/config.json +0 -1
  107. package/dist/test/fixtures/file-tree/data/items.json +0 -1
  108. package/dist/test/unit/data/file/bad/bad3.json +0 -3
  109. package/dist/test/unit/data/file/bad/thing1.json +0 -4
  110. package/dist/test/unit/data/file/bad/thing2.json +0 -3
  111. package/dist/test/unit/data/file/good/thing1.json +0 -4
  112. package/dist/test/unit/data/file/good/thing2.json +0 -3
  113. package/dist/test/unit/json-compatible/helpers.js +0 -32
@@ -345,7 +345,9 @@ declare class FileItem<TCT extends string = string> implements IMutableFileTreeF
345
345
  */
346
346
  static create<TCT extends string = string>(path: string, hal: IFileTreeAccessors<TCT>): Result<FileItem<TCT>>;
347
347
  /**
348
- * {@inheritDoc FileTree.IFileTreeFileItem.getIsMutable}
348
+ * Indicates whether this file can be saved.
349
+ * @returns `DetailedSuccess` with {@link FileTree.SaveCapability} if the file can be saved,
350
+ * or `DetailedFailure` with {@link FileTree.SaveFailureReason} if it cannot.
349
351
  */
350
352
  getIsMutable(): DetailedResult<boolean, SaveDetail>;
351
353
  /**
@@ -366,15 +368,20 @@ declare class FileItem<TCT extends string = string> implements IMutableFileTreeF
366
368
  */
367
369
  setContentType(contentType: TCT | undefined): void;
368
370
  /**
369
- * {@inheritDoc FileTree.IFileTreeFileItem.setContents}
371
+ * Sets the contents of the file from a JSON value.
372
+ * @param json - The JSON value to serialize and save.
373
+ * @returns `Success` if the file was saved, or `Failure` with an error message.
370
374
  */
371
375
  setContents(json: JsonValue): Result<JsonValue>;
372
376
  /**
373
- * {@inheritDoc FileTree.IFileTreeFileItem.setRawContents}
377
+ * Sets the raw contents of the file.
378
+ * @param contents - The string contents to save.
379
+ * @returns `Success` if the file was saved, or `Failure` with an error message.
374
380
  */
375
381
  setRawContents(contents: string): Result<string>;
376
382
  /**
377
- * {@inheritDoc FileTree.IFileTreeFileItem.delete}
383
+ * Deletes this file from its backing store.
384
+ * @returns `Success` with `true` if the file was deleted, or `Failure` with an error message.
378
385
  */
379
386
  delete(): Result<boolean>;
380
387
  /**
@@ -542,55 +549,86 @@ declare class FsFileTreeAccessors<TCT extends string = string> implements IMutab
542
549
  */
543
550
  constructor(params?: IFileTreeInitParams<TCT>);
544
551
  /**
545
- * {@inheritDoc FileTree.IFileTreeAccessors.resolveAbsolutePath}
552
+ * Resolves paths to an absolute path.
553
+ * @param paths - Paths to resolve.
554
+ * @returns The resolved absolute path.
546
555
  */
547
556
  resolveAbsolutePath(...paths: string[]): string;
548
557
  /**
549
- * {@inheritDoc FileTree.IFileTreeAccessors.getExtension}
558
+ * Gets the extension of a path.
559
+ * @param itemPath - Path to get the extension of.
560
+ * @returns The extension of the path.
550
561
  */
551
562
  getExtension(itemPath: string): string;
552
563
  /**
553
- * {@inheritDoc FileTree.IFileTreeAccessors.getBaseName}
564
+ * Gets the base name of a path.
565
+ * @param itemPath - Path to get the base name of.
566
+ * @param suffix - Optional suffix to remove from the base name.
567
+ * @returns The base name of the path.
554
568
  */
555
569
  getBaseName(itemPath: string, suffix?: string): string;
556
570
  /**
557
- * {@inheritDoc FileTree.IFileTreeAccessors.joinPaths}
571
+ * Joins paths together.
572
+ * @param paths - Paths to join.
573
+ * @returns The joined paths.
558
574
  */
559
575
  joinPaths(...paths: string[]): string;
560
576
  /**
561
- * {@inheritDoc FileTree.IFileTreeAccessors.getItem}
577
+ * Gets an item from the file tree.
578
+ * @param itemPath - Path of the item to get.
579
+ * @returns The item if it exists.
562
580
  */
563
581
  getItem(itemPath: string): Result<FileTreeItem<TCT>>;
564
582
  /**
565
- * {@inheritDoc FileTree.IFileTreeAccessors.getFileContents}
583
+ * Gets the contents of a file in the file tree.
584
+ * @param filePath - Absolute path of the file.
585
+ * @returns The contents of the file.
566
586
  */
567
587
  getFileContents(filePath: string): Result<string>;
568
588
  /**
569
- * {@inheritDoc FileTree.IFileTreeAccessors.getFileContentType}
589
+ * Gets the content type of a file in the file tree.
590
+ * @param filePath - Absolute path of the file.
591
+ * @param provided - Optional supplied content type.
592
+ * @returns The content type of the file.
570
593
  */
571
594
  getFileContentType(filePath: string, provided?: string): Result<TCT | undefined>;
572
595
  /**
573
- * {@inheritDoc FileTree.IFileTreeAccessors.getChildren}
596
+ * Gets the children of a directory in the file tree.
597
+ * @param dirPath - Path of the directory.
598
+ * @returns The children of the directory.
574
599
  */
575
600
  getChildren(dirPath: string): Result<ReadonlyArray<FileTreeItem<TCT>>>;
576
601
  /**
577
- * {@inheritDoc FileTree.IMutableFileTreeAccessors.fileIsMutable}
602
+ * Checks if a file at the given path can be saved.
603
+ * @param path - The path to check.
604
+ * @returns `DetailedSuccess` with {@link FileTree.SaveCapability} if the file can be saved,
605
+ * or `DetailedFailure` with {@link FileTree.SaveFailureReason} if it cannot.
578
606
  */
579
607
  fileIsMutable(path: string): DetailedResult<boolean, SaveDetail>;
580
608
  /**
581
- * {@inheritDoc FileTree.IMutableFileTreeAccessors.saveFileContents}
609
+ * Saves the contents to a file at the given path.
610
+ * @param path - The path of the file to save.
611
+ * @param contents - The string contents to save.
612
+ * @returns `Success` if the file was saved, or `Failure` with an error message.
582
613
  */
583
614
  saveFileContents(path: string, contents: string): Result<string>;
584
615
  /**
585
- * {@inheritDoc FileTree.IMutableFileTreeAccessors.deleteFile}
616
+ * Deletes a file at the given path.
617
+ * @param path - The path of the file to delete.
618
+ * @returns `Success` with `true` if the file was deleted, or `Failure` with an error message.
586
619
  */
587
620
  deleteFile(path: string): Result<boolean>;
588
621
  /**
589
- * {@inheritDoc FileTree.IMutableFileTreeAccessors.createDirectory}
622
+ * Creates a directory at the given path, including any missing parent directories.
623
+ * @param dirPath - The path of the directory to create.
624
+ * @returns `Success` with the absolute path if created, or `Failure` with an error message.
590
625
  */
591
626
  createDirectory(dirPath: string): Result<string>;
592
627
  /**
593
- * {@inheritDoc FileTree.IMutableFileTreeAccessors.deleteDirectory}
628
+ * Deletes a directory at the given path.
629
+ * The directory must be empty or the operation will fail.
630
+ * @param dirPath - The path of the directory to delete.
631
+ * @returns `Success` with `true` if the directory was deleted, or `Failure` with an error message.
594
632
  */
595
633
  deleteDirectory(dirPath: string): Result<boolean>;
596
634
  }
@@ -1011,56 +1049,87 @@ declare class InMemoryTreeAccessors<TCT extends string = string> implements IMut
1011
1049
  */
1012
1050
  static create<TCT extends string = string>(files: IInMemoryFile<TCT>[], params?: IFileTreeInitParams<TCT>): Result<InMemoryTreeAccessors<TCT>>;
1013
1051
  /**
1014
- * {@inheritDoc FileTree.IFileTreeAccessors.resolveAbsolutePath}
1052
+ * Resolves paths to an absolute path.
1053
+ * @param paths - Paths to resolve.
1054
+ * @returns The resolved absolute path.
1015
1055
  */
1016
1056
  resolveAbsolutePath(...paths: string[]): string;
1017
1057
  /**
1018
- * {@inheritDoc FileTree.IFileTreeAccessors.getExtension}
1058
+ * Gets the extension of a path.
1059
+ * @param path - Path to get the extension of.
1060
+ * @returns The extension of the path.
1019
1061
  */
1020
1062
  getExtension(path: string): string;
1021
1063
  /**
1022
- * {@inheritDoc FileTree.IFileTreeAccessors.getBaseName}
1064
+ * Gets the base name of a path.
1065
+ * @param path - Path to get the base name of.
1066
+ * @param suffix - Optional suffix to remove from the base name.
1067
+ * @returns The base name of the path.
1023
1068
  */
1024
1069
  getBaseName(path: string, suffix?: string): string;
1025
1070
  /**
1026
- * {@inheritDoc FileTree.IFileTreeAccessors.joinPaths}
1071
+ * Joins paths together.
1072
+ * @param paths - Paths to join.
1073
+ * @returns The joined paths.
1027
1074
  */
1028
1075
  joinPaths(...paths: string[]): string;
1029
1076
  /**
1030
- * {@inheritDoc FileTree.IFileTreeAccessors.getItem}
1077
+ * Gets an item from the file tree.
1078
+ * @param itemPath - Path of the item to get.
1079
+ * @returns The item if it exists.
1031
1080
  */
1032
1081
  getItem(itemPath: string): Result<FileTreeItem<TCT>>;
1033
1082
  /**
1034
- * {@inheritDoc FileTree.IFileTreeAccessors.getFileContents}
1083
+ * Gets the contents of a file in the file tree.
1084
+ * @param path - Absolute path of the file.
1085
+ * @returns The contents of the file.
1035
1086
  */
1036
1087
  getFileContents(path: string): Result<string>;
1037
1088
  /**
1038
- * {@inheritDoc FileTree.IFileTreeAccessors.getFileContentType}
1089
+ * Gets the content type of a file in the file tree.
1090
+ * @param path - Absolute path of the file.
1091
+ * @param provided - Optional supplied content type.
1092
+ * @returns The content type of the file.
1039
1093
  */
1040
1094
  getFileContentType(path: string, provided?: string): Result<TCT | undefined>;
1041
1095
  /**
1042
- * {@inheritDoc FileTree.IFileTreeAccessors.getChildren}
1096
+ * Gets the children of a directory in the file tree.
1097
+ * @param path - Path of the directory.
1098
+ * @returns The children of the directory.
1043
1099
  */
1044
1100
  getChildren(path: string): Result<ReadonlyArray<FileTreeItem<TCT>>>;
1045
1101
  private _addMutableFile;
1046
1102
  /**
1047
- * {@inheritDoc FileTree.IMutableFileTreeAccessors.createDirectory}
1103
+ * Creates a directory at the given path, including any missing parent directories.
1104
+ * @param dirPath - The path of the directory to create.
1105
+ * @returns `Success` with the absolute path if created, or `Failure` with an error message.
1048
1106
  */
1049
1107
  createDirectory(dirPath: string): Result<string>;
1050
1108
  /**
1051
- * {@inheritDoc FileTree.IMutableFileTreeAccessors.fileIsMutable}
1109
+ * Checks if a file at the given path can be saved.
1110
+ * @param path - The path to check.
1111
+ * @returns `DetailedSuccess` with {@link FileTree.SaveCapability} if the file can be saved,
1112
+ * or `DetailedFailure` with {@link FileTree.SaveFailureReason} if it cannot.
1052
1113
  */
1053
1114
  fileIsMutable(path: string): DetailedResult<boolean, SaveDetail>;
1054
1115
  /**
1055
- * {@inheritDoc FileTree.IMutableFileTreeAccessors.deleteFile}
1116
+ * Deletes a file at the given path.
1117
+ * @param path - The path of the file to delete.
1118
+ * @returns `Success` with `true` if the file was deleted, or `Failure` with an error message.
1056
1119
  */
1057
1120
  deleteFile(path: string): Result<boolean>;
1058
1121
  /**
1059
- * {@inheritDoc FileTree.IMutableFileTreeAccessors.deleteDirectory}
1122
+ * Deletes a directory at the given path.
1123
+ * The directory must be empty or the operation will fail.
1124
+ * @param path - The path of the directory to delete.
1125
+ * @returns `Success` with `true` if the directory was deleted, or `Failure` with an error message.
1060
1126
  */
1061
1127
  deleteDirectory(path: string): Result<boolean>;
1062
1128
  /**
1063
- * {@inheritDoc FileTree.IMutableFileTreeAccessors.saveFileContents}
1129
+ * Saves the contents to a file at the given path.
1130
+ * @param path - The path of the file to save.
1131
+ * @param contents - The string contents to save.
1132
+ * @returns `Success` if the file was saved, or `Failure` with an error message.
1064
1133
  */
1065
1134
  saveFileContents(path: string, contents: string): Result<string>;
1066
1135
  }
@@ -5,7 +5,7 @@
5
5
  "toolPackages": [
6
6
  {
7
7
  "packageName": "@microsoft/api-extractor",
8
- "packageVersion": "7.57.6"
8
+ "packageVersion": "7.57.7"
9
9
  }
10
10
  ]
11
11
  }
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.browser.d.ts","sourceRoot":"","sources":["../src/index.browser.ts"],"names":[],"mappings":"AAsBA,OAAO,KAAK,UAAU,MAAM,uBAAuB,CAAC;AAEpD,OAAO,KAAK,QAAQ,MAAM,oCAAoC,CAAC;AAC/D,OAAO,KAAK,cAAc,MAAM,4BAA4B,CAAC;AAE7D,OAAO,KAAK,QAAQ,MAAM,oCAAoC,CAAC;AAC/D,OAAO,KAAK,UAAU,MAAM,uBAAuB,CAAC;AAEpD,cAAc,iBAAiB,CAAC;AAChC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,cAAc,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC"}
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.browser.js","sourceRoot":"","sources":["../src/index.browser.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,kEAAoD;AAS3C,gCAAU;AARnB,yDAAyD;AACzD,6EAA+D;AAO1C,4BAAQ;AAN7B,2EAA6D;AAM9B,wCAAc;AAL7C,yDAAyD;AACzD,6EAA+D;AAIhB,4BAAQ;AAHvD,kEAAoD;AAGK,gCAAU;AADnE,kDAAgC","sourcesContent":["/*\n * Copyright (c) 2023 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport * as Converters from './packlets/converters';\n// eslint-disable-next-line @rushstack/packlets/mechanics\nimport * as FileTree from './packlets/file-tree/index.browser';\nimport * as JsonCompatible from './packlets/json-compatible';\n// eslint-disable-next-line @rushstack/packlets/mechanics\nimport * as JsonFile from './packlets/json-file/index.browser';\nimport * as Validators from './packlets/validators';\n\nexport * from './packlets/json';\nexport { Converters, FileTree, JsonCompatible, JsonFile, Validators };\n"]}
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAsBA,OAAO,KAAK,UAAU,MAAM,uBAAuB,CAAC;AACpD,OAAO,KAAK,QAAQ,MAAM,sBAAsB,CAAC;AACjD,OAAO,KAAK,cAAc,MAAM,4BAA4B,CAAC;AAC7D,OAAO,KAAK,QAAQ,MAAM,sBAAsB,CAAC;AACjD,OAAO,KAAK,UAAU,MAAM,uBAAuB,CAAC;AAEpD,cAAc,iBAAiB,CAAC;AAChC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,cAAc,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC"}
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,kEAAoD;AAO3C,gCAAU;AANnB,+DAAiD;AAM5B,4BAAQ;AAL7B,2EAA6D;AAK9B,wCAAc;AAJ7C,+DAAiD;AAIF,4BAAQ;AAHvD,kEAAoD;AAGK,gCAAU;AADnE,kDAAgC","sourcesContent":["/*\n * Copyright (c) 2023 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport * as Converters from './packlets/converters';\nimport * as FileTree from './packlets/file-tree';\nimport * as JsonCompatible from './packlets/json-compatible';\nimport * as JsonFile from './packlets/json-file';\nimport * as Validators from './packlets/validators';\n\nexport * from './packlets/json';\nexport { Converters, FileTree, JsonCompatible, JsonFile, Validators };\n"]}
@@ -0,0 +1 @@
1
+ {"version":3,"file":"converters.d.ts","sourceRoot":"","sources":["../../../src/packlets/converters/converters.ts"],"names":[],"mappings":"AAsBA,OAAO,EAEL,SAAS,EAGT,eAAe,EAIhB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,aAAa,EAAE,SAAS,EAA6B,MAAM,SAAS,CAAC;AAIrG;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,yBAAyB,CAAC,EAAE,OAAO,CAAC;CACrC;AAED;;;GAGG;AACH,eAAO,MAAM,aAAa,EAAE,SAAS,CAAC,aAAa,EAAE,qBAAqB,CAqBzE,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,UAAU,EAAE,SAAS,CAAC,UAAU,EAAE,qBAAqB,CAgCnE,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,SAAS,EAAE,SAAS,CAAC,SAAS,EAAE,qBAAqB,CAkCjE,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,EAAE,SAAS,CAAC,SAAS,EAAE,qBAAqB,CAgBjE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,MAAM,EAAE,eAAe,CAAC,MAAM,EAAE,qBAAqB,CAG/D,CAAC;AAEJ;;;;;GAKG;AACH,eAAO,MAAM,MAAM,EAAE,SAAS,CAAC,MAAM,EAAE,qBAAqB,CAGa,CAAC;AAE1E;;;;;GAKG;AACH,eAAO,MAAM,OAAO,EAAE,SAAS,CAAC,OAAO,EAAE,qBAAqB,CAGa,CAAC;AAE5E;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,EAAE,qBAAqB,CAAC,CAExE;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAC/B,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC,EACxB,OAAO,CAAC,EAAE,MAAM,GACf,SAAS,CAAC,CAAC,EAAE,qBAAqB,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC,CAexD;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAkBtE"}
@@ -0,0 +1 @@
1
+ {"version":3,"file":"converters.js","sourceRoot":"","sources":["../../../src/packlets/converters/converters.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AA0MH,0BAEC;AAgBD,0CAkBC;AAQD,sCAkBC;AAtQD,4CASuB;AACvB,kCAAqG;AAYrG;;;GAGG;AACU,QAAA,aAAa,GAAoD,IAAI,qBAAU,CAAC,aAAa,CACxG,CACE,IAAa,EACb,MAAuD,EACvD,GAA2B,EACJ,EAAE;IACzB,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QAClB,OAAO,IAAA,kBAAO,EAAC,IAAI,CAAC,CAAC;IACvB,CAAC;IACD,QAAQ,OAAO,IAAI,EAAE,CAAC;QACpB,KAAK,SAAS,CAAC;QACf,KAAK,QAAQ;YACX,OAAO,IAAA,kBAAO,EAAC,IAAI,CAAC,CAAC;QACvB,KAAK,QAAQ;YACX,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;gBACxB,OAAO,IAAA,kBAAO,EAAC,IAAI,CAAC,CAAC;YACvB,CAAC;YACD,MAAM;IACV,CAAC;IACD,OAAO,IAAA,eAAI,EAAC,IAAI,MAAM,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;AAC5D,CAAC,CACF,CAAC;AAEF;;;;;;;;GAQG;AACU,QAAA,UAAU,GAAiD,IAAI,qBAAU,CAAC,aAAa,CAClG,CACE,IAAa,EACb,MAAoD,EACpD,GAA2B,EACP,EAAE;IACtB,IAAI,CAAC,IAAA,mBAAY,EAAC,IAAI,CAAC,EAAE,CAAC;QACxB,OAAO,IAAA,eAAI,EAAC,sBAAsB,CAAC,CAAC;IACtC,CAAC;IACD,MAAM,GAAG,GAAe,EAAE,CAAC;IAC3B,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACjD,IAAI,KAAK,KAAK,SAAS,IAAI,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,yBAAyB,MAAK,IAAI,EAAE,CAAC;YACnE,qCAAqC;YACrC,SAAS;QACX,CAAC;QACD,iBAAS;aACN,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;aACnB,SAAS,CAAC,CAAC,CAAY,EAAE,EAAE;YAC1B,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACd,OAAO,IAAA,kBAAO,EAAC,CAAC,CAAC,CAAC;QACpB,CAAC,CAAC;aACD,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;YACf,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,KAAK,CAAC,EAAE,CAAC,CAAC;YAC7B,OAAO,IAAA,eAAI,EAAC,CAAC,CAAC,CAAC;QACjB,CAAC,CAAC,CAAC;IACP,CAAC;IACD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,OAAO,IAAA,eAAI,EAAC,yBAAyB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC5D,CAAC;IACD,OAAO,IAAA,kBAAO,EAAC,GAAG,CAAC,CAAC;AACtB,CAAC,CACF,CAAC;AAEF;;;;;;;;GAQG;AACU,QAAA,SAAS,GAAgD,IAAI,qBAAU,CAAC,aAAa,CAChG,CACE,IAAa,EACb,MAAmD,EACnD,GAA2B,EACR,EAAE;IACrB,IAAI,CAAC,IAAA,kBAAW,EAAC,IAAI,CAAC,EAAE,CAAC;QACvB,OAAO,IAAA,eAAI,EAAC,cAAc,CAAC,CAAC;IAC9B,CAAC;IACD,MAAM,GAAG,GAAgB,EAAE,CAAC;IAC5B,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QACtB,IAAI,KAAK,KAAK,SAAS,IAAI,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,yBAAyB,MAAK,IAAI,EAAE,CAAC;YACnE,6DAA6D;YAC7D,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACf,SAAS;QACX,CAAC;QACD,iBAAS;aACN,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;aACnB,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;YACf,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACZ,OAAO,IAAA,kBAAO,EAAC,CAAC,CAAC,CAAC;QACpB,CAAC,CAAC;aACD,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;YACf,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YAC1B,OAAO,IAAA,eAAI,EAAC,CAAC,CAAC,CAAC;QACjB,CAAC,CAAC,CAAC;IACP,CAAC;IACD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,OAAO,IAAA,eAAI,EAAC,sCAAsC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACzE,CAAC;IACD,OAAO,IAAA,kBAAO,EAAC,GAAG,CAAC,CAAC;AACtB,CAAC,CACF,CAAC;AAEF;;;;;;GAMG;AACU,QAAA,SAAS,GAAgD,IAAI,qBAAU,CAAC,aAAa,CAIhG,CACE,IAAa,EACb,MAAmD,EACnD,GAA2B,EACR,EAAE;IACrB,IAAI,IAAA,kBAAW,EAAC,IAAI,CAAC,EAAE,CAAC;QACtB,OAAO,iBAAS,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IACtC,CAAC;SAAM,IAAI,IAAA,mBAAY,EAAC,IAAI,CAAC,EAAE,CAAC;QAC9B,OAAO,kBAAU,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IACvC,CAAC;IACD,OAAO,qBAAa,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;AAC1C,CAAC,CACF,CAAC;AAEF;;;;GAIG;AACU,QAAA,MAAM,GAAmD,IAAI,0BAAe,EAGtF,CAAC;AAEJ;;;;;GAKG;AACU,QAAA,MAAM,GAA6C,IAAI,qBAAU,CAAC,aAAa,CAG1F,CAAC,IAAa,EAAkB,EAAE,CAAC,qBAAc,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;AAE1E;;;;;GAKG;AACU,QAAA,OAAO,GAA8C,IAAI,qBAAU,CAAC,aAAa,CAG5F,CAAC,IAAa,EAAmB,EAAE,CAAC,qBAAc,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;AAE5E;;;;;GAKG;AACH,SAAgB,OAAO,CAAI,KAAQ;IACjC,OAAO,qBAAc,CAAC,OAAO,CAA2B,KAAK,CAAC,CAAC;AACjE,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,SAAgB,eAAe,CAC7B,MAAwB,EACxB,OAAgB;IAEhB,OAAO,IAAI,qBAAU,CAAC,aAAa,CACjC,CACE,IAAa,EACb,MAA8D,EAC9D,OAAkD,EACvC,EAAE;QACb,MAAM,eAAe,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAE,OAA4B,CAAC,CAAC,CAAC,MAAM,CAAC;QACxF,MAAM,KAAK,GAAG,eAAe,CAAC,OAAO,CAAC,IAAS,CAAC,CAAC;QACjD,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;YACf,OAAO,IAAA,kBAAO,EAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC;QACzC,CAAC;QACD,OAAO,IAAA,eAAI,EAAC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,4BAA4B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC7E,CAAC,CACF,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAgB,aAAa,CAAI,SAAuB;IACtD,OAAO,IAAI,qBAAU,CAAC,aAAa,CAAI,CAAC,IAAa,EAAa,EAAE;QAClE,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,OAAO,IAAA,eAAI,EAAC,wBAAwB,CAAC,CAAC;QACxC,CAAC;QAED,MAAM,WAAW,GAAG,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1D,IAAI,WAAW,CAAC,SAAS,EAAE,EAAE,CAAC;YAC5B,OAAO,IAAA,eAAI,EAAC,yBAAyB,WAAW,CAAC,OAAO,EAAE,CAAC,CAAC;QAC9D,CAAC;QAED,MAAM,MAAM,GAAG,WAAW,CAAC,KAAK,CAAC;QACjC,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;YAClD,OAAO,IAAA,eAAI,EAAC,sDAAsD,CAAC,CAAC;QACtE,CAAC;QAED,OAAO,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["/*\n * Copyright (c) 2023 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport {\n Conversion,\n Converter,\n Converters as BaseConverters,\n Result,\n StringConverter,\n captureResult,\n fail,\n succeed\n} from '@fgv/ts-utils';\nimport { JsonArray, JsonObject, JsonPrimitive, JsonValue, isJsonArray, isJsonObject } from '../json';\n\n/* eslint-disable @typescript-eslint/no-use-before-define */\n\n/**\n * Conversion context for JSON converters.\n * @public\n */\nexport interface IJsonConverterContext {\n ignoreUndefinedProperties?: boolean;\n}\n\n/**\n * An converter which converts a supplied `unknown` value to a valid {@link JsonPrimitive | JsonPrimitive}.\n * @public\n */\nexport const jsonPrimitive: Converter<JsonPrimitive, IJsonConverterContext> = new Conversion.BaseConverter(\n (\n from: unknown,\n __self: Converter<JsonPrimitive, IJsonConverterContext>,\n ctx?: IJsonConverterContext\n ): Result<JsonPrimitive> => {\n if (from === null) {\n return succeed(null);\n }\n switch (typeof from) {\n case 'boolean':\n case 'string':\n return succeed(from);\n case 'number':\n if (!Number.isNaN(from)) {\n return succeed(from);\n }\n break;\n }\n return fail(`\"${String(from)}\": invalid JSON primitive.`);\n }\n);\n\n/**\n * An copying converter which converts a supplied `unknown` value into\n * a valid {@link JsonObject | JsonObject}. Fails by default if any properties or array elements\n * are `undefined` - this default behavior can be overridden by supplying an appropriate\n * `IJsonConverterContext` at runtime.\n *\n * Guaranteed to return a new object.\n * @public\n */\nexport const jsonObject: Converter<JsonObject, IJsonConverterContext> = new Conversion.BaseConverter(\n (\n from: unknown,\n __self: Converter<JsonObject, IJsonConverterContext>,\n ctx?: IJsonConverterContext\n ): Result<JsonObject> => {\n if (!isJsonObject(from)) {\n return fail('invalid JSON object.');\n }\n const obj: JsonObject = {};\n const errors: string[] = [];\n for (const [name, value] of Object.entries(from)) {\n if (value === undefined && ctx?.ignoreUndefinedProperties === true) {\n // optionally ignore undefined values\n continue;\n }\n jsonValue\n .convert(value, ctx)\n .onSuccess((v: JsonValue) => {\n obj[name] = v;\n return succeed(v);\n })\n .onFailure((m) => {\n errors.push(`${name}: ${m}`);\n return fail(m);\n });\n }\n if (errors.length > 0) {\n return fail(`invalid JSON object:\\n${errors.join('\\n')}`);\n }\n return succeed(obj);\n }\n);\n\n/**\n * An copying converter which converts a supplied `unknown` value to\n * a valid {@link JsonArray | JsonArray}. Fails by default if any properties or array elements\n * are `undefined` - this default behavior can be overridden by supplying an appropriate\n * `IJsonConverterContext` at runtime.\n *\n * Guaranteed to return a new array.\n * @public\n */\nexport const jsonArray: Converter<JsonArray, IJsonConverterContext> = new Conversion.BaseConverter(\n (\n from: unknown,\n __self: Converter<JsonArray, IJsonConverterContext>,\n ctx?: IJsonConverterContext\n ): Result<JsonArray> => {\n if (!isJsonArray(from)) {\n return fail('not an array');\n }\n const arr: JsonValue[] = [];\n const errors: string[] = [];\n for (let i = 0; i < from.length; i++) {\n const value = from[i];\n if (value === undefined && ctx?.ignoreUndefinedProperties === true) {\n // convert undefined to 'null' for parity with JSON.stringify\n arr.push(null);\n continue;\n }\n jsonValue\n .convert(value, ctx)\n .onSuccess((v) => {\n arr.push(v);\n return succeed(v);\n })\n .onFailure((m) => {\n errors.push(`${i}: ${m}`);\n return fail(m);\n });\n }\n if (errors.length > 0) {\n return fail(`array contains non-json elements:\\n${errors.join('\\n')}`);\n }\n return succeed(arr);\n }\n);\n\n/**\n * An copying converter which converts a supplied `unknown` value to a\n * valid {@link JsonValue | JsonValue}. Fails by default if any properties or array elements\n * are `undefined` - this default behavior can be overridden by supplying an appropriate\n * `IJsonConverterContext` at runtime.\n * @public\n */\nexport const jsonValue: Converter<JsonValue, IJsonConverterContext> = new Conversion.BaseConverter<\n JsonValue,\n IJsonConverterContext\n>(\n (\n from: unknown,\n __self: Converter<JsonValue, IJsonConverterContext>,\n ctx?: IJsonConverterContext\n ): Result<JsonValue> => {\n if (isJsonArray(from)) {\n return jsonArray.convert(from, ctx);\n } else if (isJsonObject(from)) {\n return jsonObject.convert(from, ctx);\n }\n return jsonPrimitive.convert(from, ctx);\n }\n);\n\n/**\n * A `StringConverter` which converts `unknown` to a `string`.\n * Accepts `IJsonConverterContext` but ignores it.\n * @public\n */\nexport const string: StringConverter<string, IJsonConverterContext> = new StringConverter<\n string,\n IJsonConverterContext\n>();\n\n/**\n * A `Converter` which converts `unknown` to a `number`.\n * Accepts `IJsonConverterContext` but ignores it.\n * Mirrors the behavior of `@fgv/ts-utils`.\n * @public\n */\nexport const number: Converter<number, IJsonConverterContext> = new Conversion.BaseConverter<\n number,\n IJsonConverterContext\n>((from: unknown): Result<number> => BaseConverters.number.convert(from));\n\n/**\n * A `Converter` which converts `unknown` to a `boolean`.\n * Accepts `IJsonConverterContext` but ignores it.\n * Mirrors the behavior of `@fgv/ts-utils`.\n * @public\n */\nexport const boolean: Converter<boolean, IJsonConverterContext> = new Conversion.BaseConverter<\n boolean,\n IJsonConverterContext\n>((from: unknown): Result<boolean> => BaseConverters.boolean.convert(from));\n\n/**\n * Helper to create a converter for a literal value.\n * Accepts `IJsonConverterContext` but ignores it.\n * Mirrors the behavior of `@fgv/ts-utils`.\n * @public\n */\nexport function literal<T>(value: T): Converter<T, IJsonConverterContext> {\n return BaseConverters.literal<T, IJsonConverterContext>(value);\n}\n\n/**\n * Helper function to create a `Converter` which converts `unknown` to one of a set of\n * supplied enumerated values. Anything else fails.\n *\n * @remarks\n * This JSON variant accepts an `IJsonConverterContext` OR\n * a `ReadonlyArray<T>` as its conversion context. If the context is an array, it is used to override the\n * allowed values for that conversion; otherwise, the original `values` supplied at creation time are used.\n *\n * @param values - Array of allowed values.\n * @param message - Optional custom failure message.\n * @returns A new `Converter` returning `<T>`.\n * @public\n */\nexport function enumeratedValue<T>(\n values: ReadonlyArray<T>,\n message?: string\n): Converter<T, IJsonConverterContext | ReadonlyArray<T>> {\n return new Conversion.BaseConverter<T, IJsonConverterContext | ReadonlyArray<T>>(\n (\n from: unknown,\n __self: Converter<T, IJsonConverterContext | ReadonlyArray<T>>,\n context?: IJsonConverterContext | ReadonlyArray<T>\n ): Result<T> => {\n const effectiveValues = Array.isArray(context) ? (context as ReadonlyArray<T>) : values;\n const index = effectiveValues.indexOf(from as T);\n if (index >= 0) {\n return succeed(effectiveValues[index]);\n }\n return fail(message ?? `Invalid enumerated value ${JSON.stringify(from)}`);\n }\n );\n}\n\n/**\n * Creates a converter that parses JSON string content and then applies the supplied converter.\n * @param converter - Converter to apply to the parsed JSON\n * @returns Converter that parses JSON then validates\n * @public\n */\nexport function jsonConverter<T>(converter: Converter<T>): Converter<T> {\n return new Conversion.BaseConverter<T>((from: unknown): Result<T> => {\n if (typeof from !== 'string') {\n return fail('Input must be a string');\n }\n\n const parseResult = captureResult(() => JSON.parse(from));\n if (parseResult.isFailure()) {\n return fail(`Failed to parse JSON: ${parseResult.message}`);\n }\n\n const parsed = parseResult.value;\n if (typeof parsed !== 'object' || parsed === null) {\n return fail('Failed to parse JSON: JSON content must be an object');\n }\n\n return converter.convert(parsed);\n });\n}\n"]}
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/packlets/converters/index.ts"],"names":[],"mappings":"AAsBA,cAAc,cAAc,CAAC"}
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/packlets/converters/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;AAEH,+CAA6B","sourcesContent":["/*\n * Copyright (c) 2020 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nexport * from './converters';\n"]}
@@ -0,0 +1 @@
1
+ {"version":3,"file":"directoryItem.d.ts","sourceRoot":"","sources":["../../../src/packlets/file-tree/directoryItem.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,MAAM,EAAgC,MAAM,eAAe,CAAC;AACrE,OAAO,EACL,YAAY,EACZ,mBAAmB,EACnB,kBAAkB,EAClB,6BAA6B,EAC7B,wBAAwB,EAGzB,MAAM,qBAAqB,CAAC;AAE7B;;;GAGG;AACH,qBAAa,aAAa,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,CAAE,YAAW,6BAA6B,CAAC,GAAG,CAAC;IACnG;;OAEG;IACH,SAAgB,IAAI,EAAE,WAAW,CAAe;IAEhD;;OAEG;IACH,SAAgB,YAAY,EAAE,MAAM,CAAC;IAErC;;OAEG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;IAED;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAC,GAAG,CAAC,CAAC;IAEjD;;;;;;OAMG;IACH,SAAS,aAAa,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,kBAAkB,CAAC,GAAG,CAAC;IAKhE;;;;;;;OAOG;WACW,MAAM,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,EAC9C,IAAI,EAAE,MAAM,EACZ,GAAG,EAAE,kBAAkB,CAAC,GAAG,CAAC,GAC3B,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IAI7B;;OAEG;IACI,WAAW,IAAI,MAAM,CAAC,aAAa,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC;IAI9D;;OAEG;IACI,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC;IAmB7F;;OAEG;IACI,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,6BAA6B,CAAC,GAAG,CAAC,CAAC;IAWrF;;OAEG;IACI,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,MAAM,CAAC,OAAO,CAAC;IAoBhF;;OAEG;IACI,MAAM,IAAI,MAAM,CAAC,OAAO,CAAC;IAShC;;;;;OAKG;IACH,OAAO,CAAC,gBAAgB;CAyBzB"}
@@ -0,0 +1 @@
1
+ {"version":3,"file":"directoryItem.js","sourceRoot":"","sources":["../../../src/packlets/file-tree/directoryItem.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,4CAAqE;AACrE,2DAQ6B;AAE7B;;;GAGG;AACH,MAAa,aAAa;IAWxB;;OAEG;IACH,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAClD,CAAC;IAQD;;;;;;OAMG;IACH,YAAsB,IAAY,EAAE,GAA4B;QA9BhE;;WAEG;QACa,SAAI,GAAgB,WAAW,CAAC;QA4B9C,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;QAChB,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAClB,IAAY,EACZ,GAA4B;QAE5B,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,aAAa,CAAM,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;IAChE,CAAC;IAED;;OAEG;IACI,WAAW;QAChB,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAClD,CAAC;IAED;;OAEG;IACI,eAAe,CAAC,IAAY,EAAE,QAAgB;QACnD,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC;QACtB,IAAI,CAAC,IAAA,sCAAkB,EAAC,GAAG,CAAC,EAAE,CAAC;YAC7B,mGAAmG;YACnG,OAAO,IAAA,eAAI,EAAC,GAAG,IAAI,CAAC,YAAY,0BAA0B,CAAC,CAAC;QAC9D,CAAC;QAED,MAAM,QAAQ,GAAG,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;QACxD,OAAO,GAAG,CAAC,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,SAAS,CAAC,GAAG,EAAE,CAC7D,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE;YACvC,2FAA2F;YAC3F,IAAI,CAAC,IAAA,qCAAiB,EAAC,IAAI,CAAC,EAAE,CAAC;gBAC7B,OAAO,IAAA,eAAI,EAAC,GAAG,QAAQ,mCAAmC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;YACzE,CAAC;YACD,OAAO,IAAA,kBAAO,EAAC,IAAI,CAAC,CAAC;QACvB,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,oBAAoB,CAAC,IAAY;QACtC,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC;QACtB,IAAI,CAAC,IAAA,sCAAkB,EAAC,GAAG,CAAC,EAAE,CAAC;YAC7B,mGAAmG;YACnG,OAAO,IAAA,eAAI,EAAC,GAAG,IAAI,CAAC,YAAY,0BAA0B,CAAC,CAAC;QAC9D,CAAC;QAED,MAAM,OAAO,GAAG,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;QACvD,OAAO,GAAG,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,aAAa,CAAC,MAAM,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC;IAC1F,CAAC;IAED;;OAEG;IACI,WAAW,CAAC,IAAY,EAAE,OAA6B;QAC5D,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC;QACtB,IAAI,CAAC,IAAA,sCAAkB,EAAC,GAAG,CAAC,EAAE,CAAC;YAC7B,mGAAmG;YACnG,OAAO,IAAA,eAAI,EAAC,GAAG,IAAI,CAAC,YAAY,0BAA0B,CAAC,CAAC;QAC9D,CAAC;QAED,MAAM,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;QACzD,OAAO,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE;YAC/C,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;gBACzB,OAAO,GAAG,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;YACnC,CAAC;YACD,kBAAkB;YAClB,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,EAAE,CAAC;gBACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;YAC1C,CAAC;YACD,OAAO,GAAG,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,MAAM;QACX,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC;QACtB,IAAI,CAAC,IAAA,sCAAkB,EAAC,GAAG,CAAC,EAAE,CAAC;YAC7B,mGAAmG;YACnG,OAAO,IAAA,eAAI,EAAC,GAAG,IAAI,CAAC,YAAY,0BAA0B,CAAC,CAAC;QAC9D,CAAC;QACD,OAAO,GAAG,CAAC,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAChD,CAAC;IAED;;;;;OAKG;IACK,gBAAgB,CAAC,OAAe;QACtC,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC;QACtB,mEAAmE;QACnE,IAAI,CAAC,IAAA,sCAAkB,EAAC,GAAG,CAAC,EAAE,CAAC;YAC7B,OAAO,IAAA,eAAI,EAAC,GAAG,OAAO,0BAA0B,CAAC,CAAC;QACpD,CAAC;QACD,OAAO,GAAG,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,QAAQ,EAAE,EAAE;YACrD,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;gBAC7B,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;oBAC1B,MAAM,MAAM,GAAG,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;oBAClD,6EAA6E;oBAC7E,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;wBACvB,OAAO,MAAM,CAAC;oBAChB,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,MAAM,MAAM,GAAG,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;oBACzD,6EAA6E;oBAC7E,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;wBACvB,OAAO,MAAM,CAAC;oBAChB,CAAC;gBACH,CAAC;YACH,CAAC;YACD,OAAO,GAAG,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;QACtC,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAhKD,sCAgKC","sourcesContent":["/*\n * Copyright (c) 2025 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { Result, captureResult, fail, succeed } from '@fgv/ts-utils';\nimport {\n FileTreeItem,\n IDeleteChildOptions,\n IFileTreeAccessors,\n IMutableFileTreeDirectoryItem,\n IMutableFileTreeFileItem,\n isMutableAccessors,\n isMutableFileItem\n} from './fileTreeAccessors';\n\n/**\n * Class representing a directory in a file tree.\n * @public\n */\nexport class DirectoryItem<TCT extends string = string> implements IMutableFileTreeDirectoryItem<TCT> {\n /**\n * {@inheritDoc FileTree.IFileTreeDirectoryItem.\"type\"}\n */\n public readonly type: 'directory' = 'directory';\n\n /**\n * {@inheritDoc FileTree.IFileTreeDirectoryItem.absolutePath}\n */\n public readonly absolutePath: string;\n\n /**\n * {@inheritDoc FileTree.IFileTreeDirectoryItem.name}\n */\n public get name(): string {\n return this._hal.getBaseName(this.absolutePath);\n }\n\n /**\n * The {@link FileTree.IFileTreeAccessors | accessors} to use for file system operations.\n * @public\n */\n protected readonly _hal: IFileTreeAccessors<TCT>;\n\n /**\n * Protected constructor for derived classes.\n * @param path - Relative path of the directory.\n * @param hal - The {@link FileTree.IFileTreeAccessors | accessors} to use for\n * file system operations.\n * @public\n */\n protected constructor(path: string, hal: IFileTreeAccessors<TCT>) {\n this._hal = hal;\n this.absolutePath = hal.resolveAbsolutePath(path);\n }\n\n /**\n * Creates a new DirectoryItem instance.\n * @param path - Relative path of the directory.\n * @param hal - The {@link FileTree.IFileTreeAccessors | accessors} to use for\n * file system operations.\n * @returns `Success` with the new {@link FileTree.DirectoryItem | DirectoryItem} instance if successful,\n * or `Failure` with an error message otherwise.\n */\n public static create<TCT extends string = string>(\n path: string,\n hal: IFileTreeAccessors<TCT>\n ): Result<DirectoryItem<TCT>> {\n return captureResult(() => new DirectoryItem<TCT>(path, hal));\n }\n\n /**\n * {@inheritDoc FileTree.IFileTreeDirectoryItem.getChildren}\n */\n public getChildren(): Result<ReadonlyArray<FileTreeItem<TCT>>> {\n return this._hal.getChildren(this.absolutePath);\n }\n\n /**\n * {@inheritDoc FileTree.IMutableFileTreeDirectoryItem.createChildFile}\n */\n public createChildFile(name: string, contents: string): Result<IMutableFileTreeFileItem<TCT>> {\n const hal = this._hal;\n if (!isMutableAccessors(hal)) {\n /* c8 ignore next 2 - defensive: all current accessor implementations support mutation interface */\n return fail(`${this.absolutePath}: mutation not supported`);\n }\n\n const filePath = hal.joinPaths(this.absolutePath, name);\n return hal.saveFileContents(filePath, contents).onSuccess(() =>\n hal.getItem(filePath).onSuccess((item) => {\n /* c8 ignore next 3 - defensive: verifies accessor returned correct item type after save */\n if (!isMutableFileItem(item)) {\n return fail(`${filePath}: expected mutable file but got ${item.type}`);\n }\n return succeed(item);\n })\n );\n }\n\n /**\n * {@inheritDoc FileTree.IMutableFileTreeDirectoryItem.createChildDirectory}\n */\n public createChildDirectory(name: string): Result<IMutableFileTreeDirectoryItem<TCT>> {\n const hal = this._hal;\n if (!isMutableAccessors(hal)) {\n /* c8 ignore next 2 - defensive: all current accessor implementations support mutation interface */\n return fail(`${this.absolutePath}: mutation not supported`);\n }\n\n const dirPath = hal.joinPaths(this.absolutePath, name);\n return hal.createDirectory(dirPath).onSuccess(() => DirectoryItem.create(dirPath, hal));\n }\n\n /**\n * {@inheritDoc FileTree.IMutableFileTreeDirectoryItem.deleteChild}\n */\n public deleteChild(name: string, options?: IDeleteChildOptions): Result<boolean> {\n const hal = this._hal;\n if (!isMutableAccessors(hal)) {\n /* c8 ignore next 2 - defensive: all current accessor implementations support mutation interface */\n return fail(`${this.absolutePath}: mutation not supported`);\n }\n\n const childPath = hal.joinPaths(this.absolutePath, name);\n return hal.getItem(childPath).onSuccess((item) => {\n if (item.type === 'file') {\n return hal.deleteFile(childPath);\n }\n // Directory child\n if (options?.recursive) {\n return this._deleteRecursive(childPath);\n }\n return hal.deleteDirectory(childPath);\n });\n }\n\n /**\n * {@inheritDoc FileTree.IMutableFileTreeDirectoryItem.delete}\n */\n public delete(): Result<boolean> {\n const hal = this._hal;\n if (!isMutableAccessors(hal)) {\n /* c8 ignore next 2 - defensive: all current accessor implementations support mutation interface */\n return fail(`${this.absolutePath}: mutation not supported`);\n }\n return hal.deleteDirectory(this.absolutePath);\n }\n\n /**\n * Recursively deletes all children of a directory and then the directory itself.\n * @param dirPath - The absolute path of the directory to delete.\n * @returns `Success` with `true` if the directory was deleted, or `Failure` with an error message.\n * @internal\n */\n private _deleteRecursive(dirPath: string): Result<boolean> {\n const hal = this._hal;\n /* c8 ignore next 3 - defensive: caller already verified mutable */\n if (!isMutableAccessors(hal)) {\n return fail(`${dirPath}: mutation not supported`);\n }\n return hal.getChildren(dirPath).onSuccess((children) => {\n for (const child of children) {\n if (child.type === 'file') {\n const result = hal.deleteFile(child.absolutePath);\n /* c8 ignore next 3 - defensive: error propagation during recursive delete */\n if (result.isFailure()) {\n return result;\n }\n } else {\n const result = this._deleteRecursive(child.absolutePath);\n /* c8 ignore next 3 - defensive: error propagation during recursive delete */\n if (result.isFailure()) {\n return result;\n }\n }\n }\n return hal.deleteDirectory(dirPath);\n });\n }\n}\n"]}
@@ -58,7 +58,9 @@ export declare class FileItem<TCT extends string = string> implements IMutableFi
58
58
  */
59
59
  static create<TCT extends string = string>(path: string, hal: IFileTreeAccessors<TCT>): Result<FileItem<TCT>>;
60
60
  /**
61
- * {@inheritDoc FileTree.IFileTreeFileItem.getIsMutable}
61
+ * Indicates whether this file can be saved.
62
+ * @returns `DetailedSuccess` with {@link FileTree.SaveCapability} if the file can be saved,
63
+ * or `DetailedFailure` with {@link FileTree.SaveFailureReason} if it cannot.
62
64
  */
63
65
  getIsMutable(): DetailedResult<boolean, SaveDetail>;
64
66
  /**
@@ -79,15 +81,20 @@ export declare class FileItem<TCT extends string = string> implements IMutableFi
79
81
  */
80
82
  setContentType(contentType: TCT | undefined): void;
81
83
  /**
82
- * {@inheritDoc FileTree.IFileTreeFileItem.setContents}
84
+ * Sets the contents of the file from a JSON value.
85
+ * @param json - The JSON value to serialize and save.
86
+ * @returns `Success` if the file was saved, or `Failure` with an error message.
83
87
  */
84
88
  setContents(json: JsonValue): Result<JsonValue>;
85
89
  /**
86
- * {@inheritDoc FileTree.IFileTreeFileItem.setRawContents}
90
+ * Sets the raw contents of the file.
91
+ * @param contents - The string contents to save.
92
+ * @returns `Success` if the file was saved, or `Failure` with an error message.
87
93
  */
88
94
  setRawContents(contents: string): Result<string>;
89
95
  /**
90
- * {@inheritDoc FileTree.IFileTreeFileItem.delete}
96
+ * Deletes this file from its backing store.
97
+ * @returns `Success` with `true` if the file was deleted, or `Failure` with an error message.
91
98
  */
92
99
  delete(): Result<boolean>;
93
100
  /**
@@ -0,0 +1 @@
1
+ {"version":3,"file":"fileItem.d.ts","sourceRoot":"","sources":["../../../src/packlets/file-tree/fileItem.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAiB,cAAc,EAAwB,MAAM,EAAoB,MAAM,eAAe,CAAC;AAC9G,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AACrD,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AACpC,OAAO,EACL,kBAAkB,EAClB,wBAAwB,EAExB,UAAU,EACX,MAAM,qBAAqB,CAAC;AAE7B;;;GAGG;AACH,qBAAa,QAAQ,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,CAAE,YAAW,wBAAwB,CAAC,GAAG,CAAC;IACzF;;OAEG;IACH,SAAgB,IAAI,EAAE,MAAM,CAAU;IAEtC;;OAEG;IACH,SAAgB,YAAY,EAAE,MAAM,CAAC;IAErC;;OAEG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;IAED;;OAEG;IACH,IAAW,QAAQ,IAAI,MAAM,CAE5B;IAED;;OAEG;IACH,IAAW,SAAS,IAAI,MAAM,CAE7B;IAED;;OAEG;IACH,IAAW,WAAW,IAAI,GAAG,GAAG,SAAS,CAExC;IAED;;;OAGG;IACH,OAAO,CAAC,YAAY,CAAkB;IAEtC;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAC,GAAG,CAAC,CAAC;IAEjD;;;;;;OAMG;IACH,SAAS,aAAa,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,kBAAkB,CAAC,GAAG,CAAC;IAMhE;;;;;;OAMG;WACW,MAAM,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,EAC9C,IAAI,EAAE,MAAM,EACZ,GAAG,EAAE,kBAAkB,CAAC,GAAG,CAAC,GAC3B,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAIxB;;;;OAIG;IACI,YAAY,IAAI,cAAc,CAAC,OAAO,EAAE,UAAU,CAAC;IAQ1D;;OAEG;IACI,WAAW,IAAI,MAAM,CAAC,SAAS,CAAC;IACvC;;OAEG;IACI,WAAW,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;IAaxE;;OAEG;IACI,cAAc,IAAI,MAAM,CAAC,MAAM,CAAC;IAIvC;;;OAGG;IACI,cAAc,CAAC,WAAW,EAAE,GAAG,GAAG,SAAS,GAAG,IAAI;IAIzD;;;;OAIG;IACI,WAAW,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;IAMtD;;;;OAIG;IACI,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;IAQvD;;;OAGG;IACI,MAAM,IAAI,MAAM,CAAC,OAAO,CAAC;IAQhC;;;;;;;;OAQG;WACW,uBAAuB,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,EAC/D,QAAQ,EAAE,MAAM,EAChB,QAAQ,CAAC,EAAE,MAAM,GAChB,MAAM,CAAC,GAAG,GAAG,SAAS,CAAC;IAI1B;;;;;;;;OAQG;WACW,wBAAwB,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,EAChE,QAAQ,EAAE,MAAM,EAChB,QAAQ,CAAC,EAAE,GAAG,GACb,MAAM,CAAC,GAAG,GAAG,SAAS,CAAC;CAG3B"}
@@ -80,7 +80,9 @@ class FileItem {
80
80
  return (0, ts_utils_1.captureResult)(() => new FileItem(path, hal));
81
81
  }
82
82
  /**
83
- * {@inheritDoc FileTree.IFileTreeFileItem.getIsMutable}
83
+ * Indicates whether this file can be saved.
84
+ * @returns `DetailedSuccess` with {@link FileTree.SaveCapability} if the file can be saved,
85
+ * or `DetailedFailure` with {@link FileTree.SaveFailureReason} if it cannot.
84
86
  */
85
87
  getIsMutable() {
86
88
  if ((0, fileTreeAccessors_1.isMutableAccessors)(this._hal)) {
@@ -114,13 +116,17 @@ class FileItem {
114
116
  this._contentType = contentType;
115
117
  }
116
118
  /**
117
- * {@inheritDoc FileTree.IFileTreeFileItem.setContents}
119
+ * Sets the contents of the file from a JSON value.
120
+ * @param json - The JSON value to serialize and save.
121
+ * @returns `Success` if the file was saved, or `Failure` with an error message.
118
122
  */
119
123
  setContents(json) {
120
124
  return (0, ts_utils_1.captureResult)(() => JSON.stringify(json, null, 2)).onSuccess((contents) => this.setRawContents(contents).onSuccess(() => ts_utils_1.Success.with(json)));
121
125
  }
122
126
  /**
123
- * {@inheritDoc FileTree.IFileTreeFileItem.setRawContents}
127
+ * Sets the raw contents of the file.
128
+ * @param contents - The string contents to save.
129
+ * @returns `Success` if the file was saved, or `Failure` with an error message.
124
130
  */
125
131
  setRawContents(contents) {
126
132
  if ((0, fileTreeAccessors_1.isMutableAccessors)(this._hal)) {
@@ -130,7 +136,8 @@ class FileItem {
130
136
  return (0, ts_utils_1.fail)(`${this.absolutePath}: mutation not supported`);
131
137
  }
132
138
  /**
133
- * {@inheritDoc FileTree.IFileTreeFileItem.delete}
139
+ * Deletes this file from its backing store.
140
+ * @returns `Success` with `true` if the file was deleted, or `Failure` with an error message.
134
141
  */
135
142
  delete() {
136
143
  if (!(0, fileTreeAccessors_1.isMutableAccessors)(this._hal)) {
@@ -0,0 +1 @@
1
+ {"version":3,"file":"fileItem.js","sourceRoot":"","sources":["../../../src/packlets/file-tree/fileItem.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,4CAA8G;AAG9G,2DAK6B;AAE7B;;;GAGG;AACH,MAAa,QAAQ;IAWnB;;OAEG;IACH,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAClD,CAAC;IAED;;OAEG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IAClE,CAAC;IAED;;OAEG;IACH,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACnD,CAAC;IAED;;OAEG;IACH,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAcD;;;;;;OAMG;IACH,YAAsB,IAAY,EAAE,GAA4B;QAzDhE;;WAEG;QACa,SAAI,GAAW,MAAM,CAAC;QAuDpC,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;QAChB,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;QAClD,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC,kBAAkB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,SAAS,EAAE,CAAC;IAC5E,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAClB,IAAY,EACZ,GAA4B;QAE5B,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;IACtD,CAAC;IAED;;;;OAIG;IACI,YAAY;QACjB,IAAI,IAAA,sCAAkB,EAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAClC,OAAO,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACpD,CAAC;QACD,mGAAmG;QACnG,OAAO,IAAA,yBAAc,EAAC,GAAG,IAAI,CAAC,YAAY,0BAA0B,EAAE,eAAe,CAAC,CAAC;IACzF,CAAC;IAUM,WAAW,CAAI,SAAuC;QAC3D,OAAO,IAAI,CAAC,IAAI;aACb,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC;aAClC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,IAAA,kBAAO,EAAC,IAAI,CAAC,CAAC,CAAC;aACzF,SAAS,CAAgB,CAAC,MAAM,EAAE,EAAE;YACnC,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;gBAC5B,OAAO,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACnC,CAAC;YACD,OAAO,IAAA,kBAAO,EAAC,MAAmB,CAAC,CAAC;QACtC,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACI,cAAc;QACnB,OAAO,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACtD,CAAC;IAED;;;OAGG;IACI,cAAc,CAAC,WAA4B;QAChD,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACI,WAAW,CAAC,IAAe;QAChC,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,QAAQ,EAAE,EAAE,CAC/E,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,kBAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAClE,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,cAAc,CAAC,QAAgB;QACpC,IAAI,IAAA,sCAAkB,EAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAClC,OAAO,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;QACjE,CAAC;QACD,mGAAmG;QACnG,OAAO,IAAA,eAAI,EAAC,GAAG,IAAI,CAAC,YAAY,0BAA0B,CAAC,CAAC;IAC9D,CAAC;IAED;;;OAGG;IACI,MAAM;QACX,IAAI,CAAC,IAAA,sCAAkB,EAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACnC,mGAAmG;YACnG,OAAO,IAAA,eAAI,EAAC,GAAG,IAAI,CAAC,YAAY,0BAA0B,CAAC,CAAC;QAC9D,CAAC;QACD,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,uBAAuB,CACnC,QAAgB,EAChB,QAAiB;QAEjB,OAAO,IAAA,kBAAO,EAAC,SAAS,CAAC,CAAC;IAC5B,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,wBAAwB,CACpC,QAAgB,EAChB,QAAc;QAEd,OAAO,IAAA,kBAAO,EAAC,QAAQ,CAAC,CAAC;IAC3B,CAAC;CACF;AAjMD,4BAiMC","sourcesContent":["/*\n * Copyright (c) 2025 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { captureResult, DetailedResult, fail, failWithDetail, Result, succeed, Success } from '@fgv/ts-utils';\nimport { Converter, Validator } from '@fgv/ts-utils';\nimport { JsonValue } from '../json';\nimport {\n IFileTreeAccessors,\n IMutableFileTreeFileItem,\n isMutableAccessors,\n SaveDetail\n} from './fileTreeAccessors';\n\n/**\n * Class representing a file in a file tree.\n * @public\n */\nexport class FileItem<TCT extends string = string> implements IMutableFileTreeFileItem<TCT> {\n /**\n * {@inheritDoc FileTree.IFileTreeFileItem.\"type\"}\n */\n public readonly type: 'file' = 'file';\n\n /**\n * {@inheritDoc FileTree.IFileTreeFileItem.absolutePath}\n */\n public readonly absolutePath: string;\n\n /**\n * {@inheritDoc FileTree.IFileTreeFileItem.name}\n */\n public get name(): string {\n return this._hal.getBaseName(this.absolutePath);\n }\n\n /**\n * {@inheritDoc FileTree.IFileTreeFileItem.baseName}\n */\n public get baseName(): string {\n return this._hal.getBaseName(this.absolutePath, this.extension);\n }\n\n /**\n * {@inheritDoc FileTree.IFileTreeFileItem.extension}\n */\n public get extension(): string {\n return this._hal.getExtension(this.absolutePath);\n }\n\n /**\n * {@inheritDoc FileTree.IFileTreeFileItem.contentType}\n */\n public get contentType(): TCT | undefined {\n return this._contentType;\n }\n\n /**\n * Mutable content type of the file.\n * @public\n */\n private _contentType: TCT | undefined;\n\n /**\n * The {@link FileTree.IFileTreeAccessors | accessors} to use for file system operations.\n * @public\n */\n protected readonly _hal: IFileTreeAccessors<TCT>;\n\n /**\n * Protected constructor for derived classes.\n * @param path - Relative path of the file.\n * @param hal - The {@link FileTree.IFileTreeAccessors | accessors} to use for\n * file system operations.\n * @public\n */\n protected constructor(path: string, hal: IFileTreeAccessors<TCT>) {\n this._hal = hal;\n this.absolutePath = hal.resolveAbsolutePath(path);\n this._contentType = hal.getFileContentType(this.absolutePath).orDefault();\n }\n\n /**\n * Creates a new {@link FileTree.FileItem} instance.\n * @param path - Relative path of the file.\n * @param hal - The {@link FileTree.IFileTreeAccessors | accessors} to use for\n * file system operations.\n * @public\n */\n public static create<TCT extends string = string>(\n path: string,\n hal: IFileTreeAccessors<TCT>\n ): Result<FileItem<TCT>> {\n return captureResult(() => new FileItem(path, hal));\n }\n\n /**\n * Indicates whether this file can be saved.\n * @returns `DetailedSuccess` with {@link FileTree.SaveCapability} if the file can be saved,\n * or `DetailedFailure` with {@link FileTree.SaveFailureReason} if it cannot.\n */\n public getIsMutable(): DetailedResult<boolean, SaveDetail> {\n if (isMutableAccessors(this._hal)) {\n return this._hal.fileIsMutable(this.absolutePath);\n }\n /* c8 ignore next 2 - defensive: all current accessor implementations support mutation interface */\n return failWithDetail(`${this.absolutePath}: mutation not supported`, 'not-supported');\n }\n\n /**\n * {@inheritDoc FileTree.IFileTreeFileItem.getContents}\n */\n public getContents(): Result<JsonValue>;\n /**\n * {@inheritDoc FileTree.IFileTreeFileItem.getContents}\n */\n public getContents<T>(converter: Validator<T> | Converter<T>): Result<T>;\n public getContents<T>(converter?: Validator<T> | Converter<T>): Result<T | JsonValue> {\n return this._hal\n .getFileContents(this.absolutePath)\n .onSuccess((body) => captureResult(() => JSON.parse(body)).onFailure(() => succeed(body)))\n .onSuccess<T | JsonValue>((parsed) => {\n if (converter !== undefined) {\n return converter.convert(parsed);\n }\n return succeed(parsed as JsonValue);\n });\n }\n\n /**\n * {@inheritDoc FileTree.IFileTreeFileItem.getRawContents}\n */\n public getRawContents(): Result<string> {\n return this._hal.getFileContents(this.absolutePath);\n }\n\n /**\n * Sets the content type of the file.\n * @param contentType - The content type of the file.\n */\n public setContentType(contentType: TCT | undefined): void {\n this._contentType = contentType;\n }\n\n /**\n * Sets the contents of the file from a JSON value.\n * @param json - The JSON value to serialize and save.\n * @returns `Success` if the file was saved, or `Failure` with an error message.\n */\n public setContents(json: JsonValue): Result<JsonValue> {\n return captureResult(() => JSON.stringify(json, null, 2)).onSuccess((contents) =>\n this.setRawContents(contents).onSuccess(() => Success.with(json))\n );\n }\n\n /**\n * Sets the raw contents of the file.\n * @param contents - The string contents to save.\n * @returns `Success` if the file was saved, or `Failure` with an error message.\n */\n public setRawContents(contents: string): Result<string> {\n if (isMutableAccessors(this._hal)) {\n return this._hal.saveFileContents(this.absolutePath, contents);\n }\n /* c8 ignore next 2 - defensive: all current accessor implementations support mutation interface */\n return fail(`${this.absolutePath}: mutation not supported`);\n }\n\n /**\n * Deletes this file from its backing store.\n * @returns `Success` with `true` if the file was deleted, or `Failure` with an error message.\n */\n public delete(): Result<boolean> {\n if (!isMutableAccessors(this._hal)) {\n /* c8 ignore next 2 - defensive: all current accessor implementations support mutation interface */\n return fail(`${this.absolutePath}: mutation not supported`);\n }\n return this._hal.deleteFile(this.absolutePath);\n }\n\n /**\n * Default function to infer the content type of a file.\n * @param filePath - The path of the file.\n * @param provided - Optional supplied content type.\n * @returns `Success` with the content type of the file if successful, or\n * `Failure` with an error message otherwise.\n * @remarks This default implementation always returns `Success` with `undefined`.\n * @public\n */\n public static defaultInferContentType<TCT extends string = string>(\n filePath: string,\n provided?: string\n ): Result<TCT | undefined> {\n return succeed(undefined);\n }\n\n /**\n * Default function to accept the content type of a file.\n * @param filePath - The path of the file.\n * @param provided - Optional supplied content type.\n * @returns `Success` with the content type of the file if successful, or\n * `Failure` with an error message otherwise.\n * @remarks This default implementation always returns `Success` with `undefined`.\n * @public\n */\n public static defaultAcceptContentType<TCT extends string = string>(\n filePath: string,\n provided?: TCT\n ): Result<TCT | undefined> {\n return succeed(provided);\n }\n}\n"]}
@@ -0,0 +1 @@
1
+ {"version":3,"file":"fileTree.d.ts","sourceRoot":"","sources":["../../../src/packlets/file-tree/fileTree.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAiB,MAAM,EAAiB,MAAM,eAAe,CAAC;AACrE,OAAO,EACL,YAAY,EACZ,kBAAkB,EAClB,sBAAsB,EACtB,iBAAiB,EAClB,MAAM,qBAAqB,CAAC;AAE7B;;;GAGG;AACH,qBAAa,QAAQ,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM;IAC/C;;;OAGG;IACI,GAAG,EAAE,kBAAkB,CAAC,GAAG,CAAC,CAAC;IAEpC;;;;;OAKG;IACH,SAAS,aAAa,GAAG,EAAE,kBAAkB,CAAC,GAAG,CAAC;IAIlD;;;;;OAKG;WACW,MAAM,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,kBAAkB,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAItG;;;;;OAKG;IACI,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;IAK3D;;;;;OAKG;IACI,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;IAShE;;;;;OAKG;IACI,YAAY,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;CAQhF"}
@@ -0,0 +1 @@
1
+ {"version":3,"file":"fileTree.js","sourceRoot":"","sources":["../../../src/packlets/file-tree/fileTree.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,4CAAqE;AAQrE;;;GAGG;AACH,MAAa,QAAQ;IAOnB;;;;;OAKG;IACH,YAAsB,GAA4B;QAChD,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,MAAM,CAA8B,GAA4B;QAC5E,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;IAChD,CAAC;IAED;;;;;OAKG;IACI,OAAO,CAAC,QAAgB;QAC7B,MAAM,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;QAC5D,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IACxC,CAAC;IAED;;;;;OAKG;IACI,OAAO,CAAC,QAAgB;QAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE;YAC/C,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;gBACzB,OAAO,IAAA,kBAAO,EAAC,IAAI,CAAC,CAAC;YACvB,CAAC;YACD,OAAO,IAAA,eAAI,EAAC,GAAG,QAAQ,cAAc,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,YAAY,CAAC,aAAqB;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE;YACpD,IAAI,IAAI,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;gBAC9B,OAAO,IAAA,kBAAO,EAAC,IAAI,CAAC,CAAC;YACvB,CAAC;YACD,OAAO,IAAA,eAAI,EAAC,GAAG,aAAa,mBAAmB,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAnED,4BAmEC","sourcesContent":["/*\n * Copyright (c) 2025 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { captureResult, Result, fail, succeed } from '@fgv/ts-utils';\nimport {\n FileTreeItem,\n IFileTreeAccessors,\n IFileTreeDirectoryItem,\n IFileTreeFileItem\n} from './fileTreeAccessors';\n\n/**\n * Represents a file tree.\n * @public\n */\nexport class FileTree<TCT extends string = string> {\n /**\n * The {@link FileTree.IFileTreeAccessors | accessors} to use for file system operations.\n * @public\n */\n public hal: IFileTreeAccessors<TCT>;\n\n /**\n * Protected constructor for derived classes.\n * @param hal - The {@link FileTree.IFileTreeAccessors | accessors} to use for\n * file system operations.\n * @public\n */\n protected constructor(hal: IFileTreeAccessors<TCT>) {\n this.hal = hal;\n }\n\n /**\n * Creates a new {@link FileTree} instance with the supplied\n * accessors.\n * @param hal - The {@link FileTree.IFileTreeAccessors | accessors} to use for\n * file system operations.\n */\n public static create<TCT extends string = string>(hal: IFileTreeAccessors<TCT>): Result<FileTree<TCT>> {\n return captureResult(() => new FileTree(hal));\n }\n\n /**\n * Gets an item from the tree.\n * @param itemPath - The path to the item.\n * @returns `Success` with the item if successful,\n * or `Failure` with an error message otherwise.\n */\n public getItem(itemPath: string): Result<FileTreeItem<TCT>> {\n const absolutePath = this.hal.resolveAbsolutePath(itemPath);\n return this.hal.getItem(absolutePath);\n }\n\n /**\n * Gets a file item from the tree.\n * @param filePath - The path to the file.\n * @returns `Success` with the {@link FileTree.IFileTreeFileItem | file item}\n * if successful, or `Failure` with an error message otherwise.\n */\n public getFile(filePath: string): Result<IFileTreeFileItem<TCT>> {\n return this.getItem(filePath).onSuccess((item) => {\n if (item.type === 'file') {\n return succeed(item);\n }\n return fail(`${filePath}: not a file`);\n });\n }\n\n /**\n * Gets a directory item from the tree.\n * @param directoryPath - The path to the directory.\n * @returns `Success` with the {@link FileTree.IFileTreeDirectoryItem | directory item}\n * if successful, or `Failure` with an error message otherwise.\n */\n public getDirectory(directoryPath: string): Result<IFileTreeDirectoryItem<TCT>> {\n return this.getItem(directoryPath).onSuccess((item) => {\n if (item.type === 'directory') {\n return succeed(item);\n }\n return fail(`${directoryPath}: not a directory`);\n });\n }\n}\n"]}
@@ -0,0 +1 @@
1
+ {"version":3,"file":"fileTreeAccessors.d.ts","sourceRoot":"","sources":["../../../src/packlets/file-tree/fileTreeAccessors.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AACrD,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEpC;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG,YAAY,GAAG,WAAW,CAAC;AAExD;;;;;;;;GAQG;AACH,MAAM,MAAM,iBAAiB,GACzB,eAAe,GACf,WAAW,GACX,aAAa,GACb,eAAe,GACf,mBAAmB,CAAC;AAExB;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,cAAc,GAAG,iBAAiB,CAAC;AAE5D;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IAE9B;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,WAAW,GAAG,MAAM,CAAC;AAEpD;;;GAGG;AACH,MAAM,MAAM,kBAAkB,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,IAAI,CAC5D,QAAQ,EAAE,MAAM,EAChB,QAAQ,CAAC,EAAE,MAAM,KACd,MAAM,CAAC,GAAG,GAAG,SAAS,CAAC,CAAC;AAE7B;;;GAGG;AACH,MAAM,WAAW,mBAAmB,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM;IAC9D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gBAAgB,CAAC,EAAE,kBAAkB,CAAC,GAAG,CAAC,CAAC;IAE3C;;;;;OAKG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,WAAW,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAMD;;;GAGG;AACH,MAAM,WAAW,iBAAiB,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM;IAC5D;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,GAAG,GAAG,SAAS,CAAC;IAEtC;;;;OAIG;IACH,WAAW,IAAI,MAAM,CAAC,SAAS,CAAC,CAAC;IAEjC;;;;;;OAMG;IACH,WAAW,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IAElE;;;;OAIG;IACH,cAAc,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAwB,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,iBAAiB,CAAC,GAAG,CAAC;IACnG;;;;OAIG;IACH,YAAY,IAAI,cAAc,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAEpD;;;;OAIG;IACH,WAAW,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;IAEhD;;;;OAIG;IACH,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;IAEjD;;;OAGG;IACH,MAAM,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC;CAC3B;AAMD;;;GAGG;AACH,MAAM,WAAW,sBAAsB,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM;IACjE;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,WAAW,IAAI,MAAM,CAAC,aAAa,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CACzD;AAED;;;;GAIG;AACH,MAAM,WAAW,6BAA6B,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,CACxE,SAAQ,sBAAsB,CAAC,GAAG,CAAC;IACnC;;;;;OAKG;IACH,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC,CAAC;IAEvF;;;;OAIG;IACH,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,6BAA6B,CAAC,GAAG,CAAC,CAAC,CAAC;IAE/E;;;;;OAKG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;IAE1E;;;;OAIG;IACH,MAAM,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC;CAC3B;AAMD;;;GAGG;AACH,MAAM,MAAM,YAAY,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,IAAI,iBAAiB,CAAC,GAAG,CAAC,GAAG,sBAAsB,CAAC,GAAG,CAAC,CAAC;AAE7G;;;GAGG;AACH,MAAM,MAAM,mBAAmB,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,IACvD,wBAAwB,CAAC,GAAG,CAAC,GAC7B,6BAA6B,CAAC,GAAG,CAAC,CAAC;AAEvC;;;;;;;;;GASG;AACH,MAAM,MAAM,mBAAmB,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,IACvD,iBAAiB,CAAC,GAAG,CAAC,GACtB,wBAAwB,CAAC,GAAG,CAAC,CAAC;AAElC;;;;;;;;;GASG;AACH,MAAM,MAAM,wBAAwB,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,IAC5D,sBAAsB,CAAC,GAAG,CAAC,GAC3B,6BAA6B,CAAC,GAAG,CAAC,CAAC;AAMvC;;;;GAIG;AACH,MAAM,WAAW,kBAAkB,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM;IAC7D;;;;OAIG;IACH,mBAAmB,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IAEhD;;;;OAIG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;IAEnC;;;;;OAKG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAEnD;;;;OAIG;IACH,SAAS,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IAEtC;;;;OAIG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC;IAEjD;;;;OAIG;IACH,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;IAE9C;;;;;OAKG;IACH,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,GAAG,GAAG,SAAS,CAAC,CAAC;IAE7E;;;;OAIG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,aAAa,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CACrE;AAED;;;;;GAKG;AACH,MAAM,WAAW,yBAAyB,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,kBAAkB,CAAC,GAAG,CAAC;IACrG;;;;;OAKG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,cAAc,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAEjE;;;;;OAKG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;IAEjE;;;;OAIG;IACH,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;IAE1C;;;;OAIG;IACH,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;IAE9C;;;;;OAKG;IACH,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;CAChD;AAED;;;GAGG;AACH,MAAM,WAAW,4BAA4B,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,CACvE,SAAQ,yBAAyB,CAAC,GAAG,CAAC;IACtC;;;OAGG;IACH,UAAU,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IAEpC;;;OAGG;IACH,OAAO,IAAI,OAAO,CAAC;IAEnB;;;OAGG;IACH,aAAa,IAAI,MAAM,EAAE,CAAC;CAC3B;AAMD;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,EAC5D,SAAS,EAAE,kBAAkB,CAAC,GAAG,CAAC,GACjC,SAAS,IAAI,yBAAyB,CAAC,GAAG,CAAC,CAS7C;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,EAC/D,SAAS,EAAE,kBAAkB,CAAC,GAAG,CAAC,GACjC,SAAS,IAAI,4BAA4B,CAAC,GAAG,CAAC,CAShD;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,EAC3D,IAAI,EAAE,mBAAmB,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC,GAAG,CAAC,GACjD,IAAI,IAAI,wBAAwB,CAAC,GAAG,CAAC,CASvC;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,EAChE,IAAI,EAAE,wBAAwB,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC,GAAG,CAAC,GACtD,IAAI,IAAI,6BAA6B,CAAC,GAAG,CAAC,CAS5C"}
@@ -0,0 +1 @@
1
+ {"version":3,"file":"fileTreeAccessors.js","sourceRoot":"","sources":["../../../src/packlets/file-tree/fileTreeAccessors.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;AA2cH,gDAWC;AAQD,sDAWC;AAQD,8CAWC;AAQD,wDAWC;AA9ED,+EAA+E;AAC/E,cAAc;AACd,+EAA+E;AAE/E;;;;;GAKG;AACH,SAAgB,kBAAkB,CAChC,SAAkC;IAElC,MAAM,OAAO,GAAG,SAA2C,CAAC;IAC5D,OAAO,CACL,OAAO,OAAO,CAAC,aAAa,KAAK,UAAU;QAC3C,OAAO,OAAO,CAAC,gBAAgB,KAAK,UAAU;QAC9C,OAAO,OAAO,CAAC,UAAU,KAAK,UAAU;QACxC,OAAO,OAAO,CAAC,eAAe,KAAK,UAAU;QAC7C,OAAO,OAAO,CAAC,eAAe,KAAK,UAAU,CAC9C,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAgB,qBAAqB,CACnC,SAAkC;IAElC,MAAM,UAAU,GAAG,SAA8C,CAAC;IAClE,oFAAoF;IACpF,OAAO,CACL,kBAAkB,CAAC,SAAS,CAAC;QAC7B,OAAO,UAAU,CAAC,UAAU,KAAK,UAAU;QAC3C,OAAO,UAAU,CAAC,OAAO,KAAK,UAAU;QACxC,OAAO,UAAU,CAAC,aAAa,KAAK,UAAU,CAC/C,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAgB,iBAAiB,CAC/B,IAAkD;IAElD,MAAM,OAAO,GAAG,IAAqC,CAAC;IACtD,OAAO,CACL,OAAO,CAAC,IAAI,KAAK,MAAM;QACvB,OAAO,OAAO,CAAC,YAAY,KAAK,UAAU;QAC1C,OAAO,OAAO,CAAC,WAAW,KAAK,UAAU;QACzC,OAAO,OAAO,CAAC,cAAc,KAAK,UAAU;QAC5C,OAAO,OAAO,CAAC,MAAM,KAAK,UAAU,CACrC,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAgB,sBAAsB,CACpC,IAAuD;IAEvD,MAAM,OAAO,GAAG,IAA0C,CAAC;IAC3D,OAAO,CACL,OAAO,CAAC,IAAI,KAAK,WAAW;QAC5B,OAAO,OAAO,CAAC,eAAe,KAAK,UAAU;QAC7C,OAAO,OAAO,CAAC,oBAAoB,KAAK,UAAU;QAClD,OAAO,OAAO,CAAC,WAAW,KAAK,UAAU;QACzC,OAAO,OAAO,CAAC,MAAM,KAAK,UAAU,CACrC,CAAC;AACJ,CAAC","sourcesContent":["/*\n * Copyright (c) 2025 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { DetailedResult, Result } from '@fgv/ts-utils';\nimport { Converter, Validator } from '@fgv/ts-utils';\nimport { JsonValue } from '../json';\n\n/**\n * Indicates the persistence capability of a save operation.\n * - `persistent`: Changes are saved to durable storage (e.g., file system).\n * - `transient`: Changes are saved in memory only and will be lost on reload.\n * @public\n */\nexport type SaveCapability = 'persistent' | 'transient';\n\n/**\n * Indicates the reason a save operation cannot be performed.\n * - `not-supported`: The accessors do not support mutation.\n * - `read-only`: The file or file system is read-only.\n * - `not-mutable`: Mutability is disabled in configuration.\n * - `path-excluded`: The path is excluded by the mutability filter.\n * - `permission-denied`: Insufficient permissions to write.\n * @public\n */\nexport type SaveFailureReason =\n | 'not-supported'\n | 'read-only'\n | 'not-mutable'\n | 'path-excluded'\n | 'permission-denied';\n\n/**\n * Detail type for getIsMutable results.\n * @public\n */\nexport type SaveDetail = SaveCapability | SaveFailureReason;\n\n/**\n * Filter specification for controlling which paths are mutable.\n * @public\n */\nexport interface IFilterSpec {\n /**\n * Paths or patterns to include. If specified, only matching paths are mutable.\n */\n include?: (string | RegExp)[];\n\n /**\n * Paths or patterns to exclude. Matching paths are not mutable.\n */\n exclude?: (string | RegExp)[];\n}\n\n/**\n * Type of item in a file tree.\n * @public\n */\nexport type FileTreeItemType = 'directory' | 'file';\n\n/**\n * Type of function to infer the content type of a file.\n * @public\n */\nexport type ContentTypeFactory<TCT extends string = string> = (\n filePath: string,\n provided?: string\n) => Result<TCT | undefined>;\n\n/**\n * Initialization parameters for a file tree.\n * @public\n */\nexport interface IFileTreeInitParams<TCT extends string = string> {\n prefix?: string;\n inferContentType?: ContentTypeFactory<TCT>;\n\n /**\n * Controls mutability of the file tree.\n * - `undefined` or `false`: No files are mutable.\n * - `true`: All files are mutable.\n * - `IFilterSpec`: Only files matching the filter are mutable.\n */\n mutable?: boolean | IFilterSpec;\n}\n\n/**\n * Options for deleting a child item from a directory.\n * @public\n */\nexport interface IDeleteChildOptions {\n /**\n * If true, recursively delete directory children and their contents.\n * Default: false (fail if directory is non-empty).\n */\n recursive?: boolean;\n}\n\n// ============================================================================\n// File Item Interfaces\n// ============================================================================\n\n/**\n * Interface for a read-only file in a file tree.\n * @public\n */\nexport interface IFileTreeFileItem<TCT extends string = string> {\n /**\n * Indicates that this {@link FileTree.FileTreeItem | file tree item} is a file.\n */\n readonly type: 'file';\n\n /**\n * The absolute path of the file.\n */\n readonly absolutePath: string;\n\n /**\n * The name of the file\n */\n readonly name: string;\n\n /**\n * The base name of the file (without extension)\n */\n readonly baseName: string;\n\n /**\n * The extension of the file\n */\n readonly extension: string;\n\n /**\n * An optional content type (e.g. mime type) for the file.\n */\n readonly contentType: TCT | undefined;\n\n /**\n * Gets the contents of the file as parsed JSON.\n * @returns `Success` with the parsed JSON-compatible contents if successful, or\n * `Failure` with an error message otherwise.\n */\n getContents(): Result<JsonValue>;\n\n /**\n * Gets the contents of the file as parsed JSON, converted to a specific type.\n * @param converter - A `Validator` or `Converter`\n * to convert the parsed JSON contents to the desired type.\n * @returns `Success` with the converted contents if successful, or\n * `Failure` with an error message otherwise.\n */\n getContents<T>(converter: Validator<T> | Converter<T>): Result<T>;\n\n /**\n * Gets the raw contents of the file as a string.\n * @returns `Success` with the raw contents if successful, or\n * `Failure` with an error message otherwise.\n */\n getRawContents(): Result<string>;\n}\n\n/**\n * Extended file item interface that supports mutation operations.\n * Use {@link FileTree.isMutableFileItem | isMutableFileItem} type guard to narrow.\n * @public\n */\nexport interface IMutableFileTreeFileItem<TCT extends string = string> extends IFileTreeFileItem<TCT> {\n /**\n * Indicates whether this file can be saved.\n * @returns `DetailedSuccess` with {@link FileTree.SaveCapability} if the file can be saved,\n * or `DetailedFailure` with {@link FileTree.SaveFailureReason} if it cannot.\n */\n getIsMutable(): DetailedResult<boolean, SaveDetail>;\n\n /**\n * Sets the contents of the file from a JSON value.\n * @param json - The JSON value to serialize and save.\n * @returns `Success` if the file was saved, or `Failure` with an error message.\n */\n setContents(json: JsonValue): Result<JsonValue>;\n\n /**\n * Sets the raw contents of the file.\n * @param contents - The string contents to save.\n * @returns `Success` if the file was saved, or `Failure` with an error message.\n */\n setRawContents(contents: string): Result<string>;\n\n /**\n * Deletes this file from its backing store.\n * @returns `Success` with `true` if the file was deleted, or `Failure` with an error message.\n */\n delete(): Result<boolean>;\n}\n\n// ============================================================================\n// Directory Item Interfaces\n// ============================================================================\n\n/**\n * Interface for a read-only directory in a file tree.\n * @public\n */\nexport interface IFileTreeDirectoryItem<TCT extends string = string> {\n /**\n * Indicates that this {@link FileTree.FileTreeItem | file tree item} is a directory\n */\n readonly type: 'directory';\n\n /**\n * The absolute path of the directory.\n */\n readonly absolutePath: string;\n\n /**\n * The name of the directory\n */\n readonly name: string;\n\n /**\n * Gets the children of the directory.\n * @returns `Success` with the children of the directory if successful,\n * or `Failure` with an error message otherwise.\n */\n getChildren(): Result<ReadonlyArray<FileTreeItem<TCT>>>;\n}\n\n/**\n * Extended directory item interface that supports mutation operations.\n * Use {@link FileTree.isMutableDirectoryItem | isMutableDirectoryItem} type guard to narrow.\n * @public\n */\nexport interface IMutableFileTreeDirectoryItem<TCT extends string = string>\n extends IFileTreeDirectoryItem<TCT> {\n /**\n * Creates a new file as a child of this directory.\n * @param name - The file name to create.\n * @param contents - The string contents to write.\n * @returns `Success` with the new file item, or `Failure` with an error message.\n */\n createChildFile(name: string, contents: string): Result<IMutableFileTreeFileItem<TCT>>;\n\n /**\n * Creates a new subdirectory as a child of this directory.\n * @param name - The directory name to create.\n * @returns `Success` with the new directory item, or `Failure` with an error message.\n */\n createChildDirectory(name: string): Result<IMutableFileTreeDirectoryItem<TCT>>;\n\n /**\n * Deletes a child item from this directory.\n * @param name - The name of the child to delete.\n * @param options - Optional {@link FileTree.IDeleteChildOptions | options} controlling deletion behavior.\n * @returns `Success` with `true` if the child was deleted, or `Failure` with an error message.\n */\n deleteChild(name: string, options?: IDeleteChildOptions): Result<boolean>;\n\n /**\n * Deletes this directory from its backing store.\n * The directory must be empty or the operation will fail.\n * @returns `Success` with `true` if the directory was deleted, or `Failure` with an error message.\n */\n delete(): Result<boolean>;\n}\n\n// ============================================================================\n// Union Types\n// ============================================================================\n\n/**\n * Type for an item in a file tree.\n * @public\n */\nexport type FileTreeItem<TCT extends string = string> = IFileTreeFileItem<TCT> | IFileTreeDirectoryItem<TCT>;\n\n/**\n * Type for a mutable item in a file tree.\n * @public\n */\nexport type MutableFileTreeItem<TCT extends string = string> =\n | IMutableFileTreeFileItem<TCT>\n | IMutableFileTreeDirectoryItem<TCT>;\n\n/**\n * A file item that may or may not be mutable at runtime.\n *\n * Use this type for parameters or fields where the code checks for mutability\n * and handles the read-only case gracefully. Use {@link FileTree.IMutableFileTreeFileItem}\n * when mutation is required.\n *\n * Narrow with {@link FileTree.isMutableFileItem} to access mutation methods.\n * @public\n */\nexport type AnyFileTreeFileItem<TCT extends string = string> =\n | IFileTreeFileItem<TCT>\n | IMutableFileTreeFileItem<TCT>;\n\n/**\n * A directory item that may or may not be mutable at runtime.\n *\n * Use this type for parameters or fields where the code checks for mutability\n * and handles the read-only case gracefully. Use {@link FileTree.IMutableFileTreeDirectoryItem}\n * when mutation is required.\n *\n * Narrow with {@link FileTree.isMutableDirectoryItem} to access mutation methods.\n * @public\n */\nexport type AnyFileTreeDirectoryItem<TCT extends string = string> =\n | IFileTreeDirectoryItem<TCT>\n | IMutableFileTreeDirectoryItem<TCT>;\n\n// ============================================================================\n// Accessor Interfaces\n// ============================================================================\n\n/**\n * Common abstraction layer interface for a tree of files\n * (e.g. a file system or a zip file).\n * @public\n */\nexport interface IFileTreeAccessors<TCT extends string = string> {\n /**\n * Resolves paths to an absolute path.\n * @param paths - Paths to resolve.\n * @returns The resolved absolute path.\n */\n resolveAbsolutePath(...paths: string[]): string;\n\n /**\n * Gets the extension of a path.\n * @param path - Path to get the extension of.\n * @returns The extension of the path.\n */\n getExtension(path: string): string;\n\n /**\n * Gets the base name of a path.\n * @param path - Path to get the base name of.\n * @param suffix - Optional suffix to remove from the base name.\n * @returns The base name of the path.\n */\n getBaseName(path: string, suffix?: string): string;\n\n /**\n * Joins paths together.\n * @param paths - Paths to join.\n * @returns The joined paths.\n */\n joinPaths(...paths: string[]): string;\n\n /**\n * Gets an item from the file tree.\n * @param path - Path of the item to get.\n * @returns The item if it exists.\n */\n getItem(path: string): Result<FileTreeItem<TCT>>;\n\n /**\n * Gets the contents of a file in the file tree.\n * @param path - Absolute path of the file.\n * @returns The contents of the file.\n */\n getFileContents(path: string): Result<string>;\n\n /**\n * Gets the content type of a file in the file tree.\n * @param path - Absolute path of the file.\n * @param provided - Optional supplied content type.\n * @returns The content type of the file.\n */\n getFileContentType(path: string, provided?: string): Result<TCT | undefined>;\n\n /**\n * Gets the children of a directory in the file tree.\n * @param path - Path of the directory.\n * @returns The children of the directory.\n */\n getChildren(path: string): Result<ReadonlyArray<FileTreeItem<TCT>>>;\n}\n\n/**\n * Extended accessors interface that supports mutation operations.\n * All mutation methods are required — use {@link FileTree.isMutableAccessors | isMutableAccessors}\n * type guard to check if an accessor supports mutation.\n * @public\n */\nexport interface IMutableFileTreeAccessors<TCT extends string = string> extends IFileTreeAccessors<TCT> {\n /**\n * Checks if a file at the given path can be saved.\n * @param path - The path to check.\n * @returns `DetailedSuccess` with {@link FileTree.SaveCapability} if the file can be saved,\n * or `DetailedFailure` with {@link FileTree.SaveFailureReason} if it cannot.\n */\n fileIsMutable(path: string): DetailedResult<boolean, SaveDetail>;\n\n /**\n * Saves the contents to a file at the given path.\n * @param path - The path of the file to save.\n * @param contents - The string contents to save.\n * @returns `Success` if the file was saved, or `Failure` with an error message.\n */\n saveFileContents(path: string, contents: string): Result<string>;\n\n /**\n * Deletes a file at the given path.\n * @param path - The path of the file to delete.\n * @returns `Success` with `true` if the file was deleted, or `Failure` with an error message.\n */\n deleteFile(path: string): Result<boolean>;\n\n /**\n * Creates a directory at the given path, including any missing parent directories.\n * @param path - The path of the directory to create.\n * @returns `Success` with the absolute path if created, or `Failure` with an error message.\n */\n createDirectory(path: string): Result<string>;\n\n /**\n * Deletes a directory at the given path.\n * The directory must be empty or the operation will fail.\n * @param path - The path of the directory to delete.\n * @returns `Success` with `true` if the directory was deleted, or `Failure` with an error message.\n */\n deleteDirectory(path: string): Result<boolean>;\n}\n\n/**\n * Extended accessors interface that supports persistence operations.\n * @public\n */\nexport interface IPersistentFileTreeAccessors<TCT extends string = string>\n extends IMutableFileTreeAccessors<TCT> {\n /**\n * Synchronize all dirty files to persistent storage.\n * @returns Promise resolving to success or failure\n */\n syncToDisk(): Promise<Result<void>>;\n\n /**\n * Check if there are unsaved changes.\n * @returns True if there are dirty files\n */\n isDirty(): boolean;\n\n /**\n * Get paths of all files with unsaved changes.\n * @returns Array of dirty file paths\n */\n getDirtyPaths(): string[];\n}\n\n// ============================================================================\n// Type Guards\n// ============================================================================\n\n/**\n * Type guard to check if accessors support mutation.\n * @param accessors - The accessors to check.\n * @returns `true` if the accessors implement {@link FileTree.IMutableFileTreeAccessors}.\n * @public\n */\nexport function isMutableAccessors<TCT extends string = string>(\n accessors: IFileTreeAccessors<TCT>\n): accessors is IMutableFileTreeAccessors<TCT> {\n const mutable = accessors as IMutableFileTreeAccessors<TCT>;\n return (\n typeof mutable.fileIsMutable === 'function' &&\n typeof mutable.saveFileContents === 'function' &&\n typeof mutable.deleteFile === 'function' &&\n typeof mutable.createDirectory === 'function' &&\n typeof mutable.deleteDirectory === 'function'\n );\n}\n\n/**\n * Type guard to check if accessors support persistence.\n * @param accessors - The accessors to check.\n * @returns `true` if the accessors implement {@link FileTree.IPersistentFileTreeAccessors}.\n * @public\n */\nexport function isPersistentAccessors<TCT extends string = string>(\n accessors: IFileTreeAccessors<TCT>\n): accessors is IPersistentFileTreeAccessors<TCT> {\n const persistent = accessors as IPersistentFileTreeAccessors<TCT>;\n /* c8 ignore next 6 - no current accessor implements IPersistentFileTreeAccessors */\n return (\n isMutableAccessors(accessors) &&\n typeof persistent.syncToDisk === 'function' &&\n typeof persistent.isDirty === 'function' &&\n typeof persistent.getDirtyPaths === 'function'\n );\n}\n\n/**\n * Type guard to check if a file item supports mutation.\n * @param item - The file item to check.\n * @returns `true` if the item implements {@link FileTree.IMutableFileTreeFileItem}.\n * @public\n */\nexport function isMutableFileItem<TCT extends string = string>(\n item: AnyFileTreeFileItem<TCT> | FileTreeItem<TCT>\n): item is IMutableFileTreeFileItem<TCT> {\n const mutable = item as IMutableFileTreeFileItem<TCT>;\n return (\n mutable.type === 'file' &&\n typeof mutable.getIsMutable === 'function' &&\n typeof mutable.setContents === 'function' &&\n typeof mutable.setRawContents === 'function' &&\n typeof mutable.delete === 'function'\n );\n}\n\n/**\n * Type guard to check if a directory item supports mutation.\n * @param item - The directory item to check.\n * @returns `true` if the item implements {@link FileTree.IMutableFileTreeDirectoryItem}.\n * @public\n */\nexport function isMutableDirectoryItem<TCT extends string = string>(\n item: AnyFileTreeDirectoryItem<TCT> | FileTreeItem<TCT>\n): item is IMutableFileTreeDirectoryItem<TCT> {\n const mutable = item as IMutableFileTreeDirectoryItem<TCT>;\n return (\n mutable.type === 'directory' &&\n typeof mutable.createChildFile === 'function' &&\n typeof mutable.createChildDirectory === 'function' &&\n typeof mutable.deleteChild === 'function' &&\n typeof mutable.delete === 'function'\n );\n}\n"]}
@@ -0,0 +1 @@
1
+ {"version":3,"file":"fileTreeHelpers.d.ts","sourceRoot":"","sources":["../../../src/packlets/file-tree/fileTreeHelpers.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAiB,MAAM,EAAE,MAAM,eAAe,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAE1D;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;AAEnG;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,EACvD,MAAM,CAAC,EAAE,mBAAmB,CAAC,GAAG,CAAC,GAChC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC"}
@@ -0,0 +1 @@
1
+ {"version":3,"file":"fileTreeHelpers.inMemory.d.ts","sourceRoot":"","sources":["../../../src/packlets/file-tree/fileTreeHelpers.inMemory.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACvC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,aAAa,EAAyB,MAAM,aAAa,CAAC;AACnE,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAE1D;;;;;;;;GAQG;AACH,wBAAgB,QAAQ,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,EAClD,KAAK,EAAE,aAAa,CAAC,GAAG,CAAC,EAAE,EAC3B,MAAM,CAAC,EAAE,MAAM,GACd,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;AAEzB;;;;;;;;GAQG;AACH,wBAAgB,QAAQ,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,EAClD,KAAK,EAAE,aAAa,CAAC,GAAG,CAAC,EAAE,EAC3B,MAAM,CAAC,EAAE,mBAAmB,CAAC,GAAG,CAAC,GAChC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC"}
@@ -0,0 +1 @@
1
+ {"version":3,"file":"fileTreeHelpers.inMemory.js","sourceRoot":"","sources":["../../../src/packlets/file-tree/fileTreeHelpers.inMemory.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;AAmCH,4BAQC;AAxCD,yCAAsC;AACtC,2CAAmE;AA+BnE,SAAgB,QAAQ,CACtB,KAA2B,EAC3B,MAA0C;IAE1C,MAAM,GAAG,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;IAClE,OAAO,iCAAqB,CAAC,MAAM,CAAM,KAAK,EAAE,MAAM,CAAC,CAAC,SAAS,CAAC,CAAC,GAA+B,EAAE,EAAE,CACpG,mBAAQ,CAAC,MAAM,CAAM,GAAG,CAAC,CAC1B,CAAC;AACJ,CAAC","sourcesContent":["/*\n * Copyright (c) 2025 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { Result } from '@fgv/ts-utils';\nimport { FileTree } from './fileTree';\nimport { IInMemoryFile, InMemoryTreeAccessors } from './in-memory';\nimport { IFileTreeInitParams } from './fileTreeAccessors';\n\n/**\n * Helper function to create a new {@link FileTree.FileTree | FileTree} instance\n * with accessors for an in-memory file tree.\n * @param files - An array of File |{@link FileTree.IInMemoryFile | in-memory files} to include in the tree.\n * @param prefix - An optional prefix to add to the paths of all files in the tree.\n * @returns `Success` with the new {@link FileTree.FileTree | FileTree} instance\n * if successful, or `Failure` with an error message otherwise.\n * @public\n */\nexport function inMemory<TCT extends string = string>(\n files: IInMemoryFile<TCT>[],\n prefix?: string\n): Result<FileTree<TCT>>;\n\n/**\n * Helper function to create a new {@link FileTree.FileTree | FileTree} instance\n * with accessors for an in-memory file tree.\n * @param files - An array of File |{@link FileTree.IInMemoryFile | in-memory files} to include in the tree.\n * @param params - Optional {@link FileTree.IFileTreeInitParams | initialization parameters} for the file tree.\n * @returns `Success` with the new {@link FileTree.FileTree | FileTree} instance\n * if successful, or `Failure` with an error message otherwise.\n * @public\n */\nexport function inMemory<TCT extends string = string>(\n files: IInMemoryFile<TCT>[],\n params?: IFileTreeInitParams<TCT>\n): Result<FileTree<TCT>>;\n\nexport function inMemory<TCT extends string = string>(\n files: IInMemoryFile<TCT>[],\n params?: IFileTreeInitParams<TCT> | string\n): Result<FileTree<TCT>> {\n params = typeof params === 'string' ? { prefix: params } : params;\n return InMemoryTreeAccessors.create<TCT>(files, params).onSuccess((hal: InMemoryTreeAccessors<TCT>) =>\n FileTree.create<TCT>(hal)\n );\n}\n"]}
@@ -0,0 +1 @@
1
+ {"version":3,"file":"fileTreeHelpers.js","sourceRoot":"","sources":["../../../src/packlets/file-tree/fileTreeHelpers.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;AA4BH,sCAKC;AA/BD,4CAAsD;AACtD,yCAAsC;AACtC,qCAA+C;AAwB/C,SAAgB,aAAa,CAC3B,MAA0C;IAE1C,MAAM,GAAG,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;IAClE,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,4BAAmB,CAAM,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,mBAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;AAC5G,CAAC","sourcesContent":["/*\n * Copyright (c) 2025 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { captureResult, Result } from '@fgv/ts-utils';\nimport { FileTree } from './fileTree';\nimport { FsFileTreeAccessors } from './fsTree';\nimport { IFileTreeInitParams } from './fileTreeAccessors';\n\n/**\n * Helper function to create a new {@link FileTree.FileTree | FileTree} instance\n * with accessors for the filesystem.\n * @param prefix - An optional prefix to prepended to supplied relative paths.\n * @returns `Success` with the new {@link FileTree.FileTree | FileTree} instance\n * if successful, or `Failure` with an error message otherwise.\n * @public\n */\nexport function forFilesystem<TCT extends string = string>(prefix?: string): Result<FileTree<TCT>>;\n\n/**\n * Helper function to create a new {@link FileTree.FileTree | FileTree} instance\n * with accessors for the filesystem.\n * @param params - Optional {@link FileTree.IFileTreeInitParams | initialization parameters} for the file tree.\n * @returns `Success` with the new {@link FileTree.FileTree | FileTree} instance\n * if successful, or `Failure` with an error message otherwise.\n * @public\n */\nexport function forFilesystem<TCT extends string = string>(\n params?: IFileTreeInitParams<TCT>\n): Result<FileTree<TCT>>;\nexport function forFilesystem<TCT extends string = string>(\n params?: IFileTreeInitParams<TCT> | string\n): Result<FileTree<TCT>> {\n params = typeof params === 'string' ? { prefix: params } : params;\n return captureResult(() => new FsFileTreeAccessors<TCT>(params)).onSuccess((hal) => FileTree.create(hal));\n}\n"]}
@@ -0,0 +1 @@
1
+ {"version":3,"file":"filterSpec.d.ts","sourceRoot":"","sources":["../../../src/packlets/file-tree/filterSpec.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AA8BlD;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,WAAW,GAAG,SAAS,GAAG,OAAO,CAuB/F"}
@@ -0,0 +1 @@
1
+ {"version":3,"file":"filterSpec.js","sourceRoot":"","sources":["../../../src/packlets/file-tree/filterSpec.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;AAuCH,sCAuBC;AA1DD;;;;;;GAMG;AACH,SAAS,cAAc,CAAC,IAAY,EAAE,OAAwB;IAC5D,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAChC,OAAO,IAAI,KAAK,OAAO,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,GAAG,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IACtF,CAAC;IACD,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC5B,CAAC;AAED;;;;;;GAMG;AACH,SAAS,UAAU,CAAC,IAAY,EAAE,QAAyC;IACzE,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvC,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;AACnE,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,aAAa,CAAC,IAAY,EAAE,OAA0C;IACpF,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,KAAK,KAAK,EAAE,CAAC;QAC/C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IAErC,uEAAuE;IACvE,IAAI,UAAU,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,kEAAkE;IAClE,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAClC,OAAO,UAAU,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACnC,CAAC;IAED,iEAAiE;IACjE,OAAO,IAAI,CAAC;AACd,CAAC","sourcesContent":["/*\n * Copyright (c) 2025 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { IFilterSpec } from './fileTreeAccessors';\n\n/**\n * Checks if a path matches a single pattern (string or RegExp).\n * @param path - The path to check.\n * @param pattern - The pattern to match against.\n * @returns `true` if the path matches the pattern.\n * @internal\n */\nfunction matchesPattern(path: string, pattern: string | RegExp): boolean {\n if (typeof pattern === 'string') {\n return path === pattern || path.startsWith(pattern + '/') || path.includes(pattern);\n }\n return pattern.test(path);\n}\n\n/**\n * Checks if a path matches any pattern in an array.\n * @param path - The path to check.\n * @param patterns - The patterns to match against.\n * @returns `true` if the path matches any pattern.\n * @internal\n */\nfunction matchesAny(path: string, patterns: (string | RegExp)[] | undefined): boolean {\n if (!patterns || patterns.length === 0) {\n return false;\n }\n return patterns.some((pattern) => matchesPattern(path, pattern));\n}\n\n/**\n * Checks if a path is allowed by a mutability configuration.\n * @param path - The path to check.\n * @param mutable - The mutability configuration.\n * @returns `true` if the path is mutable according to the configuration.\n * @public\n */\nexport function isPathMutable(path: string, mutable: boolean | IFilterSpec | undefined): boolean {\n if (mutable === undefined || mutable === false) {\n return false;\n }\n\n if (mutable === true) {\n return true;\n }\n\n const { include, exclude } = mutable;\n\n // If exclude patterns are specified and path matches, it's not mutable\n if (matchesAny(path, exclude)) {\n return false;\n }\n\n // If include patterns are specified, path must match at least one\n if (include && include.length > 0) {\n return matchesAny(path, include);\n }\n\n // No include patterns means all paths (not excluded) are mutable\n return true;\n}\n"]}