@diory/client-js 0.2.0-rc2 → 0.2.0-rc20

package/.github/workflows/publish.yml

@@ -0,0 +1,44 @@
+name: Publish to NPM
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Specify the version to publish'
+        required: true
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: '.nvmrc'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install dependencies
+        run: yarn install
+
+      - name: Build
+        run: yarn build
+
+      - name: Update version using Yarn
+        run: |
+          git config user.email "<>"
+          git config user.name "GitHub Actions Bot"
+          yarn version --new-version ${{ github.event.inputs.version }}
+
+      - name: Push version update commit
+        run: git push origin HEAD --follow-tags
+
+      - name: Publish to NPM
+        run: npm publish --access=public --tag=next
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}

package/.github/workflows/yarn-test.yml

@@ -0,0 +1,23 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Test (yarn test)
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    env:
+      CI: false
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: '.nvmrc'
+      - run: yarn
+      - run: yarn build
+      - run: yarn test

package/.nvmrc

@@ -0,0 +1 @@
+20.10.0

package/dist/connectionClient/utils/debounce.d.ts

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

package/dist/connectionClient/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/dist/dioryClient/defaultDiograph.json

@@ -0,0 +1,24 @@
+{
+  "/": {
+    "id": "welcome-root-diory"
+  },
+  "welcome-root-diory": {
+    "id": "welcome-root-diory",
+    "text": "Room",
+    "image": "",
+    "links": [
+      {
+        "id": "welcome-diory"
+      }
+    ],
+    "modified": "2020-01-03T14:03:04.751Z"
+  },
+  "welcome-diory": {
+    "id": "welcome-diory",
+    "image": "",
+    "modified": "2020-01-03T14:03:04.751Z",
+    "text": "Welcome to Diory",
+    "latitude": 60.01366036242365,
+    "longitude": 20.007133483886722
+  }
+}

package/dist/dioryClient/defaultDiosphere.d.ts

@@ -0,0 +1,21 @@
+export declare const diosphere: {
+  rooms: {
+    '/': {
+      id: string
+      created: string
+      modified: string
+    }
+    'welcome-room': {
+      id: string
+      text: string
+      doors: never[]
+      connections: {
+        id: string
+        client: string
+        address: string
+      }[]
+      created: string
+      modified: string
+    }
+  }
+}

package/dist/dioryClient/defaultDiosphere.js

@@ -0,0 +1,26 @@
+'use strict'
+Object.defineProperty(exports, '__esModule', { value: true })
+exports.diosphere = void 0
+exports.diosphere = {
+  rooms: {
+    '/': {
+      id: 'welcome-room',
+      created: '2024-03-24T14:56:21.243Z',
+      modified: '2024-03-24T14:56:21.243Z',
+    },
+    'welcome-room': {
+      id: 'welcome-room',
+      text: 'Wellcome',
+      doors: [],
+      connections: [
+        {
+          id: 'welcome-connection',
+          client: 'LocalClient',
+          address: 'public/welcome-room',
+        },
+      ],
+      created: '2024-03-24T14:56:21.243Z',
+      modified: '2024-03-24T14:56:21.243Z',
+    },
+  },
+}

package/dist/dioryClient/defaultDiosphere.json

@@ -0,0 +1,23 @@
+{
+  "rooms": {
+    "/": {
+      "id": "welcome-room",
+      "created": "2024-03-24T14:56:21.243Z",
+      "modified": "2024-03-24T14:56:21.243Z"
+    },
+    "welcome-room": {
+      "id": "welcome-room",
+      "text": "Wellcome room",
+      "doors": [],
+      "connections": [
+        {
+          "id": "welcome-room",
+          "client": "LocalClient",
+          "address": "public/welcome-room"
+        }
+      ],
+      "created": "2024-03-24T14:56:21.243Z",
+      "modified": "2024-03-24T14:56:21.243Z"
+    }
+  }
+}

package/dist/dioryClient/dioryClient.d.ts

@@ -1,5 +1,5 @@
-import { IConnectionObject, IDiosphere, IRoom, IRoomObject } from '@diory/diosphere-js';
-import { IDiograph, IDiory, IDioryObject } from '@diograph/diograph';
+import { IConnectionObject, IDiosphere, IDiosphereObject, IRoom, IRoomObject } from '@diory/diosphere-js';
+import { IDiograph, IDiographObject, IDiory, IDioryObject } from '@diograph/diograph';
 import { IDioryClient, IDataClient } from '../types';
 declare class DioryClient implements IDioryClient {
     dataClients: IDataClient[];
@@ -9,13 +9,17 @@ declare class DioryClient implements IDioryClient {
     diograph: IDiograph;
     diory?: IDiory;
     constructor(dataClients: IDataClient[]);
-    initialise: (connections: IConnectionObject[]) => Promise<IDioryClient>;
-    enterRoom: (roomObject: IRoomObject) => Promise<IRoom>;
+    selectRoom: (roomObject: IRoomObject) => IRoom;
+    getDiosphereClients: (connections?: IConnectionObject[]) => import("../types").IConnectionClient[];
+    initialiseDiosphere: (connections: IConnectionObject[]) => Promise<IDiosphere>;
+    getDiosphere: (connections?: IConnectionObject[]) => Promise<IDiosphereObject | undefined>;
+    saveDiosphere: (connections?: IConnectionObject[]) => Promise<IDiosphereObject>;
+    getDiographClients: (connections?: IConnectionObject[]) => import("../types").IConnectionClient[];
     focusDiory: (dioryObject: IDioryObject) => IDiory;
-    getDiosphere: () => Promise<IDiosphere>;
-    saveDiosphere: () => Promise<IDiosphere>;
-    getDiograph: () => Promise<IDiograph>;
-    saveDiograph: () => Promise<IDiograph>;
-    generateDiograph: () => Promise<IDiograph>;
+    initialiseDiograph: (roomObject: IRoomObject) => Promise<IDiograph>;
+    getDiograph: (connections?: IConnectionObject[]) => Promise<IDiographObject | undefined>;
+    saveDiograph: (connections?: IConnectionObject[]) => Promise<IDiographObject>;
+    mergeDiograph: (diographObject: IDiographObject) => Promise<void>;
+    generateDiograph: (connections?: IConnectionObject[]) => Promise<IDiographObject | undefined>;
 }
 export { DioryClient };

package/dist/dioryClient/dioryClient.js

@@ -4,99 +4,127 @@ exports.DioryClient = void 0;
 const diosphere_js_1 = require("@diory/diosphere-js");
 const diograph_1 = require("@diograph/diograph");
 const getConnectionClients_1 = require("../utils/getConnectionClients");
+const debounce_1 = require("../connectionClient/utils/debounce");
+const getDefaultDiosphere_1 = require("./getDefaultDiosphere");
+const getDefaultDiograph_1 = require("./getDefaultDiograph");
 class DioryClient {
     constructor(dataClients) {
         this.dataClients = [];
         this.connections = [];
-        this.initialise = async (connections) => {
+        this.selectRoom = (roomObject) => {
+            return (this.room = this.diosphere.getRoom(roomObject));
+        };
+        this.getDiosphereClients = (connections) => {
+            return (0, getConnectionClients_1.getConnectionClients)(this.dataClients, connections !== null && connections !== void 0 ? connections : this.connections);
+        };
+        this.initialiseDiosphere = async (connections) => {
+            var _a;
+            console.info('initialiseDiosphere', connections);
             this.connections = connections;
             this.diosphere.resetRooms();
-            await this.getDiosphere();
-            await this.enterRoom({ id: '/' });
-            return this;
+            const diosphereObject = (_a = (await this.getDiosphere())) !== null && _a !== void 0 ? _a : (0, getDefaultDiosphere_1.getDefaultDiosphere)(connections);
+            this.diosphere.addDiosphere(diosphereObject);
+            this.selectRoom({ id: '/' });
+            console.info(this.diosphere.toObject());
+            return this.diosphere;
         };
-        this.enterRoom = async (roomObject) => {
-            this.room = this.diosphere.getRoom(roomObject);
-            this.diograph.resetDiograph();
-            await this.getDiograph();
-            this.focusDiory({ id: '/' });
-            await this.generateDiograph();
-            return this.room;
+        this.getDiosphere = async (connections) => {
+            console.info('getDiosphere', connections);
+            let diosphereObject;
+            await Promise.all(this.getDiosphereClients(connections).map(async (connectionClient) => {
+                try {
+                    diosphereObject = await connectionClient.getDiosphere();
+                    console.info(diosphereObject);
+                }
+                catch (error) {
+                    console.error(error);
+                }
+                return;
+            }));
+            return diosphereObject;
+        };
+        this.saveDiosphere = async (connections) => {
+            console.info('saveDiosphere', connections);
+            const diosphereObject = this.diosphere.toObject();
+            await Promise.all(this.getDiosphereClients(connections).map(async (connectionClient) => {
+                await connectionClient.saveDiosphere(diosphereObject);
+                console.info(diosphereObject);
+                return;
+            }));
+            return diosphereObject;
+        };
+        this.getDiographClients = (connections) => {
+            var _a;
+            return (0, getConnectionClients_1.getConnectionClients)(this.dataClients, connections !== null && connections !== void 0 ? connections : (_a = this.room) === null || _a === void 0 ? void 0 : _a.connections);
         };
         this.focusDiory = (dioryObject) => {
             return (this.diory = this.diograph.getDiory(dioryObject));
         };
-        this.getDiosphere = async () => {
-            console.info('getDiosphere', this.connections);
-            if (this.connections) {
-                const connectionClients = (0, getConnectionClients_1.getConnectionClients)(this.dataClients, this.connections);
-                await Promise.all(connectionClients.map(async (connectionClient) => {
-                    const diosphereObject = await connectionClient.getDiosphere();
-                    console.info(diosphereObject);
-                    return this.diosphere.addDiosphere(diosphereObject);
-                }));
-            }
-            return this.diosphere;
-        };
-        this.saveDiosphere = async () => {
-            console.info('saveDiosphere', this.connections);
-            if (this.connections) {
-                const connectionClients = (0, getConnectionClients_1.getConnectionClients)(this.dataClients, this.connections);
-                await Promise.all(connectionClients.map(async (connectionClient) => {
-                    console.info(this.diosphere.toObject());
-                    await connectionClient.saveDiosphere(this.diosphere.toObject());
-                    return;
-                }));
-            }
-            return this.diosphere;
+        this.initialiseDiograph = async (roomObject) => {
+            var _a;
+            console.info('initialiseDiograph', roomObject);
+            this.selectRoom(roomObject);
+            this.diograph.resetDiograph();
+            const diographObject = (_a = (await this.getDiograph())) !== null && _a !== void 0 ? _a : (0, getDefaultDiograph_1.getDefaultDiograph)();
+            this.diograph.addDiograph(diographObject);
+            this.focusDiory({ id: '/' });
+            console.info(this.diograph.toObject());
+            return this.diograph;
         };
-        this.getDiograph = async () => {
-            var _a, _b;
-            console.info('getDiograph', (_a = this.room) === null || _a === void 0 ? void 0 : _a.connections);
-            if ((_b = this.room) === null || _b === void 0 ? void 0 : _b.connections) {
-                const connectionClients = (0, getConnectionClients_1.getConnectionClients)(this.dataClients, this.room.connections);
-                await Promise.all(connectionClients.map(async (connectionClient) => {
-                    const diographObject = await connectionClient.getDiograph();
+        this.getDiograph = async (connections) => {
+            console.info('getDiograph', connections);
+            let diographObject;
+            await Promise.all(this.getDiographClients(connections).map(async (connectionClient) => {
+                try {
+                    diographObject = await connectionClient.getDiograph();
                     console.info(diographObject);
-                    this.diograph.addDiograph(diographObject);
-                    return;
-                }));
-            }
-            return this.diograph;
+                }
+                catch (error) {
+                    console.error(error);
+                }
+                return;
+            }));
+            return diographObject;
         };
-        this.saveDiograph = async () => {
-            var _a, _b;
-            console.info('saveDiograph', (_a = this.room) === null || _a === void 0 ? void 0 : _a.connections);
-            if ((_b = this.room) === null || _b === void 0 ? void 0 : _b.connections) {
-                const connectionClients = (0, getConnectionClients_1.getConnectionClients)(this.dataClients, this.room.connections);
-                await Promise.all(connectionClients.map(async (connectionClient) => {
-                    console.info(this.diograph.toObject());
-                    await connectionClient.saveDiograph(this.diograph.toObject());
-                    return;
-                }));
-            }
-            return this.diograph;
+        this.saveDiograph = async (connections) => {
+            console.info('saveDiograph', connections);
+            const diographObject = this.diograph.toObject();
+            await Promise.all(this.getDiographClients(connections).map(async (connectionClient) => {
+                await connectionClient.saveDiograph(diographObject);
+                console.info(diographObject);
+                return;
+            }));
+            return diographObject;
         };
-        this.generateDiograph = async () => {
-            var _a, _b, _c;
-            console.info('generateDiograph', (_a = this.room) === null || _a === void 0 ? void 0 : _a.connections);
-            if ((_b = this.room) === null || _b === void 0 ? void 0 : _b.connections) {
-                const connectionClients = (0, getConnectionClients_1.getConnectionClients)(this.dataClients, (_c = this.room) === null || _c === void 0 ? void 0 : _c.connections);
-                await Promise.all(connectionClients.map(async (connectionClient) => {
-                    const diographObject = await connectionClient.generateDiograph();
-                    console.info(diographObject);
-                    this.diograph.addDiograph(diographObject);
-                    await connectionClient.saveDiograph(this.diograph.toObject());
-                    return;
-                }));
-            }
-            return this.diograph;
+        this.mergeDiograph = async (diographObject) => {
+            Object.entries(diographObject).forEach(([key, dioryObject]) => {
+                try {
+                    key === '/'
+                        ? this.diograph.addDioryLink({ id: '/' }, diographObject['/'])
+                        : this.diograph.addDiory(dioryObject);
+                }
+                catch (error) {
+                    console.error(error);
+                }
+            });
+            await this.saveDiograph();
+            console.info(this.diograph.toObject());
+        };
+        this.generateDiograph = async (connections) => {
+            console.info('generateDiograph', connections);
+            let diographObject;
+            await Promise.all(this.getDiographClients(connections).map(async (connectionClient) => {
+                diographObject = await connectionClient.generateDiograph();
+                console.info(diographObject);
+                return;
+            }));
+            return diographObject;
         };
         this.dataClients = dataClients;
         this.diosphere = new diosphere_js_1.Diosphere();
         this.diograph = new diograph_1.Diograph();
-        this.diosphere.saveDiosphere = this.saveDiosphere;
-        this.diograph.saveDiograph = this.saveDiograph;
+        this.diosphere.saveDiosphere = (0, debounce_1.debounce)(this.saveDiosphere, 1000);
+        this.diograph.saveDiograph = (0, debounce_1.debounce)(this.saveDiograph, 1000);
     }
 }
 exports.DioryClient = DioryClient;

package/dist/dioryClient/getDefaultDiograph.d.ts

@@ -0,0 +1,2 @@
+import { IDiographObject } from '@diograph/diograph';
+export declare const getDefaultDiograph: () => IDiographObject;

package/dist/dioryClient/getDefaultDiograph.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDefaultDiograph = void 0;
+const diograph_1 = require("@diograph/diograph");
+const getDefaultDiograph = () => {
+    const diograph = new diograph_1.Diograph();
+    const diory = diograph.addDiory({
+        text: 'Welcome to Diory',
+        latlng: '60.01366036242365, 20.007133483886722',
+    });
+    diograph.addDiory({
+        text: 'Room root',
+        links: [{ id: diory.id }],
+    }, '/');
+    return diograph.toObject();
+};
+exports.getDefaultDiograph = getDefaultDiograph;

package/dist/dioryClient/getDefaultDiosphere.d.ts

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

package/dist/dioryClient/getDefaultDiosphere.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDefaultDiosphere = void 0;
+const diosphere_js_1 = require("@diory/diosphere-js");
+const getDefaultDiosphere = (connections) => {
+    const diosphere = new diosphere_js_1.Diosphere();
+    diosphere.addRoom({
+        text: 'Welcome room',
+        connections,
+    }, '/');
+    return diosphere.toObject();
+};
+exports.getDefaultDiosphere = getDefaultDiosphere;

package/dist/types.d.ts

@@ -5,6 +5,9 @@ export interface IMetadata {
     name: string;
     created?: string;
     modified?: string;
+    duration?: string;
+    thumbnail?: string;
+    latlng?: string;
 }
 export interface IFileType {
     ext?: string;
@@ -23,8 +26,10 @@ export interface IDataClient {
     list(url: string): Promise<string[]>;
     getFileNames(url: string): Promise<string[]>;
     getFolderNames(url: string): Promise<string[]>;
-    getMetadata(url: string): IMetadata;
     getFileType(url: string): Promise<IFileType>;
+    getMetadata(url: string): IMetadata;
+    getThumbnail?(imageUrl: string): Promise<string | undefined>;
+    getVideoMetadata?(videoUrl: string): Promise<IMetadata>;
 }
 export interface IConnectionClient {
     type: string;
@@ -43,12 +48,13 @@ export interface IDioryClient {
     room?: IRoom;
     diograph: IDiograph;
     diory?: IDiory;
-    initialise: (connections: IConnectionObject[]) => Promise<IDioryClient>;
-    enterRoom: (roomObject: IRoomObject) => Promise<IRoom>;
+    selectRoom: (roomObject: IRoomObject) => IRoom;
+    getDiosphere: () => Promise<IDiosphereObject | undefined>;
+    saveDiosphere: () => Promise<IDiosphereObject>;
+    initialiseDiosphere: (connections: IConnectionObject[]) => Promise<IDiosphere>;
     focusDiory: (dioryObject: IDioryObject) => IDiory;
-    getDiosphere: () => Promise<IDiosphere>;
-    saveDiosphere: () => Promise<IDiosphere>;
-    getDiograph: () => Promise<IDiograph>;
-    saveDiograph: () => Promise<IDiograph>;
-    generateDiograph: () => Promise<IDiograph>;
+    getDiograph: () => Promise<IDiographObject | undefined>;
+    saveDiograph: () => Promise<IDiographObject>;
+    initialiseDiograph: (roomObject: IRoomObject) => Promise<IDiograph>;
+    generateDiograph: () => Promise<IDiographObject | undefined>;
 }

package/dist/utils/getConnectionClients.d.ts

@@ -1,3 +1,3 @@
 import { IConnectionObject } from '@diory/diosphere-js';
 import { IConnectionClient, IDataClient } from '../types';
-export declare function getConnectionClients(dataClients: IDataClient[], connections: IConnectionObject[]): IConnectionClient[];
+export declare function getConnectionClients(dataClients: IDataClient[], connections?: IConnectionObject[]): IConnectionClient[];

package/dist/utils/getConnectionClients.js

@@ -6,9 +6,7 @@ function getDataClient(dataClients, { client }) {
     return dataClients.find(({ type }) => type === client);
 }
 function getConnectionClients(dataClients, connections) {
-    return connections
-        .filter(({ client }) => dataClients.some(({ type }) => type === client))
-        .map((connection) => {
+    return connections === null || connections === void 0 ? void 0 : connections.filter(({ client }) => dataClients.some(({ type }) => type === client)).map((connection) => {
         const dataClient = getDataClient(dataClients, connection);
         return new connectionClient_1.ConnectionClient(dataClient, connection);
     });

package/jest.config.js

@@ -0,0 +1,6 @@
+/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  testPathIgnorePatterns: ['dist', 'node_modules'],
+}

package/package.json

@@ -1,17 +1,14 @@
 {
   "name": "@diory/client-js",
-  "version": "0.2.0-rc2",
+  "version": "0.2.0-rc20",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
   "author": "Olli-Pekka Pohjola <op@diory.me>, Jouni Alanen <jouni@diory.me>",
   "license": "MIT",
   "dependencies": {
-    "@diograph/diograph": "0.3.0-rc14",
-    "@diograph/folder-generator": "^0.3.0-rc1",
-    "@diory/diosphere-js": "0.2.6-rc2",
+    "@diograph/diograph": "0.3.0-rc16",
+    "@diograph/folder-generator": "^0.3.0-rc3",
+    "@diory/diosphere-js": "0.2.6-rc4",
     "path-browserify": "^1.0.1",
     "uuid": "8.3.2"
   },

package/src/connectionClient/connectionClient.spec.ts

@@ -0,0 +1,19 @@
+describe('connectionClient', () => {
+  describe('construct()', () => {
+    it('should construct with dataClient and connection', () => {
+      expect(true).toEqual(true)
+    })
+  })
+
+  describe('getDiosphere()', () => {
+    it('should get diosphere', () => {
+      expect(true).toEqual(true)
+    })
+  })
+
+  describe('saveDiosphere()', () => {
+    it('should save diosphere object', () => {
+      expect(true).toEqual(true)
+    })
+  })
+})

package/src/connectionClient/connectionClient.ts

@@ -0,0 +1,52 @@
+import { join } from 'path-browserify'
+import { generateDiograph } from '@diograph/folder-generator'
+
+import { IDiographObject } from '@diograph/diograph'
+import { IConnectionObject, IDiosphereObject } from '@diory/diosphere-js'
+import { IConnectionClient, IDataClient } from '../types'
+
+const DIOSPHERE_JSON = 'diosphere.json'
+const DIOGRAPH_JSON = 'diograph.json'
+
+class ConnectionClient implements IConnectionClient {
+  type: string
+  client: IDataClient
+  connection: IConnectionObject
+
+  constructor(dataClient: IDataClient, connection: IConnectionObject) {
+    this.type = dataClient.type
+    this.client = dataClient
+    this.connection = connection
+  }
+
+  getDiosphere = async () => {
+    const path = join(this.connection.address, DIOSPHERE_JSON)
+    const diosphereString = await this.client.readTextItem(path)
+    return JSON.parse(diosphereString)
+  }
+
+  saveDiosphere = async (diosphereObject: IDiosphereObject) => {
+    const path = join(this.connection.address, DIOSPHERE_JSON)
+    const diosphereString = JSON.stringify(diosphereObject, null, 2)
+    return this.client.writeItem(path, diosphereString)
+  }
+
+  getDiograph = async () => {
+    const path = join(this.connection.address, DIOGRAPH_JSON)
+    const diographString = await this.client.readTextItem(path)
+    return JSON.parse(diographString)
+  }
+
+  saveDiograph = async (diographObject: IDiographObject) => {
+    const path = join(this.connection.address, DIOGRAPH_JSON)
+    const diographString = JSON.stringify(diographObject, null, 2)
+    return this.client.writeItem(path, diographString)
+  }
+
+  generateDiograph = async (): Promise<IDiographObject> => {
+    const { diograph } = await generateDiograph(this.connection.address, this.client)
+    return diograph.toObject()
+  }
+}
+
+export { ConnectionClient }

package/src/connectionClient/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/src/dioryClient/dioryClient.spec.ts

@@ -0,0 +1,19 @@
+describe('dioryClient', () => {
+  describe('constructor()', () => {
+    it('should construct with dataClient', () => {
+      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

@@ -0,0 +1,183 @@
+import {
+  Diosphere,
+  IConnectionObject,
+  IDiosphere,
+  IDiosphereObject,
+  IRoom,
+  IRoomObject,
+} from '@diory/diosphere-js'
+import { Diograph, IDiograph, IDiographObject, IDiory, IDioryObject } from '@diograph/diograph'
+
+import { IDioryClient, IDataClient } from '../types'
+import { getConnectionClients } from '../utils/getConnectionClients'
+import { debounce } from '../connectionClient/utils/debounce'
+
+import { getDefaultDiosphere } from './getDefaultDiosphere'
+import { getDefaultDiograph } from './getDefaultDiograph'
+
+class DioryClient implements IDioryClient {
+  dataClients: IDataClient[] = []
+  connections: IConnectionObject[] = []
+  diosphere: IDiosphere
+  room?: IRoom
+  diograph: IDiograph
+  diory?: IDiory
+
+  constructor(dataClients: IDataClient[]) {
+    this.dataClients = dataClients
+
+    this.diosphere = new Diosphere()
+    this.diograph = new Diograph()
+
+    this.diosphere.saveDiosphere = debounce(this.saveDiosphere, 1000)
+    this.diograph.saveDiograph = debounce(this.saveDiograph, 1000)
+  }
+
+  selectRoom = (roomObject: IRoomObject): IRoom => {
+    return (this.room = this.diosphere.getRoom(roomObject))
+  }
+
+  getDiosphereClients = (connections?: IConnectionObject[]) => {
+    return getConnectionClients(this.dataClients, connections ?? this.connections)
+  }
+
+  initialiseDiosphere = async (connections: IConnectionObject[]): Promise<IDiosphere> => {
+    console.info('initialiseDiosphere', connections)
+    this.connections = connections
+
+    this.diosphere.resetRooms()
+    const diosphereObject = (await this.getDiosphere()) ?? getDefaultDiosphere(connections)
+    this.diosphere.addDiosphere(diosphereObject)
+
+    this.selectRoom({ id: '/' })
+
+    console.info(this.diosphere.toObject())
+    return this.diosphere
+  }
+
+  getDiosphere = async (
+    connections?: IConnectionObject[],
+  ): Promise<IDiosphereObject | undefined> => {
+    console.info('getDiosphere', connections)
+
+    let diosphereObject
+    await Promise.all(
+      this.getDiosphereClients(connections).map(async (connectionClient) => {
+        try {
+          diosphereObject = await connectionClient.getDiosphere()
+          console.info(diosphereObject)
+        } catch (error) {
+          console.error(error)
+        }
+        return
+      }),
+    )
+
+    return diosphereObject
+  }
+
+  saveDiosphere = async (connections?: IConnectionObject[]): Promise<IDiosphereObject> => {
+    console.info('saveDiosphere', connections)
+
+    const diosphereObject = this.diosphere.toObject()
+    await Promise.all(
+      this.getDiosphereClients(connections).map(async (connectionClient) => {
+        await connectionClient.saveDiosphere(diosphereObject)
+        console.info(diosphereObject)
+        return
+      }),
+    )
+
+    return diosphereObject
+  }
+
+  getDiographClients = (connections?: IConnectionObject[]) => {
+    return getConnectionClients(this.dataClients, connections ?? this.room?.connections)
+  }
+
+  focusDiory = (dioryObject: IDioryObject): IDiory => {
+    return (this.diory = this.diograph.getDiory(dioryObject))
+  }
+
+  initialiseDiograph = async (roomObject: IRoomObject): Promise<IDiograph> => {
+    console.info('initialiseDiograph', roomObject)
+    this.selectRoom(roomObject)
+
+    this.diograph.resetDiograph()
+    const diographObject = (await this.getDiograph()) ?? getDefaultDiograph()
+    this.diograph.addDiograph(diographObject)
+
+    this.focusDiory({ id: '/' })
+
+    console.info(this.diograph.toObject())
+    return this.diograph
+  }
+
+  getDiograph = async (connections?: IConnectionObject[]): Promise<IDiographObject | undefined> => {
+    console.info('getDiograph', connections)
+
+    let diographObject
+    await Promise.all(
+      this.getDiographClients(connections).map(async (connectionClient) => {
+        try {
+          diographObject = await connectionClient.getDiograph()
+          console.info(diographObject)
+        } catch (error) {
+          console.error(error)
+        }
+        return
+      }),
+    )
+
+    return diographObject
+  }
+
+  saveDiograph = async (connections?: IConnectionObject[]): Promise<IDiographObject> => {
+    console.info('saveDiograph', connections)
+
+    const diographObject = this.diograph.toObject()
+    await Promise.all(
+      this.getDiographClients(connections).map(async (connectionClient) => {
+        await connectionClient.saveDiograph(diographObject)
+        console.info(diographObject)
+        return
+      }),
+    )
+
+    return diographObject
+  }
+
+  mergeDiograph = async (diographObject: IDiographObject) => {
+    Object.entries(diographObject).forEach(([key, dioryObject]) => {
+      try {
+        key === '/'
+          ? this.diograph.addDioryLink({ id: '/' }, diographObject['/'])
+          : this.diograph.addDiory(dioryObject)
+      } catch (error) {
+        console.error(error)
+      }
+    })
+
+    await this.saveDiograph()
+    console.info(this.diograph.toObject())
+  }
+
+  generateDiograph = async (
+    connections?: IConnectionObject[],
+  ): Promise<IDiographObject | undefined> => {
+    console.info('generateDiograph', connections)
+
+    let diographObject
+    await Promise.all(
+      this.getDiographClients(connections).map(async (connectionClient) => {
+        diographObject = await connectionClient.generateDiograph()
+        console.info(diographObject)
+        return
+      }),
+    )
+
+    return diographObject
+  }
+}
+
+export { DioryClient }

package/src/dioryClient/getDefaultDiograph.ts

@@ -0,0 +1,18 @@
+import { Diograph, IDiographObject } from '@diograph/diograph'
+
+export const getDefaultDiograph = (): IDiographObject => {
+  const diograph = new Diograph()
+  const diory = diograph.addDiory({
+    text: 'Welcome to Diory',
+    latlng: '60.01366036242365, 20.007133483886722',
+  })
+  diograph.addDiory(
+    {
+      text: 'Room root',
+      links: [{ id: diory.id }],
+    },
+    '/',
+  )
+
+  return diograph.toObject()
+}

package/src/dioryClient/getDefaultDiosphere.ts

@@ -0,0 +1,14 @@
+import { Diosphere, IConnectionObject, IDiosphereObject } from '@diory/diosphere-js'
+
+export const getDefaultDiosphere = (connections: IConnectionObject[]): IDiosphereObject => {
+  const diosphere = new Diosphere()
+  diosphere.addRoom(
+    {
+      text: 'Welcome room',
+      connections,
+    },
+    '/',
+  )
+
+  return diosphere.toObject()
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+export { DioryClient } from './dioryClient/dioryClient'
+export { ConnectionClient } from './connectionClient/connectionClient'
+export { IDioryClient, IConnectionClient, IDataClient, IFileType, IMetadata } from './types'

package/src/types.ts

@@ -0,0 +1,70 @@
+import {
+  IConnectionObject,
+  IDiosphere,
+  IDiosphereObject,
+  IRoom,
+  IRoomObject,
+} from '@diory/diosphere-js'
+import { IDiograph, IDiographObject, IDiory, IDioryObject } from '@diograph/diograph'
+
+export interface IMetadata {
+  name: string
+  created?: string
+  modified?: string
+  duration?: string
+  thumbnail?: string
+  latlng?: string
+}
+
+export interface IFileType {
+  ext?: string
+  mime?: string
+}
+
+export interface IDataClient {
+  type: string
+  readTextItem(url: string): Promise<string>
+  readItem(url: string): Promise<Buffer>
+  readToStream(url: string): any
+  exists(url: string): Promise<boolean>
+  writeTextItem(url: string, fileContent: string): Promise<boolean>
+  writeItem(url: string, fileContent: Buffer | string): Promise<boolean>
+  deleteItem(url: string): Promise<boolean>
+  deleteFolder(url: string): Promise<void>
+  list(url: string): Promise<string[]>
+  getFileNames(url: string): Promise<string[]>
+  getFolderNames(url: string): Promise<string[]>
+  getFileType(url: string): Promise<IFileType>
+  getMetadata(url: string): IMetadata
+  getThumbnail?(imageUrl: string): Promise<string | undefined>
+  getVideoMetadata?(videoUrl: string): Promise<IMetadata>
+}
+
+export interface IConnectionClient {
+  type: string
+  client: IDataClient
+  connection: IConnectionObject
+  getDiosphere: () => Promise<IDiosphereObject>
+  saveDiosphere: (diosphereObject: IDiosphereObject) => void
+  getDiograph: () => Promise<IDiographObject>
+  saveDiograph: (diographObject: IDiographObject) => void
+  generateDiograph: () => Promise<IDiographObject>
+}
+
+export interface IDioryClient {
+  dataClients: IDataClient[]
+  connections: IConnectionObject[]
+  diosphere: IDiosphere
+  room?: IRoom
+  diograph: IDiograph
+  diory?: IDiory
+  selectRoom: (roomObject: IRoomObject) => IRoom
+  getDiosphere: () => Promise<IDiosphereObject | undefined>
+  saveDiosphere: () => Promise<IDiosphereObject>
+  initialiseDiosphere: (connections: IConnectionObject[]) => Promise<IDiosphere>
+  focusDiory: (dioryObject: IDioryObject) => IDiory
+  getDiograph: () => Promise<IDiographObject | undefined>
+  saveDiograph: () => Promise<IDiographObject>
+  initialiseDiograph: (roomObject: IRoomObject) => Promise<IDiograph>
+  generateDiograph: () => Promise<IDiographObject | undefined>
+}

package/src/utils/getConnectionClients.ts

@@ -0,0 +1,23 @@
+import { IConnectionObject } from '@diory/diosphere-js'
+
+import { ConnectionClient } from '../connectionClient/connectionClient'
+import { IConnectionClient, IDataClient } from '../types'
+
+function getDataClient(
+  dataClients: IDataClient[],
+  { client }: IConnectionObject,
+): IDataClient | undefined {
+  return dataClients.find(({ type }) => type === client)
+}
+
+export function getConnectionClients(
+  dataClients: IDataClient[],
+  connections?: IConnectionObject[],
+): IConnectionClient[] {
+  return connections
+    ?.filter(({ client }) => dataClients.some(({ type }) => type === client))
+    .map((connection) => {
+      const dataClient = getDataClient(dataClients, connection)
+      return new ConnectionClient(dataClient!, connection)
+    }) as IConnectionClient[]
+}

package/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "outDir": "dist",
+    "declaration": true,
+    "target": "es2017",
+    "module": "commonjs",
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
+    "esModuleInterop": true
+  },
+  "exclude": ["node_modules", "dist"]
+}