Add HTTP response Helper & Make initNammatham create Azure Functions …

…for default (#131)

.gitignore

@@ -135,4 +135,5 @@ inversify-express-utils
 
 .azurite
 tmp
-.nx
+.nx
+sample_code

README.md

@@ -16,6 +16,8 @@ Type-safe Serverless Library for Azure Functions and friends
 > 
 > Note: [Nammatham v1](https://www.npmjs.com/package/nammatham) is currently in maintenance mode. no new features are actively being developed
 
+You're reading v2 docs
+
 
 | Version | Status      | Azure Functions <br>Node.js Lib | Branch       | Build Status                                                                                                                                                                                                                                                                                                                |
 | ------- | ----------- | ----------------------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -37,31 +39,28 @@ Nammatham (นามธรรม in Thai, pronounced `/naam ma tham/`, means **a
 npm install nammatham@alpha
 ```
 
-You can also install independently
-```bash
-npm install @nammatham/core @nammatham/azure-functions @nammatham/express
-```
-
 ### Example
 
 You can see [examples](examples) or follow the minimal app getting started below:
 
+> `initNammatham.create()` is a factory function for creating Nammatham App, it's a wrapper for Azure Functions App.
+
 ```typescript
-import { initNammatham, AzureFunctionsAdapter, expressPlugin } from "nammatham";
+import { initNammatham, expressPlugin } from 'nammatham';
 
-const n = initNammatham.create(new AzureFunctionsAdapter());
+const n = initNammatham.create();
 const func = n.func;
 const app = n.app;
 
 const helloFunction = func
   .httpGet('hello', {
     route: 'hello-world',
   })
-  .handler(async ({trigger, context}) => {
-    context.log('HTTP trigger function processed a request.');
-    context.debug(`Http function processed request for url "${trigger.url}"`);
-    const name = trigger.query.get('name') || (await trigger.text()) || 'world';
-    return { body: `Hello, ${name}!` };
+  .handler(async c => {
+    c.context.log('HTTP trigger function processed a request.');
+    c.context.debug(`Http function processed request for url "${c.trigger.url}"`);
+    const name = c.trigger.query.get('name') || (await c.trigger.text()) || 'world';
+    return c.text(`Hello, ${name}!`);
   });
 
 app.addFunctions(helloFunction);

examples/azure-functions-minimal/src/main.ts

@@ -1,6 +1,6 @@
-import { AzureFunctionsAdapter, initNammatham, expressPlugin } from 'nammatham';
+import { initNammatham, expressPlugin } from 'nammatham';
 
-const n = initNammatham.create(new AzureFunctionsAdapter());
+const n = initNammatham.create();
 const func = n.func;
 const app = n.app;
 
@@ -9,11 +9,11 @@ app.addFunctions(
     .httpGet('hello', {
       route: 'hello-world',
     })
-    .handler(async ({ trigger, context }) => {
-      context.log('HTTP trigger function processed a request.');
-      context.debug(`Http function processed request for url "${trigger.url}"`);
-      const name = trigger.query.get('name') || (await trigger.text()) || 'world';
-      return { body: `Hello, ${name}!` };
+    .handler(async c => {
+      c.context.log('HTTP trigger function processed a request.');
+      c.context.debug(`Http function processed request for url "${c.trigger.url}"`);
+      const name = c.trigger.query.get('name') || (await c.trigger.text()) || 'world';
+      return c.text(`Hello, ${name}!`);
     })
 );
 

examples/azure-functions-timer-trigger/src/functions/simple-timer.ts

@@ -4,7 +4,7 @@ export default func
   .timer('watcher', {
     schedule: '*/5 * * * * *',
   })
-  .handler(async ({trigger, context}) => {
-    context.info('Timer triggered!'); 
+  .handler(async ({ trigger, context }) => {
+    context.info('Timer triggered!');
     trigger.isPastDue ? context.info('Timer is past due!') : null;
   });

examples/azure-functions-timer-trigger/src/nammatham.ts

@@ -1,6 +1,6 @@
-import { initNammatham, AzureFunctionsAdapter } from 'nammatham';
+import { initNammatham } from 'nammatham';
 
-const n = initNammatham.create(new AzureFunctionsAdapter());
+const n = initNammatham.create();
 n.func;
 // ^?
 export const func = n.func;

examples/azure-functions-with-inversify/src/functions/hello.ts

@@ -15,12 +15,10 @@ export default func
   .setContext({
     services,
   })
-  .handler(async ({ trigger, context, services }) => {
-    context.log('HTTP trigger function processed a request.');
+  .handler(async c => {
+    c.context.log('HTTP trigger function processed a request.');
 
-    return {
-      jsonBody: {
-        data: 'hello world' + services.dataService.getData(),
-      },
-    };
+    return c.json({
+      data: 'hello world' + services.dataService.getData(),
+    });
   });

examples/azure-functions-with-inversify/src/nammatham.ts

@@ -1,6 +1,6 @@
-import { initNammatham, AzureFunctionsAdapter } from 'nammatham';
+import { initNammatham } from 'nammatham';
 
-const n = initNammatham.create(new AzureFunctionsAdapter());
+const n = initNammatham.create();
 n.func;
 // ^?
 export const func = n.func;

examples/azure-functions-with-test/__test__/helloFunction.test.ts

@@ -1,19 +1,18 @@
 import { expect, test } from 'vitest';
 import helloFunc from '../src/functions/hello';
 import { HttpRequest, InvocationContext } from '@azure/functions';
+import { NammathamContext } from 'nammatham';
 
 test('helloFunc', async () => {
   const handler = helloFunc.getHandler();
-  const result = await handler({
-    context: new InvocationContext(),
-    trigger: new HttpRequest({
-      method: 'GET',
-      url: 'http://localhost:3000/api/hello-world',
-      query: {
-        name: 'world',
-      },
-    }),
-  });
+  const nammathamConext = new NammathamContext(new InvocationContext(), new HttpRequest({
+    method: 'GET',
+    url: 'http://localhost:3000/api/hello-world',
+    query: {
+      name: 'world',
+    },
+  }))
+  const result = await handler(nammathamConext);
 
   expect(result).toEqual({
     jsonBody: {

examples/azure-functions-with-test/src/functions/hello.ts

@@ -4,20 +4,17 @@ export default func
   .httpGet('hello', {
     route: 'hello-world',
   })
-  .handler(async ({ trigger, context }) => {
-    context.log('HTTP trigger function processed a request.');
-    context.debug(`Http function processed request for url "${trigger.url}"`);
-    const name = trigger.query.get('name') || (await trigger.text()) || 'world';
+  .handler(async c => {
+    c.context.log('HTTP trigger function processed a request.');
+    c.context.debug(`Http function processed request for url "${c.trigger.url}"`);
+    const name = c.trigger.query.get('name') || (await c.trigger.text()) || 'world';
     if (name === 'error') {
       throw new Error('this is an error');
     }
-    const result = {
+    return c.json({
       data: {
         name: name,
-        message: `Hello, ${name}!`
-      }
-    }
-    return {
-      jsonBody: result,
-    }
+        message: `Hello, ${name}!`,
+      },
+    });
   });

examples/azure-functions-with-test/src/nammatham.ts

@@ -1,7 +1,6 @@
 import { initNammatham } from 'nammatham';
-import { AzureFunctionsAdapter } from 'nammatham';
 
-const n = initNammatham.create(new AzureFunctionsAdapter());
+const n = initNammatham.create();
 
 export const func = n.func;
 export const app = n.app;

examples/azure-functions-with-trpc/src/nammatham.ts

@@ -1,6 +1,6 @@
-import { initNammatham, AzureFunctionsAdapter } from 'nammatham';
+import { initNammatham } from 'nammatham';
 
-const n = initNammatham.create(new AzureFunctionsAdapter());
+const n = initNammatham.create();
 
 export const func = n.func;
 export const app = n.app;

examples/azure-functions/src/functions/blob.ts

@@ -17,12 +17,10 @@ export default func
     extraInputs: [blobInput],
     extraOutputs: [blobOutput],
   })
-  .handler(({ trigger, context }) => {
-    context.log('function processed work item:', trigger);
-    const blobInputValue = context.extraInputs.get(blobOutput);
+  .handler(c => {
+    c.context.log('function processed work item:', c.trigger);
+    const blobInputValue = c.context.extraInputs.get(blobOutput);
 
-    context.extraOutputs.set(blobOutput, blobInputValue);
-    return {
-      body: `Hello ${blobInputValue}`,
-    };
+    c.context.extraOutputs.set(blobOutput, blobInputValue);
+    return c.text(`Hello ${blobInputValue}`);
   });

examples/azure-functions/src/functions/hello.ts

@@ -4,20 +4,17 @@ export default func
   .httpGet('hello', {
     route: 'hello-world',
   })
-  .handler(async ({ trigger, context }) => {
-    context.log('HTTP trigger function processed a request.');
-    context.debug(`Http function processed request for url "${trigger.url}"`);
-    const name = trigger.query.get('name') || (await trigger.text()) || 'world';
+  .handler(async c => {
+    c.context.log('HTTP trigger function processed a request.');
+    c.context.debug(`Http function processed request for url "${c.trigger.url}"`);
+    const name = c.trigger.query.get('name') || (await c.trigger.text()) || 'world';
     if (name === 'error') {
       throw new Error('this is an error');
     }
-    const result = {
+    return c.json({
       data: {
         name: name,
-        message: `Hello, ${name}!`
-      }
-    }
-    return {
-      jsonBody: result,
-    }
+        message: `Hello, ${name}!`,
+      },
+    });
   });

examples/azure-functions/src/nammatham.ts

@@ -1,6 +1,6 @@
-import { initNammatham, AzureFunctionsAdapter } from 'nammatham';
+import { initNammatham } from 'nammatham';
 
-const n = initNammatham.create(new AzureFunctionsAdapter());
+const n = initNammatham.create();
 n.func;
 // ^?
 export const func = n.func;

packages/azure-functions/src/handler.ts

@@ -12,7 +12,7 @@ export class AzureFunctionsHandler<
   // eslint-disable-next-line @typescript-eslint/ban-types
   ExtraContext extends Record<string, unknown> = {}
 > extends BaseHandler<HandlerFunction<TTriggerType, TReturnType, ExtraContext>> {
-  context: ExtraContext = {} as ExtraContext;
+  extraContext: ExtraContext = {} as ExtraContext;
   protected funcHandler!: HandlerFunction<TTriggerType, TReturnType, ExtraContext>;
 
   constructor(
@@ -31,7 +31,8 @@ export class AzureFunctionsHandler<
   build(): AzureFunctionsEndpoint<TTriggerType, TReturnType> {
     const invokeHandler = (triggerInput: TTriggerType, innocationContext: InvocationContext) => {
       const nammathamContext = new NammathamContext(innocationContext, triggerInput);
-      return this.funcHandler({ ...nammathamContext, ...this.context });
+      Object.assign(nammathamContext, this.extraContext);
+      return this.funcHandler(nammathamContext as NammathamContext<TTriggerType> & ExtraContext);
     };
     return {
       ...this.functionOption,
@@ -43,7 +44,7 @@ export class AzureFunctionsHandler<
   }
 
   setContext<NewItem extends Record<string, unknown>>(context: NewItem) {
-    this.context = { ...this.context, ...context };
+    this.extraContext = { ...this.extraContext, ...context };
     return this as AzureFunctionsHandler<TTriggerType, TReturnType, ExtraContext & NewItem>;
   }
 

packages/azure-functions/src/http/HttpResponse.ts

@@ -0,0 +1,73 @@
+import * as type from '@azure/functions';
+
+/**
+ * Re-export from Azure Functions;
+ */
+export type AzureHttpResponse = type.HttpResponseInit | type.HttpResponse;
+export type Request = type.HttpRequest;
+
+/**
+ * Http Response Builder wrapping around azure/functions
+ */
+export type Header = Record<string, string>;
+export class HttpResponse {
+  protected _headers: Header;
+  protected _cookies: NonNullable<type.HttpResponseInit['cookies']> = [];
+  protected _httpResponse: type.HttpResponseInit;
+
+  constructor(responseInit?: Omit<type.HttpResponseInit, 'headers'> & { headers: Header }) {
+    this._httpResponse = {
+      ...responseInit,
+    };
+    this._headers = responseInit?.headers ?? {};
+  }
+
+  private build(): type.HttpResponseInit {
+    const result = {
+      ...this._httpResponse,
+    };
+    if (Object.values(this._headers).length > 0) {
+      result.headers = this._headers;
+    }
+
+    if (this._cookies.length > 0) {
+      result.cookies = this._cookies;
+    }
+    return result;
+  }
+
+  public text(body?: string) {
+    return new type.HttpResponse({
+      ...this.build(),
+      body,
+    });
+  }
+
+  public json<T extends object>(jsonBody: T): AzureHttpResponse {
+    return {
+      ...this.build(),
+      jsonBody,
+    };
+  }
+
+  public httpResponse(responseInit?: type.HttpResponseInit) {
+    return new type.HttpResponse(responseInit);
+  }
+
+  public header(key: string, value: string) {
+    this._headers[key] = value;
+    return this;
+  }
+
+  public headers(headers: Header) {
+    for (const [key, value] of Object.entries(headers)) {
+      this._headers[key] = value;
+    }
+    return this;
+  }
+
+  public status(status: number) {
+    this._httpResponse.status = status;
+    return this;
+  }
+}

packages/azure-functions/src/nammatham-context.ts

@@ -1,8 +1,8 @@
-import type { InvocationContext } from '@azure/functions';
+import { type InvocationContext } from '@azure/functions';
 
-import { NammathamContextBase } from '@nammatham/core';
+import { HttpResponse } from './http/HttpResponse';
 
-export class NammathamContext<TTriggerType> extends NammathamContextBase {
+export class NammathamContext<TTriggerType> extends HttpResponse {
   constructor(public readonly context: InvocationContext, public readonly trigger: TTriggerType) {
     super();
   }