test: major examples refactoring for docs, unit tests and e2e tests

.envrc

@@ -1,3 +1,12 @@
+# Automatically sets up your devbox environment whenever you cd into this
+# directory via our direnv integration:
+
+eval "$(devbox generate direnv --print-envrc)"
+
+# check out https://www.jetpack.io/devbox/docs/ide_configuration/direnv/
+# for more details
+
+# Custom direnv changes:
 [[ -f .env-global.env ]] && dotenv ".env-global.env"
 [[ -f .env ]] && dotenv ".env"
 [[ -f ".env-${DEPLOYMENT_ENV}.env" ]] && dotenv ".env-${DEPLOYMENT_ENV}.env"

.eslintignore

@@ -4,3 +4,4 @@ docs/
 dist/
 gas/
 node_modules/
+*.bak*

.gitignore

@@ -8,7 +8,7 @@ dist-examples/
 node_modules/
 .env
 *.env
-*.bak
+*.bak*
 !.vscode/settings.json
 debug.json
 docs/docs/community/CHANGELOG.md

devbox.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://raw.githubusercontent.com/jetpack-io/devbox/0.10.3/.schema/devbox.schema.json",
+  "packages": ["nodejs@20", "gojq@0", "gh@2", "gomplate@3"],
+  "shell": {
+    "init_hook": ["echo 'Welcome to devbox!' > /dev/null"],
+    "scripts": {
+      "test": ["echo \"Error: no test specified\" && exit 1"]
+    }
+  }
+}

devbox.lock

@@ -0,0 +1,214 @@
+{
+  "lockfile_version": "1",
+  "packages": {
+    "gh@2": {
+      "last_modified": "2024-03-22T07:26:23-04:00",
+      "resolved": "github:NixOS/nixpkgs/a3ed7406349a9335cb4c2a71369b697cecd9d351#gh",
+      "source": "devbox-search",
+      "version": "2.46.0",
+      "systems": {
+        "aarch64-darwin": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/lxz3z6qdrkszz8v5xp77xa20cv8q7fdj-gh-2.46.0",
+              "default": true
+            }
+          ],
+          "store_path": "/nix/store/lxz3z6qdrkszz8v5xp77xa20cv8q7fdj-gh-2.46.0"
+        },
+        "aarch64-linux": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/71ckv4vlahg0h5xrc384n1rh9f92kn7k-gh-2.46.0",
+              "default": true
+            }
+          ],
+          "store_path": "/nix/store/71ckv4vlahg0h5xrc384n1rh9f92kn7k-gh-2.46.0"
+        },
+        "x86_64-darwin": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/jfhaync1xvyigrk0gg3x5i6wqnabpbwy-gh-2.46.0",
+              "default": true
+            }
+          ],
+          "store_path": "/nix/store/jfhaync1xvyigrk0gg3x5i6wqnabpbwy-gh-2.46.0"
+        },
+        "x86_64-linux": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/pbz07yhi7rfr677b4jy97zvajmkpxyk2-gh-2.46.0",
+              "default": true
+            }
+          ],
+          "store_path": "/nix/store/pbz07yhi7rfr677b4jy97zvajmkpxyk2-gh-2.46.0"
+        }
+      }
+    },
+    "gojq@0": {
+      "last_modified": "2024-04-01T22:53:36-04:00",
+      "resolved": "github:NixOS/nixpkgs/080a4a27f206d07724b88da096e27ef63401a504#gojq",
+      "source": "devbox-search",
+      "version": "0.12.15",
+      "systems": {
+        "aarch64-darwin": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/n85srcaymmpbmy9ya2dgb03g1gsnw85n-gojq-0.12.15",
+              "default": true
+            }
+          ],
+          "store_path": "/nix/store/n85srcaymmpbmy9ya2dgb03g1gsnw85n-gojq-0.12.15"
+        },
+        "aarch64-linux": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/1vn0pzq8fxwvwlwdgj7j180i0x3vpcm4-gojq-0.12.15",
+              "default": true
+            }
+          ],
+          "store_path": "/nix/store/1vn0pzq8fxwvwlwdgj7j180i0x3vpcm4-gojq-0.12.15"
+        },
+        "x86_64-darwin": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/1aagyz08j358689qylfhzgc6dwxsjx8x-gojq-0.12.15",
+              "default": true
+            }
+          ],
+          "store_path": "/nix/store/1aagyz08j358689qylfhzgc6dwxsjx8x-gojq-0.12.15"
+        },
+        "x86_64-linux": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/jhfljx1v9qkzzhk6zs06zdzfpd3yg1d9-gojq-0.12.15",
+              "default": true
+            }
+          ],
+          "store_path": "/nix/store/jhfljx1v9qkzzhk6zs06zdzfpd3yg1d9-gojq-0.12.15"
+        }
+      }
+    },
+    "gomplate@3": {
+      "last_modified": "2024-03-22T07:26:23-04:00",
+      "resolved": "github:NixOS/nixpkgs/a3ed7406349a9335cb4c2a71369b697cecd9d351#gomplate",
+      "source": "devbox-search",
+      "version": "3.11.7",
+      "systems": {
+        "aarch64-darwin": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/0q5f69q896cxv0nm7w2zv4kr7qmgxl33-gomplate-3.11.7",
+              "default": true
+            }
+          ],
+          "store_path": "/nix/store/0q5f69q896cxv0nm7w2zv4kr7qmgxl33-gomplate-3.11.7"
+        },
+        "aarch64-linux": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/dwx86xs6w4k55s9h58jjqmwryhnbzmqp-gomplate-3.11.7",
+              "default": true
+            }
+          ],
+          "store_path": "/nix/store/dwx86xs6w4k55s9h58jjqmwryhnbzmqp-gomplate-3.11.7"
+        },
+        "x86_64-darwin": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/fiys7c3zw8r6469nfs369zkjiw34gb9p-gomplate-3.11.7",
+              "default": true
+            }
+          ],
+          "store_path": "/nix/store/fiys7c3zw8r6469nfs369zkjiw34gb9p-gomplate-3.11.7"
+        },
+        "x86_64-linux": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/hya29vsr9dmmxx8m05mip441qlfyyaq6-gomplate-3.11.7",
+              "default": true
+            }
+          ],
+          "store_path": "/nix/store/hya29vsr9dmmxx8m05mip441qlfyyaq6-gomplate-3.11.7"
+        }
+      }
+    },
+    "nodejs@20": {
+      "last_modified": "2024-03-22T11:26:23Z",
+      "plugin_version": "0.0.2",
+      "resolved": "github:NixOS/nixpkgs/a3ed7406349a9335cb4c2a71369b697cecd9d351#nodejs_20",
+      "source": "devbox-search",
+      "version": "20.11.1",
+      "systems": {
+        "aarch64-darwin": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/xjgg53kjjhwcx4p3dmywjmqjbv82xhyn-nodejs-20.11.1",
+              "default": true
+            },
+            {
+              "name": "libv8",
+              "path": "/nix/store/aq4aay71mvhbjnkni9rxjalnpnmmqrzc-nodejs-20.11.1-libv8"
+            }
+          ],
+          "store_path": "/nix/store/xjgg53kjjhwcx4p3dmywjmqjbv82xhyn-nodejs-20.11.1"
+        },
+        "aarch64-linux": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/v2a0w6001v9j9dzwcywjk7sj5djz6nmf-nodejs-20.11.1",
+              "default": true
+            },
+            {
+              "name": "libv8",
+              "path": "/nix/store/9g739av3wgvn5vfmagnw2snfmiqh95zc-nodejs-20.11.1-libv8"
+            }
+          ],
+          "store_path": "/nix/store/v2a0w6001v9j9dzwcywjk7sj5djz6nmf-nodejs-20.11.1"
+        },
+        "x86_64-darwin": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/00lahyvbxdb24226g6gfxr7dqwz7maii-nodejs-20.11.1",
+              "default": true
+            },
+            {
+              "name": "libv8",
+              "path": "/nix/store/vf2zx8s3lql9ky587gabp83mjn7s88cx-nodejs-20.11.1-libv8"
+            }
+          ],
+          "store_path": "/nix/store/00lahyvbxdb24226g6gfxr7dqwz7maii-nodejs-20.11.1"
+        },
+        "x86_64-linux": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/rlv9fcq70pniyrm3xy21wgk5rdhdh12h-nodejs-20.11.1",
+              "default": true
+            },
+            {
+              "name": "libv8",
+              "path": "/nix/store/77y1yf6i43bznwvqalhxz0l6kd68lqqn-nodejs-20.11.1-libv8"
+            }
+          ],
+          "store_path": "/nix/store/rlv9fcq70pniyrm3xy21wgk5rdhdh12h-nodejs-20.11.1"
+        }
+      }
+    }
+  }
+}

docs/docs/examples/actions/actionAttachmentExtractText.mdx

@@ -0,0 +1,12 @@
+---
+id: actionAttachmentExtractText
+title: attachment.extractText
+---
+// NOTE: Do not edit this auto-generated file!
+// Template: src/examples/_templates/docs.tmpl
+// Source: src/examples/actions/actionAttachmentExtractText.ts
+
+import { actionAttachmentExtractTextExample } from "../../../../src/examples/actions/actionAttachmentExtractText.ts"
+import RenderExample from "/src/components/RenderExample.tsx"
+
+<RenderExample path="src/examples/actions/actionAttachmentExtractText.ts" example={actionAttachmentExtractTextExample} />

docs/docs/examples/actions/actionExport.mdx

@@ -0,0 +1,12 @@
+---
+id: actionExport
+title: Export Thread/Message
+---
+// NOTE: Do not edit this auto-generated file!
+// Template: src/examples/_templates/docs.tmpl
+// Source: src/examples/actions/actionExport.ts
+
+import { actionExportExample } from "../../../../src/examples/actions/actionExport.ts"
+import RenderExample from "/src/components/RenderExample.tsx"
+
+<RenderExample path="src/examples/actions/actionExport.ts" example={actionExportExample} />

docs/docs/examples/actions/actionThreadRemoveLabel.mdx

@@ -0,0 +1,12 @@
+---
+id: actionThreadRemoveLabel
+title: thread.removeLabel
+---
+// NOTE: Do not edit this auto-generated file!
+// Template: src/examples/_templates/docs.tmpl
+// Source: src/examples/actions/actionThreadRemoveLabel.ts
+
+import { actionThreadRemoveLabelExample } from "../../../../src/examples/actions/actionThreadRemoveLabel.ts"
+import RenderExample from "/src/components/RenderExample.tsx"
+
+<RenderExample path="src/examples/actions/actionThreadRemoveLabel.ts" example={actionThreadRemoveLabelExample} />

docs/docs/examples/actions/index.mdx

@@ -0,0 +1,11 @@
+---
+id: actions
+sidebar_position: 36
+---
+import DocCardList from '@theme/DocCardList';
+
+# Actions
+
+These examples demonstrate the use of certain actions.
+
+<DocCardList />

docs/docs/examples/advanced/index.mdx

@@ -0,0 +1,11 @@
+---
+id: advanced
+sidebar_position: 36
+---
+import DocCardList from '@theme/DocCardList';
+
+# Advanced
+
+These examples demonstrate advanced features of Gmail Processor.
+
+<DocCardList />

docs/docs/examples/basics/index.mdx

@@ -0,0 +1,11 @@
+---
+id: basics
+sidebar_position: 32
+---
+import DocCardList from '@theme/DocCardList';
+
+# Basics
+
+These examples demonstrate basic functionality of Gmail Processor.
+
+<DocCardList />

docs/docs/examples/basics/simple.mdx

@@ -0,0 +1,12 @@
+---
+id: simple
+title: Simple
+---
+// NOTE: Do not edit this auto-generated file!
+// Template: src/examples/_templates/docs.tmpl
+// Source: src/examples/basics/simple.ts
+
+import { simpleExample } from "../../../../src/examples/basics/simple.ts"
+import RenderExample from "/src/components/RenderExample.tsx"
+
+<RenderExample path="src/examples/basics/simple.ts" example={simpleExample} />

docs/docs/examples/features/convertToGoogle.mdx

@@ -0,0 +1,12 @@
+---
+id: convertToGoogle
+title: Convert to Google
+---
+// NOTE: Do not edit this auto-generated file!
+// Template: src/examples/_templates/docs.tmpl
+// Source: src/examples/features/convertToGoogle.ts
+
+import { convertToGoogleExample } from "../../../../src/examples/features/convertToGoogle.ts"
+import RenderExample from "/src/components/RenderExample.tsx"
+
+<RenderExample path="src/examples/features/convertToGoogle.ts" example={convertToGoogleExample} />

docs/docs/examples/features/index.mdx

@@ -0,0 +1,11 @@
+---
+id: migration
+sidebar_position: 34
+---
+import DocCardList from '@theme/DocCardList';
+
+# Features
+
+These examples demonstrate different features of Gmail Processor.
+
+<DocCardList />