@vouchfor/libs 1.0.0

package/.editorconfig

@@ -0,0 +1,13 @@
+# editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

package/README.md

@@ -0,0 +1,134 @@
+# Share libs
+
+included modules
+- `dotenv`
+- `@logtail/node`
+- `@logtail/winston`
+- `@sentry/node`
+- `@sentry/tracing`
+- `winston`
+
+## Installation
+
+```bash
+// will need to publish this module to npm registry with private account
+npm i @vouchfor/libs
+
+// or directly from private repo
+
+npm i git+ssh://git@github.com:VouchAU/vouch-libs.git
+```
+
+## ENV variables
+
+```
+ENV=dev|staging|prod
+LOGTAIL_SOURCE_TOKE=xxxxxx
+SENTRY_DSN=xxxxxxx
+```
+
+## Logger
+
+`Logger` class is constructed using winston and [logtail](https://betterstack.com/logtail) as the transport layer.
+To channel the logs to `Logtail`, it requires `LOGTAIL_SOURCE_TOKEN` in the `.env` file, or register the token to the config module:
+
+```js
+import { Logger } from '@vouchfor/libs';
+
+const logger = new Logger();
+
+logger.info('Hi');
+// --> [INFO] Hi
+```
+
+get winstan logger instance directly
+```js
+import { getLogger } from '@vouchfor/libs';
+
+const logger = getLogger();
+
+logger.info('Hi');
+// --> [INFO] Hi
+```
+
+`getLogger` support winston `transformer` and `format` method passing through the config options
+```js
+const logger = getLogger({
+  transformer: (info) => ({...info, foo: process.env.BAR}),
+  format: (info) => `[LOGGER] ${JSON.stringiy(info)}`
+});
+
+logger.info('Hi');
+// --> [LOGGER] {"message": "Hi", "foo": "bar", ... }
+
+```
+
+Injecting metadata per process/request.
+```js
+import { Logger } from '@vouchfor/libs';
+
+const logger = new Logger({
+  metadata: {
+    requestId: "1234-123-123-1234",
+  }
+});
+
+logger.info('Hi'); 
+// --> [INFO] Hi {"metadata":{"requestId":"1234-123-123-1234"}}
+```
+
+Logtail `source_token` can be injected through the class initialisation.
+```js
+import { Logger } from '@vouchfor/libs';
+
+const logger = new Logger({
+  token: 'xxxxxxx',
+  metadata: {
+    requestId: "1234-123-123-1234",
+  }
+});
+
+logger.info('Hi');
+// --> [INFO] Hi {"metadata":{"requestId":"1234-123-123-1234"}}
+```
+
+## Sentry
+
+Sentry DSN is needed in `.env` file as in [.env](#env-variables).
+```js
+import { Sentry } from '@vouchfor/libs';
+
+try {
+  throw new Error('123');
+} catch (err) {
+  Sentry.captureException(err);
+}
+
+```
+
+To use Sentry in lambda, it requires `@sentry/serverless`
+
+```js
+import { Sentry } from '@vouchfor/libs';
+import { AWSLambda } from '@sentry/serverless';
+
+exports.handler = AWSLambda.wrapHandler(async (event, context) => {
+  throw new Error('oh, hello there!');
+});
+
+// or just use the `@sentry/serverless` module
+
+import * as Sentry from '@sentry/serverless';
+
+Sentry.init({
+  ...
+})
+
+exports.handler = Sentry.AWSLambda.wrapHandler(async (event, context) => {
+  throw new Error('oh, hello there!');
+});
+
+```
+
+
+

package/dist/@logtail/winston.d.ts

@@ -0,0 +1,8 @@
+import { LogEntry } from "winston";
+import Transport from "winston-transport";
+import { Logtail } from "@logtail/node";
+export declare class LogtailTransport extends Transport {
+    private _logtail;
+    constructor(_logtail: Logtail, opts?: Transport.TransportStreamOptions);
+    log(info: LogEntry, cb: Function): void;
+}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { Logger } from './logger';
+export type { LoggerConfig } from './logger';
+export { initSentry, Sentry } from './sentry';