@algolia/composition 0.0.1-beta.2

package/dist/src/compositionClient.cjs

@@ -0,0 +1,204 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/compositionClient.ts
+var compositionClient_exports = {};
+__export(compositionClient_exports, {
+  apiClientVersion: () => apiClientVersion,
+  createCompositionClient: () => createCompositionClient
+});
+module.exports = __toCommonJS(compositionClient_exports);
+var import_client_common = require("@algolia/client-common");
+var apiClientVersion = "0.0.1-beta.2";
+function getDefaultHosts(appId) {
+  return [
+    {
+      url: `${appId}-dsn.algolia.net`,
+      accept: "read",
+      protocol: "https"
+    },
+    {
+      url: `${appId}.algolia.net`,
+      accept: "write",
+      protocol: "https"
+    }
+  ].concat(
+    (0, import_client_common.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"
+      }
+    ])
+  );
+}
+function createCompositionClient({
+  appId: appIdOption,
+  apiKey: apiKeyOption,
+  authMode,
+  algoliaAgents,
+  ...options
+}) {
+  const auth = (0, import_client_common.createAuth)(appIdOption, apiKeyOption, authMode);
+  const transporter = (0, import_client_common.createTransporter)({
+    hosts: getDefaultHosts(appIdOption),
+    ...options,
+    algoliaAgent: (0, import_client_common.getAlgoliaAgent)({
+      algoliaAgents,
+      client: "Composition",
+      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,
+    /**
+     * The `apiKey` currently in use.
+     */
+    apiKey: apiKeyOption,
+    /**
+     * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
+     */
+    clearCache() {
+      return Promise.all([transporter.requestsCache.clear(), transporter.responsesCache.clear()]).then(() => void 0);
+    },
+    /**
+     * 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 });
+    },
+    /**
+     * Helper method to switch the API key used to authenticate the requests.
+     *
+     * @param params - Method params.
+     * @param params.apiKey - The new API Key to use.
+     */
+    setClientApiKey({ apiKey }) {
+      if (!authMode || authMode === "WithinHeaders") {
+        transporter.baseHeaders["x-algolia-api-key"] = apiKey;
+      } else {
+        transporter.baseQueryParameters["x-algolia-api-key"] = apiKey;
+      }
+    },
+    /**
+     * Runs a query on a single composition and returns matching results.
+     *
+     * Required API Key ACLs:
+     *  - search
+     * @param search - The search object.
+     * @param search.compositionID - Unique Composition ObjectID.
+     * @param search.requestBody - The requestBody object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    search({ compositionID, requestBody }, requestOptions) {
+      if (!compositionID) {
+        throw new Error("Parameter `compositionID` is required when calling `search`.");
+      }
+      if (!requestBody) {
+        throw new Error("Parameter `requestBody` is required when calling `search`.");
+      }
+      const requestPath = "/1/compositions/{compositionID}/run".replace(
+        "{compositionID}",
+        encodeURIComponent(compositionID)
+      );
+      const headers = {};
+      const queryParameters = {};
+      const request = {
+        method: "POST",
+        path: requestPath,
+        queryParameters,
+        headers,
+        data: requestBody,
+        useReadTransporter: true,
+        cacheable: true
+      };
+      return transporter.request(request, requestOptions);
+    },
+    /**
+     * Searches for values of a specified facet attribute on the composition\'s main source\'s index.  - By default, facet values are sorted by decreasing count.   You can adjust this with the `sortFacetValueBy` parameter. - Searching for facet values doesn\'t work if you have **more than 65 searchable facets and searchable attributes combined**.
+     *
+     * Required API Key ACLs:
+     *  - search
+     * @param searchForFacetValues - The searchForFacetValues object.
+     * @param searchForFacetValues.compositionID - Unique Composition ObjectID.
+     * @param searchForFacetValues.facetName - Facet attribute in which to search for values.  This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier.
+     * @param searchForFacetValues.searchForFacetValuesRequest - The searchForFacetValuesRequest object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    searchForFacetValues({ compositionID, facetName, searchForFacetValuesRequest }, requestOptions) {
+      if (!compositionID) {
+        throw new Error("Parameter `compositionID` is required when calling `searchForFacetValues`.");
+      }
+      if (!facetName) {
+        throw new Error("Parameter `facetName` is required when calling `searchForFacetValues`.");
+      }
+      const requestPath = "/1/compositions/{compositionID}/facets/{facetName}/query".replace("{compositionID}", encodeURIComponent(compositionID)).replace("{facetName}", encodeURIComponent(facetName));
+      const headers = {};
+      const queryParameters = {};
+      const request = {
+        method: "POST",
+        path: requestPath,
+        queryParameters,
+        headers,
+        data: searchForFacetValuesRequest ? searchForFacetValuesRequest : {},
+        useReadTransporter: true,
+        cacheable: true
+      };
+      return transporter.request(request, requestOptions);
+    }
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  apiClientVersion,
+  createCompositionClient
+});
+//# sourceMappingURL=compositionClient.cjs.map

package/dist/src/compositionClient.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/compositionClient.ts"],"sourcesContent":["// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.\n\nimport type {\n  CreateClientOptions,\n  Headers,\n  Host,\n  QueryParameters,\n  Request,\n  RequestOptions,\n} from '@algolia/client-common';\nimport { createAuth, createTransporter, getAlgoliaAgent, shuffle } from '@algolia/client-common';\n\nimport type { SearchForFacetValuesResponse } from '../model/searchForFacetValuesResponse';\nimport type { SearchResponse } from '../model/searchResponse';\n\nimport type { SearchForFacetValuesProps, SearchProps } from '../model/clientMethodProps';\n\nexport const apiClientVersion = '0.0.1-beta.2';\n\nfunction getDefaultHosts(appId: string): Host[] {\n  return (\n    [\n      {\n        url: `${appId}-dsn.algolia.net`,\n        accept: 'read',\n        protocol: 'https',\n      },\n      {\n        url: `${appId}.algolia.net`,\n        accept: 'write',\n        protocol: 'https',\n      },\n    ] as Host[]\n  ).concat(\n    shuffle([\n      {\n        url: `${appId}-1.algolianet.com`,\n        accept: 'readWrite',\n        protocol: 'https',\n      },\n      {\n        url: `${appId}-2.algolianet.com`,\n        accept: 'readWrite',\n        protocol: 'https',\n      },\n      {\n        url: `${appId}-3.algolianet.com`,\n        accept: 'readWrite',\n        protocol: 'https',\n      },\n    ]),\n  );\n}\n\nexport function createCompositionClient({\n  appId: appIdOption,\n  apiKey: apiKeyOption,\n  authMode,\n  algoliaAgents,\n  ...options\n}: CreateClientOptions) {\n  const auth = createAuth(appIdOption, apiKeyOption, authMode);\n  const transporter = createTransporter({\n    hosts: getDefaultHosts(appIdOption),\n    ...options,\n    algoliaAgent: getAlgoliaAgent({\n      algoliaAgents,\n      client: 'Composition',\n      version: apiClientVersion,\n    }),\n    baseHeaders: {\n      'content-type': 'text/plain',\n      ...auth.headers(),\n      ...options.baseHeaders,\n    },\n    baseQueryParameters: {\n      ...auth.queryParameters(),\n      ...options.baseQueryParameters,\n    },\n  });\n\n  return {\n    transporter,\n\n    /**\n     * The `appId` currently in use.\n     */\n    appId: appIdOption,\n\n    /**\n     * The `apiKey` currently in use.\n     */\n    apiKey: apiKeyOption,\n\n    /**\n     * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.\n     */\n    clearCache(): Promise<void> {\n      return Promise.all([transporter.requestsCache.clear(), transporter.responsesCache.clear()]).then(() => undefined);\n    },\n\n    /**\n     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.\n     */\n    get _ua(): string {\n      return transporter.algoliaAgent.value;\n    },\n\n    /**\n     * Adds a `segment` to the `x-algolia-agent` sent with every requests.\n     *\n     * @param segment - The algolia agent (user-agent) segment to add.\n     * @param version - The version of the agent.\n     */\n    addAlgoliaAgent(segment: string, version?: string): void {\n      transporter.algoliaAgent.add({ segment, version });\n    },\n\n    /**\n     * Helper method to switch the API key used to authenticate the requests.\n     *\n     * @param params - Method params.\n     * @param params.apiKey - The new API Key to use.\n     */\n    setClientApiKey({ apiKey }: { apiKey: string }): void {\n      if (!authMode || authMode === 'WithinHeaders') {\n        transporter.baseHeaders['x-algolia-api-key'] = apiKey;\n      } else {\n        transporter.baseQueryParameters['x-algolia-api-key'] = apiKey;\n      }\n    },\n\n    /**\n     * Runs a query on a single composition and returns matching results.\n     *\n     * Required API Key ACLs:\n     *  - search\n     * @param search - The search object.\n     * @param search.compositionID - Unique Composition ObjectID.\n     * @param search.requestBody - The requestBody object.\n     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.\n     */\n    search<T>(\n      { compositionID, requestBody }: SearchProps,\n      requestOptions?: RequestOptions,\n    ): Promise<SearchResponse<T>> {\n      if (!compositionID) {\n        throw new Error('Parameter `compositionID` is required when calling `search`.');\n      }\n\n      if (!requestBody) {\n        throw new Error('Parameter `requestBody` is required when calling `search`.');\n      }\n\n      const requestPath = '/1/compositions/{compositionID}/run'.replace(\n        '{compositionID}',\n        encodeURIComponent(compositionID),\n      );\n      const headers: Headers = {};\n      const queryParameters: QueryParameters = {};\n\n      const request: Request = {\n        method: 'POST',\n        path: requestPath,\n        queryParameters,\n        headers,\n        data: requestBody,\n        useReadTransporter: true,\n        cacheable: true,\n      };\n\n      return transporter.request(request, requestOptions);\n    },\n\n    /**\n     * Searches for values of a specified facet attribute on the composition\\'s main source\\'s index.  - By default, facet values are sorted by decreasing count.   You can adjust this with the `sortFacetValueBy` parameter. - Searching for facet values doesn\\'t work if you have **more than 65 searchable facets and searchable attributes combined**.\n     *\n     * Required API Key ACLs:\n     *  - search\n     * @param searchForFacetValues - The searchForFacetValues object.\n     * @param searchForFacetValues.compositionID - Unique Composition ObjectID.\n     * @param searchForFacetValues.facetName - Facet attribute in which to search for values.  This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier.\n     * @param searchForFacetValues.searchForFacetValuesRequest - The searchForFacetValuesRequest object.\n     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.\n     */\n    searchForFacetValues(\n      { compositionID, facetName, searchForFacetValuesRequest }: SearchForFacetValuesProps,\n      requestOptions?: RequestOptions,\n    ): Promise<SearchForFacetValuesResponse> {\n      if (!compositionID) {\n        throw new Error('Parameter `compositionID` is required when calling `searchForFacetValues`.');\n      }\n\n      if (!facetName) {\n        throw new Error('Parameter `facetName` is required when calling `searchForFacetValues`.');\n      }\n\n      const requestPath = '/1/compositions/{compositionID}/facets/{facetName}/query'\n        .replace('{compositionID}', encodeURIComponent(compositionID))\n        .replace('{facetName}', encodeURIComponent(facetName));\n      const headers: Headers = {};\n      const queryParameters: QueryParameters = {};\n\n      const request: Request = {\n        method: 'POST',\n        path: requestPath,\n        queryParameters,\n        headers,\n        data: searchForFacetValuesRequest ? searchForFacetValuesRequest : {},\n        useReadTransporter: true,\n        cacheable: true,\n      };\n\n      return transporter.request(request, requestOptions);\n    },\n  };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAUA,2BAAwE;AAOjE,IAAM,mBAAmB;AAEhC,SAAS,gBAAgB,OAAuB;AAC9C,SACE;AAAA,IACE;AAAA,MACE,KAAK,GAAG,KAAK;AAAA,MACb,QAAQ;AAAA,MACR,UAAU;AAAA,IACZ;AAAA,IACA;AAAA,MACE,KAAK,GAAG,KAAK;AAAA,MACb,QAAQ;AAAA,MACR,UAAU;AAAA,IACZ;AAAA,EACF,EACA;AAAA,QACA,8BAAQ;AAAA,MACN;AAAA,QACE,KAAK,GAAG,KAAK;AAAA,QACb,QAAQ;AAAA,QACR,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,KAAK,GAAG,KAAK;AAAA,QACb,QAAQ;AAAA,QACR,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,KAAK,GAAG,KAAK;AAAA,QACb,QAAQ;AAAA,QACR,UAAU;AAAA,MACZ;AAAA,IACF,CAAC;AAAA,EACH;AACF;AAEO,SAAS,wBAAwB;AAAA,EACtC,OAAO;AAAA,EACP,QAAQ;AAAA,EACR;AAAA,EACA;AAAA,EACA,GAAG;AACL,GAAwB;AACtB,QAAM,WAAO,iCAAW,aAAa,cAAc,QAAQ;AAC3D,QAAM,kBAAc,wCAAkB;AAAA,IACpC,OAAO,gBAAgB,WAAW;AAAA,IAClC,GAAG;AAAA,IACH,kBAAc,sCAAgB;AAAA,MAC5B;AAAA,MACA,QAAQ;AAAA,MACR,SAAS;AAAA,IACX,CAAC;AAAA,IACD,aAAa;AAAA,MACX,gBAAgB;AAAA,MAChB,GAAG,KAAK,QAAQ;AAAA,MAChB,GAAG,QAAQ;AAAA,IACb;AAAA,IACA,qBAAqB;AAAA,MACnB,GAAG,KAAK,gBAAgB;AAAA,MACxB,GAAG,QAAQ;AAAA,IACb;AAAA,EACF,CAAC;AAED,SAAO;AAAA,IACL;AAAA;AAAA;AAAA;AAAA,IAKA,OAAO;AAAA;AAAA;AAAA;AAAA,IAKP,QAAQ;AAAA;AAAA;AAAA;AAAA,IAKR,aAA4B;AAC1B,aAAO,QAAQ,IAAI,CAAC,YAAY,cAAc,MAAM,GAAG,YAAY,eAAe,MAAM,CAAC,CAAC,EAAE,KAAK,MAAM,MAAS;AAAA,IAClH;AAAA;AAAA;AAAA;AAAA,IAKA,IAAI,MAAc;AAChB,aAAO,YAAY,aAAa;AAAA,IAClC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQA,gBAAgB,SAAiB,SAAwB;AACvD,kBAAY,aAAa,IAAI,EAAE,SAAS,QAAQ,CAAC;AAAA,IACnD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQA,gBAAgB,EAAE,OAAO,GAA6B;AACpD,UAAI,CAAC,YAAY,aAAa,iBAAiB;AAC7C,oBAAY,YAAY,mBAAmB,IAAI;AAAA,MACjD,OAAO;AACL,oBAAY,oBAAoB,mBAAmB,IAAI;AAAA,MACzD;AAAA,IACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAYA,OACE,EAAE,eAAe,YAAY,GAC7B,gBAC4B;AAC5B,UAAI,CAAC,eAAe;AAClB,cAAM,IAAI,MAAM,8DAA8D;AAAA,MAChF;AAEA,UAAI,CAAC,aAAa;AAChB,cAAM,IAAI,MAAM,4DAA4D;AAAA,MAC9E;AAEA,YAAM,cAAc,sCAAsC;AAAA,QACxD;AAAA,QACA,mBAAmB,aAAa;AAAA,MAClC;AACA,YAAM,UAAmB,CAAC;AAC1B,YAAM,kBAAmC,CAAC;AAE1C,YAAM,UAAmB;AAAA,QACvB,QAAQ;AAAA,QACR,MAAM;AAAA,QACN;AAAA,QACA;AAAA,QACA,MAAM;AAAA,QACN,oBAAoB;AAAA,QACpB,WAAW;AAAA,MACb;AAEA,aAAO,YAAY,QAAQ,SAAS,cAAc;AAAA,IACpD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAaA,qBACE,EAAE,eAAe,WAAW,4BAA4B,GACxD,gBACuC;AACvC,UAAI,CAAC,eAAe;AAClB,cAAM,IAAI,MAAM,4EAA4E;AAAA,MAC9F;AAEA,UAAI,CAAC,WAAW;AACd,cAAM,IAAI,MAAM,wEAAwE;AAAA,MAC1F;AAEA,YAAM,cAAc,2DACjB,QAAQ,mBAAmB,mBAAmB,aAAa,CAAC,EAC5D,QAAQ,eAAe,mBAAmB,SAAS,CAAC;AACvD,YAAM,UAAmB,CAAC;AAC1B,YAAM,kBAAmC,CAAC;AAE1C,YAAM,UAAmB;AAAA,QACvB,QAAQ;AAAA,QACR,MAAM;AAAA,QACN;AAAA,QACA;AAAA,QACA,MAAM,8BAA8B,8BAA8B,CAAC;AAAA,QACnE,oBAAoB;AAAA,QACpB,WAAW;AAAA,MACb;AAEA,aAAO,YAAY,QAAQ,SAAS,cAAc;AAAA,IACpD;AAAA,EACF;AACF;","names":[]}

package/dist/src/compositionClient.js

@@ -0,0 +1,178 @@
+// src/compositionClient.ts
+import { createAuth, createTransporter, getAlgoliaAgent, shuffle } from "@algolia/client-common";
+var apiClientVersion = "0.0.1-beta.2";
+function getDefaultHosts(appId) {
+  return [
+    {
+      url: `${appId}-dsn.algolia.net`,
+      accept: "read",
+      protocol: "https"
+    },
+    {
+      url: `${appId}.algolia.net`,
+      accept: "write",
+      protocol: "https"
+    }
+  ].concat(
+    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"
+      }
+    ])
+  );
+}
+function createCompositionClient({
+  appId: appIdOption,
+  apiKey: apiKeyOption,
+  authMode,
+  algoliaAgents,
+  ...options
+}) {
+  const auth = createAuth(appIdOption, apiKeyOption, authMode);
+  const transporter = createTransporter({
+    hosts: getDefaultHosts(appIdOption),
+    ...options,
+    algoliaAgent: getAlgoliaAgent({
+      algoliaAgents,
+      client: "Composition",
+      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,
+    /**
+     * The `apiKey` currently in use.
+     */
+    apiKey: apiKeyOption,
+    /**
+     * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
+     */
+    clearCache() {
+      return Promise.all([transporter.requestsCache.clear(), transporter.responsesCache.clear()]).then(() => void 0);
+    },
+    /**
+     * 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 });
+    },
+    /**
+     * Helper method to switch the API key used to authenticate the requests.
+     *
+     * @param params - Method params.
+     * @param params.apiKey - The new API Key to use.
+     */
+    setClientApiKey({ apiKey }) {
+      if (!authMode || authMode === "WithinHeaders") {
+        transporter.baseHeaders["x-algolia-api-key"] = apiKey;
+      } else {
+        transporter.baseQueryParameters["x-algolia-api-key"] = apiKey;
+      }
+    },
+    /**
+     * Runs a query on a single composition and returns matching results.
+     *
+     * Required API Key ACLs:
+     *  - search
+     * @param search - The search object.
+     * @param search.compositionID - Unique Composition ObjectID.
+     * @param search.requestBody - The requestBody object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    search({ compositionID, requestBody }, requestOptions) {
+      if (!compositionID) {
+        throw new Error("Parameter `compositionID` is required when calling `search`.");
+      }
+      if (!requestBody) {
+        throw new Error("Parameter `requestBody` is required when calling `search`.");
+      }
+      const requestPath = "/1/compositions/{compositionID}/run".replace(
+        "{compositionID}",
+        encodeURIComponent(compositionID)
+      );
+      const headers = {};
+      const queryParameters = {};
+      const request = {
+        method: "POST",
+        path: requestPath,
+        queryParameters,
+        headers,
+        data: requestBody,
+        useReadTransporter: true,
+        cacheable: true
+      };
+      return transporter.request(request, requestOptions);
+    },
+    /**
+     * Searches for values of a specified facet attribute on the composition\'s main source\'s index.  - By default, facet values are sorted by decreasing count.   You can adjust this with the `sortFacetValueBy` parameter. - Searching for facet values doesn\'t work if you have **more than 65 searchable facets and searchable attributes combined**.
+     *
+     * Required API Key ACLs:
+     *  - search
+     * @param searchForFacetValues - The searchForFacetValues object.
+     * @param searchForFacetValues.compositionID - Unique Composition ObjectID.
+     * @param searchForFacetValues.facetName - Facet attribute in which to search for values.  This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier.
+     * @param searchForFacetValues.searchForFacetValuesRequest - The searchForFacetValuesRequest object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    searchForFacetValues({ compositionID, facetName, searchForFacetValuesRequest }, requestOptions) {
+      if (!compositionID) {
+        throw new Error("Parameter `compositionID` is required when calling `searchForFacetValues`.");
+      }
+      if (!facetName) {
+        throw new Error("Parameter `facetName` is required when calling `searchForFacetValues`.");
+      }
+      const requestPath = "/1/compositions/{compositionID}/facets/{facetName}/query".replace("{compositionID}", encodeURIComponent(compositionID)).replace("{facetName}", encodeURIComponent(facetName));
+      const headers = {};
+      const queryParameters = {};
+      const request = {
+        method: "POST",
+        path: requestPath,
+        queryParameters,
+        headers,
+        data: searchForFacetValuesRequest ? searchForFacetValuesRequest : {},
+        useReadTransporter: true,
+        cacheable: true
+      };
+      return transporter.request(request, requestOptions);
+    }
+  };
+}
+export {
+  apiClientVersion,
+  createCompositionClient
+};
+//# sourceMappingURL=compositionClient.js.map

package/dist/src/compositionClient.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/compositionClient.ts"],"sourcesContent":["// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.\n\nimport type {\n  CreateClientOptions,\n  Headers,\n  Host,\n  QueryParameters,\n  Request,\n  RequestOptions,\n} from '@algolia/client-common';\nimport { createAuth, createTransporter, getAlgoliaAgent, shuffle } from '@algolia/client-common';\n\nimport type { SearchForFacetValuesResponse } from '../model/searchForFacetValuesResponse';\nimport type { SearchResponse } from '../model/searchResponse';\n\nimport type { SearchForFacetValuesProps, SearchProps } from '../model/clientMethodProps';\n\nexport const apiClientVersion = '0.0.1-beta.2';\n\nfunction getDefaultHosts(appId: string): Host[] {\n  return (\n    [\n      {\n        url: `${appId}-dsn.algolia.net`,\n        accept: 'read',\n        protocol: 'https',\n      },\n      {\n        url: `${appId}.algolia.net`,\n        accept: 'write',\n        protocol: 'https',\n      },\n    ] as Host[]\n  ).concat(\n    shuffle([\n      {\n        url: `${appId}-1.algolianet.com`,\n        accept: 'readWrite',\n        protocol: 'https',\n      },\n      {\n        url: `${appId}-2.algolianet.com`,\n        accept: 'readWrite',\n        protocol: 'https',\n      },\n      {\n        url: `${appId}-3.algolianet.com`,\n        accept: 'readWrite',\n        protocol: 'https',\n      },\n    ]),\n  );\n}\n\nexport function createCompositionClient({\n  appId: appIdOption,\n  apiKey: apiKeyOption,\n  authMode,\n  algoliaAgents,\n  ...options\n}: CreateClientOptions) {\n  const auth = createAuth(appIdOption, apiKeyOption, authMode);\n  const transporter = createTransporter({\n    hosts: getDefaultHosts(appIdOption),\n    ...options,\n    algoliaAgent: getAlgoliaAgent({\n      algoliaAgents,\n      client: 'Composition',\n      version: apiClientVersion,\n    }),\n    baseHeaders: {\n      'content-type': 'text/plain',\n      ...auth.headers(),\n      ...options.baseHeaders,\n    },\n    baseQueryParameters: {\n      ...auth.queryParameters(),\n      ...options.baseQueryParameters,\n    },\n  });\n\n  return {\n    transporter,\n\n    /**\n     * The `appId` currently in use.\n     */\n    appId: appIdOption,\n\n    /**\n     * The `apiKey` currently in use.\n     */\n    apiKey: apiKeyOption,\n\n    /**\n     * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.\n     */\n    clearCache(): Promise<void> {\n      return Promise.all([transporter.requestsCache.clear(), transporter.responsesCache.clear()]).then(() => undefined);\n    },\n\n    /**\n     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.\n     */\n    get _ua(): string {\n      return transporter.algoliaAgent.value;\n    },\n\n    /**\n     * Adds a `segment` to the `x-algolia-agent` sent with every requests.\n     *\n     * @param segment - The algolia agent (user-agent) segment to add.\n     * @param version - The version of the agent.\n     */\n    addAlgoliaAgent(segment: string, version?: string): void {\n      transporter.algoliaAgent.add({ segment, version });\n    },\n\n    /**\n     * Helper method to switch the API key used to authenticate the requests.\n     *\n     * @param params - Method params.\n     * @param params.apiKey - The new API Key to use.\n     */\n    setClientApiKey({ apiKey }: { apiKey: string }): void {\n      if (!authMode || authMode === 'WithinHeaders') {\n        transporter.baseHeaders['x-algolia-api-key'] = apiKey;\n      } else {\n        transporter.baseQueryParameters['x-algolia-api-key'] = apiKey;\n      }\n    },\n\n    /**\n     * Runs a query on a single composition and returns matching results.\n     *\n     * Required API Key ACLs:\n     *  - search\n     * @param search - The search object.\n     * @param search.compositionID - Unique Composition ObjectID.\n     * @param search.requestBody - The requestBody object.\n     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.\n     */\n    search<T>(\n      { compositionID, requestBody }: SearchProps,\n      requestOptions?: RequestOptions,\n    ): Promise<SearchResponse<T>> {\n      if (!compositionID) {\n        throw new Error('Parameter `compositionID` is required when calling `search`.');\n      }\n\n      if (!requestBody) {\n        throw new Error('Parameter `requestBody` is required when calling `search`.');\n      }\n\n      const requestPath = '/1/compositions/{compositionID}/run'.replace(\n        '{compositionID}',\n        encodeURIComponent(compositionID),\n      );\n      const headers: Headers = {};\n      const queryParameters: QueryParameters = {};\n\n      const request: Request = {\n        method: 'POST',\n        path: requestPath,\n        queryParameters,\n        headers,\n        data: requestBody,\n        useReadTransporter: true,\n        cacheable: true,\n      };\n\n      return transporter.request(request, requestOptions);\n    },\n\n    /**\n     * Searches for values of a specified facet attribute on the composition\\'s main source\\'s index.  - By default, facet values are sorted by decreasing count.   You can adjust this with the `sortFacetValueBy` parameter. - Searching for facet values doesn\\'t work if you have **more than 65 searchable facets and searchable attributes combined**.\n     *\n     * Required API Key ACLs:\n     *  - search\n     * @param searchForFacetValues - The searchForFacetValues object.\n     * @param searchForFacetValues.compositionID - Unique Composition ObjectID.\n     * @param searchForFacetValues.facetName - Facet attribute in which to search for values.  This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier.\n     * @param searchForFacetValues.searchForFacetValuesRequest - The searchForFacetValuesRequest object.\n     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.\n     */\n    searchForFacetValues(\n      { compositionID, facetName, searchForFacetValuesRequest }: SearchForFacetValuesProps,\n      requestOptions?: RequestOptions,\n    ): Promise<SearchForFacetValuesResponse> {\n      if (!compositionID) {\n        throw new Error('Parameter `compositionID` is required when calling `searchForFacetValues`.');\n      }\n\n      if (!facetName) {\n        throw new Error('Parameter `facetName` is required when calling `searchForFacetValues`.');\n      }\n\n      const requestPath = '/1/compositions/{compositionID}/facets/{facetName}/query'\n        .replace('{compositionID}', encodeURIComponent(compositionID))\n        .replace('{facetName}', encodeURIComponent(facetName));\n      const headers: Headers = {};\n      const queryParameters: QueryParameters = {};\n\n      const request: Request = {\n        method: 'POST',\n        path: requestPath,\n        queryParameters,\n        headers,\n        data: searchForFacetValuesRequest ? searchForFacetValuesRequest : {},\n        useReadTransporter: true,\n        cacheable: true,\n      };\n\n      return transporter.request(request, requestOptions);\n    },\n  };\n}\n"],"mappings":";AAUA,SAAS,YAAY,mBAAmB,iBAAiB,eAAe;AAOjE,IAAM,mBAAmB;AAEhC,SAAS,gBAAgB,OAAuB;AAC9C,SACE;AAAA,IACE;AAAA,MACE,KAAK,GAAG,KAAK;AAAA,MACb,QAAQ;AAAA,MACR,UAAU;AAAA,IACZ;AAAA,IACA;AAAA,MACE,KAAK,GAAG,KAAK;AAAA,MACb,QAAQ;AAAA,MACR,UAAU;AAAA,IACZ;AAAA,EACF,EACA;AAAA,IACA,QAAQ;AAAA,MACN;AAAA,QACE,KAAK,GAAG,KAAK;AAAA,QACb,QAAQ;AAAA,QACR,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,KAAK,GAAG,KAAK;AAAA,QACb,QAAQ;AAAA,QACR,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,KAAK,GAAG,KAAK;AAAA,QACb,QAAQ;AAAA,QACR,UAAU;AAAA,MACZ;AAAA,IACF,CAAC;AAAA,EACH;AACF;AAEO,SAAS,wBAAwB;AAAA,EACtC,OAAO;AAAA,EACP,QAAQ;AAAA,EACR;AAAA,EACA;AAAA,EACA,GAAG;AACL,GAAwB;AACtB,QAAM,OAAO,WAAW,aAAa,cAAc,QAAQ;AAC3D,QAAM,cAAc,kBAAkB;AAAA,IACpC,OAAO,gBAAgB,WAAW;AAAA,IAClC,GAAG;AAAA,IACH,cAAc,gBAAgB;AAAA,MAC5B;AAAA,MACA,QAAQ;AAAA,MACR,SAAS;AAAA,IACX,CAAC;AAAA,IACD,aAAa;AAAA,MACX,gBAAgB;AAAA,MAChB,GAAG,KAAK,QAAQ;AAAA,MAChB,GAAG,QAAQ;AAAA,IACb;AAAA,IACA,qBAAqB;AAAA,MACnB,GAAG,KAAK,gBAAgB;AAAA,MACxB,GAAG,QAAQ;AAAA,IACb;AAAA,EACF,CAAC;AAED,SAAO;AAAA,IACL;AAAA;AAAA;AAAA;AAAA,IAKA,OAAO;AAAA;AAAA;AAAA;AAAA,IAKP,QAAQ;AAAA;AAAA;AAAA;AAAA,IAKR,aAA4B;AAC1B,aAAO,QAAQ,IAAI,CAAC,YAAY,cAAc,MAAM,GAAG,YAAY,eAAe,MAAM,CAAC,CAAC,EAAE,KAAK,MAAM,MAAS;AAAA,IAClH;AAAA;AAAA;AAAA;AAAA,IAKA,IAAI,MAAc;AAChB,aAAO,YAAY,aAAa;AAAA,IAClC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQA,gBAAgB,SAAiB,SAAwB;AACvD,kBAAY,aAAa,IAAI,EAAE,SAAS,QAAQ,CAAC;AAAA,IACnD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQA,gBAAgB,EAAE,OAAO,GAA6B;AACpD,UAAI,CAAC,YAAY,aAAa,iBAAiB;AAC7C,oBAAY,YAAY,mBAAmB,IAAI;AAAA,MACjD,OAAO;AACL,oBAAY,oBAAoB,mBAAmB,IAAI;AAAA,MACzD;AAAA,IACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAYA,OACE,EAAE,eAAe,YAAY,GAC7B,gBAC4B;AAC5B,UAAI,CAAC,eAAe;AAClB,cAAM,IAAI,MAAM,8DAA8D;AAAA,MAChF;AAEA,UAAI,CAAC,aAAa;AAChB,cAAM,IAAI,MAAM,4DAA4D;AAAA,MAC9E;AAEA,YAAM,cAAc,sCAAsC;AAAA,QACxD;AAAA,QACA,mBAAmB,aAAa;AAAA,MAClC;AACA,YAAM,UAAmB,CAAC;AAC1B,YAAM,kBAAmC,CAAC;AAE1C,YAAM,UAAmB;AAAA,QACvB,QAAQ;AAAA,QACR,MAAM;AAAA,QACN;AAAA,QACA;AAAA,QACA,MAAM;AAAA,QACN,oBAAoB;AAAA,QACpB,WAAW;AAAA,MACb;AAEA,aAAO,YAAY,QAAQ,SAAS,cAAc;AAAA,IACpD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAaA,qBACE,EAAE,eAAe,WAAW,4BAA4B,GACxD,gBACuC;AACvC,UAAI,CAAC,eAAe;AAClB,cAAM,IAAI,MAAM,4EAA4E;AAAA,MAC9F;AAEA,UAAI,CAAC,WAAW;AACd,cAAM,IAAI,MAAM,wEAAwE;AAAA,MAC1F;AAEA,YAAM,cAAc,2DACjB,QAAQ,mBAAmB,mBAAmB,aAAa,CAAC,EAC5D,QAAQ,eAAe,mBAAmB,SAAS,CAAC;AACvD,YAAM,UAAmB,CAAC;AAC1B,YAAM,kBAAmC,CAAC;AAE1C,YAAM,UAAmB;AAAA,QACvB,QAAQ;AAAA,QACR,MAAM;AAAA,QACN;AAAA,QACA;AAAA,QACA,MAAM,8BAA8B,8BAA8B,CAAC;AAAA,QACnE,oBAAoB;AAAA,QACpB,WAAW;AAAA,MACb;AAEA,aAAO,YAAY,QAAQ,SAAS,cAAc;AAAA,IACpD;AAAA,EACF;AACF;","names":[]}