@esri/hub-common 13.36.1 → 13.37.1

package/dist/types/search/_internal/explainHelpers.d.ts

@@ -0,0 +1,38 @@
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { GenericResult, IMatchReason, IPredicateExplanation } from "../explainQueryResult";
+import { IMatchOptions } from "../types";
+export declare function explainDatePredicate(predicate: Record<string, IMatchOptions>, result: GenericResult, requestOptions: IRequestOptions): Promise<IPredicateExplanation>;
+export declare function explainPropPredicate(predicate: Record<string, IMatchOptions>, result: GenericResult, requestOptions: IRequestOptions): Promise<IPredicateExplanation>;
+/**
+ * @internal
+ * Create explanation for an IMatchOptions predicate
+ * @param predicate
+ * @param result
+ * @param requestOptions
+ * @returns
+ */
+export declare function explainMatchOptionPredicate(predicate: Record<string, IMatchOptions>, result: GenericResult, requestOptions: IRequestOptions): Promise<IPredicateExplanation>;
+/**
+ * Returns information about the match between a result value and the .any property of an IMatchOptions predicate
+ * @param attribute
+ * @param option
+ * @param resultValue
+ * @returns
+ */
+export declare function checkAny(attribute: string, option: string | string[], resultValue: string | string[]): IMatchReason;
+/**
+ * * Returns information about the match between a result value and the .all property of an IMatchOptions predicate
+ * @param attribute
+ * @param option
+ * @param resultValue
+ * @returns
+ */
+export declare function checkAll(attribute: string, option: string | string[], resultValue: string | string[]): IMatchReason;
+/**
+ * * Returns information about the match between a result value and the .not property of an IMatchOptions predicate
+ * @param attribute
+ * @param option
+ * @param resultValue
+ * @returns
+ */
+export declare function checkNot(attribute: string, option: string | string[], resultValue: string | string[]): IMatchReason;

package/dist/types/search/_internal/explainPredicate.d.ts

@@ -0,0 +1,12 @@
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { GenericResult, IPredicateExplanation } from "../explainQueryResult";
+import { IMatchOptions } from "../types";
+/**
+ * Geneate an explanation if a specific result passes the predicate's criteria
+ * This will delegate to more specific functions based on the predicate's key
+ * @param predicate
+ * @param result
+ * @param requestOptions
+ * @returns
+ */
+export declare function explainPredicate(predicate: Record<string, IMatchOptions>, result: GenericResult, requestOptions: IRequestOptions): Promise<IPredicateExplanation>;

package/dist/types/search/_internal/portalSearchItems.d.ts

@@ -17,6 +17,14 @@ export declare function portalSearchItems(query: IQuery, options: IHubSearchOpti
  * @returns
  */
 export declare function portalSearchItemsAsItems(query: IQuery, options: IHubSearchOptions): Promise<IHubSearchResponse<IItem>>;
+/**
+ * @internal
+ * Expand an IQuery by applying well-known filters and predicates,
+ * and then expanding all the predicates into IMatchOption objects.
+ * @param query `IQuery` to expand
+ * @returns IQuery
+ */
+export declare function expandQuery(query: IQuery): IQuery;
 /**
  * Convert an `IItem` to a `IHubSearchResult`
  * Fetches the enrichments, and attaches them as directed in the `include` list

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

@@ -0,0 +1,102 @@
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { IFilter, IPredicate, IQuery } from "./types";
+/**
+ * Explanation of why a result matched a query
+ */
+export interface IQueryExplanation {
+    /**
+     * Copy of result; Useful when doing bulk calls
+     */
+    result: GenericResult;
+    /**
+     * Copy of query; Useful when doing bulk calls
+     */
+    query: IQuery;
+    /**
+     * Whether the result matched the query
+     */
+    matched: boolean;
+    /**
+     * Array of explanations for each filter
+     */
+    reasons: IFilterExplanation[];
+    /**
+     * Summary of all reasons for the result matching the query
+     */
+    summary: IMatchReason[];
+}
+export interface IQueryExplanationDetails {
+    value: string;
+    description: string;
+    details: [];
+}
+/**
+ * Explanation of why a filter matched a query
+ */
+export interface IFilterExplanation {
+    /**
+     * Copy of the Filter
+     */
+    filter: IFilter;
+    /**
+     * Did the filter match the query?
+     */
+    matched: boolean;
+    /**
+     * Array of explanations for each predicate in the Filter
+     */
+    reasons: IPredicateExplanation[];
+}
+/**
+ * Explanation of why a predicate matched a query
+ */
+export interface IPredicateExplanation {
+    /**
+     * Copy of the Predicate
+     */
+    predicate: IPredicate;
+    /**
+     * Did the predicate match the query?
+     */
+    matched: boolean;
+    /**
+     * Array of reasons why the predicate matched the query
+     */
+    reasons: IMatchReason[];
+    /**
+     * Additional information about the predicate which can be useful
+     * when preparing a UI to display the explanation
+     */
+    meta?: Record<string, any>;
+}
+/**
+ * Match condition
+ */
+export declare type MatchCondition = "IN" | "NOT_IN" | "ALL";
+/**
+ * Reason why a result matched a query
+ */
+export interface IMatchReason {
+    attribute: string;
+    values?: string;
+    condition?: MatchCondition;
+    matched: boolean;
+    requirement?: string;
+    message?: string;
+    meta?: Record<string, any>;
+}
+/**
+ * Wide type allowing any object to be passed in as a result
+ */
+export declare type GenericResult = Record<string, any>;
+/**
+ * Explain why a specific result was included in a Query.
+ *
+ * NOTE: This only works for entityType: "item" queries and does not
+ * cover all possible permutations.
+ * @param queryResult
+ * @param query
+ * @param requestOptions
+ * @returns
+ */
+export declare function explainQueryResult(queryResult: GenericResult, query: IQuery, requestOptions: IRequestOptions): Promise<IQueryExplanation>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/hub-common",
-  "version": "13.36.1",
+  "version": "13.37.1",
   "description": "Common TypeScript types and utility functions for @esri/hub.js.",
   "main": "dist/node/index.js",
   "module": "dist/esm/index.js",