@diory/client-js 0.4.1 → 0.4.2-rc1

package/README.md

@@ -11,22 +11,20 @@ yarn add @diory/client-js
 ## Usage
 
 ```
-const clients = [localClient, S3Client, ...]
-const dioryClient = DioryClient(clients)
-dioryClient.initialiseDiosphere([connections])
-diosphere.initialise([connection])
-diosphere.enterRoom(room)
-diograph.focusDiory(diory)
-console.log('Hello Diosphere!', diosphere.toObject())
+const dataClients = [localClient, S3Client, ...]
+const dioryClient = new DioryClient(clients)
+const diograph = dioryClient.getDiograph(address)
+console.log('My Diory', diograph.toObject())
 ```
 
-### Internal methods
+### Methods
 
 ```
-client.getDiosphere()
-client.saveDiosphere()
-client.getDiograph()
-client.saveDiograph()
+dioryClient.addDiograph(address, diograph)
+dioryClient.getDiograph(address)
+dioryClient.fetchDiograph(address)
+dioryClient.generateDiograph(address)
+dioryClient.saveDiograph(address)
 ```
 
 ## Development

package/dist/dioryClient/dioryClient.d.ts

@@ -1,15 +1,15 @@
-import { IConnectionObject, IDiosphere, IRoom, IRoomObject, IDiograph, IDiory, IDioryObject, IDataClient } from '@diory/types';
+import { IDataClient } from '@diory/types';
+import { IDiograph, IDiographObject } from '@diograph/diograph';
 import { IDioryClient } from '../types';
-declare class DioryClient implements IDioryClient {
+export declare class DioryClient implements IDioryClient {
+    diographs: {
+        [address: string]: IDiograph;
+    };
     dataClients: IDataClient[];
-    diosphere: IDiosphere;
-    diograph: IDiograph;
-    room?: IRoom;
-    diory?: IDiory;
     constructor(dataClients: IDataClient[]);
-    initialiseDiosphere: (connections: IConnectionObject[]) => Promise<IDiosphere>;
-    initialiseDiograph: (roomObject: IRoomObject) => Promise<IDiograph>;
-    selectRoom: (roomObject: IRoomObject) => IRoom;
-    focusDiory: (dioryObject: IDioryObject) => IDiory;
+    addDiograph: (address: string, diographObject: IDiographObject) => IDioryClient;
+    getDiograph: (address: string) => IDiograph | undefined;
+    fetchDiograph: (address: string) => Promise<IDioryClient>;
+    generateDiograph: (address: string) => Promise<IDioryClient>;
+    saveDiograph: (address: string) => () => any;
 }
-export { DioryClient };

package/dist/dioryClient/dioryClient.js

@@ -1,48 +1,68 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DioryClient = void 0;
-const diosphere_js_1 = require("@diory/diosphere-js");
+const path_browserify_1 = require("path-browserify");
 const diograph_1 = require("@diograph/diograph");
-const connection_client_js_1 = require("@diory/connection-client-js");
-const addDefaultRoom_1 = require("../utils/addDefaultRoom");
-const addDefaultDiograph_1 = require("../utils/addDefaultDiograph");
+const folder_generator_1 = require("@diograph/folder-generator");
+const debounce_1 = require("../utils/debounce");
+const resolveConnection = (address) => {
+    const addressArray = (address || '').split('/') || [];
+    return {
+        client: addressArray[0],
+        path: addressArray.slice(1, -1).join('/'),
+        id: addressArray[addressArray.length - 1],
+    };
+};
+const getDiographKey = (connection) => `${connection.client}/${connection.path}`;
+const findDataClient = (dataClients, client) => {
+    return dataClients.find(({ type }) => type === client);
+};
+const DIOGRAPH_JSON = 'diograph.json';
 class DioryClient {
     constructor(dataClients) {
-        this.initialiseDiosphere = async (connections) => {
-            console.info('initialiseDiosphere: connections', connections);
-            const connectionClient = new connection_client_js_1.ConnectionClient(this.dataClients, connections);
-            this.diosphere.connect(connectionClient);
-            await this.diosphere.getDiosphere();
-            if (!Object.keys(this.diosphere.rooms)) {
-                (0, addDefaultRoom_1.addDefaultRoom)(this.diosphere, connections);
-            }
-            this.selectRoom({ id: '/' });
-            return this.diosphere;
+        this.diographs = {};
+        this.addDiograph = (address, diographObject) => {
+            const connection = resolveConnection(address);
+            const diographKey = getDiographKey(connection);
+            this.diographs[diographKey] = new diograph_1.Diograph(this.saveDiograph(address)).addDiograph(diographObject);
+            return this;
         };
-        this.initialiseDiograph = async (roomObject) => {
-            var _a, _b;
-            console.info('initialiseDiograph: room', roomObject);
-            this.selectRoom(roomObject);
-            if ((_a = this.room) === null || _a === void 0 ? void 0 : _a.connections) {
-                const connectionClient = new connection_client_js_1.ConnectionClient(this.dataClients, (_b = this.room) === null || _b === void 0 ? void 0 : _b.connections);
-                this.diograph.connect(connectionClient);
-                await this.diograph.getDiograph();
-                if (!Object.keys(this.diograph.diograph)) {
-                    (0, addDefaultDiograph_1.addDefaultDiograph)(this.diograph);
-                }
-                this.focusDiory({ id: '/' });
-            }
-            return this.diograph;
+        this.getDiograph = (address) => {
+            const connection = resolveConnection(address);
+            const diographKey = getDiographKey(connection);
+            return this.diographs[diographKey];
         };
-        this.selectRoom = (roomObject) => {
-            return (this.room = this.diosphere.getRoom(roomObject));
+        this.fetchDiograph = async (address) => {
+            const { client, path } = resolveConnection(address);
+            const dataClient = findDataClient(this.dataClients, client);
+            if (dataClient) {
+                const diographString = await dataClient.readTextItem((0, path_browserify_1.join)(path, DIOGRAPH_JSON));
+                if (diographString)
+                    this.addDiograph(address, JSON.parse(diographString));
+            }
+            return this;
         };
-        this.focusDiory = (dioryObject) => {
-            return (this.diory = this.diograph.getDiory(dioryObject));
+        this.generateDiograph = async (address) => {
+            const { client, path } = resolveConnection(address);
+            const dataClient = findDataClient(this.dataClients, client);
+            if (dataClient) {
+                const diographObject = await (0, folder_generator_1.generateDiograph)(path, '/', dataClient);
+                if (diographObject)
+                    this.addDiograph(address, diographObject);
+            }
+            return this;
         };
+        this.saveDiograph = (address) => (0, debounce_1.debounce)(async () => {
+            const { client, path } = resolveConnection(address);
+            const dataClient = findDataClient(this.dataClients, client);
+            if (dataClient) {
+                const diograph = this.getDiograph(address);
+                if (diograph)
+                    dataClient.writeItem((0, path_browserify_1.join)(path, DIOGRAPH_JSON), diograph.toJson());
+            }
+            return;
+        }, 1000);
         this.dataClients = dataClients;
-        this.diosphere = new diosphere_js_1.Diosphere();
-        this.diograph = new diograph_1.Diograph();
     }
 }
 exports.DioryClient = DioryClient;

package/dist/dioryClient/dioryClient.spec.js

@@ -5,14 +5,4 @@ describe('dioryClient', () => {
             expect(true).toEqual(true);
         });
     });
-    describe('initialise()', () => {
-        it('should initialise with connections', () => {
-            expect(true).toEqual(true);
-        });
-    });
-    describe('enterRoom()', () => {
-        it('should initialise with connections', () => {
-            expect(true).toEqual(true);
-        });
-    });
 });

package/dist/index.d.ts

@@ -1,2 +1,2 @@
+export * from './types';
 export { DioryClient } from './dioryClient/dioryClient';
-export { IDioryClient } from './types';

package/dist/index.js

@@ -1,5 +1,20 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DioryClient = void 0;
+__exportStar(require("./types"), exports);
 var dioryClient_1 = require("./dioryClient/dioryClient");
 Object.defineProperty(exports, "DioryClient", { enumerable: true, get: function () { return dioryClient_1.DioryClient; } });

package/dist/types.d.ts

@@ -1,12 +1,17 @@
-import { IConnectionObject, IDiosphere, IRoom, IRoomObject } from '@diory/types';
-import { IDiograph, IDiory, IDioryObject } from '@diory/types';
+import { IDataClient } from '@diory/types';
+import { IDiograph } from '@diograph/diograph';
+export type IConnectionObject = {
+    client: string;
+    path: string;
+    id: string;
+};
 export interface IDioryClient {
-    diosphere: IDiosphere;
-    diograph: IDiograph;
-    room?: IRoom;
-    diory?: IDiory;
-    initialiseDiosphere: (connections: IConnectionObject[]) => Promise<IDiosphere>;
-    initialiseDiograph: (roomObject: IRoomObject) => Promise<IDiograph>;
-    selectRoom: (roomObject: IRoomObject) => IRoom;
-    focusDiory: (dioryObject: IDioryObject) => IDiory;
+    diographs: {
+        [address: string]: IDiograph;
+    };
+    dataClients: IDataClient[];
+    getDiograph: (address: string) => IDiograph | undefined;
+    generateDiograph: (address: string) => Promise<IDioryClient>;
+    fetchDiograph: (address: string) => Promise<IDioryClient>;
+    saveDiograph: (address: string) => () => void;
 }

package/dist/utils/debounce.d.ts

@@ -0,0 +1 @@
+export declare function debounce(func: any, wait: number, immediate?: boolean): () => typeof func;

package/dist/utils/debounce.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.debounce = void 0;
+function debounce(func, wait, immediate = false) {
+    let timeout;
+    // eslint-disable-next-line func-names
+    return () => {
+        // @ts-ignore
+        const context = this;
+        const args = arguments;
+        // eslint-disable-next-line func-names
+        const later = function () {
+            timeout = null;
+            if (!immediate)
+                func.apply(context, args);
+        };
+        const callNow = immediate && !timeout;
+        clearTimeout(timeout);
+        timeout = setTimeout(later, wait);
+        if (callNow)
+            func.apply(context, args);
+    };
+}
+exports.debounce = debounce;

package/package.json

@@ -1,14 +1,13 @@
 {
   "name": "@diory/client-js",
-  "version": "0.4.1",
+  "version": "0.4.2-rc1",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "author": "Olli-Pekka Pohjola <op@diory.me>, Jouni Alanen <jouni@diory.me>",
   "license": "MIT",
   "dependencies": {
-    "@diograph/diograph": "^0.4.1",
-    "@diory/connection-client-js": "^0.4.1",
-    "@diory/diosphere-js": "^0.4.1",
+    "@diograph/diograph": "^0.4.3",
+    "@diograph/folder-generator": "^0.4.2",
     "path-browserify": "^1.0.1",
     "uuid": "8.3.2"
   },

package/src/dioryClient/dioryClient.spec.ts

@@ -4,16 +4,4 @@ describe('dioryClient', () => {
       expect(true).toEqual(true)
     })
   })
-
-  describe('initialise()', () => {
-    it('should initialise with connections', () => {
-      expect(true).toEqual(true)
-    })
-  })
-
-  describe('enterRoom()', () => {
-    it('should initialise with connections', () => {
-      expect(true).toEqual(true)
-    })
-  })
 })

package/src/dioryClient/dioryClient.ts

@@ -1,82 +1,83 @@
-import { Diosphere } from '@diory/diosphere-js'
-import { Diograph } from '@diograph/diograph'
-import { ConnectionClient } from '@diory/connection-client-js'
-
-import {
-  IConnectionObject,
-  IDiosphere,
-  IRoom,
-  IRoomObject,
-  IDiograph,
-  IDiory,
-  IDioryObject,
-  IDataClient,
-  IConnectionClient,
-} from '@diory/types'
-
-import { IDioryClient } from '../types'
-
-import { addDefaultRoom } from '../utils/addDefaultRoom'
-import { addDefaultDiograph } from '../utils/addDefaultDiograph'
-
-class DioryClient implements IDioryClient {
-  dataClients: IDataClient[]
-  diosphere: IDiosphere
-  diograph: IDiograph
-  room?: IRoom
-  diory?: IDiory
+import { join } from 'path-browserify'
+import { IDataClient } from '@diory/types'
+import { Diograph, IDiograph, IDiographObject } from '@diograph/diograph'
+import { generateDiograph } from '@diograph/folder-generator'
 
-  constructor(dataClients: IDataClient[]) {
-    this.dataClients = dataClients
-    this.diosphere = new Diosphere()
-    this.diograph = new Diograph()
+import { IConnectionObject, IDioryClient } from '../types'
+
+import { debounce } from '../utils/debounce'
+
+const resolveConnection = (address: string): IConnectionObject => {
+  const addressArray = (address || '').split('/') || []
+  return {
+    client: addressArray[0],
+    path: addressArray.slice(1, -1).join('/'),
+    id: addressArray[addressArray.length - 1],
   }
+}
 
-  initialiseDiosphere = async (connections: IConnectionObject[]): Promise<IDiosphere> => {
-    console.info('initialiseDiosphere: connections', connections)
+const getDiographKey = (connection: IConnectionObject) => `${connection.client}/${connection.path}`
 
-    const connectionClient: IConnectionClient = new ConnectionClient(this.dataClients, connections)
-    this.diosphere.connect(connectionClient)
-    await this.diosphere.getDiosphere()
+const findDataClient = (dataClients: IDataClient[], client: string): IDataClient | undefined => {
+  return dataClients.find(({ type }) => type === client)
+}
 
-    if (!Object.keys(this.diosphere.rooms)) {
-      addDefaultRoom(this.diosphere, connections)
-    }
+const DIOGRAPH_JSON = 'diograph.json'
 
-    this.selectRoom({ id: '/' })
+export class DioryClient implements IDioryClient {
+  diographs: { [address: string]: IDiograph } = {}
+  dataClients: IDataClient[]
 
-    return this.diosphere
+  constructor(dataClients: IDataClient[]) {
+    this.dataClients = dataClients
   }
 
-  initialiseDiograph = async (roomObject: IRoomObject): Promise<IDiograph> => {
-    console.info('initialiseDiograph: room', roomObject)
-    this.selectRoom(roomObject)
-
-    if (this.room?.connections) {
-      const connectionClient: IConnectionClient = new ConnectionClient(
-        this.dataClients,
-        this.room?.connections,
-      )
-      this.diograph.connect(connectionClient)
-      await this.diograph.getDiograph()
+  addDiograph = (address: string, diographObject: IDiographObject): IDioryClient => {
+    const connection = resolveConnection(address)
+    const diographKey = getDiographKey(connection)
+    this.diographs[diographKey] = new Diograph(this.saveDiograph(address)).addDiograph(
+      diographObject,
+    )
+    return this
+  }
 
-      if (!Object.keys(this.diograph.diograph)) {
-        addDefaultDiograph(this.diograph)
-      }
+  getDiograph = (address: string): IDiograph | undefined => {
+    const connection = resolveConnection(address)
+    const diographKey = getDiographKey(connection)
+    return this.diographs[diographKey]
+  }
 
-      this.focusDiory({ id: '/' })
+  fetchDiograph = async (address: string): Promise<IDioryClient> => {
+    const { client, path } = resolveConnection(address)
+    const dataClient = findDataClient(this.dataClients, client)
+    if (dataClient) {
+      const diographString = await dataClient.readTextItem(join(path, DIOGRAPH_JSON))
+      if (diographString) this.addDiograph(address, JSON.parse(diographString))
     }
 
-    return this.diograph
+    return this
   }
 
-  selectRoom = (roomObject: IRoomObject): IRoom => {
-    return (this.room = this.diosphere.getRoom(roomObject))
-  }
+  generateDiograph = async (address: string): Promise<IDioryClient> => {
+    const { client, path } = resolveConnection(address)
+    const dataClient = findDataClient(this.dataClients, client)
+    if (dataClient) {
+      const diographObject = await generateDiograph(path, '/', dataClient)
+      if (diographObject) this.addDiograph(address, diographObject)
+    }
 
-  focusDiory = (dioryObject: IDioryObject): IDiory => {
-    return (this.diory = this.diograph.getDiory(dioryObject))
+    return this
   }
-}
 
-export { DioryClient }
+  saveDiograph = (address: string) =>
+    debounce(async () => {
+      const { client, path } = resolveConnection(address)
+      const dataClient = findDataClient(this.dataClients, client)
+      if (dataClient) {
+        const diograph = this.getDiograph(address)
+        if (diograph) dataClient.writeItem(join(path, DIOGRAPH_JSON), diograph.toJson())
+      }
+
+      return
+    }, 1000)
+}

package/src/index.ts

@@ -1,2 +1,2 @@
+export * from './types'
 export { DioryClient } from './dioryClient/dioryClient'
-export { IDioryClient } from './types'

package/src/types.ts

@@ -1,13 +1,17 @@
-import { IConnectionObject, IDiosphere, IRoom, IRoomObject } from '@diory/types'
-import { IDiograph, IDiory, IDioryObject } from '@diory/types'
+import { IDataClient } from '@diory/types'
+import { IDiograph } from '@diograph/diograph'
+
+export type IConnectionObject = {
+  client: string
+  path: string
+  id: string
+}
 
 export interface IDioryClient {
-  diosphere: IDiosphere
-  diograph: IDiograph
-  room?: IRoom
-  diory?: IDiory
-  initialiseDiosphere: (connections: IConnectionObject[]) => Promise<IDiosphere>
-  initialiseDiograph: (roomObject: IRoomObject) => Promise<IDiograph>
-  selectRoom: (roomObject: IRoomObject) => IRoom
-  focusDiory: (dioryObject: IDioryObject) => IDiory
+  diographs: { [address: string]: IDiograph }
+  dataClients: IDataClient[]
+  getDiograph: (address: string) => IDiograph | undefined
+  generateDiograph: (address: string) => Promise<IDioryClient>
+  fetchDiograph: (address: string) => Promise<IDioryClient>
+  saveDiograph: (address: string) => () => void
 }

package/src/utils/debounce.ts

@@ -0,0 +1,18 @@
+export function debounce(func: any, wait: number, immediate = false) {
+  let timeout: any
+  // eslint-disable-next-line func-names
+  return (): typeof func => {
+    // @ts-ignore
+    const context = this
+    const args = arguments
+    // eslint-disable-next-line func-names
+    const later = function () {
+      timeout = null
+      if (!immediate) func.apply(context, args)
+    }
+    const callNow = immediate && !timeout
+    clearTimeout(timeout)
+    timeout = setTimeout(later, wait)
+    if (callNow) func.apply(context, args)
+  }
+}

package/dist/utils/addDefaultDiograph.d.ts

@@ -1,2 +0,0 @@
-import { IDiograph } from '@diory/types';
-export declare const addDefaultDiograph: (diograph: IDiograph) => void;

package/dist/utils/addDefaultDiograph.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.addDefaultDiograph = void 0;
-const addDefaultDiograph = (diograph) => {
-    const diory = diograph.addDiory({
-        text: 'Welcome to Diory',
-        latlng: '60.01366036242365, 20.007133483886722',
-    });
-    diograph.addDiory({
-        text: 'Root diory',
-        links: [{ id: diory.id }],
-    }, '/');
-};
-exports.addDefaultDiograph = addDefaultDiograph;

package/dist/utils/addDefaultRoom.d.ts

@@ -1,2 +0,0 @@
-import { IConnectionObject, IDiosphere } from '@diory/types';
-export declare const addDefaultRoom: (diosphere: IDiosphere, connections: IConnectionObject[]) => void;

package/dist/utils/addDefaultRoom.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.addDefaultRoom = void 0;
-const addDefaultRoom = (diosphere, connections) => {
-    diosphere.addRoom({
-        text: 'Home room',
-        connections,
-    }, '/');
-};
-exports.addDefaultRoom = addDefaultRoom;

package/src/utils/addDefaultDiograph.ts

@@ -1,15 +0,0 @@
-import { IDiograph } from '@diory/types'
-
-export const addDefaultDiograph = (diograph: IDiograph): void => {
-  const diory = diograph.addDiory({
-    text: 'Welcome to Diory',
-    latlng: '60.01366036242365, 20.007133483886722',
-  })
-  diograph.addDiory(
-    {
-      text: 'Root diory',
-      links: [{ id: diory.id }],
-    },
-    '/',
-  )
-}

package/src/utils/addDefaultRoom.ts

@@ -1,11 +0,0 @@
-import { IConnectionObject, IDiosphere } from '@diory/types'
-
-export const addDefaultRoom = (diosphere: IDiosphere, connections: IConnectionObject[]): void => {
-  diosphere.addRoom(
-    {
-      text: 'Home room',
-      connections,
-    },
-    '/',
-  )
-}