@deepnote/blocks 1.4.0 → 3.0.0

package/dist/index.cjs

@@ -29,20 +29,320 @@ let ts_dedent = require("ts-dedent");
 ts_dedent = __toESM(ts_dedent);
 
 //#region src/deserialize-file/deepnote-file-schema.ts
-const deepnoteBlockSchema = zod.z.object({
-	blockGroup: zod.z.string().optional(),
-	content: zod.z.string().optional(),
-	contentHash: zod.z.string().regex(/^(md5|sha256):[a-f0-9]+$/i).optional(),
-	executionCount: zod.z.number().optional(),
-	executionFinishedAt: zod.z.string().datetime().optional(),
-	executionStartedAt: zod.z.string().datetime().optional(),
+/** Preprocesses any content value to empty string for blocks that don't use content */
+const emptyContent = () => zod.z.preprocess(() => "", zod.z.literal("").optional());
+const baseBlockMetadataSchema = zod.z.object({
+	deepnote_app_is_code_hidden: zod.z.boolean().optional(),
+	deepnote_app_is_output_hidden: zod.z.boolean().optional(),
+	deepnote_app_block_visible: zod.z.boolean().optional(),
+	deepnote_app_block_width: zod.z.number().optional(),
+	deepnote_app_block_group_id: zod.z.string().nullable().optional(),
+	deepnote_app_block_subgroup_id: zod.z.string().optional(),
+	deepnote_app_block_order: zod.z.number().optional()
+}).passthrough();
+const executableBlockMetadataSchema = baseBlockMetadataSchema.extend({
+	allow_embed: zod.z.union([zod.z.boolean(), zod.z.enum([
+		"code_output",
+		"code",
+		"output"
+	])]).optional(),
+	is_code_hidden: zod.z.boolean().optional(),
+	is_output_hidden: zod.z.boolean().optional(),
+	output_cleared: zod.z.boolean().optional(),
+	execution_start: zod.z.number().optional(),
+	execution_millis: zod.z.number().optional(),
+	source_hash: zod.z.string().optional(),
+	execution_context_id: zod.z.string().optional(),
+	deepnote_cell_height: zod.z.number().optional(),
+	deepnote_output_heights: zod.z.array(zod.z.number().nullable()).optional(),
+	deepnote_table_state: zod.z.record(zod.z.any()).optional(),
+	last_executed_function_notebook_id: zod.z.string().optional(),
+	last_function_run_started_at: zod.z.number().optional(),
+	function_notebook_export_states: zod.z.record(zod.z.any()).optional()
+}).passthrough();
+const textCellMetadataSchema = baseBlockMetadataSchema.extend({
+	is_collapsed: zod.z.boolean().optional(),
+	formattedRanges: zod.z.array(zod.z.any()).optional()
+}).passthrough();
+const baseInputMetadataSchema = executableBlockMetadataSchema.extend({
+	deepnote_variable_name: zod.z.string().default("unnamed_variable"),
+	deepnote_input_label: zod.z.string().optional()
+});
+const baseBlockFields = {
 	id: zod.z.string(),
-	metadata: zod.z.record(zod.z.any()).optional(),
-	outputs: zod.z.array(zod.z.any()).optional(),
+	blockGroup: zod.z.string(),
 	sortingKey: zod.z.string(),
-	type: zod.z.string(),
+	contentHash: zod.z.string().regex(/^(md5|sha256):[a-f0-9]+$/i).optional(),
 	version: zod.z.number().optional()
+};
+const executableBlockFields = {
+	...baseBlockFields,
+	executionCount: zod.z.number().nullable().optional(),
+	executionFinishedAt: zod.z.string().datetime().optional(),
+	executionStartedAt: zod.z.string().datetime().optional(),
+	outputs: zod.z.array(zod.z.any()).optional()
+};
+const markdownBlockSchema = zod.z.object({
+	...baseBlockFields,
+	type: zod.z.literal("markdown"),
+	content: zod.z.string().optional(),
+	metadata: baseBlockMetadataSchema.extend({ deepnote_cell_height: zod.z.number().optional() }).default({})
+});
+const imageBlockSchema = zod.z.object({
+	...baseBlockFields,
+	type: zod.z.literal("image"),
+	content: emptyContent(),
+	metadata: baseBlockMetadataSchema.extend({
+		deepnote_img_src: zod.z.string().optional(),
+		deepnote_img_width: zod.z.enum([
+			"actual",
+			"50%",
+			"75%",
+			"100%"
+		]).optional(),
+		deepnote_img_alignment: zod.z.enum([
+			"left",
+			"center",
+			"right"
+		]).optional()
+	}).default({})
+});
+const separatorBlockSchema = zod.z.object({
+	...baseBlockFields,
+	type: zod.z.literal("separator"),
+	content: emptyContent(),
+	metadata: baseBlockMetadataSchema.default({})
+});
+const textCellH1BlockSchema = zod.z.object({
+	...baseBlockFields,
+	type: zod.z.literal("text-cell-h1"),
+	content: zod.z.string().optional(),
+	metadata: textCellMetadataSchema.default({})
+});
+const textCellH2BlockSchema = zod.z.object({
+	...baseBlockFields,
+	type: zod.z.literal("text-cell-h2"),
+	content: zod.z.string().optional(),
+	metadata: textCellMetadataSchema.default({})
+});
+const textCellH3BlockSchema = zod.z.object({
+	...baseBlockFields,
+	type: zod.z.literal("text-cell-h3"),
+	content: zod.z.string().optional(),
+	metadata: textCellMetadataSchema.default({})
+});
+const textCellPBlockSchema = zod.z.object({
+	...baseBlockFields,
+	type: zod.z.literal("text-cell-p"),
+	content: zod.z.string().optional(),
+	metadata: textCellMetadataSchema.default({})
+});
+const textCellBulletBlockSchema = zod.z.object({
+	...baseBlockFields,
+	type: zod.z.literal("text-cell-bullet"),
+	content: zod.z.string().optional(),
+	metadata: textCellMetadataSchema.default({})
+});
+const textCellTodoBlockSchema = zod.z.object({
+	...baseBlockFields,
+	type: zod.z.literal("text-cell-todo"),
+	content: zod.z.string().optional(),
+	metadata: textCellMetadataSchema.extend({ checked: zod.z.boolean().optional() }).default({})
+});
+const textCellCalloutBlockSchema = zod.z.object({
+	...baseBlockFields,
+	type: zod.z.literal("text-cell-callout"),
+	content: zod.z.string().optional(),
+	metadata: textCellMetadataSchema.extend({ color: zod.z.enum([
+		"blue",
+		"green",
+		"yellow",
+		"red",
+		"purple"
+	]).optional() }).default({})
+});
+const codeBlockSchema = zod.z.object({
+	...executableBlockFields,
+	type: zod.z.literal("code"),
+	content: zod.z.string().optional(),
+	metadata: executableBlockMetadataSchema.extend({ function_export_name: zod.z.string().optional() }).default({})
+});
+const sqlBlockSchema = zod.z.object({
+	...executableBlockFields,
+	type: zod.z.literal("sql"),
+	content: zod.z.string().optional(),
+	metadata: executableBlockMetadataSchema.extend({
+		deepnote_variable_name: zod.z.string().optional(),
+		deepnote_return_variable_type: zod.z.enum(["dataframe", "query_preview"]).optional(),
+		sql_integration_id: zod.z.string().optional(),
+		is_compiled_sql_query_visible: zod.z.boolean().optional(),
+		function_export_name: zod.z.string().optional()
+	}).default({})
+});
+const notebookFunctionBlockSchema = zod.z.object({
+	...executableBlockFields,
+	type: zod.z.literal("notebook-function"),
+	content: emptyContent(),
+	metadata: executableBlockMetadataSchema.extend({
+		function_notebook_id: zod.z.string().nullable(),
+		function_notebook_inputs: zod.z.record(zod.z.any()).optional(),
+		function_notebook_export_mappings: zod.z.record(zod.z.any()).optional()
+	}).default({ function_notebook_id: null })
+});
+const visualizationBlockSchema = zod.z.object({
+	...executableBlockFields,
+	type: zod.z.literal("visualization"),
+	content: emptyContent(),
+	metadata: executableBlockMetadataSchema.extend({
+		deepnote_variable_name: zod.z.string().optional(),
+		deepnote_visualization_spec: zod.z.record(zod.z.any()).optional(),
+		deepnote_config_collapsed: zod.z.boolean().optional(),
+		deepnote_chart_height: zod.z.number().optional(),
+		deepnote_chart_filter: zod.z.record(zod.z.any()).optional()
+	}).default({})
+});
+const buttonBlockSchema = zod.z.object({
+	...executableBlockFields,
+	type: zod.z.literal("button"),
+	content: emptyContent(),
+	metadata: executableBlockMetadataSchema.extend({
+		deepnote_button_title: zod.z.string().optional(),
+		deepnote_button_color_scheme: zod.z.enum([
+			"blue",
+			"red",
+			"neutral",
+			"green",
+			"yellow"
+		]).optional(),
+		deepnote_button_behavior: zod.z.enum(["run", "set_variable"]).optional(),
+		deepnote_variable_name: zod.z.string().optional()
+	}).default({})
+});
+const bigNumberBlockSchema = zod.z.object({
+	...executableBlockFields,
+	type: zod.z.literal("big-number"),
+	content: zod.z.string().optional(),
+	metadata: executableBlockMetadataSchema.extend({
+		deepnote_big_number_title: zod.z.string().default(""),
+		deepnote_big_number_value: zod.z.string().default(""),
+		deepnote_big_number_format: zod.z.string().default(""),
+		deepnote_big_number_comparison_enabled: zod.z.boolean().optional(),
+		deepnote_big_number_comparison_title: zod.z.string().optional(),
+		deepnote_big_number_comparison_value: zod.z.string().optional(),
+		deepnote_big_number_comparison_type: zod.z.string().optional(),
+		deepnote_big_number_comparison_format: zod.z.string().optional()
+	}).default({})
+});
+const inputTextBlockSchema = zod.z.object({
+	...executableBlockFields,
+	type: zod.z.literal("input-text"),
+	content: zod.z.string().optional(),
+	metadata: baseInputMetadataSchema.extend({
+		deepnote_variable_value: zod.z.string().default(""),
+		deepnote_variable_default_value: zod.z.preprocess((val) => val === null ? void 0 : val, zod.z.string().optional())
+	}).default({})
+});
+const inputTextareaBlockSchema = zod.z.object({
+	...executableBlockFields,
+	type: zod.z.literal("input-textarea"),
+	content: zod.z.string().optional(),
+	metadata: baseInputMetadataSchema.extend({
+		deepnote_variable_value: zod.z.string().default(""),
+		deepnote_variable_default_value: zod.z.preprocess((val) => val === null ? void 0 : val, zod.z.string().optional())
+	}).default({})
+});
+const inputCheckboxBlockSchema = zod.z.object({
+	...executableBlockFields,
+	type: zod.z.literal("input-checkbox"),
+	content: zod.z.string().optional(),
+	metadata: baseInputMetadataSchema.extend({
+		deepnote_variable_value: zod.z.boolean().default(false),
+		deepnote_variable_default_value: zod.z.preprocess((val) => val === null ? void 0 : val, zod.z.boolean().optional()),
+		deepnote_input_checkbox_label: zod.z.string().optional()
+	}).default({})
+});
+const inputSelectBlockSchema = zod.z.object({
+	...executableBlockFields,
+	type: zod.z.literal("input-select"),
+	content: zod.z.string().optional(),
+	metadata: baseInputMetadataSchema.extend({
+		deepnote_variable_value: zod.z.union([zod.z.string(), zod.z.array(zod.z.string())]).default(""),
+		deepnote_variable_default_value: zod.z.preprocess((val) => val === null ? void 0 : val, zod.z.union([zod.z.string(), zod.z.array(zod.z.string())]).optional()),
+		deepnote_variable_options: zod.z.array(zod.z.string()).default([]),
+		deepnote_variable_custom_options: zod.z.array(zod.z.string()).default([]),
+		deepnote_variable_selected_variable: zod.z.string().default(""),
+		deepnote_variable_select_type: zod.z.enum(["from-options", "from-variable"]).default("from-options"),
+		deepnote_allow_multiple_values: zod.z.boolean().optional(),
+		deepnote_allow_empty_values: zod.z.boolean().optional()
+	}).default({})
+});
+const inputSliderBlockSchema = zod.z.object({
+	...executableBlockFields,
+	type: zod.z.literal("input-slider"),
+	content: zod.z.string().optional(),
+	metadata: baseInputMetadataSchema.extend({
+		deepnote_variable_value: zod.z.string().default("0"),
+		deepnote_variable_default_value: zod.z.preprocess((val) => val === null ? void 0 : val, zod.z.string().optional()),
+		deepnote_slider_min_value: zod.z.number().default(0),
+		deepnote_slider_max_value: zod.z.number().default(100),
+		deepnote_slider_step: zod.z.number().default(1)
+	}).default({})
+});
+const inputDateBlockSchema = zod.z.object({
+	...executableBlockFields,
+	type: zod.z.literal("input-date"),
+	content: zod.z.string().optional(),
+	metadata: baseInputMetadataSchema.extend({
+		deepnote_variable_value: zod.z.string().default(""),
+		deepnote_variable_default_value: zod.z.preprocess((val) => val === null ? void 0 : val, zod.z.string().optional()),
+		deepnote_allow_empty_values: zod.z.boolean().optional(),
+		deepnote_input_date_version: zod.z.number().optional()
+	}).default({})
+});
+const inputDateRangeBlockSchema = zod.z.object({
+	...executableBlockFields,
+	type: zod.z.literal("input-date-range"),
+	content: zod.z.string().optional(),
+	metadata: baseInputMetadataSchema.extend({
+		deepnote_variable_value: zod.z.union([zod.z.tuple([zod.z.string(), zod.z.string()]), zod.z.string()]).default(""),
+		deepnote_variable_default_value: zod.z.preprocess((val) => val === null ? void 0 : val, zod.z.union([zod.z.tuple([zod.z.string(), zod.z.string()]), zod.z.string()]).optional())
+	}).default({})
+});
+const inputFileBlockSchema = zod.z.object({
+	...executableBlockFields,
+	type: zod.z.literal("input-file"),
+	content: zod.z.string().optional(),
+	metadata: baseInputMetadataSchema.extend({
+		deepnote_variable_value: zod.z.string().default(""),
+		deepnote_allowed_file_extensions: zod.z.string().optional()
+	}).default({})
 });
+const deepnoteBlockSchema = zod.z.discriminatedUnion("type", [
+	markdownBlockSchema,
+	imageBlockSchema,
+	separatorBlockSchema,
+	textCellH1BlockSchema,
+	textCellH2BlockSchema,
+	textCellH3BlockSchema,
+	textCellPBlockSchema,
+	textCellBulletBlockSchema,
+	textCellTodoBlockSchema,
+	textCellCalloutBlockSchema,
+	codeBlockSchema,
+	sqlBlockSchema,
+	notebookFunctionBlockSchema,
+	visualizationBlockSchema,
+	buttonBlockSchema,
+	bigNumberBlockSchema,
+	inputTextBlockSchema,
+	inputTextareaBlockSchema,
+	inputCheckboxBlockSchema,
+	inputSelectBlockSchema,
+	inputSliderBlockSchema,
+	inputDateBlockSchema,
+	inputDateRangeBlockSchema,
+	inputFileBlockSchema
+]);
 const environmentSchema = zod.z.object({
 	customImage: zod.z.string().optional(),
 	hash: zod.z.string().optional(),
@@ -254,7 +554,7 @@ function sanitizeAlignment(alignment) {
 	].includes(alignment.toLowerCase()) ? alignment.toLowerCase() : "";
 }
 function createMarkdownForImageBlock(block) {
-	return `<img src="${escapeHtmlAttribute(block.metadata.deepnote_img_src ?? "")}" width="${sanitizeWidth(block.metadata.deepnote_img_width ?? "")}" align="${sanitizeAlignment(block.metadata.deepnote_img_alignment ?? "")}" />`;
+	return `<img src="${escapeHtmlAttribute(block.metadata?.deepnote_img_src ?? "")}" width="${sanitizeWidth(block.metadata?.deepnote_img_width ?? "")}" align="${sanitizeAlignment(block.metadata?.deepnote_img_alignment ?? "")}" />`;
 }
 function isImageBlock(block) {
 	return block.type === "image";
@@ -277,23 +577,25 @@ function escapeMarkdown(text) {
 	return text.replace(/([\\`*_{}[\]()#+\-.!|>])/g, "\\$1");
 }
 function createMarkdownForTextBlock(block) {
-	if (block.type === "text-cell-h1") return `# ${escapeMarkdown(block.content)}`;
-	if (block.type === "text-cell-h2") return `## ${escapeMarkdown(block.content)}`;
-	if (block.type === "text-cell-h3") return `### ${escapeMarkdown(block.content)}`;
-	if (block.type === "text-cell-bullet") return `- ${escapeMarkdown(block.content)}`;
-	if (block.type === "text-cell-todo") return `- ${block.metadata.checked ? "[x]" : "[ ]"} ${escapeMarkdown(block.content)}`;
-	if (block.type === "text-cell-callout") return `> ${escapeMarkdown(block.content)}`;
-	if (block.type === "text-cell-p") return escapeMarkdown(block.content);
+	const content = block.content ?? "";
+	if (block.type === "text-cell-h1") return `# ${escapeMarkdown(content)}`;
+	if (block.type === "text-cell-h2") return `## ${escapeMarkdown(content)}`;
+	if (block.type === "text-cell-h3") return `### ${escapeMarkdown(content)}`;
+	if (block.type === "text-cell-bullet") return `- ${escapeMarkdown(content)}`;
+	if (block.type === "text-cell-todo") return `- ${block.metadata?.checked ? "[x]" : "[ ]"} ${escapeMarkdown(content)}`;
+	if (block.type === "text-cell-callout") return `> ${escapeMarkdown(content)}`;
+	if (block.type === "text-cell-p") return escapeMarkdown(content);
 	throw new Error("Unhandled block type.");
 }
 function stripMarkdownFromTextBlock(block) {
-	if (block.type === "text-cell-h1") return block.content.replace(/^#\s+/, "").trim();
-	if (block.type === "text-cell-h2") return block.content.replace(/^##\s+/, "").trim();
-	if (block.type === "text-cell-h3") return block.content.replace(/^#{3,6}\s+/, "").trim();
-	if (block.type === "text-cell-bullet") return block.content.replace(/^-+\s+/, "").trim();
-	if (block.type === "text-cell-todo") return block.content.replace(/^-+\s+\[.\]\s+/, "").trim();
-	if (block.type === "text-cell-callout") return block.content.replace(/^>\s+/, "").trim();
-	if (block.type === "text-cell-p") return block.content.trim();
+	const content = block.content ?? "";
+	if (block.type === "text-cell-h1") return content.replace(/^#\s+/, "").trim();
+	if (block.type === "text-cell-h2") return content.replace(/^##\s+/, "").trim();
+	if (block.type === "text-cell-h3") return content.replace(/^#{3,6}\s+/, "").trim();
+	if (block.type === "text-cell-bullet") return content.replace(/^-+\s+/, "").trim();
+	if (block.type === "text-cell-todo") return content.replace(/^-+\s+\[.\]\s+/, "").trim();
+	if (block.type === "text-cell-callout") return content.replace(/^>\s+/, "").trim();
+	if (block.type === "text-cell-p") return content.trim();
 	throw new Error("Unhandled block type.");
 }
 function createMarkdownForSeparatorBlock(_block) {
@@ -473,7 +775,7 @@ function isBigNumberBlock(block) {
 //#endregion
 //#region src/blocks/button-blocks.ts
 function createPythonCodeForButtonBlock(block, executionContext) {
-	if (block.metadata.deepnote_button_behavior === "set_variable" && block.metadata.deepnote_variable_name) {
+	if (block.metadata?.deepnote_button_behavior === "set_variable" && block.metadata?.deepnote_variable_name) {
 		const sanitizedPythonVariableName = sanitizePythonVariableName(block.metadata.deepnote_variable_name);
 		if (executionContext?.variableContext?.includes(sanitizedPythonVariableName)) return pythonCode.setVariableContextValue(sanitizedPythonVariableName, true);
 		return pythonCode.setVariableContextValue(sanitizedPythonVariableName, false);
@@ -487,7 +789,7 @@ function isButtonBlock(block) {
 //#endregion
 //#region src/blocks/data-frame.ts
 function createDataFrameConfig(block) {
-	const tableState = block.metadata.deepnote_table_state ?? {};
+	const tableState = block.metadata?.deepnote_table_state ?? {};
 	const tableStateAsJson = JSON.stringify(tableState);
 	return ts_dedent.dedent`
     if '_dntk' in globals():
@@ -648,11 +950,11 @@ function getSqlEnvVarName(integrationId) {
 //#endregion
 //#region src/blocks/sql-blocks.ts
 function createPythonCodeForSqlBlock(block) {
-	const query = block.content;
-	const pythonVariableName = block.metadata.deepnote_variable_name;
+	const query = block.content ?? "";
+	const pythonVariableName = block.metadata?.deepnote_variable_name;
 	const sanitizedPythonVariableName = pythonVariableName !== void 0 ? sanitizePythonVariableName(pythonVariableName) || "input_1" : void 0;
-	const returnVariableType = block.metadata.deepnote_return_variable_type ?? "dataframe";
-	const integrationId = block.metadata.sql_integration_id;
+	const returnVariableType = block.metadata?.deepnote_return_variable_type ?? "dataframe";
+	const integrationId = block.metadata?.sql_integration_id;
 	const connectionEnvVarName = integrationId ? convertToEnvironmentVariableName(getSqlEnvVarName(integrationId)) : "SQL_ALCHEMY_JSON_ENV_VAR";
 	const escapedQuery = escapePythonString(query);
 	const dataFrameConfig = createDataFrameConfig(block);
@@ -684,9 +986,9 @@ function isSqlBlock(block) {
 //#endregion
 //#region src/blocks/visualization-blocks.ts
 function createPythonCodeForVisualizationBlock(block) {
-	const variableName = block.metadata.deepnote_variable_name;
-	const spec = block.metadata.deepnote_visualization_spec;
-	const filters = block.metadata.deepnote_chart_filter?.advancedFilters ?? [];
+	const variableName = block.metadata?.deepnote_variable_name;
+	const spec = block.metadata?.deepnote_visualization_spec;
+	const filters = block.metadata?.deepnote_chart_filter?.advancedFilters ?? [];
 	if (!variableName || !spec) return "";
 	const sanitizedVariableName = sanitizePythonVariableName(variableName);
 	return pythonCode.executeVisualization(sanitizedVariableName, JSON.stringify(spec), JSON.stringify(filters));