sentry-vir 0.0.0 → 0.0.2

package/dist/types/init-sentry/handle-sentry-send.d.ts

@@ -0,0 +1,16 @@
+import type { EventHint } from '@sentry/browser';
+import type { ErrorEvent, TransactionEvent } from '@sentry/types';
+import { SentryReleaseEnvEnum } from '../env/release-env';
+/** Creates a handler for Sentry events based on the given env. */
+export declare function createSentryHandler(
+/**
+ * The release environment (dev vs prod). Determines whether events should be sent to sentry or
+ * not.
+ */
+releaseEnv: SentryReleaseEnvEnum): (event: TransactionEvent | ErrorEvent, hint: EventHint) => TransactionEvent | ErrorEvent | null;
+/** Tries to extract the original event message from different possible Sentry types. */
+export declare function extractOriginalMessage(
+/** Event from Sentry. */
+event: TransactionEvent | ErrorEvent, 
+/** EventHint generated by Sentry. */
+hint: EventHint): string;

package/dist/types/init-sentry/init-sentry.d.ts

@@ -0,0 +1,194 @@
+import type { Options } from '@sentry/types';
+import { SentryExecutionEnvEnum } from '../env/execution-env';
+import { SentryReleaseEnvEnum } from '../env/release-env';
+import { EventExtraContextCreator } from '../event-context/event-context';
+import { UserOverrides } from './sentry-config';
+/** Configuration for initializing Sentry. */
+export type InitSentryInput = {
+    /**
+     * The environment wherein the Sentry client will execute. Used to determine which Sentry client
+     * to load: browser or node.
+     */
+    executionEnv: SentryExecutionEnvEnum;
+    /**
+     * The release environment, prod vs dev rather than browser vs node. In dev, events won't be
+     * sent to sentry. In both options, all events will be logged to the local console.
+     */
+    releaseEnv: SentryReleaseEnvEnum;
+    /** Name for the current release. */
+    releaseName: Required<Options>['release'];
+    /** DSN needed for Sentry to hook up to your sentry project. */
+    dsn: Required<Options>['dsn'];
+    /**
+     * Optionally create extra context to be included in all Sentry events. This will execute for
+     * each event that is processed.
+     */
+    createUniversalContext?: EventExtraContextCreator | undefined;
+    /** Optionally override any Sentry config properties that this package sets. */
+    sentryConfigOverrides?: UserOverrides;
+};
+/**
+ * Setup a sentry client with all the default sentry-vir integrations and configs.
+ *
+ * To override any default sentry-vir settings, include them in the userConfig input.
+ */
+export declare function initSentry({ executionEnv, dsn, releaseEnv, releaseName, sentryConfigOverrides, createUniversalContext, }: InitSentryInput): Promise<{
+    default: typeof import("@sentry/browser");
+    Integrations: {
+        GlobalHandlers: typeof import("@sentry/browser").GlobalHandlers;
+        TryCatch: typeof import("@sentry/browser").TryCatch;
+        Breadcrumbs: typeof import("@sentry/browser").Breadcrumbs;
+        LinkedErrors: typeof import("@sentry/browser").LinkedErrors;
+        HttpContext: typeof import("@sentry/browser").HttpContext;
+        Dedupe: typeof import("@sentry/browser").Dedupe;
+        FunctionToString: typeof import("@sentry/core").FunctionToString;
+        InboundFilters: typeof import("@sentry/core").InboundFilters;
+    };
+    Replay: typeof import("@sentry/replay").Replay;
+    BrowserTracing: typeof import("@sentry-internal/tracing").BrowserTracing;
+    defaultRequestInstrumentationOptions: import("@sentry-internal/tracing").RequestInstrumentationOptions;
+    instrumentOutgoingRequests: typeof import("@sentry-internal/tracing").instrumentOutgoingRequests;
+    addTracingExtensions: typeof import("@sentry/core").addTracingExtensions;
+    setMeasurement: typeof import("@sentry/core").setMeasurement;
+    extractTraceparentData: typeof import("@sentry/utils").extractTraceparentData;
+    getActiveTransaction: typeof import("@sentry/core").getActiveTransaction;
+    spanStatusfromHttpCode: typeof import("@sentry/core").spanStatusfromHttpCode;
+    trace: typeof import("@sentry/core").trace;
+    makeMultiplexedTransport: typeof import("@sentry/core").makeMultiplexedTransport;
+    ModuleMetadata: typeof import("@sentry/core").ModuleMetadata;
+    makeBrowserOfflineTransport: typeof import("@sentry/browser").makeBrowserOfflineTransport;
+    onProfilingStartRouteTransaction: typeof import("@sentry/browser").onProfilingStartRouteTransaction;
+    BrowserProfilingIntegration: typeof import("@sentry/browser").BrowserProfilingIntegration;
+    addGlobalEventProcessor: typeof import("@sentry/core").addGlobalEventProcessor;
+    addBreadcrumb: typeof import("@sentry/core").addBreadcrumb;
+    captureException: typeof import("@sentry/core").captureException;
+    captureEvent: typeof import("@sentry/core").captureEvent;
+    captureMessage: typeof import("@sentry/core").captureMessage;
+    close: typeof import("@sentry/core").close;
+    configureScope: typeof import("@sentry/core").configureScope;
+    createTransport: typeof import("@sentry/core").createTransport;
+    flush: typeof import("@sentry/core").flush;
+    getHubFromCarrier: typeof import("@sentry/core").getHubFromCarrier;
+    getCurrentHub: typeof import("@sentry/core").getCurrentHub;
+    Hub: typeof import("@sentry/core").Hub;
+    lastEventId: typeof import("@sentry/core").lastEventId;
+    makeMain: typeof import("@sentry/core").makeMain;
+    Scope: typeof import("@sentry/core").Scope;
+    startTransaction: typeof import("@sentry/core").startTransaction;
+    getActiveSpan: typeof import("@sentry/core").getActiveSpan;
+    startSpan: typeof import("@sentry/core").startSpan;
+    startInactiveSpan: typeof import("@sentry/core").startInactiveSpan;
+    startSpanManual: typeof import("@sentry/core").startSpanManual;
+    SDK_VERSION: "7.73.0";
+    setContext: typeof import("@sentry/core").setContext;
+    setExtra: typeof import("@sentry/core").setExtra;
+    setExtras: typeof import("@sentry/core").setExtras;
+    setTag: typeof import("@sentry/core").setTag;
+    setTags: typeof import("@sentry/core").setTags;
+    setUser: typeof import("@sentry/core").setUser;
+    withScope: typeof import("@sentry/core").withScope;
+    FunctionToString: typeof import("@sentry/core").FunctionToString;
+    InboundFilters: typeof import("@sentry/core").InboundFilters;
+    WINDOW: import("@sentry/utils").InternalGlobal & Window;
+    BrowserClient: typeof import("@sentry/browser").BrowserClient;
+    makeFetchTransport: typeof import("@sentry/browser").makeFetchTransport;
+    makeXHRTransport: typeof import("@sentry/browser").makeXHRTransport;
+    defaultStackParser: import("@sentry/types").StackParser;
+    defaultStackLineParsers: import("@sentry/types").StackLineParser[];
+    chromeStackLineParser: import("@sentry/types").StackLineParser;
+    geckoStackLineParser: import("@sentry/types").StackLineParser;
+    opera10StackLineParser: import("@sentry/types").StackLineParser;
+    opera11StackLineParser: import("@sentry/types").StackLineParser;
+    winjsStackLineParser: import("@sentry/types").StackLineParser;
+    eventFromException: typeof import("@sentry/browser").eventFromException;
+    eventFromMessage: typeof import("@sentry/browser").eventFromMessage;
+    exceptionFromError: typeof import("@sentry/browser").exceptionFromError;
+    createUserFeedbackEnvelope: typeof import("@sentry/browser").createUserFeedbackEnvelope;
+    defaultIntegrations: (import("@sentry/browser").HttpContext | import("@sentry/browser").Dedupe | import("@sentry/core").InboundFilters | import("@sentry/core").FunctionToString | import("@sentry/browser").GlobalHandlers | import("@sentry/browser").TryCatch | import("@sentry/browser").Breadcrumbs | import("@sentry/browser").LinkedErrors)[];
+    forceLoad: typeof import("@sentry/browser").forceLoad;
+    init: typeof import("@sentry/browser").init;
+    onLoad: typeof import("@sentry/browser").onLoad;
+    showReportDialog: typeof import("@sentry/browser").showReportDialog;
+    captureUserFeedback: typeof import("@sentry/browser").captureUserFeedback;
+    wrap: typeof import("@sentry/browser").wrap;
+    GlobalHandlers: typeof import("@sentry/browser").GlobalHandlers;
+    TryCatch: typeof import("@sentry/browser").TryCatch;
+    Breadcrumbs: typeof import("@sentry/browser").Breadcrumbs;
+    LinkedErrors: typeof import("@sentry/browser").LinkedErrors;
+    HttpContext: typeof import("@sentry/browser").HttpContext;
+    Dedupe: typeof import("@sentry/browser").Dedupe;
+} | {
+    default: typeof import("@sentry/node");
+    addGlobalEventProcessor: typeof import("@sentry/core").addGlobalEventProcessor;
+    addBreadcrumb: typeof import("@sentry/core").addBreadcrumb;
+    captureException: typeof import("@sentry/core").captureException;
+    captureEvent: typeof import("@sentry/core").captureEvent;
+    captureMessage: typeof import("@sentry/core").captureMessage;
+    close: typeof import("@sentry/core").close;
+    configureScope: typeof import("@sentry/core").configureScope;
+    createTransport: typeof import("@sentry/core").createTransport;
+    extractTraceparentData: typeof import("@sentry/utils").extractTraceparentData;
+    flush: typeof import("@sentry/core").flush;
+    getActiveTransaction: typeof import("@sentry/core").getActiveTransaction;
+    getHubFromCarrier: typeof import("@sentry/core").getHubFromCarrier;
+    getCurrentHub: typeof import("@sentry/core").getCurrentHub;
+    Hub: typeof import("@sentry/core").Hub;
+    lastEventId: typeof import("@sentry/core").lastEventId;
+    makeMain: typeof import("@sentry/core").makeMain;
+    runWithAsyncContext: typeof import("@sentry/core").runWithAsyncContext;
+    Scope: typeof import("@sentry/core").Scope;
+    startTransaction: typeof import("@sentry/core").startTransaction;
+    SDK_VERSION: "7.73.0";
+    setContext: typeof import("@sentry/core").setContext;
+    setExtra: typeof import("@sentry/core").setExtra;
+    setExtras: typeof import("@sentry/core").setExtras;
+    setTag: typeof import("@sentry/core").setTag;
+    setTags: typeof import("@sentry/core").setTags;
+    setUser: typeof import("@sentry/core").setUser;
+    spanStatusfromHttpCode: typeof import("@sentry/core").spanStatusfromHttpCode;
+    trace: typeof import("@sentry/core").trace;
+    withScope: typeof import("@sentry/core").withScope;
+    captureCheckIn: typeof import("@sentry/core").captureCheckIn;
+    setMeasurement: typeof import("@sentry/core").setMeasurement;
+    getActiveSpan: typeof import("@sentry/core").getActiveSpan;
+    startSpan: typeof import("@sentry/core").startSpan;
+    startActiveSpan: typeof import("@sentry/core").startSpan;
+    startInactiveSpan: typeof import("@sentry/core").startInactiveSpan;
+    startSpanManual: typeof import("@sentry/core").startSpanManual;
+    autoDiscoverNodePerformanceMonitoringIntegrations: typeof import("@sentry/node").autoDiscoverNodePerformanceMonitoringIntegrations;
+    NodeClient: typeof import("@sentry/node").NodeClient;
+    makeNodeTransport: typeof import("@sentry/node").makeNodeTransport;
+    defaultIntegrations: (import("@sentry/core").InboundFilters | import("@sentry/core").FunctionToString | import("@sentry/node/types/integrations").OnUncaughtException | import("@sentry/node/types/integrations").OnUnhandledRejection | import("@sentry/node/types/integrations").ContextLines | import("@sentry/node/types/integrations").Context | import("@sentry/node/types/integrations").Console | import("@sentry/node/types/integrations").Http | import("@sentry/node/types/integrations").LinkedErrors | import("@sentry/node/types/integrations").Modules | import("@sentry/node/types/integrations").RequestData | import("@sentry/node/types/integrations").LocalVariables | import("@sentry/node/types/integrations").Undici)[];
+    init: typeof import("@sentry/node").init;
+    defaultStackParser: import("@sentry/types").StackParser;
+    getSentryRelease: typeof import("@sentry/node").getSentryRelease;
+    addRequestDataToEvent: typeof import("@sentry/node").addRequestDataToEvent;
+    DEFAULT_USER_INCLUDES: string[];
+    extractRequestData: typeof import("@sentry/node").extractRequestData;
+    deepReadDirSync: typeof import("@sentry/node").deepReadDirSync;
+    getModuleFromFilename: typeof import("@sentry/node").getModuleFromFilename;
+    enableAnrDetection: typeof import("@sentry/node").enableAnrDetection;
+    Integrations: {
+        Apollo: typeof import("@sentry-internal/tracing").Apollo;
+        Express: typeof import("@sentry-internal/tracing").Express;
+        GraphQL: typeof import("@sentry-internal/tracing").GraphQL;
+        Mongo: typeof import("@sentry-internal/tracing").Mongo;
+        Mysql: typeof import("@sentry-internal/tracing").Mysql;
+        Postgres: typeof import("@sentry-internal/tracing").Postgres;
+        Prisma: typeof import("@sentry-internal/tracing").Prisma;
+        Console: typeof import("@sentry/node/types/integrations").Console;
+        Http: typeof import("@sentry/node/types/integrations").Http;
+        OnUncaughtException: typeof import("@sentry/node/types/integrations").OnUncaughtException;
+        OnUnhandledRejection: typeof import("@sentry/node/types/integrations").OnUnhandledRejection;
+        LinkedErrors: typeof import("@sentry/node/types/integrations").LinkedErrors;
+        Modules: typeof import("@sentry/node/types/integrations").Modules;
+        ContextLines: typeof import("@sentry/node/types/integrations").ContextLines;
+        Context: typeof import("@sentry/node/types/integrations").Context;
+        RequestData: typeof import("@sentry/node/types/integrations").RequestData;
+        LocalVariables: typeof import("@sentry/node/types/integrations").LocalVariables;
+        Undici: typeof import("@sentry/node/types/integrations").Undici;
+        FunctionToString: typeof import("@sentry/core").FunctionToString;
+        InboundFilters: typeof import("@sentry/core").InboundFilters;
+    };
+    Handlers: typeof import("@sentry/node/types/handlers");
+}>;

package/dist/types/init-sentry/sentry-config.d.ts

@@ -0,0 +1,9 @@
+import type { Options } from '@sentry/types';
+import { SentryBrowserDep, SentryDepByEnv, SentryExecutionEnvEnum, SentryNodeDep } from '../env/execution-env';
+import { SentryReleaseEnvEnum } from '../env/release-env';
+/** Optional UserOverrides of Sentry config values. */
+export type UserOverrides = Omit<Partial<Options>, keyof RequiredSentryOptions> | undefined;
+/** Sentry config options that are required. */
+export type RequiredSentryOptions = Pick<Required<Options>, 'dsn' | 'environment' | 'release'>;
+/** Creates the sentry config used internally by sentry-vir. */
+export declare function createSentryConfig<const Env extends SentryExecutionEnvEnum>(env: Env, sentryDep: SentryDepByEnv<Env>, requiredSentryOptions: RequiredSentryOptions, userOverrides: UserOverrides, releaseEnv: SentryReleaseEnvEnum): Promise<SentryBrowserDep | SentryNodeDep>;

package/dist/types/init-sentry/sentry-logger.d.ts

@@ -0,0 +1,40 @@
+import { AnyFunction, MaybePromise } from '@augment-vir/common';
+import type { Event as SentryEvent } from '@sentry/types';
+import type { SentryDep } from '../env/execution-env';
+import { EventDetails, EventExtraContext } from '../event-context/event-context';
+/** The bare minimum Sentry client needed for logging events. */
+export type SentryClientForLogging = Pick<SentryDep, 'captureMessage' | 'captureException' | 'captureEvent'>;
+/** An event that was triggered before setSentryClientForLogging was called. */
+export type PrematureEvent<EntryPointFunction extends AnyFunction> = {
+    entryPoint: EntryPointFunction;
+    inputs: Parameters<EntryPointFunction>;
+};
+/**
+ * Used to store events before the Sentry client is setup. This is exported for testing purposes
+ * only, you don't need to do anything with this.
+ */
+export declare const prematureSentryEvents: PrematureEvent<any>[];
+/**
+ * Asynchronously set the Sentry client for logging. When this is called, any events that were
+ * triggered beforehand are handled. Thus, this set can be done at any time, allowing for
+ * asynchronous Sentry client setup but synchronous log and error handling.
+ *
+ * This should be called as soon as possible after you have a return value from initSentry.
+ *
+ * This can be safely called multiple times (to overwrite the previously set Sentry client) because
+ * previous events won't be handled multiple times.
+ */
+export declare function setSentryClientForLogging(client: MaybePromise<SentryClientForLogging>): Promise<void>;
+/** Record an error to Sentry without throwing it. */
+export declare function handleError(error: unknown, extraContext?: EventExtraContext): string | undefined;
+/** Send non-error events to Sentry. */
+export declare const sendLog: {
+    /** Sends an even to Sentry with debug severity. */
+    readonly debug: (info: Parameters<typeof sendLogToSentry>[0], extraContext?: EventExtraContext) => string | undefined;
+    /** Sends an even to Sentry with info severity. */
+    readonly info: (info: Parameters<typeof sendLogToSentry>[0], extraContext?: EventExtraContext) => string | undefined;
+    /** Sends an even to Sentry with warning severity. */
+    readonly warning: (info: Parameters<typeof sendLogToSentry>[0], extraContext?: EventExtraContext) => string | undefined;
+};
+declare function sendLogToSentry(logInfo: string | Omit<SentryEvent, 'extra' | 'level'>, eventDetails: EventDetails): string | undefined;
+export {};

package/package.json

@@ -1,12 +1,70 @@
 {
-  "name": "sentry-vir",
-  "version": "0.0.0",
-  "description": "",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "MIT"
+    "name": "sentry-vir",
+    "version": "0.0.2",
+    "keywords": [
+        "config",
+        "helper",
+        "sentry",
+        "vir"
+    ],
+    "homepage": "https://github.com/electrovir/sentry-vir",
+    "bugs": {
+        "url": "https://github.com/electrovir/sentry-vir/issues"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/electrovir/sentry-vir"
+    },
+    "license": "(MIT or CC0 1.0)",
+    "author": {
+        "name": "electrovir",
+        "url": "https://github.com/electrovir"
+    },
+    "main": "dist/cjs/index.js",
+    "module": "dist/esm/index.js",
+    "types": "dist/types/index.d.ts",
+    "scripts": {
+        "compile": "rm -rf dist && tsc --project tsconfig.json && tsc --project tsconfig.cjs.json",
+        "docs": "virmator docs",
+        "format": "virmator format",
+        "publish": "virmator publish \"npm run compile && npm run test:all\"",
+        "test": "virmator test-web",
+        "test:all": "concurrently --colors --kill-others-on-fail -c auto --names types,tests,spelling,format,docs \"npm run test:types\" \"npm run test:coverage\" \"npm run test:spelling\" \"npm run test:format\" \"npm run test:docs\"",
+        "test:coverage": "npm run test coverage",
+        "test:docs": "virmator docs check",
+        "test:format": "virmator format check",
+        "test:spelling": "virmator spellcheck",
+        "test:types": "tsc --noEmit"
+    },
+    "dependencies": {
+        "@augment-vir/common": "^19.4.1",
+        "@sentry/browser": "^7.73.0",
+        "@sentry/node": "^7.73.0",
+        "type-fest": "^4.3.3"
+    },
+    "devDependencies": {
+        "@augment-vir/browser-testing": "^19.4.1",
+        "@open-wc/testing": "^3.2.0",
+        "@types/mocha": "^10.0.2",
+        "@web/dev-server-esbuild": "^0.4.1",
+        "@web/test-runner": "^0.17.1",
+        "@web/test-runner-commands": "^0.8.0",
+        "@web/test-runner-playwright": "^0.10.1",
+        "@web/test-runner-visual-regression": "^0.8.2",
+        "cspell": "^7.3.7",
+        "esbuild": "^0.19.4",
+        "istanbul-smart-text-reporter": "^1.1.2",
+        "markdown-code-example-inserter": "^0.3.2",
+        "npm-check-updates": "~16.12.3",
+        "prettier": "^2.8.8",
+        "prettier-plugin-interpolated-html-tags": "^0.0.4",
+        "prettier-plugin-jsdoc": "^0.4.2",
+        "prettier-plugin-multiline-arrays": "^2.0.0",
+        "prettier-plugin-organize-imports": "^3.2.3",
+        "prettier-plugin-packagejson": "^2.4.6",
+        "prettier-plugin-sort-json": "^2.0.0",
+        "prettier-plugin-toml": "^0.3.5",
+        "typedoc": "^0.25.1",
+        "virmator": "^8.0.5"
+    }
 }