smuggler-api/types.ts: split types & helpers (#390)

Author: SergNikitin

archaeologist/src/background.ts

@@ -24,6 +24,7 @@ import {
 import { log, isAbortError, genOriginId, unixtime } from 'armoury'
 import {
   TNode,
+  NodeUtil,
   TotalUserActivity,
   ResourceVisit,
   smuggler,
@@ -102,7 +103,7 @@ async function requestPageSavedStatus(url: string | undefined) {
   }
   let bookmark: TNode | undefined = undefined
   for (const node of nodes) {
-    if (node.isWebBookmark()) {
+    if (NodeUtil.isWebBookmark(node)) {
       bookmark = node
       break
     }
@@ -419,7 +420,7 @@ async function handleMessageFromContent(
       const suggested = await suggestAssociations(message.phrase, message.limit)
       return {
         type: 'SUGGESTED_CONTENT_ASSOCIATIONS',
-        suggested: suggested.map((node: TNode) => node.toJson()),
+        suggested: suggested.map((node: TNode) => NodeUtil.toJson(node)),
       }
     }
     default:
@@ -608,7 +609,11 @@ async function handleMessageFromPopup(
         content,
         tabId
       )
-      return { type: 'PAGE_SAVED', bookmark: node?.toJson(), unmemorable }
+      return {
+        type: 'PAGE_SAVED',
+        bookmark: node ? NodeUtil.toJson(node) : undefined,
+        unmemorable,
+      }
     case 'REQUEST_PAGE_IN_ACTIVE_TAB_STATUS': {
       const { bookmark, unmemorable, fromNodes, toNodes } =
         await requestPageSavedStatus(activeTab?.url)
@@ -619,9 +624,9 @@ async function handleMessageFromPopup(
       return {
         type: 'UPDATE_POPUP_CARDS',
         mode: 'reset',
-        bookmark: bookmark?.toJson(),
-        fromNodes: fromNodes?.map((node) => node.toJson()) ?? [],
-        toNodes: toNodes?.map((node) => node.toJson()) ?? [],
+        bookmark: bookmark ? NodeUtil.toJson(bookmark) : undefined,
+        fromNodes: fromNodes?.map((node) => NodeUtil.toJson(node)) ?? [],
+        toNodes: toNodes?.map((node) => NodeUtil.toJson(node)) ?? [],
         unmemorable,
       }
     }
@@ -785,9 +790,9 @@ async function initMazedPartsOfTab(
       type: 'INIT_CONTENT_AUGMENTATION_REQUEST',
       nodeEnv: process.env.NODE_ENV,
       userUid: auth.account().getUid(),
-      bookmark: bookmark?.toJson(),
-      fromNodes: fromNodes?.map((node) => node.toJson()) ?? [],
-      toNodes: toNodes?.map((node) => node.toJson()) ?? [],
+      bookmark: bookmark ? NodeUtil.toJson(bookmark) : undefined,
+      fromNodes: fromNodes?.map((node) => NodeUtil.toJson(node)) ?? [],
+      toNodes: toNodes?.map((node) => NodeUtil.toJson(node)) ?? [],
       mode,
     })
   } catch (err) {

archaeologist/src/background/savePage.ts

@@ -12,7 +12,8 @@ import {
   NodeType,
   OriginHash,
   TNode,
-  makeNodeTextData,
+  NodeUtil,
+  makeEmptyNodeTextData,
   smuggler,
 } from 'smuggler-api'
 import { ToContent } from '../message/types'
@@ -33,16 +34,16 @@ async function updateContent(
   bookmark?: TNode,
   tabId?: number
 ): Promise<void> {
-  const bookmarkJson = bookmark?.toJson()
+  const bookmarkJson = bookmark ? NodeUtil.toJson(bookmark) : undefined
   // Update content augmentation
   if (tabId == null) {
     return
   }
   try {
     await ToContent.sendMessage(tabId, {
       type: 'REQUEST_UPDATE_CONTENT_AUGMENTATION',
-      fromNodes: fromNodes.map((node) => node.toJson()),
-      toNodes: toNodes.map((node) => node.toJson()),
+      fromNodes: fromNodes.map((node) => NodeUtil.toJson(node)),
+      toNodes: toNodes.map((node) => NodeUtil.toJson(node)),
       bookmark: bookmarkJson,
       mode: 'append',
     })
@@ -136,7 +137,7 @@ export async function saveWebPage(
     await updateContent([], [], undefined, tabId)
     return { unmemorable: true }
   }
-  const text = makeNodeTextData()
+  const text = makeEmptyNodeTextData()
   const index_text: NodeIndexText = {
     plaintext: content.text || undefined,
     labels: [],
@@ -222,7 +223,7 @@ export async function savePageQuote(
     web_quote: { url, path, text },
   }
   const resp = await smuggler.node.create({
-    text: makeNodeTextData(),
+    text: makeEmptyNodeTextData(),
     ntype: NodeType.WebQuote,
     from_nid: fromNid ? [fromNid] : undefined,
     extattrs,
@@ -248,7 +249,7 @@ async function _saveWebSearchQuery(
   if (originId == null) {
     originId = genOriginId(url).id
   }
-  const text = makeNodeTextData()
+  const text = makeEmptyNodeTextData()
   const index_text: NodeIndexText = {
     labels: [],
     brands: [],

archaeologist/src/background/suggestAssociations.ts

@@ -1,4 +1,5 @@
-import { smuggler, TNode } from 'smuggler-api'
+import { smuggler } from 'smuggler-api'
+import type { TNode } from 'smuggler-api'
 import { Beagle } from 'elementary'
 
 export async function suggestAssociations(

archaeologist/src/content/App.tsx

@@ -5,7 +5,8 @@ import browser from 'webextension-polyfill'
 import { PostHog } from 'posthog-js'
 import { v4 as uuidv4 } from 'uuid'
 
-import { TNode, TNodeJson, NodeType } from 'smuggler-api'
+import { NodeUtil, NodeType } from 'smuggler-api'
+import type { TNode, TNodeJson } from 'smuggler-api'
 import { genOriginId, OriginIdentity, log, productanalytics } from 'armoury'
 import * as truthsayer_archaeologist_communication from 'truthsayer-archaeologist-communication'
 
@@ -152,10 +153,12 @@ function updateState(state: State, action: Action): State {
         fromNodes: fromNodesJson,
       } = action.data
       const bookmark =
-        bookmarkJson != null ? TNode.fromJson(bookmarkJson) : undefined
-      const toNodes = toNodesJson.map((json: TNodeJson) => TNode.fromJson(json))
+        bookmarkJson != null ? NodeUtil.fromJson(bookmarkJson) : undefined
+      const toNodes = toNodesJson.map((json: TNodeJson) =>
+        NodeUtil.fromJson(json)
+      )
       const fromNodes = fromNodesJson.map((json: TNodeJson) =>
-        TNode.fromJson(json)
+        NodeUtil.fromJson(json)
       )
 
       let analytics: PostHog | null = null
@@ -225,13 +228,13 @@ function updateState(state: State, action: Action): State {
       }
       const d = action.data
       const newToNodes = d.toNodes.map((json: TNodeJson) =>
-        TNode.fromJson(json)
+        NodeUtil.fromJson(json)
       )
       const newFromNodes = d.fromNodes.map((json: TNodeJson) =>
-        TNode.fromJson(json)
+        NodeUtil.fromJson(json)
       )
       const newBookmark =
-        d.bookmark != null ? TNode.fromJson(d.bookmark) : undefined
+        d.bookmark != null ? NodeUtil.fromJson(d.bookmark) : undefined
 
       return {
         ...state,

archaeologist/src/content/augmentation/SuggestionsToast.tsx

@@ -5,7 +5,8 @@ import styled from '@emotion/styled'
 import { mazed } from '../../util/mazed'
 
 import { TDoc, ShrinkMinimalCard, NodeCardReadOnly } from 'elementary'
-import { TNode } from 'smuggler-api'
+import { NodeUtil, smuggler } from 'smuggler-api'
+import type { TNode } from 'smuggler-api'
 
 import { Toast, useOutsideToastClickHandler } from './../toaster/Toaster'
 import { LogoSmall, RefItem } from './../style'
@@ -91,21 +92,21 @@ const CopySuggestionButton = ({
 
 function getTextToInsert(node: TNode): string {
   let toInsert: string
-  if (node.isWebBookmark() && node.extattrs?.web != null) {
+  if (NodeUtil.isWebBookmark(node) && node.extattrs?.web != null) {
     const { web, title, author } = node.extattrs
     const authorStr = author ? `\nby ${author}` : ''
     toInsert = `${title}${authorStr}\n🧵 ${web.url} `
-  } else if (node.isWebQuote() && node.extattrs?.web_quote != null) {
+  } else if (NodeUtil.isWebQuote(node) && node.extattrs?.web_quote != null) {
     const { text, url } = node.extattrs.web_quote
     const { author } = node.extattrs
     const authorStr = author ? `\nby ${author}` : ''
     toInsert = `“${text}”${authorStr}\n🧵 ${url} `
-  } else if (node.isImage()) {
-    const url = node.getBlobSource()
+  } else if (NodeUtil.isImage(node)) {
+    const url = smuggler.blob.sourceUrl(node.nid)
     toInsert = ` 🧵 ${url} `
   } else {
-    const doc = TDoc.fromNodeTextData(node.getText())
-    toInsert = `${doc.genPlainText()}\n🧵 ${node.getDirectUrl()} `
+    const doc = TDoc.fromNodeTextData(node.text)
+    toInsert = `${doc.genPlainText()}\n🧵 ${smuggler.node.url(node.nid)} `
   }
   return toInsert
 }
@@ -118,11 +119,11 @@ function CardInsertButton({
   onClose: () => void
 }) {
   let copySubj: string
-  if (node.isWebBookmark() && node.extattrs?.web != null) {
+  if (NodeUtil.isWebBookmark(node) && node.extattrs?.web != null) {
     copySubj = 'Link'
-  } else if (node.isWebQuote() && node.extattrs?.web_quote != null) {
+  } else if (NodeUtil.isWebQuote(node) && node.extattrs?.web_quote != null) {
     copySubj = 'Quote'
-  } else if (node.isImage()) {
+  } else if (NodeUtil.isImage(node)) {
     copySubj = 'Image'
   } else {
     copySubj = 'Note'
@@ -156,7 +157,7 @@ const SuggestedCard = ({
       <SuggestedCardTools>
         <CardInsertButton node={node} onClose={onClose} />
         <SuggestionButton
-          href={node.getDirectUrl()}
+          href={smuggler.node.url(node.nid)}
           metricLabel={'Suggested Fragment Open in Mazed'}
         >
           Open Mazed
@@ -182,7 +183,7 @@ export const SuggestionsToast = ({
   onClose: () => void
 }) => {
   const suggestedEl = suggested.map((node: TNode) => {
-    return <SuggestedCard key={node.getNid()} node={node} onClose={onClose} />
+    return <SuggestedCard key={node.nid} node={node} onClose={onClose} />
   })
   useOutsideToastClickHandler(onClose)
   return (

archaeologist/src/content/augmentation/WriteAugmentation.tsx

@@ -2,7 +2,8 @@ import React from 'react'
 import lodash from 'lodash'
 
 import { log } from 'armoury'
-import { TNode, TNodeJson } from 'smuggler-api'
+import { NodeUtil } from 'smuggler-api'
+import type { TNode, TNodeJson } from 'smuggler-api'
 import { Spinner } from 'elementary'
 
 import { FromContent } from './../../message/types'
@@ -87,7 +88,9 @@ export function WriteAugmentation() {
             phrase,
           })
           setSuggestedNodes(
-            response.suggested.map((value: TNodeJson) => TNode.fromJson(value))
+            response.suggested.map((value: TNodeJson) =>
+              NodeUtil.fromJson(value)
+            )
           )
           setSuggestionsSearchIsActive(false)
         },

archaeologist/src/content/quote/Quotes.tsx

@@ -1,5 +1,6 @@
 import React from 'react'
-import { TNode } from 'smuggler-api'
+import { NodeUtil } from 'smuggler-api'
+import type { TNode } from 'smuggler-api'
 
 import { QuoteHighlight } from './QuoteHighlight'
 
@@ -11,7 +12,7 @@ export const Quotes = ({ quotes }: { quotes: TNode[] }) => {
       return null
     }
     const { path, text } = web_quote
-    if (!node.isWebQuote() || path == null) {
+    if (!NodeUtil.isWebQuote(node) || path == null) {
       return null
     }
     return (

archaeologist/src/message/types.ts

@@ -1,7 +1,7 @@
 import { WebPageContent } from './../content/extractor/webPageContent'
 
 import browser from 'webextension-polyfill'
-import { OriginHash, TNodeJson } from 'smuggler-api'
+import type { OriginHash, TNodeJson } from 'smuggler-api'
 import { OriginIdentity } from 'armoury'
 
 /**

archaeologist/src/omnibox/omnibox.ts

@@ -1,4 +1,5 @@
-import { smuggler, TNode } from 'smuggler-api'
+import { smuggler, NodeUtil } from 'smuggler-api'
+import type { TNode } from 'smuggler-api'
 import { Beagle, TDoc } from 'elementary'
 import { log, unicodeText } from 'armoury'
 import { mazed } from '../util/mazed'
@@ -12,7 +13,7 @@ function nodeToSuggestion(node: TNode): browser.Omnibox.SuggestResult {
   const { nid } = node
   const url = node.extattrs?.web?.url || node.extattrs?.web_quote?.url
   if (url != null) {
-    if (node.isWebQuote()) {
+    if (NodeUtil.isWebQuote(node)) {
       const title = _truncate(
         node.extattrs?.web_quote?.text || '',
         kTitleLengthMax
@@ -23,7 +24,7 @@ function nodeToSuggestion(node: TNode): browser.Omnibox.SuggestResult {
         description: formatDescription(title, shortUrl),
       }
     }
-    if (node.isWebBookmark()) {
+    if (NodeUtil.isWebBookmark(node)) {
       const title = _truncate(
         node.extattrs?.title ?? node.extattrs?.description ?? '',
         kTitleLengthMax
@@ -35,7 +36,7 @@ function nodeToSuggestion(node: TNode): browser.Omnibox.SuggestResult {
       }
     }
   }
-  const doc = TDoc.fromNodeTextData(node.getText())
+  const doc = TDoc.fromNodeTextData(node.text)
   const title = doc.genTitle(kTitleLengthMax)
   return {
     content: mazed.makeNodeUrl(nid).toString(),

archaeologist/src/popup/NodeCard.tsx

@@ -10,7 +10,7 @@ import {
   NodeCardReadOnly,
 } from 'elementary'
 
-import { TNode } from 'smuggler-api'
+import type { TNode } from 'smuggler-api'
 
 const Box = styled(SmallCard)`
   width: 100%;