Adds the API for a ISharedDocument factory (#125)

* Adds the API for a ISharedDocument factory

* Update javascript/src/api.ts

Co-authored-by: Frédéric Collonval <[email protected]>

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Fixes tests

Co-authored-by: Frédéric Collonval <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: 3 people

.github/workflows/test.yml

@@ -43,8 +43,8 @@ jobs:
       - name: Install Miniconda
         uses: conda-incubator/setup-miniconda@v2
         with:
-          mamba-version: "*"
-          channels: conda-forge
+          miniforge-variant: Mambaforge
+          miniforge-version: latest
           python-version: "3.7"
 
       - name: Install dependencies

javascript/src/api.ts

@@ -41,6 +41,45 @@ export type MapChanges = Map<
   }
 >;
 
+/**
+ * A factory interface for creating `ISharedDocument` objects.
+ */
+export interface IFactory {
+  /**
+   * Create a new `ISharedDocument` instance.
+   */
+  createNew(options: IFactory.IOptions): ISharedDocument;
+}
+
+/**
+ * The namespace for `IFactory`.
+ */
+export namespace IFactory {
+  /**
+   * The options used to instantiate a ISharedDocument
+   */
+  export interface IOptions {
+    /**
+     * The path of the file.
+     */
+    path: string;
+    /**
+     * The format of the document.
+     */
+    format: string;
+    /**
+     * The content type of the document.
+     */
+    contentType: string;
+    /**
+     * Wether the document is collaborative or not.
+     *
+     *  The default value is `true`.
+     */
+    collaborative?: boolean;
+  }
+}
+
 /**
  * ISharedBase defines common operations that can be performed on any shared object.
  */