feat(docs): create-script guide

Author: zzhenryquezz

packages/docs/content/en-US/1.guide/1.create-collections.md

@@ -49,4 +49,6 @@ Each column type have different options to be customized, but for now let's just
 
 With this we already have the basic structure of our collection and we can create our todos
 
-![views-table](/views.table.jpeg)
+![views-table](/views.table.jpeg)
+
+- [Check this example here](https://github.com/sidekick-coder/index-san/tree/main/packages/examples/todo-list)

packages/docs/content/en-US/1.guide/2.create-scripts.md

@@ -0,0 +1,130 @@
+# Create scripts
+
+Scripts are javascript code that run simples tasks using(or not) workspace files & collections.
+
+They are very powerful but they can also be dangerous if you do not take care, so pay extra attention to the code you will execute in the app.
+
+::alert{type=danger}
+Never run code from untrusted sources
+::
+
+## Creating & Running script
+
+Go to entries page and click in the plus button to create a new file.
+
+Select the file and press **F2** to rename him to **my-script.ts**.
+
+::alert{type=info}
+Any file in the workspace with the extname *.ts* or *.js* will be treated as a script by the app!
+::
+
+![entires-script-file](/entires.script-file.jpeg)
+
+Open the file to access the editor and we can already write our script.
+
+To execute the script just press the play button on top right of the page.
+
+![script-editor](/scripts.editor.jpeg)
+
+
+
+Scrips have some **global variables** like ```Workspace``` and ```Facades``` to help you make the operations needed in the workspace. 
+
+Check the [script global scope](/scripts/global-scope) to know more about
+
+## Item examples
+
+::code-group
+
+```ts [List]
+// list items of a collection
+
+const repository = await Facades.item
+    .createRepositoryFromWorkspace(Workspace, 'todos')
+
+const items = await repository.list()
+
+setResult(items)
+
+```
+
+```ts [Create]
+const repository = await Facades.item
+    .createRepositoryFromWorkspace(Workspace, 'todos')
+
+const item = await repository.create({
+    name: 'New todo'
+})
+
+setResult(item)
+```
+
+```ts [Create multiple]
+const repository = await Facades.item
+    .createRepositoryFromWorkspace(Workspace, 'todos')
+
+const items = []
+
+for await (const i of Array.from(Array(10).keys())) {
+    items.push(await repository.create({
+        name: 'New todo ' + i
+    }))
+}
+
+setResult(items)
+```
+
+```ts [Update]
+// update items of a collection
+
+const repository = await Facades.item
+    .createRepositoryFromWorkspace(Workspace, 'todos')
+
+const items = await repository.list()
+
+for await (const item of items) {
+
+    await repository.update(item.id, {
+        done: !item.done
+    })
+
+    console.log('updated: ', item.name)
+}
+
+```
+
+::
+
+
+## Drive examples
+
+::code-group
+
+```ts [List]
+
+// read a file/folders in root workspace
+
+const entries = await Drive.list('/')
+
+setResult(entries)
+```
+
+```ts [Read]
+// read a file in root workspace
+
+const bytes = await Drive.read('hello.md')
+
+const text = bytes ? Entry.decode(bytes) : ''
+
+setResult(text)
+```
+
+```ts [Write]
+// write a file in root workspace
+
+await Drive.write('hello.md', Entry.encode('# Hello word'))
+
+setResult("Done")
+```
+::
+

packages/docs/public/entires.script-file.jpeg

@@ -1,2 +1,4 @@
 gtd/tasks/.is/metas.json
-gtd/projects/.is/metas.json
+gtd/projects/.is/metas.json
+
+scripts/collections/todos/.is/metas.json

packages/docs/public/scripts.editor.jpeg

@@ -0,0 +1,24 @@
+[
+    {
+        "columns": [
+            {
+                "label": "Done",
+                "id": "47dcb1b3-4895-4642-a9f9-c23b0d9b3331",
+                "field": "done",
+                "type": "checkbox",
+                "options": []
+            },
+            {
+                "label": "Name",
+                "id": "11ce8ee8-52b6-4dcb-9c49-d5c56a9dbe92",
+                "field": "name",
+                "type": "text",
+                "options": []
+            }
+        ],
+        "id": "todos",
+        "crudName": "fsFolder",
+        "name": "Todos",
+        "path": "/collections/todos"
+    }
+]

packages/examples/.gitignore

@@ -1,38 +1,37 @@
 [
     {
-        "label": "execute.ts",
-        "to": "/entries/execute.ts",
-        "children": [],
-        "id": "0c4b4eb8-c14f-4272-bd9a-9cce18dd9f79",
-        "icon": "fas fa-code"
+        "id": "6421.837380922849",
+        "label": "Collections",
+        "icon": "code",
+        "isSection": true,
+        "children": []
     },
     {
-        "id": "5930.060426198447",
-        "label": "Operations",
+        "id": "289.65503229275765",
+        "label": "Scripts",
         "icon": "code",
         "isSection": true,
-        "children": [
-            {
-                "label": "subtraction.ts",
-                "to": "/entries/subtraction.ts",
-                "children": [],
-                "id": "1d3cb4d7-f861-4f2c-8766-530f7621f811",
-                "icon": "fas fa-code"
-            },
-            {
-                "label": "list-operations.ts",
-                "to": "/entries///list-operations.ts",
-                "children": [],
-                "id": "48fd5d64-cff1-40f8-ba90-6f5db40452e3",
-                "icon": "fas fa-code"
-            },
-            {
-                "label": "sum.ts",
-                "to": "/entries/sum.ts",
-                "children": [],
-                "id": "0a92dd20-140f-4f28-98e1-e49f4ff6c312",
-                "icon": "fas fa-code"
-            }
-        ]
+        "children": []
+    },
+    {
+        "label": "create-item.ts",
+        "to": "/entries/items/create-item.ts",
+        "children": [],
+        "id": "04372ef9-90e8-46f4-ae6e-1913436d2d16",
+        "icon": "bookmark"
+    },
+    {
+        "label": "Todos",
+        "to": "/collections/todos/items",
+        "children": [],
+        "id": "4ef035fd-89a1-4509-aa55-2b575b25a141",
+        "icon": "bookmark"
+    },
+    {
+        "label": "create-multiple.ts",
+        "to": "/entries/items/create-multiple.ts",
+        "children": [],
+        "id": "e6262730-0af1-42b8-abcc-fb0f05efdccb",
+        "icon": "bookmark"
     }
 ]

packages/examples/scripts/.is/collections.json

@@ -0,0 +1,40 @@
+[
+    {
+        "component": "group",
+        "id": "default",
+        "label": "",
+        "viewIds": [
+            "9753fc8e-fac2-4995-92a9-b47d77bb7e4e"
+        ]
+    },
+    {
+        "component": "table",
+        "id": "9753fc8e-fac2-4995-92a9-b47d77bb7e4e",
+        "label": "Table",
+        "search": "",
+        "filters": [],
+        "columns": [
+            {
+                "id": "_actions_left",
+                "label": "#",
+                "width": 43
+            },
+            {
+                "label": "Done",
+                "id": "47dcb1b3-4895-4642-a9f9-c23b0d9b3331",
+                "options": [],
+                "width": 92
+            },
+            {
+                "label": "Name",
+                "id": "11ce8ee8-52b6-4dcb-9c49-d5c56a9dbe92",
+                "options": []
+            },
+            {
+                "id": "_actions_right",
+                "width": "100%"
+            }
+        ],
+        "orderBy": []
+    }
+]

packages/examples/scripts/.is/menu.json

@@ -0,0 +1,9 @@
+/**
+ * This scrit list all files in root of workspace
+ */
+
+const entries = await Drive.list('/')
+
+
+setResult(entries)
+

packages/examples/scripts/collections/todos/.is/views.json

@@ -0,0 +1,7 @@
+// read a file in root worksapce
+
+const bytes = await Drive.read('hello.md')
+
+const text = bytes ? Entry.decode(bytes) : ''
+
+setResult(text)

packages/examples/scripts/drive/list.ts

@@ -0,0 +1,5 @@
+// write a file in root worksapce
+
+await Drive.write('hello.md', Entry.encode('# Hello word'))
+
+setResult("Done")

packages/examples/scripts/drive/read.ts

@@ -0,0 +1 @@
+# Hello word

packages/examples/scripts/drive/write.ts

@@ -0,0 +1,14 @@
+/**
+ * This scrit create an item in the todos collection
+ */
+
+const repository = await Facades.item.createRepositoryFromWorkspace(Workspace, 'todos')
+
+
+const item = await repository.create({
+    name: 'New todo'
+})
+
+
+setResult(item)
+

packages/examples/scripts/execute.ts

@@ -0,0 +1,17 @@
+/**
+ * This scrit create multiple an item in the todos collection
+ */
+
+const repository = await Facades.item.createRepositoryFromWorkspace(Workspace, 'todos')
+
+const items = []
+
+for await (const i of Array.from(Array(10).keys())) {
+    // items.push(await repository.create({
+    //     name: 'New todo ' + i
+    // }))
+}
+
+
+setResult(items)
+

packages/examples/scripts/hello.md

@@ -0,0 +1,8 @@
+// list items of a collection
+
+const repository = await Facades.item.createRepositoryFromWorkspace(Workspace, 'todos')
+
+const items = await repository.list()
+
+setResult(items)
+

packages/examples/scripts/items/create-item.ts

@@ -0,0 +1,15 @@
+// update items of a collection
+
+const repository = await Facades.item.createRepositoryFromWorkspace(Workspace, 'todos')
+
+const items = await repository.list()
+
+for await (const item of items) {
+
+    await repository.update(item.id, {
+        done: !item.done
+    })
+
+    console.log('updated: ', item.name)
+}
+