@supabase/functions-js 1.3.4 → 1.4.0-next.1

package/README.md

@@ -1,3 +1,6 @@
 # `functions-js`
 
 JS Client library to interact with Supabase Functions.
+
+## Docs
+https://supabase.github.io/functions-js/index.html

package/dist/main/FunctionsClient.d.ts

@@ -0,0 +1,26 @@
+import { Fetch, FunctionsResponse } from './types';
+export declare class FunctionsClient {
+    protected url: string;
+    protected headers: Record<string, string>;
+    protected fetch: Fetch;
+    constructor(url: string, { headers, customFetch, }?: {
+        headers?: Record<string, string>;
+        customFetch?: Fetch;
+    });
+    /**
+     * Updates the authorization header
+     * @params token - the new jwt token sent in the authorisation header
+     */
+    setAuth(token: string): void;
+    /**
+     * Invokes a function
+     * @param functionName - the name of the function to invoke
+     * @param functionArgs - the arguments to the function
+     * @param options - function invoke options
+     * @param options.headers - headers to send with the request
+     */
+    invoke(functionName: string, functionArgs: any, { headers, }?: {
+        headers?: Record<string, string>;
+    }): Promise<FunctionsResponse>;
+}
+//# sourceMappingURL=FunctionsClient.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"FunctionsClient.d.ts","sourceRoot":"","sources":["../../src/FunctionsClient.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,EAIL,iBAAiB,EAClB,MAAM,SAAS,CAAA;AAEhB,qBAAa,eAAe;IAC1B,SAAS,CAAC,GAAG,EAAE,MAAM,CAAA;IACrB,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACzC,SAAS,CAAC,KAAK,EAAE,KAAK,CAAA;gBAGpB,GAAG,EAAE,MAAM,EACX,EACE,OAAY,EACZ,WAAW,GACZ,GAAE;QACD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAChC,WAAW,CAAC,EAAE,KAAK,CAAA;KACf;IAOR;;;OAGG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM;IAIrB;;;;;;OAMG;IACG,MAAM,CACV,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,GAAG,EACjB,EACE,OAAY,GACb,GAAE;QACD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAC5B,GACL,OAAO,CAAC,iBAAiB,CAAC;CA8D9B"}

package/dist/main/FunctionsClient.js

@@ -0,0 +1,104 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FunctionsClient = void 0;
+const helper_1 = require("./helper");
+const types_1 = require("./types");
+class FunctionsClient {
+    constructor(url, { headers = {}, customFetch, } = {}) {
+        this.url = url;
+        this.headers = headers;
+        this.fetch = (0, helper_1.resolveFetch)(customFetch);
+    }
+    /**
+     * Updates the authorization header
+     * @params token - the new jwt token sent in the authorisation header
+     */
+    setAuth(token) {
+        this.headers.Authorization = `Bearer ${token}`;
+    }
+    /**
+     * Invokes a function
+     * @param functionName - the name of the function to invoke
+     * @param functionArgs - the arguments to the function
+     * @param options - function invoke options
+     * @param options.headers - headers to send with the request
+     */
+    invoke(functionName, functionArgs, { headers = {}, } = {}) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                let _headers = {};
+                let body;
+                if (functionArgs instanceof Blob || functionArgs instanceof ArrayBuffer) {
+                    // will work for File as File inherits Blob
+                    // also works for ArrayBuffer as it is the same underlying structure as a Blob
+                    _headers['Content-Type'] = 'application/octet-stream';
+                    body = functionArgs;
+                }
+                else if (typeof functionArgs === 'string') {
+                    // plain string
+                    _headers['Content-Type'] = 'text/plain';
+                    body = functionArgs;
+                }
+                else if (functionArgs instanceof FormData) {
+                    // don't set content-type headers
+                    // Request will automatically add the right boundary value
+                    body = functionArgs;
+                }
+                else {
+                    // default, assume this is JSON
+                    _headers['Content-Type'] = 'application/json';
+                    body = JSON.stringify(functionArgs);
+                }
+                const response = yield this.fetch(`${this.url}/${functionName}`, {
+                    method: 'POST',
+                    // headers priority is (high to low):
+                    // 1. invoke-level headers
+                    // 2. client-level headers
+                    // 3. default Content-Type header
+                    headers: Object.assign(Object.assign(Object.assign({}, _headers), this.headers), headers),
+                    body,
+                }).catch((fetchError) => {
+                    throw new types_1.FunctionsFetchError(fetchError);
+                });
+                const isRelayError = response.headers.get('x-relay-error');
+                if (isRelayError && isRelayError === 'true') {
+                    throw new types_1.FunctionsRelayError(response);
+                }
+                if (!response.ok) {
+                    throw new types_1.FunctionsHttpError(response);
+                }
+                let responseType = ((_a = response.headers.get('Content-Type')) !== null && _a !== void 0 ? _a : 'text/plain').split(';')[0].trim();
+                let data;
+                if (responseType === 'application/json') {
+                    data = yield response.json();
+                }
+                else if (responseType === 'application/octet-stream') {
+                    data = yield response.blob();
+                }
+                else if (responseType === 'multipart/form-data') {
+                    data = yield response.formData();
+                }
+                else {
+                    // default to text
+                    data = yield response.text();
+                }
+                return { data, error: null };
+            }
+            catch (error) {
+                return { data: null, error };
+            }
+        });
+    }
+}
+exports.FunctionsClient = FunctionsClient;
+//# sourceMappingURL=FunctionsClient.js.map

package/dist/main/FunctionsClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FunctionsClient.js","sourceRoot":"","sources":["../../src/FunctionsClient.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qCAAuC;AACvC,mCAMgB;AAEhB,MAAa,eAAe;IAK1B,YACE,GAAW,EACX,EACE,OAAO,GAAG,EAAE,EACZ,WAAW,MAIT,EAAE;QAEN,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;QACd,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,KAAK,GAAG,IAAA,qBAAY,EAAC,WAAW,CAAC,CAAA;IACxC,CAAC;IAED;;;OAGG;IACH,OAAO,CAAC,KAAa;QACnB,IAAI,CAAC,OAAO,CAAC,aAAa,GAAG,UAAU,KAAK,EAAE,CAAA;IAChD,CAAC;IAED;;;;;;OAMG;IACG,MAAM,CACV,YAAoB,EACpB,YAAiB,EACjB,EACE,OAAO,GAAG,EAAE,MAGV,EAAE;;;YAEN,IAAI;gBACF,IAAI,QAAQ,GAA2B,EAAE,CAAA;gBACzC,IAAI,IAAS,CAAA;gBACb,IAAI,YAAY,YAAY,IAAI,IAAI,YAAY,YAAY,WAAW,EAAE;oBACvE,2CAA2C;oBAC3C,8EAA8E;oBAC9E,QAAQ,CAAC,cAAc,CAAC,GAAG,0BAA0B,CAAA;oBACrD,IAAI,GAAG,YAAY,CAAA;iBACpB;qBAAM,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE;oBAC3C,eAAe;oBACf,QAAQ,CAAC,cAAc,CAAC,GAAG,YAAY,CAAA;oBACvC,IAAI,GAAG,YAAY,CAAA;iBACpB;qBAAM,IAAI,YAAY,YAAY,QAAQ,EAAE;oBAC3C,iCAAiC;oBACjC,0DAA0D;oBAC1D,IAAI,GAAG,YAAY,CAAA;iBACpB;qBAAM;oBACL,+BAA+B;oBAC/B,QAAQ,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAA;oBAC7C,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAA;iBACpC;gBAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,GAAG,IAAI,YAAY,EAAE,EAAE;oBAC/D,MAAM,EAAE,MAAM;oBACd,qCAAqC;oBACrC,0BAA0B;oBAC1B,0BAA0B;oBAC1B,iCAAiC;oBACjC,OAAO,gDAAO,QAAQ,GAAK,IAAI,CAAC,OAAO,GAAK,OAAO,CAAE;oBACrD,IAAI;iBACL,CAAC,CAAC,KAAK,CAAC,CAAC,UAAU,EAAE,EAAE;oBACtB,MAAM,IAAI,2BAAmB,CAAC,UAAU,CAAC,CAAA;gBAC3C,CAAC,CAAC,CAAA;gBAEF,MAAM,YAAY,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAA;gBAC1D,IAAI,YAAY,IAAI,YAAY,KAAK,MAAM,EAAE;oBAC3C,MAAM,IAAI,2BAAmB,CAAC,QAAQ,CAAC,CAAA;iBACxC;gBAED,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE;oBAChB,MAAM,IAAI,0BAAkB,CAAC,QAAQ,CAAC,CAAA;iBACvC;gBAED,IAAI,YAAY,GAAG,CAAC,MAAA,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,mCAAI,YAAY,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;gBAC9F,IAAI,IAAS,CAAA;gBACb,IAAI,YAAY,KAAK,kBAAkB,EAAE;oBACvC,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;iBAC7B;qBAAM,IAAI,YAAY,KAAK,0BAA0B,EAAE;oBACtD,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;iBAC7B;qBAAM,IAAI,YAAY,KAAK,qBAAqB,EAAE;oBACjD,IAAI,GAAG,MAAM,QAAQ,CAAC,QAAQ,EAAE,CAAA;iBACjC;qBAAM;oBACL,kBAAkB;oBAClB,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;iBAC7B;gBAED,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;aAC7B;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;aAC7B;;KACF;CACF;AAzGD,0CAyGC"}

package/dist/main/helper.d.ts

@@ -1,4 +1,3 @@
-declare type Fetch = typeof fetch;
+import { Fetch } from './types';
 export declare const resolveFetch: (customFetch?: typeof fetch | undefined) => Fetch;
-export {};
 //# sourceMappingURL=helper.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"helper.d.ts","sourceRoot":"","sources":["../../src/helper.ts"],"names":[],"mappings":"AAAA,aAAK,KAAK,GAAG,OAAO,KAAK,CAAA;AAEzB,eAAO,MAAM,YAAY,8CAA0B,KAUlD,CAAA"}
+{"version":3,"file":"helper.d.ts","sourceRoot":"","sources":["../../src/helper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAE/B,eAAO,MAAM,YAAY,8CAA0B,KAUlD,CAAA"}

package/dist/main/index.d.ts

@@ -1,31 +1,3 @@
-import { Fetch, FunctionInvokeOptions } from './types';
-export declare class FunctionsClient {
-    protected url: string;
-    protected headers: Record<string, string>;
-    protected fetch: Fetch;
-    constructor(url: string, { headers, customFetch, }?: {
-        headers?: Record<string, string>;
-        customFetch?: Fetch;
-    });
-    /**
-     * Updates the authorization header
-     * @params token - the new jwt token sent in the authorisation header
-     */
-    setAuth(token: string): void;
-    /**
-     * Invokes a function
-     * @param functionName - the name of the function to invoke
-     * @param invokeOptions - object with the following properties
-     * `headers`: object representing the headers to send with the request
-     * `body`: the body of the request
-     * `responseType`: how the response should be parsed. The default is `json`
-     */
-    invoke<T = any>(functionName: string, invokeOptions?: FunctionInvokeOptions): Promise<{
-        data: T;
-        error: null;
-    } | {
-        data: null;
-        error: Error;
-    }>;
-}
+export { FunctionsClient } from './FunctionsClient';
+export { FunctionsError, FunctionsFetchError, FunctionsHttpError, FunctionsRelayError, FunctionsResponse, } from './types';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAA;AAEtD,qBAAa,eAAe;IAC1B,SAAS,CAAC,GAAG,EAAE,MAAM,CAAA;IACrB,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACzC,SAAS,CAAC,KAAK,EAAE,KAAK,CAAA;gBAGpB,GAAG,EAAE,MAAM,EACX,EACE,OAAY,EACZ,WAAW,GACZ,GAAE;QACD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAChC,WAAW,CAAC,EAAE,KAAK,CAAA;KACf;IAOR;;;OAGG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM;IAIrB;;;;;;;OAOG;IACG,MAAM,CAAC,CAAC,GAAG,GAAG,EAClB,YAAY,EAAE,MAAM,EACpB,aAAa,CAAC,EAAE,qBAAqB,GACpC,OAAO,CAAC;QAAE,IAAI,EAAE,CAAC,CAAC;QAAC,KAAK,EAAE,IAAI,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,IAAI,CAAC;QAAC,KAAK,EAAE,KAAK,CAAA;KAAE,CAAC;CA+BpE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,EACL,cAAc,EACd,mBAAmB,EACnB,kBAAkB,EAClB,mBAAmB,EACnB,iBAAiB,GAClB,MAAM,SAAS,CAAA"}

package/dist/main/index.js

@@ -1,71 +1,11 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FunctionsClient = void 0;
-const helper_1 = require("./helper");
-class FunctionsClient {
-    constructor(url, { headers = {}, customFetch, } = {}) {
-        this.url = url;
-        this.headers = headers;
-        this.fetch = (0, helper_1.resolveFetch)(customFetch);
-    }
-    /**
-     * Updates the authorization header
-     * @params token - the new jwt token sent in the authorisation header
-     */
-    setAuth(token) {
-        this.headers.Authorization = `Bearer ${token}`;
-    }
-    /**
-     * Invokes a function
-     * @param functionName - the name of the function to invoke
-     * @param invokeOptions - object with the following properties
-     * `headers`: object representing the headers to send with the request
-     * `body`: the body of the request
-     * `responseType`: how the response should be parsed. The default is `json`
-     */
-    invoke(functionName, invokeOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                const { headers, body } = invokeOptions !== null && invokeOptions !== void 0 ? invokeOptions : {};
-                const response = yield this.fetch(`${this.url}/${functionName}`, {
-                    method: 'POST',
-                    headers: Object.assign({}, this.headers, headers),
-                    body,
-                });
-                const isRelayError = response.headers.get('x-relay-error');
-                if (isRelayError && isRelayError === 'true') {
-                    return { data: null, error: new Error(yield response.text()) };
-                }
-                let data;
-                const { responseType } = invokeOptions !== null && invokeOptions !== void 0 ? invokeOptions : {};
-                if (!responseType || responseType === 'json') {
-                    data = yield response.json();
-                }
-                else if (responseType === 'arrayBuffer') {
-                    data = yield response.arrayBuffer();
-                }
-                else if (responseType === 'blob') {
-                    data = yield response.blob();
-                }
-                else {
-                    data = yield response.text();
-                }
-                return { data, error: null };
-            }
-            catch (error) {
-                return { data: null, error };
-            }
-        });
-    }
-}
-exports.FunctionsClient = FunctionsClient;
+exports.FunctionsRelayError = exports.FunctionsHttpError = exports.FunctionsFetchError = exports.FunctionsError = exports.FunctionsClient = void 0;
+var FunctionsClient_1 = require("./FunctionsClient");
+Object.defineProperty(exports, "FunctionsClient", { enumerable: true, get: function () { return FunctionsClient_1.FunctionsClient; } });
+var types_1 = require("./types");
+Object.defineProperty(exports, "FunctionsError", { enumerable: true, get: function () { return types_1.FunctionsError; } });
+Object.defineProperty(exports, "FunctionsFetchError", { enumerable: true, get: function () { return types_1.FunctionsFetchError; } });
+Object.defineProperty(exports, "FunctionsHttpError", { enumerable: true, get: function () { return types_1.FunctionsHttpError; } });
+Object.defineProperty(exports, "FunctionsRelayError", { enumerable: true, get: function () { return types_1.FunctionsRelayError; } });
 //# sourceMappingURL=index.js.map

package/dist/main/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qCAAuC;AAGvC,MAAa,eAAe;IAK1B,YACE,GAAW,EACX,EACE,OAAO,GAAG,EAAE,EACZ,WAAW,MAIT,EAAE;QAEN,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;QACd,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,KAAK,GAAG,IAAA,qBAAY,EAAC,WAAW,CAAC,CAAA;IACxC,CAAC;IAED;;;OAGG;IACH,OAAO,CAAC,KAAa;QACnB,IAAI,CAAC,OAAO,CAAC,aAAa,GAAG,UAAU,KAAK,EAAE,CAAA;IAChD,CAAC;IAED;;;;;;;OAOG;IACG,MAAM,CACV,YAAoB,EACpB,aAAqC;;YAErC,IAAI;gBACF,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,aAAa,aAAb,aAAa,cAAb,aAAa,GAAI,EAAE,CAAA;gBAC7C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,GAAG,IAAI,YAAY,EAAE,EAAE;oBAC/D,MAAM,EAAE,MAAM;oBACd,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC;oBACjD,IAAI;iBACL,CAAC,CAAA;gBAEF,MAAM,YAAY,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAA;gBAC1D,IAAI,YAAY,IAAI,YAAY,KAAK,MAAM,EAAE;oBAC3C,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,KAAK,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,EAAE,CAAA;iBAC/D;gBAED,IAAI,IAAI,CAAA;gBACR,MAAM,EAAE,YAAY,EAAE,GAAG,aAAa,aAAb,aAAa,cAAb,aAAa,GAAI,EAAE,CAAA;gBAC5C,IAAI,CAAC,YAAY,IAAI,YAAY,KAAK,MAAM,EAAE;oBAC5C,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;iBAC7B;qBAAM,IAAI,YAAY,KAAK,aAAa,EAAE;oBACzC,IAAI,GAAG,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAA;iBACpC;qBAAM,IAAI,YAAY,KAAK,MAAM,EAAE;oBAClC,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;iBAC7B;qBAAM;oBACL,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;iBAC7B;gBAED,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;aAC7B;YAAC,OAAO,KAAU,EAAE;gBACnB,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;aAC7B;QACH,CAAC;KAAA;CACF;AAtED,0CAsEC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,qDAAmD;AAA1C,kHAAA,eAAe,OAAA;AACxB,iCAMgB;AALd,uGAAA,cAAc,OAAA;AACd,4GAAA,mBAAmB,OAAA;AACnB,2GAAA,kBAAkB,OAAA;AAClB,4GAAA,mBAAmB,OAAA"}

package/dist/main/types.d.ts

@@ -1,15 +1,29 @@
 export declare type Fetch = typeof fetch;
-export declare enum ResponseType {
-    json = 0,
-    text = 1,
-    arrayBuffer = 2,
-    blob = 3
-}
-export declare type FunctionInvokeOptions = {
-    headers?: {
-        [key: string]: string;
-    };
-    body?: Blob | BufferSource | FormData | URLSearchParams | ReadableStream<Uint8Array> | string;
-    responseType?: keyof typeof ResponseType;
-};
+/**
+ * Response format
+ *
+ */
+interface FunctionsResponseSuccess {
+    data: any;
+    error: null;
+}
+interface FunctionsResponseFailure {
+    data: null;
+    error: any;
+}
+export declare type FunctionsResponse = FunctionsResponseSuccess | FunctionsResponseFailure;
+export declare class FunctionsError extends Error {
+    context: any;
+    constructor(message: string, name?: string, context?: any);
+}
+export declare class FunctionsFetchError extends FunctionsError {
+    constructor(context: any);
+}
+export declare class FunctionsRelayError extends FunctionsError {
+    constructor(context: any);
+}
+export declare class FunctionsHttpError extends FunctionsError {
+    constructor(context: any);
+}
+export {};
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,oBAAY,KAAK,GAAG,OAAO,KAAK,CAAA;AAEhC,oBAAY,YAAY;IACtB,IAAI,IAAA;IACJ,IAAI,IAAA;IACJ,WAAW,IAAA;IACX,IAAI,IAAA;CACL;AAED,oBAAY,qBAAqB,GAAG;IAClC,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;IACnC,IAAI,CAAC,EAAE,IAAI,GAAG,YAAY,GAAG,QAAQ,GAAG,eAAe,GAAG,cAAc,CAAC,UAAU,CAAC,GAAG,MAAM,CAAA;IAC7F,YAAY,CAAC,EAAE,MAAM,OAAO,YAAY,CAAA;CACzC,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,oBAAY,KAAK,GAAG,OAAO,KAAK,CAAA;AAEhC;;;GAGG;AACH,UAAU,wBAAwB;IAChC,IAAI,EAAE,GAAG,CAAA;IACT,KAAK,EAAE,IAAI,CAAA;CACZ;AACD,UAAU,wBAAwB;IAChC,IAAI,EAAE,IAAI,CAAA;IACV,KAAK,EAAE,GAAG,CAAA;CACX;AACD,oBAAY,iBAAiB,GAAG,wBAAwB,GAAG,wBAAwB,CAAA;AAEnF,qBAAa,cAAe,SAAQ,KAAK;IACvC,OAAO,EAAE,GAAG,CAAA;gBACA,OAAO,EAAE,MAAM,EAAE,IAAI,SAAmB,EAAE,OAAO,CAAC,EAAE,GAAG;CAKpE;AAED,qBAAa,mBAAoB,SAAQ,cAAc;gBACzC,OAAO,EAAE,GAAG;CAGzB;AAED,qBAAa,mBAAoB,SAAQ,cAAc;gBACzC,OAAO,EAAE,GAAG;CAGzB;AAED,qBAAa,kBAAmB,SAAQ,cAAc;gBACxC,OAAO,EAAE,GAAG;CAGzB"}

package/dist/main/types.js

@@ -1,11 +1,30 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ResponseType = void 0;
-var ResponseType;
-(function (ResponseType) {
-    ResponseType[ResponseType["json"] = 0] = "json";
-    ResponseType[ResponseType["text"] = 1] = "text";
-    ResponseType[ResponseType["arrayBuffer"] = 2] = "arrayBuffer";
-    ResponseType[ResponseType["blob"] = 3] = "blob";
-})(ResponseType = exports.ResponseType || (exports.ResponseType = {}));
+exports.FunctionsHttpError = exports.FunctionsRelayError = exports.FunctionsFetchError = exports.FunctionsError = void 0;
+class FunctionsError extends Error {
+    constructor(message, name = 'FunctionsError', context) {
+        super(message);
+        super.name = name;
+        this.context = context;
+    }
+}
+exports.FunctionsError = FunctionsError;
+class FunctionsFetchError extends FunctionsError {
+    constructor(context) {
+        super('Failed to perform request to Edge Function', 'FunctionsFetchError', context);
+    }
+}
+exports.FunctionsFetchError = FunctionsFetchError;
+class FunctionsRelayError extends FunctionsError {
+    constructor(context) {
+        super('Relay error communicating with deno backend', 'FunctionsRelayError', context);
+    }
+}
+exports.FunctionsRelayError = FunctionsRelayError;
+class FunctionsHttpError extends FunctionsError {
+    constructor(context) {
+        super('Edge Function returned a non-2xx status code', 'FunctionsHttpError', context);
+    }
+}
+exports.FunctionsHttpError = FunctionsHttpError;
 //# sourceMappingURL=types.js.map

package/dist/main/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":";;;AAEA,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,+CAAI,CAAA;IACJ,+CAAI,CAAA;IACJ,6DAAW,CAAA;IACX,+CAAI,CAAA;AACN,CAAC,EALW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAKvB"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":";;;AAgBA,MAAa,cAAe,SAAQ,KAAK;IAEvC,YAAY,OAAe,EAAE,IAAI,GAAG,gBAAgB,EAAE,OAAa;QACjE,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,KAAK,CAAC,IAAI,GAAG,IAAI,CAAA;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;CACF;AAPD,wCAOC;AAED,MAAa,mBAAoB,SAAQ,cAAc;IACrD,YAAY,OAAY;QACtB,KAAK,CAAC,4CAA4C,EAAE,qBAAqB,EAAE,OAAO,CAAC,CAAA;IACrF,CAAC;CACF;AAJD,kDAIC;AAED,MAAa,mBAAoB,SAAQ,cAAc;IACrD,YAAY,OAAY;QACtB,KAAK,CAAC,6CAA6C,EAAE,qBAAqB,EAAE,OAAO,CAAC,CAAA;IACtF,CAAC;CACF;AAJD,kDAIC;AAED,MAAa,kBAAmB,SAAQ,cAAc;IACpD,YAAY,OAAY;QACtB,KAAK,CAAC,8CAA8C,EAAE,oBAAoB,EAAE,OAAO,CAAC,CAAA;IACtF,CAAC;CACF;AAJD,gDAIC"}

package/dist/main/version.d.ts

@@ -1,2 +1,2 @@
-export declare const version = "1.3.4";
+export declare const version = "1.4.0-next.1";
 //# sourceMappingURL=version.d.ts.map

package/dist/main/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
-exports.version = '1.3.4';
+exports.version = '1.4.0-next.1';
 //# sourceMappingURL=version.js.map

package/dist/module/FunctionsClient.d.ts

@@ -0,0 +1,26 @@
+import { Fetch, FunctionsResponse } from './types';
+export declare class FunctionsClient {
+    protected url: string;
+    protected headers: Record<string, string>;
+    protected fetch: Fetch;
+    constructor(url: string, { headers, customFetch, }?: {
+        headers?: Record<string, string>;
+        customFetch?: Fetch;
+    });
+    /**
+     * Updates the authorization header
+     * @params token - the new jwt token sent in the authorisation header
+     */
+    setAuth(token: string): void;
+    /**
+     * Invokes a function
+     * @param functionName - the name of the function to invoke
+     * @param functionArgs - the arguments to the function
+     * @param options - function invoke options
+     * @param options.headers - headers to send with the request
+     */
+    invoke(functionName: string, functionArgs: any, { headers, }?: {
+        headers?: Record<string, string>;
+    }): Promise<FunctionsResponse>;
+}
+//# sourceMappingURL=FunctionsClient.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"FunctionsClient.d.ts","sourceRoot":"","sources":["../../src/FunctionsClient.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,EAIL,iBAAiB,EAClB,MAAM,SAAS,CAAA;AAEhB,qBAAa,eAAe;IAC1B,SAAS,CAAC,GAAG,EAAE,MAAM,CAAA;IACrB,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACzC,SAAS,CAAC,KAAK,EAAE,KAAK,CAAA;gBAGpB,GAAG,EAAE,MAAM,EACX,EACE,OAAY,EACZ,WAAW,GACZ,GAAE;QACD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAChC,WAAW,CAAC,EAAE,KAAK,CAAA;KACf;IAOR;;;OAGG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM;IAIrB;;;;;;OAMG;IACG,MAAM,CACV,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,GAAG,EACjB,EACE,OAAY,GACb,GAAE;QACD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAC5B,GACL,OAAO,CAAC,iBAAiB,CAAC;CA8D9B"}

package/dist/module/FunctionsClient.js

@@ -0,0 +1,100 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { resolveFetch } from './helper';
+import { FunctionsFetchError, FunctionsHttpError, FunctionsRelayError, } from './types';
+export class FunctionsClient {
+    constructor(url, { headers = {}, customFetch, } = {}) {
+        this.url = url;
+        this.headers = headers;
+        this.fetch = resolveFetch(customFetch);
+    }
+    /**
+     * Updates the authorization header
+     * @params token - the new jwt token sent in the authorisation header
+     */
+    setAuth(token) {
+        this.headers.Authorization = `Bearer ${token}`;
+    }
+    /**
+     * Invokes a function
+     * @param functionName - the name of the function to invoke
+     * @param functionArgs - the arguments to the function
+     * @param options - function invoke options
+     * @param options.headers - headers to send with the request
+     */
+    invoke(functionName, functionArgs, { headers = {}, } = {}) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                let _headers = {};
+                let body;
+                if (functionArgs instanceof Blob || functionArgs instanceof ArrayBuffer) {
+                    // will work for File as File inherits Blob
+                    // also works for ArrayBuffer as it is the same underlying structure as a Blob
+                    _headers['Content-Type'] = 'application/octet-stream';
+                    body = functionArgs;
+                }
+                else if (typeof functionArgs === 'string') {
+                    // plain string
+                    _headers['Content-Type'] = 'text/plain';
+                    body = functionArgs;
+                }
+                else if (functionArgs instanceof FormData) {
+                    // don't set content-type headers
+                    // Request will automatically add the right boundary value
+                    body = functionArgs;
+                }
+                else {
+                    // default, assume this is JSON
+                    _headers['Content-Type'] = 'application/json';
+                    body = JSON.stringify(functionArgs);
+                }
+                const response = yield this.fetch(`${this.url}/${functionName}`, {
+                    method: 'POST',
+                    // headers priority is (high to low):
+                    // 1. invoke-level headers
+                    // 2. client-level headers
+                    // 3. default Content-Type header
+                    headers: Object.assign(Object.assign(Object.assign({}, _headers), this.headers), headers),
+                    body,
+                }).catch((fetchError) => {
+                    throw new FunctionsFetchError(fetchError);
+                });
+                const isRelayError = response.headers.get('x-relay-error');
+                if (isRelayError && isRelayError === 'true') {
+                    throw new FunctionsRelayError(response);
+                }
+                if (!response.ok) {
+                    throw new FunctionsHttpError(response);
+                }
+                let responseType = ((_a = response.headers.get('Content-Type')) !== null && _a !== void 0 ? _a : 'text/plain').split(';')[0].trim();
+                let data;
+                if (responseType === 'application/json') {
+                    data = yield response.json();
+                }
+                else if (responseType === 'application/octet-stream') {
+                    data = yield response.blob();
+                }
+                else if (responseType === 'multipart/form-data') {
+                    data = yield response.formData();
+                }
+                else {
+                    // default to text
+                    data = yield response.text();
+                }
+                return { data, error: null };
+            }
+            catch (error) {
+                return { data: null, error };
+            }
+        });
+    }
+}
+//# sourceMappingURL=FunctionsClient.js.map

package/dist/module/FunctionsClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FunctionsClient.js","sourceRoot":"","sources":["../../src/FunctionsClient.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AACvC,OAAO,EAEL,mBAAmB,EACnB,kBAAkB,EAClB,mBAAmB,GAEpB,MAAM,SAAS,CAAA;AAEhB,MAAM,OAAO,eAAe;IAK1B,YACE,GAAW,EACX,EACE,OAAO,GAAG,EAAE,EACZ,WAAW,MAIT,EAAE;QAEN,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;QACd,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,KAAK,GAAG,YAAY,CAAC,WAAW,CAAC,CAAA;IACxC,CAAC;IAED;;;OAGG;IACH,OAAO,CAAC,KAAa;QACnB,IAAI,CAAC,OAAO,CAAC,aAAa,GAAG,UAAU,KAAK,EAAE,CAAA;IAChD,CAAC;IAED;;;;;;OAMG;IACG,MAAM,CACV,YAAoB,EACpB,YAAiB,EACjB,EACE,OAAO,GAAG,EAAE,MAGV,EAAE;;;YAEN,IAAI;gBACF,IAAI,QAAQ,GAA2B,EAAE,CAAA;gBACzC,IAAI,IAAS,CAAA;gBACb,IAAI,YAAY,YAAY,IAAI,IAAI,YAAY,YAAY,WAAW,EAAE;oBACvE,2CAA2C;oBAC3C,8EAA8E;oBAC9E,QAAQ,CAAC,cAAc,CAAC,GAAG,0BAA0B,CAAA;oBACrD,IAAI,GAAG,YAAY,CAAA;iBACpB;qBAAM,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE;oBAC3C,eAAe;oBACf,QAAQ,CAAC,cAAc,CAAC,GAAG,YAAY,CAAA;oBACvC,IAAI,GAAG,YAAY,CAAA;iBACpB;qBAAM,IAAI,YAAY,YAAY,QAAQ,EAAE;oBAC3C,iCAAiC;oBACjC,0DAA0D;oBAC1D,IAAI,GAAG,YAAY,CAAA;iBACpB;qBAAM;oBACL,+BAA+B;oBAC/B,QAAQ,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAA;oBAC7C,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAA;iBACpC;gBAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,GAAG,IAAI,YAAY,EAAE,EAAE;oBAC/D,MAAM,EAAE,MAAM;oBACd,qCAAqC;oBACrC,0BAA0B;oBAC1B,0BAA0B;oBAC1B,iCAAiC;oBACjC,OAAO,gDAAO,QAAQ,GAAK,IAAI,CAAC,OAAO,GAAK,OAAO,CAAE;oBACrD,IAAI;iBACL,CAAC,CAAC,KAAK,CAAC,CAAC,UAAU,EAAE,EAAE;oBACtB,MAAM,IAAI,mBAAmB,CAAC,UAAU,CAAC,CAAA;gBAC3C,CAAC,CAAC,CAAA;gBAEF,MAAM,YAAY,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAA;gBAC1D,IAAI,YAAY,IAAI,YAAY,KAAK,MAAM,EAAE;oBAC3C,MAAM,IAAI,mBAAmB,CAAC,QAAQ,CAAC,CAAA;iBACxC;gBAED,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE;oBAChB,MAAM,IAAI,kBAAkB,CAAC,QAAQ,CAAC,CAAA;iBACvC;gBAED,IAAI,YAAY,GAAG,CAAC,MAAA,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,mCAAI,YAAY,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;gBAC9F,IAAI,IAAS,CAAA;gBACb,IAAI,YAAY,KAAK,kBAAkB,EAAE;oBACvC,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;iBAC7B;qBAAM,IAAI,YAAY,KAAK,0BAA0B,EAAE;oBACtD,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;iBAC7B;qBAAM,IAAI,YAAY,KAAK,qBAAqB,EAAE;oBACjD,IAAI,GAAG,MAAM,QAAQ,CAAC,QAAQ,EAAE,CAAA;iBACjC;qBAAM;oBACL,kBAAkB;oBAClB,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;iBAC7B;gBAED,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;aAC7B;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;aAC7B;;KACF;CACF"}

package/dist/module/helper.d.ts

@@ -1,4 +1,3 @@
-declare type Fetch = typeof fetch;
+import { Fetch } from './types';
 export declare const resolveFetch: (customFetch?: typeof fetch | undefined) => Fetch;
-export {};
 //# sourceMappingURL=helper.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"helper.d.ts","sourceRoot":"","sources":["../../src/helper.ts"],"names":[],"mappings":"AAAA,aAAK,KAAK,GAAG,OAAO,KAAK,CAAA;AAEzB,eAAO,MAAM,YAAY,8CAA0B,KAUlD,CAAA"}
+{"version":3,"file":"helper.d.ts","sourceRoot":"","sources":["../../src/helper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAE/B,eAAO,MAAM,YAAY,8CAA0B,KAUlD,CAAA"}

package/dist/module/index.d.ts

@@ -1,31 +1,3 @@
-import { Fetch, FunctionInvokeOptions } from './types';
-export declare class FunctionsClient {
-    protected url: string;
-    protected headers: Record<string, string>;
-    protected fetch: Fetch;
-    constructor(url: string, { headers, customFetch, }?: {
-        headers?: Record<string, string>;
-        customFetch?: Fetch;
-    });
-    /**
-     * Updates the authorization header
-     * @params token - the new jwt token sent in the authorisation header
-     */
-    setAuth(token: string): void;
-    /**
-     * Invokes a function
-     * @param functionName - the name of the function to invoke
-     * @param invokeOptions - object with the following properties
-     * `headers`: object representing the headers to send with the request
-     * `body`: the body of the request
-     * `responseType`: how the response should be parsed. The default is `json`
-     */
-    invoke<T = any>(functionName: string, invokeOptions?: FunctionInvokeOptions): Promise<{
-        data: T;
-        error: null;
-    } | {
-        data: null;
-        error: Error;
-    }>;
-}
+export { FunctionsClient } from './FunctionsClient';
+export { FunctionsError, FunctionsFetchError, FunctionsHttpError, FunctionsRelayError, FunctionsResponse, } from './types';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAA;AAEtD,qBAAa,eAAe;IAC1B,SAAS,CAAC,GAAG,EAAE,MAAM,CAAA;IACrB,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACzC,SAAS,CAAC,KAAK,EAAE,KAAK,CAAA;gBAGpB,GAAG,EAAE,MAAM,EACX,EACE,OAAY,EACZ,WAAW,GACZ,GAAE;QACD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAChC,WAAW,CAAC,EAAE,KAAK,CAAA;KACf;IAOR;;;OAGG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM;IAIrB;;;;;;;OAOG;IACG,MAAM,CAAC,CAAC,GAAG,GAAG,EAClB,YAAY,EAAE,MAAM,EACpB,aAAa,CAAC,EAAE,qBAAqB,GACpC,OAAO,CAAC;QAAE,IAAI,EAAE,CAAC,CAAC;QAAC,KAAK,EAAE,IAAI,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,IAAI,CAAC;QAAC,KAAK,EAAE,KAAK,CAAA;KAAE,CAAC;CA+BpE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,EACL,cAAc,EACd,mBAAmB,EACnB,kBAAkB,EAClB,mBAAmB,EACnB,iBAAiB,GAClB,MAAM,SAAS,CAAA"}

package/dist/module/index.js

@@ -1,67 +1,3 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import { resolveFetch } from './helper';
-export class FunctionsClient {
-    constructor(url, { headers = {}, customFetch, } = {}) {
-        this.url = url;
-        this.headers = headers;
-        this.fetch = resolveFetch(customFetch);
-    }
-    /**
-     * Updates the authorization header
-     * @params token - the new jwt token sent in the authorisation header
-     */
-    setAuth(token) {
-        this.headers.Authorization = `Bearer ${token}`;
-    }
-    /**
-     * Invokes a function
-     * @param functionName - the name of the function to invoke
-     * @param invokeOptions - object with the following properties
-     * `headers`: object representing the headers to send with the request
-     * `body`: the body of the request
-     * `responseType`: how the response should be parsed. The default is `json`
-     */
-    invoke(functionName, invokeOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                const { headers, body } = invokeOptions !== null && invokeOptions !== void 0 ? invokeOptions : {};
-                const response = yield this.fetch(`${this.url}/${functionName}`, {
-                    method: 'POST',
-                    headers: Object.assign({}, this.headers, headers),
-                    body,
-                });
-                const isRelayError = response.headers.get('x-relay-error');
-                if (isRelayError && isRelayError === 'true') {
-                    return { data: null, error: new Error(yield response.text()) };
-                }
-                let data;
-                const { responseType } = invokeOptions !== null && invokeOptions !== void 0 ? invokeOptions : {};
-                if (!responseType || responseType === 'json') {
-                    data = yield response.json();
-                }
-                else if (responseType === 'arrayBuffer') {
-                    data = yield response.arrayBuffer();
-                }
-                else if (responseType === 'blob') {
-                    data = yield response.blob();
-                }
-                else {
-                    data = yield response.text();
-                }
-                return { data, error: null };
-            }
-            catch (error) {
-                return { data: null, error };
-            }
-        });
-    }
-}
+export { FunctionsClient } from './FunctionsClient';
+export { FunctionsError, FunctionsFetchError, FunctionsHttpError, FunctionsRelayError, } from './types';
 //# sourceMappingURL=index.js.map

package/dist/module/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAGvC,MAAM,OAAO,eAAe;IAK1B,YACE,GAAW,EACX,EACE,OAAO,GAAG,EAAE,EACZ,WAAW,MAIT,EAAE;QAEN,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;QACd,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,KAAK,GAAG,YAAY,CAAC,WAAW,CAAC,CAAA;IACxC,CAAC;IAED;;;OAGG;IACH,OAAO,CAAC,KAAa;QACnB,IAAI,CAAC,OAAO,CAAC,aAAa,GAAG,UAAU,KAAK,EAAE,CAAA;IAChD,CAAC;IAED;;;;;;;OAOG;IACG,MAAM,CACV,YAAoB,EACpB,aAAqC;;YAErC,IAAI;gBACF,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,aAAa,aAAb,aAAa,cAAb,aAAa,GAAI,EAAE,CAAA;gBAC7C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,GAAG,IAAI,YAAY,EAAE,EAAE;oBAC/D,MAAM,EAAE,MAAM;oBACd,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC;oBACjD,IAAI;iBACL,CAAC,CAAA;gBAEF,MAAM,YAAY,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAA;gBAC1D,IAAI,YAAY,IAAI,YAAY,KAAK,MAAM,EAAE;oBAC3C,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,KAAK,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,EAAE,CAAA;iBAC/D;gBAED,IAAI,IAAI,CAAA;gBACR,MAAM,EAAE,YAAY,EAAE,GAAG,aAAa,aAAb,aAAa,cAAb,aAAa,GAAI,EAAE,CAAA;gBAC5C,IAAI,CAAC,YAAY,IAAI,YAAY,KAAK,MAAM,EAAE;oBAC5C,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;iBAC7B;qBAAM,IAAI,YAAY,KAAK,aAAa,EAAE;oBACzC,IAAI,GAAG,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAA;iBACpC;qBAAM,IAAI,YAAY,KAAK,MAAM,EAAE;oBAClC,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;iBAC7B;qBAAM;oBACL,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;iBAC7B;gBAED,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;aAC7B;YAAC,OAAO,KAAU,EAAE;gBACnB,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;aAC7B;QACH,CAAC;KAAA;CACF"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,EACL,cAAc,EACd,mBAAmB,EACnB,kBAAkB,EAClB,mBAAmB,GAEpB,MAAM,SAAS,CAAA"}

package/dist/module/types.d.ts

@@ -1,15 +1,29 @@
 export declare type Fetch = typeof fetch;
-export declare enum ResponseType {
-    json = 0,
-    text = 1,
-    arrayBuffer = 2,
-    blob = 3
-}
-export declare type FunctionInvokeOptions = {
-    headers?: {
-        [key: string]: string;
-    };
-    body?: Blob | BufferSource | FormData | URLSearchParams | ReadableStream<Uint8Array> | string;
-    responseType?: keyof typeof ResponseType;
-};
+/**
+ * Response format
+ *
+ */
+interface FunctionsResponseSuccess {
+    data: any;
+    error: null;
+}
+interface FunctionsResponseFailure {
+    data: null;
+    error: any;
+}
+export declare type FunctionsResponse = FunctionsResponseSuccess | FunctionsResponseFailure;
+export declare class FunctionsError extends Error {
+    context: any;
+    constructor(message: string, name?: string, context?: any);
+}
+export declare class FunctionsFetchError extends FunctionsError {
+    constructor(context: any);
+}
+export declare class FunctionsRelayError extends FunctionsError {
+    constructor(context: any);
+}
+export declare class FunctionsHttpError extends FunctionsError {
+    constructor(context: any);
+}
+export {};
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,oBAAY,KAAK,GAAG,OAAO,KAAK,CAAA;AAEhC,oBAAY,YAAY;IACtB,IAAI,IAAA;IACJ,IAAI,IAAA;IACJ,WAAW,IAAA;IACX,IAAI,IAAA;CACL;AAED,oBAAY,qBAAqB,GAAG;IAClC,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;IACnC,IAAI,CAAC,EAAE,IAAI,GAAG,YAAY,GAAG,QAAQ,GAAG,eAAe,GAAG,cAAc,CAAC,UAAU,CAAC,GAAG,MAAM,CAAA;IAC7F,YAAY,CAAC,EAAE,MAAM,OAAO,YAAY,CAAA;CACzC,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,oBAAY,KAAK,GAAG,OAAO,KAAK,CAAA;AAEhC;;;GAGG;AACH,UAAU,wBAAwB;IAChC,IAAI,EAAE,GAAG,CAAA;IACT,KAAK,EAAE,IAAI,CAAA;CACZ;AACD,UAAU,wBAAwB;IAChC,IAAI,EAAE,IAAI,CAAA;IACV,KAAK,EAAE,GAAG,CAAA;CACX;AACD,oBAAY,iBAAiB,GAAG,wBAAwB,GAAG,wBAAwB,CAAA;AAEnF,qBAAa,cAAe,SAAQ,KAAK;IACvC,OAAO,EAAE,GAAG,CAAA;gBACA,OAAO,EAAE,MAAM,EAAE,IAAI,SAAmB,EAAE,OAAO,CAAC,EAAE,GAAG;CAKpE;AAED,qBAAa,mBAAoB,SAAQ,cAAc;gBACzC,OAAO,EAAE,GAAG;CAGzB;AAED,qBAAa,mBAAoB,SAAQ,cAAc;gBACzC,OAAO,EAAE,GAAG;CAGzB;AAED,qBAAa,kBAAmB,SAAQ,cAAc;gBACxC,OAAO,EAAE,GAAG;CAGzB"}

package/dist/module/types.js

@@ -1,8 +1,23 @@
-export var ResponseType;
-(function (ResponseType) {
-    ResponseType[ResponseType["json"] = 0] = "json";
-    ResponseType[ResponseType["text"] = 1] = "text";
-    ResponseType[ResponseType["arrayBuffer"] = 2] = "arrayBuffer";
-    ResponseType[ResponseType["blob"] = 3] = "blob";
-})(ResponseType || (ResponseType = {}));
+export class FunctionsError extends Error {
+    constructor(message, name = 'FunctionsError', context) {
+        super(message);
+        super.name = name;
+        this.context = context;
+    }
+}
+export class FunctionsFetchError extends FunctionsError {
+    constructor(context) {
+        super('Failed to perform request to Edge Function', 'FunctionsFetchError', context);
+    }
+}
+export class FunctionsRelayError extends FunctionsError {
+    constructor(context) {
+        super('Relay error communicating with deno backend', 'FunctionsRelayError', context);
+    }
+}
+export class FunctionsHttpError extends FunctionsError {
+    constructor(context) {
+        super('Edge Function returned a non-2xx status code', 'FunctionsHttpError', context);
+    }
+}
 //# sourceMappingURL=types.js.map

package/dist/module/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAEA,MAAM,CAAN,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,+CAAI,CAAA;IACJ,+CAAI,CAAA;IACJ,6DAAW,CAAA;IACX,+CAAI,CAAA;AACN,CAAC,EALW,YAAY,KAAZ,YAAY,QAKvB"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAgBA,MAAM,OAAO,cAAe,SAAQ,KAAK;IAEvC,YAAY,OAAe,EAAE,IAAI,GAAG,gBAAgB,EAAE,OAAa;QACjE,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,KAAK,CAAC,IAAI,GAAG,IAAI,CAAA;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;CACF;AAED,MAAM,OAAO,mBAAoB,SAAQ,cAAc;IACrD,YAAY,OAAY;QACtB,KAAK,CAAC,4CAA4C,EAAE,qBAAqB,EAAE,OAAO,CAAC,CAAA;IACrF,CAAC;CACF;AAED,MAAM,OAAO,mBAAoB,SAAQ,cAAc;IACrD,YAAY,OAAY;QACtB,KAAK,CAAC,6CAA6C,EAAE,qBAAqB,EAAE,OAAO,CAAC,CAAA;IACtF,CAAC;CACF;AAED,MAAM,OAAO,kBAAmB,SAAQ,cAAc;IACpD,YAAY,OAAY;QACtB,KAAK,CAAC,8CAA8C,EAAE,oBAAoB,EAAE,OAAO,CAAC,CAAA;IACtF,CAAC;CACF"}

package/dist/module/version.d.ts

@@ -1,2 +1,2 @@
-export declare const version = "1.3.4";
+export declare const version = "1.4.0-next.1";
 //# sourceMappingURL=version.d.ts.map

package/dist/module/version.js

@@ -1,2 +1,2 @@
-export const version = '1.3.4';
+export const version = '1.4.0-next.1';
 //# sourceMappingURL=version.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@supabase/functions-js",
-  "version": "1.3.4",
+  "version": "1.4.0-next.1",
   "description": "JS Client library to interact with Supabase Functions.",
   "main": "dist/main/index.js",
   "module": "dist/module/index.js",
@@ -12,8 +12,8 @@
     "build": "run-s clean format build:*",
     "build:main": "tsc -p tsconfig.json",
     "build:module": "tsc -p tsconfig.module.json",
-    "docs": "typedoc src/index.ts",
-    "docs:json": "typedoc --json docs/spec.json --excludeExternals src/index.ts",
+    "docs": "typedoc src/index.ts src/types.ts --excludePrivate --excludeProtected",
+    "docs:json": "typedoc --json docs/spec.json --excludeExternals src/index.ts src/types.ts",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "repository": {
@@ -43,7 +43,7 @@
     "rimraf": "^3.0.2",
     "semantic-release": "^19.0.2",
     "semantic-release-plugin-update-version-in-files": "^1.1.0",
-    "typedoc": "^0.22.13",
+    "typedoc": "^0.23.10",
     "typescript": "^4.6.2"
   },
   "publishConfig": {

package/src/FunctionsClient.ts

@@ -0,0 +1,115 @@
+import { resolveFetch } from './helper'
+import {
+  Fetch,
+  FunctionsFetchError,
+  FunctionsHttpError,
+  FunctionsRelayError,
+  FunctionsResponse,
+} from './types'
+
+export class FunctionsClient {
+  protected url: string
+  protected headers: Record<string, string>
+  protected fetch: Fetch
+
+  constructor(
+    url: string,
+    {
+      headers = {},
+      customFetch,
+    }: {
+      headers?: Record<string, string>
+      customFetch?: Fetch
+    } = {}
+  ) {
+    this.url = url
+    this.headers = headers
+    this.fetch = resolveFetch(customFetch)
+  }
+
+  /**
+   * Updates the authorization header
+   * @params token - the new jwt token sent in the authorisation header
+   */
+  setAuth(token: string) {
+    this.headers.Authorization = `Bearer ${token}`
+  }
+
+  /**
+   * Invokes a function
+   * @param functionName - the name of the function to invoke
+   * @param functionArgs - the arguments to the function
+   * @param options - function invoke options
+   * @param options.headers - headers to send with the request
+   */
+  async invoke(
+    functionName: string,
+    functionArgs: any,
+    {
+      headers = {},
+    }: {
+      headers?: Record<string, string>
+    } = {}
+  ): Promise<FunctionsResponse> {
+    try {
+      let _headers: Record<string, string> = {}
+      let body: any
+      if (functionArgs instanceof Blob || functionArgs instanceof ArrayBuffer) {
+        // will work for File as File inherits Blob
+        // also works for ArrayBuffer as it is the same underlying structure as a Blob
+        _headers['Content-Type'] = 'application/octet-stream'
+        body = functionArgs
+      } else if (typeof functionArgs === 'string') {
+        // plain string
+        _headers['Content-Type'] = 'text/plain'
+        body = functionArgs
+      } else if (functionArgs instanceof FormData) {
+        // don't set content-type headers
+        // Request will automatically add the right boundary value
+        body = functionArgs
+      } else {
+        // default, assume this is JSON
+        _headers['Content-Type'] = 'application/json'
+        body = JSON.stringify(functionArgs)
+      }
+
+      const response = await this.fetch(`${this.url}/${functionName}`, {
+        method: 'POST',
+        // headers priority is (high to low):
+        // 1. invoke-level headers
+        // 2. client-level headers
+        // 3. default Content-Type header
+        headers: { ..._headers, ...this.headers, ...headers },
+        body,
+      }).catch((fetchError) => {
+        throw new FunctionsFetchError(fetchError)
+      })
+
+      const isRelayError = response.headers.get('x-relay-error')
+      if (isRelayError && isRelayError === 'true') {
+        throw new FunctionsRelayError(response)
+      }
+
+      if (!response.ok) {
+        throw new FunctionsHttpError(response)
+      }
+
+      let responseType = (response.headers.get('Content-Type') ?? 'text/plain').split(';')[0].trim()
+      let data: any
+      if (responseType === 'application/json') {
+        data = await response.json()
+      } else if (responseType === 'application/octet-stream') {
+        data = await response.blob()
+      } else if (responseType === 'multipart/form-data') {
+        data = await response.formData()
+      } else {
+        // default to text
+        data = await response.text()
+      }
+
+      return { data, error: null }
+    } catch (error) {
+      return { data: null, error }
+    }
+  }
+}

package/src/helper.ts

@@ -1,4 +1,4 @@
-type Fetch = typeof fetch
+import { Fetch } from './types'
 
 export const resolveFetch = (customFetch?: Fetch): Fetch => {
   let _fetch: Fetch

package/src/index.ts

@@ -1,74 +1,8 @@
-import { resolveFetch } from './helper'
-import { Fetch, FunctionInvokeOptions } from './types'
-
-export class FunctionsClient {
-  protected url: string
-  protected headers: Record<string, string>
-  protected fetch: Fetch
-
-  constructor(
-    url: string,
-    {
-      headers = {},
-      customFetch,
-    }: {
-      headers?: Record<string, string>
-      customFetch?: Fetch
-    } = {}
-  ) {
-    this.url = url
-    this.headers = headers
-    this.fetch = resolveFetch(customFetch)
-  }
-
-  /**
-   * Updates the authorization header
-   * @params token - the new jwt token sent in the authorisation header
-   */
-  setAuth(token: string) {
-    this.headers.Authorization = `Bearer ${token}`
-  }
-
-  /**
-   * Invokes a function
-   * @param functionName - the name of the function to invoke
-   * @param invokeOptions - object with the following properties
-   * `headers`: object representing the headers to send with the request
-   * `body`: the body of the request
-   * `responseType`: how the response should be parsed. The default is `json`
-   */
-  async invoke<T = any>(
-    functionName: string,
-    invokeOptions?: FunctionInvokeOptions
-  ): Promise<{ data: T; error: null } | { data: null; error: Error }> {
-    try {
-      const { headers, body } = invokeOptions ?? {}
-      const response = await this.fetch(`${this.url}/${functionName}`, {
-        method: 'POST',
-        headers: Object.assign({}, this.headers, headers),
-        body,
-      })
-
-      const isRelayError = response.headers.get('x-relay-error')
-      if (isRelayError && isRelayError === 'true') {
-        return { data: null, error: new Error(await response.text()) }
-      }
-
-      let data
-      const { responseType } = invokeOptions ?? {}
-      if (!responseType || responseType === 'json') {
-        data = await response.json()
-      } else if (responseType === 'arrayBuffer') {
-        data = await response.arrayBuffer()
-      } else if (responseType === 'blob') {
-        data = await response.blob()
-      } else {
-        data = await response.text()
-      }
-
-      return { data, error: null }
-    } catch (error: any) {
-      return { data: null, error }
-    }
-  }
-}
+export { FunctionsClient } from './FunctionsClient'
+export {
+  FunctionsError,
+  FunctionsFetchError,
+  FunctionsHttpError,
+  FunctionsRelayError,
+  FunctionsResponse,
+} from './types'

package/src/types.ts

@@ -1,14 +1,42 @@
 export type Fetch = typeof fetch
 
-export enum ResponseType {
-  json,
-  text,
-  arrayBuffer,
-  blob,
+/**
+ * Response format
+ *
+ */
+interface FunctionsResponseSuccess {
+  data: any
+  error: null
+}
+interface FunctionsResponseFailure {
+  data: null
+  error: any
+}
+export type FunctionsResponse = FunctionsResponseSuccess | FunctionsResponseFailure
+
+export class FunctionsError extends Error {
+  context: any
+  constructor(message: string, name = 'FunctionsError', context?: any) {
+    super(message)
+    super.name = name
+    this.context = context
+  }
+}
+
+export class FunctionsFetchError extends FunctionsError {
+  constructor(context: any) {
+    super('Failed to perform request to Edge Function', 'FunctionsFetchError', context)
+  }
+}
+
+export class FunctionsRelayError extends FunctionsError {
+  constructor(context: any) {
+    super('Relay error communicating with deno backend', 'FunctionsRelayError', context)
+  }
 }
 
-export type FunctionInvokeOptions = {
-  headers?: { [key: string]: string }
-  body?: Blob | BufferSource | FormData | URLSearchParams | ReadableStream<Uint8Array> | string
-  responseType?: keyof typeof ResponseType
+export class FunctionsHttpError extends FunctionsError {
+  constructor(context: any) {
+    super('Edge Function returned a non-2xx status code', 'FunctionsHttpError', context)
+  }
 }

package/src/version.ts

@@ -1 +1 @@
-export const version = '1.3.4'
+export const version = '1.4.0-next.1'