Merge pull request #2 from LemmyNet/typescript_push_webhook

Add typescript_push_webhook plugin

Author: Nutomic

.gitignore

@@ -3,11 +3,13 @@
 .vscode
 
 # tests
-tests/node_modules
+**/node_modules
+plugins/typescript_push_webhook/dist
 tests/.yalc
 tests/yalc.lock
 tests/pict-rs
 tests/log
 
 # lemmy plugins
 *.wasm
+

.woodpecker.yml

@@ -3,16 +3,39 @@ steps:
     image: tmknom/prettier:3.2.5
     commands:
       - prettier -c .
+    when:
+      - event: pull_request
+
+  build_typescript_plugin:
+    # need to use ubuntu instead of debian because extism-js requires newer glibc version
+    # https://github.com/extism/js-pdk/issues/129
+    image: ubuntu
+    commands:
+      - apt-get update && apt-get install -y --no-install-recommends --no-install-suggests node-typescript wget gzip ca-certificates npm
+      - wget --quiet https://github.com/extism/js-pdk/releases/download/v1.4.0/extism-js-x86_64-linux-v1.4.0.gz -O extism-js.gz
+      - gzip -d extism-js.gz
+      - chmod +x extism-js
+      - mv extism-js /usr/local/bin/
+      # for wasm-merge, version in ubuntu repo is too old
+      - wget --quiet https://github.com/WebAssembly/binaryen/releases/download/version_122/binaryen-version_122-x86_64-linux.tar.gz -O binaryen.tar.gz
+      - tar -xvzf binaryen.tar.gz
+      - mv binaryen-version_122/bin/* /usr/local/bin/
+      - cd plugins/typescript_push_webhook
+      - npm install
+      - npm run build
+    when:
+      - event: [pull_request, tag]
 
-  build_go_plugins:
+  build_go_plugin:
     image: tinygo/tinygo:latest
     backend_options:
       docker:
         user: 0:0
     commands:
       - cd plugins/go_replace_words
       - tinygo build -o ../go_replace_words.wasm -target wasip1 -buildmode=c-shared main.go
-      - cd -
+    when:
+      - event: [pull_request, tag]
 
   run_plugin_tests:
     image: node:22-bookworm-slim
@@ -30,12 +53,15 @@ steps:
       - cd tests/
       - pnpm i
       - pnpm test
+    when:
+      - event: pull_request
 
   publish_plugins:
     image: woodpeckerci/plugin-release
     settings:
       files:
         - plugins/go_replace_words.wasm
+        - plugins/typescript_push_webhook.wasm
       title: ${CI_COMMIT_TAG##v}
       api-key:
         from_secret: github_token

README.md

@@ -2,12 +2,33 @@
 
 This repository contains various example plugins for Lemmy. See the [Extism documentation](https://extism.org/docs/quickstart/plugin-quickstart) for details on how to write plugins. Lemmy-specific details and available hooks are [described in the RFC](https://github.com/LemmyNet/rfcs/pull/8/files).
 
-## Contributing
+## Go: Replace Words
 
-- Install `go`, tinygo`, `pnpm`, `postgresql`
-- `cd tests`
-- `./run.sh` to start test cases
+Uses the `create_local_post` hook to listen for newly created posts, replacing some words and rejecting posts containing specific terms. See [go-pdk readme](https://github.com/extism/go-pdk#readme) for detailed documentation.
 
-## Available Examples
+Use the following steps to compile it:
 
-- `go_replace_words` Written in Go, uses `create_local_post` hook to replace specific words in post title, and reject posts with forbidden words in title
+```bash
+apt install go
+# install tinygo: https://tinygo.org/getting-started/install/linux/
+cd plugins/go_replace_words
+tinygo build -o ../go_replace_words.wasm -target wasip1 -buildmode=c-shared main.go
+```
+
+## Typescript: Push Webhook
+
+Listens to `new_post` hook which is called after any local or remote post is created. Then calls the url configured in the [manifest](https://extism.org/docs/concepts/manifest/) (`plugins/typescript_push_webhook.json`) with the post's `ap_id`. See [js-pdk readme](https://github.com/extism/js-pdk#readme) for setup and detailed documentation.
+
+Use the following steps to compile it:
+
+```bash
+apt install npm typescript
+# use steps in js-pdk readme to install extism-js
+cd plugins/typescript_push_webhook
+npm install
+npm run build
+```
+
+## Tests
+
+This repository contains test cases for the plugins. To run them install `pnpm` and `postgresql`, with a database `postgres://lemmy:password@localhost:5432/lemmy`. Then go into `tests` folder and execute `./run.sh`.

lemmy_server

@@ -0,0 +1,11 @@
+{
+  "wasm": [
+    {
+      "path": "plugins/typescript_push_webhook.wasm"
+    }
+  ],
+  "allowed_hosts": ["127.0.0.1"],
+  "config": {
+    "notify_url": "http://127.0.0.1:8927"
+  }
+}

plugins/typescript_push_webhook.json

@@ -0,0 +1,11 @@
+const esbuild = require("esbuild");
+
+esbuild.build({
+  entryPoints: ["src/index.ts"],
+  outdir: "dist",
+  bundle: true,
+  sourcemap: true,
+  minify: false, // might want to use true for production build
+  format: "cjs", // needs to be CJS for now
+  target: ["es2020"], // don't go over es2020 because quickjs doesn't support it
+});