chatgpt-to-markdown 1.3.0 → 1.5.0

package/README.md

@@ -97,6 +97,8 @@ git push --follow-tags
 
 ## Release notes
 
+- 1.5.0: 28 Nov 2023. Handle `tether_browsing_display`, `tether_quote` and `system_error`
+- 1.4.0: 29 Oct 2023. Handle multi-modal text from Dall-E
 - 1.3.0: 29 Sep 2023. Set create and update dates from chat
 - 1.2.0: 28 Sep 2023. Added test cases
 - 1.1.0: 26 Sep 2023. Add date format option

package/index.js

@@ -33,27 +33,19 @@ function wrapHtmlTagsInBackticks(text) {
 function indent(str) {
   return str
     .split("\n")
-    .map((v) => `    ${v}`)
-    .join("\n");
+    .map((v) => `    ${v}\n`)
+    .join("");
 }
 
-/**
- * Formats a date to a string like "1 Jan 2021".
- * @param {Date} date - The date to format.
- * @returns {string} - The formatted date.
- * @example
- * formatDate(new Date());
- * //=> "1 Jan 2021"
- */
-function formatDate(date) {
-  const month = date.toLocaleString("en", { month: "short" });
-  const min = date.getMinutes().toString().padStart(2, "0");
-  let hours = date.getHours();
-  let ampm = hours >= 12 ? "PM" : "AM";
-  hours = hours % 12;
-  hours = hours ? hours : 12; // the hour '0' should be '12'
-  return `${date.getDate()} ${month} ${date.getFullYear()} ${hours}:${min} ${ampm}`;
-}
+const dateFormat = new Intl.DateTimeFormat("en-US", {
+  day: "numeric",
+  month: "short",
+  year: "numeric",
+  hour: "numeric",
+  minute: "2-digit",
+  hour12: true,
+});
+export const formatDate = (date) => dateFormat.format(date);
 
 /**
  * Converts a JSON object to markdown and saves it to a file.
@@ -96,6 +88,20 @@ async function chatgptToMarkdown(json, sourceDir, { dateFormat } = { dateFormat:
             ? "```" + content.language.replace("unknown", "") + "\n" + content.text + "\n```"
             : content.content_type == "execution_output"
             ? "```\n" + content.text + "\n```"
+            : content.content_type == "multimodal_text"
+            ? content.parts
+                .map((part) =>
+                  part.content_type === "image_asset_pointer"
+                    ? `Image (${part.width}x${part.height}): ${part?.metadata?.dalle?.prompt}\n\n`
+                    : `${part.content_type}\n\n`,
+                )
+                .join("")
+            : content.content_type == "tether_browsing_display"
+            ? "```\n" + content.result + "\n```"
+            : content.content_type == "tether_quote"
+            ? "```\n" + `${content.title} (${content.url})\n\n${content.text}` + "\n```"
+            : content.content_type == "system_error"
+            ? `${content.name}\n\n${content.text}\n\n`
             : content;
         // Ignore empty content
         if (!body.trim()) return "";

package/index.test.js

@@ -3,7 +3,7 @@
 import { promises as fs } from "fs";
 import path from "path";
 import os from "os";
-import chatgptToMarkdown from "./index";
+import { default as chatgptToMarkdown, formatDate } from "./index";
 
 describe("chatgptToMarkdown", () => {
   let tempDir;
@@ -40,13 +40,14 @@ describe("chatgptToMarkdown", () => {
 
     expect(fileContent).toBe(`# Test Conversation
 
-- Created: 1 Sep 2021 5:30 AM
-- Updated: 1 Sep 2021 6:30 AM
+- Created: ${formatDate(1630454400 * 1000)}
+- Updated: ${formatDate(1630458000 * 1000)}
 
 ## user (John)
 
     Hello
 
+
 `);
   });
 
@@ -129,6 +130,82 @@ describe("chatgptToMarkdown", () => {
     expect(fileContent).not.toContain("## user (John)");
   });
 
+  it("should handle tether_browsing_display content", async () => {
+    const json = [
+      {
+        title: "Test Conversation",
+        create_time: 1630454400,
+        update_time: 1630458000,
+        mapping: {
+          0: {
+            message: {
+              author: { role: "tool", name: "browser" },
+              content: { content_type: "tether_browsing_display", result: "L0: x" },
+            },
+          },
+        },
+      },
+    ];
+    await chatgptToMarkdown(json, tempDir);
+    const fileContent = await fs.readFile(path.join(tempDir, "Test Conversation.md"), "utf8");
+    expect(fileContent).toContain("```\nL0: x\n```");
+  });
+
+  it("should handle tether_quote content", async () => {
+    const json = [
+      {
+        title: "Test Conversation",
+        create_time: 1630454400,
+        update_time: 1630458000,
+        mapping: {
+          0: {
+            message: {
+              author: { role: "tool", name: "browser" },
+              content: { content_type: "tether_quote", url: "x.com", domain: "x.com", title: "T", text: "X" },
+            },
+          },
+        },
+      },
+    ];
+    await chatgptToMarkdown(json, tempDir);
+    const fileContent = await fs.readFile(path.join(tempDir, "Test Conversation.md"), "utf8");
+    expect(fileContent).toContain("```\nT (x.com)\n\nX\n```");
+  });
+
+  it("should handle multimodal_text content", async () => {
+    const json = [
+      {
+        title: "Test Conversation",
+        create_time: 1630454400,
+        update_time: 1630458000,
+        mapping: {
+          0: {
+            message: {
+              author: { role: "tool", name: "dalle.text2im" },
+              content: {
+                content_type: "multimodal_text",
+                parts: [
+                  {
+                    content_type: "image_asset_pointer",
+                    width: 1024,
+                    height: 1024,
+                    metadata: { dalle: { prompt: "Photo" } },
+                  },
+                  { content_type: "image_asset_pointer", width: 1024, height: 1024 },
+                  { content_type: "some_other_type" },
+                ],
+              },
+            },
+          },
+        },
+      },
+    ];
+    await chatgptToMarkdown(json, tempDir);
+    const fileContent = await fs.readFile(path.join(tempDir, "Test Conversation.md"), "utf8");
+    expect(fileContent).toContain("Image (1024x1024): Photo\n");
+    expect(fileContent).toContain("some_other_type\n");
+  });
+
   it("should indent messages with tool role that contain ``` fenced code blocks", async () => {
     const json = [
       {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chatgpt-to-markdown",
-  "version": "1.3.0",
+  "version": "1.5.0",
   "description": "Convert ChatGPT exported conversations.json to Markdown",
   "main": "index.js",
   "type": "module",