@slack/client - npm Package Compare versions

Comparing version 4.12.0 to 5.0.0

dist/index.d.ts

@@ -1,9 +0,13 @@
-export { Logger, LoggingFunc, LogLevel, } from './logger';
-export { CodedError, ErrorCode, } from './errors';
-export { addAppMetadata, AgentOption, TLSOptions, } from './util';
-export { default as retryPolicies, RetryOptions, } from './retry-policies';
-export { WebClient, WebClientOptions, WebAPICallOptions, WebAPICallResult, WebAPIPlatformError, WebAPIRequestError, WebAPIReadError, // NOTE: this is no longer used, but might once again be used if a more specific means to detect it
-WebAPIHTTPError, WebAPIRateLimitedError, WebAPIRefreshFailedError, WebAPICallError, WebAPIResultCallback, TokenRefreshedEvent, } from './WebClient';
-export * from './methods';
-export { RTMClient, RTMClientOptions, RTMCallResult, RTMPlatformError, RTMWebsocketError, RTMCallError, RTMCallResultCallback, } from './RTMClient';
-export { IncomingWebhook, IncomingWebhookSendArguments, IncomingWebhookDefaultArguments, IncomingWebhookResult, IncomingWebhookResultCallback, } from './IncomingWebhook';
+export { Logger, LogLevel, } from '@slack/logger';
+export * from '@slack/web-api';
+export { ErrorCode as WebAPIErrorCode } from '@slack/web-api';
+export { RTMClient, RTMClientOptions, RTMStartOptions, RTMCallResult, RTMPlatformError, RTMWebsocketError, RTMCallError, RTMNoReplyReceivedError, RTMSendWhileDisconnectedError, RTMSendWhileNotReadyError, } from '@slack/rtm-api';
+export { ErrorCode as RTMAPIErrorCode } from '@slack/rtm-api';
+export { IncomingWebhook, IncomingWebhookSendArguments, IncomingWebhookDefaultArguments, IncomingWebhookResult, IncomingWebhookRequestError, IncomingWebhookHTTPError, IncomingWebhookSendError, } from '@slack/webhook';
+export { ErrorCode as WebhookErrorCode } from '@slack/webhook';
+export * from '@slack/types';
+import { ErrorCode as WebAPIErrorCode } from '@slack/web-api';
+import { ErrorCode as RTMAPIErrorCode } from '@slack/rtm-api';
+import { ErrorCode as WebhookErrorCode } from '@slack/webhook';
+export declare const ErrorCode: typeof WebAPIErrorCode & typeof RTMAPIErrorCode & typeof WebhookErrorCode;
+//# sourceMappingURL=index.d.ts.map

dist/index.js

@@ -6,17 +6,38 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-var logger_1 = require("./logger");
+var logger_1 = require("@slack/logger");
 exports.LogLevel = logger_1.LogLevel;
-var errors_1 = require("./errors");
-exports.ErrorCode = errors_1.ErrorCode;
-var util_1 = require("./util");
-exports.addAppMetadata = util_1.addAppMetadata;
-var retry_policies_1 = require("./retry-policies");
-exports.retryPolicies = retry_policies_1.default;
-var WebClient_1 = require("./WebClient");
-exports.WebClient = WebClient_1.WebClient;
-__export(require("./methods"));
-var RTMClient_1 = require("./RTMClient");
-exports.RTMClient = RTMClient_1.RTMClient;
-var IncomingWebhook_1 = require("./IncomingWebhook");
-exports.IncomingWebhook = IncomingWebhook_1.IncomingWebhook;
+// Using a wildcard (*) export because listing each individual method is cumbersome and hard to keep up to date.
+// The following export contains:
+// addAppMetadata,
+// TLSOptions,
+// retryPolicies,
+// RetryOptions,
+// WebClient,
+// WebClientOptions,
+// WebAPICallOptions,
+// WebAPICallResult,
+// WebAPIPlatformError,
+// WebAPIRequestError,
+// WebAPIHTTPError,
+// WebAPIRateLimitedError,
+// WebAPICallError,
+// WebClientEvent,
+// and all method definitions
+__export(require("@slack/web-api"));
+var web_api_1 = require("@slack/web-api");
+exports.WebAPIErrorCode = web_api_1.ErrorCode;
+var rtm_api_1 = require("@slack/rtm-api");
+exports.RTMClient = rtm_api_1.RTMClient;
+var rtm_api_2 = require("@slack/rtm-api");
+exports.RTMAPIErrorCode = rtm_api_2.ErrorCode;
+var webhook_1 = require("@slack/webhook");
+exports.IncomingWebhook = webhook_1.IncomingWebhook;
+var webhook_2 = require("@slack/webhook");
+exports.WebhookErrorCode = webhook_2.ErrorCode;
+// Merge the two ErrorCode constants into one, to make this as similar to @slack/client@4 as possible
+const web_api_2 = require("@slack/web-api");
+const rtm_api_3 = require("@slack/rtm-api");
+const webhook_3 = require("@slack/webhook");
+// tslint:disable-next-line:variable-name
+exports.ErrorCode = Object.assign({}, web_api_2.ErrorCode, rtm_api_3.ErrorCode, webhook_3.ErrorCode);
 //# sourceMappingURL=index.js.map

package.json

 {
   "name": "@slack/client",
-  "version": "4.12.0",
-  "description": "Slack Developer Kit - official clients for the Web API, RTM API, and Incoming Webhooks",
+  "version": "5.0.0",
+  "description": "Legacy wrapper for official Slack Platform's Web API, RTM API, and Incoming Webhook libraries. Use @slack/web-api, @slack/rtm-api, or @slack/webhook instead.",
   "author": "Slack Technologies, Inc.",
@@ -12,9 +12,14 @@ "license": "MIT",
     "bot",
-    "chatbot",
     "client",
     "http",
-    "websockets",
-    "api"
+    "websocket",
+    "request",
+    "api",
+    "proxy",
+    "rate-limiting",
+    "pagination",
+    "state",
+    "connection"
   ],
-  "main": "./dist/index.js",
+  "main": "dist/index.js",
   "types": "./dist/index.d.ts",
@@ -25,6 +30,10 @@ "files": [
   "engines": {
-    "node": ">= 6.9.0",
-    "npm": ">= 3.10.8"
+    "node": ">= 8.9.0",
+    "npm": ">= 5.5.1"
   },
   "repository": "slackapi/node-slack-sdk",
+  "homepage": "https://slack.dev/node-slack-sdk/tutorials/migrating_to_v5/",
+  "publishConfig": {
+    "access": "public"
+  },
   "bugs": {
@@ -34,67 +43,22 @@ "url": "https://github.com/slackapi/node-slack-sdk/issues"
   "scripts": {
-    "prepublish": "npm run build",
+    "prepare": "npm run build",
+    "build": "npm run build:clean && tsc",
+    "build:clean": "shx rm -rf ./dist",
     "lint": "tslint --project .",
-    "test": "npm run build && npm run test:spec && npm run test:integration",
-    "test:spec": "nyc mocha --config src/.mocharc.json src/*.spec.js src/**/*.spec.js",
-    "test:integration": "mocha --config test/.mocharc.json test/typescript/test.ts test/proxy/test.js",
-    "coverage": "codecov",
-    "build": "npm run build:clean && tsc",
-    "build:clean": "shx rm -rf ./dist ./coverage ./.nyc_output",
-    "docs": "node support/jsdoc-to-markdown.js",
-    "docs:jsdoc": "ts2jsdoc"
+    "test": "npm run build && echo \"Tests are not implemented.\" && exit 0"
   },
-  "husky": {
-    "pre-push": "npm run build",
-    "pre-commit": "lint-staged"
-  },
   "dependencies": {
-    "@types/form-data": "^2.2.1",
-    "@types/is-stream": "^1.1.0",
-    "@types/node": ">=6.0.0",
-    "@types/p-cancelable": "^1.0.0",
-    "@types/p-queue": "^2.3.2",
-    "@types/p-retry": "^3.0.0",
-    "@types/retry": "^0.12.0",
-    "@types/ws": "^5.1.1",
-    "axios": "^0.18.0",
-    "eventemitter3": "^3.1.0",
-    "finity": "^0.5.4",
-    "form-data": "^2.3.3",
-    "is-stream": "^1.1.0",
-    "object.entries": "^1.1.0",
-    "object.getownpropertydescriptors": "^2.0.3",
-    "object.values": "^1.1.0",
-    "p-cancelable": "~1.0.0",
-    "p-queue": "^2.4.2",
-    "p-retry": "^3.0.1",
-    "retry": "^0.12.0",
-    "ws": "^5.2.0"
+    "@slack/logger": "^1.0.0",
+    "@slack/rtm-api": "^5.0.0",
+    "@slack/types": "^1.0.0",
+    "@slack/web-api": "^5.0.0",
+    "@slack/webhook": "^5.0.0"
   },
   "devDependencies": {
-    "@aoberoi/capture-console": "^1.1.0",
-    "@types/chai": "^4.1.7",
-    "@types/mocha": "^5.2.6",
-    "busboy": "^0.3.0",
-    "chai": "^4.2.0",
-    "codecov": "^3.2.0",
-    "http-shutdown": "^1.2.0",
-    "https-proxy-agent": "^2.2.1",
-    "husky": "^1.3.1",
-    "jsdoc-to-markdown": "^4.0.1",
-    "lint-staged": "^7.3.0",
-    "mocha": "^6.0.2",
-    "nock": "^10.0.6",
-    "nyc": "^13.3.0",
-    "p-is-promise": "^2.0.0",
-    "proxy": "^0.2.4",
     "shx": "^0.3.2",
-    "sinon": "^7.2.7",
-    "source-map-support": "^0.5.10",
-    "ts-jsdoc": "^3.0.1",
-    "ts-node": "^8.0.3",
     "tslint": "^5.13.1",
     "tslint-config-airbnb": "^5.11.1",
-    "typescript": "^2.7.1",
-    "typings-tester": "^0.3.2"
-  }
+    "typescript": "^3.3.3333"
+  },
+  "gitHead": "891307eb5f1625f68b72e4c242ba749a7d6cb996"
 }

New 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

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Dependency count

5

decreased by-76.19%

Dev dependency count

4

decreased by-84%

Worsened metrics

Total package byte prevSize

6856

decreased by-97.18%

Number of package files

7

decreased by-78.79%

Lines of code

53

decreased by-98.71%

Number of low quality alerts

1

increased byInfinity%

Number of lines in readme file

1

decreased by-99.3%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Added@slack/logger@^1.0.0

• + Added@slack/rtm-api@^5.0.0

• + Added@slack/types@^1.0.0

• + Added@slack/web-api@^5.0.0

• + Added@slack/webhook@^5.0.0

• + Added@slack/logger@1.1.1(transitive)

• + Added@slack/rtm-api@5.0.5(transitive)

• + Added@slack/types@1.10.0(transitive)

• + Added@slack/web-api@5.15.0(transitive)

• + Added@slack/webhook@5.0.4(transitive)

• + Added@types/retry@0.12.0(transitive)

• + Added@types/ws@7.4.7(transitive)

• + Addedaxios@0.21.4(transitive)

• + Addedeventemitter3@4.0.7(transitive)

• + Addedfollow-redirects@1.15.6(transitive)

• + Addedp-cancelable@1.1.0(transitive)

• + Addedp-finally@1.0.0(transitive)

• + Addedp-queue@6.6.2(transitive)

• + Addedp-retry@4.6.2(transitive)

• + Addedp-timeout@3.2.0(transitive)

• + Addedretry@0.13.1(transitive)

• - Removed@types/form-data@^2.2.1

• - Removed@types/is-stream@^1.1.0

• - Removed@types/node@>=6.0.0

• - Removed@types/p-cancelable@^1.0.0

• - Removed@types/p-queue@^2.3.2

• - Removed@types/p-retry@^3.0.0

• - Removed@types/retry@^0.12.0

• - Removed@types/ws@^5.1.1

• - Removedaxios@^0.18.0

• - Removedeventemitter3@^3.1.0

• - Removedfinity@^0.5.4

• - Removedform-data@^2.3.3

• - Removedis-stream@^1.1.0

• - Removedobject.entries@^1.1.0

• - Removedobject.getownpropertydescriptors@^2.0.3

• - Removedobject.values@^1.1.0

• - Removedp-cancelable@~1.0.0

• - Removedp-queue@^2.4.2

• - Removedp-retry@^3.0.1

• - Removedretry@^0.12.0

• - Removedws@^5.2.0

• - Removed@types/events@3.0.3(transitive)

• - Removed@types/form-data@2.5.0(transitive)

• - Removed@types/p-cancelable@1.0.1(transitive)

• - Removed@types/p-retry@3.0.1(transitive)

• - Removed@types/retry@0.12.5(transitive)

• - Removed@types/ws@5.1.2(transitive)

• - Removedarray-buffer-byte-length@1.0.1(transitive)

• - Removedarray.prototype.reduce@1.0.7(transitive)

• - Removedarraybuffer.prototype.slice@1.0.3(transitive)

• - Removedavailable-typed-arrays@1.0.7(transitive)

• - Removedaxios@0.18.1(transitive)

• - Removedcall-bind@1.0.7(transitive)

• - Removeddata-view-buffer@1.0.1(transitive)

• - Removeddata-view-byte-length@1.0.1(transitive)

• - Removeddata-view-byte-offset@1.0.0(transitive)

• - Removeddefine-data-property@1.1.4(transitive)

• - Removeddefine-properties@1.2.1(transitive)

• - Removedes-abstract@1.23.3(transitive)

• - Removedes-array-method-boxes-properly@1.0.0(transitive)

• - Removedes-define-property@1.0.0(transitive)

• - Removedes-errors@1.3.0(transitive)

• - Removedes-object-atoms@1.0.0(transitive)

• - Removedes-set-tostringtag@2.0.3(transitive)

• - Removedes-to-primitive@1.2.1(transitive)

• - Removedfollow-redirects@1.5.10(transitive)

• - Removedfor-each@0.3.3(transitive)

• - Removedfunction-bind@1.1.2(transitive)

• - Removedfunction.prototype.name@1.1.6(transitive)

• - Removedfunctions-have-names@1.2.3(transitive)

• - Removedget-intrinsic@1.2.4(transitive)

• - Removedget-symbol-description@1.0.2(transitive)

• - Removedglobalthis@1.0.4(transitive)

• - Removedgopd@1.0.1(transitive)

• - Removedhas-bigints@1.0.2(transitive)

• - Removedhas-property-descriptors@1.0.2(transitive)

• - Removedhas-proto@1.0.3(transitive)

• - Removedhas-symbols@1.0.3(transitive)

• - Removedhas-tostringtag@1.0.2(transitive)

• - Removedhasown@2.0.2(transitive)

• - Removedinternal-slot@1.0.7(transitive)

• - Removedis-array-buffer@3.0.4(transitive)

• - Removedis-bigint@1.0.4(transitive)

• - Removedis-boolean-object@1.1.2(transitive)

• - Removedis-buffer@2.0.5(transitive)

• - Removedis-callable@1.2.7(transitive)

• - Removedis-data-view@1.0.1(transitive)

• - Removedis-date-object@1.0.5(transitive)

• - Removedis-negative-zero@2.0.3(transitive)

• - Removedis-number-object@1.0.7(transitive)

• - Removedis-regex@1.1.4(transitive)

• - Removedis-shared-array-buffer@1.0.3(transitive)

• - Removedis-string@1.0.7(transitive)

• - Removedis-symbol@1.0.4(transitive)

• - Removedis-typed-array@1.1.13(transitive)

• - Removedis-weakref@1.0.2(transitive)

• - Removedisarray@2.0.5(transitive)

• - Removedobject-inspect@1.13.1(transitive)

• - Removedobject-keys@1.1.1(transitive)

• - Removedobject.assign@4.1.5(transitive)

• - Removedobject.entries@1.1.8(transitive)

• - Removedobject.getownpropertydescriptors@2.1.8(transitive)

• - Removedobject.values@1.2.0(transitive)

• - Removedp-cancelable@1.0.0(transitive)

• - Removedp-retry@3.0.1(transitive)

• - Removedpossible-typed-array-names@1.0.0(transitive)

• - Removedregexp.prototype.flags@1.5.2(transitive)

• - Removedretry@0.12.0(transitive)

• - Removedsafe-array-concat@1.1.2(transitive)

• - Removedsafe-regex-test@1.0.3(transitive)

• - Removedset-function-length@1.2.2(transitive)

• - Removedset-function-name@2.0.2(transitive)

• - Removedside-channel@1.0.6(transitive)

• - Removedstring.prototype.trim@1.2.9(transitive)

• - Removedstring.prototype.trimend@1.0.8(transitive)

• - Removedstring.prototype.trimstart@1.0.8(transitive)

• - Removedtyped-array-buffer@1.0.2(transitive)

• - Removedtyped-array-byte-length@1.0.1(transitive)

• - Removedtyped-array-byte-offset@1.0.2(transitive)

• - Removedtyped-array-length@1.0.6(transitive)

• - Removedunbox-primitive@1.0.2(transitive)

• - Removedwhich-boxed-primitive@1.0.2(transitive)

• - Removedwhich-typed-array@1.1.15(transitive)