clipy-kit 0.1.0

package/dist/lib/ops.d.ts

@@ -0,0 +1,460 @@
+import { GoogleClient } from '../http.js';
+import { type FormatFlags } from './format.js';
+import type { Spreadsheet } from './types.js';
+export declare function createOps(client: GoogleClient): {
+    getSpreadsheet: (id: string, fields?: string) => Promise<Spreadsheet>;
+    findSpreadsheets: (name: string, limit?: number) => Promise<{
+        query: string;
+        files: {
+            id: string;
+            name: string;
+            url: string;
+        }[];
+    }>;
+    info: (id: string) => Promise<{
+        spreadsheetId: string;
+        title: string | undefined;
+        url: string | undefined;
+        tabs: {
+            sheetId: number | undefined;
+            title: string | undefined;
+            index: number | undefined;
+            rows: number | undefined;
+            columns: number | undefined;
+        }[];
+    }>;
+    listTabs: (id: string) => Promise<{
+        title: string | undefined;
+        tabs: {
+            sheetId: number | undefined;
+            title: string | undefined;
+            index: number | undefined;
+            rows: number | undefined;
+            columns: number | undefined;
+        }[];
+    }>;
+    readTable: (id: string, opts: ReadOpts) => Promise<{
+        range: string;
+        values: unknown[][];
+    } | {
+        headers: string[];
+        rows: Record<string, unknown>[];
+        headerRow: number;
+        range: string;
+        values?: undefined;
+    }>;
+    readRange: (id: string, range: string) => Promise<{
+        range: string;
+        values: unknown[][];
+    }>;
+    append: (id: string, opts: WriteTableOpts) => Promise<{
+        dryRun: boolean;
+        tab: string;
+        headers: string[];
+        rows: number;
+        bootstrap: boolean;
+        result?: undefined;
+    } | {
+        tab: string;
+        headers: string[];
+        rows: number;
+        bootstrap: boolean;
+        result: unknown;
+        dryRun?: undefined;
+    } | {
+        dryRun: boolean;
+        tab: string;
+        headers: string[];
+        rows: number;
+        bootstrap?: undefined;
+        result?: undefined;
+    } | {
+        tab: string;
+        headers: string[];
+        rows: number;
+        result: unknown;
+        dryRun?: undefined;
+        bootstrap?: undefined;
+    }>;
+    update: (id: string, opts: UpdateOpts) => Promise<{
+        dryRun: boolean;
+        matchedRows: unknown[];
+        set: Record<string, unknown>;
+        updated?: undefined;
+        result?: undefined;
+    } | {
+        matchedRows: unknown[];
+        updated: number;
+        result: unknown;
+        dryRun?: undefined;
+        set?: undefined;
+    }>;
+    upsert: (id: string, opts: UpsertOpts) => Promise<{
+        updated: number;
+        inserted: number;
+        updatedRows: unknown[];
+        appendResult: unknown;
+    }>;
+    setRange: (id: string, opts: SetOpts) => Promise<{
+        dryRun: boolean;
+        range: string;
+        values: unknown[][];
+        result?: undefined;
+    } | {
+        range: string;
+        result: unknown;
+        dryRun?: undefined;
+        values?: undefined;
+    }>;
+    clear: (id: string, range: string, dryRun?: boolean) => Promise<{
+        dryRun: boolean;
+        range: string;
+        result?: undefined;
+    } | {
+        range: string;
+        result: unknown;
+        dryRun?: undefined;
+    }>;
+    batch: (id: string, ops: BatchOp[], dryRun?: boolean) => Promise<{
+        count: number;
+        results: ({
+            op: "append";
+            result: {
+                dryRun: boolean;
+                tab: string;
+                headers: string[];
+                rows: number;
+                bootstrap: boolean;
+                result?: undefined;
+            } | {
+                tab: string;
+                headers: string[];
+                rows: number;
+                bootstrap: boolean;
+                result: unknown;
+                dryRun?: undefined;
+            } | {
+                dryRun: boolean;
+                tab: string;
+                headers: string[];
+                rows: number;
+                bootstrap?: undefined;
+                result?: undefined;
+            } | {
+                tab: string;
+                headers: string[];
+                rows: number;
+                result: unknown;
+                dryRun?: undefined;
+                bootstrap?: undefined;
+            };
+        } | {
+            op: "updateKey";
+            result: {
+                dryRun: boolean;
+                matchedRows: unknown[];
+                set: Record<string, unknown>;
+                updated?: undefined;
+                result?: undefined;
+            } | {
+                matchedRows: unknown[];
+                updated: number;
+                result: unknown;
+                dryRun?: undefined;
+                set?: undefined;
+            };
+        } | {
+            op: "updateRow";
+            result: {
+                dryRun: boolean;
+                row: number;
+                set: Record<string, unknown>;
+                result?: undefined;
+            } | {
+                row: number;
+                result: unknown;
+                dryRun?: undefined;
+                set?: undefined;
+            };
+        } | {
+            op: "setRange";
+            result: {
+                dryRun: boolean;
+                range: string;
+                values: unknown[][];
+                result?: undefined;
+            } | {
+                range: string;
+                result: unknown;
+                dryRun?: undefined;
+                values?: undefined;
+            };
+        } | {
+            op: "clear";
+            result: {
+                dryRun: boolean;
+                range: string;
+                result?: undefined;
+            } | {
+                range: string;
+                result: unknown;
+                dryRun?: undefined;
+            };
+        })[];
+    }>;
+    create: (opts: CreateOpts) => Promise<{
+        properties: {
+            title: string;
+        };
+        sheets: {
+            properties: {
+                title: string;
+                index: number;
+            };
+        }[];
+        dryRun: boolean;
+        spreadsheetId?: undefined;
+        url?: undefined;
+        title?: undefined;
+        tabs?: undefined;
+    } | {
+        spreadsheetId: string;
+        url: string;
+        title: string | undefined;
+        tabs: string[];
+    }>;
+    tabAdd: (id: string, opts: TabAddOpts) => Promise<{
+        title: string;
+        result: unknown;
+    }>;
+    tabRename: (id: string, opts: TabRenameOpts) => Promise<{
+        from: string;
+        title: string;
+        result: unknown;
+    }>;
+    tabDelete: (id: string, opts: {
+        tab: string;
+        dryRun?: boolean;
+    }) => Promise<{
+        tab: string;
+        sheetId: number;
+        result: unknown;
+    }>;
+    tabDuplicate: (id: string, opts: TabDupOpts) => Promise<{
+        tab: string;
+        title: string | undefined;
+        result: unknown;
+    }>;
+    format: (id: string, opts: FormatOpts) => Promise<{
+        dryRun: boolean;
+        range: string;
+        requests: Record<string, unknown>[];
+        result?: undefined;
+    } | {
+        range: string;
+        result: unknown;
+        dryRun?: undefined;
+        requests?: undefined;
+    }>;
+    formatHeader: (id: string, opts: HeaderFormatOpts) => Promise<{
+        tab: string;
+        freeze: boolean;
+        result: unknown;
+    }>;
+    freeze: (id: string, opts: FreezeOpts) => Promise<{
+        tab: string;
+        rows: number;
+        columns: number | undefined;
+        result: unknown;
+    }>;
+    numberFormat: (id: string, opts: NumberFormatOpts) => Promise<{
+        dryRun: boolean;
+        range: string;
+        requests: Record<string, unknown>[];
+        result?: undefined;
+    } | {
+        range: string;
+        result: unknown;
+        dryRun?: undefined;
+        requests?: undefined;
+    }>;
+    formula: (id: string, opts: FormulaOpts) => Promise<{
+        dryRun: boolean;
+        cell: string;
+        expr: string;
+        result?: undefined;
+    } | {
+        cell: string;
+        expr: string;
+        result: unknown;
+        dryRun?: undefined;
+    }>;
+    fillDown: (id: string, opts: FillDownOpts) => Promise<{
+        dryRun: boolean;
+        range: string;
+        expr: string;
+        rows: number;
+        result?: undefined;
+    } | {
+        range: string;
+        expr: string;
+        rows: number;
+        result: unknown;
+        dryRun?: undefined;
+    }>;
+    share: (id: string, opts: ShareOpts) => Promise<{
+        dryRun: boolean;
+        email: string;
+        role: string;
+        result?: undefined;
+    } | {
+        email: string;
+        role: string;
+        result: unknown;
+        dryRun?: undefined;
+    }>;
+    unshare: (id: string, email: string, dryRun?: boolean) => Promise<{
+        dryRun: boolean;
+        email: string;
+        permissionId: string;
+        removed?: undefined;
+    } | {
+        email: string;
+        removed: string;
+        dryRun?: undefined;
+        permissionId?: undefined;
+    }>;
+    permissions: (id: string) => Promise<{
+        permissions: {
+            id: string;
+            role: string | undefined;
+            type: string | undefined;
+            email: string | undefined;
+            name: string | undefined;
+        }[];
+    }>;
+    api: (method: string, id: string | undefined, json: unknown) => Promise<{
+        method: string;
+        result: unknown;
+    }>;
+};
+export type ReadOpts = {
+    tab?: string;
+    range?: string;
+    limit?: number;
+    headerRow?: number;
+    raw?: boolean;
+};
+export type WriteTableOpts = {
+    tab: string;
+    rows: Record<string, unknown>[];
+    dryRun?: boolean;
+    valueInput?: string;
+};
+export type UpdateOpts = {
+    tab: string;
+    keyCol: string;
+    key: string;
+    set: Record<string, unknown>;
+    allowMulti?: boolean;
+    dryRun?: boolean;
+    valueInput?: string;
+};
+export type UpsertOpts = {
+    tab: string;
+    keyCol: string;
+    rows: Record<string, unknown>[];
+    dryRun?: boolean;
+    valueInput?: string;
+};
+export type SetOpts = {
+    range: string;
+    values: unknown[][];
+    dryRun?: boolean;
+    valueInput?: string;
+};
+export type CreateOpts = {
+    title: string;
+    tabs?: string[];
+    dryRun?: boolean;
+};
+export type TabAddOpts = {
+    title: string;
+    index?: number;
+    dryRun?: boolean;
+};
+export type TabRenameOpts = {
+    tab: string;
+    title: string;
+    dryRun?: boolean;
+};
+export type TabDupOpts = {
+    tab: string;
+    title?: string;
+    dryRun?: boolean;
+};
+export type FormatOpts = FormatFlags & {
+    range: string;
+    tab?: string;
+    dryRun?: boolean;
+};
+export type HeaderFormatOpts = FormatFlags & {
+    tab: string;
+    freeze?: boolean;
+    dryRun?: boolean;
+};
+export type FreezeOpts = {
+    tab: string;
+    rows?: number;
+    columns?: number;
+    dryRun?: boolean;
+};
+export type NumberFormatOpts = {
+    range: string;
+    pattern: string;
+    tab?: string;
+    dryRun?: boolean;
+};
+export type FormulaOpts = {
+    cell: string;
+    expr: string;
+    dryRun?: boolean;
+};
+export type FillDownOpts = {
+    range: string;
+    expr: string;
+    dryRun?: boolean;
+};
+export type ShareOpts = {
+    email: string;
+    role: string;
+    dryRun?: boolean;
+};
+export type BatchOp = {
+    op: 'append';
+    sheet: string;
+    values: Record<string, unknown> | Record<string, unknown>[];
+} | {
+    op: 'updateKey';
+    sheet: string;
+    keyCol: string;
+    key: string;
+    set: Record<string, unknown>;
+    allowMulti?: boolean;
+} | {
+    op: 'updateRow';
+    sheet: string;
+    row: number;
+    set: Record<string, unknown>;
+} | {
+    op: 'setRange';
+    range: string;
+    values: unknown[][];
+} | {
+    op: 'clear';
+    range: string;
+};
+declare const VALUE_INPUT: {
+    valueInputOption: string;
+};
+export { VALUE_INPUT };