@supabase/functions-js 2.71.2-canary.6 → 2.72.1-canary.2

package/README.md

@@ -4,17 +4,100 @@ JS Client library to interact with Supabase Functions.
 
 ## Docs
 
-<https://supabase.com/docs/reference/javascript/functions-invoke>
+- **API Reference**: <https://supabase.com/docs/reference/javascript/functions-invoke>
+- **Functions Guide**: <https://supabase.com/docs/guides/functions>
 
-## testing
+## Quick Start
 
-To run tests you will need Node 20+.
+### Installation
 
-You are going to need docker daemon running to execute tests.
+```bash
+npm install @supabase/functions-js
+```
+
+### Usage
+
+```js
+import { FunctionsClient } from '@supabase/functions-js'
+
+const functionsUrl = 'https://<project_ref>.supabase.co/functions/v1'
+const anonKey = '<anon_key>'
+
+const functions = new FunctionsClient(functionsUrl, {
+  headers: {
+    Authorization: `Bearer ${anonKey}`,
+  },
+})
+
+// Invoke a function
+const { data, error } = await functions.invoke('hello-world', {
+  body: { name: 'Functions' },
+})
+```
+
+## Development
+
+This package is part of the [Supabase JavaScript monorepo](https://github.com/supabase/supabase-js-libs). To work on this package:
+
+### Building
+
+```bash
+# Complete build (from monorepo root)
+npx nx build functions-js
+
+# Build with watch mode for development
+npx nx build functions-js --watch
+
+# Individual build targets
+npx nx build:main functions-js    # CommonJS build (dist/main/)
+npx nx build:module functions-js  # ES Modules build (dist/module/)
+
+# Other useful commands
+npx nx clean functions-js         # Clean build artifacts
+npx nx format functions-js        # Format code with Prettier
+npx nx typecheck functions-js     # TypeScript type checking
+npx nx docs functions-js          # Generate documentation
+```
+
+#### Build Outputs
+
+- **CommonJS (`dist/main/`)** - For Node.js environments
+- **ES Modules (`dist/module/`)** - For modern bundlers (Webpack, Vite, Rollup)
+- **TypeScript definitions (`dist/module/index.d.ts`)** - Type definitions for TypeScript projects
+
+### Testing
+
+**Docker Required** for relay tests. The functions-js tests use testcontainers to spin up a Deno relay server for testing Edge Function invocations.
+
+```bash
+# Run all tests (from monorepo root)
+npx nx test functions-js
+
+# Run tests with coverage report
+npx nx test functions-js --coverage
 
-To start test run use the following command:
+# Run tests in watch mode during development
+npx nx test functions-js --watch
 
-```sh
-npm i
-npm run test
+# CI test command (runs with coverage)
+npx nx test:ci functions-js
 ```
+
+#### Test Requirements
+
+- **Node.js 20+** - Required for testcontainers
+- **Docker** - Must be installed and running for relay tests
+- No Supabase instance needed - Tests use mocked services and testcontainers
+
+#### What Gets Tested
+
+- **Function invocation** - Testing the `invoke()` method with various options
+- **Relay functionality** - Using a containerized Deno relay to test real Edge Function scenarios
+- **Error handling** - Ensuring proper error responses and retries
+- **Request/response models** - Validating headers, body, and response formats
+
+### Contributing
+
+We welcome contributions! Please see our [Contributing Guide](../../../CONTRIBUTING.md) for details on how to get started.
+
+For major changes or if you're unsure about something, please open an issue first to discuss your proposed changes.

package/dist/main/version.d.ts

@@ -1,2 +1,2 @@
-export declare const version = "0.0.0-automated";
+export declare const version = "2.72.1-canary.2";
 //# sourceMappingURL=version.d.ts.map

package/dist/main/version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,oBAAoB,CAAA"}
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,OAAO,oBAAoB,CAAA"}

package/dist/main/version.js

@@ -1,5 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
-exports.version = '0.0.0-automated';
+// Generated automatically during releases by scripts/update-version-files.js
+// This file provides runtime access to the package version for:
+// - HTTP request headers (e.g., X-Client-Info header for API requests)
+// - Debugging and support (identifying which version is running)
+// - Telemetry and logging (version reporting in errors/analytics)
+// - Ensuring build artifacts match the published package version
+exports.version = '2.72.1-canary.2';
 //# sourceMappingURL=version.js.map

package/dist/main/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,iBAAiB,CAAA"}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":";;;AAAA,6EAA6E;AAC7E,gEAAgE;AAChE,uEAAuE;AACvE,iEAAiE;AACjE,kEAAkE;AAClE,iEAAiE;AACpD,QAAA,OAAO,GAAG,iBAAiB,CAAA"}

package/dist/module/version.d.ts

@@ -1,2 +1,2 @@
-export declare const version = "0.0.0-automated";
+export declare const version = "2.72.1-canary.2";
 //# sourceMappingURL=version.d.ts.map

package/dist/module/version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,oBAAoB,CAAA"}
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,OAAO,oBAAoB,CAAA"}

package/dist/module/version.js

@@ -1,2 +1,8 @@
-export const version = '0.0.0-automated';
+// Generated automatically during releases by scripts/update-version-files.js
+// This file provides runtime access to the package version for:
+// - HTTP request headers (e.g., X-Client-Info header for API requests)
+// - Debugging and support (identifying which version is running)
+// - Telemetry and logging (version reporting in errors/analytics)
+// - Ensuring build artifacts match the published package version
+export const version = '2.72.1-canary.2';
 //# sourceMappingURL=version.js.map

package/dist/module/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,iBAAiB,CAAA"}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,6EAA6E;AAC7E,gEAAgE;AAChE,uEAAuE;AACvE,iEAAiE;AACjE,kEAAkE;AAClE,iEAAiE;AACjE,MAAM,CAAC,MAAM,OAAO,GAAG,iBAAiB,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@supabase/functions-js",
-  "version": "2.71.2-canary.6",
+  "version": "2.72.1-canary.2",
   "description": "JS Client library to interact with Supabase Functions.",
   "main": "dist/main/index.js",
   "module": "dist/module/index.js",
@@ -15,8 +15,7 @@
     "docs": "typedoc src/index.ts --out docs/v2",
     "docs:json": "typedoc --json docs/v2/spec.json --excludeExternals src/index.ts",
     "test": "jest",
-    "test:ci": "jest --coverage",
-    "test:coverage": "jest --coverage"
+    "test:ci": "jest --coverage"
   },
   "repository": {
     "type": "git",

package/src/version.ts

@@ -1 +1,7 @@
-export const version = '0.0.0-automated'
+// Generated automatically during releases by scripts/update-version-files.js
+// This file provides runtime access to the package version for:
+// - HTTP request headers (e.g., X-Client-Info header for API requests)
+// - Debugging and support (identifying which version is running)
+// - Telemetry and logging (version reporting in errors/analytics)
+// - Ensuring build artifacts match the published package version
+export const version = '2.72.1-canary.2'