feat: Adds insertStatements.

Author: ryasmi

package-lock.json

@@ -23,11 +23,14 @@
     "check-coverage": true
   },
   "dependencies": {
+    "axios": "^0.18.0",
+    "base-64": "^0.1.0",
     "lodash": "^4.17.11"
   },
   "devDependencies": {
     "@ht2-labs/semantic-release": "1.1.27",
     "@ht2-labs/typescript-project": "2.0.2",
+    "@types/base-64": "0.1.2",
     "@types/lodash": "4.14.116",
     "@types/mocha": "5.2.5",
     "@types/source-map-support": "0.4.1",

package.json

@@ -0,0 +1,23 @@
+import createBasicAuthToken from '../statementUtils/createBasicAuthToken';
+import insertStatements from '../statementUtils/insertStatements';
+import actionOnSiteActivity from './actionOnSiteActivity';
+
+const main = async () => {
+  try {
+    await insertStatements({
+      statements: [actionOnSiteActivity],
+      endpoint: 'https://example.org/lrs/xAPI',
+      authToken: createBasicAuthToken({
+        key: 'demo-key',
+        secret: 'demo-secret',
+      }),
+    });
+    // tslint:disable-next-line:no-console
+    console.log('Successfully inserted statements');
+  } catch {
+    // tslint:disable-next-line:no-console
+    console.log('Failed inserting statements');
+  }
+};
+
+main();

src/examples/insertingStatements.ts

@@ -10,7 +10,9 @@ import loggedOutOfSite from './statementCreators/loggedOutOfSite';
 import registeredToSite from './statementCreators/registeredToSite';
 import createActivity from './statementUtils/createActivity';
 import createAgent from './statementUtils/createAgent';
+import createBasicAuthToken from './statementUtils/createBasicAuthToken';
 import createTimestamp from './statementUtils/createTimestamp';
+import insertStatements from './statementUtils/insertStatements';
 import * as types from './statementUtils/types';
 
 export const statementCreators = {
@@ -26,7 +28,9 @@ export const statementCreators = {
 export const statementUtils = {
   createActivity,
   createAgent,
+  createBasicAuthToken,
   createTimestamp,
+  insertStatements,
   types,
 };
 

src/index.ts

@@ -0,0 +1,11 @@
+import { encode } from 'base-64';
+
+export interface BasicAuthOpts {
+  readonly key: string;
+  readonly secret: string;
+}
+
+export default function createBasicAuthToken(opts: BasicAuthOpts) {
+  const encodedCredentials = encode(`${opts.key}:${opts.secret})`);
+  return `Basic ${encodedCredentials}`;
+}

src/statementUtils/createBasicAuthToken.ts

@@ -0,0 +1,34 @@
+import axios from 'axios';
+import { Statement } from './types';
+
+interface StatementInsertionOpts {
+  /** An array of statements to be inserted to the LRS. */
+  readonly statements: Statement[];
+
+  /**
+   * The URL that provides access to the LRS (e.g. https://example.org/xAPI).
+   * Do not use a trailing slash (e.g. https://example.org/xAPI/).
+   * Do not add `/statements` (e.g. https://example.org/xAPI/statements).
+   */
+  readonly endpoint: string;
+
+  /**
+   * The authorization header value that provides access to the LRS.
+   * Use `createBasicAuthToken` from `statementUtils` for basic authentication tokens.
+   */
+  readonly authToken: string;
+}
+
+/**
+ * Makes a HTTP POST request to the LRS to insert the statements.
+ */
+export default async function insertStatements(opts: StatementInsertionOpts) {
+  const url = `${opts.endpoint}/statements`;
+  const headers = {
+    Authorization: opts.authToken,
+    'X-Experience-API-Version': '1.0.3',
+    'Content-Type': 'application/json',
+  };
+  const body = JSON.stringify(opts.statements);
+  return axios.post(url, body, { headers });
+}