@algolia/client-analytics 4.13.1 → 5.0.0-alpha.1

package/dist/client-analytics.d.ts

@@ -1,233 +0,0 @@
-import { ClientTransporterOptions } from '@algolia/client-common';
-import { CreateClient } from '@algolia/client-common';
-import { RequestOptions } from '@algolia/transporter';
-import { SearchOptions } from '@algolia/client-search';
-import { Transporter } from '@algolia/transporter';
-
-export declare type ABTest = {
-    /**
-     * The ab test name.
-     */
-    readonly name: string;
-    /**
-     * The ab test list of variants.
-     */
-    readonly variants: readonly Variant[];
-    /**
-     * The ab test end date, if any.
-     */
-    readonly endAt: string;
-};
-
-export declare const addABTest: (base: AnalyticsClient) => (abTest: ABTest, requestOptions?: RequestOptions | undefined) => Readonly<Promise<AddABTestResponse>>;
-
-export declare type AddABTestResponse = {
-    /**
-     * The ab test unique identifier.
-     */
-    abTestID: number;
-    /**
-     * The operation task id. May be used to perform a wait task.
-     */
-    taskID: number;
-    /**
-     * The index name where the ab test is attached to.
-     */
-    index: string;
-};
-
-export declare type AnalyticsClient = {
-    /**
-     * The application id.
-     */
-    readonly appId: string;
-    /**
-     * The underlying transporter.
-     */
-    readonly transporter: Transporter;
-};
-
-export declare type AnalyticsClientOptions = {
-    /**
-     * The application id.
-     */
-    readonly appId: string;
-    /**
-     * The api key.
-     */
-    readonly apiKey: string;
-    /**
-     * The prefered region.
-     */
-    readonly region?: 'de' | 'us';
-};
-
-export declare const createAnalyticsClient: CreateClient<AnalyticsClient, AnalyticsClientOptions & ClientTransporterOptions>;
-
-export declare const deleteABTest: (base: AnalyticsClient) => (abTestID: number, requestOptions?: RequestOptions | undefined) => Readonly<Promise<DeleteABTestResponse>>;
-
-export declare type DeleteABTestResponse = {
-    /**
-     * The ab test unique identifier.
-     */
-    abTestID: number;
-    /**
-     * The operation task id. May be used to perform a wait task.
-     */
-    taskID: number;
-    /**
-     * The index name where the ab test was attached to.
-     */
-    index: string;
-};
-
-export declare const getABTest: (base: AnalyticsClient) => (abTestID: number, requestOptions?: RequestOptions | undefined) => Readonly<Promise<GetABTestResponse>>;
-
-export declare type GetABTestResponse = {
-    /**
-     * The ab test name.
-     */
-    name: string;
-    /**
-     * The ab test status.
-     */
-    status: string;
-    /**
-     * The ab test list of variants.
-     */
-    variants: VariantResponse[];
-    /**
-     * The ab test end date, if any.
-     */
-    endAt: string;
-    /**
-     * The ab test created date, if any.
-     */
-    createdAt: string;
-    /**
-     * The ab test updated date.
-     */
-    updatedAt: string;
-    /**
-     * The ab test unique identifier.
-     */
-    abTestID: number;
-    /**
-     * The ab test significance based on click data. Should be higher than 0.95 to be considered significant - no matter which variant is winning.
-     */
-    clickSignificance: number;
-    /**
-     *
-     * The ab test significance based on conversion data. Should be higher than 0.95 to be considered significant - no matter which variant is winning.
-     */
-    conversionSignificance: number;
-};
-
-export declare const getABTests: (base: AnalyticsClient) => (requestOptions?: (RequestOptions & GetABTestsOptions) | undefined) => Readonly<Promise<GetABTestsResponse>>;
-
-export declare type GetABTestsOptions = {
-    /**
-     * The number of ab tests to skip from the biginning of the list.
-     */
-    readonly offset?: number;
-    /**
-     *  The limit of the number of ab tests returned.
-     */
-    readonly limit?: number;
-};
-
-export declare type GetABTestsResponse = {
-    /**
-     * The number of ab tests within this response.
-     */
-    count: number;
-    /**
-     * The total of ab tests.
-     */
-    total: number;
-    /**
-     * The list of ab tests.
-     */
-    abtests: GetABTestResponse[] | null;
-};
-
-export declare const stopABTest: (base: AnalyticsClient) => (abTestID: number, requestOptions?: RequestOptions | undefined) => Readonly<Promise<StopABTestResponse>>;
-
-export declare type StopABTestResponse = {
-    /**
-     * The ab test unique identifier.
-     */
-    abTestID: number;
-    /**
-     * The operation task id. May be used to perform a wait task.
-     */
-    taskID: number;
-    /**
-     * The index name where the ab test is attached to.
-     */
-    index: string;
-};
-
-export declare type Variant = {
-    /**
-     * The index name.
-     */
-    readonly index: string;
-    /**
-     * Description of the variant. Useful when seing the results in the dashboard or via the API.
-     */
-    readonly description?: string;
-    /**
-     * Percentage of the traffic that should be going to the variant. The sum of the percentage should be equal to 100.
-     */
-    readonly trafficPercentage: number;
-    /**
-     * The search parameters.
-     */
-    readonly customSearchParameters?: SearchOptions;
-};
-
-export declare type VariantResponse = Variant & {
-    /**
-     * Average click position for the variant.
-     */
-    averageClickPosition?: number;
-    /**
-     * Distinct click count for the variant.
-     */
-    clickCount?: number;
-    /**
-     * Click through rate for the variant.
-     */
-    clickThroughRate?: number;
-    /**
-     * Click through rate for the variant.
-     */
-    conversionCount?: number;
-    /**
-     * Distinct conversion count for the variant.
-     */
-    conversionRate?: number;
-    /**
-     * No result count.
-     */
-    noResultCount?: number;
-    /**
-     * Tracked search count.
-     */
-    trackedSearchCount?: number;
-    /**
-     * Search count.
-     */
-    searchCount?: number;
-    /**
-     * User count.
-     */
-    userCount?: number;
-    /**
-     * The search parameters.
-     */
-    customSearchParameters?: SearchOptions;
-};
-
-export { }

package/dist/client-analytics.esm.js

@@ -1,71 +0,0 @@
-import { createAuth, AuthMode, addMethods, encode } from '@algolia/client-common';
-import { createTransporter } from '@algolia/transporter';
-import { MethodEnum } from '@algolia/requester-common';
-
-const createAnalyticsClient = options => {
-    const region = options.region || 'us';
-    const auth = createAuth(AuthMode.WithinHeaders, options.appId, options.apiKey);
-    const transporter = createTransporter({
-        hosts: [{ url: `analytics.${region}.algolia.com` }],
-        ...options,
-        headers: {
-            ...auth.headers(),
-            ...{ 'content-type': 'application/json' },
-            ...options.headers,
-        },
-        queryParameters: {
-            ...auth.queryParameters(),
-            ...options.queryParameters,
-        },
-    });
-    const appId = options.appId;
-    return addMethods({ appId, transporter }, options.methods);
-};
-
-const addABTest = (base) => {
-    return (abTest, requestOptions) => {
-        return base.transporter.write({
-            method: MethodEnum.Post,
-            path: '2/abtests',
-            data: abTest,
-        }, requestOptions);
-    };
-};
-
-const deleteABTest = (base) => {
-    return (abTestID, requestOptions) => {
-        return base.transporter.write({
-            method: MethodEnum.Delete,
-            path: encode('2/abtests/%s', abTestID),
-        }, requestOptions);
-    };
-};
-
-const getABTest = (base) => {
-    return (abTestID, requestOptions) => {
-        return base.transporter.read({
-            method: MethodEnum.Get,
-            path: encode('2/abtests/%s', abTestID),
-        }, requestOptions);
-    };
-};
-
-const getABTests = (base) => {
-    return (requestOptions) => {
-        return base.transporter.read({
-            method: MethodEnum.Get,
-            path: '2/abtests',
-        }, requestOptions);
-    };
-};
-
-const stopABTest = (base) => {
-    return (abTestID, requestOptions) => {
-        return base.transporter.write({
-            method: MethodEnum.Post,
-            path: encode('2/abtests/%s/stop', abTestID),
-        }, requestOptions);
-    };
-};
-
-export { addABTest, createAnalyticsClient, deleteABTest, getABTest, getABTests, stopABTest };