@fgv/ts-res 4.5.0-0

package/lib/packlets/import/importers/fsItemImporter.d.ts

@@ -0,0 +1,49 @@
+import { DetailedResult, Result } from '@fgv/ts-utils';
+import { ResourceManager } from '../../resources';
+import { IImportable } from '../importable';
+import { IImporter, ImporterResultDetail } from './importer';
+import { IReadOnlyQualifierCollector } from '../../qualifiers';
+import { FsItem, FsItemResultDetail } from '../fsItem';
+/**
+ * Parameters for creating a {@link Import.Importers.FsItemImporter | FsItemImporter}.
+ * @public
+ */
+export interface IFsItemImporterCreateParams {
+    qualifiers: IReadOnlyQualifierCollector;
+}
+/**
+ * {@link Import.Importers.IImporter | Importer} implementation which imports resources from a `FileTree`.
+ * @public
+ */
+export declare class FsItemImporter implements IImporter {
+    /**
+     * The {@link Qualifiers.IReadOnlyQualifierCollector | qualifier collector} to use for this importer.
+     */
+    readonly qualifiers: IReadOnlyQualifierCollector;
+    /**
+     * The types of {@link Import.IImportable | importables} that this importer can handle.
+     */
+    readonly types: ReadonlyArray<string>;
+    /**
+     * Protected constructor for the {@link Import.Importers.FsItemImporter | FsItemImporter}.
+     * @param params - Parameters for creating the {@link Import.Importers.FsItemImporter | FsItemImporter}.
+     */
+    protected constructor(params: IFsItemImporterCreateParams);
+    /**
+     * Creates a new {@link Import.Importers.FsItemImporter | FsItemImporter}.
+     * @param params - Parameters for creating the {@link Import.Importers.FsItemImporter | FsItemImporter}.
+     * @returns `Success` with the new `FsItemImporter` if successful, `Failure` with an error message if not.
+     */
+    static create(params: IFsItemImporterCreateParams): Result<FsItemImporter>;
+    /**
+     * {@inheritdoc Import.Importers.IImporter.import}
+     */
+    import(item: IImportable, __manager: ResourceManager): DetailedResult<IImportable[], ImporterResultDetail>;
+    /**
+     * Gets an {@link Import.FsItem | FsItem} from an {@link Import.IImportable | importable}.
+     * @param item - The importable to convert.
+     * @returns `Success` containing the `FsItem` if successful, `Failure` with an error message if not.
+     */
+    protected _getFileTreeItemFromImportable(item: IImportable): DetailedResult<FsItem, FsItemResultDetail>;
+}
+//# sourceMappingURL=fsItemImporter.d.ts.map

package/lib/packlets/import/importers/fsItemImporter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fsItemImporter.d.ts","sourceRoot":"","sources":["../../../../src/packlets/import/importers/fsItemImporter.ts"],"names":[],"mappings":"AAsBA,OAAO,EAEL,cAAc,EAEd,MAAM,EAIP,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,WAAW,EAA+B,MAAM,eAAe,CAAC;AACzE,OAAO,EAAE,SAAS,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAC7D,OAAO,EAAE,2BAA2B,EAAE,MAAM,kBAAkB,CAAC;AAC/D,OAAO,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAEvD;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC1C,UAAU,EAAE,2BAA2B,CAAC;CACzC;AAED;;;GAGG;AACH,qBAAa,cAAe,YAAW,SAAS;IAC9C;;OAEG;IACH,SAAgB,UAAU,EAAE,2BAA2B,CAAC;IAExD;;OAEG;IACH,SAAgB,KAAK,EAAE,aAAa,CAAC,MAAM,CAAC,CAAc;IAE1D;;;OAGG;IACH,SAAS,aAAa,MAAM,EAAE,2BAA2B;IAIzD;;;;OAIG;WACW,MAAM,CAAC,MAAM,EAAE,2BAA2B,GAAG,MAAM,CAAC,cAAc,CAAC;IAIjF;;OAEG;IACI,MAAM,CACX,IAAI,EAAE,WAAW,EACjB,SAAS,EAAE,eAAe,GACzB,cAAc,CAAC,WAAW,EAAE,EAAE,oBAAoB,CAAC;IAuDtD;;;;OAIG;IACH,SAAS,CAAC,8BAA8B,CAAC,IAAI,EAAE,WAAW,GAAG,cAAc,CAAC,MAAM,EAAE,kBAAkB,CAAC;CASxG"}

package/lib/packlets/import/importers/fsItemImporter.js

@@ -0,0 +1,120 @@
+"use strict";
+/*
+ * Copyright (c) 2025 Erik Fortune
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FsItemImporter = void 0;
+const ts_utils_1 = require("@fgv/ts-utils");
+const ts_json_base_1 = require("@fgv/ts-json-base");
+const fsItem_1 = require("../fsItem");
+/**
+ * {@link Import.Importers.IImporter | Importer} implementation which imports resources from a `FileTree`.
+ * @public
+ */
+class FsItemImporter {
+    /**
+     * Protected constructor for the {@link Import.Importers.FsItemImporter | FsItemImporter}.
+     * @param params - Parameters for creating the {@link Import.Importers.FsItemImporter | FsItemImporter}.
+     */
+    constructor(params) {
+        /**
+         * The types of {@link Import.IImportable | importables} that this importer can handle.
+         */
+        this.types = ['fsItem'];
+        this.qualifiers = params.qualifiers;
+    }
+    /**
+     * Creates a new {@link Import.Importers.FsItemImporter | FsItemImporter}.
+     * @param params - Parameters for creating the {@link Import.Importers.FsItemImporter | FsItemImporter}.
+     * @returns `Success` with the new `FsItemImporter` if successful, `Failure` with an error message if not.
+     */
+    static create(params) {
+        return (0, ts_utils_1.captureResult)(() => new FsItemImporter(params));
+    }
+    /**
+     * {@inheritdoc Import.Importers.IImporter.import}
+     */
+    import(item, __manager) {
+        const { value: fsItem, message: getTreeMessage, detail: getTreeDetail } = this._getFileTreeItemFromImportable(item);
+        if (getTreeMessage !== undefined) {
+            return (0, ts_utils_1.failWithDetail)(getTreeMessage, getTreeDetail === 'skipped' ? 'skipped' : 'failed');
+        }
+        const { value: context, message: getContextMessage } = fsItem.getContext().onSuccess((fsItemContext) => {
+            return item.context ? item.context.extend(fsItemContext) : (0, ts_utils_1.succeed)(fsItemContext);
+        });
+        /* c8 ignore next 3 - defense in depth nearly impossible to reproduce */
+        if (getContextMessage) {
+            return (0, ts_utils_1.failWithDetail)(getContextMessage, 'failed');
+        }
+        if (fsItem.item.type === 'directory') {
+            return fsItem.item
+                .getChildren()
+                .onSuccess((children) => {
+                const errors = new ts_utils_1.MessageAggregator();
+                const items = [];
+                for (const child of children) {
+                    const { value: item, message, detail } = fsItem_1.FsItem.createForItem(child, this.qualifiers);
+                    if (item) {
+                        items.push({ type: 'fsItem', item, context });
+                    }
+                    else if (detail !== 'skipped') {
+                        errors.addMessage(message);
+                    }
+                }
+                return errors.returnOrReport((0, ts_utils_1.succeed)(items));
+            })
+                .withDetail('failed', 'processed');
+        }
+        else if (fsItem.item.type === 'file') {
+            if (fsItem.item.extension === '.json') {
+                return fsItem.item
+                    .getContents(ts_json_base_1.Converters.jsonValue)
+                    .onSuccess((json) => {
+                    const jsonItem = {
+                        type: 'json',
+                        json,
+                        context
+                    };
+                    return (0, ts_utils_1.succeed)([jsonItem]);
+                })
+                    .withDetail('failed', 'processed');
+            }
+        }
+        /* c8 ignore next 2 - defense in depth near impossible to reproduce */
+        return (0, ts_utils_1.succeedWithDetail)([], 'skipped');
+    }
+    /**
+     * Gets an {@link Import.FsItem | FsItem} from an {@link Import.IImportable | importable}.
+     * @param item - The importable to convert.
+     * @returns `Success` containing the `FsItem` if successful, `Failure` with an error message if not.
+     */
+    _getFileTreeItemFromImportable(item) {
+        if (item.type === 'fsItem') {
+            if ('item' in item && item.item instanceof fsItem_1.FsItem) {
+                return (0, ts_utils_1.succeedWithDetail)(item.item, 'succeeded');
+            }
+            return (0, ts_utils_1.failWithDetail)(`malformed fsItem importable does not contain a valid item`, 'failed');
+        }
+        return (0, ts_utils_1.failWithDetail)(`${item.type}: invalid importable type for an FsItemImporter`, 'skipped');
+    }
+}
+exports.FsItemImporter = FsItemImporter;
+//# sourceMappingURL=fsItemImporter.js.map

package/lib/packlets/import/importers/fsItemImporter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fsItemImporter.js","sourceRoot":"","sources":["../../../../src/packlets/import/importers/fsItemImporter.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,4CAQuB;AACvB,oDAAiE;AAKjE,sCAAuD;AAUvD;;;GAGG;AACH,MAAa,cAAc;IAWzB;;;OAGG;IACH,YAAsB,MAAmC;QATzD;;WAEG;QACa,UAAK,GAA0B,CAAC,QAAQ,CAAC,CAAC;QAOxD,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,MAAM,CAAC,MAAmC;QACtD,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACI,MAAM,CACX,IAAiB,EACjB,SAA0B;QAE1B,MAAM,EACJ,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,cAAc,EACvB,MAAM,EAAE,aAAa,EACtB,GAAG,IAAI,CAAC,8BAA8B,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;YACjC,OAAO,IAAA,yBAAc,EAAC,cAAc,EAAE,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;QAC5F,CAAC;QAED,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE,GAAG,MAAM,CAAC,UAAU,EAAE,CAAC,SAAS,CAAC,CAAC,aAAa,EAAE,EAAE;YACrG,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,IAAA,kBAAO,EAAC,aAAa,CAAC,CAAC;QACpF,CAAC,CAAC,CAAC;QAEH,wEAAwE;QACxE,IAAI,iBAAiB,EAAE,CAAC;YACtB,OAAO,IAAA,yBAAc,EAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;QACrD,CAAC;QAED,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;YACrC,OAAO,MAAM,CAAC,IAAI;iBACf,WAAW,EAAE;iBACb,SAAS,CAAC,CAAC,QAAQ,EAAE,EAAE;gBACtB,MAAM,MAAM,GAAG,IAAI,4BAAiB,EAAE,CAAC;gBACvC,MAAM,KAAK,GAAiB,EAAE,CAAC;gBAC/B,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;oBAC7B,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,eAAM,CAAC,aAAa,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;oBACtF,IAAI,IAAI,EAAE,CAAC;wBACT,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;oBAChD,CAAC;yBAAM,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;wBAChC,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;oBAC7B,CAAC;gBACH,CAAC;gBACD,OAAO,MAAM,CAAC,cAAc,CAAC,IAAA,kBAAO,EAAC,KAAK,CAAC,CAAC,CAAC;YAC/C,CAAC,CAAC;iBACD,UAAU,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QACvC,CAAC;aAAM,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;YACvC,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,KAAK,OAAO,EAAE,CAAC;gBACtC,OAAO,MAAM,CAAC,IAAI;qBACf,WAAW,CAAC,yBAAc,CAAC,SAAS,CAAC;qBACrC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE;oBAClB,MAAM,QAAQ,GAAoB;wBAChC,IAAI,EAAE,MAAM;wBACZ,IAAI;wBACJ,OAAO;qBACR,CAAC;oBACF,OAAO,IAAA,kBAAO,EAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;gBAC7B,CAAC,CAAC;qBACD,UAAU,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;YACvC,CAAC;QACH,CAAC;QACD,sEAAsE;QACtE,OAAO,IAAA,4BAAiB,EAAC,EAAE,EAAE,SAAS,CAAC,CAAC;IAC1C,CAAC;IAED;;;;OAIG;IACO,8BAA8B,CAAC,IAAiB;QACxD,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC3B,IAAI,MAAM,IAAI,IAAI,IAAI,IAAI,CAAC,IAAI,YAAY,eAAM,EAAE,CAAC;gBAClD,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;YACnD,CAAC;YACD,OAAO,IAAA,yBAAc,EAAC,2DAA2D,EAAE,QAAQ,CAAC,CAAC;QAC/F,CAAC;QACD,OAAO,IAAA,yBAAc,EAAC,GAAG,IAAI,CAAC,IAAI,iDAAiD,EAAE,SAAS,CAAC,CAAC;IAClG,CAAC;CACF;AAvGD,wCAuGC","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 {\n  captureResult,\n  DetailedResult,\n  failWithDetail,\n  Result,\n  succeed,\n  succeedWithDetail,\n  MessageAggregator\n} from '@fgv/ts-utils';\nimport { Converters as JsonConverters } from '@fgv/ts-json-base';\nimport { ResourceManager } from '../../resources';\nimport { IImportable, IImportableJson, Importable } from '../importable';\nimport { IImporter, ImporterResultDetail } from './importer';\nimport { IReadOnlyQualifierCollector } from '../../qualifiers';\nimport { FsItem, FsItemResultDetail } from '../fsItem';\n\n/**\n * Parameters for creating a {@link Import.Importers.FsItemImporter | FsItemImporter}.\n * @public\n */\nexport interface IFsItemImporterCreateParams {\n  qualifiers: IReadOnlyQualifierCollector;\n}\n\n/**\n * {@link Import.Importers.IImporter | Importer} implementation which imports resources from a `FileTree`.\n * @public\n */\nexport class FsItemImporter implements IImporter {\n  /**\n   * The {@link Qualifiers.IReadOnlyQualifierCollector | qualifier collector} to use for this importer.\n   */\n  public readonly qualifiers: IReadOnlyQualifierCollector;\n\n  /**\n   * The types of {@link Import.IImportable | importables} that this importer can handle.\n   */\n  public readonly types: ReadonlyArray<string> = ['fsItem'];\n\n  /**\n   * Protected constructor for the {@link Import.Importers.FsItemImporter | FsItemImporter}.\n   * @param params - Parameters for creating the {@link Import.Importers.FsItemImporter | FsItemImporter}.\n   */\n  protected constructor(params: IFsItemImporterCreateParams) {\n    this.qualifiers = params.qualifiers;\n  }\n\n  /**\n   * Creates a new {@link Import.Importers.FsItemImporter | FsItemImporter}.\n   * @param params - Parameters for creating the {@link Import.Importers.FsItemImporter | FsItemImporter}.\n   * @returns `Success` with the new `FsItemImporter` if successful, `Failure` with an error message if not.\n   */\n  public static create(params: IFsItemImporterCreateParams): Result<FsItemImporter> {\n    return captureResult(() => new FsItemImporter(params));\n  }\n\n  /**\n   * {@inheritdoc Import.Importers.IImporter.import}\n   */\n  public import(\n    item: IImportable,\n    __manager: ResourceManager\n  ): DetailedResult<IImportable[], ImporterResultDetail> {\n    const {\n      value: fsItem,\n      message: getTreeMessage,\n      detail: getTreeDetail\n    } = this._getFileTreeItemFromImportable(item);\n    if (getTreeMessage !== undefined) {\n      return failWithDetail(getTreeMessage, getTreeDetail === 'skipped' ? 'skipped' : 'failed');\n    }\n\n    const { value: context, message: getContextMessage } = fsItem.getContext().onSuccess((fsItemContext) => {\n      return item.context ? item.context.extend(fsItemContext) : succeed(fsItemContext);\n    });\n\n    /* c8 ignore next 3 - defense in depth nearly impossible to reproduce */\n    if (getContextMessage) {\n      return failWithDetail(getContextMessage, 'failed');\n    }\n\n    if (fsItem.item.type === 'directory') {\n      return fsItem.item\n        .getChildren()\n        .onSuccess((children) => {\n          const errors = new MessageAggregator();\n          const items: Importable[] = [];\n          for (const child of children) {\n            const { value: item, message, detail } = FsItem.createForItem(child, this.qualifiers);\n            if (item) {\n              items.push({ type: 'fsItem', item, context });\n            } else if (detail !== 'skipped') {\n              errors.addMessage(message);\n            }\n          }\n          return errors.returnOrReport(succeed(items));\n        })\n        .withDetail('failed', 'processed');\n    } else if (fsItem.item.type === 'file') {\n      if (fsItem.item.extension === '.json') {\n        return fsItem.item\n          .getContents(JsonConverters.jsonValue)\n          .onSuccess((json) => {\n            const jsonItem: IImportableJson = {\n              type: 'json',\n              json,\n              context\n            };\n            return succeed([jsonItem]);\n          })\n          .withDetail('failed', 'processed');\n      }\n    }\n    /* c8 ignore next 2 - defense in depth near impossible to reproduce */\n    return succeedWithDetail([], 'skipped');\n  }\n\n  /**\n   * Gets an {@link Import.FsItem | FsItem} from an {@link Import.IImportable | importable}.\n   * @param item - The importable to convert.\n   * @returns `Success` containing the `FsItem` if successful, `Failure` with an error message if not.\n   */\n  protected _getFileTreeItemFromImportable(item: IImportable): DetailedResult<FsItem, FsItemResultDetail> {\n    if (item.type === 'fsItem') {\n      if ('item' in item && item.item instanceof FsItem) {\n        return succeedWithDetail(item.item, 'succeeded');\n      }\n      return failWithDetail(`malformed fsItem importable does not contain a valid item`, 'failed');\n    }\n    return failWithDetail(`${item.type}: invalid importable type for an FsItemImporter`, 'skipped');\n  }\n}\n"]}

package/lib/packlets/import/importers/importer.d.ts

@@ -0,0 +1,31 @@
+import { DetailedResult } from '@fgv/ts-utils';
+import { IImportable } from '../importable';
+import { ResourceManager } from '../../resources';
+/**
+ * Possible results of an import operation.
+ * @public
+ */
+export type ImporterResultDetail = 'consumed' | 'processed' | 'skipped' | 'failed';
+/**
+ * Generic interface for an importer than accepts a typed
+ * {@link Import.IImportable | importable} item, extracts any resources
+ * or candidates from it, and returns an optional list of
+ * additional importable items derived from the original.
+ * @public
+ */
+export interface IImporter {
+    /**
+     * The types of {@link Import.Importable | importable} items that this importer can process.
+     */
+    readonly types: ReadonlyArray<string>;
+    /**
+     * Imports an item, extracting any resources or candidates from it and returns an optional
+     * list of additional importable items derived from it.
+     * @param item - The {@link Import.IImportable | importable} item to import.
+     * @param manager - The {@link Resources.ResourceManager | resource manager} to use for the import.
+     * @returns `Success` with a list of additional importable items derived from the original, or
+     * `Failure` with an error message and a {@link Import.Importers.ImporterResultDetail | result detail}.
+     */
+    import(item: IImportable, manager: ResourceManager): DetailedResult<IImportable[], ImporterResultDetail>;
+}
+//# sourceMappingURL=importer.d.ts.map

package/lib/packlets/import/importers/importer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"importer.d.ts","sourceRoot":"","sources":["../../../../src/packlets/import/importers/importer.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAElD;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,UAAU,GAAG,WAAW,GAAG,SAAS,GAAG,QAAQ,CAAC;AAEnF;;;;;;GAMG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IAEtC;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,eAAe,GAAG,cAAc,CAAC,WAAW,EAAE,EAAE,oBAAoB,CAAC,CAAC;CAC1G"}

package/lib/packlets/import/importers/importer.js

@@ -0,0 +1,24 @@
+"use strict";
+/*
+ * Copyright (c) 2025 Erik Fortune
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=importer.js.map

package/lib/packlets/import/importers/importer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"importer.js","sourceRoot":"","sources":["../../../../src/packlets/import/importers/importer.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG","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 } from '@fgv/ts-utils';\nimport { IImportable } from '../importable';\nimport { ResourceManager } from '../../resources';\n\n/**\n * Possible results of an import operation.\n * @public\n */\nexport type ImporterResultDetail = 'consumed' | 'processed' | 'skipped' | 'failed';\n\n/**\n * Generic interface for an importer than accepts a typed\n * {@link Import.IImportable | importable} item, extracts any resources\n * or candidates from it, and returns an optional list of\n * additional importable items derived from the original.\n * @public\n */\nexport interface IImporter {\n  /**\n   * The types of {@link Import.Importable | importable} items that this importer can process.\n   */\n  readonly types: ReadonlyArray<string>;\n\n  /**\n   * Imports an item, extracting any resources or candidates from it and returns an optional\n   * list of additional importable items derived from it.\n   * @param item - The {@link Import.IImportable | importable} item to import.\n   * @param manager - The {@link Resources.ResourceManager | resource manager} to use for the import.\n   * @returns `Success` with a list of additional importable items derived from the original, or\n   * `Failure` with an error message and a {@link Import.Importers.ImporterResultDetail | result detail}.\n   */\n  import(item: IImportable, manager: ResourceManager): DetailedResult<IImportable[], ImporterResultDetail>;\n}\n"]}

package/lib/packlets/import/importers/index.d.ts

@@ -0,0 +1,6 @@
+export * from './importer';
+export * from './collectionImporter';
+export * from './fsItemImporter';
+export * from './jsonImporter';
+export * from './pathImporter';
+//# sourceMappingURL=index.d.ts.map

package/lib/packlets/import/importers/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/packlets/import/importers/index.ts"],"names":[],"mappings":"AAsBA,cAAc,YAAY,CAAC;AAC3B,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC"}

package/lib/packlets/import/importers/index.js

@@ -0,0 +1,43 @@
+"use strict";
+/*
+ * Copyright (c) 2025 Erik Fortune
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./importer"), exports);
+__exportStar(require("./collectionImporter"), exports);
+__exportStar(require("./fsItemImporter"), exports);
+__exportStar(require("./jsonImporter"), exports);
+__exportStar(require("./pathImporter"), exports);
+//# sourceMappingURL=index.js.map

package/lib/packlets/import/importers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/packlets/import/importers/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;AAEH,6CAA2B;AAC3B,uDAAqC;AACrC,mDAAiC;AACjC,iDAA+B;AAC/B,iDAA+B","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\nexport * from './importer';\nexport * from './collectionImporter';\nexport * from './fsItemImporter';\nexport * from './jsonImporter';\nexport * from './pathImporter';\n"]}

package/lib/packlets/import/importers/jsonImporter.d.ts

@@ -0,0 +1,32 @@
+import { DetailedResult, Result } from '@fgv/ts-utils';
+import { IImporter, ImporterResultDetail } from './importer';
+import { ResourceManager } from '../../resources';
+import { IImportable } from '../importable';
+/**
+ * {@link Import.Importers.IImporter | Importer} implementation which imports resources from a JSON object.
+ * @public
+ */
+export declare class JsonImporter implements IImporter {
+    /**
+     * {@inheritdoc Import.Importers.IImporter.types}
+     */
+    readonly types: ReadonlyArray<string>;
+    /**
+     * Protected {@link Import.Importers.JsonImporter | JsonImporter} constructor for derived classes.
+     */
+    protected constructor();
+    /**
+     * Creates a new {@link Import.Importers.JsonImporter | JsonImporter} instance.
+     * @returns `Success` with the new {@link Import.Importers.JsonImporter | JsonImporter} if successful,
+     * `Failure` otherwise.
+     */
+    static create(): Result<JsonImporter>;
+    /**
+     * {@inheritdoc Import.Importers.IImporter.import}
+     */
+    import(item: IImportable, manager: ResourceManager): DetailedResult<IImportable[], ImporterResultDetail>;
+    private _tryImportResourceCollection;
+    private _tryImportResourceTree;
+    private _tryImportResource;
+}
+//# sourceMappingURL=jsonImporter.d.ts.map

package/lib/packlets/import/importers/jsonImporter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsonImporter.d.ts","sourceRoot":"","sources":["../../../../src/packlets/import/importers/jsonImporter.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAiB,cAAc,EAAkB,MAAM,EAAW,MAAM,eAAe,CAAC;AAE/F,OAAO,EAAE,SAAS,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAC7D,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,WAAW,EAA6C,MAAM,eAAe,CAAC;AAGvF;;;GAGG;AACH,qBAAa,YAAa,YAAW,SAAS;IAC5C;;OAEG;IACH,SAAgB,KAAK,EAAE,aAAa,CAAC,MAAM,CAAC,CAAY;IAExD;;OAEG;IACH,SAAS;IAET;;;;OAIG;WACW,MAAM,IAAI,MAAM,CAAC,YAAY,CAAC;IAI5C;;OAEG;IACI,MAAM,CACX,IAAI,EAAE,WAAW,EACjB,OAAO,EAAE,eAAe,GACvB,cAAc,CAAC,WAAW,EAAE,EAAE,oBAAoB,CAAC;IAWtD,OAAO,CAAC,4BAA4B;IAepC,OAAO,CAAC,sBAAsB;IAa9B,OAAO,CAAC,kBAAkB;CAkB3B"}

package/lib/packlets/import/importers/jsonImporter.js

@@ -0,0 +1,140 @@
+"use strict";
+/*
+ * Copyright (c) 2025 Erik Fortune
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JsonImporter = void 0;
+const ts_utils_1 = require("@fgv/ts-utils");
+const ts_json_base_1 = require("@fgv/ts-json-base");
+const importable_1 = require("../importable");
+const ResourceJson = __importStar(require("../../resource-json"));
+/**
+ * {@link Import.Importers.IImporter | Importer} implementation which imports resources from a JSON object.
+ * @public
+ */
+class JsonImporter {
+    /**
+     * Protected {@link Import.Importers.JsonImporter | JsonImporter} constructor for derived classes.
+     */
+    constructor() {
+        /**
+         * {@inheritdoc Import.Importers.IImporter.types}
+         */
+        this.types = ['json'];
+    }
+    /**
+     * Creates a new {@link Import.Importers.JsonImporter | JsonImporter} instance.
+     * @returns `Success` with the new {@link Import.Importers.JsonImporter | JsonImporter} if successful,
+     * `Failure` otherwise.
+     */
+    static create() {
+        return (0, ts_utils_1.captureResult)(() => new JsonImporter());
+    }
+    /**
+     * {@inheritdoc Import.Importers.IImporter.import}
+     */
+    import(item, manager) {
+        var _a, _b;
+        if (!(0, importable_1.isImportable)(item) || item.type !== 'json') {
+            /* c8 ignore next 1 - defense in depth */
+            const name = (_b = (_a = item.context) === null || _a === void 0 ? void 0 : _a.baseId) !== null && _b !== void 0 ? _b : 'unknown';
+            return (0, ts_utils_1.failWithDetail)(`${name}: not a valid JSON importable (${item.type})`, 'skipped');
+        }
+        return this._tryImportResourceCollection(item)
+            .onFailure(() => this._tryImportResourceTree(item))
+            .onFailure(() => this._tryImportResource(item, manager));
+    }
+    _tryImportResourceCollection(item) {
+        return ResourceJson.ResourceDeclCollection.create(item.json)
+            .onSuccess((collection) => {
+            const importable = {
+                type: 'resourceCollection',
+                collection,
+                context: item.context
+            };
+            return (0, ts_utils_1.succeed)([importable]);
+        })
+            .withDetail('skipped', 'consumed');
+    }
+    _tryImportResourceTree(item) {
+        return ResourceJson.ResourceDeclTree.create(item.json)
+            .onSuccess((tree) => {
+            const importable = {
+                type: 'resourceTree',
+                tree,
+                context: item.context
+            };
+            return (0, ts_utils_1.succeed)([importable]);
+        })
+            .withDetail('skipped', 'consumed');
+    }
+    _tryImportResource(item, manager) {
+        return ts_json_base_1.Converters.jsonObject
+            .convert(item.json)
+            .onSuccess((json) => {
+            var _a, _b, _c;
+            /* c8 ignore next 2 - defense in depth */
+            const id = (_b = (_a = item.context) === null || _a === void 0 ? void 0 : _a.baseId) !== null && _b !== void 0 ? _b : '';
+            const conditions = (_c = item.context) === null || _c === void 0 ? void 0 : _c.conditions;
+            const candidate = { id, conditions, json };
+            return manager.addLooseCandidate(candidate);
+        })
+            .onSuccess(() => {
+            return (0, ts_utils_1.succeed)([]);
+        })
+            .withDetail('failed', 'consumed');
+    }
+}
+exports.JsonImporter = JsonImporter;
+//# sourceMappingURL=jsonImporter.js.map

package/lib/packlets/import/importers/jsonImporter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsonImporter.js","sourceRoot":"","sources":["../../../../src/packlets/import/importers/jsonImporter.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,4CAA+F;AAC/F,oDAAiE;AAGjE,8CAAuF;AACvF,kEAAoD;AAEpD;;;GAGG;AACH,MAAa,YAAY;IAMvB;;OAEG;IACH;QARA;;WAEG;QACa,UAAK,GAA0B,CAAC,MAAM,CAAC,CAAC;IAK/B,CAAC;IAE1B;;;;OAIG;IACI,MAAM,CAAC,MAAM;QAClB,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,YAAY,EAAE,CAAC,CAAC;IACjD,CAAC;IAED;;OAEG;IACI,MAAM,CACX,IAAiB,EACjB,OAAwB;;QAExB,IAAI,CAAC,IAAA,yBAAY,EAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;YAChD,yCAAyC;YACzC,MAAM,IAAI,GAAG,MAAA,MAAA,IAAI,CAAC,OAAO,0CAAE,MAAM,mCAAI,SAAS,CAAC;YAC/C,OAAO,IAAA,yBAAc,EAAC,GAAG,IAAI,kCAAkC,IAAI,CAAC,IAAI,GAAG,EAAE,SAAS,CAAC,CAAC;QAC1F,CAAC;QACD,OAAO,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC;aAC3C,SAAS,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;aAClD,SAAS,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IAC7D,CAAC;IAEO,4BAA4B,CAClC,IAAqB;QAErB,OAAO,YAAY,CAAC,sBAAsB,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;aACzD,SAAS,CAAC,CAAC,UAAU,EAAE,EAAE;YACxB,MAAM,UAAU,GAAe;gBAC7B,IAAI,EAAE,oBAAoB;gBAC1B,UAAU;gBACV,OAAO,EAAE,IAAI,CAAC,OAAO;aACtB,CAAC;YACF,OAAO,IAAA,kBAAO,EAAC,CAAC,UAAU,CAAC,CAAC,CAAC;QAC/B,CAAC,CAAC;aACD,UAAU,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IACvC,CAAC;IAEO,sBAAsB,CAAC,IAAqB;QAClD,OAAO,YAAY,CAAC,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;aACnD,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE;YAClB,MAAM,UAAU,GAAe;gBAC7B,IAAI,EAAE,cAAc;gBACpB,IAAI;gBACJ,OAAO,EAAE,IAAI,CAAC,OAAO;aACtB,CAAC;YACF,OAAO,IAAA,kBAAO,EAAC,CAAC,UAAU,CAAC,CAAC,CAAC;QAC/B,CAAC,CAAC;aACD,UAAU,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IACvC,CAAC;IAEO,kBAAkB,CACxB,IAAqB,EACrB,OAAwB;QAExB,OAAO,yBAAc,CAAC,UAAU;aAC7B,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;aAClB,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE;;YAClB,yCAAyC;YACzC,MAAM,EAAE,GAAG,MAAA,MAAA,IAAI,CAAC,OAAO,0CAAE,MAAM,mCAAI,EAAE,CAAC;YACtC,MAAM,UAAU,GAAG,MAAA,IAAI,CAAC,OAAO,0CAAE,UAAU,CAAC;YAC5C,MAAM,SAAS,GAAkD,EAAE,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;YAC1F,OAAO,OAAO,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC;QAC9C,CAAC,CAAC;aACD,SAAS,CAAC,GAAG,EAAE;YACd,OAAO,IAAA,kBAAO,EAAC,EAAE,CAAC,CAAC;QACrB,CAAC,CAAC;aACD,UAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IACtC,CAAC;CACF;AAnFD,oCAmFC","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, failWithDetail, Result, succeed } from '@fgv/ts-utils';\nimport { Converters as JsonConverters } from '@fgv/ts-json-base';\nimport { IImporter, ImporterResultDetail } from './importer';\nimport { ResourceManager } from '../../resources';\nimport { IImportable, IImportableJson, Importable, isImportable } from '../importable';\nimport * as ResourceJson from '../../resource-json';\n\n/**\n * {@link Import.Importers.IImporter | Importer} implementation which imports resources from a JSON object.\n * @public\n */\nexport class JsonImporter implements IImporter {\n  /**\n   * {@inheritdoc Import.Importers.IImporter.types}\n   */\n  public readonly types: ReadonlyArray<string> = ['json'];\n\n  /**\n   * Protected {@link Import.Importers.JsonImporter | JsonImporter} constructor for derived classes.\n   */\n  protected constructor() {}\n\n  /**\n   * Creates a new {@link Import.Importers.JsonImporter | JsonImporter} instance.\n   * @returns `Success` with the new {@link Import.Importers.JsonImporter | JsonImporter} if successful,\n   * `Failure` otherwise.\n   */\n  public static create(): Result<JsonImporter> {\n    return captureResult(() => new JsonImporter());\n  }\n\n  /**\n   * {@inheritdoc Import.Importers.IImporter.import}\n   */\n  public import(\n    item: IImportable,\n    manager: ResourceManager\n  ): DetailedResult<IImportable[], ImporterResultDetail> {\n    if (!isImportable(item) || item.type !== 'json') {\n      /* c8 ignore next 1 - defense in depth */\n      const name = item.context?.baseId ?? 'unknown';\n      return failWithDetail(`${name}: not a valid JSON importable (${item.type})`, 'skipped');\n    }\n    return this._tryImportResourceCollection(item)\n      .onFailure(() => this._tryImportResourceTree(item))\n      .onFailure(() => this._tryImportResource(item, manager));\n  }\n\n  private _tryImportResourceCollection(\n    item: IImportableJson\n  ): DetailedResult<IImportable[], ImporterResultDetail> {\n    return ResourceJson.ResourceDeclCollection.create(item.json)\n      .onSuccess((collection) => {\n        const importable: Importable = {\n          type: 'resourceCollection',\n          collection,\n          context: item.context\n        };\n        return succeed([importable]);\n      })\n      .withDetail('skipped', 'consumed');\n  }\n\n  private _tryImportResourceTree(item: IImportableJson): DetailedResult<IImportable[], ImporterResultDetail> {\n    return ResourceJson.ResourceDeclTree.create(item.json)\n      .onSuccess((tree) => {\n        const importable: Importable = {\n          type: 'resourceTree',\n          tree,\n          context: item.context\n        };\n        return succeed([importable]);\n      })\n      .withDetail('skipped', 'consumed');\n  }\n\n  private _tryImportResource(\n    item: IImportableJson,\n    manager: ResourceManager\n  ): DetailedResult<IImportable[], ImporterResultDetail> {\n    return JsonConverters.jsonObject\n      .convert(item.json)\n      .onSuccess((json) => {\n        /* c8 ignore next 2 - defense in depth */\n        const id = item.context?.baseId ?? '';\n        const conditions = item.context?.conditions;\n        const candidate: ResourceJson.Json.ILooseResourceCandidateDecl = { id, conditions, json };\n        return manager.addLooseCandidate(candidate);\n      })\n      .onSuccess(() => {\n        return succeed([]);\n      })\n      .withDetail('failed', 'consumed');\n  }\n}\n"]}

package/lib/packlets/import/importers/pathImporter.d.ts

@@ -0,0 +1,61 @@
+import { DetailedResult, Result, FileTree } from '@fgv/ts-utils';
+import { ResourceManager } from '../../resources';
+import { IImportable } from '../importable';
+import { IImporter, ImporterResultDetail } from './importer';
+import { IReadOnlyQualifierCollector } from '../../qualifiers';
+import { FsItem, FsItemResultDetail } from '../fsItem';
+/**
+ * Parameters for creating a {@link Import.Importers.PathImporter | PathImporter}.
+ * @public
+ */
+export interface IPathImporterCreateParams {
+    qualifiers: IReadOnlyQualifierCollector;
+    tree?: FileTree.FileTree;
+    ignoreFileTypes?: string[];
+}
+/**
+ * {@link Import.Importers.IImporter | Importer} implementation which imports resources from a `FileTree`
+ * given a path.
+ * @public
+ */
+export declare class PathImporter implements IImporter {
+    /**
+     * The {@link Qualifiers.IReadOnlyQualifierCollector | qualifier collector} to use for this importer.
+     */
+    readonly qualifiers: IReadOnlyQualifierCollector;
+    /**
+     * The `FileTree` from which resources will be imported.
+     */
+    readonly tree: FileTree.FileTree;
+    /**
+     * The types of {@link Import.IImportable | importables} that this importer can handle.
+     */
+    readonly types: ReadonlyArray<string>;
+    /**
+     * The types of files to ignore when importing.  Any file not ignored is converted
+     * to an {@link Import.IImportableFsItem | IImportableFsItem}.
+     */
+    readonly ignoreFileTypes: string[];
+    /**
+     * Protected constructor for the {@link Import.Importers.PathImporter | PathImporter}.
+     * @param params - Parameters for creating the {@link Import.Importers.PathImporter | PathImporter}.
+     */
+    protected constructor(params: IPathImporterCreateParams);
+    /**
+     * Creates a new {@link Import.Importers.PathImporter | PathImporter}.
+     * @param params - Parameters for creating the {@link Import.Importers.PathImporter | dirPathImporter}.
+     * @returns `Success` with the new `PathImporter` if successful, `Failure` with an error message if not.
+     */
+    static create(params: IPathImporterCreateParams): Result<PathImporter>;
+    /**
+     * {@inheritdoc Import.Importers.IImporter.import}
+     */
+    import(item: IImportable, __manager: ResourceManager): DetailedResult<IImportable[], ImporterResultDetail>;
+    /**
+     * Gets an {@link Import.FsItem | FsItem} from an {@link Import.IImportable | importable}.
+     * @param item - The importable to convert.
+     * @returns `Success` containing the `FsItem` if successful, `Failure` with an error message if not.
+     */
+    protected _getFileTreeItemFromImportable(item: IImportable): DetailedResult<FsItem, FsItemResultDetail>;
+}
+//# sourceMappingURL=pathImporter.d.ts.map

package/lib/packlets/import/importers/pathImporter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pathImporter.d.ts","sourceRoot":"","sources":["../../../../src/packlets/import/importers/pathImporter.ts"],"names":[],"mappings":"AAsBA,OAAO,EAEL,cAAc,EAEd,MAAM,EAEN,QAAQ,EACT,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,SAAS,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAC7D,OAAO,EAAE,2BAA2B,EAAE,MAAM,kBAAkB,CAAC;AAC/D,OAAO,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAEvD;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,UAAU,EAAE,2BAA2B,CAAC;IACxC,IAAI,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC;IACzB,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;CAC5B;AAED;;;;GAIG;AACH,qBAAa,YAAa,YAAW,SAAS;IAC5C;;OAEG;IACH,SAAgB,UAAU,EAAE,2BAA2B,CAAC;IAExD;;OAEG;IACH,SAAgB,IAAI,EAAE,QAAQ,CAAC,QAAQ,CAAC;IAExC;;OAEG;IACH,SAAgB,KAAK,EAAE,aAAa,CAAC,MAAM,CAAC,CAAY;IAExD;;;OAGG;IACH,SAAgB,eAAe,EAAE,MAAM,EAAE,CAAC;IAE1C;;;OAGG;IACH,SAAS,aAAa,MAAM,EAAE,yBAAyB;IAMvD;;;;OAIG;WACW,MAAM,CAAC,MAAM,EAAE,yBAAyB,GAAG,MAAM,CAAC,YAAY,CAAC;IAI7E;;OAEG;IACI,MAAM,CACX,IAAI,EAAE,WAAW,EACjB,SAAS,EAAE,eAAe,GACzB,cAAc,CAAC,WAAW,EAAE,EAAE,oBAAoB,CAAC;IAqBtD;;;;OAIG;IACH,SAAS,CAAC,8BAA8B,CAAC,IAAI,EAAE,WAAW,GAAG,cAAc,CAAC,MAAM,EAAE,kBAAkB,CAAC;CASxG"}