feat(documents): pull documents during build

Author: collectedmind

.gitignore

@@ -107,6 +107,9 @@ ui/styles/global-variables.pcss
 # We don't want to commit built icons files
 ui/icons/dist/
 
+# We don't want to commit built document files either
+clients/web/public/static/docs/legal
+
 # TS Terraform build 
 .terraform/
 node_modules/

clients/web/package.json

@@ -32,7 +32,6 @@
     "he": "1.2.0",
     "intersection-observer": "0.12.2",
     "jsonwebtoken": "9.0.2",
-    "legal-docs": "github:mozilla/legal-docs#74eccbd6e11b762ca706f31734ab6c5192273de4",
     "marked": "14.1.2",
     "match-sorter": "6.3.4",
     "mousetrap": "1.6.5",

clients/web/src/pages/privacy/index.tsx

@@ -4,6 +4,7 @@ import { LOCALE_COMMON } from 'common/constants'
 import { readFileSync } from 'node:fs'
 import { marked } from 'marked'
 import { overrideDateTime, customHeadingId } from 'common/utilities/marked-formatters'
+import { join } from 'node:path'
 
 // Types
 import type { LocalizedProps } from '@common/types'
@@ -61,9 +62,9 @@ async function getMDContent(locale: string, isEU: boolean): Promise<string> {
   let mdContent: string
   const docToUse = isEU ? 'pocket_privacy_policy_eu.md' : 'pocket_privacy_policy.md'
   try {
-    mdContent = readFileSync(`node_modules/legal-docs/${locale}/${docToUse}`, 'utf8')
+    mdContent = readFileSync(join(process.cwd(), `public/static/docs/legal/${locale}/${docToUse}`), 'utf8') //prettier-ignore
   } catch {
-    mdContent = readFileSync(`node_modules/legal-docs/en/${docToUse}`, 'utf8')
+    mdContent = readFileSync(join(process.cwd(), `public/static/docs/legal/en/${docToUse}`), 'utf8')
   }
 
   const mdContentModified = mdContent.replace(/\{:\s?\#(.+\S)\s?\}/gi, '{#$1}')

clients/web/src/pages/tos/index.tsx

@@ -4,6 +4,7 @@ import { LOCALE_COMMON } from 'common/constants'
 import { readFileSync } from 'node:fs'
 import { marked } from 'marked'
 import { overrideDateTime, customHeadingId } from 'common/utilities/marked-formatters'
+import { join } from 'node:path'
 
 // Types
 import type { LocalizedProps } from '@common/types'
@@ -31,9 +32,9 @@ async function getMDContent(locale: string): Promise<string> {
   let mdContent: string
 
   try {
-    mdContent = readFileSync(`node_modules/legal-docs/${locale}/pocket_tos.md`, 'utf8')
+    mdContent = readFileSync(join(process.cwd(), `public/static/docs/legal/${locale}/pocket_tos.md`), 'utf8') //prettier-ignore
   } catch {
-    mdContent = readFileSync(`node_modules/legal-docs/en/pocket_tos.md`, 'utf8')
+    mdContent = readFileSync(join(process.cwd(), `public/static/docs/legal/en/pocket_tos.md`), 'utf8') //prettier-ignore
   }
 
   const mdContentModified = mdContent.replace(/\{:\s?\#(.+\S)\s?\}/gi, '{#$1}')

config/document-config/index.js

@@ -0,0 +1,28 @@
+import { globby } from 'globby'
+import { ensureDir, copy } from 'fs-extra'
+import { join, basename, dirname } from 'node:path'
+
+// Source and destination directories
+const sourceDir = 'node_modules/legal-docs/'
+const destinationDir = join(process.cwd(), '../../clients/web/public/static/docs/legal/')
+
+async function copyLegalDocs() {
+  const paths = await globby([`${sourceDir}/**/pocket_*`])
+
+  try {
+    for (const filePath of paths) {
+      const destinationFolder = join(destinationDir, basename(dirname(filePath)))
+      const fileDestination = basename(filePath)
+      const copyPath = `${destinationFolder}/${fileDestination}`
+      console.log(copyPath)
+
+      await ensureDir(destinationFolder)
+      await copy(filePath, copyPath)
+    }
+    console.log('Legal Docs Copied')
+  } catch (err) {
+    console.log('There was an issue copying legal documents over', err)
+  }
+}
+
+copyLegalDocs()

config/document-config/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@config/document-config",
+  "version": "0.0.0",
+  "description": "",
+  "main": "index.js",
+  "type": "module",
+  "scripts": {
+    "build": "node index.js"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "legal-docs": "github:mozilla/legal-docs#74eccbd6e11b762ca706f31734ab6c5192273de4",
+    "fs-extra": "11.2.0",
+    "globby": "14.0.2"
+  }
+}