@serverless/sdk - npm Package Compare versions

Comparing version 0.1.0 to 0.2.0

.ts-types/index.d.ts

@@ -27,2 +27,8 @@ import TraceSpan from './lib/trace-span';
   ): TraceSpan;
+  captureError(
+    error: Error,
+    options?: {
+      tags?: Record<string, boolean | number | string | Date | Array | Null>;
+    }
+  ): undefined;
 }
@@ -29,0 +35,0 @@

.ts-types/lib/trace-span.d.ts

@@ -1,8 +0,2 @@
-declare class TraceSpanTags extends Map {
-  set(key: string, value: boolean | number | string | Date | Array): TraceSpanTags;
-  setMany(
-    tags: Record<string, boolean | number | string | Date | Array | Null>,
-    options?: { prefix?: string }
-  ): TraceSpanTags;
-}
+import Tags from './tags';
 
@@ -15,3 +9,3 @@ declare class TraceSpan {
   spans: Set<TraceSpan>;
-  tags: TraceSpanTags;
+  tags: Tags;
   input?: string;
@@ -18,0 +12,0 @@ output?: string;

CHANGELOG.md

@@ -5,2 +5,30 @@ # Changelog
 
+## [0.2.0](https://github.com/serverless/console/compare/@serverless/sdk@0.1.0...@serverless/sdk@0.2.0) (2022-12-22)
+
+### ⚠ BREAKING CHANGES
+
+- Remove resolution of `aws.lambda.outcome` tag enum. This needs to be done in the context of `aws-lambda-sdk`
+- Trace span event emitter is generalized (to be not only Trace span specific) and relocated, it is accessible now at `_eventsEmitter` instead of `_traceSpanEmitter` property on SDK
+- Trace span events are renamed from `open` to `trace-span-open` and `close` to `trace-span-close`
+
+### Features
+
+- `serverless.captureError` with internal `CapturedEvent` interface ([b808b8a](https://github.com/serverless/console/commit/b808b8aecb29e862a5b13365b2a6160f169a6cdd))
+- Remove AWS specific logic ([2ab35d0](https://github.com/serverless/console/commit/2ab35d0961b59191acbc090df21c4c0ada736c04))
+
+### Maintenance Improvements
+
+- Exclude `resolveEpochTimestampString` ([284908c](https://github.com/serverless/console/commit/284908ced51271bafd81f23777dcf03e609330a8))
+- Exclude `Tags` interface from `TraceSpan` context ([1cafe8b](https://github.com/serverless/console/commit/1cafe8b976fd67394cb25ea1f1e3ad6038586c1c))
+- Exclude `toLong` utility ([8571198](https://github.com/serverless/console/commit/8571198206d8bb8a9523ef5b103b7353c815c78c))
+- Fix typo in internal function name ([a1bd97c](https://github.com/serverless/console/commit/a1bd97c06d52f0faba99f93e81552fa5ca6f18c4))
+- Generalize `ensureXName` logic ([e93607b](https://github.com/serverless/console/commit/e93607b91452fc5f4ad8f068c79755a2c90fe3dd))
+- Generalize internal event emitter ([80c5961](https://github.com/serverless/console/commit/80c5961a981959f5fce060a9e882fd6c952b8ddf))
+- Implement `tags.toJSON()` ([7d9fc1f](https://github.com/serverless/console/commit/7d9fc1f619c005a9e99628fa310a7d38a8af2d5c))
+- Remove dead code ([14f3613](https://github.com/serverless/console/commit/14f3613c73788885f627f36be483b2ec574bd486))
+- Seclude `generateId` utility ([e8842c7](https://github.com/serverless/console/commit/e8842c734714cb6c21b598b6d4f088f4769d5f5a))
+- Seclude `toProtobufEpochTimestamp` ([e886a5e](https://github.com/serverless/console/commit/e886a5e88e2c6e2f8496d48df1d433cb4018b66b))
+- Seclude `toProtobuTags` utility ([47f2598](https://github.com/serverless/console/commit/47f2598a8dd15a05cd8f3dc69964536c02f531a4))
+- Simplify `traceSpan.startTime` validation ([60d62f6](https://github.com/serverless/console/commit/60d62f66daa5914066722686215ad09d40427af4))
+
 ### 0.1.0 (2022-12-15)
@@ -7,0 +35,0 @@

docs/sdk.md

@@ -26,1 +26,9 @@ # Serverless SDK
 Returns instance of [TraceSpan](trace-span.md)
+
+### `.captureError(error[, options])`
+
+Record captured error
+
+- `error` - Captured error
+- `options`:
+  - `tags` _(object)_ - User tags object. Tag names can contain only lowercase alphanumeric tokens separated with dot. Values can be _string_, _boolean_, _number_, Date or Array containing any values of prior listed types

index.js

@@ -17,2 +17,3 @@ 'use strict';
 const TraceSpan = require('./lib/trace-span');
+const createErrorCapturedEvent = require('./create-error-captured-event');
 const pkgJson = require('./package');
@@ -34,2 +35,5 @@
 serverlessSdk.createTraceSpan = (name, options = {}) => new TraceSpan(name, options);
+serverlessSdk.captureError = (error, options = {}) => {
+  createErrorCapturedEvent(error, options);
+};
 
@@ -83,2 +87,2 @@ // Private
 
-serverlessSdk._traceSpanEmitter = require('./lib/trace-span/emitter');
+serverlessSdk._eventEmitter = require('./lib/emitter');

package.json

 {
   "name": "@serverless/sdk",
   "repository": "serverless/console",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "author": "Serverless, Inc.",
@@ -6,0 +6,0 @@ "dependencies": {

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

48983

increased by17.56%

Number of package files

28

increased by55.56%

Lines of code

1003

increased by14.11%

Number of medium supply chain risk alerts

2

decreased by-33.33%

No dependency changes