@algolia/client-personalization 4.14.1 → 5.0.0-alpha.2

package/index.js

@@ -1,2 +1,2 @@
-// eslint-disable-next-line functional/immutable-data, import/no-commonjs
+// eslint-disable-next-line import/no-commonjs,import/extensions
 module.exports = require('./dist/client-personalization.cjs.js');

package/model/clientMethodProps.ts

@@ -0,0 +1,85 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Properties for the `del` method.
+ */
+export type DelProps = {
+  /**
+   * The path of the API endpoint to target, anything after the /1 needs to be specified.
+   */
+  path: string;
+  /**
+   * Query parameters to be applied to the current query.
+   */
+  parameters?: Record<string, any>;
+};
+
+/**
+ * Properties for the `deleteUserProfile` method.
+ */
+export type DeleteUserProfileProps = {
+  /**
+   * UserToken representing the user for which to fetch the Personalization profile.
+   */
+  userToken: string;
+};
+
+/**
+ * Properties for the `get` method.
+ */
+export type GetProps = {
+  /**
+   * The path of the API endpoint to target, anything after the /1 needs to be specified.
+   */
+  path: string;
+  /**
+   * Query parameters to be applied to the current query.
+   */
+  parameters?: Record<string, any>;
+};
+
+/**
+ * Properties for the `getUserTokenProfile` method.
+ */
+export type GetUserTokenProfileProps = {
+  /**
+   * UserToken representing the user for which to fetch the Personalization profile.
+   */
+  userToken: string;
+};
+
+/**
+ * Properties for the `post` method.
+ */
+export type PostProps = {
+  /**
+   * The path of the API endpoint to target, anything after the /1 needs to be specified.
+   */
+  path: string;
+  /**
+   * Query parameters to be applied to the current query.
+   */
+  parameters?: Record<string, any>;
+  /**
+   * The parameters to send with the custom request.
+   */
+  body?: Record<string, any>;
+};
+
+/**
+ * Properties for the `put` method.
+ */
+export type PutProps = {
+  /**
+   * The path of the API endpoint to target, anything after the /1 needs to be specified.
+   */
+  path: string;
+  /**
+   * Query parameters to be applied to the current query.
+   */
+  parameters?: Record<string, any>;
+  /**
+   * The parameters to send with the custom request.
+   */
+  body?: Record<string, any>;
+};

package/model/deleteUserProfileResponse.ts

@@ -0,0 +1,12 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type DeleteUserProfileResponse = {
+  /**
+   * UserToken representing the user for which to fetch the Personalization profile.
+   */
+  userToken: string;
+  /**
+   * A date until which the data can safely be considered as deleted for the given user. Any data received after the `deletedUntil` date will start building a new user profile.
+   */
+  deletedUntil: string;
+};

package/model/errorBase.ts

@@ -0,0 +1,8 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Error.
+ */
+export type ErrorBase = Record<string, any> & {
+  message?: string;
+};

package/model/eventScoring.ts

@@ -0,0 +1,16 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type EventScoring = {
+  /**
+   * The score for the event.
+   */
+  score: number;
+  /**
+   * The name of the event.
+   */
+  eventName: string;
+  /**
+   * The type of the event.
+   */
+  eventType: string;
+};

package/model/facetScoring.ts

@@ -0,0 +1,12 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type FacetScoring = {
+  /**
+   * The score for the event.
+   */
+  score: number;
+  /**
+   * The name of the facet.
+   */
+  facetName: string;
+};

package/model/getUserTokenResponse.ts

@@ -0,0 +1,16 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type GetUserTokenResponse = {
+  /**
+   * UserToken representing the user for which to fetch the Personalization profile.
+   */
+  userToken: string;
+  /**
+   * Date of last event update. (ISO-8601 format).
+   */
+  lastEventAt: string;
+  /**
+   * The userToken scores.
+   */
+  scores: Record<string, any>;
+};

package/model/index.ts

@@ -0,0 +1,10 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export * from './deleteUserProfileResponse';
+export * from './errorBase';
+export * from './eventScoring';
+export * from './facetScoring';
+export * from './getUserTokenResponse';
+export * from './personalizationStrategyParams';
+export * from './setPersonalizationStrategyResponse';
+export * from './clientMethodProps';

package/model/personalizationStrategyParams.ts

@@ -0,0 +1,19 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { EventScoring } from './eventScoring';
+import type { FacetScoring } from './facetScoring';
+
+export type PersonalizationStrategyParams = {
+  /**
+   * Scores associated with the events.
+   */
+  eventScoring: EventScoring[];
+  /**
+   * Scores associated with the facets.
+   */
+  facetScoring: FacetScoring[];
+  /**
+   * The impact that personalization has on search results: a number between 0 (personalization disabled) and 100 (personalization fully enabled).
+   */
+  personalizationImpact: number;
+};

package/model/setPersonalizationStrategyResponse.ts

@@ -0,0 +1,8 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type SetPersonalizationStrategyResponse = {
+  /**
+   * A message confirming the strategy update.
+   */
+  message: string;
+};

package/package.json

@@ -1,23 +1,35 @@
 {
   "name": "@algolia/client-personalization",
-  "version": "4.14.1",
-  "private": false,
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/algolia/algoliasearch-client-javascript.git"
-  },
+  "version": "5.0.0-alpha.2",
+  "description": "JavaScript client for client-personalization",
+  "repository": "algolia/algoliasearch-client-javascript",
   "license": "MIT",
-  "sideEffects": false,
+  "author": "Algolia",
   "main": "index.js",
-  "module": "dist/client-personalization.esm.js",
-  "types": "dist/client-personalization.d.ts",
+  "jsdelivr": "dist/client-personalization.umd.js",
+  "unpkg": "dist/client-personalization.umd.js",
+  "module": "dist/client-personalization.esm.node.js",
+  "browser": "dist/client-personalization.umd.js",
+  "types": "index.d.ts",
   "files": [
+    "dist",
+    "model",
     "index.js",
-    "dist"
+    "index.d.ts"
   ],
+  "scripts": {
+    "clean": "rm -rf ./dist"
+  },
   "dependencies": {
-    "@algolia/client-common": "4.14.1",
-    "@algolia/requester-common": "4.14.1",
-    "@algolia/transporter": "4.14.1"
+    "@algolia/client-common": "5.0.0-alpha.2",
+    "@algolia/requester-browser-xhr": "5.0.0-alpha.2",
+    "@algolia/requester-node-http": "5.0.0-alpha.2"
+  },
+  "devDependencies": {
+    "@types/node": "16.11.45",
+    "typescript": "4.7.4"
+  },
+  "engines": {
+    "node": ">= 14.0.0"
   }
 }

package/dist/client-personalization.d.ts

@@ -1,93 +0,0 @@
-import { ClientTransporterOptions } from '@algolia/client-common';
-import { CreateClient } from '@algolia/client-common';
-import { RequestOptions } from '@algolia/transporter';
-import { Transporter } from '@algolia/transporter';
-
-export declare const createPersonalizationClient: CreateClient<PersonalizationClient, PersonalizationClientOptions & ClientTransporterOptions>;
-
-export declare const getPersonalizationStrategy: (base: PersonalizationClient) => (requestOptions?: RequestOptions | undefined) => Readonly<Promise<GetPersonalizationStrategyResponse>>;
-
-export declare type GetPersonalizationStrategyResponse = {
-    /**
-     * Events scoring
-     */
-    eventsScoring: Array<{
-        eventName: string;
-        eventType: string;
-        score: number;
-    }>;
-    /**
-     * Facets scoring
-     */
-    facetsScoring: Array<{
-        facetName: string;
-        score: number;
-    }>;
-    /**
-     * Personalization impact
-     */
-    personalizationImpact: number;
-};
-
-export declare type PersonalizationClient = {
-    /**
-     * The application id.
-     */
-    readonly appId: string;
-    /**
-     * The underlying transporter.
-     */
-    readonly transporter: Transporter;
-};
-
-export declare type PersonalizationClientOptions = {
-    /**
-     * The application id.
-     */
-    readonly appId: string;
-    /**
-     * The api key.
-     */
-    readonly apiKey: string;
-    /**
-     * The prefered region.
-     */
-    readonly region?: string;
-};
-
-export declare type PersonalizationStrategy = {
-    /**
-     * Events scoring
-     */
-    readonly eventsScoring: ReadonlyArray<{
-        readonly eventName: string;
-        readonly eventType: string;
-        readonly score: number;
-    }>;
-    /**
-     * Facets scoring
-     */
-    readonly facetsScoring: ReadonlyArray<{
-        readonly facetName: string;
-        readonly score: number;
-    }>;
-    /**
-     * Personalization impact
-     */
-    readonly personalizationImpact: number;
-};
-
-export declare const setPersonalizationStrategy: (base: PersonalizationClient) => (personalizationStrategy: PersonalizationStrategy, requestOptions?: RequestOptions | undefined) => Readonly<Promise<SetPersonalizationStrategyResponse>>;
-
-export declare type SetPersonalizationStrategyResponse = {
-    /**
-     * The status code.
-     */
-    status?: number;
-    /**
-     * The message.
-     */
-    message: string;
-};
-
-export { }

package/dist/client-personalization.esm.js

@@ -1,43 +0,0 @@
-import { createAuth, AuthMode, addMethods } from '@algolia/client-common';
-import { createTransporter } from '@algolia/transporter';
-import { MethodEnum } from '@algolia/requester-common';
-
-const createPersonalizationClient = options => {
-    const region = options.region || 'us';
-    const auth = createAuth(AuthMode.WithinHeaders, options.appId, options.apiKey);
-    const transporter = createTransporter({
-        hosts: [{ url: `personalization.${region}.algolia.com` }],
-        ...options,
-        headers: {
-            ...auth.headers(),
-            ...{ 'content-type': 'application/json' },
-            ...options.headers,
-        },
-        queryParameters: {
-            ...auth.queryParameters(),
-            ...options.queryParameters,
-        },
-    });
-    return addMethods({ appId: options.appId, transporter }, options.methods);
-};
-
-const getPersonalizationStrategy = (base) => {
-    return (requestOptions) => {
-        return base.transporter.read({
-            method: MethodEnum.Get,
-            path: '1/strategies/personalization',
-        }, requestOptions);
-    };
-};
-
-const setPersonalizationStrategy = (base) => {
-    return (personalizationStrategy, requestOptions) => {
-        return base.transporter.write({
-            method: MethodEnum.Post,
-            path: '1/strategies/personalization',
-            data: personalizationStrategy,
-        }, requestOptions);
-    };
-};
-
-export { createPersonalizationClient, getPersonalizationStrategy, setPersonalizationStrategy };