feat: task queues, email support, and multiprocessing (#21)

Author: eveffer

.gitignore

@@ -3,3 +3,5 @@ deno.lock
 cloud-config.json
 pgdata/
 debug.log
+.zed/
+.vscode/

.zed/settings.json

@@ -4,6 +4,21 @@
       "settings": {
         "deno": {
           "enable": true,
+          "suggest": {
+            "completeFunctionCalls": true,
+            "names": {
+              "enabled": true
+            },
+            "paths": {
+              "enabled": true
+            },
+            "autoImports": {
+              "enabled": true
+            },
+            "imports": {
+              "autoDiscover": true
+            }
+          },
           "inlayHints": {
             "parameterNames": {
               "enabled": "all"
@@ -28,7 +43,6 @@
       }
     }
   },
-
   "languages": {
     "TypeScript": {
       "language_servers": ["deno"],

.zed/tasks.json

@@ -1,14 +1,7 @@
 [
   {
     "command": "deno",
-    "args": [
-      "run",
-      "-A",
-      "--watch",
-      "--watch-exclude=.inspatial",
-      "--unstable-broadcast-channel",
-      "mainApp.ts"
-    ],
+    "args": ["run", "-A", "--watch", "--watch-exclude=.inspatial", "main.ts"],
     "cwd": "$ZED_WORKTREE_ROOT/examples/basic",
     "label": "Example: Basic",
     "allow_concurrent_runs": false,

README.md

@@ -80,8 +80,11 @@ universal and spatial (AR/MR/VR) applications.
 Some of the key features include:
 
 - **InSpatialORM**: An easy-to-use advanced ORM for PostgreSQL
+- **InDB**: An embedded database for local development (no need to install
+  PostgreSQL locally!)
 - **Authentication**: Built-in authentication and authorization out of the box
 - **InLive**: Real-time data streaming and synchronization over WebSockets
+- **InQueue**: A task queue system for background processing
 - **CloudAPI**: A powerful API that is easy to use and extend. Includes built in
   request validation and authentication
 - **InCache**: A powerful caching layer for your data
@@ -120,19 +123,12 @@ InSpatial Cloud is released under the Apache 2.0 License. See the
 ### Pre-requisites
 
 - Deno
-- PostgreSQL
-
-> Note: You'll need to create a Postgres database first:
-
-```bash
-createdb mydb
-```
 
 ### Installation
 
 Add the InSpatial Cloud module to your Deno project using the following command:
 
-```bash
+```shell
 deno add jsr:@inspatial/cloud
 ```
 
@@ -141,31 +137,17 @@ deno add jsr:@inspatial/cloud
 ### Basic Usage
 
 ```ts
-import { InCloud } from "@inspatial/cloud";
-
-const app = new InCloud("myApp");
+import { createInCloud } from "@inspatial/cloud";
 
-if (import.meta.main) {
-  app.run();
-}
+createInCloud();
 ```
 
-Now you can run the app:
+That's it! Now you can run the app:
 
-```bash
+```shell
 deno run -A main.ts
 ```
 
 You can verify the app is running by pinging the API endpoint in you browser:
 
 [http://localhost:8000/api?group=api&action=ping](http://localhost:8000/api?group=api&action=ping)
-
-You should see the following response:
-
-```json
-{
-  "message": "pong",
-  "timestamp": 1745065012205,
-  "app": "myApp"
-}
-```

deno.json

@@ -1,12 +1,13 @@
 {
   "name": "@inspatial/cloud",
-  "version": "0.2.3",
+  "version": "0.3.0",
   "license": "Apache-2.0",
   "exports": {
     ".": "./mod.ts",
     "./extensions": "./extensions/mod.ts",
     "./types": "./types.ts"
   },
+
   "publish": {
     "include": [
       "src/",
@@ -21,19 +22,26 @@
     ],
     "exclude": [".github/", ".vscode/", ".zed/", "examples/**/.inspatial/"]
   },
-
   "imports": {
-    "#/": "./src/",
+    "/": "./src/",
+    "./": "./",
+    "#orm/": "./src/orm/",
+    "#utils/": "./src/utils/",
+    "#terminal/": "./src/terminal/",
+    "#queue/": "./src/in-queue/",
     "#extensions/": "./extensions/",
-    "#types/": "./src/types/"
+    "#types/": "./src/types/",
+    "#inLog": "./src/in-log/in-log.ts"
   },
   "tasks": {
     "check": "deno publish --dry-run",
-    "type-check": "deno check --all mod.ts"
+    "type-check": "deno check --all mod.ts",
+    "example:tasks": "cd examples/task-queue && deno run -A --unstable-broadcast-channel run.ts",
+    "example:tasks-queue": "cd examples/task-queue && deno run -A --unstable-broadcast-channel queue.ts"
   },
+  "scopes": {},
   "lint": {
     "rules": {
-      "tags": [],
       "include": ["verbatim-module-syntax"],
       "exclude": ["no-explicit-any"]
     }

examples/basic/main.ts

@@ -0,0 +1,18 @@
+import { createInCloud } from "@inspatial/cloud";
+import { EntryType } from "/orm/mod.ts";
+
+createInCloud({
+  name: "myAwesomeCloud",
+  entryTypes: [
+    new EntryType("thing", {
+      fields: [],
+      actions: [{
+        key: "yo",
+        params: [],
+        action() {
+          console.log("Hello from the cloud!");
+        },
+      }],
+    }),
+  ],
+});

examples/basic/mainApp.ts

@@ -1,5 +1,5 @@
 import { EntryType } from "@inspatial/cloud";
-import { ChildEntryType } from "#/orm/child-entry/child-entry.ts";
+import { ChildEntryType } from "/orm/child-entry/child-entry.ts";
 
 export const customerAccount = new EntryType("customerAccount", {
   label: "Customer Account",

examples/crm/crmExtension.ts

@@ -1,7 +1,9 @@
-import { InCloud } from "@inspatial/cloud";
-import crmExtension from "./crmExtension.ts";
+import { createInCloud } from "@inspatial/cloud";
+import customerAccount from "./entryTypes/customerAccount.ts";
 
-const app = new InCloud("myCRM", {
-  extensions: [crmExtension],
+createInCloud({
+  name: "CRM",
+  description: "Customer Relationship Management",
+  version: "1.0.0",
+  entryTypes: [customerAccount],
 });
-app.run();