@cucumber/react-components 24.2.0 → 24.3.0

package/dist/src/search/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/search/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC1C,cAAc,YAAY,CAAA","sourcesContent":["export { createSearch } from './Search.js'\nexport * from './types.js'\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/search/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAA;AACtC,cAAc,+BAA+B,CAAA;AAC7C,cAAc,4BAA4B,CAAA;AAC1C,cAAc,YAAY,CAAA","sourcesContent":["export * from './createSearchIndex.js'\nexport * from './deriveLineageConstraints.js'\nexport * from './pruneGherkinDocuments.js'\nexport * from './types.js'\n"]}

package/dist/src/search/pruneGherkinDocuments.d.ts

@@ -0,0 +1,24 @@
+import type { GherkinDocument } from '@cucumber/messages';
+import type { LineageConstraints, SearchHits } from './types.js';
+/**
+ * Returns abridged copies of the given documents, with lineage constraints and search hits used
+ * to filter out nodes that shouldn't be shown
+ *
+ * @param gherkinDocuments - the original documents to prune
+ * @param constraints - the set of AST node IDs to retain, derived from pickle lineage
+ * @param searchHits - if provided, further narrows results to nodes matching a search query
+ *
+ * @remarks
+ * The two filtering mechanisms behave a little differently.
+ *
+ * `lineageConstraints` are strictly enforced at every level - any node of the covered types must
+ * have its id included otherwise it will be filtered off. This check is performed eagerly at every
+ * level so for e.g. a Rule that isn't matched, we won't even look at its child Scenarios.
+ *
+ * `searchHits` has cascading behaviour - a match at a higher level (Feature, Rule, or Background)
+ * ensures all of its descendants will be retained, and a match at a lower level (Scenario, Step)
+ * ensures all of its ascendants (but not siblings) will be retained. A `false` value means there
+ * were no hits at all, so no documents will be returned.
+ */
+export declare function pruneGherkinDocuments(gherkinDocuments: ReadonlyArray<GherkinDocument>, constraints: LineageConstraints, searchHits?: SearchHits | false): ReadonlyArray<GherkinDocument>;
+//# sourceMappingURL=pruneGherkinDocuments.d.ts.map

package/dist/src/search/pruneGherkinDocuments.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pruneGherkinDocuments.d.ts","sourceRoot":"","sources":["../../../src/search/pruneGherkinDocuments.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAKV,eAAe,EAMhB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,KAAK,EAAsB,kBAAkB,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAEpF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,qBAAqB,CACnC,gBAAgB,EAAE,aAAa,CAAC,eAAe,CAAC,EAChD,WAAW,EAAE,kBAAkB,EAC/B,UAAU,CAAC,EAAE,UAAU,GAAG,KAAK,GAC9B,aAAa,CAAC,eAAe,CAAC,CAsBhC"}

package/dist/src/search/pruneGherkinDocuments.js

@@ -0,0 +1,180 @@
+/**
+ * Returns abridged copies of the given documents, with lineage constraints and search hits used
+ * to filter out nodes that shouldn't be shown
+ *
+ * @param gherkinDocuments - the original documents to prune
+ * @param constraints - the set of AST node IDs to retain, derived from pickle lineage
+ * @param searchHits - if provided, further narrows results to nodes matching a search query
+ *
+ * @remarks
+ * The two filtering mechanisms behave a little differently.
+ *
+ * `lineageConstraints` are strictly enforced at every level - any node of the covered types must
+ * have its id included otherwise it will be filtered off. This check is performed eagerly at every
+ * level so for e.g. a Rule that isn't matched, we won't even look at its child Scenarios.
+ *
+ * `searchHits` has cascading behaviour - a match at a higher level (Feature, Rule, or Background)
+ * ensures all of its descendants will be retained, and a match at a lower level (Scenario, Step)
+ * ensures all of its ascendants (but not siblings) will be retained. A `false` value means there
+ * were no hits at all, so no documents will be returned.
+ */
+export function pruneGherkinDocuments(gherkinDocuments, constraints, searchHits) {
+    if (searchHits === false) {
+        return [];
+    }
+    const results = [];
+    for (const gherkinDocument of gherkinDocuments) {
+        if (!gherkinDocument.uri) {
+            continue;
+        }
+        if (!constraints.gherkinDocument.has(gherkinDocument.uri)) {
+            continue;
+        }
+        const documentHits = searchHits?.get(gherkinDocument.uri);
+        if (searchHits && !documentHits) {
+            continue;
+        }
+        const pruned = pruneGherkinDocument(gherkinDocument, constraints, documentHits);
+        if (pruned) {
+            results.push(pruned);
+        }
+    }
+    return results;
+}
+function pruneGherkinDocument(gherkinDocument, constraints, searchHits) {
+    if (searchHits?.feature) {
+        searchHits = undefined;
+    }
+    const feature = filterFeature(gherkinDocument.feature, constraints, searchHits);
+    if (feature) {
+        return {
+            ...gherkinDocument,
+            feature,
+        };
+    }
+}
+function filterFeature(feature, constraints, searchHits) {
+    if (!feature) {
+        return undefined;
+    }
+    if (searchHits && matchesOnBackground(feature.children, searchHits)) {
+        searchHits = undefined;
+    }
+    const children = feature.children
+        .map((child) => filterFeatureChild(child, constraints, searchHits))
+        .filter((child) => !!child);
+    if (children.some((child) => !child.background)) {
+        return {
+            ...feature,
+            children,
+        };
+    }
+}
+function filterFeatureChild(child, constraints, searchHits) {
+    if (child.background) {
+        const background = filterBackground(child.background, constraints);
+        if (background) {
+            return {
+                background,
+            };
+        }
+    }
+    if (child.scenario) {
+        const scenario = filterScenario(child.scenario, constraints, searchHits);
+        if (scenario) {
+            return {
+                scenario,
+            };
+        }
+    }
+    if (child.rule) {
+        const rule = filterRule(child.rule, constraints, searchHits);
+        if (rule) {
+            return {
+                rule,
+            };
+        }
+    }
+    return undefined;
+}
+function filterBackground(background, constraints) {
+    return constraints.background.has(background.id) ? background : undefined;
+}
+function filterRule(rule, constraints, searchHits) {
+    if (!constraints.rule.has(rule.id)) {
+        return undefined;
+    }
+    if (searchHits &&
+        (searchHits.rule.includes(rule.id) || matchesOnBackground(rule.children, searchHits))) {
+        searchHits = undefined;
+    }
+    const children = rule.children
+        .map((child) => filterRuleChild(child, constraints, searchHits))
+        .filter((child) => !!child);
+    if (children.some((child) => !child.background)) {
+        return {
+            ...rule,
+            children,
+        };
+    }
+}
+function filterRuleChild(child, constraints, searchHits) {
+    if (child.background) {
+        const background = filterBackground(child.background, constraints);
+        if (background) {
+            return {
+                background,
+            };
+        }
+    }
+    if (child.scenario) {
+        const scenario = filterScenario(child.scenario, constraints, searchHits);
+        if (scenario) {
+            return {
+                scenario,
+            };
+        }
+    }
+    return undefined;
+}
+function filterScenario(scenario, constraints, searchHits) {
+    if (!constraints.scenario.has(scenario.id)) {
+        return undefined;
+    }
+    if (searchHits &&
+        !searchHits.scenario.includes(scenario.id) &&
+        !matchesOnSteps(scenario.steps, searchHits)) {
+        return undefined;
+    }
+    return {
+        ...scenario,
+        examples: scenario.examples
+            .map((examples) => filterExamplesTable(examples, constraints))
+            .filter((examples) => !!examples),
+    };
+}
+function filterExamplesTable(examples, constraints) {
+    if (!constraints.examples.has(examples.id)) {
+        return undefined;
+    }
+    return {
+        ...examples,
+        tableBody: examples.tableBody
+            .map((row) => filterExampleRow(row, constraints))
+            .filter((row) => !!row),
+    };
+}
+function filterExampleRow(row, constraints) {
+    return constraints.example.has(row.id) ? row : undefined;
+}
+function matchesOnBackground(children, searchHits) {
+    return children
+        .map((child) => child.background)
+        .filter((background) => !!background)
+        .some((background) => searchHits.background.includes(background.id) ||
+        matchesOnSteps(background.steps, searchHits));
+}
+function matchesOnSteps(steps, searchHits) {
+    return steps.some((step) => searchHits.step.includes(step.id));
+}
+//# sourceMappingURL=pruneGherkinDocuments.js.map

package/dist/src/search/pruneGherkinDocuments.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pruneGherkinDocuments.js","sourceRoot":"","sources":["../../../src/search/pruneGherkinDocuments.ts"],"names":[],"mappings":"AAcA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,qBAAqB,CACnC,gBAAgD,EAChD,WAA+B,EAC/B,UAA+B;IAE/B,IAAI,UAAU,KAAK,KAAK,EAAE,CAAC;QACzB,OAAO,EAAE,CAAA;IACX,CAAC;IACD,MAAM,OAAO,GAAsB,EAAE,CAAA;IACrC,KAAK,MAAM,eAAe,IAAI,gBAAgB,EAAE,CAAC;QAC/C,IAAI,CAAC,eAAe,CAAC,GAAG,EAAE,CAAC;YACzB,SAAQ;QACV,CAAC;QACD,IAAI,CAAC,WAAW,CAAC,eAAe,CAAC,GAAG,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1D,SAAQ;QACV,CAAC;QACD,MAAM,YAAY,GAAG,UAAU,EAAE,GAAG,CAAC,eAAe,CAAC,GAAG,CAAC,CAAA;QACzD,IAAI,UAAU,IAAI,CAAC,YAAY,EAAE,CAAC;YAChC,SAAQ;QACV,CAAC;QACD,MAAM,MAAM,GAAG,oBAAoB,CAAC,eAAe,EAAE,WAAW,EAAE,YAAY,CAAC,CAAA;QAC/E,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACtB,CAAC;IACH,CAAC;IACD,OAAO,OAAO,CAAA;AAChB,CAAC;AAED,SAAS,oBAAoB,CAC3B,eAAgC,EAChC,WAA+B,EAC/B,UAA+B;IAE/B,IAAI,UAAU,EAAE,OAAO,EAAE,CAAC;QACxB,UAAU,GAAG,SAAS,CAAA;IACxB,CAAC;IAED,MAAM,OAAO,GAAG,aAAa,CAAC,eAAe,CAAC,OAAO,EAAE,WAAW,EAAE,UAAU,CAAC,CAAA;IAC/E,IAAI,OAAO,EAAE,CAAC;QACZ,OAAO;YACL,GAAG,eAAe;YAClB,OAAO;SACR,CAAA;IACH,CAAC;AACH,CAAC;AAED,SAAS,aAAa,CACpB,OAA4B,EAC5B,WAA+B,EAC/B,UAA+B;IAE/B,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,IAAI,UAAU,IAAI,mBAAmB,CAAC,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,EAAE,CAAC;QACpE,UAAU,GAAG,SAAS,CAAA;IACxB,CAAC;IAED,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ;SAC9B,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,kBAAkB,CAAC,KAAK,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC;SAClE,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;IAE7B,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;QAChD,OAAO;YACL,GAAG,OAAO;YACV,QAAQ;SACT,CAAA;IACH,CAAC;AACH,CAAC;AAED,SAAS,kBAAkB,CACzB,KAAmB,EACnB,WAA+B,EAC/B,UAA+B;IAE/B,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC;QACrB,MAAM,UAAU,GAAG,gBAAgB,CAAC,KAAK,CAAC,UAAU,EAAE,WAAW,CAAC,CAAA;QAClE,IAAI,UAAU,EAAE,CAAC;YACf,OAAO;gBACL,UAAU;aACX,CAAA;QACH,CAAC;IACH,CAAC;IACD,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;QACnB,MAAM,QAAQ,GAAG,cAAc,CAAC,KAAK,CAAC,QAAQ,EAAE,WAAW,EAAE,UAAU,CAAC,CAAA;QACxE,IAAI,QAAQ,EAAE,CAAC;YACb,OAAO;gBACL,QAAQ;aACT,CAAA;QACH,CAAC;IACH,CAAC;IACD,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;QACf,MAAM,IAAI,GAAG,UAAU,CAAC,KAAK,CAAC,IAAI,EAAE,WAAW,EAAE,UAAU,CAAC,CAAA;QAC5D,IAAI,IAAI,EAAE,CAAC;YACT,OAAO;gBACL,IAAI;aACL,CAAA;QACH,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAA;AAClB,CAAC;AAED,SAAS,gBAAgB,CAAC,UAAsB,EAAE,WAA+B;IAC/E,OAAO,WAAW,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAA;AAC3E,CAAC;AAED,SAAS,UAAU,CACjB,IAAU,EACV,WAA+B,EAC/B,UAA+B;IAE/B,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;QACnC,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,IACE,UAAU;QACV,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,mBAAmB,CAAC,IAAI,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC,EACrF,CAAC;QACD,UAAU,GAAG,SAAS,CAAA;IACxB,CAAC;IAED,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ;SAC3B,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,eAAe,CAAC,KAAK,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC;SAC/D,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;IAE7B,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;QAChD,OAAO;YACL,GAAG,IAAI;YACP,QAAQ;SACT,CAAA;IACH,CAAC;AACH,CAAC;AAED,SAAS,eAAe,CACtB,KAAgB,EAChB,WAA+B,EAC/B,UAA+B;IAE/B,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC;QACrB,MAAM,UAAU,GAAG,gBAAgB,CAAC,KAAK,CAAC,UAAU,EAAE,WAAW,CAAC,CAAA;QAClE,IAAI,UAAU,EAAE,CAAC;YACf,OAAO;gBACL,UAAU;aACX,CAAA;QACH,CAAC;IACH,CAAC;IACD,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;QACnB,MAAM,QAAQ,GAAG,cAAc,CAAC,KAAK,CAAC,QAAQ,EAAE,WAAW,EAAE,UAAU,CAAC,CAAA;QACxE,IAAI,QAAQ,EAAE,CAAC;YACb,OAAO;gBACL,QAAQ;aACT,CAAA;QACH,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAA;AAClB,CAAC;AAED,SAAS,cAAc,CACrB,QAAkB,EAClB,WAA+B,EAC/B,UAA+B;IAE/B,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;QAC3C,OAAO,SAAS,CAAA;IAClB,CAAC;IACD,IACE,UAAU;QACV,CAAC,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC1C,CAAC,cAAc,CAAC,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC,EAC3C,CAAC;QACD,OAAO,SAAS,CAAA;IAClB,CAAC;IACD,OAAO;QACL,GAAG,QAAQ;QACX,QAAQ,EAAE,QAAQ,CAAC,QAAQ;aACxB,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,mBAAmB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;aAC7D,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;KACpC,CAAA;AACH,CAAC;AAED,SAAS,mBAAmB,CAC1B,QAAkB,EAClB,WAA+B;IAE/B,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;QAC3C,OAAO,SAAS,CAAA;IAClB,CAAC;IACD,OAAO;QACL,GAAG,QAAQ;QACX,SAAS,EAAE,QAAQ,CAAC,SAAS;aAC1B,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,gBAAgB,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;aAChD,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;KAC1B,CAAA;AACH,CAAC;AAED,SAAS,gBAAgB,CAAC,GAAa,EAAE,WAA+B;IACtE,OAAO,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAA;AAC1D,CAAC;AAED,SAAS,mBAAmB,CAC1B,QAAkC,EAClC,UAA8B;IAE9B,OAAO,QAAQ;SACZ,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC;SAChC,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC;SACpC,IAAI,CACH,CAAC,UAAU,EAAE,EAAE,CACb,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;QAC7C,cAAc,CAAC,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,CAC/C,CAAA;AACL,CAAC;AAED,SAAS,cAAc,CAAC,KAA0B,EAAE,UAA8B;IAChF,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAA;AAChE,CAAC","sourcesContent":["import type {\n  Background,\n  Examples,\n  Feature,\n  FeatureChild,\n  GherkinDocument,\n  Rule,\n  RuleChild,\n  Scenario,\n  Step,\n  TableRow,\n} from '@cucumber/messages'\nimport type { DocumentSearchHits, LineageConstraints, SearchHits } from './types.js'\n\n/**\n * Returns abridged copies of the given documents, with lineage constraints and search hits used\n * to filter out nodes that shouldn't be shown\n *\n * @param gherkinDocuments - the original documents to prune\n * @param constraints - the set of AST node IDs to retain, derived from pickle lineage\n * @param searchHits - if provided, further narrows results to nodes matching a search query\n *\n * @remarks\n * The two filtering mechanisms behave a little differently.\n *\n * `lineageConstraints` are strictly enforced at every level - any node of the covered types must\n * have its id included otherwise it will be filtered off. This check is performed eagerly at every\n * level so for e.g. a Rule that isn't matched, we won't even look at its child Scenarios.\n *\n * `searchHits` has cascading behaviour - a match at a higher level (Feature, Rule, or Background)\n * ensures all of its descendants will be retained, and a match at a lower level (Scenario, Step)\n * ensures all of its ascendants (but not siblings) will be retained. A `false` value means there\n * were no hits at all, so no documents will be returned.\n */\nexport function pruneGherkinDocuments(\n  gherkinDocuments: ReadonlyArray<GherkinDocument>,\n  constraints: LineageConstraints,\n  searchHits?: SearchHits | false\n): ReadonlyArray<GherkinDocument> {\n  if (searchHits === false) {\n    return []\n  }\n  const results: GherkinDocument[] = []\n  for (const gherkinDocument of gherkinDocuments) {\n    if (!gherkinDocument.uri) {\n      continue\n    }\n    if (!constraints.gherkinDocument.has(gherkinDocument.uri)) {\n      continue\n    }\n    const documentHits = searchHits?.get(gherkinDocument.uri)\n    if (searchHits && !documentHits) {\n      continue\n    }\n    const pruned = pruneGherkinDocument(gherkinDocument, constraints, documentHits)\n    if (pruned) {\n      results.push(pruned)\n    }\n  }\n  return results\n}\n\nfunction pruneGherkinDocument(\n  gherkinDocument: GherkinDocument,\n  constraints: LineageConstraints,\n  searchHits?: DocumentSearchHits\n): GherkinDocument | undefined {\n  if (searchHits?.feature) {\n    searchHits = undefined\n  }\n\n  const feature = filterFeature(gherkinDocument.feature, constraints, searchHits)\n  if (feature) {\n    return {\n      ...gherkinDocument,\n      feature,\n    }\n  }\n}\n\nfunction filterFeature(\n  feature: Feature | undefined,\n  constraints: LineageConstraints,\n  searchHits?: DocumentSearchHits\n): Feature | undefined {\n  if (!feature) {\n    return undefined\n  }\n\n  if (searchHits && matchesOnBackground(feature.children, searchHits)) {\n    searchHits = undefined\n  }\n\n  const children = feature.children\n    .map((child) => filterFeatureChild(child, constraints, searchHits))\n    .filter((child) => !!child)\n\n  if (children.some((child) => !child.background)) {\n    return {\n      ...feature,\n      children,\n    }\n  }\n}\n\nfunction filterFeatureChild(\n  child: FeatureChild,\n  constraints: LineageConstraints,\n  searchHits?: DocumentSearchHits\n): FeatureChild | undefined {\n  if (child.background) {\n    const background = filterBackground(child.background, constraints)\n    if (background) {\n      return {\n        background,\n      }\n    }\n  }\n  if (child.scenario) {\n    const scenario = filterScenario(child.scenario, constraints, searchHits)\n    if (scenario) {\n      return {\n        scenario,\n      }\n    }\n  }\n  if (child.rule) {\n    const rule = filterRule(child.rule, constraints, searchHits)\n    if (rule) {\n      return {\n        rule,\n      }\n    }\n  }\n  return undefined\n}\n\nfunction filterBackground(background: Background, constraints: LineageConstraints) {\n  return constraints.background.has(background.id) ? background : undefined\n}\n\nfunction filterRule(\n  rule: Rule,\n  constraints: LineageConstraints,\n  searchHits?: DocumentSearchHits\n): Rule | undefined {\n  if (!constraints.rule.has(rule.id)) {\n    return undefined\n  }\n\n  if (\n    searchHits &&\n    (searchHits.rule.includes(rule.id) || matchesOnBackground(rule.children, searchHits))\n  ) {\n    searchHits = undefined\n  }\n\n  const children = rule.children\n    .map((child) => filterRuleChild(child, constraints, searchHits))\n    .filter((child) => !!child)\n\n  if (children.some((child) => !child.background)) {\n    return {\n      ...rule,\n      children,\n    }\n  }\n}\n\nfunction filterRuleChild(\n  child: RuleChild,\n  constraints: LineageConstraints,\n  searchHits?: DocumentSearchHits\n): RuleChild | undefined {\n  if (child.background) {\n    const background = filterBackground(child.background, constraints)\n    if (background) {\n      return {\n        background,\n      }\n    }\n  }\n  if (child.scenario) {\n    const scenario = filterScenario(child.scenario, constraints, searchHits)\n    if (scenario) {\n      return {\n        scenario,\n      }\n    }\n  }\n  return undefined\n}\n\nfunction filterScenario(\n  scenario: Scenario,\n  constraints: LineageConstraints,\n  searchHits?: DocumentSearchHits\n): Scenario | undefined {\n  if (!constraints.scenario.has(scenario.id)) {\n    return undefined\n  }\n  if (\n    searchHits &&\n    !searchHits.scenario.includes(scenario.id) &&\n    !matchesOnSteps(scenario.steps, searchHits)\n  ) {\n    return undefined\n  }\n  return {\n    ...scenario,\n    examples: scenario.examples\n      .map((examples) => filterExamplesTable(examples, constraints))\n      .filter((examples) => !!examples),\n  }\n}\n\nfunction filterExamplesTable(\n  examples: Examples,\n  constraints: LineageConstraints\n): Examples | undefined {\n  if (!constraints.examples.has(examples.id)) {\n    return undefined\n  }\n  return {\n    ...examples,\n    tableBody: examples.tableBody\n      .map((row) => filterExampleRow(row, constraints))\n      .filter((row) => !!row),\n  }\n}\n\nfunction filterExampleRow(row: TableRow, constraints: LineageConstraints): TableRow | undefined {\n  return constraints.example.has(row.id) ? row : undefined\n}\n\nfunction matchesOnBackground(\n  children: ReadonlyArray<RuleChild>,\n  searchHits: DocumentSearchHits\n): boolean {\n  return children\n    .map((child) => child.background)\n    .filter((background) => !!background)\n    .some(\n      (background) =>\n        searchHits.background.includes(background.id) ||\n        matchesOnSteps(background.steps, searchHits)\n    )\n}\n\nfunction matchesOnSteps(steps: ReadonlyArray<Step>, searchHits: DocumentSearchHits): boolean {\n  return steps.some((step) => searchHits.step.includes(step.id))\n}\n"]}

package/dist/src/search/types.d.ts

@@ -1,14 +1,45 @@
-import { GherkinDocument } from '@cucumber/messages';
+export declare const ID_SEPARATOR = "\0";
+export interface IndexHit {
+    uri: string;
+    id: string;
+}
+/**
+ * Facade for an index that supports adding items of a given type and returning hits as an array
+ * of uri/id pairs
+ */
+export interface TypedIndex<SourceType = unknown> {
+    search: (query: string) => Promise<ReadonlyArray<IndexHit>>;
+    add: (item: SourceType, uri: string) => Promise<this>;
+}
 /**
- * Facade for an index that supports searching for and adding items of a given
- * type. Also supports a different type being added if needed.
+ * Interface for the top-level document search index
  */
-export interface TypedIndex<ReturnedType, SourceType = ReturnedType> {
-    search: (query: string) => Promise<readonly ReturnedType[]>;
-    add: (item: SourceType) => Promise<this>;
+export interface SearchIndex {
+    search: (query: string) => Promise<SearchHits | false>;
 }
 /**
- * Shorthand type for an index of Gherkin documents.
+ * Collection of Gherkin node ids that matched a search term for a single document, grouped by
+ * node type
  */
-export type Searchable = TypedIndex<GherkinDocument>;
+export interface DocumentSearchHits {
+    feature: boolean;
+    background: Array<string>;
+    rule: Array<string>;
+    scenario: Array<string>;
+    step: Array<string>;
+}
+export type SearchHits = ReadonlyMap<string, DocumentSearchHits>;
+/**
+ * Collection of Gherkin node ids harvested from executed test cases, grouped by node type
+ * @remarks
+ * In the case of `gherkinDocument`, the values are URIs
+ */
+export interface LineageConstraints {
+    gherkinDocument: ReadonlySet<string>;
+    background: ReadonlySet<string>;
+    rule: ReadonlySet<string>;
+    scenario: ReadonlySet<string>;
+    examples: ReadonlySet<string>;
+    example: ReadonlySet<string>;
+}
 //# sourceMappingURL=types.d.ts.map

package/dist/src/search/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/search/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA;AAEpD;;;GAGG;AACH,MAAM,WAAW,UAAU,CAAC,YAAY,EAAE,UAAU,GAAG,YAAY;IACjE,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,SAAS,YAAY,EAAE,CAAC,CAAA;IAC3D,GAAG,EAAE,CAAC,IAAI,EAAE,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;CACzC;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,UAAU,CAAC,eAAe,CAAC,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/search/types.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,YAAY,OAAO,CAAA;AAEhC,MAAM,WAAW,QAAQ;IACvB,GAAG,EAAE,MAAM,CAAA;IACX,EAAE,EAAE,MAAM,CAAA;CACX;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU,CAAC,UAAU,GAAG,OAAO;IAC9C,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAA;IAC3D,GAAG,EAAE,CAAC,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;CACtD;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,UAAU,GAAG,KAAK,CAAC,CAAA;CACvD;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,OAAO,CAAA;IAChB,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;IACzB,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;IACnB,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;IACvB,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;CACpB;AAED,MAAM,MAAM,UAAU,GAAG,WAAW,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAA;AAEhE;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,eAAe,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IACpC,UAAU,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAC/B,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IACzB,QAAQ,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAC7B,QAAQ,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAC7B,OAAO,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CAC7B"}

package/dist/src/search/types.js

@@ -1,2 +1,2 @@
-export {};
+export const ID_SEPARATOR = '\0';
 //# sourceMappingURL=types.js.map

package/dist/src/search/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/search/types.ts"],"names":[],"mappings":"","sourcesContent":["import { GherkinDocument } from '@cucumber/messages'\n\n/**\n * Facade for an index that supports searching for and adding items of a given\n * type. Also supports a different type being added if needed.\n */\nexport interface TypedIndex<ReturnedType, SourceType = ReturnedType> {\n  search: (query: string) => Promise<readonly ReturnedType[]>\n  add: (item: SourceType) => Promise<this>\n}\n\n/**\n * Shorthand type for an index of Gherkin documents.\n */\nexport type Searchable = TypedIndex<GherkinDocument>\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/search/types.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,YAAY,GAAG,IAAI,CAAA","sourcesContent":["export const ID_SEPARATOR = '\\0'\n\nexport interface IndexHit {\n  uri: string\n  id: string\n}\n\n/**\n * Facade for an index that supports adding items of a given type and returning hits as an array\n * of uri/id pairs\n */\nexport interface TypedIndex<SourceType = unknown> {\n  search: (query: string) => Promise<ReadonlyArray<IndexHit>>\n  add: (item: SourceType, uri: string) => Promise<this>\n}\n\n/**\n * Interface for the top-level document search index\n */\nexport interface SearchIndex {\n  search: (query: string) => Promise<SearchHits | false>\n}\n\n/**\n * Collection of Gherkin node ids that matched a search term for a single document, grouped by\n * node type\n */\nexport interface DocumentSearchHits {\n  feature: boolean\n  background: Array<string>\n  rule: Array<string>\n  scenario: Array<string>\n  step: Array<string>\n}\n\nexport type SearchHits = ReadonlyMap<string, DocumentSearchHits>\n\n/**\n * Collection of Gherkin node ids harvested from executed test cases, grouped by node type\n * @remarks\n * In the case of `gherkinDocument`, the values are URIs\n */\nexport interface LineageConstraints {\n  gherkinDocument: ReadonlySet<string>\n  background: ReadonlySet<string>\n  rule: ReadonlySet<string>\n  scenario: ReadonlySet<string>\n  examples: ReadonlySet<string>\n  example: ReadonlySet<string>\n}\n"]}

package/dist/src/toRepositoryId.d.ts

@@ -1,2 +1,2 @@
-export default function toRepositoryId(s: string): string;
+export default function toRepositoryId(remote: string): string;
 //# sourceMappingURL=toRepositoryId.d.ts.map

package/dist/src/toRepositoryId.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"toRepositoryId.d.ts","sourceRoot":"","sources":["../../src/toRepositoryId.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,UAAU,cAAc,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CASxD"}
+{"version":3,"file":"toRepositoryId.d.ts","sourceRoot":"","sources":["../../src/toRepositoryId.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,UAAU,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAU7D"}

package/dist/src/toRepositoryId.js

@@ -1,11 +1,12 @@
-export default function toRepositoryId(s) {
-    if (!s.includes('://') && s.includes(':')) {
+export default function toRepositoryId(remote) {
+    let result = remote;
+    if (!remote.includes('://') && remote.includes(':')) {
         // scp style URL (not really a URL)
-        const [host, path] = s.split(':', 2);
-        s = `ssh://${host}/${path}`;
+        const [host, path] = remote.split(':', 2);
+        result = `ssh://${host}/${path}`;
     }
-    s = s.replace(/\.git$/, '');
-    const url = new URL(s);
+    result = result.replace(/\.git$/, '');
+    const url = new URL(result);
     return `${url.hostname}${url.pathname}`;
 }
 //# sourceMappingURL=toRepositoryId.js.map

package/dist/src/toRepositoryId.js.map

@@ -1 +1 @@
-{"version":3,"file":"toRepositoryId.js","sourceRoot":"","sources":["../../src/toRepositoryId.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,UAAU,cAAc,CAAC,CAAS;IAC9C,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;QACzC,mCAAmC;QACnC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAA;QACpC,CAAC,GAAG,SAAS,IAAI,IAAI,IAAI,EAAE,CAAA;KAC5B;IACD,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAA;IAC3B,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,CAAA;IACtB,OAAO,GAAG,GAAG,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,EAAE,CAAA;AACzC,CAAC","sourcesContent":["export default function toRepositoryId(s: string): string {\n  if (!s.includes('://') && s.includes(':')) {\n    // scp style URL (not really a URL)\n    const [host, path] = s.split(':', 2)\n    s = `ssh://${host}/${path}`\n  }\n  s = s.replace(/\\.git$/, '')\n  const url = new URL(s)\n  return `${url.hostname}${url.pathname}`\n}\n"]}
+{"version":3,"file":"toRepositoryId.js","sourceRoot":"","sources":["../../src/toRepositoryId.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,UAAU,cAAc,CAAC,MAAc;IACnD,IAAI,MAAM,GAAG,MAAM,CAAA;IACnB,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACpD,mCAAmC;QACnC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAA;QACzC,MAAM,GAAG,SAAS,IAAI,IAAI,IAAI,EAAE,CAAA;IAClC,CAAC;IACD,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAA;IACrC,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,CAAA;IAC3B,OAAO,GAAG,GAAG,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,EAAE,CAAA;AACzC,CAAC","sourcesContent":["export default function toRepositoryId(remote: string): string {\n  let result = remote\n  if (!remote.includes('://') && remote.includes(':')) {\n    // scp style URL (not really a URL)\n    const [host, path] = remote.split(':', 2)\n    result = `ssh://${host}/${path}`\n  }\n  result = result.replace(/\\.git$/, '')\n  const url = new URL(result)\n  return `${url.hostname}${url.pathname}`\n}\n"]}