feat(core): implement Document API (#130)

* feat(sdk): create interface for Document API

* feat(core): create DocumentAPI, expose document api via EditorAPI, implement get data method that returns serialized model object

* refactor(core): create separate folder for DocumentAPI

* test(document-api): add unit test for data getter

* chore: apply suggestions from code review

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* chore: add jsdoc

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: ilyamore88

packages/core/src/api/DocumentAPI/DocumentAPI.spec.ts

@@ -0,0 +1,51 @@
+/* eslint-disable @typescript-eslint/naming-convention */
+import { beforeEach, describe, expect, jest } from '@jest/globals';
+
+jest.unstable_mockModule('@editorjs/model', () => {
+  const EditorJSModel = jest.fn(() => ({
+    serialized: { blocks: [] },
+  }));
+
+  return {
+    EditorJSModel,
+  };
+});
+
+const { EditorJSModel } = await import('@editorjs/model');
+const { DocumentAPI } = await import('./DocumentAPI.js');
+
+describe('DocumentAPI', () => {
+  // @ts-expect-error - mock object, don't need to pass any arguments
+  const model = new EditorJSModel();
+
+  const documentAPI = new DocumentAPI(model);
+
+  beforeEach(() => {
+    jest.resetAllMocks();
+  });
+
+  describe('.data', () => {
+    it('should return serialized model', () => {
+      const mockedSerializedModel = {
+        blocks: [
+          {
+            name: 'a',
+          },
+          {
+            name: 'b',
+          },
+          {
+            name: 'c',
+          },
+        ],
+      };
+
+      // @ts-expect-error - need to assign read only property to mock it
+      model.serialized = mockedSerializedModel;
+
+      const data = documentAPI.data;
+
+      expect(data).toEqual(mockedSerializedModel);
+    });
+  });
+});

packages/core/src/api/DocumentAPI/DocumentAPI.ts

@@ -0,0 +1,33 @@
+import 'reflect-metadata';
+import { Service } from 'typedi';
+
+import { type EditorDocumentSerialized, EditorJSModel } from '@editorjs/model';
+import { DocumentAPI as DocumentApiInterface } from '@editorjs/sdk';
+
+/**
+ * Document API
+ *  - provides access to document serialized data
+ */
+@Service()
+export class DocumentAPI implements DocumentApiInterface {
+  /**
+   * Editor document model instance
+   */
+  #model: EditorJSModel;
+
+  /**
+   * DocumentAPI constructor
+   * All parameters are injected through the IoC container
+   * @param model - Editor's Document Model instance
+   */
+  constructor(model: EditorJSModel) {
+    this.#model = model;
+  }
+
+  /**
+   * Returns serialized document object
+   */
+  public get data(): EditorDocumentSerialized {
+    return this.#model.serialized;
+  }
+}

packages/core/src/api/DocumentAPI/index.ts

@@ -0,0 +1 @@
+export * from './DocumentAPI.js';

packages/core/src/api/index.ts

@@ -3,6 +3,7 @@ import { Inject, Service } from 'typedi';
 import { EditorAPI as EditorApiInterface } from '@editorjs/sdk';
 import { BlocksAPI } from './BlocksAPI.js';
 import { SelectionAPI } from './SelectionAPI.js';
+import { DocumentAPI } from './DocumentAPI/index.js';
 
 /**
  * Class gathers all Editor's APIs
@@ -20,4 +21,10 @@ export class EditorAPI implements EditorApiInterface {
    */
   @Inject()
   public selection!: SelectionAPI;
+
+  /**
+   * Document API instance to work with document
+   */
+  @Inject()
+  public document!: DocumentAPI;
 }

packages/sdk/src/api/DocumentAPI.ts

@@ -0,0 +1,12 @@
+import type { EditorDocumentSerialized } from '@editorjs/model';
+
+/**
+ * Document API interface
+ * Provides methods to work with Editor's document object
+ */
+export interface DocumentAPI {
+  /**
+   * Returns serialized document object
+   */
+  get data(): EditorDocumentSerialized;
+}

packages/sdk/src/api/EditorAPI.ts

@@ -1,5 +1,6 @@
 import type { BlocksAPI } from './BlocksAPI.js';
 import type { SelectionAPI } from './SelectionAPI.js';
+import type { DocumentAPI } from './DocumentAPI.js';
 
 /**
  * Editor API interface
@@ -15,4 +16,9 @@ export interface EditorAPI {
    * Selection API instance to work with selection and inline formatting
    */
   selection: SelectionAPI;
+
+  /**
+   * Document API instance to work with Editor's document
+   */
+  document: DocumentAPI;
 }

packages/sdk/src/api/index.ts

@@ -1,3 +1,4 @@
 export type * from './EditorAPI.js';
 export type * from './BlocksAPI.js';
 export type * from './SelectionAPI.js';
+export type * from './DocumentAPI.js';