ep_email_notifications 0.1.36 → 10.0.2

package/client.js

@@ -1,7 +1,7 @@
 'use strict';
 
 const eejs = require('ep_etherpad-lite/node/eejs');
-const settings = require('ep_etherpad-lite/node/utils/Settings');
+import settings from 'ep_etherpad-lite/node/utils/Settings'
 
 exports.eejsBlock_mySettings = (hookName, args, cb) => {
   args.content += eejs.require('ep_email_notifications/templates/email_notifications_settings.ejs');

package/handleMessage.js

@@ -3,7 +3,7 @@
 const db = require('ep_etherpad-lite/node/db/DB');
 const email = require('emailjs');
 const randomString = require('ep_etherpad-lite/static/js/pad_utils').randomString;
-const settings = require('ep_etherpad-lite/node/utils/Settings');
+import settings from 'ep_etherpad-lite/node/utils/Settings'
 const util = require('util');
 const validator = require('validator');
 

package/index.js

@@ -2,7 +2,7 @@
 
 const db = require('ep_etherpad-lite/node/db/DB');
 const fs = require('fs').promises;
-const settings = require('ep_etherpad-lite/node/utils/Settings');
+import settings from 'ep_etherpad-lite/node/utils/Settings'
 
 // Remove cache for this procedure
 db.db.dbSettings.cache = 0;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "ep_email_notifications",
   "description": "Subscribe to a pad and receive an email when someone edits your pad",
-  "version": "0.1.36",
+  "version": "10.0.2",
   "author": {
     "name": "John Mclear",
     "email": "john@mclear.co.uk",
@@ -19,11 +19,11 @@
     "validator": "13.7.0"
   },
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=20.0.0"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/JohnMcLear/ep_email_notifications.git"
+    "url": "https://github.com/ether/ether-plugins.git"
   },
   "readme": "# Description\nThis plugin allows users to subscribe to pads and receive email updates when a pad is being modified.  You can modify the frequency.  This plugin is very much in alpha stage and has a lot of things TODO (See TODO).\n\n# Installation\nMake sure an SMTP gateway is installed IE postfix\nConfigure SPF and RDNS records to ensure proper mail flow <-- Search online\nCopy/Edit the below to your settings.json\nConnect to a pad, Click on the Share/Embed link and enter in your email address.\nOpen that pad in ANOTHER BROWSER then begin modifying, you should receive an email when the pad has begun editing and once the pad has gone stale (when everyone stops editing it and a time period passes).\nNOTE: You will NOT receive an email if you(the author that registered their email) are currently on or editing that pad!\n\n```\n \"ep_email_notifications\" : {\n    checkFrequency: 6000, // checkFrequency = How frequently(milliseconds) to check for pad updates -- Move me to the settings file\n    staleTime: 30000,  // staleTime = How stale(milliseconds) does a pad need to be before notifying subscribers?  Move me to settings\n    fromName: \"Etherpad SETTINGS FILE!\",\n    fromEmail: \"pad@etherpad.org\",\n    urlToPads: \"http://beta.etherpad.org/p/\", // urlToPads = The URL to your pads note the trailing /\n    emailServer: { // See https://github.com/eleith/emailjs for settings\n      host: \"127.0.0.1\"\n    }\n  }\n```\n\n# TODO\n* Clean up all code\n\n# FUTURE VERSIONS TODO\n* v2 - Get the modified contents from the API HTML diff and append that to the Email and make the email from the server HTML not plain text\n* v2 - a point to unsubscribe and validate/verify email https://github.com/alfredwesterveld/node-email-verification\n* v2 - Keep a record of when a user was last on a pad\n",
   "readmeFilename": "README.md",
@@ -36,10 +36,14 @@
     "url": "https://etherpad.org/"
   },
   "devDependencies": {
-    "eslint": "^8.57.0",
+    "eslint": "^9.24.0",
     "eslint-config-etherpad": "^4.0.4",
-    "typescript": "^5.4.2"
+    "typescript": "^5.4.3"
   },
+  "bugs": {
+    "url": "https://github.com/ether/ether-plugins/issues"
+  },
+  "homepage": "https://github.com/ether/ether-plugins/tree/main/ep_email_notifications#readme",
   "scripts": {
     "lint": "eslint .",
     "lint:fix": "eslint --fix ."

package/update.js

@@ -5,7 +5,7 @@
 const db = require('ep_etherpad-lite/node/db/DB');
 const API = require('ep_etherpad-lite/node/db/API.js');
 const email = require('emailjs');
-const settings = require('ep_etherpad-lite/node/utils/Settings');
+import settings from 'ep_etherpad-lite/node/utils/Settings'
 const util = require('util');
 
 const SMTPClient = email.SMTPClient;

package/.github/dependabot.yml

@@ -1,11 +0,0 @@
-version: 2
-updates:
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule:
-      interval: "daily"
-  - package-ecosystem: "npm"
-    directory: "/"
-    schedule:
-      interval: "daily"
-    versioning-strategy: "increase"

package/.github/workflows/backend-tests.yml

@@ -1,92 +0,0 @@
-name: Backend Tests
-
-# any branch is useful for testing before a PR is submitted
-on:
-  workflow_call:
-
-jobs:
-  withplugins:
-    # run on pushes to any branch
-    # run on PRs from external forks
-    if: |
-      (github.event_name != 'pull_request')
-      || (github.event.pull_request.head.repo.id != github.event.pull_request.base.repo.id)
-    name: with Plugins
-    runs-on: ubuntu-latest
-    steps:
-      -
-        name: Install libreoffice
-        uses: awalsh128/cache-apt-pkgs-action@v1.4.2
-        with:
-          packages: libreoffice libreoffice-pdfimport
-          version: 1.0
-      -
-        name: Install etherpad core
-        uses: actions/checkout@v3
-        with:
-          repository: ether/etherpad-lite
-          path: etherpad-lite
-      - uses: pnpm/action-setup@v3
-        name: Install pnpm
-        with:
-          version: 8
-          run_install: false
-      - name: Get pnpm store directory
-        shell: bash
-        run: |
-          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
-      - uses: actions/cache@v4
-        name: Setup pnpm cache
-        with:
-          path: ${{ env.STORE_PATH }}
-          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
-          restore-keys: |
-            ${{ runner.os }}-pnpm-store-
-      -
-        name: Checkout plugin repository
-        uses: actions/checkout@v3
-        with:
-          path: plugin
-      -
-        name: Determine plugin name
-        id: plugin_name
-        working-directory: ./plugin
-        run: |
-          npx -c 'printf %s\\n "::set-output name=plugin_name::${npm_package_name}"'
-      -
-        name: Link plugin directory
-        working-directory: ./plugin
-        run: |
-          pnpm link --global
-      - name: Remove tests
-        working-directory: ./etherpad-lite
-        run: rm -rf ./src/tests/backend/specs
-      -
-        name: Install Etherpad core dependencies
-        working-directory: ./etherpad-lite
-        run: bin/installDeps.sh
-      - name: Link plugin to etherpad-lite
-        working-directory: ./etherpad-lite
-        run: |
-          pnpm link --global $PLUGIN_NAME
-          pnpm run install-plugins --path  ../../plugin
-        env:
-          PLUGIN_NAME: ${{ steps.plugin_name.outputs.plugin_name }}
-      - name: Link ep_etherpad-lite
-        working-directory: ./etherpad-lite/src
-        run: |
-          pnpm link --global
-      - name: Link etherpad to plugin
-        working-directory: ./plugin
-        run: |
-          pnpm link --global ep_etherpad-lite
-      -
-        name: Run the backend tests
-        working-directory: ./etherpad-lite
-        run: |
-          res=$(find .. -path "./node_modules/ep_*/static/tests/backend/specs/**" | wc -l)
-          if [ $res -eq 0 ]; then
-          echo "No backend tests found"
-          else
-          pnpm run test
-          fi

package/.github/workflows/frontend-tests.yml

@@ -1,94 +0,0 @@
-# Publicly credit Sauce Labs because they generously support open source
-# projects.
-name: Frontend Tests
-
-on:
-  workflow_call:
-
-jobs:
-  test-frontend:
-    runs-on: ubuntu-latest
-
-    steps:
-      -
-        name: Check out Etherpad core
-        uses: actions/checkout@v3
-        with:
-          repository: ether/etherpad-lite
-      - uses: pnpm/action-setup@v3
-        name: Install pnpm
-        with:
-          version: 8
-          run_install: false
-      - name: Get pnpm store directory
-        shell: bash
-        run: |
-          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
-      - uses: actions/cache@v4
-        name: Setup pnpm cache
-        with:
-          path: ${{ env.STORE_PATH }}
-          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
-          restore-keys: |
-            ${{ runner.os }}-pnpm-store-
-      -
-        name: Check out the plugin
-        uses: actions/checkout@v3
-        with:
-          path: ./node_modules/__tmp
-      -
-        name: export GIT_HASH to env
-        id: environment
-        run: |
-          cd ./node_modules/__tmp
-          echo "::set-output name=sha_short::$(git rev-parse --short ${{ github.sha }})"
-      -
-        name: Determine plugin name
-        id: plugin_name
-        run: |
-          cd ./node_modules/__tmp
-          npx -c 'printf %s\\n "::set-output name=plugin_name::${npm_package_name}"'
-      -
-        name: Rename plugin directory
-        env:
-          PLUGIN_NAME: ${{ steps.plugin_name.outputs.plugin_name }}
-        run: |
-          mv ./node_modules/__tmp ./node_modules/"${PLUGIN_NAME}"
-      -
-        name: Install plugin dependencies
-        env:
-          PLUGIN_NAME: ${{ steps.plugin_name.outputs.plugin_name }}
-        run: |
-          cd ./node_modules/"${PLUGIN_NAME}"
-          pnpm i
-      # Etherpad core dependencies must be installed after installing the
-      # plugin's dependencies, otherwise npm will try to hoist common
-      # dependencies by removing them from src/node_modules and installing them
-      # in the top-level node_modules. As of v6.14.10, npm's hoist logic appears
-      # to be buggy, because it sometimes removes dependencies from
-      # src/node_modules but fails to add them to the top-level node_modules.
-      # Even if npm correctly hoists the dependencies, the hoisting seems to
-      # confuse tools such as `npm outdated`, `npm update`, and some ESLint
-      # rules.
-      -
-        name: Install Etherpad core dependencies
-        run: bin/installDeps.sh
-      - name: Create settings.json
-        run: cp ./src/tests/settings.json settings.json
-      - name: Run the frontend tests
-        shell: bash
-        run: |
-          pnpm run dev &
-          connected=false
-          can_connect() {
-          curl -sSfo /dev/null http://localhost:9001/ || return 1
-          connected=true
-          }
-          now() { date +%s; }
-          start=$(now)
-          while [ $(($(now) - $start)) -le 15 ] && ! can_connect; do
-          sleep 1
-          done
-          cd src
-          pnpm exec playwright install chromium  --with-deps
-          pnpm run test-ui --project=chromium

package/.github/workflows/npmpublish.yml

@@ -1,74 +0,0 @@
-# This workflow will run tests using node and then publish a package to the npm registry when a release is created
-# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
-
-name: Node.js Package
-
-on:
-  workflow_call:
-
-jobs:
-  publish-npm:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          registry-url: https://registry.npmjs.org/
-      - name: Check out Etherpad core
-        uses: actions/checkout@v3
-        with:
-          repository: ether/etherpad-lite
-      - uses: pnpm/action-setup@v3
-        name: Install pnpm
-        with:
-          version: 8
-          run_install: false
-      - name: Get pnpm store directory
-        shell: bash
-        run: |
-          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
-      - uses: actions/cache@v4
-        name: Setup pnpm cache
-        with:
-          path: ${{ env.STORE_PATH }}
-          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
-          restore-keys: |
-            ${{ runner.os }}-pnpm-store-
-      -
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-      -
-        name: Bump version (patch)
-        run: |
-          LATEST_TAG=$(git describe --tags --abbrev=0) || exit 1
-          NEW_COMMITS=$(git rev-list --count "${LATEST_TAG}"..) || exit 1
-          [ "${NEW_COMMITS}" -gt 0 ] || exit 0
-          git config user.name 'github-actions[bot]'
-          git config user.email '41898282+github-actions[bot]@users.noreply.github.com'
-          pnpm i
-          pnpm version patch
-          git push --follow-tags
-      # This is required if the package has a prepare script that uses something
-      # in dependencies or devDependencies.
-      -
-        run: pnpm i
-      # `npm publish` must come after `git push` otherwise there is a race
-      # condition: If two PRs are merged back-to-back then master/main will be
-      # updated with the commits from the second PR before the first PR's
-      # workflow has a chance to push the commit generated by `npm version
-      # patch`. This causes the first PR's `git push` step to fail after the
-      # package has already been published, which in turn will cause all future
-      # workflow runs to fail because they will all attempt to use the same
-      # already-used version number. By running `npm publish` after `git push`,
-      # back-to-back merges will cause the first merge's workflow to fail but
-      # the second's will succeed.
-      -
-        run: pnpm publish
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
-      #-
-      #  name: Add package to etherpad organization
-      #  run: pnpm access grant read-write etherpad:developers
-      #  env:
-      #    NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

package/.github/workflows/test-and-release.yml

@@ -1,18 +0,0 @@
-name: Node.js Package
-on: [push]
-
-
-jobs:
-  backend:
-    uses: ./.github/workflows/backend-tests.yml
-    secrets: inherit
-  frontend:
-    uses: ./.github/workflows/frontend-tests.yml
-    secrets: inherit
-  release:
-    if: ${{ github.ref == 'refs/heads/master' || github.ref == 'refs/heads/main' }}
-    needs:
-      - backend
-      - frontend
-    uses: ./.github/workflows/npmpublish.yml
-    secrets: inherit