@slack/web-api - npm Package Compare versions

Comparing version 5.11.0 to 5.12.0

dist/index.d.ts

 /// <reference lib="es2017" />
-export { WebClient, WebClientOptions, WebAPICallOptions, WebAPICallResult, PaginatePredicate, WebClientEvent, TLSOptions, } from './WebClient';
+export { WebClient, WebClientOptions, WebAPICallOptions, WebAPICallResult, PageAccumulator, PageReducer, PaginatePredicate, WebClientEvent, TLSOptions, } from './WebClient';
 export { Logger, LogLevel } from './logger';
-export { ErrorCode, WebAPICallError, WebAPIPlatformError, WebAPIRequestError, WebAPIHTTPError, WebAPIRateLimitedError, } from './errors';
+export { CodedError, ErrorCode, WebAPICallError, WebAPIPlatformError, WebAPIRequestError, WebAPIHTTPError, WebAPIRateLimitedError, } from './errors';
 export { default as retryPolicies, RetryOptions } from './retry-policies';
 export { addAppMetadata } from './instrument';
 export * from './methods';
+export { default as Method } from './methods';
 //# sourceMappingURL=index.d.ts.map

dist/instrument.d.ts

 /**
  * Appends the app metadata into the User-Agent value
- * @param appMetadata.name name of tool to be counted in instrumentation
- * @param appMetadata.version version of tool to be counted in instrumentation
+ * @param appMetadata.name - name of tool to be counted in instrumentation
+ * @param appMetadata.version - version of tool to be counted in instrumentation
  */
@@ -6,0 +6,0 @@ export declare function addAppMetadata({ name, version }: {

dist/instrument.js

@@ -37,4 +37,4 @@ "use strict";
  * Appends the app metadata into the User-Agent value
- * @param appMetadata.name name of tool to be counted in instrumentation
- * @param appMetadata.version version of tool to be counted in instrumentation
+ * @param appMetadata.name - name of tool to be counted in instrumentation
+ * @param appMetadata.version - version of tool to be counted in instrumentation
  */
@@ -41,0 +41,0 @@ function addAppMetadata({ name, version }) {

dist/methods.d.ts

@@ -303,2 +303,7 @@ /// <reference types="node" />
     };
+    readonly workflows: {
+        stepCompleted: Method<WorkflowsStepCompletedArguments, WebAPICallResult>;
+        stepFailed: Method<WorkflowsStepFailedArguments, WebAPICallResult>;
+        updateStep: Method<WorkflowsUpdateStepArguments, WebAPICallResult>;
+    };
 }
@@ -1157,3 +1162,22 @@ /**
 }
+export interface WorkflowsStepCompletedArguments extends WebAPICallOptions, TokenOverridable {
+    workflow_step_execute_id: string;
+    outputs?: object;
+}
+export interface WorkflowsStepFailedArguments extends WebAPICallOptions, TokenOverridable {
+    workflow_step_execute_id: string;
+    error: {
+        message: string;
+    };
+}
+export interface WorkflowsUpdateStepArguments extends WebAPICallOptions, TokenOverridable {
+    workflow_step_edit_id: string;
+    inputs?: object;
+    outputs?: {
+        type: string;
+        name: string;
+        label: string;
+    }[];
+}
 export * from '@slack/types';
 //# sourceMappingURL=methods.d.ts.map

dist/methods.js

@@ -328,2 +328,7 @@ "use strict";
         };
+        this.workflows = {
+            stepCompleted: bindApiCall(this, 'workflows.stepCompleted'),
+            stepFailed: bindApiCall(this, 'workflows.stepFailed'),
+            updateStep: bindApiCall(this, 'workflows.updateStep'),
+        };
         // Check that the class being created extends from `WebClient` rather than this class
@@ -330,0 +335,0 @@ if (new.target !== WebClient_1.WebClient && !(new.target.prototype instanceof WebClient_1.WebClient)) {

dist/WebClient.d.ts

@@ -59,4 +59,4 @@ /// <reference types="node" />
      *
-     * @param method the Web API method to call {@see https://api.slack.com/methods}
-     * @param options options
+     * @param method - the Web API method to call {@link https://api.slack.com/methods}
+     * @param options - options
      */
@@ -79,6 +79,6 @@ apiCall(method: string, options?: WebAPICallOptions): Promise<WebAPICallResult>;
      *
-     * @param method the cursor-paginated Web API method to call {@see https://api.slack.com/docs/pagination}
-     * @param options options
-     * @param shouldStop a predicate that is called with each page, and should return true when pagination can end.
-     * @param reduce a callback that can be used to accumulate a value that the return promise is resolved to
+     * @param method - the cursor-paginated Web API method to call {@link https://api.slack.com/docs/pagination}
+     * @param options - options
+     * @param shouldStop - a predicate that is called with each page, and should return true when pagination can end.
+     * @param reduce - a callback that can be used to accumulate a value that the return promise is resolved to
      */
@@ -98,4 +98,4 @@ paginate(method: string, options?: WebAPICallOptions): AsyncIterable<WebAPICallResult>;
      *
-     * @param options arguments for the Web API method
-     * @param headers a mutable object representing the HTTP headers for the outgoing request
+     * @param options - arguments for the Web API method
+     * @param headers - a mutable object representing the HTTP headers for the outgoing request
      */
@@ -145,6 +145,6 @@ private serializeApiCallOptions;
 }
-interface PageReducer<A = any> {
+export interface PageReducer<A = any> {
     (accumulator: A | undefined, page: WebAPICallResult, index: number): A;
 }
-declare type PageAccumulator<R extends PageReducer> = R extends (accumulator: (infer A) | undefined, page: WebAPICallResult, index: number) => infer A ? A : never;
+export declare type PageAccumulator<R extends PageReducer> = R extends (accumulator: (infer A) | undefined, page: WebAPICallResult, index: number) => infer A ? A : never;
 //# sourceMappingURL=WebClient.d.ts.map

dist/WebClient.js

@@ -116,4 +116,4 @@ "use strict";
      *
-     * @param method the Web API method to call {@see https://api.slack.com/methods}
-     * @param options options
+     * @param method - the Web API method to call {@link https://api.slack.com/methods}
+     * @param options - options
      */
@@ -290,4 +290,4 @@ async apiCall(method, options) {
      *
-     * @param options arguments for the Web API method
-     * @param headers a mutable object representing the HTTP headers for the outgoing request
+     * @param options - arguments for the Web API method
+     * @param headers - a mutable object representing the HTTP headers for the outgoing request
      */
@@ -294,0 +294,0 @@ serializeApiCallOptions(options, headers) {

package.json

 {
   "name": "@slack/web-api",
-  "version": "5.11.0",
+  "version": "5.12.0",
   "description": "Official library for using the Slack Platform's Web API",
@@ -40,4 +40,8 @@ "author": "Slack Technologies, Inc.",
     "lint": "tslint --project .",
-    "test": "npm run build && nyc mocha --config .mocharc.json src/*.spec.js",
-    "coverage": "codecov -F webapi --root=$PWD"
+    "test": "npm run build && npm run test:mocha && npm run test:types",
+    "test:mocha": "nyc mocha --config .mocharc.json src/*.spec.js",
+    "test:types": "tsd",
+    "coverage": "codecov -F webapi --root=$PWD",
+    "ref-docs:model": "api-extractor run",
+    "watch": "npx nodemon --watch 'src' --ext 'ts' --exec npm run build"
   },
@@ -59,2 +63,3 @@ "dependencies": {
     "@aoberoi/capture-console": "^1.1.0",
+    "@microsoft/api-extractor": "^7.3.4",
     "@types/chai": "^4.1.7",
@@ -73,6 +78,10 @@ "@types/mocha": "^5.2.6",
     "ts-node": "^8.0.3",
+    "tsd": "^0.13.1",
     "tslint": "^5.13.1",
     "tslint-config-airbnb": "^5.11.1",
     "typescript": "^3.3.3333"
+  },
+  "tsd": {
+    "directory": "test/types"
   }
 }

Fixed alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

187530

increased by1.24%

Lines of code

2485

increased by1.22%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dev dependency count

19

increased by11.76%

No dependency changes