feat: add template

frontend/appflowy_flutter/integration_test/document/document_template_test.dart

@@ -0,0 +1,120 @@
+import 'package:flutter/services.dart';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:integration_test/integration_test.dart';
+
+import 'package:path/path.dart' as p;
+import 'package:path_provider/path_provider.dart';
+import 'dart:io';
+
+import 'package:appflowy_backend/protobuf/flowy-folder2/protobuf.dart';
+
+import '../util/mock/mock_file_picker.dart';
+import '../util/util.dart';
+
+void main() {
+  IntegrationTestWidgetsFlutterBinding.ensureInitialized();
+
+  group('document template test', () {
+    testWidgets('export a template tree', (tester) async {
+      await tester.initializeAppFlowy();
+      await tester.tapGoButton();
+
+      await tester.createNewPageWithName(
+        name: 'parentDoc',
+        layout: ViewLayoutPB.Document,
+      );
+
+      await tester.editor.tapLineOfEditorAt(0);
+      await tester.ime.insertText("# Parent Doc");
+
+      await tester.createNewPageWithName(
+        name: "childDoc",
+        parentName: "parentDoc",
+        layout: ViewLayoutPB.Document,
+      );
+      await tester.editor.tapLineOfEditorAt(0);
+      await tester.ime.insertText("# Child Doc");
+
+      await tester.createNewPageWithName(
+        name: "childGrid",
+        parentName: "parentDoc",
+        layout: ViewLayoutPB.Grid,
+      );
+
+      await tester.openPage(gettingStarted);
+
+      await tester.editor.hoverOnCoverToolbar();
+      await tester.tapButtonWithName("Convert to JSON");
+
+      final tempDir = await getApplicationDocumentsDirectory();
+
+      expect(await Directory("${tempDir.path}/template").exists(), isTrue);
+
+      expect(
+        await File("${tempDir.path}/template/config.json").exists(),
+        isTrue,
+      );
+      expect(
+        await File("${tempDir.path}/template/parentDoc.json").exists(),
+        isTrue,
+      );
+      expect(
+        await File("${tempDir.path}/template/childDoc.json").exists(),
+        isTrue,
+      );
+      expect(
+        await File("${tempDir.path}/template/childGrid.csv").exists(),
+        isTrue,
+      );
+    });
+
+    testWidgets('import a template', (tester) async {
+      final context = await tester.initializeAppFlowy();
+      await tester.tapGoButton();
+
+      await tester.editor.tapLineOfEditorAt(0);
+
+      const zipFileName = 'template.zip';
+      final data = await rootBundle.load('assets/test/workspaces/$zipFileName');
+
+      final bytes = Uint8List.view(data.buffer);
+      final path = p.join(context.applicationDataDirectory, zipFileName);
+      File(path).writeAsBytesSync(bytes);
+
+      // mock get files
+      await mockPickFilePaths(paths: [path]);
+
+      // tap template button
+      await tester.tapAddViewButton();
+      await tester.tapButtonWithName("Template");
+
+      await tester.expandPage(gettingStarted);
+
+      await tester.pumpAndSettle();
+
+      // Expand all pages
+      final List<String> toExpand = [
+        "TestTemplate",
+        "Level1_1",
+        "Level1_2",
+        "Level2_1",
+      ];
+
+      for (final e in toExpand) {
+        await tester.expandPage(e);
+      }
+
+      await tester.pumpAndSettle();
+
+      tester.expectToSeePageName("TestTemplate", parentName: gettingStarted);
+
+      tester.expectToSeePageName("Level1_1", parentName: "TestTemplate");
+      tester.expectToSeePageName("Level2_1", parentName: "Level1_1");
+      tester.expectToSeePageName("Level3_1", parentName: "Level2_1");
+
+      tester.expectToSeePageName("Level1_2", parentName: "TestTemplate");
+      tester.expectToSeePageName("Level2_2", parentName: "Level1_2");
+      tester.expectToSeeText("Level2_Grid");
+    });
+  });
+}

frontend/appflowy_flutter/integration_test/util/common_operations.dart

@@ -1,3 +1,4 @@
+import 'package:appflowy/generated/flowy_svgs.g.dart';
 import 'package:appflowy/workspace/presentation/home/menu/sidebar/sidebar_new_page_button.dart';
 import 'package:appflowy/workspace/presentation/home/menu/view/draggable_view_item.dart';
 import 'package:appflowy/workspace/presentation/home/menu/view/view_action_type.dart';
@@ -409,6 +410,19 @@ extension CommonOperations on WidgetTester {
     await gesture.up();
     await pumpAndSettle();
   }
+
+  Future<void> expandPage(String name) async {
+    final pageToggleButton = find.descendant(
+      of: findPageName(name),
+      matching: find.byWidgetPredicate(
+        // (widget) => widget is FlowySvg && widget.name == 'home/drop_down_hide',
+        (widget) =>
+            widget is FlowySvg && widget.svg == FlowySvgs.drop_menu_hide_m,
+      ),
+    );
+    await tap(pageToggleButton);
+    await pumpAndSettle(const Duration(milliseconds: 500));
+  }
 }
 
 extension ViewLayoutPBTest on ViewLayoutPB {

frontend/appflowy_flutter/lib/plugins/document/application/template/config_service.dart

@@ -0,0 +1,177 @@
+import 'dart:convert';
+import 'dart:io';
+
+import 'package:path/path.dart' as path;
+import 'package:appflowy/workspace/application/view/view_service.dart';
+import 'package:appflowy_backend/protobuf/flowy-folder2/view.pb.dart';
+import 'package:path_provider/path_provider.dart';
+
+/// Responsible to generate the [config.json] file for template
+
+class ConfigService {
+  final _template = FlowyTemplate(
+    templateName: "template",
+    documents: FlowyTemplateItem(name: "template.json", childViews: []),
+  );
+
+  initConfig(ViewPB view) async {
+    final docModel = await _generateConfig(view, _template.documents);
+    if (docModel != null) _template.documents = docModel;
+  }
+
+  Future<FlowyTemplateItem?> _generateConfig(
+    ViewPB view,
+    FlowyTemplateItem model,
+  ) async {
+    final viewsAtId = await ViewBackendService.getChildViews(viewId: view.id);
+    final List<ViewPB> views = viewsAtId.getLeftOrNull();
+
+    if (views.isEmpty) return null;
+
+    final FlowyTemplateItem newModel =
+        FlowyTemplateItem(name: "${view.name}.json", childViews: []);
+
+    for (final e in views) {
+      final temp = await ViewBackendService.getChildViews(viewId: e.id);
+      final viewsAtE = temp.getLeftOrNull();
+
+      // If children are empty no need to continue
+      if (viewsAtE.isEmpty) {
+        newModel.childViews.add(addData(newModel, e));
+      } else {
+        final newDoc = await _generateConfig(e, newModel);
+
+        if (newDoc != null) {
+          newModel.childViews.add(newDoc);
+        }
+      }
+    }
+
+    return newModel;
+  }
+
+  Future<void> saveConfig() async {
+    final directory = await getApplicationDocumentsDirectory();
+
+    final dir = Directory(path.join(directory.path, 'template'));
+    if (!(await dir.exists())) {
+      await dir.create(recursive: true);
+    }
+
+    final file = File(
+      path.join(directory.path, 'template', "config.json"),
+    );
+
+    await file.writeAsString(json.encode(_template.toJson()));
+  }
+
+  FlowyTemplateItem addData(FlowyTemplateItem model, ViewPB view) {
+    final FlowyTemplateItem newModel = FlowyTemplateItem(
+      name: "",
+      childViews: [],
+    );
+
+    switch (view.layout) {
+      case ViewLayoutPB.Document:
+        newModel.name = "${view.name}.json";
+        break;
+      case ViewLayoutPB.Grid:
+      case ViewLayoutPB.Board:
+        final name = "${view.name}.csv";
+        newModel.name = name;
+        break;
+      default:
+      // Eventually support calender
+    }
+    return newModel;
+  }
+}
+
+/// [FlowyTemplate] is the structure for [config.json] file
+class FlowyTemplate {
+  String templateName;
+  FlowyTemplateItem documents;
+
+  FlowyTemplate({
+    required this.templateName,
+    required this.documents,
+  });
+
+  factory FlowyTemplate.fromRawJson(String str) =>
+      FlowyTemplate.fromJson(json.decode(str));
+
+  String toRawJson() => json.encode(toJson());
+
+  factory FlowyTemplate.fromJson(Map<String, dynamic> json) => FlowyTemplate(
+        templateName: json["templateName"],
+        documents: FlowyTemplateItem.fromJson(json["documents"]),
+      );
+
+  Map<String, dynamic> toJson() => {
+        "templateName": templateName,
+        "documents": documents.toJson(),
+      };
+}
+
+/// [FlowyTemplateItem] is the structure for each document in [config.json] file
+class FlowyTemplateItem {
+  String name;
+  // List<String> db;
+  List<FlowyTemplateItem> childViews;
+
+  FlowyTemplateItem({
+    required this.name,
+    // required this.db,
+    required this.childViews,
+  });
+
+  factory FlowyTemplateItem.fromRawJson(String str) =>
+      FlowyTemplateItem.fromJson(json.decode(str));
+
+  String toRawJson() => json.encode(toJson());
+
+  factory FlowyTemplateItem.fromJson(Map<String, dynamic> json) =>
+      FlowyTemplateItem(
+        name: json["name"],
+        childViews: List<FlowyTemplateItem>.from(
+          json["childViews"].map((x) => FlowyTemplateItem.fromJson(x)),
+        ),
+      );
+
+  Map<String, dynamic> toJson() {
+    final processed = <FlowyTemplateItem>{};
+    final result = <String, dynamic>{
+      "name": name,
+      "childViews": [],
+    };
+
+    _toJsonHelper(this, processed, result);
+
+    return result;
+  }
+
+  void _toJsonHelper(
+    FlowyTemplateItem model,
+    Set<FlowyTemplateItem> processed,
+    Map<String, dynamic> result,
+  ) {
+    if (processed.contains(model)) {
+      return;
+    }
+
+    processed.add(model);
+
+    final childViews = <dynamic>[];
+    for (final child in model.childViews) {
+      final childResult = <String, dynamic>{
+        "name": child.name,
+        "childViews": [],
+      };
+
+      _toJsonHelper(child, processed, childResult);
+      childViews.add(childResult);
+    }
+
+    result["childViews"] = childViews;
+  }
+}