@sinequa/atomic 0.0.62

package/dist/types/config/CCTab.d.ts

@@ -0,0 +1,35 @@
+import { CCSortingChoice } from "./CCSortingChoice";
+/**
+ * Describes the fields for a tab configuration object
+ */
+export type CCTab = {
+    /**
+     * The name of the tab
+     */
+    name: string;
+    /**
+     * The display value of the tab
+     */
+    display: string;
+    /**
+     * The values in the tab distribution that contribute to this tab
+     */
+    value: string;
+    /**
+     * Set if this tab is the default to be used when no tab is specified in a query
+     */
+    isDefault: boolean;
+    /**
+     * Indexes to exclude when executing a query with this tab selected
+     */
+    excludedIndices: string;
+    /**
+     * Aggregations to exclude when executing a query with this tab selected
+     */
+    excludedAggregations: string;
+    /**
+     * Results sorting options that should be available when executing a query with this tab selected
+     */
+    sortingChoices: CCSortingChoice[];
+};
+//# sourceMappingURL=CCTab.d.ts.map

package/dist/types/config/CCTab.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CCTab.d.ts","sourceRoot":"","sources":["../../../src/types/config/CCTab.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD;;GAEG;AACH,MAAM,MAAM,KAAK,GAAG;IAChB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAC7B;;OAEG;IACH,cAAc,EAAE,eAAe,EAAE,CAAC;CACrC,CAAA"}

package/dist/types/config/CCTabSearch.d.ts

@@ -0,0 +1,46 @@
+import { CCTab } from "./CCTab";
+/**
+ * Describes the fields for the tab search configuration in a query. A tab search defines a special distribution which is evaluated
+ * as a part of query to group the results by a set of tab items. The distribution gives the count of documents
+ * associated with each tab item. The values associated with a tab item are used to filter a query when a tab item is selected.
+ */
+export type CCTabSearch = {
+    /**
+     * Determines whether this tab search is used in a query
+     */
+    isActive: boolean;
+    /**
+     * Defines the column to be used in the tab distribution and for filtering results by a selected tab item
+     */
+    column: string;
+    /**
+     * `true` if the associated column is a tree
+     */
+    columnIsTree: boolean;
+    /**
+     * Determines whether the overall document total should be calculated from the per-tab item documents totals
+     */
+    totalIsSumOfTabTotals: boolean;
+    /**
+     * Determines whether configured aggregations should be evaluated in the context of the selected tab or not.
+     * This setting can be overridden at the tab item level using [CCTab.excludedAggregations]{@link CCTab#excludedAggregations}
+     */
+    loadAggregationsForSelectedTab: boolean;
+    /**
+     * Determines the `minlevel` value to use when evaluating the tab distribution for a tree column
+     */
+    valueLevels: number;
+    /**
+     * Determines whether `post-group-by=true` should be used in the tab distribution
+     */
+    postGroupBy: boolean;
+    /**
+     * Determines whether 'merge-groups=true` should be used in the tab distribution. This is only used if `postGroupBy` is set to `true`
+     */
+    mergeGroups: boolean;
+    /**
+     * The set of configured tab items
+     */
+    tabs: CCTab[];
+};
+//# sourceMappingURL=CCTabSearch.d.ts.map

package/dist/types/config/CCTabSearch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CCTabSearch.d.ts","sourceRoot":"","sources":["../../../src/types/config/CCTabSearch.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG;IACtB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAC;IAC/B;;;OAGG;IACH,8BAA8B,EAAE,OAAO,CAAC;IACxC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,IAAI,EAAE,KAAK,EAAE,CAAC;CACjB,CAAA"}

package/dist/types/config/CCWebService.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Describes the fields available in all web service configuration objects
+ */
+import { CCConfig } from "./CCConfig";
+declare const VALUES: readonly ["query", "sponsoredlinks", "queryexport", "preview", "labels", "autocomplete", "dataset"];
+export type CCWebService = CCConfig & {
+    webServiceType: typeof VALUES[number];
+};
+export {};
+//# sourceMappingURL=CCWebService.d.ts.map

package/dist/types/config/CCWebService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CCWebService.d.ts","sourceRoot":"","sources":["../../../src/types/config/CCWebService.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,QAAA,MAAM,MAAM,qGAAsG,CAAC;AAEnH,MAAM,MAAM,YAAY,GAAG,QAAQ,GAAG;IAClC,cAAc,EAAE,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC;CACzC,CAAC"}

package/dist/types/config/EngineType.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Defines the range of column types for a column
+ */
+export declare enum EngineType {
+    none = 0,
+    bool = 1,
+    date = 2,
+    dateTime = 3,
+    time = 4,
+    unsigned = 5,
+    integer = 6,
+    float = 7,
+    double = 8,
+    dates = 9,
+    dateTimes = 10,
+    times = 11,
+    varchar = 12,
+    binary = 13,
+    string = 14,
+    csv = 15
+}
+//# sourceMappingURL=EngineType.d.ts.map

package/dist/types/config/EngineType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EngineType.d.ts","sourceRoot":"","sources":["../../../src/types/config/EngineType.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,oBAAY,UAAU;IAClB,IAAI,IAAI;IACR,IAAI,IAAI;IACR,IAAI,IAAI;IACR,QAAQ,IAAI;IACZ,IAAI,IAAI;IACR,QAAQ,IAAI;IACZ,OAAO,IAAI;IACX,KAAK,IAAI;IACT,MAAM,IAAI;IACV,KAAK,IAAI;IACT,SAAS,KAAK;IACd,KAAK,KAAK;IACV,OAAO,KAAK;IACZ,MAAM,KAAK;IACX,MAAM,KAAK;IACX,GAAG,KAAK;CACX"}

package/dist/types/config/EngineTypeModifier.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Defines the type modifiers that can be used for a column
+ */
+export declare enum EngineTypeModifier {
+    none = 0,
+    a = 2053,
+    c = 4,
+    d = 8,
+    e = 2068,
+    i = 256,
+    l = 2052,
+    n = 8192,
+    t = 524292,
+    x = 8388608,
+    z = 33554432,
+    f_ordinal = 8192,
+    f_multidates = 8192,
+    f_varchar = 33554432,
+    f_binary = 33562624,
+    f_string = 33562888,
+    f_csv = 42477853,
+    f_overridable = 33554696
+}
+//# sourceMappingURL=EngineTypeModifier.d.ts.map

package/dist/types/config/EngineTypeModifier.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EngineTypeModifier.d.ts","sourceRoot":"","sources":["../../../src/types/config/EngineTypeModifier.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,oBAAY,kBAAkB;IAC1B,IAAI,IAAI;IACR,CAAC,OAAO;IAGR,CAAC,IAAI;IACL,CAAC,IAAI;IACL,CAAC,OAAO;IAOR,CAAC,MAAM;IAGP,CAAC,OAAO;IAGR,CAAC,OAAO;IAMR,CAAC,SAAS;IAOV,CAAC,UAAU;IAEX,CAAC,WAAW;IAEZ,SAAS,OAAO;IAChB,YAAY,OAAO;IACnB,SAAS,WAAW;IACpB,QAAQ,WAAW;IACnB,QAAQ,WAAW;IACnB,KAAK,WAAW;IAEhB,aAAa,WAAW;CAC3B"}

package/dist/types/config/ExportDialogModel.d.ts

@@ -0,0 +1,13 @@
+import { ExportOutputFormat } from "./ExportOutputFormat";
+import { ExportSourceType } from "./ExportSourceType";
+/**
+ * Data model of the Export dialog.
+ */
+export interface ExportDialogModel {
+    format: ExportOutputFormat;
+    export: ExportSourceType;
+    webService: string;
+    maxCount?: number;
+    queryName?: string;
+}
+//# sourceMappingURL=ExportDialogModel.d.ts.map

package/dist/types/config/ExportDialogModel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExportDialogModel.d.ts","sourceRoot":"","sources":["../../../src/types/config/ExportDialogModel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD;;GAEG;AAGH,MAAM,WAAW,iBAAiB;IAC9B,MAAM,EAAE,kBAAkB,CAAC;IAC3B,MAAM,EAAE,gBAAgB,CAAC;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB"}

package/dist/types/config/ExportOutputFormat.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Enum representing supported export format.
+ */
+export declare enum ExportOutputFormat {
+    None = 0,
+    Csv = 1,
+    Xlsx = 2,
+    Json = 4
+}
+//# sourceMappingURL=ExportOutputFormat.d.ts.map

package/dist/types/config/ExportOutputFormat.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExportOutputFormat.d.ts","sourceRoot":"","sources":["../../../src/types/config/ExportOutputFormat.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,oBAAY,kBAAkB;IAC1B,IAAI,IAAI;IACR,GAAG,IAAI;IACP,IAAI,IAAI;IACR,IAAI,IAAI;CACX"}

package/dist/types/config/ExportSourceType.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Enum representing supported export source.
+ */
+export declare enum ExportSourceType {
+    None = 0,
+    Result = 1,
+    Selection = 2,
+    SavedQuery = 4
+}
+//# sourceMappingURL=ExportSourceType.d.ts.map

package/dist/types/config/ExportSourceType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExportSourceType.d.ts","sourceRoot":"","sources":["../../../src/types/config/ExportSourceType.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,oBAAY,gBAAgB;IACxB,IAAI,IAAI;IACR,MAAM,IAAI;IACV,SAAS,IAAI;IACb,UAAU,IAAI;CACjB"}

package/dist/types/config/QueryPrecision.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Defines different precision operators that can be automatically added to a `text contains` clause
+ * when no precision operators are present.
+ *
+ * `Default` - no operators are added
+ *
+ * `ExactExpression` - text surrounded by `"..."`
+ *
+ * `InTheSamePhrase` - text surrounded by `[...]`
+ *
+ * `EveryWord` - text surrounded by `+(...)`
+ */
+export type QueryPrecision = "Default" | "ExactExpression" | "InTheSamePhrase" | "EveryWord";
+//# sourceMappingURL=QueryPrecision.d.ts.map

package/dist/types/config/QueryPrecision.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"QueryPrecision.d.ts","sourceRoot":"","sources":["../../../src/types/config/QueryPrecision.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,cAAc,GAAG,SAAS,GAAG,iBAAiB,GAAG,iBAAiB,GAAG,WAAW,CAAC"}

package/dist/types/config/QueryStrategy.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Defines strategies that can used in the query search parameters. Each strategy defines a pair of word weight (`ww`) and meaning
+ * weight (`mw`) values to be used.
+ *
+ * `Default` - no `ww` and `mw` parameters used
+ *
+ * `WordsOnly` - `ww=1;mw=0`
+ *
+ * `WordsFirst` - `ww=0.8;mw=0.2`
+ *
+ * `WordsAndMeaning` - `ww=0.6;mw=0.4`
+ *
+ * `MeaningFirst` - `ww=0.3;mw=0.7`
+ *
+ * `MeaningOnly` - `ww=0;mw=1`
+ */
+export type QueryStrategy = "Default" | "WordsOnly" | "WordsFirst" | "WordsAndMeaning" | "MeaningFirst" | "MeaningOnly";
+//# sourceMappingURL=QueryStrategy.d.ts.map

package/dist/types/config/QueryStrategy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"QueryStrategy.d.ts","sourceRoot":"","sources":["../../../src/types/config/QueryStrategy.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,MAAM,MAAM,aAAa,GACrB,SAAS,GACT,WAAW,GACX,YAAY,GACZ,iBAAiB,GACjB,cAAc,GACd,aAAa,CAAC"}

package/dist/types/config/SpellingCorrectionMode.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Defines modes for the spelling correction of search terms and did-you-mean functionality. Corrections
+ * are based on edit and phonetic distance and exist among the searched documents
+ *
+ * `default | classic` - corrections are sought for terms that are not present in any documents. The original terms
+ * and corrections are included in the query
+ *
+ * `smart` - corrections are sought for terms that are present in less than 10 documents and where the correction
+ * is 20 times more frequent than the original term. Only the best corrections are kept. The original terms and corrections
+ * are included in the query. The [Results.didYouMean]{@link Results#didYouMean] member is populated allowing for a "We included
+ * results for these terms..." feedback to be displayed
+ *
+ * `correct` - corrections are sought for terms that are present in less than 10 documents and where the correction is
+ * 20 times more frequent than the original term. Only the best corrections are kept. The original terms that have corrections
+ * are not included in the query. The [Results.didYouMean]{@link Results#didYouMean] member is populated allowing for a "Your query
+ * has been corrected to..." feedback to be displayed
+ *
+ * `dymonly` - corrections are sought for terms that are present in less than 10 documents and where the correction is
+ * 20 times more frequent than the original term. The actual query is unaffected but the
+ * [Results.didYouMean]{@link Results#didYouMean] member will be populated allowing for a "Did you mean..." feedback to be
+ * displayed
+ *
+ * `force` - corrections are sought for all terms. All terms and corrections are included in the query
+ *
+ * `false` - no spelling correction processing occurs
+ */
+export type SpellingCorrectionMode = "default" | "classic" | "smart" | "correct" | "dymonly" | "force" | "false";
+//# sourceMappingURL=SpellingCorrectionMode.d.ts.map

package/dist/types/config/SpellingCorrectionMode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SpellingCorrectionMode.d.ts","sourceRoot":"","sources":["../../../src/types/config/SpellingCorrectionMode.ts"],"names":[],"mappings":"AACA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAEH,MAAM,MAAM,sBAAsB,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,GAAG,OAAO,CAAC"}

package/dist/types/config/index.d.ts

@@ -0,0 +1,34 @@
+/**
+ * The minimum server api version that compatible with this version of SBA.
+ */
+export declare const MINIMUM_COMPATIBLE_SERVER_API_VERSION = "1.0";
+export type { CCApp } from "./CCApp";
+export type { CCAppRefresh } from "./CCAppRefresh";
+export type { CCAppPreLogin } from "./CCAppPreLogin";
+export type { CCAggregation } from "./CCAggregation";
+export type { CCAutocomplete } from "./CCAutocomplete";
+export type { CCColumn } from "./CCColumn";
+export type { CCColumnInfo } from "./CCColumnInfo";
+export type { CCColumnsInfo } from "./CCColumnsInfo";
+export type { CCConfig } from "./CCConfig";
+export type { CCIndex } from "./CCIndex";
+export type { CCLabels } from "./CCLabels";
+export type { CCList } from "./CCList";
+export type { CCListItem } from "./CCListItem";
+export type { CCQuery } from "./CCQuery";
+export type { CCRFM } from "./CCRFM";
+export type { CCRFMAction } from "./CCRFMAction";
+export type { CCScope } from "./CCScope";
+export type { CCSortingChoice } from "./CCSortingChoice";
+export type { CCTab } from "./CCTab";
+export type { CCTabSearch } from "./CCTabSearch";
+export type { CCWebService } from "./CCWebService";
+export type { EngineType } from "./EngineType";
+export type { EngineTypeModifier } from "./EngineTypeModifier";
+export type { ExportDialogModel } from "./ExportDialogModel";
+export type { ExportOutputFormat } from "./ExportOutputFormat";
+export type { ExportSourceType } from "./ExportSourceType";
+export type { QueryPrecision } from "./QueryPrecision";
+export type { QueryStrategy } from "./QueryStrategy";
+export type { SpellingCorrectionMode } from "./SpellingCorrectionMode";
+//# sourceMappingURL=index.d.ts.map

package/dist/types/config/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/config/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,qCAAqC,QAAQ,CAAC;AAE3D,YAAY,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AACrC,YAAY,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,YAAY,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,YAAY,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,YAAY,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD,YAAY,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,YAAY,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,YAAY,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,YAAY,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,YAAY,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACzC,YAAY,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C,YAAY,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,YAAY,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,YAAY,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC,YAAY,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AACrC,YAAY,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAEjD,YAAY,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACzC,YAAY,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,YAAY,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AACrC,YAAY,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAEjD,YAAY,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,YAAY,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,YAAY,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,YAAY,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,YAAY,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,YAAY,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,YAAY,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,YAAY,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,YAAY,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC"}

package/dist/types/credentials.d.ts

@@ -0,0 +1,5 @@
+export type Credentials = {
+    username: string;
+    password: string;
+};
+//# sourceMappingURL=credentials.d.ts.map

package/dist/types/credentials.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"credentials.d.ts","sourceRoot":"","sources":["../../src/types/credentials.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAA"}

package/dist/types/filters/BetweenFilter.d.ts

@@ -0,0 +1,7 @@
+import { Filter } from "./Filter";
+export type BetweenFilter = Omit<Filter, "value"> & {
+    operator: 'between';
+    start: string | number;
+    end: string | number;
+};
+//# sourceMappingURL=BetweenFilter.d.ts.map

package/dist/types/filters/BetweenFilter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BetweenFilter.d.ts","sourceRoot":"","sources":["../../../src/types/filters/BetweenFilter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,MAAM,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IAClD,QAAQ,EAAE,SAAS,CAAC;IACpB,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;IACvB,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;CACtB,CAAA"}

package/dist/types/filters/ExprFilter.d.ts

@@ -0,0 +1,6 @@
+import { Filter, FilterExprOperator } from "./Filter";
+export type ExprFilter = Omit<Filter, "field" | "value"> & {
+    operator: FilterExprOperator;
+    filters: Filter[];
+};
+//# sourceMappingURL=ExprFilter.d.ts.map

package/dist/types/filters/ExprFilter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExprFilter.d.ts","sourceRoot":"","sources":["../../../src/types/filters/ExprFilter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAEtD,MAAM,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,GAAG;IACzD,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB,CAAA"}

package/dist/types/filters/Filter.d.ts

@@ -0,0 +1,10 @@
+export type FilterScalarOperator = 'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte' | 'like' | 'contains' | 'regex' | 'null' | 'notnull';
+export type FilterRangeOperator = 'in' | 'between';
+export type FilterExprOperator = 'and' | 'or' | 'not';
+export type FilterOperator = FilterScalarOperator | FilterRangeOperator | FilterExprOperator;
+export type Filter = {
+    field?: string;
+    operator?: FilterOperator;
+    value?: string | number | boolean;
+};
+//# sourceMappingURL=Filter.d.ts.map

package/dist/types/filters/Filter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Filter.d.ts","sourceRoot":"","sources":["../../../src/types/filters/Filter.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,oBAAoB,GAC5B,IAAI,GACJ,KAAK,GACL,IAAI,GACJ,KAAK,GACL,IAAI,GACJ,KAAK,GACL,MAAM,GACN,UAAU,GACV,OAAO,GACP,MAAM,GACN,SAAS,CAAC;AACd,MAAM,MAAM,mBAAmB,GAAG,IAAI,GAAG,SAAS,CAAC;AACnD,MAAM,MAAM,kBAAkB,GAAG,KAAK,GAAG,IAAI,GAAG,KAAK,CAAC;AACtD,MAAM,MAAM,cAAc,GAAG,oBAAoB,GAAG,mBAAmB,GAAG,kBAAkB,CAAC;AAE7F,MAAM,MAAM,MAAM,GAAG;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,cAAc,CAAC;IAC1B,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;CACnC,CAAA"}

package/dist/types/filters/InFilter.d.ts

@@ -0,0 +1,6 @@
+import { Filter } from "./Filter";
+export type InFilter = Omit<Filter, "value"> & {
+    operator: 'in';
+    values: string[];
+};
+//# sourceMappingURL=InFilter.d.ts.map

package/dist/types/filters/InFilter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"InFilter.d.ts","sourceRoot":"","sources":["../../../src/types/filters/InFilter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,MAAM,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IAC7C,QAAQ,EAAE,IAAI,CAAC;IACf,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB,CAAA"}

package/dist/types/filters/NotNullFilter.d.ts

@@ -0,0 +1,5 @@
+import { Filter } from ".";
+export type NotNullFilter = Omit<Filter, "value"> & {
+    operator: 'notnull';
+};
+//# sourceMappingURL=NotNullFilter.d.ts.map

package/dist/types/filters/NotNullFilter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NotNullFilter.d.ts","sourceRoot":"","sources":["../../../src/types/filters/NotNullFilter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,GAAG,CAAC;AAE3B,MAAM,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IAClD,QAAQ,EAAE,SAAS,CAAC;CACrB,CAAA"}

package/dist/types/filters/NullFilter.d.ts

@@ -0,0 +1,5 @@
+import { Filter } from ".";
+export type NullFilter = Omit<Filter, "value"> & {
+    operator: 'null';
+};
+//# sourceMappingURL=NullFilter.d.ts.map

package/dist/types/filters/NullFilter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NullFilter.d.ts","sourceRoot":"","sources":["../../../src/types/filters/NullFilter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,GAAG,CAAC;AAE3B,MAAM,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IAC/C,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAA"}

package/dist/types/filters/SimpleFilter.d.ts

@@ -0,0 +1,5 @@
+import { Filter, FilterScalarOperator } from "./Filter";
+export type SimpleFilter = Filter & {
+    operator: FilterScalarOperator;
+};
+//# sourceMappingURL=SimpleFilter.d.ts.map

package/dist/types/filters/SimpleFilter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SimpleFilter.d.ts","sourceRoot":"","sources":["../../../src/types/filters/SimpleFilter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAExD,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG;IAClC,QAAQ,EAAE,oBAAoB,CAAC;CAChC,CAAA"}

package/dist/types/filters/index.d.ts

@@ -0,0 +1,9 @@
+export type { BetweenFilter } from './BetweenFilter';
+export type { ExprFilter } from './ExprFilter';
+export type { Filter, FilterExprOperator, FilterOperator, FilterRangeOperator, FilterScalarOperator } from './Filter';
+export type { InFilter } from './InFilter';
+export type { NotNullFilter } from './NotNullFilter';
+export type { NullFilter } from './NullFilter';
+export type { SimpleFilter } from './SimpleFilter';
+export type { LegacyFilter } from './legacy-filters';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/filters/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/filters/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,YAAY,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,cAAc,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AACtH,YAAY,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,YAAY,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,YAAY,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,YAAY,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,YAAY,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC"}

package/dist/types/filters/legacy-filters.d.ts

@@ -0,0 +1,13 @@
+import { FilterOperator } from "./Filter";
+export type LegacyFilter = {
+    name?: string;
+    display?: string;
+    field?: string;
+    filters?: LegacyFilter | LegacyFilter[];
+    operator?: FilterOperator;
+    values?: string[];
+    value?: string;
+    start?: string | number;
+    end?: string | number;
+};
+//# sourceMappingURL=legacy-filters.d.ts.map

package/dist/types/filters/legacy-filters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"legacy-filters.d.ts","sourceRoot":"","sources":["../../../src/types/filters/legacy-filters.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAE1C,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,YAAY,GAAG,YAAY,EAAE,CAAC;IACxC,QAAQ,CAAC,EAAE,cAAc,CAAC;IAC1B,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACxB,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACvB,CAAA"}

package/dist/types/index.d.ts

@@ -0,0 +1,16 @@
+export * from "./aggregations";
+export * from "./audit";
+export * from "./config";
+export * from "./filters";
+export * from "./interfaces";
+export * from "./link-results";
+export * from "./preview";
+export * from "./principal";
+export * from "./search";
+export * from "./suggest/suggestion";
+export * from "./user-settings/user-settings";
+export * from "./chunks";
+export * from "./labels/label-rights";
+export * from "./api-endpoints";
+export * from "./credentials";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,sBAAsB,CAAC;AACrC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,UAAU,CAAC;AACzB,cAAc,uBAAuB,CAAC;AAEtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC"}

package/dist/types/interfaces/Open.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Defines the object used to request the children of a tree node in an aggregation
+ */
+export interface Open {
+    /**
+     * The fielded search expression of the filter used to request the tree node children. For example: `treepath:/folder1/folder2/*`
+     */
+    expression: string;
+    /**
+     * The name of the associated aggregation
+     */
+    aggregation: string;
+}
+//# sourceMappingURL=Open.d.ts.map

package/dist/types/interfaces/Open.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Open.d.ts","sourceRoot":"","sources":["../../../src/types/interfaces/Open.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB"}

package/dist/types/interfaces/Query.d.ts

@@ -0,0 +1,136 @@
+/**
+ * Describes the query object that can be passed to the {@link QueryWebService}
+ */
+import { AggregationOptions } from "../aggregations";
+import { SpellingCorrectionMode } from "../config";
+import { ExprFilter, LegacyFilter } from "../filters";
+import { Open } from "./Open";
+import { Select } from "./Select";
+export type Query = {
+    /**
+     * The name of the query web service configuration object
+     */
+    name: string;
+    /**
+     * The full text of the query
+     */
+    text?: string;
+    /**
+     * Defines the action that can be performed with this query.
+     *
+     * `search` - This action performs a standard search that returns document results and aggregation values. This is the default action
+     *
+     * `open` - Processes the objects specified in the `open` member. This is used to expand tree aggregation nodes
+     *
+     * `aggregate` - Processes the objects specified in the `aggregations` member. This is used to provide pagination of aggregation values
+     */
+    action?: "" | "search" | "open" | "aggregate";
+    /**
+     * Specifies conditions applied by the user to filter their search results
+     */
+    filters?: LegacyFilter | LegacyFilter[] | ExprFilter;
+    /**
+     * Specifies selection-based filtering for this query, typically from UI facets
+     */
+    select?: Select[];
+    /**
+     * Specifies the tree aggregation nodes whose children should be returned (using the `open` action)
+     */
+    open?: Open[];
+    /**
+     * Specifies the starting page for the document results. Defaults to 1
+     */
+    page?: number;
+    /**
+     * Specifies the page size size for the document results
+     */
+    pageSize?: number;
+    /**
+     * Specifies the name of the current tab selection for the query. See {@link CCTabSearch}
+     */
+    tab?: string;
+    /**
+     * Specifies the name of the current scope selection for the query. See {@link CCScope}
+     */
+    scope?: string;
+    /**
+     * Specifies the name of the current sort selection for the query. See {@link CCSortingChoice}
+     */
+    sort?: string;
+    /**
+     * Specifies the name of a basket of document results to retrieve. If specified then the search results will be
+     * trimmed to only contain documents included in the specified basket
+     */
+    basket?: string;
+    /**
+     * If set then no document results will be returned but aggregations results will be returned. This is typically used
+     * to provide aggregation results on a home page or to retrieve values to be used in advanced search components
+     */
+    isFirstPage?: boolean;
+    /**
+     * Determines results can only include documents that were in the results set prior to the addition of a filter.
+     * In some circumstances the addition of a filter can enlarge the set of matching documents.
+     * For example, the addition of search terms using the "refine" facet
+     */
+    strictRefine?: boolean;
+    /**
+     * Sets the relevance threshold for document to appear in the results. This is a number between 0 and 100.
+     */
+    globalRelevance?: number;
+    /**
+     * Sets the language to be used to interpret search terms
+     */
+    questionLanguage?: string;
+    /**
+     * Sets the language to be used to interpret search terms if `questionLanguage` is not set and the
+     * language cannot be determined automatically
+     */
+    questionDefaultLanguage?: string;
+    /**
+     * Sets the spelling correction mode
+     */
+    spellingCorrectionMode?: SpellingCorrectionMode;
+    /**
+     * Sets a regular expression filter on which terms to consider for spelling corrections
+     */
+    spellingCorrectionFilter?: string;
+    /**
+     * Sets the value for the `DocumentWeight` clause to be added to the query
+     */
+    documentWeight?: string;
+    /**
+     * Sets the value for the `TextPartWeights` clause to be added to the query
+     */
+    textPartWeights?: string;
+    /**
+     * Sets the value for the `RelevanceTransforms` clause to be added to the query
+     */
+    relevanceTransforms?: string;
+    /**
+     * Determines whether duplicate documents should be filtered from the results. Duplicate document detection
+     * requires either nearhash or exacthash values to be calculated in the indexes.
+     */
+    removeDuplicates?: boolean;
+    /**
+     * Sets the query id for the query. This is used in "strict refine" mode and is normally populated from the
+     * results attributes
+     */
+    queryId?: string;
+    /**
+     * Specifies the aggregations to include when `action` is set to `aggregate`
+     */
+    aggregations?: Record<string, AggregationOptions> | string[];
+    /**
+     * Specifies a value for the `ORDER BY` clause of the query
+     */
+    orderBy?: string;
+    /**
+     * Specifies a value for the `GROUP BY` clause of the query
+     */
+    groupBy?: string;
+    /**
+     * Whether to activate neural search or not (default is true, if neural search is available)
+     */
+    neuralSearch?: boolean;
+};
+//# sourceMappingURL=Query.d.ts.map