@gorules/zen-engine 1.0.0-beta.10 → 1.0.0-beta.11

package/index.d.ts

@@ -310,6 +310,51 @@ export interface PolicyReferenceSite {
   kind: PolicyReferenceKind;
 }
 
+/** What kind of content a `PolicySearchHit` matched. */
+export type PolicySearchHitKind =
+  | 'document'
+  | 'heading'
+  | 'paragraph'
+  | 'listItem'
+  | 'codeBlock'
+  | 'expression'
+  | 'expressionKey'
+  | 'tableColumn'
+  | 'tableCell'
+  | 'matchKey'
+  | 'matchCondition'
+  | 'matchValue'
+  | 'assertionOutput'
+  | 'assertionCondition'
+  | 'dataModel'
+  | 'dataModelProperty'
+  | 'dictionary'
+  | 'dictionaryEntry'
+  | 'graphNode'
+  | 'switchCondition'
+  | 'function';
+
+/**
+ * One ranked fuzzy-search hit returned by `search()`. Location fields are
+ * populated per kind: policy hits carry `blockId` (plus `expressionId`,
+ * `row`/`column` for table cells), graph hits carry `nodeId`. `span` is a
+ * character range within `text` (which may be a snippet of long sources).
+ */
+export interface PolicySearchHit {
+  path: string;
+  blockId?: string;
+  nodeId?: string;
+  expressionId?: string;
+  row?: number;
+  column?: string;
+  kind: PolicySearchHitKind;
+  text: string;
+  /** Human context for the hit, e.g. column name, entity, or node name. */
+  context?: string;
+  span: PolicySpan;
+  score: number;
+}
+
 /**
  * One node in the transitive dependency tree returned by `dependencies()`.
  * Each node names a property; `writtenBy` is the block that produces it
@@ -418,6 +463,7 @@ export declare class Workspace {
   prepareRename(cursor: PolicyExpressionCursor): PolicyPrepareRenameResult | null
   rename(req: PolicyRenameRequest): PolicyEngineEdit[]
   references(target: any): PolicyReferenceSite[]
+  search(query: string, limit?: number | undefined | null): PolicySearchHit[]
   inputSkeleton(req: PolicyScopeRequest): unknown
   dependencies(target: string, document?: string | undefined | null): PolicyDependencyNode
   evaluate(req: PolicyEvaluateRequest): PolicyEvaluationResult

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gorules/zen-engine",
-  "version": "1.0.0-beta.10",
+  "version": "1.0.0-beta.11",
   "main": "index.js",
   "browser": "browser.js",
   "types": "./index.d.ts",
@@ -101,15 +101,15 @@
   "resolutions": {
     "form-data@^4.0.0": "4.0.4"
   },
-  "gitHead": "ad97b340b3cb9fb1731d4652c12cbe9ea3fa2ec0",
+  "gitHead": "e17a808baee7140cba9b6e0689e55dded7ee1133",
   "optionalDependencies": {
-    "@gorules/zen-engine-darwin-x64": "1.0.0-beta.10",
-    "@gorules/zen-engine-linux-x64-gnu": "1.0.0-beta.10",
-    "@gorules/zen-engine-linux-x64-musl": "1.0.0-beta.10",
-    "@gorules/zen-engine-win32-x64-msvc": "1.0.0-beta.10",
-    "@gorules/zen-engine-linux-arm64-gnu": "1.0.0-beta.10",
-    "@gorules/zen-engine-linux-arm64-musl": "1.0.0-beta.10",
-    "@gorules/zen-engine-darwin-arm64": "1.0.0-beta.10",
-    "@gorules/zen-engine-wasm32-wasi": "1.0.0-beta.10"
+    "@gorules/zen-engine-darwin-x64": "1.0.0-beta.11",
+    "@gorules/zen-engine-linux-x64-gnu": "1.0.0-beta.11",
+    "@gorules/zen-engine-linux-x64-musl": "1.0.0-beta.11",
+    "@gorules/zen-engine-win32-x64-msvc": "1.0.0-beta.11",
+    "@gorules/zen-engine-linux-arm64-gnu": "1.0.0-beta.11",
+    "@gorules/zen-engine-linux-arm64-musl": "1.0.0-beta.11",
+    "@gorules/zen-engine-darwin-arm64": "1.0.0-beta.11",
+    "@gorules/zen-engine-wasm32-wasi": "1.0.0-beta.11"
   }
 }