@interopio/search-api
Version:
Glue42 Search API
1,300 lines (1,280 loc) • 95.9 kB
JavaScript
/* @ts-self-types="./index.d.ts" */
let urlAlphabet =
'useandom-26T198340PX75pxJACKVERYMINDBUSHWOLF_GQZbfghjklqvwyzrict';
let nanoid = (size = 21) => {
let id = '';
let i = size | 0;
while (i--) {
id += urlAlphabet[(Math.random() * 64) | 0];
}
return id
};
function getDefaultExportFromCjs (x) {
return x && x.__esModule && Object.prototype.hasOwnProperty.call(x, 'default') ? x['default'] : x;
}
function createRegistry(options) {
if (options && options.errorHandling
&& typeof options.errorHandling !== "function"
&& options.errorHandling !== "log"
&& options.errorHandling !== "silent"
&& options.errorHandling !== "throw") {
throw new Error("Invalid options passed to createRegistry. Prop errorHandling should be [\"log\" | \"silent\" | \"throw\" | (err) => void], but " + typeof options.errorHandling + " was passed");
}
var _userErrorHandler = options && typeof options.errorHandling === "function" && options.errorHandling;
var callbacks = {};
function add(key, callback, replayArgumentsArr) {
var callbacksForKey = callbacks[key];
if (!callbacksForKey) {
callbacksForKey = [];
callbacks[key] = callbacksForKey;
}
callbacksForKey.push(callback);
if (replayArgumentsArr) {
setTimeout(function () {
replayArgumentsArr.forEach(function (replayArgument) {
var _a;
if ((_a = callbacks[key]) === null || _a === void 0 ? void 0 : _a.includes(callback)) {
try {
if (Array.isArray(replayArgument)) {
callback.apply(undefined, replayArgument);
}
else {
callback.apply(undefined, [replayArgument]);
}
}
catch (err) {
_handleError(err, key);
}
}
});
}, 0);
}
return function () {
var allForKey = callbacks[key];
if (!allForKey) {
return;
}
allForKey = allForKey.reduce(function (acc, element, index) {
if (!(element === callback && acc.length === index)) {
acc.push(element);
}
return acc;
}, []);
if (allForKey.length === 0) {
delete callbacks[key];
}
else {
callbacks[key] = allForKey;
}
};
}
function execute(key) {
var argumentsArr = [];
for (var _i = 1; _i < arguments.length; _i++) {
argumentsArr[_i - 1] = arguments[_i];
}
var callbacksForKey = callbacks[key];
if (!callbacksForKey || callbacksForKey.length === 0) {
return [];
}
var results = [];
callbacksForKey.forEach(function (callback) {
try {
var result = callback.apply(undefined, argumentsArr);
results.push(result);
}
catch (err) {
results.push(undefined);
_handleError(err, key);
}
});
return results;
}
function _handleError(exceptionArtifact, key) {
var errParam = exceptionArtifact instanceof Error ? exceptionArtifact : new Error(exceptionArtifact);
if (_userErrorHandler) {
_userErrorHandler(errParam);
return;
}
var msg = "[ERROR] callback-registry: User callback for key \"" + key + "\" failed: " + errParam.stack;
if (options) {
switch (options.errorHandling) {
case "log":
return console.error(msg);
case "silent":
return;
case "throw":
throw new Error(msg);
}
}
console.error(msg);
}
function clear() {
callbacks = {};
}
function clearKey(key) {
var callbacksForKey = callbacks[key];
if (!callbacksForKey) {
return;
}
delete callbacks[key];
}
return {
add: add,
execute: execute,
clear: clear,
clearKey: clearKey
};
}
createRegistry.default = createRegistry;
var lib = createRegistry;
var CallbackRegistryFactory = /*@__PURE__*/getDefaultExportFromCjs(lib);
const SEARCH_QUERY_STATUSES = {
done: "done",
inProgress: "in-progress",
error: "error"
};
const CLIENT_TO_PROVIDER_PROTOCOL_OPERATIONS = {
info: "info",
search: "search",
cancel: "cancel"
};
/**
* Wraps values in an `Ok` type.
*
* Example: `ok(5) // => {ok: true, result: 5}`
*/
var ok = function (result) { return ({ ok: true, result: result }); };
/**
* Wraps errors in an `Err` type.
*
* Example: `err('on fire') // => {ok: false, error: 'on fire'}`
*/
var err = function (error) { return ({ ok: false, error: error }); };
/**
* Create a `Promise` that either resolves with the result of `Ok` or rejects
* with the error of `Err`.
*/
var asPromise = function (r) {
return r.ok === true ? Promise.resolve(r.result) : Promise.reject(r.error);
};
/**
* Unwraps a `Result` and returns either the result of an `Ok`, or
* `defaultValue`.
*
* Example:
* ```
* Result.withDefault(5, number().run(json))
* ```
*
* It would be nice if `Decoder` had an instance method that mirrored this
* function. Such a method would look something like this:
* ```
* class Decoder<A> {
* runWithDefault = (defaultValue: A, json: any): A =>
* Result.withDefault(defaultValue, this.run(json));
* }
*
* number().runWithDefault(5, json)
* ```
* Unfortunately, the type of `defaultValue: A` on the method causes issues
* with type inference on the `object` decoder in some situations. While these
* inference issues can be solved by providing the optional type argument for
* `object`s, the extra trouble and confusion doesn't seem worth it.
*/
var withDefault = function (defaultValue, r) {
return r.ok === true ? r.result : defaultValue;
};
/**
* Return the successful result, or throw an error.
*/
var withException = function (r) {
if (r.ok === true) {
return r.result;
}
else {
throw r.error;
}
};
/**
* Apply `f` to the result of an `Ok`, or pass the error through.
*/
var map = function (f, r) {
return r.ok === true ? ok(f(r.result)) : r;
};
/**
* Apply `f` to the result of two `Ok`s, or pass an error through. If both
* `Result`s are errors then the first one is returned.
*/
var map2 = function (f, ar, br) {
return ar.ok === false ? ar :
br.ok === false ? br :
ok(f(ar.result, br.result));
};
/**
* Apply `f` to the error of an `Err`, or pass the success through.
*/
var mapError = function (f, r) {
return r.ok === true ? r : err(f(r.error));
};
/**
* Chain together a sequence of computations that may fail, similar to a
* `Promise`. If the first computation fails then the error will propagate
* through. If it succeeds, then `f` will be applied to the value, returning a
* new `Result`.
*/
var andThen = function (f, r) {
return r.ok === true ? f(r.result) : r;
};
/*! *****************************************************************************
Copyright (c) Microsoft Corporation.
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS SOFTWARE.
***************************************************************************** */
/* global Reflect, Promise */
var __assign = function() {
__assign = Object.assign || function __assign(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
function __rest(s, e) {
var t = {};
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
t[p] = s[p];
if (s != null && typeof Object.getOwnPropertySymbols === "function")
for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
t[p[i]] = s[p[i]];
}
return t;
}
function isEqual(a, b) {
if (a === b) {
return true;
}
if (a === null && b === null) {
return true;
}
if (typeof (a) !== typeof (b)) {
return false;
}
if (typeof (a) === 'object') {
// Array
if (Array.isArray(a)) {
if (!Array.isArray(b)) {
return false;
}
if (a.length !== b.length) {
return false;
}
for (var i = 0; i < a.length; i++) {
if (!isEqual(a[i], b[i])) {
return false;
}
}
return true;
}
// Hash table
var keys = Object.keys(a);
if (keys.length !== Object.keys(b).length) {
return false;
}
for (var i = 0; i < keys.length; i++) {
if (!b.hasOwnProperty(keys[i])) {
return false;
}
if (!isEqual(a[keys[i]], b[keys[i]])) {
return false;
}
}
return true;
}
}
/*
* Helpers
*/
var isJsonArray = function (json) { return Array.isArray(json); };
var isJsonObject = function (json) {
return typeof json === 'object' && json !== null && !isJsonArray(json);
};
var typeString = function (json) {
switch (typeof json) {
case 'string':
return 'a string';
case 'number':
return 'a number';
case 'boolean':
return 'a boolean';
case 'undefined':
return 'undefined';
case 'object':
if (json instanceof Array) {
return 'an array';
}
else if (json === null) {
return 'null';
}
else {
return 'an object';
}
default:
return JSON.stringify(json);
}
};
var expectedGot = function (expected, got) {
return "expected " + expected + ", got " + typeString(got);
};
var printPath = function (paths) {
return paths.map(function (path) { return (typeof path === 'string' ? "." + path : "[" + path + "]"); }).join('');
};
var prependAt = function (newAt, _a) {
var at = _a.at, rest = __rest(_a, ["at"]);
return (__assign({ at: newAt + (at || '') }, rest));
};
/**
* Decoders transform json objects with unknown structure into known and
* verified forms. You can create objects of type `Decoder<A>` with either the
* primitive decoder functions, such as `boolean()` and `string()`, or by
* applying higher-order decoders to the primitives, such as `array(boolean())`
* or `dict(string())`.
*
* Each of the decoder functions are available both as a static method on
* `Decoder` and as a function alias -- for example the string decoder is
* defined at `Decoder.string()`, but is also aliased to `string()`. Using the
* function aliases exported with the library is recommended.
*
* `Decoder` exposes a number of 'run' methods, which all decode json in the
* same way, but communicate success and failure in different ways. The `map`
* and `andThen` methods modify decoders without having to call a 'run' method.
*
* Alternatively, the main decoder `run()` method returns an object of type
* `Result<A, DecoderError>`. This library provides a number of helper
* functions for dealing with the `Result` type, so you can do all the same
* things with a `Result` as with the decoder methods.
*/
var Decoder = /** @class */ (function () {
/**
* The Decoder class constructor is kept private to separate the internal
* `decode` function from the external `run` function. The distinction
* between the two functions is that `decode` returns a
* `Partial<DecoderError>` on failure, which contains an unfinished error
* report. When `run` is called on a decoder, the relevant series of `decode`
* calls is made, and then on failure the resulting `Partial<DecoderError>`
* is turned into a `DecoderError` by filling in the missing information.
*
* While hiding the constructor may seem restrictive, leveraging the
* provided decoder combinators and helper functions such as
* `andThen` and `map` should be enough to build specialized decoders as
* needed.
*/
function Decoder(decode) {
var _this = this;
this.decode = decode;
/**
* Run the decoder and return a `Result` with either the decoded value or a
* `DecoderError` containing the json input, the location of the error, and
* the error message.
*
* Examples:
* ```
* number().run(12)
* // => {ok: true, result: 12}
*
* string().run(9001)
* // =>
* // {
* // ok: false,
* // error: {
* // kind: 'DecoderError',
* // input: 9001,
* // at: 'input',
* // message: 'expected a string, got 9001'
* // }
* // }
* ```
*/
this.run = function (json) {
return mapError(function (error) { return ({
kind: 'DecoderError',
input: json,
at: 'input' + (error.at || ''),
message: error.message || ''
}); }, _this.decode(json));
};
/**
* Run the decoder as a `Promise`.
*/
this.runPromise = function (json) { return asPromise(_this.run(json)); };
/**
* Run the decoder and return the value on success, or throw an exception
* with a formatted error string.
*/
this.runWithException = function (json) { return withException(_this.run(json)); };
/**
* Construct a new decoder that applies a transformation to the decoded
* result. If the decoder succeeds then `f` will be applied to the value. If
* it fails the error will propagated through.
*
* Example:
* ```
* number().map(x => x * 5).run(10)
* // => {ok: true, result: 50}
* ```
*/
this.map = function (f) {
return new Decoder(function (json) { return map(f, _this.decode(json)); });
};
/**
* Chain together a sequence of decoders. The first decoder will run, and
* then the function will determine what decoder to run second. If the result
* of the first decoder succeeds then `f` will be applied to the decoded
* value. If it fails the error will propagate through.
*
* This is a very powerful method -- it can act as both the `map` and `where`
* methods, can improve error messages for edge cases, and can be used to
* make a decoder for custom types.
*
* Example of adding an error message:
* ```
* const versionDecoder = valueAt(['version'], number());
* const infoDecoder3 = object({a: boolean()});
*
* const decoder = versionDecoder.andThen(version => {
* switch (version) {
* case 3:
* return infoDecoder3;
* default:
* return fail(`Unable to decode info, version ${version} is not supported.`);
* }
* });
*
* decoder.run({version: 3, a: true})
* // => {ok: true, result: {a: true}}
*
* decoder.run({version: 5, x: 'abc'})
* // =>
* // {
* // ok: false,
* // error: {... message: 'Unable to decode info, version 5 is not supported.'}
* // }
* ```
*
* Example of decoding a custom type:
* ```
* // nominal type for arrays with a length of at least one
* type NonEmptyArray<T> = T[] & { __nonEmptyArrayBrand__: void };
*
* const nonEmptyArrayDecoder = <T>(values: Decoder<T>): Decoder<NonEmptyArray<T>> =>
* array(values).andThen(arr =>
* arr.length > 0
* ? succeed(createNonEmptyArray(arr))
* : fail(`expected a non-empty array, got an empty array`)
* );
* ```
*/
this.andThen = function (f) {
return new Decoder(function (json) {
return andThen(function (value) { return f(value).decode(json); }, _this.decode(json));
});
};
/**
* Add constraints to a decoder _without_ changing the resulting type. The
* `test` argument is a predicate function which returns true for valid
* inputs. When `test` fails on an input, the decoder fails with the given
* `errorMessage`.
*
* ```
* const chars = (length: number): Decoder<string> =>
* string().where(
* (s: string) => s.length === length,
* `expected a string of length ${length}`
* );
*
* chars(5).run('12345')
* // => {ok: true, result: '12345'}
*
* chars(2).run('HELLO')
* // => {ok: false, error: {... message: 'expected a string of length 2'}}
*
* chars(12).run(true)
* // => {ok: false, error: {... message: 'expected a string, got a boolean'}}
* ```
*/
this.where = function (test, errorMessage) {
return _this.andThen(function (value) { return (test(value) ? Decoder.succeed(value) : Decoder.fail(errorMessage)); });
};
}
/**
* Decoder primitive that validates strings, and fails on all other input.
*/
Decoder.string = function () {
return new Decoder(function (json) {
return typeof json === 'string'
? ok(json)
: err({ message: expectedGot('a string', json) });
});
};
/**
* Decoder primitive that validates numbers, and fails on all other input.
*/
Decoder.number = function () {
return new Decoder(function (json) {
return typeof json === 'number'
? ok(json)
: err({ message: expectedGot('a number', json) });
});
};
/**
* Decoder primitive that validates booleans, and fails on all other input.
*/
Decoder.boolean = function () {
return new Decoder(function (json) {
return typeof json === 'boolean'
? ok(json)
: err({ message: expectedGot('a boolean', json) });
});
};
Decoder.constant = function (value) {
return new Decoder(function (json) {
return isEqual(json, value)
? ok(value)
: err({ message: "expected " + JSON.stringify(value) + ", got " + JSON.stringify(json) });
});
};
Decoder.object = function (decoders) {
return new Decoder(function (json) {
if (isJsonObject(json) && decoders) {
var obj = {};
for (var key in decoders) {
if (decoders.hasOwnProperty(key)) {
var r = decoders[key].decode(json[key]);
if (r.ok === true) {
// tslint:disable-next-line:strict-type-predicates
if (r.result !== undefined) {
obj[key] = r.result;
}
}
else if (json[key] === undefined) {
return err({ message: "the key '" + key + "' is required but was not present" });
}
else {
return err(prependAt("." + key, r.error));
}
}
}
return ok(obj);
}
else if (isJsonObject(json)) {
return ok(json);
}
else {
return err({ message: expectedGot('an object', json) });
}
});
};
Decoder.array = function (decoder) {
return new Decoder(function (json) {
if (isJsonArray(json) && decoder) {
var decodeValue_1 = function (v, i) {
return mapError(function (err$$1) { return prependAt("[" + i + "]", err$$1); }, decoder.decode(v));
};
return json.reduce(function (acc, v, i) {
return map2(function (arr, result) { return arr.concat([result]); }, acc, decodeValue_1(v, i));
}, ok([]));
}
else if (isJsonArray(json)) {
return ok(json);
}
else {
return err({ message: expectedGot('an array', json) });
}
});
};
Decoder.tuple = function (decoders) {
return new Decoder(function (json) {
if (isJsonArray(json)) {
if (json.length !== decoders.length) {
return err({
message: "expected a tuple of length " + decoders.length + ", got one of length " + json.length
});
}
var result = [];
for (var i = 0; i < decoders.length; i++) {
var nth = decoders[i].decode(json[i]);
if (nth.ok) {
result[i] = nth.result;
}
else {
return err(prependAt("[" + i + "]", nth.error));
}
}
return ok(result);
}
else {
return err({ message: expectedGot("a tuple of length " + decoders.length, json) });
}
});
};
Decoder.union = function (ad, bd) {
var decoders = [];
for (var _i = 2; _i < arguments.length; _i++) {
decoders[_i - 2] = arguments[_i];
}
return Decoder.oneOf.apply(Decoder, [ad, bd].concat(decoders));
};
Decoder.intersection = function (ad, bd) {
var ds = [];
for (var _i = 2; _i < arguments.length; _i++) {
ds[_i - 2] = arguments[_i];
}
return new Decoder(function (json) {
return [ad, bd].concat(ds).reduce(function (acc, decoder) { return map2(Object.assign, acc, decoder.decode(json)); }, ok({}));
});
};
/**
* Escape hatch to bypass validation. Always succeeds and types the result as
* `any`. Useful for defining decoders incrementally, particularly for
* complex objects.
*
* Example:
* ```
* interface User {
* name: string;
* complexUserData: ComplexType;
* }
*
* const userDecoder: Decoder<User> = object({
* name: string(),
* complexUserData: anyJson()
* });
* ```
*/
Decoder.anyJson = function () { return new Decoder(function (json) { return ok(json); }); };
/**
* Decoder identity function which always succeeds and types the result as
* `unknown`.
*/
Decoder.unknownJson = function () {
return new Decoder(function (json) { return ok(json); });
};
/**
* Decoder for json objects where the keys are unknown strings, but the values
* should all be of the same type.
*
* Example:
* ```
* dict(number()).run({chocolate: 12, vanilla: 10, mint: 37});
* // => {ok: true, result: {chocolate: 12, vanilla: 10, mint: 37}}
* ```
*/
Decoder.dict = function (decoder) {
return new Decoder(function (json) {
if (isJsonObject(json)) {
var obj = {};
for (var key in json) {
if (json.hasOwnProperty(key)) {
var r = decoder.decode(json[key]);
if (r.ok === true) {
obj[key] = r.result;
}
else {
return err(prependAt("." + key, r.error));
}
}
}
return ok(obj);
}
else {
return err({ message: expectedGot('an object', json) });
}
});
};
/**
* Decoder for values that may be `undefined`. This is primarily helpful for
* decoding interfaces with optional fields.
*
* Example:
* ```
* interface User {
* id: number;
* isOwner?: boolean;
* }
*
* const decoder: Decoder<User> = object({
* id: number(),
* isOwner: optional(boolean())
* });
* ```
*/
Decoder.optional = function (decoder) {
return new Decoder(function (json) { return (json === undefined || json === null ? ok(undefined) : decoder.decode(json)); });
};
/**
* Decoder that attempts to run each decoder in `decoders` and either succeeds
* with the first successful decoder, or fails after all decoders have failed.
*
* Note that `oneOf` expects the decoders to all have the same return type,
* while `union` creates a decoder for the union type of all the input
* decoders.
*
* Examples:
* ```
* oneOf(string(), number().map(String))
* oneOf(constant('start'), constant('stop'), succeed('unknown'))
* ```
*/
Decoder.oneOf = function () {
var decoders = [];
for (var _i = 0; _i < arguments.length; _i++) {
decoders[_i] = arguments[_i];
}
return new Decoder(function (json) {
var errors = [];
for (var i = 0; i < decoders.length; i++) {
var r = decoders[i].decode(json);
if (r.ok === true) {
return r;
}
else {
errors[i] = r.error;
}
}
var errorsList = errors
.map(function (error) { return "at error" + (error.at || '') + ": " + error.message; })
.join('", "');
return err({
message: "expected a value matching one of the decoders, got the errors [\"" + errorsList + "\"]"
});
});
};
/**
* Decoder that always succeeds with either the decoded value, or a fallback
* default value.
*/
Decoder.withDefault = function (defaultValue, decoder) {
return new Decoder(function (json) {
return ok(withDefault(defaultValue, decoder.decode(json)));
});
};
/**
* Decoder that pulls a specific field out of a json structure, instead of
* decoding and returning the full structure. The `paths` array describes the
* object keys and array indices to traverse, so that values can be pulled out
* of a nested structure.
*
* Example:
* ```
* const decoder = valueAt(['a', 'b', 0], string());
*
* decoder.run({a: {b: ['surprise!']}})
* // => {ok: true, result: 'surprise!'}
*
* decoder.run({a: {x: 'cats'}})
* // => {ok: false, error: {... at: 'input.a.b[0]' message: 'path does not exist'}}
* ```
*
* Note that the `decoder` is ran on the value found at the last key in the
* path, even if the last key is not found. This allows the `optional`
* decoder to succeed when appropriate.
* ```
* const optionalDecoder = valueAt(['a', 'b', 'c'], optional(string()));
*
* optionalDecoder.run({a: {b: {c: 'surprise!'}}})
* // => {ok: true, result: 'surprise!'}
*
* optionalDecoder.run({a: {b: 'cats'}})
* // => {ok: false, error: {... at: 'input.a.b.c' message: 'expected an object, got "cats"'}
*
* optionalDecoder.run({a: {b: {z: 1}}})
* // => {ok: true, result: undefined}
* ```
*/
Decoder.valueAt = function (paths, decoder) {
return new Decoder(function (json) {
var jsonAtPath = json;
for (var i = 0; i < paths.length; i++) {
if (jsonAtPath === undefined) {
return err({
at: printPath(paths.slice(0, i + 1)),
message: 'path does not exist'
});
}
else if (typeof paths[i] === 'string' && !isJsonObject(jsonAtPath)) {
return err({
at: printPath(paths.slice(0, i + 1)),
message: expectedGot('an object', jsonAtPath)
});
}
else if (typeof paths[i] === 'number' && !isJsonArray(jsonAtPath)) {
return err({
at: printPath(paths.slice(0, i + 1)),
message: expectedGot('an array', jsonAtPath)
});
}
else {
jsonAtPath = jsonAtPath[paths[i]];
}
}
return mapError(function (error) {
return jsonAtPath === undefined
? { at: printPath(paths), message: 'path does not exist' }
: prependAt(printPath(paths), error);
}, decoder.decode(jsonAtPath));
});
};
/**
* Decoder that ignores the input json and always succeeds with `fixedValue`.
*/
Decoder.succeed = function (fixedValue) {
return new Decoder(function (json) { return ok(fixedValue); });
};
/**
* Decoder that ignores the input json and always fails with `errorMessage`.
*/
Decoder.fail = function (errorMessage) {
return new Decoder(function (json) { return err({ message: errorMessage }); });
};
/**
* Decoder that allows for validating recursive data structures. Unlike with
* functions, decoders assigned to variables can't reference themselves
* before they are fully defined. We can avoid prematurely referencing the
* decoder by wrapping it in a function that won't be called until use, at
* which point the decoder has been defined.
*
* Example:
* ```
* interface Comment {
* msg: string;
* replies: Comment[];
* }
*
* const decoder: Decoder<Comment> = object({
* msg: string(),
* replies: lazy(() => array(decoder))
* });
* ```
*/
Decoder.lazy = function (mkDecoder) {
return new Decoder(function (json) { return mkDecoder().decode(json); });
};
return Decoder;
}());
/* tslint:disable:variable-name */
/** See `Decoder.string` */
var string = Decoder.string;
/** See `Decoder.number` */
var number = Decoder.number;
/** See `Decoder.boolean` */
Decoder.boolean;
/** See `Decoder.anyJson` */
var anyJson = Decoder.anyJson;
/** See `Decoder.unknownJson` */
Decoder.unknownJson;
/** See `Decoder.constant` */
var constant = Decoder.constant;
/** See `Decoder.object` */
var object = Decoder.object;
/** See `Decoder.array` */
var array = Decoder.array;
/** See `Decoder.tuple` */
Decoder.tuple;
/** See `Decoder.dict` */
Decoder.dict;
/** See `Decoder.optional` */
var optional = Decoder.optional;
/** See `Decoder.oneOf` */
var oneOf = Decoder.oneOf;
/** See `Decoder.union` */
Decoder.union;
/** See `Decoder.intersection` */
Decoder.intersection;
/** See `Decoder.withDefault` */
Decoder.withDefault;
/** See `Decoder.valueAt` */
Decoder.valueAt;
/** See `Decoder.succeed` */
Decoder.succeed;
/** See `Decoder.fail` */
Decoder.fail;
/** See `Decoder.lazy` */
Decoder.lazy;
const nonEmptyStringDecoder = string().where((s) => s.length > 0, "Expected a non-empty string");
const nonNegativeNumberDecoder = number().where((num) => num >= 0, "Expected a non-negative number");
const searchTypeDecoder = object({
name: nonEmptyStringDecoder,
displayName: optional(nonEmptyStringDecoder)
});
const providerData = object({
id: nonEmptyStringDecoder,
interopId: nonEmptyStringDecoder,
name: nonEmptyStringDecoder,
appName: optional(nonEmptyStringDecoder),
types: optional(array(searchTypeDecoder))
});
const providerLimitsDecoder = object({
maxResults: optional(nonNegativeNumberDecoder),
maxResultsPerType: optional(nonNegativeNumberDecoder)
});
const queryConfigDecoder = object({
search: nonEmptyStringDecoder,
providers: optional(array(providerData)),
types: optional(array(searchTypeDecoder)),
providerLimits: optional(providerLimitsDecoder)
});
const providerRegistrationConfig = object({
name: nonEmptyStringDecoder,
types: optional(array(searchTypeDecoder))
});
const operationDecoder = oneOf(constant("cancel"), constant("info"), constant("search"));
const queryStatusDecoder = oneOf(constant("done"), constant("in-progress"), constant("error"));
const searchCancelRequestDecoder = object({
id: nonEmptyStringDecoder
});
const mainActionDecoder = object({
method: nonEmptyStringDecoder,
target: optional(oneOf(object({ instance: nonEmptyStringDecoder }), constant("all"))),
params: optional(anyJson())
});
const secondaryActionDecoder = object({
name: nonEmptyStringDecoder,
method: nonEmptyStringDecoder,
target: optional(oneOf(object({ instance: nonEmptyStringDecoder }), constant("all"))),
params: optional(anyJson())
});
const queryResultDecoder = object({
type: searchTypeDecoder,
id: optional(nonEmptyStringDecoder),
displayName: optional(nonEmptyStringDecoder),
description: optional(nonEmptyStringDecoder),
iconURL: optional(nonEmptyStringDecoder),
metadata: optional(anyJson()),
action: optional(mainActionDecoder),
secondaryActions: optional(array(secondaryActionDecoder))
});
const legacySearchResultItemDecoder = object({
type: string(),
category: optional(string()),
id: optional(string()),
displayName: optional(string()),
description: optional(string()),
iconURL: optional(string()),
action: optional(mainActionDecoder)
});
const protocolSearchResultsBatchDecoder = object({
items: array(oneOf(queryResultDecoder, legacySearchResultItemDecoder)),
provider: optional(providerData),
queryId: nonEmptyStringDecoder,
status: constant("in-progress")
});
const protocolSearchCompletedDecoder = object({
items: array(oneOf(queryResultDecoder, legacySearchResultItemDecoder)),
queryId: nonEmptyStringDecoder,
status: constant("done")
});
const protocolProviderErrorDecoder = object({
items: array(oneOf(queryResultDecoder, legacySearchResultItemDecoder)),
provider: optional(providerData),
queryId: nonEmptyStringDecoder,
errorMessage: nonEmptyStringDecoder,
status: constant("error")
});
class ClientController {
logger;
glueController;
modelFactory;
registry = CallbackRegistryFactory();
activeQueryLookup = {};
queryIdToMasterIdLookup = {};
pendingDebounce = [];
debounceTimer;
debounceMS = 0;
constructor(logger, glueController, modelFactory) {
this.logger = logger;
this.glueController = glueController;
this.modelFactory = modelFactory;
}
setDebounceMS(data) {
this.logger.info(`[${data.commandId}] Setting the debounceMS to: ${data.milliseconds}`);
this.debounceMS = data.milliseconds;
this.logger.info(`[${data.commandId}] debounceMS set to: ${data.milliseconds}`);
}
getDebounceMS(data) {
this.logger.info(`[${data.commandId}] Getting the debounceMS`);
return this.debounceMS;
}
async query(data, skipDebounce) {
if (this.debounceMS && !skipDebounce) {
return this.debounceQuery(data);
}
await this.glueController.registerMainClientMethod(this.handleProviderCall.bind(this));
const { queryConfig, commandId } = data;
this.logger.info(`[${commandId}] Initiating a query request`);
let allProvidersInfo = await this.glueController.getAllProvidersInfo();
this.logger.trace(`[${commandId}] Got all available providers: ${JSON.stringify(allProvidersInfo)}`);
if (queryConfig.providers) {
this.logger.info(`[${commandId}] Filtering providers by explicitly allowed providers.`);
allProvidersInfo = this.filterProvidersByAllowList(allProvidersInfo, queryConfig.providers);
}
if (queryConfig.types) {
this.logger.info(`[${commandId}] Filtering providers by explicitly allowed types.`);
allProvidersInfo = this.filterProvidersByAllowedTypes(allProvidersInfo, queryConfig.types);
}
if (!allProvidersInfo.length) {
this.logger.warn(`[${commandId}] There are no providers that can handle the query for ${data.queryConfig.search}`);
}
this.logger.info(`[${commandId}] Sending query request to providers: ${JSON.stringify(allProvidersInfo)}`);
const allQueryResponses = await this.glueController.sendQueryRequest(queryConfig, allProvidersInfo);
this.logger.info(`[${commandId}] Received responses from the providers: ${JSON.stringify(allQueryResponses)}`);
const masterQueryId = this.generateMasterQueryId();
const queryModel = this.modelFactory.buildClientQueryModel(masterQueryId, this);
this.logger.info(`[${commandId}] The query is in progress with master id: ${masterQueryId}`);
this.activeQueryLookup[masterQueryId] = {
servers: allQueryResponses,
model: queryModel
};
allQueryResponses.forEach((response) => {
this.queryIdToMasterIdLookup[response.queryId] = masterQueryId;
});
if (!allQueryResponses.length) {
setTimeout(() => {
this.registry.execute(`on-query-completed-${masterQueryId}`);
this.cleanUpQuery(masterQueryId);
}, 0);
}
return queryModel.exposeFacade();
}
async cancelQuery(masterQueryId, commandId) {
const activeQuery = this.activeQueryLookup[masterQueryId];
if (!activeQuery) {
throw new Error(`[${commandId}] Cannot cancel query: ${masterQueryId}, because this query does not exist`);
}
const interopIds = activeQuery.servers;
this.logger.info(`[${commandId}] Sending cancel query requests`);
await Promise.all(interopIds.map((serverId) => {
this.logger.trace(`[${commandId}] Sending cancel query request to ${serverId.interopId} with queryId: ${serverId.queryId}`);
return this.glueController.sendQueryCancelRequest({ id: serverId.queryId }, { instance: serverId.interopId });
}));
this.logger.info(`[${commandId}] The query was cancelled`);
}
processClientOnResults(data) {
return this.registry.add(`on-query-results-${data.masterQueryId}`, data.callback);
}
processClientOnCompleted(data) {
return this.registry.add(`on-query-completed-${data.masterQueryId}`, data.callback);
}
processClientOnError(data) {
return this.registry.add(`on-query-error-${data.masterQueryId}`, data.callback);
}
async handleProviderCall(args) {
const { status } = args;
const validatedOperation = queryStatusDecoder.runWithException(status);
const commandId = nanoid(10);
switch (validatedOperation) {
case SEARCH_QUERY_STATUSES.done:
return this.handleQueryCompleted({ completedConfig: args, commandId });
case SEARCH_QUERY_STATUSES.inProgress:
return this.handleQueryResults({ resultsBatch: args, commandId });
case SEARCH_QUERY_STATUSES.error:
return this.handleQueryError({ error: args, commandId });
default:
throw new Error(`Unrecognized status: ${status}`);
}
}
handleQueryResults(data) {
const { resultsBatch, commandId } = data;
this.logger.trace(`[${commandId}] Processing a results batch from provider: ${resultsBatch.provider?.name} with id: ${resultsBatch.provider?.id}`);
const verifiedResultsBatch = protocolSearchResultsBatchDecoder.runWithException(resultsBatch);
const masterQueryId = this.queryIdToMasterIdLookup[verifiedResultsBatch.queryId];
if (!masterQueryId) {
this.logger.warn(`[${commandId}] Received results for an unknown query. Provider ${JSON.stringify(verifiedResultsBatch.provider)}, items: ${JSON.stringify(verifiedResultsBatch.items)}`);
return;
}
this.logger.trace(`[${commandId}] The results batch is validated, forwarding to the callbacks`);
const translatedResults = this.checkTransformLegacyResults(verifiedResultsBatch.items);
const results = {
provider: verifiedResultsBatch.provider,
results: translatedResults
};
this.registry.execute(`on-query-results-${masterQueryId}`, results);
}
handleQueryCompleted(data) {
const { completedConfig, commandId } = data;
this.logger.trace(`[${commandId}] Processing a query completed message from query id: ${completedConfig.queryId}`);
const verifiedCompleteConfig = protocolSearchCompletedDecoder.runWithException(completedConfig);
const masterQueryId = this.queryIdToMasterIdLookup[verifiedCompleteConfig.queryId];
if (!masterQueryId) {
this.logger.warn(`[${commandId}] Received completed message for an unknown query. Provider query id: ${JSON.stringify(verifiedCompleteConfig.queryId)}`);
return;
}
if (verifiedCompleteConfig.items.length) {
const translatedResults = this.checkTransformLegacyResults(verifiedCompleteConfig.items);
const results = {
results: translatedResults
};
this.registry.execute(`on-query-results-${masterQueryId}`, results);
}
delete this.queryIdToMasterIdLookup[verifiedCompleteConfig.queryId];
const activeQuery = this.activeQueryLookup[masterQueryId];
activeQuery.servers = activeQuery.servers.filter((server) => server.queryId !== verifiedCompleteConfig.queryId);
if (activeQuery.servers.length) {
this.logger.trace(`[${commandId}] Waiting for more providers to complete`);
return;
}
this.logger.trace(`[${commandId}] All providers are done, marking this query as completed`);
this.registry.execute(`on-query-completed-${masterQueryId}`);
this.cleanUpQuery(masterQueryId);
}
handleQueryError(data) {
const { error, commandId } = data;
this.logger.trace(`[${commandId}] Processing an error message from query: ${error.queryId}`);
const validatedError = protocolProviderErrorDecoder.runWithException(error);
const masterQueryId = this.queryIdToMasterIdLookup[validatedError.queryId];
if (!masterQueryId) {
this.logger.warn(`[${commandId}] Received error message for an unknown query. Provider query id: ${JSON.stringify(validatedError.queryId)} and message: ${JSON.stringify(validatedError.errorMessage)}`);
return;
}
const queryError = {
error: validatedError.errorMessage,
provider: validatedError.provider
};
this.registry.execute(`on-query-error-${masterQueryId}`, queryError);
}
filterProvidersByAllowList(servers, allowed) {
const allowedLookup = allowed.reduce((lookup, allowedEntry) => {
lookup[allowedEntry.id] = true;
return lookup;
}, {});
return servers.filter((server) => {
const serverProviders = server.info.providers;
return serverProviders.some((provider) => allowedLookup[provider.id]);
});
}
filterProvidersByAllowedTypes(servers, allowed) {
const allowedLookup = allowed.reduce((lookup, allowedEntry) => {
lookup[allowedEntry.name] = true;
return lookup;
}, {});
return servers.filter((server) => {
const allTypes = server.info.supportedTypes;
if (allTypes.some((searchType) => searchType === "*")) {
return true;
}
if (!allTypes || !allTypes.length) {
return true;
}
return allTypes.some((supportedType) => allowedLookup[supportedType]);
});
}
generateMasterQueryId() {
const queryId = nanoid(10);
if (this.activeQueryLookup[queryId]) {
return this.generateMasterQueryId();
}
return queryId;
}
cleanUpQuery(masterQueryId) {
this.registry.clearKey(`on-query-results-${masterQueryId}`);
this.registry.clearKey(`on-query-completed-${masterQueryId}`);
this.registry.clearKey(`on-query-error-${masterQueryId}`);
delete this.activeQueryLookup[masterQueryId];
}
debounceQuery(data) {
return new Promise((res, rej) => {
clearTimeout(this.debounceTimer);
this.debounceTimer = setTimeout(() => {
const currentPending = [...this.pendingDebounce];
this.pendingDebounce = [];
this.query(data, true)
.then((query) => currentPending.forEach(({ resolve }) => resolve(query)))
.catch((error) => currentPending.forEach(({ reject }) => reject(error)));
}, this.debounceMS);
this.pendingDebounce.push({ resolve: res, reject: rej });
});
}
checkTransformLegacyResults(items) {
if (!items.length) {
return [];
}
const sampleItem = items[0];
if (!sampleItem || typeof sampleItem.type === "object") {
return items;
}
return items.map((item) => {
return {
type: { name: item.type, displayName: item.category },
id: item.id,
displayName: item.displayName,
description: item.description,
iconURL: item.iconURL,
action: item.action
};
});
}
}
const MAIN_PROVIDER_METHOD_NAME = "T42.Search.Provider";
const MAIN_CLIENT_METHOD_NAME = "T42.Search.Client";
const SEQUELIZER_INTERVAL_MS = 10;
const FLUSH_SEQUELIZER_INTERVAL_MS = 10;
const FLUSH_TIMEOUT_MS = 100;
const STALE_QUERY_TIMEOUT_MS = 900000;
class GlueController {
glue;
constructor(glue) {
this.glue = glue;
}
get myAppName() {
return this.glue.interop.instance.applicationName;
}
get myInteropId() {
return this.glue.interop.instance.instance;
}
async registerMainProviderMethod(handler) {
const mainMethodStatus = this.checkMyMethodExists(MAIN_PROVIDER_METHOD_NAME);
if (mainMethodStatus.exists) {
return;
}
await this.glue.interop.register(MAIN_PROVIDER_METHOD_NAME, handler);
}
async registerMainClientMethod(handler) {
const mainMethodStatus = this.checkMyMethodExists(MAIN_CLIENT_METHOD_NAME);
if (mainMethodStatus.exists) {
return;
}
await this.glue.interop.register(MAIN_CLIENT_METHOD_NAME, handler);
}
async clearMainProviderMethod() {
await this.glue.interop.unregister(MAIN_PROVIDER_METHOD_NAME);
}
async sendClientResultsBatch(batch, clientInstanceId, queryId) {
const interopArguments = {
items: batch.results,
provider: batch.provider,
queryId,
status: SEARCH_QUERY_STATUSES.inProgress
};
await this.glue.interop.invoke(MAIN_CLIENT_METHOD_NAME, interopArguments, { instance: clientInstanceId });
}
async sendClientQueueCompleted(clientInstanceId, queryId) {
const interopArguments = {
items: [],
queryId,
status: SEARCH_QUERY_STATUSES.done
};
await this.glue.interop.invoke(MAIN_CLIENT_METHOD_NAME, interopArguments, { instance: clientInstanceId });
}
async sendClientErrorMessage(error, clientInstanceId, queryId, provider) {
const interopArguments = {
items: [],
provider,