@sentry/types - npm Package Compare versions

Comparing version 8.0.0-beta.4 to 8.0.0-beta.5

package.json

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

types-ts3.8/client.d.ts

@@ -33,27 +33,33 @@ import { Breadcrumb, BreadcrumbHint } from './breadcrumb';
      *
+     * Unlike `captureException` exported from every SDK, this method requires that you pass it the current scope.
+     *
      * @param exception An exception-like object.
      * @param hint May contain additional information about the original exception.
-     * @param scope An optional scope containing event metadata.
+     * @param currentScope An optional scope containing event metadata.
      * @returns The event id
      */
-    captureException(exception: any, hint?: EventHint, scope?: Scope): string | undefined;
+    captureException(exception: any, hint?: EventHint, currentScope?: Scope): string;
     /**
      * Captures a message event and sends it to Sentry.
      *
+     * Unlike `captureMessage` exported from every SDK, this method requires that you pass it the current scope.
+     *
      * @param message The message to send to Sentry.
      * @param level Define the level of the message.
      * @param hint May contain additional information about the original exception.
-     * @param scope An optional scope containing event metadata.
+     * @param currentScope An optional scope containing event metadata.
      * @returns The event id
      */
-    captureMessage(message: string, level?: SeverityLevel, hint?: EventHint, scope?: Scope): string | undefined;
+    captureMessage(message: string, level?: SeverityLevel, hint?: EventHint, currentScope?: Scope): string;
     /**
      * Captures a manually created event and sends it to Sentry.
      *
+     * Unlike `captureEvent` exported from every SDK, this method requires that you pass it the current scope.
+     *
      * @param event The event to send to Sentry.
      * @param hint May contain additional information about the original exception.
-     * @param scope An optional scope containing event metadata.
+     * @param currentScope An optional scope containing event metadata.
      * @returns The event id
      */
-    captureEvent(event: Event, hint?: EventHint, scope?: Scope): string | undefined;
+    captureEvent(event: Event, hint?: EventHint, currentScope?: Scope): string;
     /**
@@ -60,0 +66,0 @@ * Captures a session

types-ts3.8/envelope.d.ts

@@ -112,3 +112,5 @@ import { AttachmentType } from './attachment';
 type StatsdEnvelopeHeaders = BaseEnvelopeHeaders;
-type SpanEnvelopeHeaders = BaseEnvelopeHeaders;
+type SpanEnvelopeHeaders = BaseEnvelopeHeaders & {
+    trace?: DynamicSamplingContext;
+};
 export type EventEnvelope = BaseEnvelope<EventEnvelopeHeaders, EventItem | AttachmentItem | UserFeedbackItem | FeedbackItem | ProfileItem>;
@@ -115,0 +117,0 @@ export type SessionEnvelope = BaseEnvelope<SessionEnvelopeHeaders, SessionItem>;

types-ts3.8/integration.d.ts

@@ -51,3 +51,3 @@ import { Client } from './client';
  */
-export type IntegrationFn = (...rest: any[]) => Integration;
+export type IntegrationFn<IntegrationType = Integration> = (...rest: any[]) => IntegrationType;
 //# sourceMappingURL=integration.d.ts.map

types-ts3.8/span.d.ts

@@ -45,2 +45,4 @@ import { Measurements } from './measurement';
     measurements?: Measurements;
+    is_segment?: boolean;
+    segment_id?: string;
 }
@@ -158,2 +160,10 @@ type TraceFlagNone = 0;
     endTimestamp?: number | undefined;
+    /**
+     * Set to `true` if this span should be sent as a standalone segment span
+     * as opposed to a transaction.
+     *
+     * @experimental this option is currently experimental and should only be
+     * used within SDK code. It might be removed or changed in the future.
+     */
+    isStandalone?: boolean | undefined;
 }
@@ -160,0 +170,0 @@ /**

types-ts3.8/startSpanOptions.d.ts

@@ -22,3 +22,20 @@ import { Scope } from './scope';
     attributes?: SpanAttributes;
+    /**
+     * Experimental options without any stability guarantees. Use with caution!
+     */
+    experimental?: {
+        /**
+         * If set to true, always start a standalone span which will be sent as a
+         * standalone segment span envelope instead of a transaction envelope.
+         *
+         * @internal this option is currently experimental and should only be
+         * used within SDK code. It might be removed or changed in the future.
+         * The payload ("envelope") of the resulting request sending the span to
+         * Sentry might change at any time.
+         *
+         * @hidden
+         */
+        standalone?: boolean;
+    };
 }
 //# sourceMappingURL=startSpanOptions.d.ts.map

types/client.d.ts

@@ -33,27 +33,33 @@ import type { Breadcrumb, BreadcrumbHint } from './breadcrumb';
      *
+     * Unlike `captureException` exported from every SDK, this method requires that you pass it the current scope.
+     *
      * @param exception An exception-like object.
      * @param hint May contain additional information about the original exception.
-     * @param scope An optional scope containing event metadata.
+     * @param currentScope An optional scope containing event metadata.
      * @returns The event id
      */
-    captureException(exception: any, hint?: EventHint, scope?: Scope): string | undefined;
+    captureException(exception: any, hint?: EventHint, currentScope?: Scope): string;
     /**
      * Captures a message event and sends it to Sentry.
      *
+     * Unlike `captureMessage` exported from every SDK, this method requires that you pass it the current scope.
+     *
      * @param message The message to send to Sentry.
      * @param level Define the level of the message.
      * @param hint May contain additional information about the original exception.
-     * @param scope An optional scope containing event metadata.
+     * @param currentScope An optional scope containing event metadata.
      * @returns The event id
      */
-    captureMessage(message: string, level?: SeverityLevel, hint?: EventHint, scope?: Scope): string | undefined;
+    captureMessage(message: string, level?: SeverityLevel, hint?: EventHint, currentScope?: Scope): string;
     /**
      * Captures a manually created event and sends it to Sentry.
      *
+     * Unlike `captureEvent` exported from every SDK, this method requires that you pass it the current scope.
+     *
      * @param event The event to send to Sentry.
      * @param hint May contain additional information about the original exception.
-     * @param scope An optional scope containing event metadata.
+     * @param currentScope An optional scope containing event metadata.
      * @returns The event id
      */
-    captureEvent(event: Event, hint?: EventHint, scope?: Scope): string | undefined;
+    captureEvent(event: Event, hint?: EventHint, currentScope?: Scope): string;
     /**
@@ -60,0 +66,0 @@ * Captures a session

types/envelope.d.ts

@@ -109,3 +109,5 @@ import type { AttachmentType } from './attachment';
 type StatsdEnvelopeHeaders = BaseEnvelopeHeaders;
-type SpanEnvelopeHeaders = BaseEnvelopeHeaders;
+type SpanEnvelopeHeaders = BaseEnvelopeHeaders & {
+    trace?: DynamicSamplingContext;
+};
 export type EventEnvelope = BaseEnvelope<EventEnvelopeHeaders, EventItem | AttachmentItem | UserFeedbackItem | FeedbackItem | ProfileItem>;
@@ -112,0 +114,0 @@ export type SessionEnvelope = BaseEnvelope<SessionEnvelopeHeaders, SessionItem>;

types/integration.d.ts

@@ -51,3 +51,3 @@ import type { Client } from './client';
  */
-export type IntegrationFn = (...rest: any[]) => Integration;
+export type IntegrationFn<IntegrationType = Integration> = (...rest: any[]) => IntegrationType;
 //# sourceMappingURL=integration.d.ts.map

types/span.d.ts

@@ -45,2 +45,4 @@ import type { Measurements } from './measurement';
     measurements?: Measurements;
+    is_segment?: boolean;
+    segment_id?: string;
 }
@@ -158,2 +160,10 @@ type TraceFlagNone = 0;
     endTimestamp?: number | undefined;
+    /**
+     * Set to `true` if this span should be sent as a standalone segment span
+     * as opposed to a transaction.
+     *
+     * @experimental this option is currently experimental and should only be
+     * used within SDK code. It might be removed or changed in the future.
+     */
+    isStandalone?: boolean | undefined;
 }
@@ -160,0 +170,0 @@ /**

types/startSpanOptions.d.ts

@@ -22,3 +22,20 @@ import type { Scope } from './scope';
     attributes?: SpanAttributes;
+    /**
+     * Experimental options without any stability guarantees. Use with caution!
+     */
+    experimental?: {
+        /**
+         * If set to true, always start a standalone span which will be sent as a
+         * standalone segment span envelope instead of a transaction envelope.
+         *
+         * @internal this option is currently experimental and should only be
+         * used within SDK code. It might be removed or changed in the future.
+         * The payload ("envelope") of the resulting request sending the span to
+         * Sentry might change at any time.
+         *
+         * @hidden
+         */
+        standalone?: boolean;
+    };
 }
 //# sourceMappingURL=startSpanOptions.d.ts.map

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

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

311692

increased by1.05%

Lines of code

6504

increased by1.09%

No dependency changes