@sockethub/platform-dummy 3.0.0-alpha.3 → 3.0.0-alpha.6

package/README.md

@@ -1,3 +1,55 @@
 # @sockethub/platform-dummy
 
-A Sockethub test platform, not intended for actual use.
+A Sockethub test platform for development and testing purposes.
+
+## About
+
+This platform provides basic testing functionality for Sockethub development. It implements
+simple verbs that can be used to test ActivityStreams message flow, error handling, and
+platform communication without requiring external service connections.
+
+## Implemented Verbs (`@type`)
+
+* **echo** - Returns the received message unchanged
+* **fail** - Intentionally fails with an error message
+* **throw** - Throws an exception for testing error handling
+* **greet** - Returns a greeting message
+
+## Usage
+
+### Echo Example
+
+```json
+{
+  "@type": "echo",
+  "context": "dummy",
+  "actor": {
+    "@id": "test-user"
+  },
+  "object": {
+    "content": "Hello World"
+  }
+}
+```
+
+### Response
+
+```json
+{
+  "@type": "echo",
+  "context": "dummy",
+  "actor": {
+    "@id": "test-user"
+  },
+  "object": {
+    "content": "Hello World"
+  }
+}
+```
+
+## Use Cases
+
+* **Development testing**: Test ActivityStreams message processing
+* **Integration testing**: Verify platform loading and communication
+* **Error handling**: Test error scenarios and exception handling
+* **Learning**: Understand Sockethub platform structure and ActivityStreams format

package/package.json

@@ -1,32 +1,39 @@
 {
   "name": "@sockethub/platform-dummy",
   "description": "A sockethub platform dummy module",
-  "version": "3.0.0-alpha.3",
+  "version": "3.0.0-alpha.6",
+  "type": "module",
   "private": false,
   "author": "Nick Jennings <nick@silverbucket.net>",
   "license": "LGPL-3.0+",
-  "main": "index.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "src/index.ts",
+  "engines": {
+    "bun": ">=1.2"
+  },
   "keywords": [
     "sockethub",
     "dummy"
   ],
+  "devDependencies": {
+    "@sockethub/schemas": "3.0.0-alpha.6",
+    "@types/bun": "latest"
+  },
   "peerDependencies": {
-    "@sockethub/server": ">=5.0.0-alpha.2"
+    "@sockethub/server": "5.0.0-alpha.6"
   },
   "peerDependenciesMeta": {
     "@sockethub/server": {
       "optional": true
     }
   },
-  "scripts": {
-    "clean:deps": "npx rimraf node_modules",
-    "test": "exit 0"
-  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/sockethub/sockethub.git",
     "directory": "packages/platform-dummy"
   },
   "homepage": "https://github.com/sockethub/sockethub/tree/master/packages/platform-dummy",
-  "gitHead": "f02238a478b7ffd3f31d8deea292eb67e630a86b"
+  "gitHead": "f8a937e071e7a209f94b94f63e68faa27784e00e"
 }

package/src/index.ts

@@ -0,0 +1,74 @@
+import type {
+    ActivityStream,
+    Logger,
+    PlatformCallback,
+    PlatformInterface,
+    PlatformSchemaStruct,
+    PlatformSession,
+    StatelessPlatformConfig,
+} from "@sockethub/schemas";
+
+import packageJSON from "../package.json" with { type: "json" };
+
+interface DummyPlatformConfig extends StatelessPlatformConfig {
+    greeting: string;
+}
+
+export default class Dummy implements PlatformInterface {
+    debug: Logger;
+    config: DummyPlatformConfig = {
+        persist: false,
+        greeting: "Hello",
+    };
+
+    constructor(session: PlatformSession) {
+        this.debug = session.debug;
+    }
+
+    get schema(): PlatformSchemaStruct {
+        return {
+            name: "dummy",
+            version: packageJSON.version,
+            messages: {
+                required: ["type"],
+                properties: {
+                    type: {
+                        enum: ["echo", "fail", "throw", "greet"],
+                    },
+                },
+            },
+            credentials: {},
+        };
+    }
+
+    echo(job: ActivityStream, cb: PlatformCallback) {
+        job.target = job.actor;
+        job.actor = {
+            id: "dummy",
+            type: "platform",
+        };
+        cb(undefined, job);
+    }
+
+    fail(job: ActivityStream, cb: PlatformCallback) {
+        cb(new Error(job.object.content));
+    }
+
+    throw(job: ActivityStream, cb: PlatformCallback) {
+        throw new Error(job.object.content);
+    }
+
+    greet(job: ActivityStream, cb: PlatformCallback) {
+        job.target = job.actor;
+        job.actor = {
+            id: "dummy",
+            type: "platform",
+        };
+        job.object.content = `${this.config.greeting} ${job.object.content}`;
+        cb(undefined, job);
+    }
+
+    cleanup(cb: PlatformCallback) {
+        cb();
+    }
+}

package/index.js

@@ -1,46 +0,0 @@
-class Dummy {
-  constructor(cfg) {
-    cfg = (typeof cfg === 'object') ? cfg : {};
-    this.id = cfg.id;
-    this.debug = cfg.debug;
-    this.sendToClient = cfg.sendToClient;
-  }
-
-  get schema() {
-    return {
-      name: "dummy",
-      version: require('./package.json').version,
-      messages: {
-        "required": ["type"],
-        "properties": {
-          "type": {
-            "enum": ["echo", "fail"]
-          }
-        }
-      },
-      credentials: {}
-    };
-  }
-
-  get config() {
-    return {
-      persist: false,
-      requireCredentials: []
-    };
-  };
-
-  echo(job, cb) {
-    this.sendToClient(job.object.content);
-    cb();
-  };
-
-  fail(job, cb) {
-    cb(new Error(job.object.content));
-  };
-
-  cleanup(cb) {
-    cb();
-  };
-}
-
-module.exports = Dummy;