DRAFT: Add support for saving full document

Most of the code is similar to the export functionality. The exception
is that this document will encompass additional non-svg data.

The `SerializeData` request accepts an `action` string that it opaquely
passes through. The response handler can use the `action` string to
decide if the serialization is for saving or auto-saving.

Author: azeemba

Cargo.lock

@@ -240,7 +240,7 @@
 <script lang="ts">
 import { defineComponent } from "vue";
 import { makeModifiersBitfield } from "@/utilities/input";
-import { ResponseType, registerResponseHandler, Response, UpdateCanvas, SetActiveTool, ExportDocument, SetCanvasZoom, SetCanvasRotation } from "@/utilities/response-handler";
+import { ResponseType, registerResponseHandler, Response, UpdateCanvas, SetActiveTool, ExportDocument, SetCanvasZoom, SetCanvasRotation, SerializeDocument } from "@/utilities/response-handler";
 import LayoutRow from "@/components/layout/LayoutRow.vue";
 import LayoutCol from "@/components/layout/LayoutCol.vue";
 import SwatchPairInput from "@/components/widgets/inputs/SwatchPairInput.vue";
@@ -342,6 +342,12 @@ export default defineComponent({
 			const updateData = responseData as ExportDocument;
 			if (updateData) this.download("canvas.svg", updateData.document);
 		});
+		registerResponseHandler(ResponseType.SerializeDocument, (responseData: Response) => {
+			const data = responseData as SerializeDocument;
+			if (data && data.action === "save") {
+				this.download("canvas.gsvg", data.document);
+			}
+		});
 		registerResponseHandler(ResponseType.SetActiveTool, (responseData: Response) => {
 			const toolData = responseData as SetActiveTool;
 			if (toolData) this.activeTool = toolData.tool_name;

client/web/src/components/panels/Document.vue

@@ -87,7 +87,7 @@ const menuEntries: MenuListEntries = [
 				{ label: "Close All", shortcut: ["Ctrl", "Alt", "W"], action: async () => (await wasm).close_all_documents_with_confirmation() },
 			],
 			[
-				{ label: "Save", shortcut: ["Ctrl", "S"] },
+				{ label: "Save", shortcut: ["Ctrl", "S"], action: async () => (await wasm).serialize_document("save") },
 				{ label: "Save As…", shortcut: ["Ctrl", "⇧", "S"] },
 				{ label: "Save All", shortcut: ["Ctrl", "Alt", "S"] },
 				{ label: "Auto-Save", shortcut: undefined },

client/web/src/components/widgets/inputs/MenuBarInput.vue

@@ -24,6 +24,7 @@ export enum ResponseType {
 	SetCanvasRotation = "SetCanvasRotation",
 	DisplayConfirmationToCloseDocument = "DisplayConfirmationToCloseDocument",
 	DisplayConfirmationToCloseAllDocuments = "DisplayConfirmationToCloseAllDocuments",
+	SerializeDocument = "SerializeDocument",
 }
 
 export function registerResponseHandler(responseType: ResponseType, callback: ResponseCallback) {
@@ -73,6 +74,8 @@ function parseResponse(responseType: string, data: any): Response {
 			return newDisplayConfirmationToCloseDocument(data.DisplayConfirmationToCloseDocument);
 		case "DisplayConfirmationToCloseAllDocuments":
 			return newDisplayConfirmationToCloseAllDocuments(data.DisplayConfirmationToCloseAllDocuments);
+		case "SerializeDocument":
+			return newSerializeDocument(data.SerializeDocument);
 		default:
 			throw new Error(`Unrecognized origin/responseType pair: ${origin}, '${responseType}'`);
 	}
@@ -158,6 +161,17 @@ function newExportDocument(input: any): UpdateCanvas {
 	};
 }
 
+export interface SerializeDocument {
+	document: string;
+	action: string;
+}
+function newSerializeDocument(input: any): SerializeDocument {
+	return {
+		document: input.document,
+		action: input.action,
+	};
+}
+
 export type DocumentChanged = {};
 function newDocumentChanged(_: any): DocumentChanged {
 	return {};

client/web/src/utilities/response-handler.ts

@@ -177,6 +177,14 @@ pub fn export_document() -> Result<(), JsValue> {
 	EDITOR_STATE.with(|editor| editor.borrow_mut().handle_message(DocumentMessage::ExportDocument)).map_err(convert_error)
 }
 
+/// Serialize document
+#[wasm_bindgen]
+pub fn serialize_document(action: String) -> Result<(), JsValue> {
+	EDITOR_STATE
+		.with(|editor| editor.borrow_mut().handle_message(DocumentMessage::SerializeDocument(action)))
+		.map_err(convert_error)
+}
+
 /// Sets the zoom to the value
 #[wasm_bindgen]
 pub fn set_zoom(new_zoom: f64) -> Result<(), JsValue> {

client/web/wasm/src/document.rs

@@ -64,6 +64,12 @@ impl Document {
 		svg
 	}
 
+	// Returns string that represents the full document (not just svg)
+	pub fn serialize_document(&mut self) -> String {
+		// Manually constructing JSON. Should switch to serde_json
+		format!("{{\"version\": 0, \"svg\": \"{}\"}}", self.render_root())
+	}
+
 	/// Checks whether each layer under `path` intersects with the provided `quad` and adds all intersection layers as paths to `intersections`.
 	pub fn intersects_quad(&self, quad: [DVec2; 4], path: &mut Vec<LayerId>, intersections: &mut Vec<Vec<LayerId>>) {
 		self.document_folder(path).unwrap().intersects_quad(quad, path, intersections);

core/document/src/document.rs

@@ -54,6 +54,7 @@ pub enum DocumentMessage {
 	WheelCanvasZoom,
 	SetCanvasRotation(f64),
 	NudgeSelectedLayers(f64, f64),
+	SerializeDocument(String),
 }
 
 impl From<DocumentOperation> for DocumentMessage {
@@ -328,6 +329,13 @@ impl MessageHandler<DocumentMessage, &InputPreprocessor> for DocumentMessageHand
 				}
 				.into(),
 			),
+			SerializeDocument(action) => responses.push_back(
+				FrontendMessage::SerializeDocument {
+					document: self.active_document_mut().document.serialize_document(),
+					action,
+				}
+				.into(),
+			),
 			ToggleLayerVisibility(path) => {
 				responses.push_back(DocumentOperation::ToggleVisibility { path }.into());
 			}
@@ -581,6 +589,7 @@ impl MessageHandler<DocumentMessage, &InputPreprocessor> for DocumentMessageHand
 			SetCanvasRotation,
 			WheelCanvasZoom,
 			WheelCanvasTranslate,
+			SerializeDocument
 		);
 
 		if self.active_document().layer_data.values().any(|data| data.selected) {

core/editor/src/document/document_message_handler.rs

@@ -22,6 +22,7 @@ pub enum FrontendMessage {
 	UpdateWorkingColors { primary: Color, secondary: Color },
 	SetCanvasZoom { new_zoom: f64 },
 	SetCanvasRotation { new_radians: f64 },
+	SerializeDocument { document: String, action: String },
 }
 
 pub struct FrontendMessageHandler {