@teamkeel/functions-runtime 0.245.2 → 0.246.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teamkeel/functions-runtime",
-  "version": "0.245.2",
+  "version": "0.246.0",
   "description": "Internal package used by @teamkeel/sdk",
   "main": "src/index.js",
   "scripts": {

package/src/RequestHeaders.js

@@ -0,0 +1,21 @@
+class RequestHeaders {
+  /**
+   * @param {{Object.<string, string>}} requestHeaders Map of request headers submitted from the client
+   */
+
+  constructor(requestHeaders) {
+    this._headers = new Headers(requestHeaders);
+  }
+
+  get(key) {
+    return this._headers.get(key);
+  }
+
+  has(key) {
+    return this._headers.has(key);
+  }
+}
+
+module.exports = {
+  RequestHeaders,
+};

package/src/handleRequest.js

@@ -10,7 +10,7 @@ const { errorToJSONRPCResponse, RuntimeErrors } = require("./errors");
 // to execute a custom function based on the contents of a jsonrpc-2.0 payload object.
 // To read more about jsonrpc request and response shapes, please read https://www.jsonrpc.org/specification
 async function handleRequest(request, config) {
-  const { createFunctionAPI, functions } = config;
+  const { createFunctionAPI, createContextAPI, functions } = config;
 
   if (!(request.method in functions)) {
     return createJSONRPCErrorResponse(
@@ -23,7 +23,8 @@ async function handleRequest(request, config) {
   try {
     const result = await functions[request.method](
       request.params,
-      createFunctionAPI()
+      createFunctionAPI(),
+      createContextAPI(request.meta)
     );
 
     if (result === undefined) {

package/src/handleRequest.test.js

@@ -13,6 +13,7 @@ test("when the custom function returns expected value", async () => {
       },
     },
     createFunctionAPI: () => {},
+    createContextAPI: () => {},
   };
 
   const rpcReq = createJSONRPCRequest("123", "createPost", { title: "a post" });
@@ -33,6 +34,7 @@ test("when the custom function doesnt return a value", async () => {
       createPost: async () => {},
     },
     createFunctionAPI: () => {},
+    createContextAPI: () => {},
   };
 
   const rpcReq = createJSONRPCRequest("123", "createPost", { title: "a post" });
@@ -53,6 +55,7 @@ test("when there is no matching function for the path", async () => {
       createPost: async () => {},
     },
     createFunctionAPI: () => {},
+    createContextAPI: () => {},
   };
 
   const rpcReq = createJSONRPCRequest("123", "unknown", { title: "a post" });
@@ -75,6 +78,7 @@ test("when there is an unexpected error in the custom function", async () => {
       },
     },
     createFunctionAPI: () => {},
+    createContextAPI: () => {},
   };
 
   const rpcReq = createJSONRPCRequest("123", "createPost", { title: "a post" });
@@ -97,6 +101,7 @@ test("when there is an unexpected object thrown in the custom function", async (
       },
     },
     createFunctionAPI: () => {},
+    createContextAPI: () => {},
   };
 
   const rpcReq = createJSONRPCRequest("123", "createPost", { title: "a post" });

package/src/index.d.ts

@@ -52,3 +52,14 @@ export type TimestampQueryInput = {
   before: string;
   after: string;
 };
+
+// Ctx API
+export type ContextAPI = {
+  headers: RequestHeaders;
+};
+
+// Request headers query API
+export type RequestHeaders = {
+  get(name: string): string;
+  has(name: string): boolean;
+};

package/src/index.js

@@ -1,10 +1,12 @@
 const { ModelAPI } = require("./ModelAPI");
+const { RequestHeaders } = require("./RequestHeaders");
 const { handleRequest } = require("./handleRequest");
 const KSUID = require("ksuid");
 const { getDatabase } = require("./database");
 
 module.exports = {
   ModelAPI,
+  RequestHeaders,
   handleRequest,
   getDatabase,
   ksuid() {