Merge pull request #41 from supabase/rc

feat: Release V2

Author: alaister

.github/workflows/docs.yml

@@ -14,22 +14,22 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        node: ['14']
+        node: ['18']
 
     runs-on: ${{ matrix.os }}
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Set up Node
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node }}
 
       - run: |
           npm ci
-          npm run v1:docs
-          npm run v1:docs:json
+          npm run docs
+          npm run docs:json
 
       - name: Publish
         uses: peaceiris/actions-gh-pages@v3

.github/workflows/release.yml

@@ -13,15 +13,15 @@ jobs:
     name: Release / Node ${{ matrix.node }}
     strategy:
       matrix:
-        node: ['14']
+        node: ['18']
 
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Set up Node
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node }}
 

.github/workflows/tests.yml

@@ -0,0 +1,33 @@
+name: Tests
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+      - rc
+  workflow_dispatch:
+
+jobs:
+  autotests:
+    name: Run tests
+    strategy:
+      matrix:
+        node: ['18']
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node }}
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run Test
+        run: npm run test
+        continue-on-error: true

.gitignore

@@ -103,3 +103,13 @@ dist
 
 # TernJS port file
 .tern-port
+
+# Generated docs
+docs/v2
+
+# Test reports
+allure-results
+allure-report
+
+# IDE specific
+.vscode

README.md

@@ -1,3 +1,19 @@
 # `functions-js`
 
-JS Client library to interact with Supabase Edge Functions.
+JS Client library to interact with Supabase Functions.
+
+## Docs
+https://supabase.github.io/functions-js/index.html
+
+## testing
+
+To run tests you will need Node 18+.
+
+You are going to need docker daemon running to execute tests.
+
+To start test run use the following command:
+
+```sh
+npm i
+npm run test
+```

jest.config.ts

@@ -0,0 +1,20 @@
+import type { Config } from '@jest/types'
+
+const config: Config.InitialOptions = {
+  preset: 'ts-jest',
+  transform: {
+    '^.+\\.ts?$': 'ts-jest',
+  },
+  moduleFileExtensions: ['ts', 'js', 'cjs', 'json', 'node'],
+  setupFilesAfterEnv: ['./test/utils/jest-custom-reporter.ts'],
+  testTimeout: 60000,
+  coverageThreshold: {
+    global: {
+      branches: 0,
+      functions: 0,
+      lines: 0,
+      statements: 0,
+    },
+  },
+}
+export default config