react-datocms 3.0.15 → 3.1.0

package/dist/cjs/index.js

@@ -14,4 +14,5 @@ __exportStar(require("./Image/index"), exports);
 __exportStar(require("./Seo/index"), exports);
 __exportStar(require("./useQuerySubscription/index"), exports);
 __exportStar(require("./StructuredText/index"), exports);
+__exportStar(require("./useSiteSearch/index"), exports);
 //# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,gDAA8B;AAC9B,8CAA4B;AAC5B,+DAA6C;AAC7C,yDAAuC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,gDAA8B;AAC9B,8CAA4B;AAC5B,+DAA6C;AAC7C,yDAAuC;AACvC,wDAAsC"}

package/dist/cjs/useQuerySubscription/index.js

@@ -66,11 +66,11 @@ function useQuerySubscription(options) {
     var enabled = options.enabled, initialData = options.initialData, other = __rest(options, ["enabled", "initialData"]);
     var _a = (0, react_1.useState)(null), error = _a[0], setError = _a[1];
     var _b = (0, react_1.useState)(null), data = _b[0], setData = _b[1];
-    var _c = (0, react_1.useState)(enabled ? "connecting" : "closed"), status = _c[0], setStatus = _c[1];
+    var _c = (0, react_1.useState)(enabled ? 'connecting' : 'closed'), status = _c[0], setStatus = _c[1];
     var subscribeToQueryOptions = other;
     (0, use_deep_compare_effect_1.useDeepCompareEffectNoCheck)(function () {
         if (enabled === false) {
-            setStatus("closed");
+            setStatus('closed');
             return function () {
                 // we don't have to perform any uninstall
             };

package/dist/cjs/useSiteSearch/index.js

@@ -0,0 +1,192 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(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);
+};
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+exports.__esModule = true;
+exports.useSiteSearch = void 0;
+var react_1 = __importStar(require("react"));
+var react_string_replace_1 = __importDefault(require("react-string-replace"));
+var defaultHighlighter = function (text, key) { return (react_1["default"].createElement("mark", { key: key }, text)); };
+function MatchHighlighter(_a) {
+    var children = _a.children, highlighter = _a.highlighter, context = _a.context;
+    return (react_1["default"].createElement(react_1["default"].Fragment, null, (0, react_string_replace_1["default"])(children, /\[h\](.+?)\[\/h\]/g, function (match, index) {
+        return highlighter(match, index.toString(), context);
+    })));
+}
+function useSiteSearch(config) {
+    var _this = this;
+    var _a, _b, _c;
+    var _d = (0, react_1.useState)({
+        query: ((_a = config.initialState) === null || _a === void 0 ? void 0 : _a.query) || '',
+        page: ((_b = config.initialState) === null || _b === void 0 ? void 0 : _b.page) || 0,
+        locale: (_c = config.initialState) === null || _c === void 0 ? void 0 : _c.locale
+    }), state = _d[0], setState = _d[1];
+    var _e = (0, react_1.useState)(), error = _e[0], setError = _e[1];
+    var _f = (0, react_1.useState)(), response = _f[0], setResponse = _f[1];
+    var resultsPerPage = config.resultsPerPage || 8;
+    (0, react_1.useEffect)(function () {
+        var isCancelled = false;
+        var run = function () { return __awaiter(_this, void 0, void 0, function () {
+            var response_1, e_1;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        setError(undefined);
+                        if (!state.query) {
+                            setResponse({ data: [], meta: { total_count: 0 } });
+                            return [2 /*return*/];
+                        }
+                        setResponse(undefined);
+                        return [4 /*yield*/, config.client.searchResults.rawList({
+                                filter: {
+                                    query: state.query,
+                                    locale: state.locale,
+                                    build_trigger_id: config.buildTriggerId
+                                },
+                                page: {
+                                    limit: resultsPerPage,
+                                    offset: resultsPerPage * state.page
+                                }
+                            })];
+                    case 1:
+                        response_1 = _a.sent();
+                        if (!isCancelled) {
+                            setResponse(response_1);
+                        }
+                        return [3 /*break*/, 3];
+                    case 2:
+                        e_1 = _a.sent();
+                        if (isCancelled) {
+                            return [2 /*return*/];
+                        }
+                        if (e_1 instanceof Error) {
+                            setError(e_1.message);
+                        }
+                        else {
+                            setError('Unknown error!');
+                        }
+                        return [3 /*break*/, 3];
+                    case 3: return [2 /*return*/];
+                }
+            });
+        }); };
+        run();
+        return function () {
+            isCancelled = true;
+        };
+    }, [
+        resultsPerPage,
+        state,
+        config.buildTriggerId,
+        config.client.config.apiToken,
+    ]);
+    var publicSetQuery = (0, react_1.useCallback)(function (newQuery) {
+        setState(function (oldState) { return (__assign(__assign({}, oldState), { query: newQuery, page: 0 })); });
+    }, [setState]);
+    var publicSetPage = (0, react_1.useCallback)(function (newPage) {
+        setState(function (oldState) { return (__assign(__assign({}, oldState), { page: newPage })); });
+    }, [setState]);
+    var publicSetLocale = (0, react_1.useCallback)(function (newLocale) {
+        setState(function (oldState) { return (__assign(__assign({}, oldState), { locale: newLocale, page: 0 })); });
+    }, [setState]);
+    var highlighter = config.highlightMatch || defaultHighlighter;
+    return {
+        state: {
+            query: state.query,
+            setQuery: publicSetQuery,
+            page: state.page,
+            setPage: publicSetPage,
+            locale: state.locale,
+            setLocale: publicSetLocale
+        },
+        error: error,
+        data: state.query === ''
+            ? {
+                pageResults: [],
+                totalResults: 0,
+                totalPages: 0
+            }
+            : response
+                ? {
+                    pageResults: response.data.map(function (rawSearchResult) { return ({
+                        id: rawSearchResult.id,
+                        url: rawSearchResult.attributes.url,
+                        title: rawSearchResult.attributes.highlight.title ? (react_1["default"].createElement(MatchHighlighter, { highlighter: highlighter, context: "title" }, rawSearchResult.attributes.highlight.title[0])) : (rawSearchResult.attributes.title),
+                        bodyExcerpt: rawSearchResult.attributes.highlight.body ? (react_1["default"].createElement(MatchHighlighter, { highlighter: highlighter, context: "bodyExcerpt" }, rawSearchResult.attributes.highlight.body[0])) : (rawSearchResult.attributes.body_excerpt),
+                        raw: rawSearchResult
+                    }); }),
+                    totalResults: response.meta.total_count,
+                    totalPages: Math.ceil(response.meta.total_count / resultsPerPage)
+                }
+                : undefined
+    };
+}
+exports.useSiteSearch = useSiteSearch;
+//# sourceMappingURL=index.js.map

package/dist/cjs/useSiteSearch/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/useSiteSearch/index.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAAgE;AAChE,8EAAsD;AA+FtD,IAAM,kBAAkB,GAAgB,UAAC,IAAI,EAAE,GAAG,IAAK,OAAA,CACrD,2CAAM,GAAG,EAAE,GAAG,IAAG,IAAI,CAAQ,CAC9B,EAFsD,CAEtD,CAAC;AAEF,SAAS,gBAAgB,CAAC,EAQzB;QAPC,QAAQ,cAAA,EACR,WAAW,iBAAA,EACX,OAAO,aAAA;IAMP,OAAO,CACL,oEACG,IAAA,iCAAkB,EAAC,QAAQ,EAAE,oBAAoB,EAAE,UAAC,KAAK,EAAE,KAAK;QAC/D,OAAA,WAAW,CAAC,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE,EAAE,OAAO,CAAC;IAA7C,CAA6C,CAC9C,CACA,CACJ,CAAC;AACJ,CAAC;AAED,SAAgB,aAAa,CAC3B,MAAmC;IADrC,iBAgJC;;IA7IO,IAAA,KAAoB,IAAA,gBAAQ,EAI/B;QACD,KAAK,EAAE,CAAA,MAAA,MAAM,CAAC,YAAY,0CAAE,KAAK,KAAI,EAAE;QACvC,IAAI,EAAE,CAAA,MAAA,MAAM,CAAC,YAAY,0CAAE,IAAI,KAAI,CAAC;QACpC,MAAM,EAAE,MAAA,MAAM,CAAC,YAAY,0CAAE,MAAM;KACpC,CAAC,EARK,KAAK,QAAA,EAAE,QAAQ,QAQpB,CAAC;IAEG,IAAA,KAAoB,IAAA,gBAAQ,GAAsB,EAAjD,KAAK,QAAA,EAAE,QAAQ,QAAkC,CAAC;IACnD,IAAA,KAA0B,IAAA,gBAAQ,GAErC,EAFI,QAAQ,QAAA,EAAE,WAAW,QAEzB,CAAC;IAEJ,IAAM,cAAc,GAAG,MAAM,CAAC,cAAc,IAAI,CAAC,CAAC;IAElD,IAAA,iBAAS,EAAC;QACR,IAAI,WAAW,GAAG,KAAK,CAAC;QAExB,IAAM,GAAG,GAAG;;;;;;wBAER,QAAQ,CAAC,SAAS,CAAC,CAAC;wBAEpB,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE;4BAChB,WAAW,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,WAAW,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;4BACpD,sBAAO;yBACR;wBAED,WAAW,CAAC,SAAS,CAAC,CAAC;wBAEN,qBAAM,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC;gCACzD,MAAM,EAAE;oCACN,KAAK,EAAE,KAAK,CAAC,KAAK;oCAClB,MAAM,EAAE,KAAK,CAAC,MAAM;oCACpB,gBAAgB,EAAE,MAAM,CAAC,cAAc;iCACxC;gCACD,IAAI,EAAE;oCACJ,KAAK,EAAE,cAAc;oCACrB,MAAM,EAAE,cAAc,GAAG,KAAK,CAAC,IAAI;iCACpC;6BACF,CAAC,EAAA;;wBAVI,aAAW,SAUf;wBAEF,IAAI,CAAC,WAAW,EAAE;4BAChB,WAAW,CAAC,UAAQ,CAAC,CAAC;yBACvB;;;;wBAED,IAAI,WAAW,EAAE;4BACf,sBAAO;yBACR;wBAED,IAAI,GAAC,YAAY,KAAK,EAAE;4BACtB,QAAQ,CAAC,GAAC,CAAC,OAAO,CAAC,CAAC;yBACrB;6BAAM;4BACL,QAAQ,CAAC,gBAAgB,CAAC,CAAC;yBAC5B;;;;;aAEJ,CAAC;QAEF,GAAG,EAAE,CAAC;QAEN,OAAO;YACL,WAAW,GAAG,IAAI,CAAC;QACrB,CAAC,CAAC;IACJ,CAAC,EAAE;QACD,cAAc;QACd,KAAK;QACL,MAAM,CAAC,cAAc;QACrB,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ;KAC9B,CAAC,CAAC;IAEH,IAAM,cAAc,GAAG,IAAA,mBAAW,EAChC,UAAC,QAAgB;QACf,QAAQ,CAAC,UAAC,QAAQ,IAAK,OAAA,uBAAM,QAAQ,KAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,IAAG,EAA3C,CAA2C,CAAC,CAAC;IACtE,CAAC,EACD,CAAC,QAAQ,CAAC,CACX,CAAC;IAEF,IAAM,aAAa,GAAG,IAAA,mBAAW,EAC/B,UAAC,OAAe;QACd,QAAQ,CAAC,UAAC,QAAQ,IAAK,OAAA,uBAAM,QAAQ,KAAE,IAAI,EAAE,OAAO,IAAG,EAAhC,CAAgC,CAAC,CAAC;IAC3D,CAAC,EACD,CAAC,QAAQ,CAAC,CACX,CAAC;IAEF,IAAM,eAAe,GAAG,IAAA,mBAAW,EACjC,UAAC,SAA6B;QAC5B,QAAQ,CAAC,UAAC,QAAQ,IAAK,OAAA,uBAAM,QAAQ,KAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,IAAG,EAA7C,CAA6C,CAAC,CAAC;IACxE,CAAC,EACD,CAAC,QAAQ,CAAC,CACX,CAAC;IAEF,IAAM,WAAW,GAAG,MAAM,CAAC,cAAc,IAAI,kBAAkB,CAAC;IAEhE,OAAO;QACL,KAAK,EAAE;YACL,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,QAAQ,EAAE,cAAc;YACxB,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,OAAO,EAAE,aAAa;YACtB,MAAM,EAAE,KAAK,CAAC,MAAM;YACpB,SAAS,EAAE,eAAe;SAC3B;QAED,KAAK,OAAA;QACL,IAAI,EACF,KAAK,CAAC,KAAK,KAAK,EAAE;YAChB,CAAC,CAAC;gBACE,WAAW,EAAE,EAAE;gBACf,YAAY,EAAE,CAAC;gBACf,UAAU,EAAE,CAAC;aACd;YACH,CAAC,CAAC,QAAQ;gBACV,CAAC,CAAC;oBACE,WAAW,EAAE,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,UAAC,eAAe,IAAK,OAAA,CAAC;wBACnD,EAAE,EAAE,eAAe,CAAC,EAAE;wBACtB,GAAG,EAAE,eAAe,CAAC,UAAU,CAAC,GAAG;wBACnC,KAAK,EAAE,eAAe,CAAC,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAClD,iCAAC,gBAAgB,IAAC,WAAW,EAAE,WAAW,EAAE,OAAO,EAAC,OAAO,IACxD,eAAe,CAAC,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAC7B,CACpB,CAAC,CAAC,CAAC,CACF,eAAe,CAAC,UAAU,CAAC,KAAK,CACjC;wBACD,WAAW,EAAE,eAAe,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CACvD,iCAAC,gBAAgB,IACf,WAAW,EAAE,WAAW,EACxB,OAAO,EAAC,aAAa,IAEpB,eAAe,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAC5B,CACpB,CAAC,CAAC,CAAC,CACF,eAAe,CAAC,UAAU,CAAC,YAAY,CACxC;wBACD,GAAG,EAAE,eAAe;qBACrB,CAAC,EArBkD,CAqBlD,CAAC;oBACH,YAAY,EAAE,QAAQ,CAAC,IAAI,CAAC,WAAW;oBACvC,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,GAAG,cAAc,CAAC;iBAClE;gBACH,CAAC,CAAC,SAAS;KAChB,CAAC;AACJ,CAAC;AAhJD,sCAgJC"}

package/dist/esm/index.d.ts

@@ -2,3 +2,4 @@ export * from './Image/index';
 export * from './Seo/index';
 export * from './useQuerySubscription/index';
 export * from './StructuredText/index';
+export * from './useSiteSearch/index';

package/dist/esm/index.js

@@ -2,4 +2,5 @@ export * from './Image/index';
 export * from './Seo/index';
 export * from './useQuerySubscription/index';
 export * from './StructuredText/index';
+export * from './useSiteSearch/index';
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,8BAA8B,CAAC;AAC7C,cAAc,wBAAwB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,8BAA8B,CAAC;AAC7C,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC"}

package/dist/esm/useQuerySubscription/index.d.ts

@@ -1,5 +1,5 @@
-import { ChannelErrorData, ConnectionStatus, Options } from "datocms-listen";
-export declare type SubscribeToQueryOptions<QueryResult, QueryVariables> = Omit<Options<QueryResult, QueryVariables>, "onStatusChange" | "onUpdate" | "onChannelError">;
+import { ChannelErrorData, ConnectionStatus, Options } from 'datocms-listen';
+export declare type SubscribeToQueryOptions<QueryResult, QueryVariables> = Omit<Options<QueryResult, QueryVariables>, 'onStatusChange' | 'onUpdate' | 'onChannelError'>;
 export declare type EnabledQueryListenerOptions<QueryResult, QueryVariables> = {
     /** Whether the subscription has to be performed or not */
     enabled?: true;

package/dist/esm/useQuerySubscription/index.js

@@ -56,18 +56,18 @@ var __rest = (this && this.__rest) || function (s, e) {
         }
     return t;
 };
-import { useState } from "react";
-import { subscribeToQuery, } from "datocms-listen";
-import { useDeepCompareEffectNoCheck as useDeepCompareEffect } from "use-deep-compare-effect";
+import { useState } from 'react';
+import { subscribeToQuery, } from 'datocms-listen';
+import { useDeepCompareEffectNoCheck as useDeepCompareEffect } from 'use-deep-compare-effect';
 export function useQuerySubscription(options) {
     var enabled = options.enabled, initialData = options.initialData, other = __rest(options, ["enabled", "initialData"]);
     var _a = useState(null), error = _a[0], setError = _a[1];
     var _b = useState(null), data = _b[0], setData = _b[1];
-    var _c = useState(enabled ? "connecting" : "closed"), status = _c[0], setStatus = _c[1];
+    var _c = useState(enabled ? 'connecting' : 'closed'), status = _c[0], setStatus = _c[1];
     var subscribeToQueryOptions = other;
     useDeepCompareEffect(function () {
         if (enabled === false) {
-            setStatus("closed");
+            setStatus('closed');
             return function () {
                 // we don't have to perform any uninstall
             };

package/dist/esm/useSiteSearch/index.d.ts

@@ -0,0 +1,81 @@
+import React from 'react';
+declare type SearchResultInstancesHrefSchema = {
+    page?: {
+        offset?: number;
+        limit?: number;
+        [k: string]: unknown;
+    };
+    filter: {
+        query: string;
+        build_trigger_id?: string;
+        locale?: string;
+        [k: string]: unknown;
+    };
+    [k: string]: unknown;
+};
+declare type SearchResultInstancesTargetSchema = {
+    data: RawSearchResult[];
+    meta: {
+        total_count: number;
+    };
+};
+export declare type RawSearchResult = {
+    type: 'search_result';
+    id: string;
+    attributes: {
+        title: string;
+        body_excerpt: string;
+        url: string;
+        score: number;
+        highlight: {
+            title?: string[] | null;
+            body?: string[] | null;
+        };
+    };
+};
+declare class GenericClient {
+    config: {
+        apiToken: string | null;
+    };
+    searchResults: {
+        rawList(queryParams: SearchResultInstancesHrefSchema): Promise<SearchResultInstancesTargetSchema>;
+    };
+}
+declare type Highlighter = (match: string, key: string, context: 'title' | 'bodyExcerpt') => React.ReactNode;
+export declare type UseSiteSearchConfig<Client extends GenericClient> = {
+    client: Client;
+    buildTriggerId: string;
+    resultsPerPage?: number;
+    highlightMatch?: Highlighter;
+    initialState?: {
+        locale?: string;
+        page?: number;
+        query?: string;
+    };
+};
+declare type SearchResult = {
+    id: string;
+    title: React.ReactNode;
+    bodyExcerpt: React.ReactNode;
+    url: string;
+    raw: RawSearchResult;
+};
+export declare type UseSiteSearchData = {
+    pageResults: SearchResult[];
+    totalResults: number;
+    totalPages: number;
+};
+export declare type UseSiteSearchResult = {
+    state: {
+        query: string;
+        setQuery: (newQuery: string) => void;
+        locale: string | undefined;
+        setLocale: (newLocale: string) => void;
+        page: number;
+        setPage: (newPage: number) => void;
+    };
+    data?: UseSiteSearchData;
+    error?: string;
+};
+export declare function useSiteSearch<Client extends GenericClient>(config: UseSiteSearchConfig<Client>): UseSiteSearchResult;
+export {};

package/dist/esm/useSiteSearch/index.js

@@ -0,0 +1,166 @@
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(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);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+import React, { useCallback, useEffect, useState } from 'react';
+import reactStringReplace from 'react-string-replace';
+var defaultHighlighter = function (text, key) { return (React.createElement("mark", { key: key }, text)); };
+function MatchHighlighter(_a) {
+    var children = _a.children, highlighter = _a.highlighter, context = _a.context;
+    return (React.createElement(React.Fragment, null, reactStringReplace(children, /\[h\](.+?)\[\/h\]/g, function (match, index) {
+        return highlighter(match, index.toString(), context);
+    })));
+}
+export function useSiteSearch(config) {
+    var _this = this;
+    var _a, _b, _c;
+    var _d = useState({
+        query: ((_a = config.initialState) === null || _a === void 0 ? void 0 : _a.query) || '',
+        page: ((_b = config.initialState) === null || _b === void 0 ? void 0 : _b.page) || 0,
+        locale: (_c = config.initialState) === null || _c === void 0 ? void 0 : _c.locale
+    }), state = _d[0], setState = _d[1];
+    var _e = useState(), error = _e[0], setError = _e[1];
+    var _f = useState(), response = _f[0], setResponse = _f[1];
+    var resultsPerPage = config.resultsPerPage || 8;
+    useEffect(function () {
+        var isCancelled = false;
+        var run = function () { return __awaiter(_this, void 0, void 0, function () {
+            var response_1, e_1;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        setError(undefined);
+                        if (!state.query) {
+                            setResponse({ data: [], meta: { total_count: 0 } });
+                            return [2 /*return*/];
+                        }
+                        setResponse(undefined);
+                        return [4 /*yield*/, config.client.searchResults.rawList({
+                                filter: {
+                                    query: state.query,
+                                    locale: state.locale,
+                                    build_trigger_id: config.buildTriggerId
+                                },
+                                page: {
+                                    limit: resultsPerPage,
+                                    offset: resultsPerPage * state.page
+                                }
+                            })];
+                    case 1:
+                        response_1 = _a.sent();
+                        if (!isCancelled) {
+                            setResponse(response_1);
+                        }
+                        return [3 /*break*/, 3];
+                    case 2:
+                        e_1 = _a.sent();
+                        if (isCancelled) {
+                            return [2 /*return*/];
+                        }
+                        if (e_1 instanceof Error) {
+                            setError(e_1.message);
+                        }
+                        else {
+                            setError('Unknown error!');
+                        }
+                        return [3 /*break*/, 3];
+                    case 3: return [2 /*return*/];
+                }
+            });
+        }); };
+        run();
+        return function () {
+            isCancelled = true;
+        };
+    }, [
+        resultsPerPage,
+        state,
+        config.buildTriggerId,
+        config.client.config.apiToken,
+    ]);
+    var publicSetQuery = useCallback(function (newQuery) {
+        setState(function (oldState) { return (__assign(__assign({}, oldState), { query: newQuery, page: 0 })); });
+    }, [setState]);
+    var publicSetPage = useCallback(function (newPage) {
+        setState(function (oldState) { return (__assign(__assign({}, oldState), { page: newPage })); });
+    }, [setState]);
+    var publicSetLocale = useCallback(function (newLocale) {
+        setState(function (oldState) { return (__assign(__assign({}, oldState), { locale: newLocale, page: 0 })); });
+    }, [setState]);
+    var highlighter = config.highlightMatch || defaultHighlighter;
+    return {
+        state: {
+            query: state.query,
+            setQuery: publicSetQuery,
+            page: state.page,
+            setPage: publicSetPage,
+            locale: state.locale,
+            setLocale: publicSetLocale
+        },
+        error: error,
+        data: state.query === ''
+            ? {
+                pageResults: [],
+                totalResults: 0,
+                totalPages: 0
+            }
+            : response
+                ? {
+                    pageResults: response.data.map(function (rawSearchResult) { return ({
+                        id: rawSearchResult.id,
+                        url: rawSearchResult.attributes.url,
+                        title: rawSearchResult.attributes.highlight.title ? (React.createElement(MatchHighlighter, { highlighter: highlighter, context: "title" }, rawSearchResult.attributes.highlight.title[0])) : (rawSearchResult.attributes.title),
+                        bodyExcerpt: rawSearchResult.attributes.highlight.body ? (React.createElement(MatchHighlighter, { highlighter: highlighter, context: "bodyExcerpt" }, rawSearchResult.attributes.highlight.body[0])) : (rawSearchResult.attributes.body_excerpt),
+                        raw: rawSearchResult
+                    }); }),
+                    totalResults: response.meta.total_count,
+                    totalPages: Math.ceil(response.meta.total_count / resultsPerPage)
+                }
+                : undefined
+    };
+}
+//# sourceMappingURL=index.js.map

package/dist/esm/useSiteSearch/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/useSiteSearch/index.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,KAAK,EAAE,EAAE,WAAW,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAChE,OAAO,kBAAkB,MAAM,sBAAsB,CAAC;AA+FtD,IAAM,kBAAkB,GAAgB,UAAC,IAAI,EAAE,GAAG,IAAK,OAAA,CACrD,8BAAM,GAAG,EAAE,GAAG,IAAG,IAAI,CAAQ,CAC9B,EAFsD,CAEtD,CAAC;AAEF,SAAS,gBAAgB,CAAC,EAQzB;QAPC,QAAQ,cAAA,EACR,WAAW,iBAAA,EACX,OAAO,aAAA;IAMP,OAAO,CACL,0CACG,kBAAkB,CAAC,QAAQ,EAAE,oBAAoB,EAAE,UAAC,KAAK,EAAE,KAAK;QAC/D,OAAA,WAAW,CAAC,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE,EAAE,OAAO,CAAC;IAA7C,CAA6C,CAC9C,CACA,CACJ,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,aAAa,CAC3B,MAAmC;IADrC,iBAgJC;;IA7IO,IAAA,KAAoB,QAAQ,CAI/B;QACD,KAAK,EAAE,CAAA,MAAA,MAAM,CAAC,YAAY,0CAAE,KAAK,KAAI,EAAE;QACvC,IAAI,EAAE,CAAA,MAAA,MAAM,CAAC,YAAY,0CAAE,IAAI,KAAI,CAAC;QACpC,MAAM,EAAE,MAAA,MAAM,CAAC,YAAY,0CAAE,MAAM;KACpC,CAAC,EARK,KAAK,QAAA,EAAE,QAAQ,QAQpB,CAAC;IAEG,IAAA,KAAoB,QAAQ,EAAsB,EAAjD,KAAK,QAAA,EAAE,QAAQ,QAAkC,CAAC;IACnD,IAAA,KAA0B,QAAQ,EAErC,EAFI,QAAQ,QAAA,EAAE,WAAW,QAEzB,CAAC;IAEJ,IAAM,cAAc,GAAG,MAAM,CAAC,cAAc,IAAI,CAAC,CAAC;IAElD,SAAS,CAAC;QACR,IAAI,WAAW,GAAG,KAAK,CAAC;QAExB,IAAM,GAAG,GAAG;;;;;;wBAER,QAAQ,CAAC,SAAS,CAAC,CAAC;wBAEpB,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE;4BAChB,WAAW,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,WAAW,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;4BACpD,sBAAO;yBACR;wBAED,WAAW,CAAC,SAAS,CAAC,CAAC;wBAEN,qBAAM,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC;gCACzD,MAAM,EAAE;oCACN,KAAK,EAAE,KAAK,CAAC,KAAK;oCAClB,MAAM,EAAE,KAAK,CAAC,MAAM;oCACpB,gBAAgB,EAAE,MAAM,CAAC,cAAc;iCACxC;gCACD,IAAI,EAAE;oCACJ,KAAK,EAAE,cAAc;oCACrB,MAAM,EAAE,cAAc,GAAG,KAAK,CAAC,IAAI;iCACpC;6BACF,CAAC,EAAA;;wBAVI,aAAW,SAUf;wBAEF,IAAI,CAAC,WAAW,EAAE;4BAChB,WAAW,CAAC,UAAQ,CAAC,CAAC;yBACvB;;;;wBAED,IAAI,WAAW,EAAE;4BACf,sBAAO;yBACR;wBAED,IAAI,GAAC,YAAY,KAAK,EAAE;4BACtB,QAAQ,CAAC,GAAC,CAAC,OAAO,CAAC,CAAC;yBACrB;6BAAM;4BACL,QAAQ,CAAC,gBAAgB,CAAC,CAAC;yBAC5B;;;;;aAEJ,CAAC;QAEF,GAAG,EAAE,CAAC;QAEN,OAAO;YACL,WAAW,GAAG,IAAI,CAAC;QACrB,CAAC,CAAC;IACJ,CAAC,EAAE;QACD,cAAc;QACd,KAAK;QACL,MAAM,CAAC,cAAc;QACrB,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ;KAC9B,CAAC,CAAC;IAEH,IAAM,cAAc,GAAG,WAAW,CAChC,UAAC,QAAgB;QACf,QAAQ,CAAC,UAAC,QAAQ,IAAK,OAAA,uBAAM,QAAQ,KAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,IAAG,EAA3C,CAA2C,CAAC,CAAC;IACtE,CAAC,EACD,CAAC,QAAQ,CAAC,CACX,CAAC;IAEF,IAAM,aAAa,GAAG,WAAW,CAC/B,UAAC,OAAe;QACd,QAAQ,CAAC,UAAC,QAAQ,IAAK,OAAA,uBAAM,QAAQ,KAAE,IAAI,EAAE,OAAO,IAAG,EAAhC,CAAgC,CAAC,CAAC;IAC3D,CAAC,EACD,CAAC,QAAQ,CAAC,CACX,CAAC;IAEF,IAAM,eAAe,GAAG,WAAW,CACjC,UAAC,SAA6B;QAC5B,QAAQ,CAAC,UAAC,QAAQ,IAAK,OAAA,uBAAM,QAAQ,KAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,IAAG,EAA7C,CAA6C,CAAC,CAAC;IACxE,CAAC,EACD,CAAC,QAAQ,CAAC,CACX,CAAC;IAEF,IAAM,WAAW,GAAG,MAAM,CAAC,cAAc,IAAI,kBAAkB,CAAC;IAEhE,OAAO;QACL,KAAK,EAAE;YACL,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,QAAQ,EAAE,cAAc;YACxB,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,OAAO,EAAE,aAAa;YACtB,MAAM,EAAE,KAAK,CAAC,MAAM;YACpB,SAAS,EAAE,eAAe;SAC3B;QAED,KAAK,OAAA;QACL,IAAI,EACF,KAAK,CAAC,KAAK,KAAK,EAAE;YAChB,CAAC,CAAC;gBACE,WAAW,EAAE,EAAE;gBACf,YAAY,EAAE,CAAC;gBACf,UAAU,EAAE,CAAC;aACd;YACH,CAAC,CAAC,QAAQ;gBACV,CAAC,CAAC;oBACE,WAAW,EAAE,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,UAAC,eAAe,IAAK,OAAA,CAAC;wBACnD,EAAE,EAAE,eAAe,CAAC,EAAE;wBACtB,GAAG,EAAE,eAAe,CAAC,UAAU,CAAC,GAAG;wBACnC,KAAK,EAAE,eAAe,CAAC,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAClD,oBAAC,gBAAgB,IAAC,WAAW,EAAE,WAAW,EAAE,OAAO,EAAC,OAAO,IACxD,eAAe,CAAC,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAC7B,CACpB,CAAC,CAAC,CAAC,CACF,eAAe,CAAC,UAAU,CAAC,KAAK,CACjC;wBACD,WAAW,EAAE,eAAe,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CACvD,oBAAC,gBAAgB,IACf,WAAW,EAAE,WAAW,EACxB,OAAO,EAAC,aAAa,IAEpB,eAAe,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAC5B,CACpB,CAAC,CAAC,CAAC,CACF,eAAe,CAAC,UAAU,CAAC,YAAY,CACxC;wBACD,GAAG,EAAE,eAAe;qBACrB,CAAC,EArBkD,CAqBlD,CAAC;oBACH,YAAY,EAAE,QAAQ,CAAC,IAAI,CAAC,WAAW;oBACvC,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,GAAG,cAAc,CAAC;iBAClE;gBACH,CAAC,CAAC,SAAS;KAChB,CAAC;AACJ,CAAC"}

package/dist/types/index.d.ts

@@ -2,3 +2,4 @@ export * from './Image/index';
 export * from './Seo/index';
 export * from './useQuerySubscription/index';
 export * from './StructuredText/index';
+export * from './useSiteSearch/index';

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

@@ -1,5 +1,5 @@
-import { ChannelErrorData, ConnectionStatus, Options } from "datocms-listen";
-export declare type SubscribeToQueryOptions<QueryResult, QueryVariables> = Omit<Options<QueryResult, QueryVariables>, "onStatusChange" | "onUpdate" | "onChannelError">;
+import { ChannelErrorData, ConnectionStatus, Options } from 'datocms-listen';
+export declare type SubscribeToQueryOptions<QueryResult, QueryVariables> = Omit<Options<QueryResult, QueryVariables>, 'onStatusChange' | 'onUpdate' | 'onChannelError'>;
 export declare type EnabledQueryListenerOptions<QueryResult, QueryVariables> = {
     /** Whether the subscription has to be performed or not */
     enabled?: true;

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

@@ -0,0 +1,81 @@
+import React from 'react';
+declare type SearchResultInstancesHrefSchema = {
+    page?: {
+        offset?: number;
+        limit?: number;
+        [k: string]: unknown;
+    };
+    filter: {
+        query: string;
+        build_trigger_id?: string;
+        locale?: string;
+        [k: string]: unknown;
+    };
+    [k: string]: unknown;
+};
+declare type SearchResultInstancesTargetSchema = {
+    data: RawSearchResult[];
+    meta: {
+        total_count: number;
+    };
+};
+export declare type RawSearchResult = {
+    type: 'search_result';
+    id: string;
+    attributes: {
+        title: string;
+        body_excerpt: string;
+        url: string;
+        score: number;
+        highlight: {
+            title?: string[] | null;
+            body?: string[] | null;
+        };
+    };
+};
+declare class GenericClient {
+    config: {
+        apiToken: string | null;
+    };
+    searchResults: {
+        rawList(queryParams: SearchResultInstancesHrefSchema): Promise<SearchResultInstancesTargetSchema>;
+    };
+}
+declare type Highlighter = (match: string, key: string, context: 'title' | 'bodyExcerpt') => React.ReactNode;
+export declare type UseSiteSearchConfig<Client extends GenericClient> = {
+    client: Client;
+    buildTriggerId: string;
+    resultsPerPage?: number;
+    highlightMatch?: Highlighter;
+    initialState?: {
+        locale?: string;
+        page?: number;
+        query?: string;
+    };
+};
+declare type SearchResult = {
+    id: string;
+    title: React.ReactNode;
+    bodyExcerpt: React.ReactNode;
+    url: string;
+    raw: RawSearchResult;
+};
+export declare type UseSiteSearchData = {
+    pageResults: SearchResult[];
+    totalResults: number;
+    totalPages: number;
+};
+export declare type UseSiteSearchResult = {
+    state: {
+        query: string;
+        setQuery: (newQuery: string) => void;
+        locale: string | undefined;
+        setLocale: (newLocale: string) => void;
+        page: number;
+        setPage: (newPage: number) => void;
+    };
+    data?: UseSiteSearchData;
+    error?: string;
+};
+export declare function useSiteSearch<Client extends GenericClient>(config: UseSiteSearchConfig<Client>): UseSiteSearchResult;
+export {};