notebooklm-sdk 0.1.8 → 0.3.0

package/dist/index.d.cts

@@ -148,6 +148,21 @@ declare const ExportType: {
     readonly SHEETS: 2;
 };
 type ExportTypeValue = (typeof ExportType)[keyof typeof ExportType];
+/**
+ * Predefined chat modes that control response style and verbosity.
+ * Applied per-notebook via `client.chat.setMode()`.
+ */
+declare const ChatMode: {
+    /** General purpose — balanced length and style. */
+    readonly DEFAULT: "default";
+    /** Educational focus with longer, learning-oriented responses. */
+    readonly LEARNING_GUIDE: "learning_guide";
+    /** Short, concise answers. */
+    readonly CONCISE: "concise";
+    /** Verbose, detailed answers. */
+    readonly DETAILED: "detailed";
+};
+type ChatModeValue = (typeof ChatMode)[keyof typeof ChatMode];
 declare const ShareAccess: {
     /** Only explicitly shared users can access */
     readonly RESTRICTED: 0;
@@ -222,6 +237,13 @@ interface Source {
     /** Raw type code from API (for debugging) */
     _typeCode: number | null;
 }
+interface SourceFulltext {
+    sourceId: string;
+    title: string;
+    content: string;
+    url: string | null;
+    charCount: number;
+}
 interface Artifact {
     id: string;
     title: string | null;
@@ -280,11 +302,32 @@ interface Note {
     createdAt: Date | null;
     updatedAt: Date | null;
 }
-interface MindMap {
-    id: string;
-    title: string | null;
-    content: string;
-    createdAt: Date | null;
+interface SourceGuide {
+    /** AI-generated summary with **bold** keywords (markdown). */
+    summary: string;
+    /** Topic keywords extracted from the source. */
+    keywords: string[];
+}
+interface ReportSuggestion {
+    title: string;
+    description: string;
+    prompt: string;
+    /** 1 = beginner, 2 = advanced */
+    audienceLevel: number;
+}
+
+declare class NotesAPI {
+    private readonly rpc;
+    constructor(rpc: RPCCore);
+    list(notebookId: string): Promise<Note[]>;
+    listMindMaps(notebookId: string): Promise<Note[]>;
+    create(notebookId: string, content: string, title?: string): Promise<Note>;
+    update(notebookId: string, noteId: string, content: string, title?: string): Promise<Note>;
+    delete(notebookId: string, noteId: string): Promise<boolean>;
+    private _fetchAll;
+    private _isMindMap;
+    private _extractContent;
+    private _parseItem;
 }
 
 interface CreateAudioOptions {
@@ -322,6 +365,15 @@ interface CreateSlideDeckOptions {
     instructions?: string;
     language?: string;
 }
+interface CreateDataTableOptions {
+    sourceIds?: string[];
+    instructions?: string;
+    language?: string;
+}
+interface DataTableContent {
+    headers: string[];
+    rows: string[][];
+}
 type ReportFormat = "briefing_doc" | "study_guide" | "blog_post" | "custom";
 interface CreateReportOptions {
     format?: ReportFormat;
@@ -333,8 +385,10 @@ interface CreateReportOptions {
 declare class ArtifactsAPI {
     private readonly rpc;
     private readonly auth;
-    constructor(rpc: RPCCore, auth: AuthTokens);
+    private readonly notes;
+    constructor(rpc: RPCCore, auth: AuthTokens, notes: NotesAPI);
     list(notebookId: string): Promise<Artifact[]>;
+    private _listRaw;
     get(notebookId: string, artifactId: string): Promise<Artifact | null>;
     delete(notebookId: string, artifactId: string): Promise<boolean>;
     rename(notebookId: string, artifactId: string, newTitle: string): Promise<boolean>;
@@ -344,8 +398,9 @@ declare class ArtifactsAPI {
     createFlashcards(notebookId: string, opts?: CreateQuizOptions): Promise<GenerationStatus>;
     createInfographic(notebookId: string, opts?: CreateInfographicOptions): Promise<GenerationStatus>;
     createSlideDeck(notebookId: string, opts?: CreateSlideDeckOptions): Promise<GenerationStatus>;
+    createDataTable(notebookId: string, opts?: CreateDataTableOptions): Promise<GenerationStatus>;
     createReport(notebookId: string, opts?: CreateReportOptions): Promise<GenerationStatus>;
-    createMindMap(notebookId: string, sourceIds?: string[]): Promise<GenerationStatus>;
+    createMindMap(notebookId: string, sourceIds?: string[]): Promise<Note>;
     /** Poll until artifact reaches completed/failed status. */
     waitUntilReady(notebookId: string, artifactId: string, timeout?: number, pollInterval?: number): Promise<Artifact>;
     /** Download audio content as a Buffer. */
@@ -356,6 +411,16 @@ declare class ArtifactsAPI {
     getReportMarkdown(notebookId: string, artifactId: string): Promise<string | null>;
     /** Get interactive HTML for quiz/flashcard artifacts. */
     getInteractiveHtml(notebookId: string, artifactId: string): Promise<string | null>;
+    /** Download a completed slide deck as PDF or PPTX. Returns a Buffer. */
+    downloadSlideDeck(notebookId: string, artifactId: string, format?: "pdf" | "pptx"): Promise<Buffer>;
+    /** Download a completed infographic as PNG. Returns a Buffer. */
+    downloadInfographic(notebookId: string, artifactId: string): Promise<Buffer>;
+    /** Get AI-suggested report formats based on notebook content. */
+    suggestReports(notebookId: string): Promise<ReportSuggestion[]>;
+    /** Revise an individual slide in a completed slide deck using a prompt. */
+    reviseSlide(notebookId: string, artifactId: string, slideIndex: number, prompt: string): Promise<GenerationStatus>;
+    /** Get parsed headers and rows from a completed data table artifact. */
+    getDataTableContent(notebookId: string, artifactId: string): Promise<DataTableContent | null>;
     /**
      * Fetch a Google-hosted media URL, manually following redirects to ensure
      * cookies are included on every hop. Node/Bun fetch strips the Cookie header
@@ -379,6 +444,11 @@ declare class ChatAPI {
     ask(notebookId: string, query: string, opts?: AskOptions): Promise<AskResult>;
     getConversationTurns(notebookId: string, conversationId: string): Promise<ConversationTurn[]>;
     getLastConversationId(notebookId: string): Promise<string | null>;
+    /**
+     * Set the chat mode for a notebook. Persists on the server — affects all
+     * subsequent `ask()` calls until changed.
+     */
+    setMode(notebookId: string, mode: ChatModeValue): Promise<void>;
     clearCache(conversationId?: string): void;
     private _buildHistory;
 }
@@ -392,21 +462,10 @@ declare class NotebooksAPI {
     delete(notebookId: string): Promise<boolean>;
     rename(notebookId: string, newTitle: string): Promise<Notebook>;
     getSummary(notebookId: string): Promise<string>;
+    removeFromRecent(notebookId: string): Promise<void>;
     getDescription(notebookId: string): Promise<NotebookDescription>;
 }
 
-declare class NotesAPI {
-    private readonly rpc;
-    constructor(rpc: RPCCore);
-    list(notebookId: string): Promise<{
-        notes: Note[];
-        mindMaps: MindMap[];
-    }>;
-    create(notebookId: string, content: string, title?: string): Promise<Note>;
-    update(notebookId: string, noteId: string, content: string, title?: string): Promise<Note>;
-    delete(notebookId: string, noteId: string): Promise<boolean>;
-}
-
 interface ResearchTask {
     taskId: string;
     reportId: string | null;
@@ -509,6 +568,12 @@ declare class SourcesAPI {
     addFileBuffer(notebookId: string, data: Buffer | Uint8Array, fileName: string, _mimeType: string, opts?: AddSourceOptions): Promise<Source>;
     private startResumableUpload;
     private uploadFile;
+    /** Get the AI-generated Source Guide (summary + keywords) for a source. */
+    getGuide(notebookId: string, sourceId: string): Promise<SourceGuide>;
+    /** Get the full indexed text content of a source. */
+    getFulltext(notebookId: string, sourceId: string): Promise<SourceFulltext>;
+    /** Check if a source has newer content available. Returns true if fresh, false if stale. */
+    checkFreshness(notebookId: string, sourceId: string): Promise<boolean>;
     delete(notebookId: string, sourceId: string): Promise<boolean>;
     refresh(notebookId: string, sourceId: string): Promise<boolean>;
     waitUntilReady(notebookId: string, sourceId: string, timeout?: number, initialInterval?: number, maxInterval?: number, backoffFactor?: number): Promise<Source>;
@@ -553,4 +618,4 @@ declare class NotebookLMClient {
     refreshTokens(): Promise<void>;
 }
 
-export { type AddSourceOptions, type Artifact, type ArtifactStatus, type ArtifactType, ArtifactTypeCode, ArtifactsAPI, type AskOptions, type AskResult, AudioFormat, type AudioFormatValue, AudioLength, type AudioLengthValue, AuthTokens, ChatAPI, type ChatReference, type ClientOptions, ConnectOptions, type ConversationTurn, type CreateAudioOptions, type CreateInfographicOptions, type CreateQuizOptions, type CreateReportOptions, type CreateSlideDeckOptions, type CreateVideoOptions, ExportType, type ExportTypeValue, type GenerationStatus, type ImportedSource, InfographicDetail, type InfographicDetailValue, InfographicOrientation, type InfographicOrientationValue, InfographicStyle, type InfographicStyleValue, type MindMap, type Note, type Notebook, type NotebookDescription, NotebookLMClient, type NotebookMetadata, NotebooksAPI, NotesAPI, QuizDifficulty, type QuizDifficultyValue, QuizQuantity, type QuizQuantityValue, RPCMethod, type RPCMethodId, ResearchAPI, type ResearchResult, type ResearchSource, type ResearchTask, SettingsAPI, ShareAccess, type ShareAccessValue, SharePermission, type SharePermissionValue, type ShareStatus, ShareViewLevel, type ShareViewLevelValue, type SharedUser, SharingAPI, SlideDeckFormat, type SlideDeckFormatValue, SlideDeckLength, type SlideDeckLengthValue, type Source, type SourceStatus, type SourceSummary, type SourceType, SourcesAPI, type SuggestedTopic, VideoFormat, type VideoFormatValue, VideoStyle, type VideoStyleValue };
+export { type AddSourceOptions, type Artifact, type ArtifactStatus, type ArtifactType, ArtifactTypeCode, ArtifactsAPI, type AskOptions, type AskResult, AudioFormat, type AudioFormatValue, AudioLength, type AudioLengthValue, AuthTokens, ChatAPI, ChatMode, type ChatModeValue, type ChatReference, type ClientOptions, ConnectOptions, type ConversationTurn, type CreateAudioOptions, type CreateDataTableOptions, type CreateInfographicOptions, type CreateQuizOptions, type CreateReportOptions, type CreateSlideDeckOptions, type CreateVideoOptions, type DataTableContent, ExportType, type ExportTypeValue, type GenerationStatus, type ImportedSource, InfographicDetail, type InfographicDetailValue, InfographicOrientation, type InfographicOrientationValue, InfographicStyle, type InfographicStyleValue, type Note, type Notebook, type NotebookDescription, NotebookLMClient, type NotebookMetadata, NotebooksAPI, NotesAPI, QuizDifficulty, type QuizDifficultyValue, QuizQuantity, type QuizQuantityValue, RPCMethod, type RPCMethodId, type ReportSuggestion, ResearchAPI, type ResearchResult, type ResearchSource, type ResearchTask, SettingsAPI, ShareAccess, type ShareAccessValue, SharePermission, type SharePermissionValue, type ShareStatus, ShareViewLevel, type ShareViewLevelValue, type SharedUser, SharingAPI, SlideDeckFormat, type SlideDeckFormatValue, SlideDeckLength, type SlideDeckLengthValue, type Source, type SourceFulltext, type SourceGuide, type SourceStatus, type SourceSummary, type SourceType, SourcesAPI, type SuggestedTopic, VideoFormat, type VideoFormatValue, VideoStyle, type VideoStyleValue };

package/dist/index.d.ts

@@ -148,6 +148,21 @@ declare const ExportType: {
     readonly SHEETS: 2;
 };
 type ExportTypeValue = (typeof ExportType)[keyof typeof ExportType];
+/**
+ * Predefined chat modes that control response style and verbosity.
+ * Applied per-notebook via `client.chat.setMode()`.
+ */
+declare const ChatMode: {
+    /** General purpose — balanced length and style. */
+    readonly DEFAULT: "default";
+    /** Educational focus with longer, learning-oriented responses. */
+    readonly LEARNING_GUIDE: "learning_guide";
+    /** Short, concise answers. */
+    readonly CONCISE: "concise";
+    /** Verbose, detailed answers. */
+    readonly DETAILED: "detailed";
+};
+type ChatModeValue = (typeof ChatMode)[keyof typeof ChatMode];
 declare const ShareAccess: {
     /** Only explicitly shared users can access */
     readonly RESTRICTED: 0;
@@ -222,6 +237,13 @@ interface Source {
     /** Raw type code from API (for debugging) */
     _typeCode: number | null;
 }
+interface SourceFulltext {
+    sourceId: string;
+    title: string;
+    content: string;
+    url: string | null;
+    charCount: number;
+}
 interface Artifact {
     id: string;
     title: string | null;
@@ -280,11 +302,32 @@ interface Note {
     createdAt: Date | null;
     updatedAt: Date | null;
 }
-interface MindMap {
-    id: string;
-    title: string | null;
-    content: string;
-    createdAt: Date | null;
+interface SourceGuide {
+    /** AI-generated summary with **bold** keywords (markdown). */
+    summary: string;
+    /** Topic keywords extracted from the source. */
+    keywords: string[];
+}
+interface ReportSuggestion {
+    title: string;
+    description: string;
+    prompt: string;
+    /** 1 = beginner, 2 = advanced */
+    audienceLevel: number;
+}
+
+declare class NotesAPI {
+    private readonly rpc;
+    constructor(rpc: RPCCore);
+    list(notebookId: string): Promise<Note[]>;
+    listMindMaps(notebookId: string): Promise<Note[]>;
+    create(notebookId: string, content: string, title?: string): Promise<Note>;
+    update(notebookId: string, noteId: string, content: string, title?: string): Promise<Note>;
+    delete(notebookId: string, noteId: string): Promise<boolean>;
+    private _fetchAll;
+    private _isMindMap;
+    private _extractContent;
+    private _parseItem;
 }
 
 interface CreateAudioOptions {
@@ -322,6 +365,15 @@ interface CreateSlideDeckOptions {
     instructions?: string;
     language?: string;
 }
+interface CreateDataTableOptions {
+    sourceIds?: string[];
+    instructions?: string;
+    language?: string;
+}
+interface DataTableContent {
+    headers: string[];
+    rows: string[][];
+}
 type ReportFormat = "briefing_doc" | "study_guide" | "blog_post" | "custom";
 interface CreateReportOptions {
     format?: ReportFormat;
@@ -333,8 +385,10 @@ interface CreateReportOptions {
 declare class ArtifactsAPI {
     private readonly rpc;
     private readonly auth;
-    constructor(rpc: RPCCore, auth: AuthTokens);
+    private readonly notes;
+    constructor(rpc: RPCCore, auth: AuthTokens, notes: NotesAPI);
     list(notebookId: string): Promise<Artifact[]>;
+    private _listRaw;
     get(notebookId: string, artifactId: string): Promise<Artifact | null>;
     delete(notebookId: string, artifactId: string): Promise<boolean>;
     rename(notebookId: string, artifactId: string, newTitle: string): Promise<boolean>;
@@ -344,8 +398,9 @@ declare class ArtifactsAPI {
     createFlashcards(notebookId: string, opts?: CreateQuizOptions): Promise<GenerationStatus>;
     createInfographic(notebookId: string, opts?: CreateInfographicOptions): Promise<GenerationStatus>;
     createSlideDeck(notebookId: string, opts?: CreateSlideDeckOptions): Promise<GenerationStatus>;
+    createDataTable(notebookId: string, opts?: CreateDataTableOptions): Promise<GenerationStatus>;
     createReport(notebookId: string, opts?: CreateReportOptions): Promise<GenerationStatus>;
-    createMindMap(notebookId: string, sourceIds?: string[]): Promise<GenerationStatus>;
+    createMindMap(notebookId: string, sourceIds?: string[]): Promise<Note>;
     /** Poll until artifact reaches completed/failed status. */
     waitUntilReady(notebookId: string, artifactId: string, timeout?: number, pollInterval?: number): Promise<Artifact>;
     /** Download audio content as a Buffer. */
@@ -356,6 +411,16 @@ declare class ArtifactsAPI {
     getReportMarkdown(notebookId: string, artifactId: string): Promise<string | null>;
     /** Get interactive HTML for quiz/flashcard artifacts. */
     getInteractiveHtml(notebookId: string, artifactId: string): Promise<string | null>;
+    /** Download a completed slide deck as PDF or PPTX. Returns a Buffer. */
+    downloadSlideDeck(notebookId: string, artifactId: string, format?: "pdf" | "pptx"): Promise<Buffer>;
+    /** Download a completed infographic as PNG. Returns a Buffer. */
+    downloadInfographic(notebookId: string, artifactId: string): Promise<Buffer>;
+    /** Get AI-suggested report formats based on notebook content. */
+    suggestReports(notebookId: string): Promise<ReportSuggestion[]>;
+    /** Revise an individual slide in a completed slide deck using a prompt. */
+    reviseSlide(notebookId: string, artifactId: string, slideIndex: number, prompt: string): Promise<GenerationStatus>;
+    /** Get parsed headers and rows from a completed data table artifact. */
+    getDataTableContent(notebookId: string, artifactId: string): Promise<DataTableContent | null>;
     /**
      * Fetch a Google-hosted media URL, manually following redirects to ensure
      * cookies are included on every hop. Node/Bun fetch strips the Cookie header
@@ -379,6 +444,11 @@ declare class ChatAPI {
     ask(notebookId: string, query: string, opts?: AskOptions): Promise<AskResult>;
     getConversationTurns(notebookId: string, conversationId: string): Promise<ConversationTurn[]>;
     getLastConversationId(notebookId: string): Promise<string | null>;
+    /**
+     * Set the chat mode for a notebook. Persists on the server — affects all
+     * subsequent `ask()` calls until changed.
+     */
+    setMode(notebookId: string, mode: ChatModeValue): Promise<void>;
     clearCache(conversationId?: string): void;
     private _buildHistory;
 }
@@ -392,21 +462,10 @@ declare class NotebooksAPI {
     delete(notebookId: string): Promise<boolean>;
     rename(notebookId: string, newTitle: string): Promise<Notebook>;
     getSummary(notebookId: string): Promise<string>;
+    removeFromRecent(notebookId: string): Promise<void>;
     getDescription(notebookId: string): Promise<NotebookDescription>;
 }
 
-declare class NotesAPI {
-    private readonly rpc;
-    constructor(rpc: RPCCore);
-    list(notebookId: string): Promise<{
-        notes: Note[];
-        mindMaps: MindMap[];
-    }>;
-    create(notebookId: string, content: string, title?: string): Promise<Note>;
-    update(notebookId: string, noteId: string, content: string, title?: string): Promise<Note>;
-    delete(notebookId: string, noteId: string): Promise<boolean>;
-}
-
 interface ResearchTask {
     taskId: string;
     reportId: string | null;
@@ -509,6 +568,12 @@ declare class SourcesAPI {
     addFileBuffer(notebookId: string, data: Buffer | Uint8Array, fileName: string, _mimeType: string, opts?: AddSourceOptions): Promise<Source>;
     private startResumableUpload;
     private uploadFile;
+    /** Get the AI-generated Source Guide (summary + keywords) for a source. */
+    getGuide(notebookId: string, sourceId: string): Promise<SourceGuide>;
+    /** Get the full indexed text content of a source. */
+    getFulltext(notebookId: string, sourceId: string): Promise<SourceFulltext>;
+    /** Check if a source has newer content available. Returns true if fresh, false if stale. */
+    checkFreshness(notebookId: string, sourceId: string): Promise<boolean>;
     delete(notebookId: string, sourceId: string): Promise<boolean>;
     refresh(notebookId: string, sourceId: string): Promise<boolean>;
     waitUntilReady(notebookId: string, sourceId: string, timeout?: number, initialInterval?: number, maxInterval?: number, backoffFactor?: number): Promise<Source>;
@@ -553,4 +618,4 @@ declare class NotebookLMClient {
     refreshTokens(): Promise<void>;
 }
 
-export { type AddSourceOptions, type Artifact, type ArtifactStatus, type ArtifactType, ArtifactTypeCode, ArtifactsAPI, type AskOptions, type AskResult, AudioFormat, type AudioFormatValue, AudioLength, type AudioLengthValue, AuthTokens, ChatAPI, type ChatReference, type ClientOptions, ConnectOptions, type ConversationTurn, type CreateAudioOptions, type CreateInfographicOptions, type CreateQuizOptions, type CreateReportOptions, type CreateSlideDeckOptions, type CreateVideoOptions, ExportType, type ExportTypeValue, type GenerationStatus, type ImportedSource, InfographicDetail, type InfographicDetailValue, InfographicOrientation, type InfographicOrientationValue, InfographicStyle, type InfographicStyleValue, type MindMap, type Note, type Notebook, type NotebookDescription, NotebookLMClient, type NotebookMetadata, NotebooksAPI, NotesAPI, QuizDifficulty, type QuizDifficultyValue, QuizQuantity, type QuizQuantityValue, RPCMethod, type RPCMethodId, ResearchAPI, type ResearchResult, type ResearchSource, type ResearchTask, SettingsAPI, ShareAccess, type ShareAccessValue, SharePermission, type SharePermissionValue, type ShareStatus, ShareViewLevel, type ShareViewLevelValue, type SharedUser, SharingAPI, SlideDeckFormat, type SlideDeckFormatValue, SlideDeckLength, type SlideDeckLengthValue, type Source, type SourceStatus, type SourceSummary, type SourceType, SourcesAPI, type SuggestedTopic, VideoFormat, type VideoFormatValue, VideoStyle, type VideoStyleValue };
+export { type AddSourceOptions, type Artifact, type ArtifactStatus, type ArtifactType, ArtifactTypeCode, ArtifactsAPI, type AskOptions, type AskResult, AudioFormat, type AudioFormatValue, AudioLength, type AudioLengthValue, AuthTokens, ChatAPI, ChatMode, type ChatModeValue, type ChatReference, type ClientOptions, ConnectOptions, type ConversationTurn, type CreateAudioOptions, type CreateDataTableOptions, type CreateInfographicOptions, type CreateQuizOptions, type CreateReportOptions, type CreateSlideDeckOptions, type CreateVideoOptions, type DataTableContent, ExportType, type ExportTypeValue, type GenerationStatus, type ImportedSource, InfographicDetail, type InfographicDetailValue, InfographicOrientation, type InfographicOrientationValue, InfographicStyle, type InfographicStyleValue, type Note, type Notebook, type NotebookDescription, NotebookLMClient, type NotebookMetadata, NotebooksAPI, NotesAPI, QuizDifficulty, type QuizDifficultyValue, QuizQuantity, type QuizQuantityValue, RPCMethod, type RPCMethodId, type ReportSuggestion, ResearchAPI, type ResearchResult, type ResearchSource, type ResearchTask, SettingsAPI, ShareAccess, type ShareAccessValue, SharePermission, type SharePermissionValue, type ShareStatus, ShareViewLevel, type ShareViewLevelValue, type SharedUser, SharingAPI, SlideDeckFormat, type SlideDeckFormatValue, SlideDeckLength, type SlideDeckLengthValue, type Source, type SourceFulltext, type SourceGuide, type SourceStatus, type SourceSummary, type SourceType, SourcesAPI, type SuggestedTopic, VideoFormat, type VideoFormatValue, VideoStyle, type VideoStyleValue };