@salesforce/apex-node 1.3.0 → 1.4.0

package/LICENSE.txt

@@ -0,0 +1,27 @@
+Copyright (c) 2020, Salesforce.com, inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice, this
+list of conditions and the following disclaimer in the documentation and/or
+other materials provided with the distribution.
+
+* Neither the name of Salesforce.com nor the names of its contributors may be
+used to endorse or promote products derived from this software without specific
+prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -1,62 +1,17 @@
 # Salesforce Apex Library
 
-[![CircleCI](https://circleci.com/gh/forcedotcom/salesforcedx-apex.svg?style=svg&circle-token=5869ea795e44e1b737f2f2a86fd51cdc2ac08629)](https://circleci.com/gh/forcedotcom/salesforcedx-apex)
-![npm (scoped)](https://img.shields.io/npm/v/@salesforce/plugin-apex)
 [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
 
 ## Introduction
 Typescript library to support the Apex plugin and [Salesforce Extensions for VS Code](https://github.com/forcedotcom/salesforcedx-vscode/).
 
-Note: This library is in beta and has been released early so we can collect feedback. It may contain bugs, undergo major changes, or be discontinued. Please report any issues via the [Issues tab](https://github.com/forcedotcom/salesforcedx-apex/issues).
+Note: Please report any issues via the [Issues tab](https://github.com/forcedotcom/salesforcedx-apex/issues).
 
 <br/>
 
-### Building the Library
-
-Clone the project and `cd` into it:
-
-```
-$ git clone git@github.com:forcedotcom/salesforcedx-apex.git
-$ cd salesforcedx-apex
-```
-
-Ensure that you have [Yarn](https://yarnpkg.com/) installed, then run:
-
-```
-$ yarn install
-$ yarn build
-```
-
-
-### Using the Library 
-
-Install the library locally by adding this information to your project's `package.json`:
-
-```
-"@salesforce/apex-node": "file://path/to/salesforcedx-apex/packages/apex-node"
-```
-
-Using the library directly requires access to a Salesforce [Connection](https://forcedotcom.github.io/sfdx-core/classes/authinfo.html). Create an instance of the specific Apex service to get access to the required methods. For example, to get a list of logs:
-
-```
-$ const authInfo = await AuthInfo.create({ username: myAdminUsername });
-$ const connection = await Connection.create({ authInfo });
-
-$ const logService = new LogService(connection);
-$ const logList = await logService.getLogRecords();
-```
-
-You can use the same pattern for the `Test Service` and `Execute Service` as well.
-
-
-### Running the Test Suite
-
-Run the test suite locally by building the project first and then running the tests.
-
-```
-$ yarn build
-$ yarn test
-```
+## Getting Started
 
+If you're interested in contributing, take a look at the [CONTRIBUTING](./CONTRIBUTING.md) guide.
 
+If you're interested in building the plugin and library locally, take a look at the [Developing](./contributing/developing.md) doc.

package/package.json

@@ -1,13 +1,15 @@
 {
   "name": "@salesforce/apex-node",
-  "description": "Salesforce js library for Apex",
-  "version": "1.3.0",
+  "description": "Salesforce JS library for Apex",
+  "version": "1.4.0",
   "author": "Salesforce",
   "bugs": "https://github.com/forcedotcom/salesforcedx-apex/issues",
   "main": "lib/src/index.js",
   "dependencies": {
-    "@salesforce/core": "^3.23.3",
+    "@commitlint/config-conventional": "^17.2.0",
+    "@salesforce/core": "^3.31.18",
     "@types/istanbul-reports": "^3.0.1",
+    "commitlint": "^17.2.0",
     "faye": "1.4.0",
     "glob": "^8.0.3",
     "istanbul-lib-coverage": "^3.2.0",
@@ -15,19 +17,30 @@
     "istanbul-reports": "^3.1.4"
   },
   "devDependencies": {
-    "@salesforce/ts-sinon": "^1.1.2",
+    "@salesforce/ts-sinon": "^1.4.2",
     "@salesforce/ts-types": "1.2.2",
     "@types/chai": "^4",
+    "@types/glob": "^8.0.0",
     "@types/istanbul-lib-coverage": "^2.0.4",
     "@types/istanbul-lib-report": "^3.0.0",
-    "@types/mkdirp": "0.5.2",
-    "@types/mocha": "^5",
+    "@types/mocha": "^10",
     "@types/node": "^14",
     "@types/sinon": "^7.5.2",
+    "@typescript-eslint/eslint-plugin": "^5.42.1",
+    "@typescript-eslint/parser": "^5.42.1",
     "chai": "^4",
-    "mocha": "^5",
+    "cz-conventional-changelog": "^3.3.0",
+    "eslint": "^7.1.0",
+    "eslint-config-prettier": "^6.11.0",
+    "eslint-plugin-header": "^3.0.0",
+    "eslint-plugin-jsdoc": "^19.1.0",
+    "eslint-plugin-prettier": "^3.1.4",
+    "husky": "^4.2.5",
+    "lint-staged": "^10.2.11",
+    "mocha": "^10",
     "mocha-junit-reporter": "^1.23.3",
     "nyc": "^14.1.1",
+    "prettier": "1.19.1",
     "shx": "^0.3.4",
     "sinon": "^7.3.1",
     "source-map-support": "^0.5.16",
@@ -47,14 +60,19 @@
   ],
   "scripts": {
     "build": "shx rm -rf lib && tsc -b",
-    "format": "prettier --config ../../.prettierrc --write './{src,test,scripts}/**/*.{ts,js,json}'",
+    "commit-init": "commitizen init cz-conventional-changelog --save-dev --save-exact --force",
+    "commit": "git-cz",
+    "format": "prettier --config ./.prettierrc --write './{src,test,scripts}/**/*.{ts,js,json}'",
     "lint": "eslint -c .eslintrc.json --ext .ts ./src ./test",
-    "test": "nyc mocha",
-    "package": "npm pack"
+    "test": "nyc mocha ./test/**/*.test.ts",
+    "package": "yarn pack",
+    "prettier": "prettier ./**/*.{js,json,ts,md} --write",
+    "format:check": "prettier ./**/*.{js,json,ts,md} --debug-check"
   },
   "husky": {
     "hooks": {
-      "pre-commit": "yarn lint-staged"
+      "pre-commit": "yarn lint-staged",
+      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
     }
   },
   "lint-staged": {
@@ -64,6 +82,11 @@
   },
   "license": "BSD-3-Clause",
   "engines": {
-    "node": ">=14.14.0"
+    "node": ">=16.13.0"
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
   }
-}
+}