@channel.io/app-sdk-core 0.15.7 → 0.16.3

package/dist/extensions/notebook.d.ts

@@ -0,0 +1,742 @@
+import { z } from "zod";
+import type { AppNotebook as ProtoAppNotebook, NotebookCell as ProtoNotebookCell, NotebookGetNotebooksInput as ProtoGetNotebooksInput, NotebookGetNotebooksOutput as ProtoGetNotebooksResponse, NotebookLayoutColumn as ProtoNotebookLayoutColumn, NotebookLayoutRow as ProtoNotebookLayoutRow, NotebookPayload as ProtoNotebookPayload, NotebookTab as ProtoNotebookTab } from "../gen/channel/app/sdk/v1/extension.js";
+import type { Context } from "../types/context.js";
+import type { ExtensionDefinition } from "../types/extension.js";
+type ProtoBacked<T, Proto> = T & Proto;
+export declare const NotebookCellTypeSchema: z.ZodEnum<["markdown", "sql", "python", "input", "chart", "table", "single_value"]>;
+export type NotebookCellType = ProtoBacked<z.infer<typeof NotebookCellTypeSchema>, ProtoNotebookCell["type"]>;
+export declare const NotebookInitialVisibilitySchema: z.ZodEnum<["visible", "hidden"]>;
+export type NotebookInitialVisibility = ProtoBacked<z.infer<typeof NotebookInitialVisibilitySchema>, ProtoAppNotebook["initialVisibility"]>;
+export declare const NotebookCellSchema: z.ZodObject<{
+    cellKey: z.ZodString;
+    type: z.ZodEnum<["markdown", "sql", "python", "input", "chart", "table", "single_value"]>;
+    name: z.ZodOptional<z.ZodString>;
+    definition: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    presentation: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, "strip", z.ZodTypeAny, {
+    type: "table" | "markdown" | "sql" | "python" | "input" | "chart" | "single_value";
+    definition: Record<string, unknown>;
+    cellKey: string;
+    name?: string | undefined;
+    presentation?: Record<string, unknown> | undefined;
+}, {
+    type: "table" | "markdown" | "sql" | "python" | "input" | "chart" | "single_value";
+    definition: Record<string, unknown>;
+    cellKey: string;
+    name?: string | undefined;
+    presentation?: Record<string, unknown> | undefined;
+}>;
+export type NotebookCell = ProtoBacked<z.infer<typeof NotebookCellSchema>, ProtoNotebookCell>;
+export declare const NotebookLayoutColumnSchema: z.ZodObject<{
+    cellKey: z.ZodString;
+    colStart: z.ZodNumber;
+    colEnd: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    cellKey: string;
+    colStart: number;
+    colEnd: number;
+}, {
+    cellKey: string;
+    colStart: number;
+    colEnd: number;
+}>;
+export type NotebookLayoutColumn = ProtoBacked<z.infer<typeof NotebookLayoutColumnSchema>, ProtoNotebookLayoutColumn>;
+export declare const NotebookLayoutRowSchema: z.ZodObject<{
+    rowKey: z.ZodString;
+    position: z.ZodNumber;
+    columns: z.ZodArray<z.ZodObject<{
+        cellKey: z.ZodString;
+        colStart: z.ZodNumber;
+        colEnd: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        cellKey: string;
+        colStart: number;
+        colEnd: number;
+    }, {
+        cellKey: string;
+        colStart: number;
+        colEnd: number;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    columns: {
+        cellKey: string;
+        colStart: number;
+        colEnd: number;
+    }[];
+    rowKey: string;
+    position: number;
+}, {
+    columns: {
+        cellKey: string;
+        colStart: number;
+        colEnd: number;
+    }[];
+    rowKey: string;
+    position: number;
+}>;
+export type NotebookLayoutRow = ProtoBacked<z.infer<typeof NotebookLayoutRowSchema>, ProtoNotebookLayoutRow>;
+export declare const NotebookTabSchema: z.ZodObject<{
+    tabKey: z.ZodString;
+    label: z.ZodString;
+    position: z.ZodNumber;
+    layout: z.ZodArray<z.ZodObject<{
+        rowKey: z.ZodString;
+        position: z.ZodNumber;
+        columns: z.ZodArray<z.ZodObject<{
+            cellKey: z.ZodString;
+            colStart: z.ZodNumber;
+            colEnd: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            cellKey: string;
+            colStart: number;
+            colEnd: number;
+        }, {
+            cellKey: string;
+            colStart: number;
+            colEnd: number;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        columns: {
+            cellKey: string;
+            colStart: number;
+            colEnd: number;
+        }[];
+        rowKey: string;
+        position: number;
+    }, {
+        columns: {
+            cellKey: string;
+            colStart: number;
+            colEnd: number;
+        }[];
+        rowKey: string;
+        position: number;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    label: string;
+    layout: {
+        columns: {
+            cellKey: string;
+            colStart: number;
+            colEnd: number;
+        }[];
+        rowKey: string;
+        position: number;
+    }[];
+    position: number;
+    tabKey: string;
+}, {
+    label: string;
+    layout: {
+        columns: {
+            cellKey: string;
+            colStart: number;
+            colEnd: number;
+        }[];
+        rowKey: string;
+        position: number;
+    }[];
+    position: number;
+    tabKey: string;
+}>;
+export type NotebookTab = ProtoBacked<z.infer<typeof NotebookTabSchema>, ProtoNotebookTab>;
+export declare const NotebookPayloadSchema: z.ZodObject<{
+    cells: z.ZodArray<z.ZodObject<{
+        cellKey: z.ZodString;
+        type: z.ZodEnum<["markdown", "sql", "python", "input", "chart", "table", "single_value"]>;
+        name: z.ZodOptional<z.ZodString>;
+        definition: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        presentation: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, "strip", z.ZodTypeAny, {
+        type: "table" | "markdown" | "sql" | "python" | "input" | "chart" | "single_value";
+        definition: Record<string, unknown>;
+        cellKey: string;
+        name?: string | undefined;
+        presentation?: Record<string, unknown> | undefined;
+    }, {
+        type: "table" | "markdown" | "sql" | "python" | "input" | "chart" | "single_value";
+        definition: Record<string, unknown>;
+        cellKey: string;
+        name?: string | undefined;
+        presentation?: Record<string, unknown> | undefined;
+    }>, "many">;
+    tabs: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        tabKey: z.ZodString;
+        label: z.ZodString;
+        position: z.ZodNumber;
+        layout: z.ZodArray<z.ZodObject<{
+            rowKey: z.ZodString;
+            position: z.ZodNumber;
+            columns: z.ZodArray<z.ZodObject<{
+                cellKey: z.ZodString;
+                colStart: z.ZodNumber;
+                colEnd: z.ZodNumber;
+            }, "strip", z.ZodTypeAny, {
+                cellKey: string;
+                colStart: number;
+                colEnd: number;
+            }, {
+                cellKey: string;
+                colStart: number;
+                colEnd: number;
+            }>, "many">;
+        }, "strip", z.ZodTypeAny, {
+            columns: {
+                cellKey: string;
+                colStart: number;
+                colEnd: number;
+            }[];
+            rowKey: string;
+            position: number;
+        }, {
+            columns: {
+                cellKey: string;
+                colStart: number;
+                colEnd: number;
+            }[];
+            rowKey: string;
+            position: number;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        label: string;
+        layout: {
+            columns: {
+                cellKey: string;
+                colStart: number;
+                colEnd: number;
+            }[];
+            rowKey: string;
+            position: number;
+        }[];
+        position: number;
+        tabKey: string;
+    }, {
+        label: string;
+        layout: {
+            columns: {
+                cellKey: string;
+                colStart: number;
+                colEnd: number;
+            }[];
+            rowKey: string;
+            position: number;
+        }[];
+        position: number;
+        tabKey: string;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    cells: {
+        type: "table" | "markdown" | "sql" | "python" | "input" | "chart" | "single_value";
+        definition: Record<string, unknown>;
+        cellKey: string;
+        name?: string | undefined;
+        presentation?: Record<string, unknown> | undefined;
+    }[];
+    tabs?: {
+        label: string;
+        layout: {
+            columns: {
+                cellKey: string;
+                colStart: number;
+                colEnd: number;
+            }[];
+            rowKey: string;
+            position: number;
+        }[];
+        position: number;
+        tabKey: string;
+    }[] | undefined;
+}, {
+    cells: {
+        type: "table" | "markdown" | "sql" | "python" | "input" | "chart" | "single_value";
+        definition: Record<string, unknown>;
+        cellKey: string;
+        name?: string | undefined;
+        presentation?: Record<string, unknown> | undefined;
+    }[];
+    tabs?: {
+        label: string;
+        layout: {
+            columns: {
+                cellKey: string;
+                colStart: number;
+                colEnd: number;
+            }[];
+            rowKey: string;
+            position: number;
+        }[];
+        position: number;
+        tabKey: string;
+    }[] | undefined;
+}>;
+export type NotebookPayload = ProtoBacked<z.infer<typeof NotebookPayloadSchema>, ProtoNotebookPayload>;
+export declare const AppNotebookSchema: z.ZodObject<{
+    notebookKey: z.ZodString;
+    version: z.ZodNumber;
+    title: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    icon: z.ZodOptional<z.ZodString>;
+    initialVisibility: z.ZodOptional<z.ZodEnum<["visible", "hidden"]>>;
+    notebook: z.ZodObject<{
+        cells: z.ZodArray<z.ZodObject<{
+            cellKey: z.ZodString;
+            type: z.ZodEnum<["markdown", "sql", "python", "input", "chart", "table", "single_value"]>;
+            name: z.ZodOptional<z.ZodString>;
+            definition: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+            presentation: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        }, "strip", z.ZodTypeAny, {
+            type: "table" | "markdown" | "sql" | "python" | "input" | "chart" | "single_value";
+            definition: Record<string, unknown>;
+            cellKey: string;
+            name?: string | undefined;
+            presentation?: Record<string, unknown> | undefined;
+        }, {
+            type: "table" | "markdown" | "sql" | "python" | "input" | "chart" | "single_value";
+            definition: Record<string, unknown>;
+            cellKey: string;
+            name?: string | undefined;
+            presentation?: Record<string, unknown> | undefined;
+        }>, "many">;
+        tabs: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            tabKey: z.ZodString;
+            label: z.ZodString;
+            position: z.ZodNumber;
+            layout: z.ZodArray<z.ZodObject<{
+                rowKey: z.ZodString;
+                position: z.ZodNumber;
+                columns: z.ZodArray<z.ZodObject<{
+                    cellKey: z.ZodString;
+                    colStart: z.ZodNumber;
+                    colEnd: z.ZodNumber;
+                }, "strip", z.ZodTypeAny, {
+                    cellKey: string;
+                    colStart: number;
+                    colEnd: number;
+                }, {
+                    cellKey: string;
+                    colStart: number;
+                    colEnd: number;
+                }>, "many">;
+            }, "strip", z.ZodTypeAny, {
+                columns: {
+                    cellKey: string;
+                    colStart: number;
+                    colEnd: number;
+                }[];
+                rowKey: string;
+                position: number;
+            }, {
+                columns: {
+                    cellKey: string;
+                    colStart: number;
+                    colEnd: number;
+                }[];
+                rowKey: string;
+                position: number;
+            }>, "many">;
+        }, "strip", z.ZodTypeAny, {
+            label: string;
+            layout: {
+                columns: {
+                    cellKey: string;
+                    colStart: number;
+                    colEnd: number;
+                }[];
+                rowKey: string;
+                position: number;
+            }[];
+            position: number;
+            tabKey: string;
+        }, {
+            label: string;
+            layout: {
+                columns: {
+                    cellKey: string;
+                    colStart: number;
+                    colEnd: number;
+                }[];
+                rowKey: string;
+                position: number;
+            }[];
+            position: number;
+            tabKey: string;
+        }>, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        cells: {
+            type: "table" | "markdown" | "sql" | "python" | "input" | "chart" | "single_value";
+            definition: Record<string, unknown>;
+            cellKey: string;
+            name?: string | undefined;
+            presentation?: Record<string, unknown> | undefined;
+        }[];
+        tabs?: {
+            label: string;
+            layout: {
+                columns: {
+                    cellKey: string;
+                    colStart: number;
+                    colEnd: number;
+                }[];
+                rowKey: string;
+                position: number;
+            }[];
+            position: number;
+            tabKey: string;
+        }[] | undefined;
+    }, {
+        cells: {
+            type: "table" | "markdown" | "sql" | "python" | "input" | "chart" | "single_value";
+            definition: Record<string, unknown>;
+            cellKey: string;
+            name?: string | undefined;
+            presentation?: Record<string, unknown> | undefined;
+        }[];
+        tabs?: {
+            label: string;
+            layout: {
+                columns: {
+                    cellKey: string;
+                    colStart: number;
+                    colEnd: number;
+                }[];
+                rowKey: string;
+                position: number;
+            }[];
+            position: number;
+            tabKey: string;
+        }[] | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    notebook: {
+        cells: {
+            type: "table" | "markdown" | "sql" | "python" | "input" | "chart" | "single_value";
+            definition: Record<string, unknown>;
+            cellKey: string;
+            name?: string | undefined;
+            presentation?: Record<string, unknown> | undefined;
+        }[];
+        tabs?: {
+            label: string;
+            layout: {
+                columns: {
+                    cellKey: string;
+                    colStart: number;
+                    colEnd: number;
+                }[];
+                rowKey: string;
+                position: number;
+            }[];
+            position: number;
+            tabKey: string;
+        }[] | undefined;
+    };
+    title: string;
+    notebookKey: string;
+    version: number;
+    description?: string | undefined;
+    initialVisibility?: "visible" | "hidden" | undefined;
+    icon?: string | undefined;
+}, {
+    notebook: {
+        cells: {
+            type: "table" | "markdown" | "sql" | "python" | "input" | "chart" | "single_value";
+            definition: Record<string, unknown>;
+            cellKey: string;
+            name?: string | undefined;
+            presentation?: Record<string, unknown> | undefined;
+        }[];
+        tabs?: {
+            label: string;
+            layout: {
+                columns: {
+                    cellKey: string;
+                    colStart: number;
+                    colEnd: number;
+                }[];
+                rowKey: string;
+                position: number;
+            }[];
+            position: number;
+            tabKey: string;
+        }[] | undefined;
+    };
+    title: string;
+    notebookKey: string;
+    version: number;
+    description?: string | undefined;
+    initialVisibility?: "visible" | "hidden" | undefined;
+    icon?: string | undefined;
+}>;
+export type AppNotebook = ProtoBacked<z.infer<typeof AppNotebookSchema>, ProtoAppNotebook>;
+export declare const GetNotebooksInputSchema: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+export type GetNotebooksInput = ProtoBacked<z.infer<typeof GetNotebooksInputSchema>, ProtoGetNotebooksInput>;
+export declare const GetNotebooksResponseSchema: z.ZodObject<{
+    notebooks: z.ZodArray<z.ZodObject<{
+        notebookKey: z.ZodString;
+        version: z.ZodNumber;
+        title: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        icon: z.ZodOptional<z.ZodString>;
+        initialVisibility: z.ZodOptional<z.ZodEnum<["visible", "hidden"]>>;
+        notebook: z.ZodObject<{
+            cells: z.ZodArray<z.ZodObject<{
+                cellKey: z.ZodString;
+                type: z.ZodEnum<["markdown", "sql", "python", "input", "chart", "table", "single_value"]>;
+                name: z.ZodOptional<z.ZodString>;
+                definition: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+                presentation: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+            }, "strip", z.ZodTypeAny, {
+                type: "table" | "markdown" | "sql" | "python" | "input" | "chart" | "single_value";
+                definition: Record<string, unknown>;
+                cellKey: string;
+                name?: string | undefined;
+                presentation?: Record<string, unknown> | undefined;
+            }, {
+                type: "table" | "markdown" | "sql" | "python" | "input" | "chart" | "single_value";
+                definition: Record<string, unknown>;
+                cellKey: string;
+                name?: string | undefined;
+                presentation?: Record<string, unknown> | undefined;
+            }>, "many">;
+            tabs: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                tabKey: z.ZodString;
+                label: z.ZodString;
+                position: z.ZodNumber;
+                layout: z.ZodArray<z.ZodObject<{
+                    rowKey: z.ZodString;
+                    position: z.ZodNumber;
+                    columns: z.ZodArray<z.ZodObject<{
+                        cellKey: z.ZodString;
+                        colStart: z.ZodNumber;
+                        colEnd: z.ZodNumber;
+                    }, "strip", z.ZodTypeAny, {
+                        cellKey: string;
+                        colStart: number;
+                        colEnd: number;
+                    }, {
+                        cellKey: string;
+                        colStart: number;
+                        colEnd: number;
+                    }>, "many">;
+                }, "strip", z.ZodTypeAny, {
+                    columns: {
+                        cellKey: string;
+                        colStart: number;
+                        colEnd: number;
+                    }[];
+                    rowKey: string;
+                    position: number;
+                }, {
+                    columns: {
+                        cellKey: string;
+                        colStart: number;
+                        colEnd: number;
+                    }[];
+                    rowKey: string;
+                    position: number;
+                }>, "many">;
+            }, "strip", z.ZodTypeAny, {
+                label: string;
+                layout: {
+                    columns: {
+                        cellKey: string;
+                        colStart: number;
+                        colEnd: number;
+                    }[];
+                    rowKey: string;
+                    position: number;
+                }[];
+                position: number;
+                tabKey: string;
+            }, {
+                label: string;
+                layout: {
+                    columns: {
+                        cellKey: string;
+                        colStart: number;
+                        colEnd: number;
+                    }[];
+                    rowKey: string;
+                    position: number;
+                }[];
+                position: number;
+                tabKey: string;
+            }>, "many">>;
+        }, "strip", z.ZodTypeAny, {
+            cells: {
+                type: "table" | "markdown" | "sql" | "python" | "input" | "chart" | "single_value";
+                definition: Record<string, unknown>;
+                cellKey: string;
+                name?: string | undefined;
+                presentation?: Record<string, unknown> | undefined;
+            }[];
+            tabs?: {
+                label: string;
+                layout: {
+                    columns: {
+                        cellKey: string;
+                        colStart: number;
+                        colEnd: number;
+                    }[];
+                    rowKey: string;
+                    position: number;
+                }[];
+                position: number;
+                tabKey: string;
+            }[] | undefined;
+        }, {
+            cells: {
+                type: "table" | "markdown" | "sql" | "python" | "input" | "chart" | "single_value";
+                definition: Record<string, unknown>;
+                cellKey: string;
+                name?: string | undefined;
+                presentation?: Record<string, unknown> | undefined;
+            }[];
+            tabs?: {
+                label: string;
+                layout: {
+                    columns: {
+                        cellKey: string;
+                        colStart: number;
+                        colEnd: number;
+                    }[];
+                    rowKey: string;
+                    position: number;
+                }[];
+                position: number;
+                tabKey: string;
+            }[] | undefined;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        notebook: {
+            cells: {
+                type: "table" | "markdown" | "sql" | "python" | "input" | "chart" | "single_value";
+                definition: Record<string, unknown>;
+                cellKey: string;
+                name?: string | undefined;
+                presentation?: Record<string, unknown> | undefined;
+            }[];
+            tabs?: {
+                label: string;
+                layout: {
+                    columns: {
+                        cellKey: string;
+                        colStart: number;
+                        colEnd: number;
+                    }[];
+                    rowKey: string;
+                    position: number;
+                }[];
+                position: number;
+                tabKey: string;
+            }[] | undefined;
+        };
+        title: string;
+        notebookKey: string;
+        version: number;
+        description?: string | undefined;
+        initialVisibility?: "visible" | "hidden" | undefined;
+        icon?: string | undefined;
+    }, {
+        notebook: {
+            cells: {
+                type: "table" | "markdown" | "sql" | "python" | "input" | "chart" | "single_value";
+                definition: Record<string, unknown>;
+                cellKey: string;
+                name?: string | undefined;
+                presentation?: Record<string, unknown> | undefined;
+            }[];
+            tabs?: {
+                label: string;
+                layout: {
+                    columns: {
+                        cellKey: string;
+                        colStart: number;
+                        colEnd: number;
+                    }[];
+                    rowKey: string;
+                    position: number;
+                }[];
+                position: number;
+                tabKey: string;
+            }[] | undefined;
+        };
+        title: string;
+        notebookKey: string;
+        version: number;
+        description?: string | undefined;
+        initialVisibility?: "visible" | "hidden" | undefined;
+        icon?: string | undefined;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    notebooks: {
+        notebook: {
+            cells: {
+                type: "table" | "markdown" | "sql" | "python" | "input" | "chart" | "single_value";
+                definition: Record<string, unknown>;
+                cellKey: string;
+                name?: string | undefined;
+                presentation?: Record<string, unknown> | undefined;
+            }[];
+            tabs?: {
+                label: string;
+                layout: {
+                    columns: {
+                        cellKey: string;
+                        colStart: number;
+                        colEnd: number;
+                    }[];
+                    rowKey: string;
+                    position: number;
+                }[];
+                position: number;
+                tabKey: string;
+            }[] | undefined;
+        };
+        title: string;
+        notebookKey: string;
+        version: number;
+        description?: string | undefined;
+        initialVisibility?: "visible" | "hidden" | undefined;
+        icon?: string | undefined;
+    }[];
+}, {
+    notebooks: {
+        notebook: {
+            cells: {
+                type: "table" | "markdown" | "sql" | "python" | "input" | "chart" | "single_value";
+                definition: Record<string, unknown>;
+                cellKey: string;
+                name?: string | undefined;
+                presentation?: Record<string, unknown> | undefined;
+            }[];
+            tabs?: {
+                label: string;
+                layout: {
+                    columns: {
+                        cellKey: string;
+                        colStart: number;
+                        colEnd: number;
+                    }[];
+                    rowKey: string;
+                    position: number;
+                }[];
+                position: number;
+                tabKey: string;
+            }[] | undefined;
+        };
+        title: string;
+        notebookKey: string;
+        version: number;
+        description?: string | undefined;
+        initialVisibility?: "visible" | "hidden" | undefined;
+        icon?: string | undefined;
+    }[];
+}>;
+export type GetNotebooksResponse = ProtoBacked<z.infer<typeof GetNotebooksResponseSchema>, ProtoGetNotebooksResponse>;
+export interface NotebookExtensionProvider {
+    getNotebooks(ctx: Context, input: GetNotebooksInput): GetNotebooksResponse | Promise<GetNotebooksResponse>;
+}
+export declare function createNotebookExtensionV1(provider: NotebookExtensionProvider): ExtensionDefinition;
+export {};
+//# sourceMappingURL=notebook.d.ts.map