Make sure deprecated document types can be read by Mazed today (#388)

Author: akindyakov

elementary/src/editor/types.test.ts

@@ -1,21 +1,21 @@
-import { makeParagraph, makeLeaf, TDoc } from './types'
+import { makeSlateTextFromPlainText, TDoc } from './types'
 
 test('exctractDocTitle - raw string', async () => {
   const text = 'RmdBzaGUgdHJpZWQgdG8gd2FzaCBvZm'
-  const doc = new TDoc([makeParagraph([makeLeaf(text)])])
+  const doc = new TDoc(makeSlateTextFromPlainText(text))
   const title = doc.genTitle()
   expect(title).toStrictEqual(text)
 })
 
 test('exctractDocTitle - empty object', () => {
-  const doc = new TDoc([makeParagraph([makeLeaf('')])])
+  const doc = new TDoc(makeSlateTextFromPlainText())
   const title = doc.genTitle()
   expect(title).toStrictEqual('…')
 })
 
 test('exctractDocTitle - make sure wide (unicode) characters are not cut in half', () => {
   const ustr = '☀️🐥📦⏳☕️💡🏗'.repeat(100)
-  const doc = new TDoc([makeParagraph([makeLeaf(ustr)])])
+  const doc = new TDoc(makeSlateTextFromPlainText(ustr))
   const title = doc.genTitle(19)
   expect(title).toStrictEqual('☀️🐥📦⏳☕️💡🏗☀️🐥📦⏳☕️💡🏗☀️🐥📦⏳…')
 })

elementary/src/editor/types.ts

@@ -2,7 +2,12 @@ import type { Descendant, BaseEditor } from 'slate'
 import { Element } from 'slate'
 import { ReactEditor } from 'slate-react'
 import { HistoryEditor } from 'slate-history'
-import type { NodeTextData } from 'smuggler-api'
+import type {
+  NodeTextData,
+  ChunkedDocDeprecated,
+  DraftDocDeprecated,
+  SlateText as RawSlateText,
+} from 'smuggler-api'
 
 import lodash from 'lodash'
 
@@ -333,39 +338,74 @@ export function makeDateTime(
   }
 }
 
+export function makeSlateTextFromPlainText(plaintext?: string): SlateText {
+  return [
+    {
+      type: 'paragraph',
+      children: [
+        {
+          text: plaintext ?? '',
+        },
+      ],
+    },
+  ]
+}
+
+/**
+ * Migrates all previous version document structre to the latest one
+ */
+function ensureCorrectNodeTextData(
+  text: {
+    slate?: SlateText | RawSlateText | null
+    draft?: DraftDocDeprecated | null
+    chunks?: ChunkedDocDeprecated | null
+  } | null
+): { slate: SlateText } {
+  let slate: SlateText
+  if (text == null) {
+    slate = makeSlateTextFromPlainText()
+  } else if (text.slate != null) {
+    slate = text.slate as SlateText
+  } else {
+    // There is an old style text node
+    if (text.chunks) {
+      slate = makeSlateTextFromPlainText(
+        text.chunks.map((chunk) => chunk.source).join(' ')
+      )
+    } else if (text.draft) {
+      slate = makeSlateTextFromPlainText(
+        text.draft.blocks.map((block) => block.text).join('\n')
+      )
+    } else {
+      slate = makeSlateTextFromPlainText(JSON.stringify(text))
+    }
+  }
+  return { slate }
+}
+
 export class TDoc {
   slate: SlateText
+  chunks?: ChunkedDocDeprecated
+  draft?: DraftDocDeprecated
 
-  constructor(slate: SlateText) {
-    this.slate = slate
+  constructor(slate: SlateText | undefined | null) {
+    this.slate = ensureCorrectNodeTextData({ slate }).slate
   }
 
   toNodeTextData(): NodeTextData {
-    const { slate } = this
-    return { slate, draft: null, chunks: null }
+    return { ...this }
   }
 
   static fromNodeTextData(text: NodeTextData): TDoc {
-    const { slate } = text
-    if (slate) {
-      return new TDoc(slate as SlateText)
-    }
-    return this.makeEmpty()
+    return new TDoc(ensureCorrectNodeTextData(text).slate)
   }
 
   static makeEmpty(): TDoc {
-    const text = ''
-    const slate = [
-      {
-        type: kSlateBlockTypeParagraph,
-        children: [{ text }],
-      },
-    ]
-    return new TDoc(slate as SlateText)
+    return new TDoc(makeSlateTextFromPlainText())
   }
 
   makeACopy(nid: string, isBlankCopy: boolean): TDoc {
-    let { slate } = this
+    let slate = this.slate
     const title = this.genTitle()
     let label
     if (isBlankCopy) {

smuggler-api/src/types.ts

@@ -5,7 +5,12 @@ import { makeUrl } from './api_url'
 
 export type SlateText = object[]
 
-function makeSlateFromPlainText(plaintext?: string): SlateText {
+/**
+ * This hacky type unsafe method for in-file use only. For anything else please
+ * consider using similar methods from elementary/src/editor/types.ts , those
+ * are type safe
+ */
+export function makeSlateFromPlainText(plaintext?: string): SlateText {
   return [
     {
       type: 'paragraph',
@@ -28,13 +33,34 @@ export function makeNodeTextData(plaintext?: string): NodeTextData {
 
 export type Nid = string
 
+// Types related to old document types
+
+export type DocChunkDeprecated = {
+  type: number
+  source: string
+}
+export type ChunkedDocDeprecated = DocChunkDeprecated[]
+export type DraftBlockDeprecated = {
+  data?: object
+  depth?: number
+  entityRanges?: any[]
+  inlineStyleRanges?: any[]
+  key: string
+  text: string
+  type?: string
+}
+export type DraftDocDeprecated = {
+  blocks: DraftBlockDeprecated[]
+  entityMap?: object
+}
+
 // see smuggler/src/types.rs
 export type NodeTextData = {
-  slate: SlateText | undefined
+  slate: SlateText
   // Deprecated
-  draft: any | undefined
+  draft?: DraftDocDeprecated
   // Deprecated
-  chunks: any | undefined
+  chunks?: ChunkedDocDeprecated
 }
 
 export enum NodeType {

truthsayer/src/external-import/BrowserHistoryImporter.tsx

@@ -5,7 +5,6 @@ import semver from 'semver'
 import { sleep } from 'armoury'
 import { Spinner } from 'elementary'
 import * as truthsayer_archaeologist_communication from 'truthsayer-archaeologist-communication'
-import { FromTruthsayer } from 'truthsayer-archaeologist-communication'
 import { TruthsayerLink } from '../lib/TrueLink'
 import BrowserLogo from '../apps-list/img/GoogleChromeLogo.svg'