doc-detective-common 3.6.1-dev.1 → 3.6.1-dev.2

package/.c8rc.json

@@ -1,7 +1,7 @@
 {
   "all": true,
-  "include": ["src/**/*.js"],
-  "exclude": ["src/schemas/dereferenceSchemas.js"],
+  "include": ["dist/**/*.js"],
+  "exclude": ["dist/types/generated/**/*.js", "dist/**/*.d.ts"],
   "reporter": ["text", "lcov", "json", "json-summary"],
   "report-dir": "coverage",
   "check-coverage": false

package/README.md

@@ -30,6 +30,36 @@ This package exports the following components:
 - `readFile` - File reading utilities
 - `transformToSchemaKey` - Schema key transformation
 
+### TypeScript Support
+
+Full TypeScript support with exported types:
+
+```typescript
+import { 
+  validate, 
+  ValidateOptions, 
+  ValidateResult,
+  resolvePaths,
+  ResolvePathsOptions
+} from 'doc-detective-common';
+```
+
+**Documentation:**
+- [TypeScript Migration Guide](./docs/typescript-migration.md) - Complete guide for TypeScript users
+- [TypeScript Examples](./docs/typescript-examples.md) - Runnable code examples
+
+### JavaScript Usage
+
+Works seamlessly with JavaScript (CommonJS or ESM):
+
+```javascript
+// CommonJS
+const { validate, schemas } = require('doc-detective-common');
+
+// ESM
+import { validate, schemas } from 'doc-detective-common';
+```
+
 ## 🧪 Development
 
 ```bash
@@ -45,4 +75,4 @@ npm run build
 
 ## 📄 License
 
-AGPL-3.0-only
+AGPL-3.0-only

package/dist/files.d.ts

@@ -0,0 +1,16 @@
+export interface ReadFileOptions {
+    fileURLOrPath: string;
+}
+/**
+ * Reads and parses content from a remote URL or local file path, supporting JSON and YAML formats.
+ *
+ * Attempts to parse the file content as JSON first, then YAML. If both parsing attempts fail, returns the raw content as a string. Returns `null` if the file cannot be read.
+ *
+ * @param options - Options object
+ * @param options.fileURLOrPath - The URL or local file path to read.
+ * @returns Parsed object for JSON or YAML files, raw string for other formats, or `null` if reading fails.
+ *
+ * @throws {Error} If {@link fileURLOrPath} is missing, not a string, or is an empty string.
+ */
+export declare function readFile({ fileURLOrPath }: ReadFileOptions): Promise<unknown | string | null>;
+//# sourceMappingURL=files.d.ts.map

package/dist/files.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"files.d.ts","sourceRoot":"","sources":["../src/files.ts"],"names":[],"mappings":"AAKA,MAAM,WAAW,eAAe;IAC9B,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,QAAQ,CAAC,EAAE,aAAa,EAAE,EAAE,eAAe,GAAG,OAAO,CAAC,OAAO,GAAG,MAAM,GAAG,IAAI,CAAC,CAiEnG"}

package/dist/files.js

@@ -0,0 +1,123 @@
+"use strict";
+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;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readFile = readFile;
+const fs = __importStar(require("fs"));
+const YAML = __importStar(require("yaml"));
+const axios_1 = __importDefault(require("axios"));
+const url_1 = require("url");
+/**
+ * Reads and parses content from a remote URL or local file path, supporting JSON and YAML formats.
+ *
+ * Attempts to parse the file content as JSON first, then YAML. If both parsing attempts fail, returns the raw content as a string. Returns `null` if the file cannot be read.
+ *
+ * @param options - Options object
+ * @param options.fileURLOrPath - The URL or local file path to read.
+ * @returns Parsed object for JSON or YAML files, raw string for other formats, or `null` if reading fails.
+ *
+ * @throws {Error} If {@link fileURLOrPath} is missing, not a string, or is an empty string.
+ */
+async function readFile({ fileURLOrPath }) {
+    if (!fileURLOrPath) {
+        throw new Error("fileURLOrPath is required");
+    }
+    if (typeof fileURLOrPath !== "string") {
+        throw new Error("fileURLOrPath must be a string");
+    }
+    if (fileURLOrPath.trim() === "") {
+        throw new Error("fileURLOrPath cannot be an empty string");
+    }
+    let content;
+    let isRemote = false;
+    try {
+        const parsedURL = new url_1.URL(fileURLOrPath);
+        isRemote =
+            parsedURL.protocol === "http:" || parsedURL.protocol === "https:";
+    }
+    catch (error) {
+        // Not a valid URL, assume local file path
+    }
+    if (isRemote) {
+        try {
+            const response = await axios_1.default.get(fileURLOrPath);
+            content = response.data;
+        }
+        catch (error) {
+            console.warn(`Error reading remote file from ${fileURLOrPath}: ${error.message}`);
+            return null;
+        }
+    }
+    else {
+        try {
+            content = await fs.promises.readFile(fileURLOrPath, "utf8");
+        }
+        catch (error) {
+            if (error.code === "ENOENT") {
+                console.warn(`File not found: ${fileURLOrPath}`);
+            }
+            else {
+                console.warn(`Error reading file: ${error.message}`);
+            }
+            return null;
+        }
+    }
+    // Parse based on file extension
+    const ext = fileURLOrPath.split('.').pop()?.toLowerCase();
+    if (ext === "json") {
+        try {
+            return JSON.parse(content);
+        }
+        catch (error) {
+            console.warn(`Failed to parse JSON: ${error.message}`);
+            return content;
+        }
+    }
+    else if (ext === "yaml" || ext === "yml") {
+        try {
+            return YAML.parse(content);
+        }
+        catch (error) {
+            console.warn(`Failed to parse YAML: ${error.message}`);
+            return content;
+        }
+    }
+    else {
+        return content;
+    }
+}
+//# sourceMappingURL=files.js.map

package/dist/files.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"files.js","sourceRoot":"","sources":["../src/files.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoBA,4BAiEC;AArFD,uCAAyB;AACzB,2CAA6B;AAC7B,kDAA0B;AAC1B,6BAA0B;AAM1B;;;;;;;;;;GAUG;AACI,KAAK,UAAU,QAAQ,CAAC,EAAE,aAAa,EAAmB;IAC/D,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC/C,CAAC;IACD,IAAI,OAAO,aAAa,KAAK,QAAQ,EAAE,CAAC;QACtC,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;IACpD,CAAC;IACD,IAAI,aAAa,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QAChC,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;IAC7D,CAAC;IAED,IAAI,OAAe,CAAC;IACpB,IAAI,QAAQ,GAAG,KAAK,CAAC;IAErB,IAAI,CAAC;QACH,MAAM,SAAS,GAAG,IAAI,SAAG,CAAC,aAAa,CAAC,CAAC;QACzC,QAAQ;YACN,SAAS,CAAC,QAAQ,KAAK,OAAO,IAAI,SAAS,CAAC,QAAQ,KAAK,QAAQ,CAAC;IACtE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,0CAA0C;IAC5C,CAAC;IAED,IAAI,QAAQ,EAAE,CAAC;QACb,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,eAAK,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;YAChD,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC;QAC1B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,IAAI,CACV,kCAAkC,aAAa,KAAM,KAAe,CAAC,OAAO,EAAE,CAC/E,CAAC;YACF,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;SAAM,CAAC;QACN,IAAI,CAAC;YACH,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;QAC9D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAK,KAA+B,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACvD,OAAO,CAAC,IAAI,CAAC,mBAAmB,aAAa,EAAE,CAAC,CAAC;YACnD,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,IAAI,CAAC,uBAAwB,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;YAClE,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,gCAAgC;IAChC,MAAM,GAAG,GAAG,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,WAAW,EAAE,CAAC;IAE1D,IAAI,GAAG,KAAK,MAAM,EAAE,CAAC;QACnB,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC7B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,IAAI,CAAC,yBAA0B,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;YAClE,OAAO,OAAO,CAAC;QACjB,CAAC;IACH,CAAC;SAAM,IAAI,GAAG,KAAK,MAAM,IAAI,GAAG,KAAK,KAAK,EAAE,CAAC;QAC3C,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC7B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,IAAI,CAAC,yBAA0B,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;YAClE,OAAO,OAAO,CAAC;QACjB,CAAC;IACH,CAAC;SAAM,CAAC;QACN,OAAO,OAAO,CAAC;IACjB,CAAC;AACH,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export { schemas, SchemaKey, Schema } from "./schemas";
+export { validate, transformToSchemaKey, ValidateOptions, ValidateResult, TransformOptions } from "./validate";
+export { resolvePaths, ResolvePathsOptions } from "./resolvePaths";
+export { readFile, ReadFileOptions } from "./files";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACvD,OAAO,EAAE,QAAQ,EAAE,oBAAoB,EAAE,eAAe,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAC/G,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AACnE,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC"}

package/dist/index.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readFile = exports.resolvePaths = exports.transformToSchemaKey = exports.validate = exports.schemas = void 0;
+var schemas_1 = require("./schemas");
+Object.defineProperty(exports, "schemas", { enumerable: true, get: function () { return schemas_1.schemas; } });
+var validate_1 = require("./validate");
+Object.defineProperty(exports, "validate", { enumerable: true, get: function () { return validate_1.validate; } });
+Object.defineProperty(exports, "transformToSchemaKey", { enumerable: true, get: function () { return validate_1.transformToSchemaKey; } });
+var resolvePaths_1 = require("./resolvePaths");
+Object.defineProperty(exports, "resolvePaths", { enumerable: true, get: function () { return resolvePaths_1.resolvePaths; } });
+var files_1 = require("./files");
+Object.defineProperty(exports, "readFile", { enumerable: true, get: function () { return files_1.readFile; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,qCAAuD;AAA9C,kGAAA,OAAO,OAAA;AAChB,uCAA+G;AAAtG,oGAAA,QAAQ,OAAA;AAAE,gHAAA,oBAAoB,OAAA;AACvC,+CAAmE;AAA1D,4GAAA,YAAY,OAAA;AACrB,iCAAoD;AAA3C,iGAAA,QAAQ,OAAA"}

package/dist/index.mjs

@@ -0,0 +1,4 @@
+// ESM wrapper for CommonJS output
+import cjsModule from './index.js';
+export const { schemas, validate, transformToSchemaKey, resolvePaths, readFile } = cjsModule;
+export default cjsModule;

package/dist/resolvePaths.d.ts

@@ -0,0 +1,28 @@
+type RelativePathBase = "file" | "cwd";
+type ObjectType = "config" | "spec";
+export interface ResolvePathsOptions {
+    config: {
+        relativePathBase: RelativePathBase;
+    };
+    object: Record<string, any>;
+    filePath: string;
+    nested?: boolean;
+    objectType?: ObjectType;
+}
+/**
+ * Convert recognized relative path properties in a config or spec object to absolute paths.
+ *
+ * Traverses the provided object (recursing into nested objects and arrays), resolving fields that represent filesystem paths according to the provided config.relativePathBase and reference filePath. On top-level calls the function infers whether the object is a config or spec via schema validation; for nested calls objectType must be provided.
+ *
+ * @param options - Options for path resolution.
+ * @param options.config - Configuration containing settings such as `relativePathBase`.
+ * @param options.object - The config or spec object whose path properties will be resolved.
+ * @param options.filePath - Reference file or directory used to resolve relative paths.
+ * @param options.nested - True when invoked recursively for nested objects.
+ * @param options.objectType - 'config' or 'spec'; required for nested invocations to select which properties to resolve.
+ * @returns The same object with applicable path properties converted to absolute paths.
+ * @throws {Error} If the top-level object matches neither config nor spec schema, or if `objectType` is missing for nested calls.
+ */
+export declare function resolvePaths({ config, object, filePath, nested, objectType, }: ResolvePathsOptions): Promise<Record<string, any>>;
+export {};
+//# sourceMappingURL=resolvePaths.d.ts.map

package/dist/resolvePaths.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolvePaths.d.ts","sourceRoot":"","sources":["../src/resolvePaths.ts"],"names":[],"mappings":"AAIA,KAAK,gBAAgB,GAAG,MAAM,GAAG,KAAK,CAAC;AACvC,KAAK,UAAU,GAAG,QAAQ,GAAG,MAAM,CAAC;AAEpC,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE;QAAE,gBAAgB,EAAE,gBAAgB,CAAA;KAAE,CAAC;IAC/C,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,YAAY,CAAC,EACjC,MAAM,EACN,MAAM,EACN,QAAQ,EACR,MAAc,EACd,UAAU,GACX,EAAE,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAqMpD"}

package/dist/resolvePaths.js

@@ -0,0 +1,236 @@
+"use strict";
+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.resolvePaths = resolvePaths;
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const validate_1 = require("./validate");
+/**
+ * Convert recognized relative path properties in a config or spec object to absolute paths.
+ *
+ * Traverses the provided object (recursing into nested objects and arrays), resolving fields that represent filesystem paths according to the provided config.relativePathBase and reference filePath. On top-level calls the function infers whether the object is a config or spec via schema validation; for nested calls objectType must be provided.
+ *
+ * @param options - Options for path resolution.
+ * @param options.config - Configuration containing settings such as `relativePathBase`.
+ * @param options.object - The config or spec object whose path properties will be resolved.
+ * @param options.filePath - Reference file or directory used to resolve relative paths.
+ * @param options.nested - True when invoked recursively for nested objects.
+ * @param options.objectType - 'config' or 'spec'; required for nested invocations to select which properties to resolve.
+ * @returns The same object with applicable path properties converted to absolute paths.
+ * @throws {Error} If the top-level object matches neither config nor spec schema, or if `objectType` is missing for nested calls.
+ */
+async function resolvePaths({ config, object, filePath, nested = false, objectType, }) {
+    // Config properties that contain paths
+    const configPaths = [
+        "input",
+        "output",
+        "loadVariables",
+        "setup",
+        "cleanup",
+        "configPath",
+        "beforeAny",
+        "afterAll",
+        "mediaDirectory",
+        "downloadDirectory",
+        "descriptionPath",
+        "path",
+    ];
+    // Spec properties that contain paths
+    const specPaths = [
+        "file",
+        "path",
+        "directory",
+        "before",
+        "after",
+        "loadVariables",
+        "setup",
+        "cleanup",
+        "savePath",
+        "saveDirectory",
+        "specPath",
+        "descriptionPath",
+        "workingDirectory",
+    ];
+    // Spec objects that are configurable by the user and shouldn't be resolved
+    const specNoResolve = [
+        "requestData",
+        "responseData",
+        "requestHeaders",
+        "responseHeaders",
+        "requestParams",
+        "responseParams",
+    ];
+    /**
+     * Resolves a relative path to an absolute path using a specified base type and reference file path.
+     *
+     * @param baseType - Indicates whether to resolve relative to the reference file's directory ("file") or the current working directory ("cwd").
+     * @param relativePath - The path to resolve, which may be relative or absolute.
+     * @param filePath - The reference file or directory path used for resolution.
+     * @returns The absolute path corresponding to {@link relativePath}.
+     *
+     * @remark If {@link relativePath} is already absolute, it is returned unchanged. If {@link filePath} does not exist, its extension is used to infer whether it is a file or directory.
+     * @remark HTTP and HTTPS URLs are returned unchanged without resolution.
+     */
+    function resolve(baseType, relativePath, filePath) {
+        // If the path is an http:// or https:// URL, or a heretto: URI, return it
+        if (relativePath.startsWith("https://") || relativePath.startsWith("http://") || relativePath.startsWith("heretto:")) {
+            return relativePath;
+        }
+        // If path is already absolute, return it
+        if (path.isAbsolute(relativePath)) {
+            return relativePath;
+        }
+        // Check if filePath exists and is a file
+        const fileExists = fs.existsSync(filePath);
+        const isFile = fileExists
+            ? fs.lstatSync(filePath).isFile()
+            : path.parse(filePath).ext !== "";
+        // Use directory of filePath if it's a file (or looks like one)
+        const basePath = isFile ? path.dirname(filePath) : filePath;
+        // Resolve the path based on the base type
+        return baseType === "file"
+            ? path.resolve(basePath, relativePath)
+            : path.resolve(relativePath);
+    }
+    const relativePathBase = config.relativePathBase;
+    let pathProperties;
+    if (!nested && !objectType) {
+        // Check if object matches the config schema
+        const validation = (0, validate_1.validate)({
+            schemaKey: "config_v3",
+            object: { ...object },
+        });
+        if (validation.valid) {
+            pathProperties = configPaths;
+            objectType = "config";
+        }
+        else {
+            // Check if object matches the spec schema
+            const validation = (0, validate_1.validate)({
+                schemaKey: "spec_v3",
+                object: { ...object },
+            });
+            if (validation.valid) {
+                pathProperties = specPaths;
+                objectType = "spec";
+            }
+            else {
+                throw new Error("Object isn't a valid config or spec.");
+            }
+        }
+    }
+    else if (nested && !objectType) {
+        // If the object is nested, the object type is required
+        throw new Error("Object type is required for nested objects.");
+    }
+    else if (objectType === "config") {
+        // If the object type is config, use configPaths
+        pathProperties = configPaths;
+    }
+    else if (objectType === "spec") {
+        // If the object type is spec, use specPaths
+        pathProperties = specPaths;
+    }
+    else {
+        throw new Error("Invalid objectType");
+    }
+    // If the object is null or empty, return it as is
+    if (object === null || Object.keys(object).length === 0) {
+        return object;
+    }
+    for (const property of Object.keys(object)) {
+        // If the property is an array, recursively call resolvePaths for each item in the array
+        if (Array.isArray(object[property])) {
+            for (let i = 0; i < object[property].length; i++) {
+                const item = object[property][i];
+                // If the item is an object, recursively call resolvePaths to resolve paths within the object
+                if (typeof item === "object") {
+                    await resolvePaths({
+                        config: config,
+                        object: item,
+                        filePath: filePath,
+                        nested: true,
+                        objectType: objectType,
+                    });
+                }
+                else if (typeof item === "string" &&
+                    pathProperties.includes(property)) {
+                    // Resolve the string path and write it back into the array
+                    const resolved = property === "path" &&
+                        object.directory &&
+                        path.isAbsolute(object.directory)
+                        ? resolve(relativePathBase, item, object.directory)
+                        : resolve(relativePathBase, item, filePath);
+                    object[property][i] = resolved;
+                }
+            }
+        }
+        // If the property is an object, recursively call resolvePaths to resolve paths within the object
+        else if (typeof object[property] === "object" &&
+            ((objectType === "spec" && !specNoResolve.includes(property)) ||
+                objectType === "config")) {
+            // If the property is an object, recursively call resolvePaths to resolve paths within the object
+            object[property] = await resolvePaths({
+                config: config,
+                object: object[property],
+                filePath: filePath,
+                nested: true,
+                objectType: objectType,
+            });
+        }
+        else if (typeof object[property] === "string") {
+            // If the property begins with "https://", "http://", or "heretto:", skip it
+            if (object[property].startsWith("https://") ||
+                object[property].startsWith("http://") ||
+                object[property].startsWith("heretto:")) {
+                continue;
+            }
+            // Check if it matches any of the path properties and resolve it if it does
+            if (pathProperties.includes(property)) {
+                if (property === "path" && object.directory) {
+                    const directory = path.isAbsolute(object.directory)
+                        ? object.directory
+                        : resolve(relativePathBase, object.directory, filePath);
+                    object[property] = resolve(relativePathBase, object[property], directory);
+                }
+                else {
+                    object[property] = resolve(relativePathBase, object[property], filePath);
+                }
+            }
+        }
+    }
+    return object;
+}
+//# sourceMappingURL=resolvePaths.js.map

package/dist/resolvePaths.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolvePaths.js","sourceRoot":"","sources":["../src/resolvePaths.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6BA,oCA2MC;AAxOD,uCAAyB;AACzB,2CAA6B;AAC7B,yCAAsC;AAatC;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,YAAY,CAAC,EACjC,MAAM,EACN,MAAM,EACN,QAAQ,EACR,MAAM,GAAG,KAAK,EACd,UAAU,GACU;IACpB,uCAAuC;IACvC,MAAM,WAAW,GAAG;QAClB,OAAO;QACP,QAAQ;QACR,eAAe;QACf,OAAO;QACP,SAAS;QACT,YAAY;QACZ,WAAW;QACX,UAAU;QACV,gBAAgB;QAChB,mBAAmB;QACnB,iBAAiB;QACjB,MAAM;KACP,CAAC;IACF,qCAAqC;IACrC,MAAM,SAAS,GAAG;QAChB,MAAM;QACN,MAAM;QACN,WAAW;QACX,QAAQ;QACR,OAAO;QACP,eAAe;QACf,OAAO;QACP,SAAS;QACT,UAAU;QACV,eAAe;QACf,UAAU;QACV,iBAAiB;QACjB,kBAAkB;KACnB,CAAC;IACF,2EAA2E;IAC3E,MAAM,aAAa,GAAG;QACpB,aAAa;QACb,cAAc;QACd,gBAAgB;QAChB,iBAAiB;QACjB,eAAe;QACf,gBAAgB;KACjB,CAAC;IAEF;;;;;;;;;;OAUG;IACH,SAAS,OAAO,CAAC,QAA0B,EAAE,YAAoB,EAAE,QAAgB;QACjF,0EAA0E;QAC1E,IAAI,YAAY,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,YAAY,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,YAAY,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;YACrH,OAAO,YAAY,CAAC;QACtB,CAAC;QAED,yCAAyC;QACzC,IAAI,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;YAClC,OAAO,YAAY,CAAC;QACtB,CAAC;QAED,yCAAyC;QACzC,MAAM,UAAU,GAAG,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAC3C,MAAM,MAAM,GAAG,UAAU;YACvB,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,MAAM,EAAE;YACjC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,GAAG,KAAK,EAAE,CAAC;QAEpC,+DAA+D;QAC/D,MAAM,QAAQ,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;QAE5D,0CAA0C;QAC1C,OAAO,QAAQ,KAAK,MAAM;YACxB,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,YAAY,CAAC;YACtC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IACjC,CAAC;IAED,MAAM,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,CAAC;IAEjD,IAAI,cAAwB,CAAC;IAC7B,IAAI,CAAC,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;QAC3B,4CAA4C;QAC5C,MAAM,UAAU,GAAG,IAAA,mBAAQ,EAAC;YAC1B,SAAS,EAAE,WAAW;YACtB,MAAM,EAAE,EAAE,GAAG,MAAM,EAAE;SACtB,CAAC,CAAC;QACH,IAAI,UAAU,CAAC,KAAK,EAAE,CAAC;YACrB,cAAc,GAAG,WAAW,CAAC;YAC7B,UAAU,GAAG,QAAQ,CAAC;QACxB,CAAC;aAAM,CAAC;YACN,0CAA0C;YAC1C,MAAM,UAAU,GAAG,IAAA,mBAAQ,EAAC;gBAC1B,SAAS,EAAE,SAAS;gBACpB,MAAM,EAAE,EAAE,GAAG,MAAM,EAAE;aACtB,CAAC,CAAC;YACH,IAAI,UAAU,CAAC,KAAK,EAAE,CAAC;gBACrB,cAAc,GAAG,SAAS,CAAC;gBAC3B,UAAU,GAAG,MAAM,CAAC;YACtB,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;YAC1D,CAAC;QACH,CAAC;IACH,CAAC;SAAM,IAAI,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;QACjC,uDAAuD;QACvD,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;IACjE,CAAC;SAAM,IAAI,UAAU,KAAK,QAAQ,EAAE,CAAC;QACnC,gDAAgD;QAChD,cAAc,GAAG,WAAW,CAAC;IAC/B,CAAC;SAAM,IAAI,UAAU,KAAK,MAAM,EAAE,CAAC;QACjC,4CAA4C;QAC5C,cAAc,GAAG,SAAS,CAAC;IAC7B,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;IACxC,CAAC;IAED,kDAAkD;IAClD,IAAI,MAAM,KAAK,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QAC3C,wFAAwF;QACxF,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;YACpC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACjD,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;gBAEjC,6FAA6F;gBAC7F,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;oBAC7B,MAAM,YAAY,CAAC;wBACjB,MAAM,EAAE,MAAM;wBACd,MAAM,EAAE,IAAI;wBACZ,QAAQ,EAAE,QAAQ;wBAClB,MAAM,EAAE,IAAI;wBACZ,UAAU,EAAE,UAAU;qBACvB,CAAC,CAAC;gBACL,CAAC;qBAAM,IACL,OAAO,IAAI,KAAK,QAAQ;oBACxB,cAAc,CAAC,QAAQ,CAAC,QAAQ,CAAC,EACjC,CAAC;oBACD,2DAA2D;oBAC3D,MAAM,QAAQ,GACZ,QAAQ,KAAK,MAAM;wBACnB,MAAM,CAAC,SAAS;wBAChB,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC;wBAC/B,CAAC,CAAC,OAAO,CAAC,gBAAgB,EAAE,IAAI,EAAE,MAAM,CAAC,SAAS,CAAC;wBACnD,CAAC,CAAC,OAAO,CAAC,gBAAgB,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;oBAChD,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC;gBACjC,CAAC;YACH,CAAC;QACH,CAAC;QACD,iGAAiG;aAC5F,IACH,OAAO,MAAM,CAAC,QAAQ,CAAC,KAAK,QAAQ;YACpC,CAAC,CAAC,UAAU,KAAK,MAAM,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;gBAC3D,UAAU,KAAK,QAAQ,CAAC,EAC1B,CAAC;YACD,iGAAiG;YACjG,MAAM,CAAC,QAAQ,CAAC,GAAG,MAAM,YAAY,CAAC;gBACpC,MAAM,EAAE,MAAM;gBACd,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC;gBACxB,QAAQ,EAAE,QAAQ;gBAClB,MAAM,EAAE,IAAI;gBACZ,UAAU,EAAE,UAAU;aACvB,CAAC,CAAC;QACL,CAAC;aAAM,IAAI,OAAO,MAAM,CAAC,QAAQ,CAAC,KAAK,QAAQ,EAAE,CAAC;YAChD,4EAA4E;YAC5E,IACE,MAAM,CAAC,QAAQ,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC;gBACvC,MAAM,CAAC,QAAQ,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC;gBACtC,MAAM,CAAC,QAAQ,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,EACvC,CAAC;gBACD,SAAS;YACX,CAAC;YACD,2EAA2E;YAC3E,IAAI,cAAc,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACtC,IAAI,QAAQ,KAAK,MAAM,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;oBAC5C,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC;wBACjD,CAAC,CAAC,MAAM,CAAC,SAAS;wBAClB,CAAC,CAAC,OAAO,CAAC,gBAAgB,EAAE,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;oBAC1D,MAAM,CAAC,QAAQ,CAAC,GAAG,OAAO,CACxB,gBAAgB,EAChB,MAAM,CAAC,QAAQ,CAAC,EAChB,SAAS,CACV,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACN,MAAM,CAAC,QAAQ,CAAC,GAAG,OAAO,CACxB,gBAAgB,EAChB,MAAM,CAAC,QAAQ,CAAC,EAChB,QAAQ,CACT,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/schemas/index.d.ts

@@ -0,0 +1,5 @@
+import schemasJson from "./schemas.json";
+export type SchemaKey = keyof typeof schemasJson;
+export type Schema = (typeof schemasJson)[SchemaKey];
+export declare const schemas: typeof schemasJson;
+//# sourceMappingURL=index.d.ts.map

package/dist/schemas/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/schemas/index.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,gBAAgB,CAAC;AAEzC,MAAM,MAAM,SAAS,GAAG,MAAM,OAAO,WAAW,CAAC;AACjD,MAAM,MAAM,MAAM,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,SAAS,CAAC,CAAC;AAErD,eAAO,MAAM,OAAO,EAAE,OAAO,WAAyB,CAAC"}

package/dist/schemas/index.js

@@ -0,0 +1,9 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.schemas = void 0;
+const schemas_json_1 = __importDefault(require("./schemas.json"));
+exports.schemas = schemas_json_1.default;
+//# sourceMappingURL=index.js.map

package/dist/schemas/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/schemas/index.ts"],"names":[],"mappings":";;;;;;AAAA,kEAAyC;AAK5B,QAAA,OAAO,GAAuB,sBAAW,CAAC"}