feat: add minimal connector

src/index.ts

@@ -0,0 +1,81 @@
+/*
+ * Copyright (C) 2018 StApps
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation, version 3.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+import {ConnectorClient as Client} from '@openstapps/api/lib/connectorClient';
+import {SCMessage} from '@openstapps/core';
+
+export class MinimalConnector {
+  // Data is mocked inside of getItems()
+  private items: SCMessage[] = [];
+
+  /**
+   * Provides "fetched" items (e.g. messages)
+   * 
+   * @returns {Promise<SCMessage[]>}
+   * @memberof MinimalConnector
+   */
+  async getItems(): Promise<SCMessage[]> {
+    // reset items
+    this.items.length = 0;
+
+    // sample items (messages) "fetched" from some source
+    const importedItems: SCMessage[] = [
+      {
+        audiences: ['students', 'employees'],
+        description: 'Some description 1' ,
+        message: 'Some message 1',
+        name: 'Some name 1',
+        origin: {
+          indexed: (new Date()).toISOString(),
+          name: 'minimal connector',
+        },
+        type: 'message',
+        uid: '',
+      },
+      {
+        audiences: ['students', 'employees'],
+        description: 'Some description 2',
+        message: 'Some message 2',
+        name: 'Some name 2',
+        origin: {
+          indexed: (new Date()).toISOString(),
+          name: 'minimal connector',
+        },
+        type: 'message',
+        uid: '',
+      },
+      {
+        audiences: ['students', 'employees'],
+        description: 'Some description 3',
+        message: 'Some message 3',
+        name: 'Some name 3',
+        origin: {
+          indexed: (new Date()).toISOString(),
+          name: 'minimal connector',
+        },
+        type: 'message',
+        uid: '',
+      },
+    ];
+
+    // create a universally unique identifier for each item
+    for (const item of importedItems) {
+      // each uid is generated by a string and the namespace id of your university
+      item.uid = Client.makeUUID(JSON.stringify(item), 'f-u');
+      this.items.push(item);
+    }
+
+    return this.items;
+  }
+}