@appium/types - npm Package Compare versions

Comparing version 0.20.3 to 0.21.0

build/lib/logger.d.ts

@@ -13,2 +13,14 @@ import type { Logger } from '@appium/logger';
 /**
+ * Async Context information to be stored in AsyncLocalStorage.
+ * Only the sessionSignature value is used as the prefix of the log message,
+ * and the remaining values are recorded only in JSON format logs.
+ */
+export type AppiumLoggerContext = {
+    idempotencyKey?: string;
+    requestId?: string;
+    sessionId?: string;
+    sessionSignature?: string;
+    [key: string]: any;
+};
+/**
  * Describes the internal logger.
@@ -37,6 +49,22 @@ */
      * @deprecated Use {@link errorWithException} instead
+     * @param {...any} args
+     * @throws {Error}
      */
     errorAndThrow(...args: any[]): never;
+    /**
+     * Logs given arguments at the error level and returns
+     * the error object.
+     *
+     * @param  {...any} args
+     * @returns {Error}
+     */
     errorWithException(...args: any[]): Error;
+    /**
+     * Assign context values to be used in the entire current asynchronous context for logging.
+     *
+     * @param {AppiumLoggerContext} contextInfo key-value pairs to be added to the context
+     * @param {boolean} [replace=false] if true, replace the existing context info object(default: false)
+     */
+    updateAsyncContext(contextInfo: AppiumLoggerContext, replace?: boolean): void;
 }
 //# sourceMappingURL=logger.d.ts.map

build/lib/server.d.ts

@@ -1,3 +0,1 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import type { Express } from 'express';
@@ -4,0 +2,0 @@ import type { Server as WSServer } from 'ws';

lib/logger.ts

@@ -15,3 +15,17 @@ import type {Logger} from '@appium/logger';
 
+
 /**
+ * Async Context information to be stored in AsyncLocalStorage.
+ * Only the sessionSignature value is used as the prefix of the log message,
+ * and the remaining values are recorded only in JSON format logs.
+ */
+export type AppiumLoggerContext = {
+  idempotencyKey?: string;
+  requestId?: string;
+  sessionId?: string;
+  sessionSignature?: string;
+  [key: string]: any
+}
+
+/**
  * Describes the internal logger.
@@ -40,5 +54,21 @@ */
    * @deprecated Use {@link errorWithException} instead
+   * @param {...any} args
+   * @throws {Error}
    */
   errorAndThrow(...args: any[]): never;
+  /**
+   * Logs given arguments at the error level and returns
+   * the error object.
+   *
+   * @param  {...any} args
+   * @returns {Error}
+   */
   errorWithException(...args: any[]): Error;
+  /**
+   * Assign context values to be used in the entire current asynchronous context for logging.
+   *
+   * @param {AppiumLoggerContext} contextInfo key-value pairs to be added to the context
+   * @param {boolean} [replace=false] if true, replace the existing context info object(default: false)
+   */
+  updateAsyncContext(contextInfo: AppiumLoggerContext, replace?: boolean): void;
 }

package.json

 {
   "name": "@appium/types",
-  "version": "0.20.3",
+  "version": "0.21.0",
   "description": "Various type declarations used across Appium",
@@ -41,3 +41,3 @@ "keywords": [
   "dependencies": {
-    "@appium/logger": "^1.4.2",
+    "@appium/logger": "^1.5.0",
     "@appium/schema": "^0.6.1",
@@ -47,3 +47,3 @@ "@appium/tsconfig": "^0.3.3",
     "@types/ws": "8.5.10",
-    "type-fest": "4.20.0"
+    "type-fest": "4.20.1"
   },
@@ -57,3 +57,3 @@ "engines": {
   },
-  "gitHead": "89e5f7e8dbdc9caed68b9f3045e20d5f76255455"
+  "gitHead": "e8a838417a75464ebb8ce08584311f39afdd67bd"
 }

No alert changes

Improved metrics

Total package byte prevSize

288636

0.75%

Lines of code

6568

0.8%

Dependency changes

• + Added

  type-fest@4.20.1
  (transitive)

• - Removed

  type-fest@4.20.0
  (transitive)

• Updated

  @appium/logger@^1.5.0

• Updated

  type-fest@4.20.1