gsheet-lvt 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,276 @@
+import { z } from 'zod';
+
+declare const oauthCredentialsSchema: z.ZodObject<{
+    client_id: z.ZodString;
+    client_secret: z.ZodString;
+    refresh_token: z.ZodString;
+    access_token: z.ZodOptional<z.ZodString>;
+    expiry_date: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+declare const spreadsheetConfigSchema: z.ZodObject<{
+    spreadsheet_id: z.ZodString;
+    activeSheet: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+declare const accountSchema: z.ZodObject<{
+    email: z.ZodString;
+    oauth: z.ZodObject<{
+        client_id: z.ZodString;
+        client_secret: z.ZodString;
+        refresh_token: z.ZodString;
+        access_token: z.ZodOptional<z.ZodString>;
+        expiry_date: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>;
+    activeSpreadsheet: z.ZodOptional<z.ZodString>;
+    spreadsheets: z.ZodRecord<z.ZodString, z.ZodObject<{
+        spreadsheet_id: z.ZodString;
+        activeSheet: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+declare const userMetadataSchema: z.ZodObject<{
+    config_path: z.ZodString;
+    activeAccount: z.ZodOptional<z.ZodString>;
+    accounts: z.ZodRecord<z.ZodString, z.ZodObject<{
+        email: z.ZodString;
+        oauth: z.ZodObject<{
+            client_id: z.ZodString;
+            client_secret: z.ZodString;
+            refresh_token: z.ZodString;
+            access_token: z.ZodOptional<z.ZodString>;
+            expiry_date: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>;
+        activeSpreadsheet: z.ZodOptional<z.ZodString>;
+        spreadsheets: z.ZodRecord<z.ZodString, z.ZodObject<{
+            spreadsheet_id: z.ZodString;
+            activeSheet: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+declare const sheetsConfigSchema: z.ZodObject<{
+    $schema: z.ZodOptional<z.ZodString>;
+    settings: z.ZodOptional<z.ZodObject<{
+        max_results: z.ZodDefault<z.ZodNumber>;
+        default_columns: z.ZodDefault<z.ZodString>;
+        completion_installed: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+declare const sheetDataSchema: z.ZodObject<{
+    title: z.ZodString;
+    index: z.ZodNumber;
+}, z.core.$strip>;
+type OAuthCredentials = z.infer<typeof oauthCredentialsSchema>;
+type SpreadsheetConfig = z.infer<typeof spreadsheetConfigSchema>;
+type Account = z.infer<typeof accountSchema>;
+type UserMetadata = z.infer<typeof userMetadataSchema>;
+type SheetsConfig = z.infer<typeof sheetsConfigSchema>;
+type SheetData = z.infer<typeof sheetDataSchema>;
+
+interface OAuthFlowResult {
+    email: string;
+    credentials: OAuthCredentials;
+}
+interface OAuthFlowOptions {
+    loginHint?: string;
+    onAuthUrl?: (url: string) => void;
+}
+declare function performOAuthFlow(clientId: string, clientSecret: string, options?: OAuthFlowOptions): Promise<OAuthFlowResult>;
+
+declare function assertRequiredOAuthScopes(grantedScopes: string[]): void;
+
+declare function refreshTokenIfNeeded(credentials: OAuthCredentials): Promise<OAuthCredentials>;
+declare function refreshToken(credentials: OAuthCredentials): Promise<OAuthCredentials>;
+
+declare class ConfigManager {
+    private userMetadata;
+    private config;
+    constructor();
+    private ensureConfigDirectory;
+    private initializeUserMetadata;
+    private createDefaultUserMetadata;
+    private loadUserMetadata;
+    private saveUserMetadata;
+    private getConfigPath;
+    private loadConfig;
+    private createDefaultConfig;
+    private saveConfig;
+    addAccount(email: string, credentials: OAuthCredentials): Promise<void>;
+    removeAccount(email: string): Promise<void>;
+    getAllAccounts(): Account[];
+    getAccount(email: string): Account | null;
+    setActiveAccount(email: string): void;
+    getActiveAccount(): Account | null;
+    getActiveAccountEmail(): string | null;
+    updateAccountCredentials(email: string, credentials: OAuthCredentials): Promise<void>;
+    getRefreshedCredentials(email: string): Promise<OAuthCredentials>;
+    addSpreadsheet(email: string, name: string, spreadsheetId: string): Promise<void>;
+    removeSpreadsheet(email: string, name: string): Promise<void>;
+    listSpreadsheets(email: string): Array<{
+        name: string;
+        spreadsheetId: string;
+        activeSheet?: string;
+    }>;
+    getSpreadsheet(email: string, name: string): SpreadsheetConfig | null;
+    getSpreadsheetById(email: string, id: string): SpreadsheetConfig | null;
+    setActiveSpreadsheet(email: string, name: string): void;
+    getActiveSpreadsheet(email: string): SpreadsheetConfig | null;
+    getActiveSpreadsheetName(email: string): string | null;
+    setActiveSheet(email: string, spreadsheetName: string, sheetName: string): void;
+    getActiveSheetName(email: string, spreadsheetName: string): string | null;
+    markCompletionInstalled(): void;
+    isCompletionInstalled(): boolean;
+}
+
+interface DriveSpreadsheet {
+    id: string;
+    name: string;
+    modifiedTime: string;
+    webViewLink: string;
+}
+declare class GoogleDriveService {
+    private credentials;
+    constructor(oauthCredentials: OAuthCredentials);
+    listSpreadsheets(): Promise<DriveSpreadsheet[]>;
+}
+
+interface GoogleSheetsConfig {
+    spreadsheetId: string;
+    oauthCredentials: OAuthCredentials;
+}
+declare class GoogleSheetsService {
+    private config;
+    private doc;
+    private auth;
+    constructor(config: GoogleSheetsConfig);
+    private ensureConnection;
+    getSheetInfo(): Promise<{
+        title: string;
+        sheets: Array<{
+            title: string;
+            index: number;
+            sheetId: number;
+        }>;
+    }>;
+    getSheetData(sheetName: string, includeFormulas?: boolean): Promise<string[][]>;
+    addSheet(sheetName: string): Promise<void>;
+    removeSheet(sheetName: string): Promise<void>;
+    renameSheet(oldName: string, newName: string): Promise<void>;
+    copySheet(sheetName: string, newSheetName: string): Promise<void>;
+    writeCell(sheetName: string, cell: string, value: string): Promise<void>;
+    writeCellRange(sheetName: string, range: string, values: (string | number)[][], noPreserve?: boolean): Promise<void>;
+    appendRow(sheetName: string, values: string[]): Promise<void>;
+    getSheetDataRange(sheetName: string, range: string, includeFormulas?: boolean): Promise<string[][]>;
+    insertRows(sheetName: string, range: {
+        startIndex: number;
+        endIndex: number;
+    }, inheritFromBefore?: boolean): Promise<void>;
+    deleteRows(sheetName: string, range: {
+        startIndex: number;
+        endIndex: number;
+    }): Promise<void>;
+    getRowFormulas(sheetName: string, rowIndex: number): Promise<Map<number, string>>;
+    copyRowFormulas(sheetName: string, sourceRowIndex: number, targetRowIndex: number): Promise<void>;
+    copyRowFormulasBulk(sheetName: string, sourceRowIndex: number, startTargetRowIndex: number, count: number): Promise<void>;
+    private adjustFormulaReferences;
+}
+
+interface SheetCmdClientOptions {
+    configManager?: ConfigManager;
+}
+interface LoginOptions {
+    clientId: string;
+    clientSecret: string;
+    loginHint?: string;
+    onAuthUrl?: (url: string) => void;
+    setActive?: boolean;
+}
+interface ReauthOptions {
+    email?: string;
+    loginHint?: string;
+    onAuthUrl?: (url: string) => void;
+}
+interface SheetServiceOptions {
+    accountEmail?: string;
+    spreadsheetName?: string;
+}
+interface DriveServiceOptions {
+    accountEmail?: string;
+}
+declare function createSheetsService(config: GoogleSheetsConfig): GoogleSheetsService;
+declare function createDriveService(oauthCredentials: OAuthCredentials): GoogleDriveService;
+declare class SheetCmdClient {
+    private configManager;
+    constructor(options?: SheetCmdClientOptions);
+    login(options: LoginOptions): Promise<Account>;
+    reauth(options?: ReauthOptions): Promise<Account>;
+    listAccounts(): Account[];
+    getAccount(email: string): Account | null;
+    getActiveAccount(): Account | null;
+    selectAccount(email: string): void;
+    removeAccount(email: string): Promise<void>;
+    addSpreadsheet(email: string, name: string, spreadsheetId: string): Promise<void>;
+    removeSpreadsheet(email: string, name: string): Promise<void>;
+    listSpreadsheets(email?: string): Array<{
+        name: string;
+        spreadsheetId: string;
+        activeSheet?: string;
+    }>;
+    getSpreadsheet(email: string, name: string): SpreadsheetConfig | null;
+    selectSpreadsheet(email: string, name: string): void;
+    getActiveSpreadsheet(email?: string): SpreadsheetConfig | null;
+    getActiveSpreadsheetName(email?: string): string | null;
+    selectSheet(email: string, spreadsheetName: string, sheetName: string): void;
+    getActiveSheetName(email?: string, spreadsheetName?: string): string | null;
+    getSheetsService(options?: SheetServiceOptions): Promise<GoogleSheetsService>;
+    getDriveService(options?: DriveServiceOptions): Promise<GoogleDriveService>;
+    refreshAccountCredentials(email: string): Promise<OAuthCredentials>;
+    private requireActiveAccount;
+    private requireAccount;
+    private requireActiveSpreadsheetName;
+    private requireSpreadsheet;
+}
+
+declare const APP_INFO: {
+    name: string;
+    packageName: any;
+    display_name: string;
+    version: any;
+};
+declare enum SupportedOS {
+    Linux = "linux",
+    Mac = "mac",
+    Windows = "windows",
+    Wsl = "wsl"
+}
+declare function getUserOS(): SupportedOS;
+declare function getConfigDirectory(): string;
+declare const CONFIG_PATHS: {
+    configDir: string;
+    userMetadataFile: string;
+    defaultConfigFile: string;
+};
+declare const OAUTH_SCOPES: {
+    SPREADSHEETS: string;
+    DRIVE_READONLY: string;
+    USERINFO_EMAIL: string;
+};
+declare const GOOGLE_API_URLS: {
+    USERINFO: string;
+    SHEETS_CREATE: string;
+};
+declare const OAUTH_CONFIG: {
+    REDIRECT_HOST: string;
+    REDIRECT_PATH: string;
+    ACCESS_TYPE: "offline";
+    PROMPT: "consent";
+};
+declare const TOKEN_REFRESH_THRESHOLD_MS: number;
+
+declare function parseCSV(content: string): string[][];
+
+declare function formatAsMarkdown(data: string[][]): string;
+declare function formatAsCSV(data: string[][]): string;
+declare function formatAsJSON(data: string[][]): string;
+
+declare function readJson<T = Record<string, unknown>>(filePath: string): T;
+declare function writeJson<T>(filePath: string, data: T, pretty?: boolean): void;
+
+export { APP_INFO, type Account, CONFIG_PATHS, ConfigManager, type DriveServiceOptions, type DriveSpreadsheet, GOOGLE_API_URLS, GoogleDriveService, type GoogleSheetsConfig, GoogleSheetsService, type LoginOptions, OAUTH_CONFIG, OAUTH_SCOPES, type OAuthCredentials, type OAuthFlowOptions, type OAuthFlowResult, type ReauthOptions, SheetCmdClient, type SheetCmdClientOptions, type SheetData, type SheetServiceOptions, type SheetsConfig, type SpreadsheetConfig, TOKEN_REFRESH_THRESHOLD_MS, type UserMetadata, accountSchema, assertRequiredOAuthScopes, createDriveService, createSheetsService, formatAsCSV, formatAsJSON, formatAsMarkdown, getConfigDirectory, getUserOS, oauthCredentialsSchema, parseCSV, performOAuthFlow, readJson, refreshToken, refreshTokenIfNeeded, sheetDataSchema, sheetsConfigSchema, spreadsheetConfigSchema, userMetadataSchema, writeJson };