feat(cli): add @coveo/search-token-server package

packages/search-token-server/.env.example

@@ -0,0 +1,8 @@
+# Coveo related configuration
+COVEO_PLATFORM_HOSTNAME=<PLATFORM_HOSTNAME dev,qa,prod,hippa>
+# for example https://platform.cloud.coveo.com
+COVEO_API_KEY=<YOUR_COVEO_API_KEY_HERE>
+USER_EMAIL=<YOUR_EMAIL>
+
+# Optional variables
+# SEARCH_HUB=<YOUR_SEARCH_HUB>

packages/search-token-server/.gitignore

@@ -0,0 +1 @@
+node_modules

packages/search-token-server/README.md

@@ -0,0 +1,7 @@
+# Simple search token generation server
+
+## Setup environment
+
+Create the `.env` file at the root of this project using `.env.example` as starting point and make sure to replace all emptied variables `<...>` by the proper information of your organization.
+
+For more info, https://docs.coveo.com/en/56/build-a-search-ui/search-token-authentication

packages/search-token-server/middlewares/searchToken.ts

@@ -0,0 +1,23 @@
+import {NextFunction} from 'express';
+import {getSearchToken} from '../utils/cloudPlatformAPI';
+
+export function ensureTokenGenerated(req: any, res: any, next: NextFunction) {
+  const userIds = [process.env.USER_EMAIL!].map((user) => ({
+    name: user,
+    provider: 'Email Security Provider',
+  }));
+
+  getSearchToken({
+    hostname: process.env.COVEO_PLATFORM_HOSTNAME!,
+    apiKey: process.env.COVEO_API_KEY!,
+    searchHub: process.env.SEARCH_HUB,
+    userIds: userIds,
+  })
+    .then((data: any) => {
+      req.token = data.token;
+      next();
+    })
+    .catch((err: any) => {
+      next(err);
+    });
+}

packages/search-token-server/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@coveo/search-token-server",
+  "author": "Coveo",
+  "version": "0.0.0",
+  "main": "server.ts",
+  "license": "Apache-2.0",
+  "dependencies": {
+    "dotenv": "^8.2.0",
+    "express": "^4.17.1",
+    "node-fetch": "^2.6.1",
+    "ts-node": "^9.1.1",
+    "typescript": "^4.1.5"
+  },
+  "scripts": {
+    "serve": "ts-node server.ts"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.11",
+    "@types/node-fetch": "^2.5.8"
+  }
+}

packages/search-token-server/server.ts

@@ -0,0 +1,26 @@
+/* eslint-disable @typescript-eslint/no-namespace */
+import * as express from 'express';
+import {ensureTokenGenerated} from './middlewares/searchToken';
+import {config} from 'dotenv';
+config();
+
+const app = express();
+
+declare global {
+  namespace Express {
+    interface Request {
+      token: string;
+    }
+  }
+}
+
+app.use(express.json());
+
+app.get('/token', ensureTokenGenerated, (req, res) => {
+  res.send({token: req.token});
+});
+
+// start our server on port 3000
+app.listen(3000, '127.0.0.1', () => {
+  console.log('Server now listening on 3000');
+});

packages/search-token-server/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "declaration": true,
+    "importHelpers": true,
+    "module": "commonjs",
+    "outDir": "lib",
+    "rootDir": "src",
+    "strict": true,
+    "target": "es2017",
+    "noEmitOnError": false
+  },
+  "include": ["src/**/*"]
+}

packages/search-token-server/utils/cloudPlatformAPI.ts

@@ -0,0 +1,24 @@
+import fetch, {Response} from 'node-fetch';
+
+export function getSearchToken(options: {
+  userIds: {name: string; provider: string}[];
+  hostname: string;
+  apiKey: string;
+  searchHub?: string;
+}) {
+  const body: {[id: string]: any} = {
+    userIds: options.userIds,
+  };
+  if (options.searchHub) {
+    body.searchHub = options.searchHub;
+  }
+
+  return fetch(`${options.hostname}/rest/search/token`, {
+    method: 'post',
+    body: JSON.stringify(body),
+    headers: {
+      Authorization: `Bearer ${options.apiKey}`,
+      'Content-Type': 'application/json',
+    },
+  }).then((res: Response) => res.json());
+}