Merge pull request #1 from gentlementlegen/development

feat: query user command

.cspell.json

@@ -1,10 +1,10 @@
 {
   "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
   "version": "0.2",
-  "ignorePaths": ["**/*.json", "**/*.css", "node_modules", "**/*.log"],
+  "ignorePaths": ["**/*.json", "**/*.css", "node_modules", "**/*.log", "**/*.http", "**/*.toml"],
   "useGitignore": true,
   "language": "en",
-  "words": ["dataurl", "devpool", "outdir", "servedir"],
+  "words": ["dataurl", "devpool", "outdir", "servedir", "typebox", "supabase", "ubiquibot", "mswjs"],
   "dictionaries": ["typescript", "node", "software-terms"],
   "import": ["@cspell/dict-typescript/cspell-ext.json", "@cspell/dict-node/cspell-ext.json", "@cspell/dict-software-terms"],
   "ignoreRegExpList": ["[0-9a-fA-F]{6}"]

.dev.vars.example

@@ -0,0 +1,3 @@
+SUPABASE_URL=
+SUPABASE_KEY=
+GITHUB_TOKEN=

.eslintrc.js

@@ -9,7 +9,7 @@ module.exports = {
   },
   plugins: ["@typescript-eslint", "sonarjs", "filename-rules"],
   extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended", "plugin:sonarjs/recommended"],
-  ignorePatterns: ["**/*.js"],
+  ignorePatterns: ["**/*.js", "src/types/database.ts"],
   rules: {
     "filename-rules/match": [2, /^(e2e\.ts$|.*\/e2e\.ts$|[a-z]+(?:[-._a-z]+)*\.ts|\.[a-z]+)$/],
     "prefer-arrow-callback": ["warn", { allowNamedFunctions: true }],

.github/knip.ts

@@ -3,10 +3,10 @@ import type { KnipConfig } from "knip";
 const config: KnipConfig = {
   entry: ["build/index.ts"],
   project: ["src/**/*.ts"],
-  ignore: ["src/types/config.ts", "**/__mocks__/**", "**/__fixtures__/**"],
+  ignore: ["**/__mocks__/**", "**/__fixtures__/**", "src/types/database.ts"],
   ignoreExportsUsedInFile: true,
   // eslint can also be safely ignored as per the docs: https://knip.dev/guides/handling-issues#eslint--jest
-  ignoreDependencies: ["eslint-config-prettier", "eslint-plugin-prettier", "@types/jest", "@mswjs/data"],
+  ignoreDependencies: ["eslint-config-prettier", "eslint-plugin-prettier", "@types/jest"],
   eslint: true,
 };
 

.github/workflows/deploy.yml

@@ -1,26 +1,29 @@
 name: Deploy to Cloudflare Pages
 
 on:
-  workflow_run:
-    workflows: ["Build"]
-    types:
-      - completed
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+      - development
 
 jobs:
   deploy-to-cloudflare:
     name: Automatic Cloudflare Deploy
     runs-on: ubuntu-22.04
     steps:
-      - name: Deploy to Cloudflare
-        if: ${{ github.event.workflow_run.conclusion == 'success' }}
-        uses: ubiquity/cloudflare-deploy-action@main
+      - name: Setup Node
+        uses: actions/setup-node@v4
         with:
-          repository: ${{ github.repository }}
-          production_branch: ${{ github.event.repository.default_branch }}
-          build_artifact_name: "static"
-          output_directory: "static"
-          current_branch: ${{ github.event.workflow_run.head_branch }}
-          cloudflare_account_id: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
-          cloudflare_api_token: ${{ secrets.CLOUDFLARE_API_TOKEN }}
-          commit_sha: ${{ github.event.workflow_run.head_sha }}
-          workflow_run_id: ${{ github.event.workflow_run.id }}
+          node-version: "20"
+      - uses: actions/checkout@v4
+      - uses: cloudflare/wrangler-action@v3
+        with:
+          wranglerVersion: '3.57.0'
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          secrets: |
+            SUPABASE_URL
+            SUPABASE_KEY
+        env:
+          SUPABASE_URL: ${{ secrets.SUPABASE_URL }}
+          SUPABASE_KEY: ${{ secrets.SUPABASE_KEY }}

.github/workflows/knip-reporter.yml

@@ -0,0 +1,40 @@
+name: Knip-reporter
+
+on:
+  workflow_run:
+    workflows: ["Knip"]
+    types:
+      - completed
+
+permissions: write-all
+
+jobs:
+  knip-reporter:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: knip-results
+          run-id: ${{ github.event.workflow_run.id }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Read pr number
+        id: pr-number
+        uses: juliangruber/read-file-action@v1
+        with:
+          path: ./pr-number.txt
+          trim: true
+
+      - name: Report knip results to pull request
+        if: ${{ github.event.workflow_run.conclusion != 'success' }}
+        uses: gitcoindev/knip-reporter@main
+        with:
+          verbose: true
+          comment_id: ${{ github.workflow }}-reporter
+          command_script_name: knip-ci
+          annotations: true
+          ignore_results: false
+          json_input: true
+          json_input_file_name: knip-results.json
+          pull_request_number: ${{ steps.pr-number.outputs.content }}
+          token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/knip.yml

@@ -1,11 +1,9 @@
 name: Knip
 
 on:
-  pull_request_target:
+  pull_request:
   workflow_dispatch:
 
-permissions: write-all
-
 jobs:
   run-knip:
     runs-on: ubuntu-latest
@@ -21,11 +19,17 @@ jobs:
       - name: Install toolchain
         run: yarn install
 
-      - name: Report knip results to pull request
-        uses: Codex-/knip-reporter@v2
+      - name: Store PR number
+        run: echo ${{ github.event.number }} > pr-number.txt
+
+      - name: Run Knip
+        run: yarn knip || yarn knip --reporter json > knip-results.json
+
+      - name: Upload knip result
+        if: failure()
+        uses: actions/upload-artifact@v4
         with:
-          verbose: true
-          comment_id: ${{ github.workflow }}-reporter
-          command_script_name: knip-ci
-          annotations: true
-          ignore_results: false
+          name: knip-results
+          path: |
+            knip-results.json
+            pr-number.txt

.gitignore

@@ -11,3 +11,5 @@ static/dist
 coverage
 junit.xml
 cypress/screenshots
+.dev.vars
+/tests/http/http-client.private.env.json

README.md

@@ -1,28 +1,56 @@
-# `@ubiquity/ts-template`
+# `@ubiquibot/command-query-user`
 
-This template repository includes support for the following:
+This package helps users querying their information, from they wallet address, label access control or current XP.
 
-- TypeScript
-- Environment Variables
-- Conventional Commits
-- Automatic deployment to Cloudflare Pages
+## Usage
 
-## Testing
+The following commands are allowed:
 
-### Cypress
+```shell
+/query @user
+```
 
-To test with Cypress Studio UI, run
+## Running locally
+### Supabase types
+You can run the type generations against a local database with
+```shell
+yarn supabase:generate:local
+```
+Or against an instance by setting the `SUPABASE_ACCESS_TOKEN` and `SUPABASE_PROJECT_ID` in your `.env` file
+```shell
+yarn prebuild
+```
 
+### Worker
+Start the Worker by running
 ```shell
-yarn cy:open
+yarn dev
 ```
 
-Otherwise to simply run the tests through the console, run
+### Make requests
+To trigger the worker, `POST` requests should be made to http://localhost:4000 with a `Content-Type: application/json`
+header and a body looking like
+```json
+{
+  "stateId": "",
+  "eventName": "",
+  "eventPayload": "",
+  "settings": "",
+  "ref": ""
+}
+```
+For convenience, you can find an `.http` file with a valid request [here](/tests/http/request.http).
 
-```shell
-yarn cy:run
+## Configuration
+A valid configuration can be like:
+
+```yaml
+- plugin: https://ubiquibot-command-query-user.ubq.fi
+  with:
+    allowPublicQuery: true
 ```
 
+## Testing
 ### Jest
 
 To start Jest tests, run