@tramvai/module-micro-sentry 3.24.1

package/README.md

@@ -0,0 +1,66 @@
+# Micro-sentry
+
+Integration with [micro-sentry](https://github.com/taiga-family/micro-sentry).
+
+## Installation
+
+You need to install `@tramvai/module-micro-sentry`:
+
+```bash
+yarn add @tramvai/module-micro-sentry
+```
+
+And connect to the project: `TramvaiMicroSentryModule`:
+
+```tsx
+import { TramvaiMicroSentryModule } from '@tramvai/module-micro-sentry';
+
+createApp({
+  modules: [TramvaiMicroSentryModule],
+});
+```
+
+And make sure to add `SENTRY_DSN` environment on deployed stands. Otherwise module will not work.
+
+## Explanation
+
+### Environment variables
+
+Required:
+
+- `SENTRY_DSN` - [DSN](https://docs.sentry.io/product/sentry-basics/dsn-explainer/) of the app
+
+## How to
+
+### Send custom error
+
+```tsx
+import { declareAction } from '@tramvai/core';
+import { SENTRY_TOKEN } from '@tramvai/module-micro-sentry';
+import { loadUsers } from './users';
+
+export default declareAction({
+  name: 'loadUsers',
+  async fn() {
+    try {
+      await loadUsers();
+    } catch (e) {
+      microSentryClient.report(e);
+      throw e;
+    }
+  },
+  deps: {
+    microSentryClient: MICRO_SENTRY_INSTANCE_TOKEN,
+  },
+});
+```
+
+## Exported tokens
+
+#### `MICRO_SENTRY_INSTANCE_TOKEN`
+
+Ready to use instance of micro-sentry
+
+### `MICRO_SENTRY_OPTIONS_TOKEN`
+
+Configuration options for micro-sentry

package/lib/browser.d.ts

@@ -0,0 +1,5 @@
+export * from './tokens';
+export declare const TramvaiMicroSentryModule: import("@tinkoff/dippy/lib/modules/module.h").ModuleClass & Partial<import("@tinkoff/dippy/lib/modules/module.h").ModuleSecretParameters> & {
+    [x: string]: (...args: any[]) => import("@tramvai/core").ModuleType;
+};
+//# sourceMappingURL=browser.d.ts.map

package/lib/browser.js

@@ -0,0 +1,28 @@
+import { declareModule, provide } from '@tramvai/core';
+import { ENV_MANAGER_TOKEN } from '@tramvai/module-common';
+import { sharedProviders } from './providers.browser.js';
+import { MICRO_SENTRY_OPTIONS_TOKEN } from './tokens.browser.js';
+export { MICRO_SENTRY_INSTANCE_TOKEN, MICRO_SENTRY_OPTIONS_TOKEN } from './tokens.browser.js';
+
+const TramvaiMicroSentryModule = declareModule({
+    name: 'TramvaiMicroSentryModule',
+    providers: [
+        provide({
+            provide: MICRO_SENTRY_OPTIONS_TOKEN,
+            useFactory: ({ envManager }) => {
+                const defaultOptions = {
+                    environment: process.env.NODE_ENV,
+                    dsn: envManager.get('SENTRY_DSN'),
+                };
+                return defaultOptions;
+            },
+            deps: {
+                envManager: ENV_MANAGER_TOKEN,
+            },
+        }),
+        ...sharedProviders,
+    ],
+    imports: [],
+});
+
+export { TramvaiMicroSentryModule };

package/lib/providers.browser.js

@@ -0,0 +1,33 @@
+import { provide, commandLineListTokens } from '@tramvai/core';
+import { ENV_USED_TOKEN } from '@tramvai/module-common';
+import { BrowserMicroSentryClient } from '@micro-sentry/browser';
+import { MICRO_SENTRY_INSTANCE_TOKEN, MICRO_SENTRY_OPTIONS_TOKEN } from './tokens.browser.js';
+
+const sharedProviders = [
+    provide({
+        provide: ENV_USED_TOKEN,
+        useValue: [{ key: 'SENTRY_DSN' }],
+    }),
+    provide({
+        provide: MICRO_SENTRY_INSTANCE_TOKEN,
+        useFactory: ({ microSentryOptions }) => {
+            return new BrowserMicroSentryClient(microSentryOptions);
+        },
+        deps: {
+            microSentryOptions: MICRO_SENTRY_OPTIONS_TOKEN,
+        },
+    }),
+    provide({
+        provide: commandLineListTokens.init,
+        useFactory: ({ microSentry }) => {
+            return function initMicroSentry() {
+                return microSentry;
+            };
+        },
+        deps: {
+            microSentry: MICRO_SENTRY_INSTANCE_TOKEN,
+        },
+    }),
+];
+
+export { sharedProviders };

package/lib/providers.d.ts

@@ -0,0 +1,3 @@
+import { type Provider } from '@tramvai/core';
+export declare const sharedProviders: Provider[];
+//# sourceMappingURL=providers.d.ts.map

package/lib/server.d.ts

@@ -0,0 +1,5 @@
+export * from './tokens';
+export declare const TramvaiMicroSentryModule: import("@tinkoff/dippy/lib/modules/module.h").ModuleClass & Partial<import("@tinkoff/dippy/lib/modules/module.h").ModuleSecretParameters> & {
+    [x: string]: (...args: any[]) => import("@tramvai/core").ModuleType;
+};
+//# sourceMappingURL=server.d.ts.map

package/lib/server.es.js

@@ -0,0 +1,21 @@
+import { declareModule, provide } from '@tramvai/core';
+import { MICRO_SENTRY_INSTANCE_TOKEN } from './tokens.es.js';
+export { MICRO_SENTRY_INSTANCE_TOKEN, MICRO_SENTRY_OPTIONS_TOKEN } from './tokens.es.js';
+
+const TramvaiMicroSentryModule = declareModule({
+    name: 'TramvaiMicroSentryModule',
+    imports: [],
+    providers: [
+        provide({
+            provide: MICRO_SENTRY_INSTANCE_TOKEN,
+            useFactory: () => {
+                if (process.env.NODE_ENV === 'development') {
+                    console.warn('micro-sentry will work only in browser environment, and will not work in server environment. If you need error logging both on server and client, take a look on @tramvai/module-sentry package');
+                }
+                return null;
+            },
+        }),
+    ],
+});
+
+export { TramvaiMicroSentryModule };

package/lib/server.js

@@ -0,0 +1,26 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var core = require('@tramvai/core');
+var tokens = require('./tokens.js');
+
+const TramvaiMicroSentryModule = core.declareModule({
+    name: 'TramvaiMicroSentryModule',
+    imports: [],
+    providers: [
+        core.provide({
+            provide: tokens.MICRO_SENTRY_INSTANCE_TOKEN,
+            useFactory: () => {
+                if (process.env.NODE_ENV === 'development') {
+                    console.warn('micro-sentry will work only in browser environment, and will not work in server environment. If you need error logging both on server and client, take a look on @tramvai/module-sentry package');
+                }
+                return null;
+            },
+        }),
+    ],
+});
+
+exports.MICRO_SENTRY_INSTANCE_TOKEN = tokens.MICRO_SENTRY_INSTANCE_TOKEN;
+exports.MICRO_SENTRY_OPTIONS_TOKEN = tokens.MICRO_SENTRY_OPTIONS_TOKEN;
+exports.TramvaiMicroSentryModule = TramvaiMicroSentryModule;

package/lib/tokens.browser.js

@@ -0,0 +1,6 @@
+import { createToken } from '@tramvai/core';
+
+const MICRO_SENTRY_INSTANCE_TOKEN = createToken('MICRO_SENTRY_INSTANCE_TOKEN');
+const MICRO_SENTRY_OPTIONS_TOKEN = createToken('MICRO_SENTRY_OPTIONS_TOKEN');
+
+export { MICRO_SENTRY_INSTANCE_TOKEN, MICRO_SENTRY_OPTIONS_TOKEN };

package/lib/tokens.d.ts

@@ -0,0 +1,8 @@
+import type { BrowserSentryClientOptions, BrowserMicroSentryClient } from '@micro-sentry/browser';
+export declare const MICRO_SENTRY_INSTANCE_TOKEN: (BrowserMicroSentryClient & {
+    __type?: "base token" | undefined;
+}) | null;
+export declare const MICRO_SENTRY_OPTIONS_TOKEN: BrowserSentryClientOptions & {
+    __type?: "base token" | undefined;
+};
+//# sourceMappingURL=tokens.d.ts.map

package/lib/tokens.es.js

@@ -0,0 +1,6 @@
+import { createToken } from '@tramvai/core';
+
+const MICRO_SENTRY_INSTANCE_TOKEN = createToken('MICRO_SENTRY_INSTANCE_TOKEN');
+const MICRO_SENTRY_OPTIONS_TOKEN = createToken('MICRO_SENTRY_OPTIONS_TOKEN');
+
+export { MICRO_SENTRY_INSTANCE_TOKEN, MICRO_SENTRY_OPTIONS_TOKEN };

package/lib/tokens.js

@@ -0,0 +1,11 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var core = require('@tramvai/core');
+
+const MICRO_SENTRY_INSTANCE_TOKEN = core.createToken('MICRO_SENTRY_INSTANCE_TOKEN');
+const MICRO_SENTRY_OPTIONS_TOKEN = core.createToken('MICRO_SENTRY_OPTIONS_TOKEN');
+
+exports.MICRO_SENTRY_INSTANCE_TOKEN = MICRO_SENTRY_INSTANCE_TOKEN;
+exports.MICRO_SENTRY_OPTIONS_TOKEN = MICRO_SENTRY_OPTIONS_TOKEN;

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@tramvai/module-micro-sentry",
+  "version": "3.24.1",
+  "description": "Micro-sentry module",
+  "browser": "lib/browser.js",
+  "main": "lib/server.js",
+  "typings": "lib/server.d.ts",
+  "license": "Apache-2.0",
+  "files": [
+    "lib"
+  ],
+  "sideEffects": false,
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:Tinkoff/tramvai.git"
+  },
+  "scripts": {
+    "build": "tramvai-build --forPublish --preserveModules",
+    "watch": "tsc -w"
+  },
+  "dependencies": {
+    "@micro-sentry/browser": "^7.0.1"
+  },
+  "peerDependencies": {
+    "@tramvai/core": "3.24.1",
+    "@tramvai/module-common": "3.24.1"
+  },
+  "module": "lib/server.es.js"
+}