@deepnote/blocks 1.3.0

package/dist/index.d.ts

@@ -0,0 +1,381 @@
+import { z } from "zod";
+
+//#region src/blocks/table-state.d.ts
+interface TableState {
+  cellFormattingRules?: {
+    column: string;
+    rule: string;
+  }[];
+  columnDisplayNames?: {
+    columnName: string;
+    displayName: string;
+  }[];
+  columnOrder?: string[];
+  conditionalFilters?: unknown[];
+  filters?: {
+    id: string;
+    value: string;
+  }[];
+  hiddenColumnIds?: string[];
+  pageIndex?: number;
+  pageSize?: number;
+  sortBy?: {
+    id: string;
+    desc: boolean;
+  }[];
+  wrappedTextColumnIds?: string[];
+}
+//#endregion
+//#region src/deserialize-file/deepnote-file-schema.d.ts
+declare const deepnoteBlockSchema: z.ZodObject<{
+  blockGroup: z.ZodOptional<z.ZodString>;
+  content: z.ZodOptional<z.ZodString>;
+  executionCount: z.ZodOptional<z.ZodNumber>;
+  id: z.ZodString;
+  metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+  outputs: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
+  sortingKey: z.ZodString;
+  type: z.ZodString;
+  version: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+  id: string;
+  type: string;
+  sortingKey: string;
+  blockGroup?: string | undefined;
+  content?: string | undefined;
+  executionCount?: number | undefined;
+  metadata?: Record<string, any> | undefined;
+  outputs?: any[] | undefined;
+  version?: number | undefined;
+}, {
+  id: string;
+  type: string;
+  sortingKey: string;
+  blockGroup?: string | undefined;
+  content?: string | undefined;
+  executionCount?: number | undefined;
+  metadata?: Record<string, any> | undefined;
+  outputs?: any[] | undefined;
+  version?: number | undefined;
+}>;
+type DeepnoteBlock = z.infer<typeof deepnoteBlockSchema>;
+declare const deepnoteFileSchema: z.ZodObject<{
+  metadata: z.ZodObject<{
+    checksum: z.ZodOptional<z.ZodString>;
+    createdAt: z.ZodString;
+    exportedAt: z.ZodOptional<z.ZodString>;
+    modifiedAt: z.ZodOptional<z.ZodString>;
+  }, "strip", z.ZodTypeAny, {
+    createdAt: string;
+    checksum?: string | undefined;
+    exportedAt?: string | undefined;
+    modifiedAt?: string | undefined;
+  }, {
+    createdAt: string;
+    checksum?: string | undefined;
+    exportedAt?: string | undefined;
+    modifiedAt?: string | undefined;
+  }>;
+  project: z.ZodObject<{
+    id: z.ZodString;
+    initNotebookId: z.ZodOptional<z.ZodString>;
+    integrations: z.ZodOptional<z.ZodArray<z.ZodObject<{
+      id: z.ZodString;
+      name: z.ZodString;
+      type: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+      id: string;
+      type: string;
+      name: string;
+    }, {
+      id: string;
+      type: string;
+      name: string;
+    }>, "many">>;
+    name: z.ZodString;
+    notebooks: z.ZodArray<z.ZodObject<{
+      blocks: z.ZodArray<z.ZodObject<{
+        blockGroup: z.ZodOptional<z.ZodString>;
+        content: z.ZodOptional<z.ZodString>;
+        executionCount: z.ZodOptional<z.ZodNumber>;
+        id: z.ZodString;
+        metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+        outputs: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
+        sortingKey: z.ZodString;
+        type: z.ZodString;
+        version: z.ZodOptional<z.ZodNumber>;
+      }, "strip", z.ZodTypeAny, {
+        id: string;
+        type: string;
+        sortingKey: string;
+        blockGroup?: string | undefined;
+        content?: string | undefined;
+        executionCount?: number | undefined;
+        metadata?: Record<string, any> | undefined;
+        outputs?: any[] | undefined;
+        version?: number | undefined;
+      }, {
+        id: string;
+        type: string;
+        sortingKey: string;
+        blockGroup?: string | undefined;
+        content?: string | undefined;
+        executionCount?: number | undefined;
+        metadata?: Record<string, any> | undefined;
+        outputs?: any[] | undefined;
+        version?: number | undefined;
+      }>, "many">;
+      executionMode: z.ZodOptional<z.ZodEnum<["block", "downstream"]>>;
+      id: z.ZodString;
+      isModule: z.ZodOptional<z.ZodBoolean>;
+      name: z.ZodString;
+      workingDirectory: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+      id: string;
+      name: string;
+      blocks: {
+        id: string;
+        type: string;
+        sortingKey: string;
+        blockGroup?: string | undefined;
+        content?: string | undefined;
+        executionCount?: number | undefined;
+        metadata?: Record<string, any> | undefined;
+        outputs?: any[] | undefined;
+        version?: number | undefined;
+      }[];
+      executionMode?: "block" | "downstream" | undefined;
+      isModule?: boolean | undefined;
+      workingDirectory?: string | undefined;
+    }, {
+      id: string;
+      name: string;
+      blocks: {
+        id: string;
+        type: string;
+        sortingKey: string;
+        blockGroup?: string | undefined;
+        content?: string | undefined;
+        executionCount?: number | undefined;
+        metadata?: Record<string, any> | undefined;
+        outputs?: any[] | undefined;
+        version?: number | undefined;
+      }[];
+      executionMode?: "block" | "downstream" | undefined;
+      isModule?: boolean | undefined;
+      workingDirectory?: string | undefined;
+    }>, "many">;
+    settings: z.ZodOptional<z.ZodObject<{
+      environment: z.ZodOptional<z.ZodObject<{
+        customImage: z.ZodOptional<z.ZodString>;
+        pythonVersion: z.ZodOptional<z.ZodString>;
+      }, "strip", z.ZodTypeAny, {
+        customImage?: string | undefined;
+        pythonVersion?: string | undefined;
+      }, {
+        customImage?: string | undefined;
+        pythonVersion?: string | undefined;
+      }>>;
+      requirements: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+      sqlCacheMaxAge: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+      environment?: {
+        customImage?: string | undefined;
+        pythonVersion?: string | undefined;
+      } | undefined;
+      requirements?: string[] | undefined;
+      sqlCacheMaxAge?: number | undefined;
+    }, {
+      environment?: {
+        customImage?: string | undefined;
+        pythonVersion?: string | undefined;
+      } | undefined;
+      requirements?: string[] | undefined;
+      sqlCacheMaxAge?: number | undefined;
+    }>>;
+  }, "strip", z.ZodTypeAny, {
+    id: string;
+    name: string;
+    notebooks: {
+      id: string;
+      name: string;
+      blocks: {
+        id: string;
+        type: string;
+        sortingKey: string;
+        blockGroup?: string | undefined;
+        content?: string | undefined;
+        executionCount?: number | undefined;
+        metadata?: Record<string, any> | undefined;
+        outputs?: any[] | undefined;
+        version?: number | undefined;
+      }[];
+      executionMode?: "block" | "downstream" | undefined;
+      isModule?: boolean | undefined;
+      workingDirectory?: string | undefined;
+    }[];
+    initNotebookId?: string | undefined;
+    integrations?: {
+      id: string;
+      type: string;
+      name: string;
+    }[] | undefined;
+    settings?: {
+      environment?: {
+        customImage?: string | undefined;
+        pythonVersion?: string | undefined;
+      } | undefined;
+      requirements?: string[] | undefined;
+      sqlCacheMaxAge?: number | undefined;
+    } | undefined;
+  }, {
+    id: string;
+    name: string;
+    notebooks: {
+      id: string;
+      name: string;
+      blocks: {
+        id: string;
+        type: string;
+        sortingKey: string;
+        blockGroup?: string | undefined;
+        content?: string | undefined;
+        executionCount?: number | undefined;
+        metadata?: Record<string, any> | undefined;
+        outputs?: any[] | undefined;
+        version?: number | undefined;
+      }[];
+      executionMode?: "block" | "downstream" | undefined;
+      isModule?: boolean | undefined;
+      workingDirectory?: string | undefined;
+    }[];
+    initNotebookId?: string | undefined;
+    integrations?: {
+      id: string;
+      type: string;
+      name: string;
+    }[] | undefined;
+    settings?: {
+      environment?: {
+        customImage?: string | undefined;
+        pythonVersion?: string | undefined;
+      } | undefined;
+      requirements?: string[] | undefined;
+      sqlCacheMaxAge?: number | undefined;
+    } | undefined;
+  }>;
+  version: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+  metadata: {
+    createdAt: string;
+    checksum?: string | undefined;
+    exportedAt?: string | undefined;
+    modifiedAt?: string | undefined;
+  };
+  version: string;
+  project: {
+    id: string;
+    name: string;
+    notebooks: {
+      id: string;
+      name: string;
+      blocks: {
+        id: string;
+        type: string;
+        sortingKey: string;
+        blockGroup?: string | undefined;
+        content?: string | undefined;
+        executionCount?: number | undefined;
+        metadata?: Record<string, any> | undefined;
+        outputs?: any[] | undefined;
+        version?: number | undefined;
+      }[];
+      executionMode?: "block" | "downstream" | undefined;
+      isModule?: boolean | undefined;
+      workingDirectory?: string | undefined;
+    }[];
+    initNotebookId?: string | undefined;
+    integrations?: {
+      id: string;
+      type: string;
+      name: string;
+    }[] | undefined;
+    settings?: {
+      environment?: {
+        customImage?: string | undefined;
+        pythonVersion?: string | undefined;
+      } | undefined;
+      requirements?: string[] | undefined;
+      sqlCacheMaxAge?: number | undefined;
+    } | undefined;
+  };
+}, {
+  metadata: {
+    createdAt: string;
+    checksum?: string | undefined;
+    exportedAt?: string | undefined;
+    modifiedAt?: string | undefined;
+  };
+  version: string;
+  project: {
+    id: string;
+    name: string;
+    notebooks: {
+      id: string;
+      name: string;
+      blocks: {
+        id: string;
+        type: string;
+        sortingKey: string;
+        blockGroup?: string | undefined;
+        content?: string | undefined;
+        executionCount?: number | undefined;
+        metadata?: Record<string, any> | undefined;
+        outputs?: any[] | undefined;
+        version?: number | undefined;
+      }[];
+      executionMode?: "block" | "downstream" | undefined;
+      isModule?: boolean | undefined;
+      workingDirectory?: string | undefined;
+    }[];
+    initNotebookId?: string | undefined;
+    integrations?: {
+      id: string;
+      type: string;
+      name: string;
+    }[] | undefined;
+    settings?: {
+      environment?: {
+        customImage?: string | undefined;
+        pythonVersion?: string | undefined;
+      } | undefined;
+      requirements?: string[] | undefined;
+      sqlCacheMaxAge?: number | undefined;
+    } | undefined;
+  };
+}>;
+type DeepnoteFile = z.infer<typeof deepnoteFileSchema>;
+//#endregion
+//#region src/deserialize-file/deserialize-deepnote-file.d.ts
+/**
+ * Deserialize a YAML string into a DeepnoteFile object.
+ */
+declare function deserializeDeepnoteFile(yamlContent: string): DeepnoteFile;
+//#endregion
+//#region src/markdown.d.ts
+declare function createMarkdown(block: DeepnoteBlock): string;
+declare function stripMarkdown(block: DeepnoteBlock): string;
+//#endregion
+//#region src/blocks/button-blocks.d.ts
+interface ButtonExecutionContext {
+  /**
+   * If set, button blocks with this variable name that are being executed
+   * will resolve their source code to set the variable to True, False otherwise.
+   */
+  variableContext?: string[];
+}
+//#endregion
+//#region src/python-code.d.ts
+declare function createPythonCode(block: DeepnoteBlock, executionContext?: ButtonExecutionContext): string;
+//#endregion
+export { type DeepnoteBlock, type DeepnoteFile, type TableState, createMarkdown, createPythonCode, deepnoteBlockSchema, deserializeDeepnoteFile, stripMarkdown };