doc-detective 4.0.1 → 4.0.2

package/dist/common/src/detectTests.d.ts

@@ -0,0 +1,101 @@
+/**
+ * Browser-compatible test detection utilities.
+ * This module provides pure parsing functionality that works with strings/objects,
+ * without dependencies on Node.js file system or path modules.
+ */
+import { FileType } from "./fileTypes.js";
+/**
+ * Precomputes an array of line-start character offsets for the given content.
+ * Each entry is the index of the first character on that line (0-indexed offsets, 1-indexed lines).
+ */
+export declare function getLineStarts(content: string): number[];
+/**
+ * Returns the 1-indexed line number for a given character index.
+ * Uses binary search over precomputed line starts, or scans linearly if none provided.
+ */
+export declare function getLineNumber(content: string, index: number, lineStarts?: number[]): number;
+export { FileType } from "./fileTypes.js";
+export interface DetectTestsConfig {
+    detectSteps?: boolean;
+    origin?: string;
+    logLevel?: string;
+    _herettoPathMapping?: Record<string, string>;
+}
+export interface DetectedTest {
+    testId?: string;
+    detectSteps?: boolean;
+    steps: Array<Record<string, any>>;
+    [key: string]: any;
+}
+export interface DetectTestsInput {
+    content: string;
+    filePath?: string;
+    fileType?: FileType;
+    config?: DetectTestsConfig;
+}
+/**
+ * Browser-compatible test detection function.
+ * Detects tests from content string using specified file type configuration.
+ *
+ * This is the main entry point for test detection in Common.
+ * It works with content strings rather than file paths, making it browser-compatible.
+ *
+ * @param input - Detection input
+ * @param input.content - Content string to parse for tests
+ * @param input.filePath - File path (for metadata only, not file I/O)
+ * @param input.fileType - File type configuration with parsing rules
+ * @param input.config - Optional configuration
+ * @returns Array of detected tests
+ *
+ * @example
+ * ```typescript
+ * const tests = await detectTests({
+ *   content: markdownContent,
+ *   filePath: 'docs/test.md',
+ *   fileType: { extensions: ['md'], markup: [...] },
+ *   config: { detectSteps: true }
+ * });
+ * ```
+ */
+export declare function detectTests(input: DetectTestsInput): Promise<DetectedTest[]>;
+/**
+ * Parses XML-style attributes to an object.
+ * Example: 'wait=500' becomes { wait: 500 }
+ * Example: 'testId="myTestId" detectSteps=false' becomes { testId: "myTestId", detectSteps: false }
+ * Example: 'httpRequest.url="https://example.com"' becomes { httpRequest: { url: "https://example.com" } }
+ */
+export declare function parseXmlAttributes({ stringifiedObject }: {
+    stringifiedObject: string;
+}): Record<string, any> | null;
+/**
+ * Parses a JSON or YAML object from a string.
+ */
+export declare function parseObject({ stringifiedObject }: {
+    stringifiedObject: string;
+}): Record<string, any> | null;
+/**
+ * Replaces numeric variables ($0, $1, etc.) in strings and objects with provided values.
+ */
+export declare function replaceNumericVariables(stringOrObjectSource: string | Record<string, any>, values: Record<string, any>): string | Record<string, any> | null;
+/**
+ * Parses raw test content into an array of structured test objects.
+ * This is a browser-compatible function that works with strings and doesn't require file system access.
+ *
+ * @param options - Options for parsing
+ * @param options.config - Test configuration object
+ * @param options.content - Raw file content as a string
+ * @param options.filePath - Path to the file being parsed (for metadata, not file I/O)
+ * @param options.fileType - File type definition containing parsing rules
+ * @returns Array of parsed and validated test objects
+ */
+export declare function parseContent({ config, content, filePath, fileType, }: {
+    config?: DetectTestsConfig;
+    content: string;
+    filePath?: string;
+    fileType?: FileType;
+}): Promise<DetectedTest[]>;
+/**
+ * Simple browser-compatible logging function.
+ */
+export declare function log(config: DetectTestsConfig, level: string, message: any): void;
+//# sourceMappingURL=detectTests.d.ts.map

package/dist/common/src/detectTests.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"detectTests.d.ts","sourceRoot":"","sources":["../../../src/common/src/detectTests.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAKH,OAAO,EAA+C,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAoCvF;;;GAGG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,CAMvD;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAe3F;AAED,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C,MAAM,WAAW,iBAAiB;IAChC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC9C;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;IAClC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,MAAM,CAAC,EAAE,iBAAiB,CAAC;CAC5B;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAsB,WAAW,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CAOlF;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,EAAE,iBAAiB,EAAE,EAAE;IAAE,iBAAiB,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAoEnH;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,EAAE,iBAAiB,EAAE,EAAE;IAAE,iBAAiB,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAkD5G;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CACrC,oBAAoB,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAClD,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC1B,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CA2DrC;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,YAAY,CAAC,EACjC,MAAW,EACX,OAAO,EACP,QAAa,EACb,QAAQ,GACT,EAAE;IACD,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CAqU1B;AAsBD;;GAEG;AACH,wBAAgB,GAAG,CAAC,MAAM,EAAE,iBAAiB,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,GAAG,IAAI,CAqBhF"}