@sentry/types - npm Package Compare versions

Comparing version 5.7.1 to 5.8.0-beta.0

dist/event.d.ts

@@ -6,2 +6,3 @@ import { Breadcrumb } from './breadcrumb';
 import { Severity } from './severity';
+import { Span } from './span';
 import { Stacktrace } from './stacktrace';
@@ -14,2 +15,3 @@ import { User } from './user';
     timestamp?: number;
+    start_timestamp?: number;
     level?: Severity;
@@ -45,5 +47,6 @@ platform?: string;
     type?: EventType;
+    spans?: Span[];
 }
 /** JSDoc */
-export declare type EventType = 'none';
+export declare type EventType = 'transaction';
 /** JSDoc */
@@ -50,0 +53,0 @@ export interface EventHint {

dist/hub.d.ts

@@ -7,2 +7,3 @@ import { Breadcrumb, BreadcrumbHint } from './breadcrumb';
 import { Severity } from './severity';
+import { Span, SpanContext } from './span';
 import { User } from './user';
@@ -161,3 +162,11 @@ /**
     };
+    /**
+     * This functions starts a span. If argument passed is of type `Span`, it'll run sampling on it if configured
+     * and attach a `SpanRecorder`. If it's of type `SpanContext` and there is already a `Span` on the Scope,
+     * the created Span will have a reference to it and become it's child. Otherwise it'll crete a new `Span`.
+     *
+     * @param span Already constructed span which should be started or properties with which the span should be created
+     */
+    startSpan(span?: Span | SpanContext): Span;
 }
 //# sourceMappingURL=hub.d.ts.map

dist/index.d.ts

@@ -19,3 +19,3 @@ export { Breadcrumb, BreadcrumbHint } from './breadcrumb';
 export { Severity } from './severity';
-export { Span } from './span';
+export { Span, SpanContext } from './span';
 export { StackFrame } from './stackframe';
@@ -22,0 +22,0 @@ export { Stacktrace } from './stacktrace';

dist/options.d.ts

@@ -66,2 +66,4 @@ import { Breadcrumb, BreadcrumbHint } from './breadcrumb';
     sampleRate?: number;
+    /** A global sample rate to apply to all transactions (0 - 1). */
+    tracesSampleRate?: number;
     /** Attaches stacktraces to pure capture message / log integrations */
@@ -96,3 +98,6 @@ attachStacktrace?: boolean;
     beforeBreadcrumb?(breadcrumb: Breadcrumb, hint?: BreadcrumbHint): Breadcrumb | null;
+    _experiments?: {
+        [key: string]: any;
+    };
 }
 //# sourceMappingURL=options.d.ts.map

dist/scope.d.ts

@@ -73,6 +73,2 @@ import { Breadcrumb } from './breadcrumb';
     setSpan(span?: Span): this;
-    /**
-     * Starts a new Span.
-     */
-    startSpan(): Span;
     /** Clears the current scope and resets its properties. */
@@ -79,0 +75,0 @@ clear(): this;

dist/span.d.ts

 /** Span holding trace_id, span_id */
 export interface Span {
+    /** Sets the finish timestamp on the current span and sends it if it was a transaction */
+    finish(): string | undefined;
     /** Return a traceparent compatible header string */
     toTraceparent(): string;
+    /** Convert the object to JSON for w. spans array info only */
+    getTraceContext(): object;
     /** Convert the object to JSON */
     toJSON(): object;
 }
+/** Interface holder all properties that can be set on a Span on creation. */
+export interface SpanContext {
+    /**
+     * Description of the Span.
+     */
+    description?: string;
+    /**
+     * Operation of the Span.
+     */
+    op?: string;
+    /**
+     * Completion status of the Span.
+     */
+    status?: boolean;
+    /**
+     * Parent Span ID
+     */
+    parentSpanId?: string;
+    /**
+     * Has the sampling decision been made?
+     */
+    sampled?: boolean;
+    /**
+     * Span ID
+     */
+    spanId?: string;
+    /**
+     * Trace ID
+     */
+    traceId?: string;
+    /**
+     * Transaction of the Span.
+     */
+    transaction?: string;
+    /**
+     * Tags of the Span.
+     */
+    tags?: {
+        [key: string]: string;
+    };
+    /**
+     * Data of the Span.
+     */
+    data?: {
+        [key: string]: any;
+    };
+}
 //# sourceMappingURL=span.d.ts.map

esm/event.d.ts

@@ -6,2 +6,3 @@ import { Breadcrumb } from './breadcrumb';
 import { Severity } from './severity';
+import { Span } from './span';
 import { Stacktrace } from './stacktrace';
@@ -14,2 +15,3 @@ import { User } from './user';
     timestamp?: number;
+    start_timestamp?: number;
     level?: Severity;
@@ -45,5 +47,6 @@ platform?: string;
     type?: EventType;
+    spans?: Span[];
 }
 /** JSDoc */
-export declare type EventType = 'none';
+export declare type EventType = 'transaction';
 /** JSDoc */
@@ -50,0 +53,0 @@ export interface EventHint {

esm/hub.d.ts

@@ -7,2 +7,3 @@ import { Breadcrumb, BreadcrumbHint } from './breadcrumb';
 import { Severity } from './severity';
+import { Span, SpanContext } from './span';
 import { User } from './user';
@@ -161,3 +162,11 @@ /**
     };
+    /**
+     * This functions starts a span. If argument passed is of type `Span`, it'll run sampling on it if configured
+     * and attach a `SpanRecorder`. If it's of type `SpanContext` and there is already a `Span` on the Scope,
+     * the created Span will have a reference to it and become it's child. Otherwise it'll crete a new `Span`.
+     *
+     * @param span Already constructed span which should be started or properties with which the span should be created
+     */
+    startSpan(span?: Span | SpanContext): Span;
 }
 //# sourceMappingURL=hub.d.ts.map

esm/index.d.ts

@@ -19,3 +19,3 @@ export { Breadcrumb, BreadcrumbHint } from './breadcrumb';
 export { Severity } from './severity';
-export { Span } from './span';
+export { Span, SpanContext } from './span';
 export { StackFrame } from './stackframe';
@@ -22,0 +22,0 @@ export { Stacktrace } from './stacktrace';

esm/options.d.ts

@@ -66,2 +66,4 @@ import { Breadcrumb, BreadcrumbHint } from './breadcrumb';
     sampleRate?: number;
+    /** A global sample rate to apply to all transactions (0 - 1). */
+    tracesSampleRate?: number;
     /** Attaches stacktraces to pure capture message / log integrations */
@@ -96,3 +98,6 @@ attachStacktrace?: boolean;
     beforeBreadcrumb?(breadcrumb: Breadcrumb, hint?: BreadcrumbHint): Breadcrumb | null;
+    _experiments?: {
+        [key: string]: any;
+    };
 }
 //# sourceMappingURL=options.d.ts.map

esm/scope.d.ts

@@ -73,6 +73,2 @@ import { Breadcrumb } from './breadcrumb';
     setSpan(span?: Span): this;
-    /**
-     * Starts a new Span.
-     */
-    startSpan(): Span;
     /** Clears the current scope and resets its properties. */
@@ -79,0 +75,0 @@ clear(): this;

esm/span.d.ts

 /** Span holding trace_id, span_id */
 export interface Span {
+    /** Sets the finish timestamp on the current span and sends it if it was a transaction */
+    finish(): string | undefined;
     /** Return a traceparent compatible header string */
     toTraceparent(): string;
+    /** Convert the object to JSON for w. spans array info only */
+    getTraceContext(): object;
     /** Convert the object to JSON */
     toJSON(): object;
 }
+/** Interface holder all properties that can be set on a Span on creation. */
+export interface SpanContext {
+    /**
+     * Description of the Span.
+     */
+    description?: string;
+    /**
+     * Operation of the Span.
+     */
+    op?: string;
+    /**
+     * Completion status of the Span.
+     */
+    status?: boolean;
+    /**
+     * Parent Span ID
+     */
+    parentSpanId?: string;
+    /**
+     * Has the sampling decision been made?
+     */
+    sampled?: boolean;
+    /**
+     * Span ID
+     */
+    spanId?: string;
+    /**
+     * Trace ID
+     */
+    traceId?: string;
+    /**
+     * Transaction of the Span.
+     */
+    transaction?: string;
+    /**
+     * Tags of the Span.
+     */
+    tags?: {
+        [key: string]: string;
+    };
+    /**
+     * Data of the Span.
+     */
+    data?: {
+        [key: string]: any;
+    };
+}
 //# sourceMappingURL=span.d.ts.map

package.json

 {
   "name": "@sentry/types",
-  "version": "5.7.1",
+  "version": "5.8.0-beta.0",
   "description": "Types for all Sentry JavaScript SDKs",
@@ -5,0 +5,0 @@ "repository": "git://github.com/getsentry/sentry-javascript.git",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

176371

increased by5.41%

Lines of code

1928

increased by7.11%

Worsened metrics

Number of low quality alerts

1

increased byInfinity%

No dependency changes