feat: migrate project to typescript

.eslintrc.js → .eslintrc.cjs

@@ -2,7 +2,6 @@ module.exports = {
   env: {
     node: true,
     es2021: true,
-    jest: true,
   },
   extends: ['eslint:recommended'],
   parserOptions: {

.github/workflows/lint.yml

@@ -0,0 +1,28 @@
+name: Lint
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [20.x, 22.x]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'npm'
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Lint
+        run: |
+          npm run lint
+          npm run format -- --check

.github/workflows/test.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [20.x]
+        node-version: [20.x, 22.x]
     steps:
       - uses: actions/checkout@v4
       - name: Use Node.js ${{ matrix.node-version }}
@@ -25,11 +25,6 @@ jobs:
           sudo apt-get install -y libgbm-dev jq xvfb
           npm ci
 
-      - name: Lint
-        run: |
-          npm run lint
-          npm run format -- --check
-
       - name: Install Chrome
         uses: browser-actions/setup-chrome@latest
         with:
@@ -38,7 +33,7 @@ jobs:
       - name: Run tests with mocks
         run: |
           # Run tests with coverage and capture results in JSON format
-          npm test -- --coverage-reporters=lcov --coverage-reporters=json-summary --json --outputFile=test-results.json
+          npm test -- --coverage.reporter=lcov --coverage.reporter=json-summary --reporter=json --outputFile.json=test-results.json
 
           # Extract coverage and test results
           {
@@ -70,13 +65,13 @@ jobs:
       - name: Upload coverage report
         uses: actions/upload-artifact@v4
         with:
-          name: coverage-report
+          name: coverage-report-${{ matrix.node-version }}
           path: coverage/
 
       - name: Run visual tests
         run: |
           mkdir -p __image_snapshots__
-          CHROME_PATH="$(which chrome)" xvfb-run --auto-servernum --server-args="-screen 0 1280x800x24" npm run test:visual:ci -- -u --json --outputFile=visual-test-results.json
+          CHROME_PATH="$(which chrome)" xvfb-run --auto-servernum --server-args="-screen 0 1280x800x24" npm run test:visual:ci -- --update --reporter=json --outputFile.json=visual-test-results.json
 
           # Show test results and screenshots
           {
@@ -111,5 +106,5 @@ jobs:
         if: always()
         uses: actions/upload-artifact@v4
         with:
-          name: screenshots
+          name: screenshots-${{ matrix.node-version }}
           path: artifacts/

.github/workflows/zapier-release.yml

@@ -44,4 +44,4 @@ jobs:
       - name: Deploy to Zapier
         env:
           ZAPIER_DEPLOY_KEY: ${{ secrets.ZAPIER_DEPLOY_KEY }}
-        run: zapier push
+        run: npm run build && zapier push

.gitignore

@@ -1,6 +1,10 @@
 # Dependencies
 node_modules/
 
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/
+dist/
+
 # Zapier build files
 .zapierapprc
 build/

docs/developer-documentation.md

@@ -55,7 +55,7 @@ The project uses several tools to ensure code quality:
 
 - **ESLint** - For code linting
 - **Prettier** - For code formatting
-- **Jest** - For testing
+- **Vitest** - For testing
 - **Husky** - For git hooks
 - **lint-staged** - For running checks on staged files
 - **markdownlint** - For markdown formatting
@@ -142,6 +142,14 @@ These tests are skipped locally to avoid environment-specific issues.
 
 ## Deployment
 
+Compile the TypeScript code so that JavaScript code will be generated:
+
+```
+npm run build
+```
+
+The command will create a new folder called `dist/`, which is referenced by `index.js`.
+
 The integration is automatically deployed to Zapier when a new version tag is pushed to GitHub.
 
 1. Create and push a new version tag:

index.js

@@ -1,57 +1 @@
-const uploadAsset = require('./actions/upload-asset');
-const schedulePlaylistItem = require('./actions/schedule-playlist-item');
-const assignScreenToPlaylist = require('./actions/assign-screen-to-playlist');
-const completeWorkflow = require('./actions/complete-workflow');
-const cleanupZapierContent = require('./actions/cleanup-zapier-content');
-
-const { getScreens } = require('./triggers/get-screens');
-const { getPlaylists } = require('./triggers/get-playlists');
-const { getAssets } = require('./triggers/get-assets');
-
-// Authentication setup
-const authentication = {
-  type: 'custom',
-  test: {
-    headers: {
-      Authorization: 'Token {{bundle.authData.api_key}}',
-    },
-    url: 'https://api.screenlyapp.com/api/v4/assets/',
-    method: 'GET',
-  },
-  fields: [
-    {
-      key: 'api_key',
-      type: 'string',
-      required: true,
-      label: 'API Key',
-      helpText:
-        'See [this page](https://support.screenly.io/hc/en-us/articles/35897560148371-How-to-Generate-a-Screenly-API-Token) for a guide on how to generate an API key for your Screenly account.',
-    },
-  ],
-};
-
-// Export the app definition
-module.exports = {
-  version: require('./package.json').version,
-  platformVersion: require('zapier-platform-core').version,
-
-  authentication,
-
-  triggers: {
-    [getScreens.key]: getScreens,
-    [getPlaylists.key]: getPlaylists,
-    [getAssets.key]: getAssets,
-  },
-
-  creates: {
-    [uploadAsset.key]: uploadAsset,
-    [schedulePlaylistItem.key]: schedulePlaylistItem,
-    [assignScreenToPlaylist.key]: assignScreenToPlaylist,
-    [completeWorkflow.key]: completeWorkflow,
-    [cleanupZapierContent.key]: cleanupZapierContent,
-  },
-
-  searches: {},
-
-  resources: {},
-};
+module.exports = require('./dist').default;