@newly/cli 0.2.201 → 0.2.202

package/dist/commands/support.js

@@ -1,9 +1,10 @@
-import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'node:fs';
-import { dirname, join } from 'node:path';
+import { existsSync, mkdirSync, readFileSync, unlinkSync, writeFileSync } from 'node:fs';
+import { dirname, join, resolve } from 'node:path';
 import { ApiClient, friendlyApiError } from '../api.js';
 import { requireCredentials, resolveProject } from '../config.js';
 import { SUPPORT_CHAT_TSX } from './supportChat.generated.js';
 export const SUPPORT_CONFIG = 'src/lib/newly-support.json';
+export const SUPPORT_ARTICLES_DIR = 'support/articles';
 export const SUPPORT_CHAT = 'src/components/SupportChat.tsx';
 export function writeSupportChat(dir, force = false) {
     const path = join(dir, SUPPORT_CHAT);
@@ -104,6 +105,64 @@ export async function runArticlesList(client, projectId, log) {
     for (const a of articles)
         log(`${a.id}  ${a.title}  (updated ${a.updated_at})`);
 }
+const slugOf = (title) => title.toLowerCase().replace(/[^a-z0-9]+/g, '-').replace(/^-+|-+$/g, '').slice(0, 60).replace(/-+$/, '') || 'article';
+const INDEX = 'articles.json';
+function exportedFiles(dir) {
+    try {
+        const { articles } = JSON.parse(readFileSync(join(dir, INDEX), 'utf8'));
+        return (articles ?? []).map((a) => a.file).filter((f) => typeof f === 'string' && /^[a-z0-9-]+\.md$/.test(f));
+    }
+    catch {
+        return [];
+    }
+}
+export const WEBSITE_ARTICLES = 'support-articles.json';
+export async function runArticlesExport(client, projectId, dir, log, websiteDir) {
+    const { settings } = (await client.get(`${base(projectId)}/settings`));
+    const websiteCopy = websiteDir ? join(websiteDir, WEBSITE_ARTICLES) : null;
+    if (!settings?.enabled) {
+        if (websiteCopy && existsSync(websiteCopy))
+            unlinkSync(websiteCopy);
+        log('Nothing exported: the help chat is off for this app. Turn it on with newly support enable first.');
+        return;
+    }
+    const { articles } = (await client.get(`${base(projectId)}/articles`));
+    const sorted = [...articles].sort((a, b) => a.title.localeCompare(b.title) || a.id.localeCompare(b.id));
+    const owned = new Set(exportedFiles(dir));
+    const taken = new Set();
+    const free = (file) => !taken.has(file) && (owned.has(file) || !existsSync(join(dir, file)));
+    const entries = sorted.map((a) => {
+        const slug = slugOf(a.title);
+        let file = `${slug}.md`;
+        for (let n = 2; !free(file); n++)
+            file = `${slug}-${n}.md`;
+        taken.add(file);
+        return {
+            id: a.id, file, title: a.title, body: a.body, source: a.source ?? 'manual',
+            source_name: a.source_name ?? null, source_url: a.source_url ?? null, updated_at: a.updated_at,
+        };
+    });
+    mkdirSync(dir, { recursive: true });
+    for (const stale of owned) {
+        if (!taken.has(stale) && existsSync(join(dir, stale)))
+            unlinkSync(join(dir, stale));
+    }
+    for (const e of entries) {
+        const header = [`id: ${e.id}`, `title: ${JSON.stringify(e.title)}`, `source: ${e.source}`];
+        if (e.source_name)
+            header.push(`source_name: ${JSON.stringify(e.source_name)}`);
+        if (e.source_url)
+            header.push(`source_url: ${JSON.stringify(e.source_url)}`);
+        header.push(`updated_at: ${e.updated_at}`);
+        writeFileSync(join(dir, e.file), `---\n${header.join('\n')}\n---\n\n${e.body.trimEnd()}\n`);
+    }
+    const note = 'Exported from Newly customer support. Edit articles in Newly; newly support articles export overwrites this folder.';
+    const index = `${JSON.stringify({ note, articles: entries }, null, 2)}\n`;
+    writeFileSync(join(dir, INDEX), index);
+    if (websiteDir && websiteCopy && existsSync(websiteDir))
+        writeFileSync(websiteCopy, index);
+    log(`Exported ${entries.length} ${entries.length === 1 ? 'article' : 'articles'} to ${dir}`);
+}
 const bodyOf = (opts) => {
     if (opts.file)
         return readFileSync(opts.file, 'utf8');
@@ -266,6 +325,12 @@ export function registerSupport(program) {
         const c = ctx(o.project);
         await runArticleImportUrl(c.client, c.projectId, url, Boolean(o.refresh), log);
     }));
+    articles.command('export').description('Write the articles into the repo (markdown plus articles.json) for the website FAQ')
+        .option('--dir <dir>', 'output folder', SUPPORT_ARTICLES_DIR).option('--project <id>')
+        .action((o) => run(async () => {
+        const c = ctx(o.project);
+        await runArticlesExport(c.client, c.projectId, resolve(o.dir), log, resolve('website'));
+    }));
     articles.command('remove <id>').option('--project <id>').action((id, o) => run(async () => {
         const c = ctx(o.project);
         await runArticleRemove(c.client, c.projectId, id, log);

package/dist/version.js

@@ -1 +1 @@
-export const CLI_VERSION = '0.2.201';
+export const CLI_VERSION = '0.2.202';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@newly/cli",
-  "version": "0.2.201",
+  "version": "0.2.202",
   "description": "Develop, provision, and deploy Newly backends from your terminal",
   "homepage": "https://newly.app",
   "repository": {