@algolia/recommend 5.0.0-alpha.9 → 5.0.0-alpha.90

package/dist/model/baseTrendingRequest.d.ts

@@ -1,13 +0,0 @@
-import type { TrendingModels } from './trendingModels';
-export declare type BaseTrendingRequest = {
-    model: TrendingModels;
-    /**
-     * The facet name to use for trending models.
-     */
-    facetName?: string;
-    /**
-     * The facet value to use for trending models.
-     */
-    facetValue?: string;
-};
-//# sourceMappingURL=baseTrendingRequest.d.ts.map

package/dist/model/baseTrendingRequest.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"baseTrendingRequest.d.ts","sourceRoot":"","sources":["../../model/baseTrendingRequest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD,oBAAY,mBAAmB,GAAG;IAChC,KAAK,EAAE,cAAc,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC"}

package/dist/model/recommendationRequest.d.ts

@@ -1,4 +0,0 @@
-import type { BaseRecommendRequest } from './baseRecommendRequest';
-import type { BaseRecommendationRequest } from './baseRecommendationRequest';
-export declare type RecommendationRequest = BaseRecommendationRequest & BaseRecommendRequest;
-//# sourceMappingURL=recommendationRequest.d.ts.map

package/dist/model/recommendationRequest.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"recommendationRequest.d.ts","sourceRoot":"","sources":["../../model/recommendationRequest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAE7E,oBAAY,qBAAqB,GAAG,yBAAyB,GAC3D,oBAAoB,CAAC"}

package/dist/model/trendingModels.d.ts

@@ -1,5 +0,0 @@
-/**
- * The trending model to use.
- */
-export declare type TrendingModels = 'trending-facets' | 'trending-items';
-//# sourceMappingURL=trendingModels.d.ts.map

package/dist/model/trendingModels.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"trendingModels.d.ts","sourceRoot":"","sources":["../../model/trendingModels.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,cAAc,GAAG,iBAAiB,GAAG,gBAAgB,CAAC"}

package/dist/model/trendingRequest.d.ts

@@ -1,4 +0,0 @@
-import type { BaseRecommendRequest } from './baseRecommendRequest';
-import type { BaseTrendingRequest } from './baseTrendingRequest';
-export declare type TrendingRequest = BaseRecommendRequest & BaseTrendingRequest;
-//# sourceMappingURL=trendingRequest.d.ts.map

package/dist/model/trendingRequest.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"trendingRequest.d.ts","sourceRoot":"","sources":["../../model/trendingRequest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,oBAAY,eAAe,GAAG,oBAAoB,GAAG,mBAAmB,CAAC"}

package/dist/recommend.cjs.js

@@ -1,248 +0,0 @@
-'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.9';
-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 createRecommendClient({ 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: 'Recommend',
-            version: apiClientVersion,
-        }),
-        baseHeaders: {
-            'content-type': 'text/plain',
-            ...auth.headers(),
-            ...options.baseHeaders,
-        },
-        baseQueryParameters: {
-            ...auth.queryParameters(),
-            ...options.baseQueryParameters,
-        },
-    });
-    return {
-        transporter,
-        /**
-         * The `appId` currently in use.
-         */
-        appId: appIdOption,
-        /**
-         * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
-         */
-        clearCache() {
-            return Promise.all([
-                transporter.requestsCache.clear(),
-                transporter.responsesCache.clear(),
-            ]).then(() => undefined);
-        },
-        /**
-         * 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 del - The del object.
-         * @param del.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-         * @param del.parameters - Query parameters to be applied to the current query.
-         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-         */
-        del({ path, parameters }, requestOptions) {
-            if (!path) {
-                throw new Error('Parameter `path` is required when calling `del`.');
-            }
-            const requestPath = '/1{path}'.replace('{path}', path);
-            const headers = {};
-            const queryParameters = parameters ? parameters : {};
-            const request = {
-                method: 'DELETE',
-                path: requestPath,
-                queryParameters,
-                headers,
-            };
-            return transporter.request(request, requestOptions);
-        },
-        /**
-         * This method allow you to send requests to the Algolia REST API.
-         *
-         * @summary Send requests to the Algolia REST API.
-         * @param get - The get object.
-         * @param get.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-         * @param get.parameters - Query parameters to be applied to the current query.
-         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-         */
-        get({ path, parameters }, requestOptions) {
-            if (!path) {
-                throw new Error('Parameter `path` is required when calling `get`.');
-            }
-            const requestPath = '/1{path}'.replace('{path}', path);
-            const headers = {};
-            const queryParameters = parameters ? parameters : {};
-            const request = {
-                method: 'GET',
-                path: requestPath,
-                queryParameters,
-                headers,
-            };
-            return transporter.request(request, requestOptions);
-        },
-        /**
-         * Returns recommendations or trending results, for a specific model and `objectID`.
-         *
-         * @summary Get results.
-         * @param getRecommendationsParams - The getRecommendationsParams object.
-         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-         */
-        getRecommendations(getRecommendationsParams, requestOptions) {
-            if (!getRecommendationsParams) {
-                throw new Error('Parameter `getRecommendationsParams` is required when calling `getRecommendations`.');
-            }
-            if (!getRecommendationsParams.requests) {
-                throw new Error('Parameter `getRecommendationsParams.requests` is required when calling `getRecommendations`.');
-            }
-            const requestPath = '/1/indexes/*/recommendations';
-            const headers = {};
-            const queryParameters = {};
-            const request = {
-                method: 'POST',
-                path: requestPath,
-                queryParameters,
-                headers,
-                data: getRecommendationsParams,
-                useReadTransporter: true,
-                cacheable: true,
-            };
-            return transporter.request(request, requestOptions);
-        },
-        /**
-         * 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);
-        },
-        /**
-         * This method allow you to send requests to the Algolia REST API.
-         *
-         * @summary Send requests to the Algolia REST API.
-         * @param put - The put object.
-         * @param put.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-         * @param put.parameters - Query parameters to be applied to the current query.
-         * @param put.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.
-         */
-        put({ path, parameters, body }, requestOptions) {
-            if (!path) {
-                throw new Error('Parameter `path` is required when calling `put`.');
-            }
-            const requestPath = '/1{path}'.replace('{path}', path);
-            const headers = {};
-            const queryParameters = parameters ? parameters : {};
-            const request = {
-                method: 'PUT',
-                path: requestPath,
-                queryParameters,
-                headers,
-                data: body ? body : {},
-            };
-            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 recommendClient(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 createRecommendClient({
-        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.recommendClient = recommendClient;

package/model/baseRecommendationRequest.ts

@@ -1,12 +0,0 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
-
-import type { RecommendationModels } from './recommendationModels';
-
-export type BaseRecommendationRequest = {
-  model: RecommendationModels;
-
-  /**
-   * Unique identifier of the object.
-   */
-  objectID: string;
-};

package/model/baseTrendingRequest.ts

@@ -1,17 +0,0 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
-
-import type { TrendingModels } from './trendingModels';
-
-export type BaseTrendingRequest = {
-  model: TrendingModels;
-
-  /**
-   * The facet name to use for trending models.
-   */
-  facetName?: string;
-
-  /**
-   * The facet value to use for trending models.
-   */
-  facetValue?: string;
-};

package/model/recommendationRequest.ts

@@ -1,7 +0,0 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
-
-import type { BaseRecommendRequest } from './baseRecommendRequest';
-import type { BaseRecommendationRequest } from './baseRecommendationRequest';
-
-export type RecommendationRequest = BaseRecommendationRequest &
-  BaseRecommendRequest;

package/model/trendingModels.ts

@@ -1,6 +0,0 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
-
-/**
- * The trending model to use.
- */
-export type TrendingModels = 'trending-facets' | 'trending-items';

package/model/trendingRequest.ts

@@ -1,6 +0,0 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
-
-import type { BaseRecommendRequest } from './baseRecommendRequest';
-import type { BaseTrendingRequest } from './baseTrendingRequest';
-
-export type TrendingRequest = BaseRecommendRequest & BaseTrendingRequest;