feat(javascript): create ingestion client

millotp · millotp · commit 231749e6855a · 2022-12-13T13:37:22.000+01:00
diff --git a/clients/algoliasearch-client-javascript/packages/client-common/src/transporter/createTransporter.ts b/clients/algoliasearch-client-javascript/packages/client-common/src/transporter/createTransporter.ts
@@ -36,6 +36,7 @@ export function createTransporter({
   baseHeaders,
   baseQueryParameters,
   algoliaAgent,
+  useAlgoliaTracking,
   timeouts,
   requester,
   requestsCache,
@@ -110,7 +111,7 @@ export function createTransporter({
         : {};
 
     const queryParameters: QueryParameters = {
-      'x-algolia-agent': algoliaAgent.value,
+      ...(useAlgoliaTracking ? { 'x-algolia-agent': algoliaAgent.value } : {}),
       ...baseQueryParameters,
       ...request.queryParameters,
       ...dataQueryParameters,
@@ -337,6 +338,7 @@ export function createTransporter({
     requester,
     timeouts,
     algoliaAgent,
+    useAlgoliaTracking,
     baseHeaders,
     baseQueryParameters,
     hosts,
diff --git a/clients/algoliasearch-client-javascript/packages/client-common/src/types/createClient.ts b/clients/algoliasearch-client-javascript/packages/client-common/src/types/createClient.ts
@@ -9,7 +9,7 @@ type OverriddenTransporterOptions =
 
 export type CreateClientOptions = Omit<
   TransporterOptions,
-  OverriddenTransporterOptions | 'algoliaAgent'
+  OverriddenTransporterOptions | 'algoliaAgent' | 'useAlgoliaTracking'
 > &
   Partial<Pick<TransporterOptions, OverriddenTransporterOptions>> & {
     appId: string;
diff --git a/clients/algoliasearch-client-javascript/packages/client-common/src/types/transporter.ts b/clients/algoliasearch-client-javascript/packages/client-common/src/types/transporter.ts
@@ -139,6 +139,8 @@ export type TransporterOptions = {
    * The user agent used. Sent on query parameters.
    */
   algoliaAgent: AlgoliaAgent;
+
+  useAlgoliaTracking: boolean;
 };
 
 export type Transporter = TransporterOptions & {
diff --git a/clients/algoliasearch-client-javascript/yarn.lock b/clients/algoliasearch-client-javascript/yarn.lock
@@ -109,6 +109,19 @@ __metadata:
   languageName: unknown
   linkType: soft
 
+"@algolia/ingestion@workspace:packages/ingestion":
+  version: 0.0.0-use.local
+  resolution: "@algolia/ingestion@workspace:packages/ingestion"
+  dependencies:
+    "@algolia/client-common": 5.0.0-alpha.26
+    "@algolia/requester-browser-xhr": 5.0.0-alpha.26
+    "@algolia/requester-node-http": 5.0.0-alpha.26
+    "@types/node": 16.11.59
+    rollup: 2.79.1
+    typescript: 4.8.3
+  languageName: unknown
+  linkType: soft
+
 "@algolia/predict@workspace:packages/predict":
   version: 0.0.0-use.local
   resolution: "@algolia/predict@workspace:packages/predict"
diff --git a/config/openapitools.json b/config/openapitools.json
@@ -65,6 +65,12 @@
           "packageVersion": "1.0.0-alpha.27"
         }
       },
+      "javascript-ingestion": {
+        "output": "#{cwd}/clients/algoliasearch-client-javascript/packages/ingestion",
+        "additionalProperties": {
+          "packageVersion": "1.0.0-alpha"
+        }
+      },
       "java-search": {
         "output": "#{cwd}/clients/algoliasearch-client-java-2"
       },
diff --git a/generators/src/main/java/com/algolia/codegen/AlgoliaJavaScriptGenerator.java b/generators/src/main/java/com/algolia/codegen/AlgoliaJavaScriptGenerator.java
@@ -119,6 +119,7 @@ private void setDefaultGeneratorOptions() {
     additionalProperties.put("algoliaAgent", Utils.capitalize(CLIENT));
     additionalProperties.put("gitRepoId", "algoliasearch-client-javascript");
     additionalProperties.put("isSearchClient", CLIENT.equals("search"));
+    additionalProperties.put("useAlgoliaTracking", !CLIENT.equals("ingestion"));
     additionalProperties.put("isAlgoliasearchClient", isAlgoliasearchClient);
 
     if (isAlgoliasearchClient) {
diff --git a/generators/src/main/java/com/algolia/codegen/GenericPropagator.java b/generators/src/main/java/com/algolia/codegen/GenericPropagator.java
@@ -169,6 +169,9 @@ public static void propagateGenericsToModels(Map<String, ModelsMap> modelsMap) {
   public static void propagateGenericsToOperations(OperationsMap operations, List<ModelMap> allModels) {
     Map<String, CodegenModel> models = convertToMap(allModels);
     for (CodegenOperation ope : operations.getOperations().getOperation()) {
+      if (ope.returnType == null) {
+        continue;
+      }
       CodegenModel returnType = models.get(ope.returnType);
       if (returnType != null && hasGeneric(returnType)) {
         ope.vendorExtensions.put("x-is-generic", true);
diff --git a/playground/javascript/node/ingestion.ts b/playground/javascript/node/ingestion.ts
@@ -0,0 +1,29 @@
+import { ingestionClient } from '@algolia/ingestion';
+import { ApiError } from '@algolia/client-common';
+import dotenv from 'dotenv';
+
+dotenv.config({ path: '../../.env' });
+
+const appId = process.env.ALGOLIA_APPLICATION_ID || '**** APP_ID *****';
+const apiKey =
+  process.env.ALGOLIA_ADMIN_KEY ||
+  '**** ADMIN_KEY *****';
+
+// Init client with appId and apiKey
+const client = ingestionClient(appId, apiKey, 'us', {authMode: 'WithinHeaders'});
+
+async function testIngestion() {
+  try {
+    const res = await client.createAuthentication({input: {appID: appId, apiKey}, name: 'test', type: 'algolia'});
+
+    console.log(`[OK]`, res);
+  } catch (e) {
+    if (e instanceof ApiError) {
+      return console.log(`[${e.status}] ${e.message}`, e.stackTrace, e);
+    }
+
+    console.log('[ERROR]', e);
+  }
+}
+
+testIngestion();
diff --git a/playground/javascript/node/package.json b/playground/javascript/node/package.json
@@ -4,8 +4,9 @@
   "private": true,
   "scripts": {
     "start:algoliasearch": "ts-node algoliasearch.ts",
-    "start:abtesting": "ts-node analytics.ts",
+    "start:abtesting": "ts-node abtesting.ts",
     "start:analytics": "ts-node analytics.ts",
+    "start:ingestion": "ts-node ingestion.ts",
     "start:insights": "ts-node insights.ts",
     "start:personalization": "ts-node personalization.ts",
     "start:query-suggestions": "ts-node query-suggestions.ts",
@@ -23,6 +24,7 @@
     "@algolia/client-query-suggestions": "link:../../../clients/algoliasearch-client-javascript/packages/client-query-suggestions",
     "@algolia/client-search": "link:../../../clients/algoliasearch-client-javascript/packages/client-search",
     "@algolia/client-sources": "link:../../../clients/algoliasearch-client-javascript/packages/client-sources",
+    "@algolia/ingestion": "link:../../../clients/algoliasearch-client-javascript/packages/ingestion",
     "@algolia/predict": "link:../../../clients/algoliasearch-client-javascript/packages/predict",
     "@algolia/recommend": "link:../../../clients/algoliasearch-client-javascript/packages/recommend",
     "@algolia/requester-node-http": "link:../../../clients/algoliasearch-client-javascript/packages/requester-node-http",
diff --git a/templates/javascript/clients/api-single.mustache b/templates/javascript/clients/api-single.mustache
@@ -19,6 +19,7 @@ export function create{{capitalizedApiName}}({
   const transporter = createTransporter({
     hosts: getDefaultHosts({{^hasRegionalHost}}appIdOption{{/hasRegionalHost}}{{#hasRegionalHost}}regionOption{{/hasRegionalHost}}),
     ...options,
+    useAlgoliaTracking: {{{useAlgoliaTracking}}},
     algoliaAgent: getAlgoliaAgent({
       algoliaAgents,
       client: '{{{algoliaAgent}}}',
@@ -75,7 +76,7 @@ export function create{{capitalizedApiName}}({
     {{/isSearchClient}}
     {{#operation}}
     {{> client/api/operation/jsdoc}}
-    {{nickname}}{{#vendorExtensions.x-is-generic}}<T>{{/vendorExtensions.x-is-generic}}( {{> client/api/operation/parameters}} ) : Promise<{{{returnType}}}{{#vendorExtensions.x-is-generic}}<T>{{/vendorExtensions.x-is-generic}}> {
+    {{nickname}}{{#vendorExtensions.x-is-generic}}<T>{{/vendorExtensions.x-is-generic}}( {{> client/api/operation/parameters}} ) : Promise<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}}{{#vendorExtensions.x-is-generic}}<T>{{/vendorExtensions.x-is-generic}}> {
       {{#vendorExtensions.x-legacy-signature}}
         {{> client/api/operation/legacySearchCompatible/implementation}}
       {{/vendorExtensions.x-legacy-signature}}
diff --git a/yarn.lock b/yarn.lock
@@ -98,6 +98,12 @@ __metadata:
   languageName: node
   linkType: soft
 
+"@algolia/ingestion@link:../../../clients/algoliasearch-client-javascript/packages/ingestion::locator=javascript-playground%40workspace%3Aplayground%2Fjavascript%2Fnode":
+  version: 0.0.0-use.local
+  resolution: "@algolia/ingestion@link:../../../clients/algoliasearch-client-javascript/packages/ingestion::locator=javascript-playground%40workspace%3Aplayground%2Fjavascript%2Fnode"
+  languageName: node
+  linkType: soft
+
 "@algolia/predict@link:../../../clients/algoliasearch-client-javascript/packages/predict::locator=javascript-playground%40workspace%3Aplayground%2Fjavascript%2Fnode":
   version: 0.0.0-use.local
   resolution: "@algolia/predict@link:../../../clients/algoliasearch-client-javascript/packages/predict::locator=javascript-playground%40workspace%3Aplayground%2Fjavascript%2Fnode"
@@ -5475,6 +5481,7 @@ __metadata:
     "@algolia/client-query-suggestions": "link:../../../clients/algoliasearch-client-javascript/packages/client-query-suggestions"
     "@algolia/client-search": "link:../../../clients/algoliasearch-client-javascript/packages/client-search"
     "@algolia/client-sources": "link:../../../clients/algoliasearch-client-javascript/packages/client-sources"
+    "@algolia/ingestion": "link:../../../clients/algoliasearch-client-javascript/packages/ingestion"
     "@algolia/predict": "link:../../../clients/algoliasearch-client-javascript/packages/predict"
     "@algolia/recommend": "link:../../../clients/algoliasearch-client-javascript/packages/recommend"
     "@algolia/requester-node-http": "link:../../../clients/algoliasearch-client-javascript/packages/requester-node-http"
