notebooklm-sdk 0.2.0 → 0.3.1

package/README.md

@@ -8,7 +8,7 @@
 
 Generate AI podcasts, chat with documents, run web research, and manage notebooks programmatically — from Node.js, Bun, or Deno.
 
-> ⚠️ **Unofficial.** This SDK reverse-engineers the NotebookLM internal API. It may break when Google updates their service. Not affiliated with Google.
+> **Unofficial.** This SDK reverse-engineers the NotebookLM internal API. It may break when Google updates their service. Not affiliated with Google.
 
 TypeScript port of [notebooklm-py](https://github.com/teng-lin/notebooklm-py).
 

package/dist/index.cjs

@@ -21,6 +21,10 @@ __export(enums_exports, {
   ArtifactTypeCode: () => exports.ArtifactTypeCode,
   AudioFormat: () => exports.AudioFormat,
   AudioLength: () => exports.AudioLength,
+  ChatGoal: () => exports.ChatGoal,
+  ChatMode: () => exports.ChatMode,
+  ChatResponseLength: () => exports.ChatResponseLength,
+  DriveMimeType: () => exports.DriveMimeType,
   ExportType: () => exports.ExportType,
   InfographicDetail: () => exports.InfographicDetail,
   InfographicOrientation: () => exports.InfographicOrientation,
@@ -38,6 +42,7 @@ __export(enums_exports, {
   VideoStyle: () => exports.VideoStyle,
   artifactStatusFromCode: () => artifactStatusFromCode,
   artifactTypeFromCode: () => artifactTypeFromCode,
+  chatModeToParams: () => chatModeToParams,
   sourceStatusFromCode: () => sourceStatusFromCode,
   sourceTypeFromCode: () => sourceTypeFromCode
 });
@@ -59,7 +64,10 @@ function artifactStatusFromCode(code) {
 function sourceStatusFromCode(code) {
   return SOURCE_STATUS_MAP[code] ?? "unknown";
 }
-exports.RPCMethod = void 0; exports.ArtifactTypeCode = void 0; var ArtifactStatusCode, SourceStatusCode; exports.AudioFormat = void 0; exports.AudioLength = void 0; exports.VideoFormat = void 0; exports.VideoStyle = void 0; exports.QuizQuantity = void 0; exports.QuizDifficulty = void 0; exports.InfographicOrientation = void 0; exports.InfographicDetail = void 0; exports.InfographicStyle = void 0; exports.SlideDeckFormat = void 0; exports.SlideDeckLength = void 0; exports.ExportType = void 0; var SOURCE_TYPE_MAP, ARTIFACT_TYPE_MAP, ARTIFACT_STATUS_MAP, SOURCE_STATUS_MAP; exports.ShareAccess = void 0; exports.ShareViewLevel = void 0; exports.SharePermission = void 0;
+function chatModeToParams(mode) {
+  return CHAT_MODE_PARAMS[mode];
+}
+exports.RPCMethod = void 0; exports.ArtifactTypeCode = void 0; var ArtifactStatusCode, SourceStatusCode; exports.AudioFormat = void 0; exports.AudioLength = void 0; exports.VideoFormat = void 0; exports.VideoStyle = void 0; exports.QuizQuantity = void 0; exports.QuizDifficulty = void 0; exports.InfographicOrientation = void 0; exports.InfographicDetail = void 0; exports.InfographicStyle = void 0; exports.SlideDeckFormat = void 0; exports.SlideDeckLength = void 0; exports.ExportType = void 0; exports.DriveMimeType = void 0; var SOURCE_TYPE_MAP, ARTIFACT_TYPE_MAP, ARTIFACT_STATUS_MAP, SOURCE_STATUS_MAP; exports.ChatMode = void 0; var CHAT_MODE_PARAMS; exports.ChatGoal = void 0; exports.ChatResponseLength = void 0; exports.ShareAccess = void 0; exports.ShareViewLevel = void 0; exports.SharePermission = void 0;
 var init_enums = __esm({
   "src/types/enums.ts"() {
     exports.RPCMethod = {
@@ -208,6 +216,12 @@ var init_enums = __esm({
       DOCS: 1,
       SHEETS: 2
     };
+    exports.DriveMimeType = {
+      GOOGLE_DOC: "application/vnd.google-apps.document",
+      GOOGLE_SLIDES: "application/vnd.google-apps.presentation",
+      GOOGLE_SHEETS: "application/vnd.google-apps.spreadsheet",
+      PDF: "application/pdf"
+    };
     SOURCE_TYPE_MAP = {
       1: "google_docs",
       2: "google_slides",
@@ -243,6 +257,38 @@ var init_enums = __esm({
       3: "error",
       5: "preparing"
     };
+    exports.ChatMode = {
+      /** General purpose — balanced length and style. */
+      DEFAULT: "default",
+      /** Educational focus with longer, learning-oriented responses. */
+      LEARNING_GUIDE: "learning_guide",
+      /** Short, concise answers. */
+      CONCISE: "concise",
+      /** Verbose, detailed answers. */
+      DETAILED: "detailed"
+    };
+    CHAT_MODE_PARAMS = {
+      default: [1, 1],
+      learning_guide: [3, 4],
+      concise: [1, 5],
+      detailed: [1, 4]
+    };
+    exports.ChatGoal = {
+      /** General purpose research and brainstorming. */
+      DEFAULT: 1,
+      /** Custom instructions (up to 10,000 characters). */
+      CUSTOM: 2,
+      /** Educational focus with learning-oriented responses. */
+      LEARNING_GUIDE: 3
+    };
+    exports.ChatResponseLength = {
+      /** Standard response length. */
+      DEFAULT: 1,
+      /** Verbose, detailed responses. */
+      LONGER: 4,
+      /** Concise, brief responses. */
+      SHORTER: 5
+    };
     exports.ShareAccess = {
       /** Only explicitly shared users can access */
       RESTRICTED: 0,
@@ -765,6 +811,30 @@ var ArtifactsAPI = class {
     const artifacts = await this.list(notebookId);
     return artifacts.find((a) => a.id === artifactId) ?? null;
   }
+  async listAudio(notebookId) {
+    return (await this.list(notebookId)).filter((a) => a.kind === "audio");
+  }
+  async listVideo(notebookId) {
+    return (await this.list(notebookId)).filter((a) => a.kind === "video");
+  }
+  async listReports(notebookId) {
+    return (await this.list(notebookId)).filter((a) => a.kind === "report");
+  }
+  async listQuizzes(notebookId) {
+    return (await this.list(notebookId)).filter((a) => a.kind === "quiz");
+  }
+  async listFlashcards(notebookId) {
+    return (await this.list(notebookId)).filter((a) => a.kind === "flashcards");
+  }
+  async listInfographics(notebookId) {
+    return (await this.list(notebookId)).filter((a) => a.kind === "infographic");
+  }
+  async listSlideDecks(notebookId) {
+    return (await this.list(notebookId)).filter((a) => a.kind === "slide_deck");
+  }
+  async listDataTables(notebookId) {
+    return (await this.list(notebookId)).filter((a) => a.kind === "data_table");
+  }
   async delete(notebookId, artifactId) {
     const params = [[2], notebookId, artifactId];
     await this.rpc.call(exports.RPCMethod.DELETE_ARTIFACT, params, {
@@ -1133,6 +1203,39 @@ ${opts.extraInstructions}` : cfg.prompt;
     if (!url) throw new exports.ArtifactNotReadyError("infographic", { artifactId });
     return this._fetchMediaWithCookies(url);
   }
+  /** Get AI-suggested report formats based on notebook content. */
+  async suggestReports(notebookId) {
+    const params = [[2], notebookId];
+    const result = await this.rpc.call(exports.RPCMethod.GET_SUGGESTED_REPORTS, params, {
+      sourcePath: `/notebook/${notebookId}`,
+      allowNull: true,
+      timeoutMs: 12e4
+    });
+    if (!Array.isArray(result) || !result.length) return [];
+    const items = Array.isArray(result[0]) ? result[0] : result;
+    const suggestions = [];
+    for (const item of items) {
+      if (Array.isArray(item) && item.length >= 5) {
+        suggestions.push({
+          title: typeof item[0] === "string" ? item[0] : "",
+          description: typeof item[1] === "string" ? item[1] : "",
+          prompt: typeof item[4] === "string" ? item[4] : "",
+          audienceLevel: typeof item[5] === "number" ? item[5] : 2
+        });
+      }
+    }
+    return suggestions;
+  }
+  /** Revise an individual slide in a completed slide deck using a prompt. */
+  async reviseSlide(notebookId, artifactId, slideIndex, prompt) {
+    if (slideIndex < 0) throw new Error("slideIndex must be >= 0");
+    const params = [[2], artifactId, [[[slideIndex, prompt]]]];
+    const result = await this.rpc.call(exports.RPCMethod.REVISE_SLIDE, params, {
+      sourcePath: `/notebook/${notebookId}`,
+      allowNull: true
+    });
+    return this._parseGenerationResult(result);
+  }
   /** Get parsed headers and rows from a completed data table artifact. */
   async getDataTableContent(notebookId, artifactId) {
     const artifacts = await this._listRaw(notebookId);
@@ -1356,6 +1459,36 @@ var ChatAPI = class {
     }
     return null;
   }
+  /**
+   * Low-level chat configuration. Set goal, response length, and optional
+   * custom instructions directly. Persists on the server per notebook.
+   * Use `setMode()` for preset combinations instead.
+   */
+  async configure(notebookId, goal, length, customPrompt) {
+    if (goal === exports.ChatGoal.CUSTOM && !customPrompt) {
+      throw new Error("customPrompt is required when goal is ChatGoal.CUSTOM");
+    }
+    const goalArray = goal === exports.ChatGoal.CUSTOM ? [goal, customPrompt] : [goal];
+    const chatSettings = [goalArray, [length]];
+    const params = [notebookId, [[null, null, null, null, null, null, null, chatSettings]]];
+    await this.rpc.call(exports.RPCMethod.RENAME_NOTEBOOK, params, {
+      sourcePath: `/notebook/${notebookId}`,
+      allowNull: true
+    });
+  }
+  /**
+   * Set the chat mode for a notebook. Persists on the server — affects all
+   * subsequent `ask()` calls until changed.
+   */
+  async setMode(notebookId, mode) {
+    const [goal, length] = chatModeToParams(mode);
+    const chatSettings = [[goal], [length]];
+    const params = [notebookId, [[null, null, null, null, null, null, null, chatSettings]]];
+    await this.rpc.call(exports.RPCMethod.RENAME_NOTEBOOK, params, {
+      sourcePath: `/notebook/${notebookId}`,
+      allowNull: true
+    });
+  }
   clearCache(conversationId) {
     if (conversationId) {
       this.conversationCache.delete(conversationId);
@@ -1526,6 +1659,9 @@ var NotebooksAPI = class {
     }
     return "";
   }
+  async removeFromRecent(notebookId) {
+    await this.rpc.call(exports.RPCMethod.REMOVE_RECENTLY_VIEWED, [notebookId], { allowNull: true });
+  }
   async getDescription(notebookId) {
     const params = [notebookId, [2]];
     const result = await this.rpc.call(exports.RPCMethod.SUMMARIZE, params, {
@@ -2051,6 +2187,44 @@ var SourcesAPI = class {
       _typeCode: null
     };
   }
+  async addDrive(notebookId, fileId, title, mimeType = exports.DriveMimeType.GOOGLE_DOC, opts = {}) {
+    const sourceData = [
+      [fileId, mimeType, 1, title],
+      null,
+      null,
+      null,
+      null,
+      null,
+      null,
+      null,
+      null,
+      null,
+      1
+    ];
+    const params = [
+      [sourceData],
+      notebookId,
+      [2],
+      [1, null, null, null, null, null, null, null, null, null, [1]]
+    ];
+    const result = await this.rpc.call(exports.RPCMethod.ADD_SOURCE, params, {
+      sourcePath: `/notebook/${notebookId}`,
+      allowNull: true
+    });
+    const sourceId = extractSourceId(result);
+    if (opts.waitUntilReady) {
+      return this.waitUntilReady(notebookId, sourceId, opts.waitTimeout);
+    }
+    return {
+      id: sourceId,
+      title,
+      url: null,
+      kind: "unknown",
+      createdAt: null,
+      status: "processing",
+      _typeCode: null
+    };
+  }
   async addFile(notebookId, filePath, mimeType, opts = {}) {
     const fileData = fs.readFileSync(filePath);
     const fileName = filePath.split("/").pop() ?? "file";
@@ -2133,6 +2307,74 @@ var SourcesAPI = class {
     const uploadResult = await uploadResp.text();
     return uploadResult.trim();
   }
+  /** Get the AI-generated Source Guide (summary + keywords) for a source. */
+  async getGuide(notebookId, sourceId) {
+    const params = [[[[sourceId]]]];
+    const result = await this.rpc.call(exports.RPCMethod.GET_SOURCE_GUIDE, params, {
+      sourcePath: `/notebook/${notebookId}`,
+      allowNull: true,
+      timeoutMs: 12e4
+    });
+    let summary = "";
+    let keywords = [];
+    if (Array.isArray(result) && result.length > 0) {
+      const outer = result[0];
+      if (Array.isArray(outer) && outer.length > 0) {
+        const inner = outer[0];
+        if (Array.isArray(inner)) {
+          if (inner.length > 1 && Array.isArray(inner[1]) && typeof inner[1][0] === "string") {
+            summary = inner[1][0];
+          }
+          if (inner.length > 2 && Array.isArray(inner[2]) && Array.isArray(inner[2][0])) {
+            keywords = inner[2][0].filter((k) => typeof k === "string");
+          }
+        }
+      }
+    }
+    return { summary, keywords };
+  }
+  /** Get the full indexed text content of a source. */
+  async getFulltext(notebookId, sourceId) {
+    const params = [[sourceId], [2], [2]];
+    const result = await this.rpc.call(exports.RPCMethod.GET_SOURCE, params, {
+      sourcePath: `/notebook/${notebookId}`,
+      allowNull: true
+    });
+    if (!Array.isArray(result) || !result.length) {
+      throw new Error(`Source ${sourceId} not found in notebook ${notebookId}`);
+    }
+    let title = "";
+    let url = null;
+    if (Array.isArray(result[0]) && result[0].length > 1) {
+      title = typeof result[0][1] === "string" ? result[0][1] : "";
+      const meta = result[0][2];
+      if (Array.isArray(meta) && meta.length > 7 && Array.isArray(meta[7]) && typeof meta[7][0] === "string") {
+        url = meta[7][0];
+      }
+    }
+    let content = "";
+    if (Array.isArray(result[3]) && result[3].length > 0) {
+      const texts = extractAllText(result[3][0]);
+      content = texts.join("\n");
+    }
+    return { sourceId, title, content, url, charCount: content.length };
+  }
+  /** Check if a source has newer content available. Returns true if fresh, false if stale. */
+  async checkFreshness(notebookId, sourceId) {
+    const params = [null, [sourceId], [2]];
+    const result = await this.rpc.call(exports.RPCMethod.CHECK_SOURCE_FRESHNESS, params, {
+      sourcePath: `/notebook/${notebookId}`,
+      allowNull: true
+    });
+    if (result === true) return true;
+    if (result === false) return false;
+    if (Array.isArray(result)) {
+      if (result.length === 0) return true;
+      const first = result[0];
+      if (Array.isArray(first) && first.length > 1 && first[1] === true) return true;
+    }
+    return false;
+  }
   async delete(notebookId, sourceId) {
     const params = [notebookId, [sourceId], [2]];
     await this.rpc.call(exports.RPCMethod.DELETE_SOURCE, params, {
@@ -2187,6 +2429,15 @@ function extractSourceId(result) {
   console.log("extractSourceId debug info: could not parse:", JSON.stringify(result, null, 2));
   throw new Error("Could not extract source ID from API response");
 }
+function extractAllText(data, maxDepth = 100) {
+  if (maxDepth <= 0) return [];
+  const texts = [];
+  for (const item of data) {
+    if (typeof item === "string" && item.length > 0) texts.push(item);
+    else if (Array.isArray(item)) texts.push(...extractAllText(item, maxDepth - 1));
+  }
+  return texts;
+}
 function sleep2(ms) {
   return new Promise((resolve) => setTimeout(resolve, ms));
 }