algoliasearch 4.14.2 → 5.0.0-alpha.3

package/dist/lite/lite/model/updatedRuleResponse.d.ts

@@ -0,0 +1,15 @@
+export declare type UpdatedRuleResponse = {
+    /**
+     * Unique identifier of the object.
+     */
+    objectID: string;
+    /**
+     * Date of last update (ISO-8601 format).
+     */
+    updatedAt: string;
+    /**
+     * TaskID of the task to wait for.
+     */
+    taskID: number;
+};
+//# sourceMappingURL=updatedRuleResponse.d.ts.map

package/dist/lite/lite/model/updatedRuleResponse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"updatedRuleResponse.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/model/updatedRuleResponse.ts"],"names":[],"mappings":"AAEA,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}

package/dist/lite/lite/model/userId.d.ts

@@ -0,0 +1,22 @@
+/**
+ * A userID.
+ */
+export declare type UserId = {
+    /**
+     * UserID of the user.
+     */
+    userID: string;
+    /**
+     * Cluster on which the user is assigned.
+     */
+    clusterName: string;
+    /**
+     * Number of records belonging to the user.
+     */
+    nbRecords: number;
+    /**
+     * Data size used by the user.
+     */
+    dataSize: number;
+};
+//# sourceMappingURL=userId.d.ts.map

package/dist/lite/lite/model/userId.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"userId.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/model/userId.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,MAAM,GAAG;IACnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC"}

package/dist/lite/lite/model/value.d.ts

@@ -0,0 +1,9 @@
+import type { SortRemainingBy } from './sortRemainingBy';
+export declare type Value = {
+    /**
+     * Pinned order of facet lists.
+     */
+    order?: string[];
+    sortRemainingBy?: SortRemainingBy;
+};
+//# sourceMappingURL=value.d.ts.map

package/dist/lite/lite/model/value.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"value.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/model/value.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,oBAAY,KAAK,GAAG;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IAEjB,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC,CAAC"}

package/dist/lite/lite/src/liteClient.d.ts

@@ -0,0 +1,43 @@
+import type { CreateClientOptions, RequestOptions } from '@algolia/client-common';
+import type { PostProps, LegacySearchMethodProps } from '../model/clientMethodProps';
+import type { SearchMethodParams } from '../model/searchMethodParams';
+import type { SearchResponses } from '../model/searchResponses';
+export declare const apiClientVersion = "5.0.0-alpha.3";
+export declare function createLiteClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
+    transporter: import("@algolia/client-common").Transporter;
+    /**
+     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
+     */
+    readonly _ua: string;
+    /**
+     * Adds a `segment` to the `x-algolia-agent` sent with every requests.
+     *
+     * @param segment - The algolia agent (user-agent) segment to add.
+     * @param version - The version of the agent.
+     */
+    addAlgoliaAgent(segment: string, version?: string): void;
+    /**
+     * This method allow you to send requests to the Algolia REST API.
+     *
+     * @summary Send requests to the Algolia REST API.
+     * @param post - The post object.
+     * @param post.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
+     * @param post.parameters - Query parameters to be applied to the current query.
+     * @param post.body - The parameters to send with the custom request.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    post({ path, parameters, body }: PostProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    /**
+     * Perform a search operation targeting one or many indices.
+     *
+     * @summary Search multiple indices.
+     * @param searchMethodParams - The `search` requests and strategy.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    search<T>(searchMethodParams: LegacySearchMethodProps | SearchMethodParams, requestOptions?: RequestOptions): Promise<SearchResponses<T>>;
+};
+/**
+ * The client type.
+ */
+export declare type LiteClient = ReturnType<typeof createLiteClient>;
+//# sourceMappingURL=liteClient.d.ts.map

package/dist/lite/lite/src/liteClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"liteClient.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/src/liteClient.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EACV,mBAAmB,EAInB,cAAc,EAEf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EACV,SAAS,EACT,uBAAuB,EACxB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAEhE,eAAO,MAAM,gBAAgB,kBAAkB,CAAC;AAsChD,wBAAgB,gBAAgB,CAAC,EAC/B,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,GAAG,OAAO,EACX,EAAE,mBAAmB;;IAuBlB;;OAEG;;IAIH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAGxD;;;;;;;;;OASG;qCAE2B,SAAS,mBACpB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAoB/B;;;;;;OAMG;kCAEmB,uBAAuB,GAAG,kBAAkB,mBAC/C,cAAc;EAwDpC;AAED;;GAEG;AACH,oBAAY,UAAU,GAAG,UAAU,CAAC,OAAO,gBAAgB,CAAC,CAAC"}

package/dist/lite/lite.cjs.js

@@ -0,0 +1,183 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var clientCommon = require('@algolia/client-common');
+var requesterNodeHttp = require('@algolia/requester-node-http');
+
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+const apiClientVersion = '5.0.0-alpha.3';
+function getDefaultHosts(appId) {
+    return [
+        {
+            url: `${appId}-dsn.algolia.net`,
+            accept: 'read',
+            protocol: 'https',
+        },
+        {
+            url: `${appId}.algolia.net`,
+            accept: 'write',
+            protocol: 'https',
+        },
+    ].concat(clientCommon.shuffle([
+        {
+            url: `${appId}-1.algolianet.com`,
+            accept: 'readWrite',
+            protocol: 'https',
+        },
+        {
+            url: `${appId}-2.algolianet.com`,
+            accept: 'readWrite',
+            protocol: 'https',
+        },
+        {
+            url: `${appId}-3.algolianet.com`,
+            accept: 'readWrite',
+            protocol: 'https',
+        },
+    ]));
+}
+// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+function createLiteClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }) {
+    const auth = clientCommon.createAuth(appIdOption, apiKeyOption, authMode);
+    const transporter = clientCommon.createTransporter({
+        hosts: getDefaultHosts(appIdOption),
+        ...options,
+        algoliaAgent: clientCommon.getAlgoliaAgent({
+            algoliaAgents,
+            client: 'Lite',
+            version: apiClientVersion,
+        }),
+        baseHeaders: {
+            'content-type': 'text/plain',
+            ...auth.headers(),
+            ...options.baseHeaders,
+        },
+        baseQueryParameters: {
+            ...auth.queryParameters(),
+            ...options.baseQueryParameters,
+        },
+    });
+    return {
+        transporter,
+        /**
+         * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
+         */
+        get _ua() {
+            return transporter.algoliaAgent.value;
+        },
+        /**
+         * Adds a `segment` to the `x-algolia-agent` sent with every requests.
+         *
+         * @param segment - The algolia agent (user-agent) segment to add.
+         * @param version - The version of the agent.
+         */
+        addAlgoliaAgent(segment, version) {
+            transporter.algoliaAgent.add({ segment, version });
+        },
+        /**
+         * This method allow you to send requests to the Algolia REST API.
+         *
+         * @summary Send requests to the Algolia REST API.
+         * @param post - The post object.
+         * @param post.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
+         * @param post.parameters - Query parameters to be applied to the current query.
+         * @param post.body - The parameters to send with the custom request.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        post({ path, parameters, body }, requestOptions) {
+            if (!path) {
+                throw new Error('Parameter `path` is required when calling `post`.');
+            }
+            const requestPath = '/1{path}'.replace('{path}', path);
+            const headers = {};
+            const queryParameters = parameters ? parameters : {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: body ? body : {},
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Perform a search operation targeting one or many indices.
+         *
+         * @summary Search multiple indices.
+         * @param searchMethodParams - The `search` requests and strategy.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        search(searchMethodParams, requestOptions) {
+            if (searchMethodParams && Array.isArray(searchMethodParams)) {
+                const newSignatureRequest = {
+                    requests: searchMethodParams.map(({ params, ...legacyRequest }) => {
+                        if (legacyRequest.type === 'facet') {
+                            return {
+                                ...legacyRequest,
+                                ...params,
+                                type: 'facet',
+                            };
+                        }
+                        return {
+                            ...legacyRequest,
+                            ...params,
+                            facet: undefined,
+                            maxFacetHits: undefined,
+                            facetQuery: undefined,
+                        };
+                    }),
+                };
+                // eslint-disable-next-line no-param-reassign
+                searchMethodParams = newSignatureRequest;
+            }
+            if (!searchMethodParams) {
+                throw new Error('Parameter `searchMethodParams` is required when calling `search`.');
+            }
+            if (!searchMethodParams.requests) {
+                throw new Error('Parameter `searchMethodParams.requests` is required when calling `search`.');
+            }
+            const requestPath = '/1/indexes/*/queries';
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: searchMethodParams,
+                useReadTransporter: true,
+                cacheable: true,
+            };
+            return transporter.request(request, requestOptions);
+        },
+    };
+}
+
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+function liteClient(appId, apiKey, options) {
+    if (!appId || typeof appId !== 'string') {
+        throw new Error('`appId` is missing.');
+    }
+    if (!apiKey || typeof apiKey !== 'string') {
+        throw new Error('`apiKey` is missing.');
+    }
+    return createLiteClient({
+        appId,
+        apiKey,
+        timeouts: {
+            connect: clientCommon.DEFAULT_CONNECT_TIMEOUT_NODE,
+            read: clientCommon.DEFAULT_READ_TIMEOUT_NODE,
+            write: clientCommon.DEFAULT_WRITE_TIMEOUT_NODE,
+        },
+        requester: requesterNodeHttp.createHttpRequester(),
+        algoliaAgents: [{ segment: 'Node.js', version: process.versions.node }],
+        responsesCache: clientCommon.createNullCache(),
+        requestsCache: clientCommon.createNullCache(),
+        hostsCache: clientCommon.createMemoryCache(),
+        ...options,
+    });
+}
+
+exports.apiClientVersion = apiClientVersion;
+exports.liteClient = liteClient;