fix: expose new methods from @salesforce/wire-service-jest-util (#227)

* docs: copyedit readme and remove sample code based on wire reform (#204)

* docs: copyedit and remove code based on wire reform

* docs: run yarn format

* fix: expose new methods from @salesforce/wire-service-jest-util (#207)

* chore: update lightning stubs (#206)

Co-authored-by: Jody Bleyle <[email protected]>

Author: jodarove

README.md

@@ -89,7 +89,7 @@ sfdx-lwc-jest -- --json
 
 See the [Jest documentation](http://facebook.github.io/jest/docs/en/cli.html) for all CLI options.
 
-## Debug mode
+## Debug Mode
 
 Debug mode lets you easily debug your Jest tests.
 
@@ -135,7 +135,7 @@ If you prefer to debug inside Visual Studio Code, follow these steps:
 -   Add a `jest.config.js` file to the root of the Salesforce DX project as described [here](#overriding-jest-config). You must add this file to run Jest from Visual Studio Code.
 -   To run tests, press F5 or select Debug > Start Debugging.
 
-## Watch mode
+## Watch Mode
 
 Watch mode causes Jest to monitor files for changes and rerun tests related to the changed files. This is a great way to rapidly make component and test changes while monitoring tests results.
 
@@ -163,17 +163,17 @@ This package installs stubs for the `lightning` base components to the `src/ligh
 
 For components from other namespaces, not in your local `lwc` directory, create your own mock and update the Jest config to map the name of these components to the mock file.
 
-Let's go through an example. Given the following template, `helloWorld.html`, we want to test:
+Let's go through an example. We want to test the following template, `helloWorld.html`.
 
 ```html
 <template>
     Hello From a Lightning Web Component!
-    <lightning-button onclick={doSomething}></lightning-button>
-    <foo-fancy-button onclick={doSomethingElse}></foo-button>
+    <lightning-button onclick="{doSomething}"></lightning-button>
+    <foo-fancy-button onclick="{doSomethingElse}"></foo-fancy-button>
 </template>
 ```
 
-Because it's in the `lightning` namespace, the `lightning-button` just works. However, you must write some code to help the Jest resolver find the `foo-fancy-button component`. First, create a `jest.config.js` file at the root of the Salesforce DX project workspace and add the following:
+Because it's in the `lightning` namespace, the `lightning-button` just works. However, you must write some code to help the Jest resolver find the `foo-fancy-button` component. First, create a `jest.config.js` file at the root of the Salesforce DX project workspace and add the following:
 
 ```js
 const { jestConfig } = require('@salesforce/sfdx-lwc-jest/config');
@@ -185,7 +185,7 @@ module.exports = {
 };
 ```
 
-This tells Jest to map the import for `foo-fancy-button` to the provided file. Notice that the first dash is converted to a forward slash and the rest of the component name goes from kebab to camel case. The reason for the forward slash is because the module resolver treats everything before the first dash as the namespace. Here, `<rootDir>` maps to the root of the Salesforce DX workspace. Note that this file location is not required, just an example.
+This config tells Jest to map the import for `foo-fancy-button` to the provided file. Notice that the first dash is converted to a forward slash and the rest of the component name goes from kebab to camel case. The reason for the forward slash is because the module resolver treats everything before the first dash as the namespace. Here, `<rootDir>` maps to the root of the Salesforce DX workspace. Note that this file location is not required, just an example.
 
 You also have the freedom to make these mock implementations as sophisticated or simple as you'd like. In this example, we'll keep `foo-fancy-button` simple with an empty template and no functionality in the `.js` file, but you can always add whatever markup you'd like or implement functionality like any other Lightning web component.
 
@@ -209,12 +209,4 @@ export default class FancyButton extends LightningElement {
 
 To provision data through `@wire` adapters in unit tests, use the APIs provided by [`@salesforce/wire-service-jest-util`](https://github.com/salesforce/wire-service-jest-util). These APIs are exposed through this package so you do not need to include another dependency in your package.json.
 
-```js
-import {
-    registerTestWireAdapter,
-    registerLdsTestWireAdapter,
-    registerApexTestWireAdapter,
-} from '@salesforce/sfdx-lwc-jest';
-```
-
 See the `@salesforce/wire-service-jest-util` [README](https://github.com/salesforce/wire-service-jest-util/blob/master/README.md) for further documentation on these APIs.

src/index.js

@@ -7,12 +7,18 @@
 'use strict';
 
 const {
+    createApexTestWireAdapter,
+    createLdsTestWireAdapter,
+    createTestWireAdapter,
     registerLdsTestWireAdapter,
     registerApexTestWireAdapter,
     registerTestWireAdapter,
 } = require('@salesforce/wire-service-jest-util');
 
 module.exports = {
+    createApexTestWireAdapter,
+    createLdsTestWireAdapter,
+    createTestWireAdapter,
     registerLdsTestWireAdapter,
     registerApexTestWireAdapter,
     registerTestWireAdapter,

src/lightning-stubs/analyticsWaveApi/analyticsWaveApi.js

@@ -0,0 +1,27 @@
+/*
+ * Copyright (c) 2021, salesforce.com, inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: MIT
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/MIT
+ */
+import { createLdsTestWireAdapter } from '@salesforce/wire-service-jest-util';
+
+export const createDataflowJob = jest.fn();
+export const deleteDataset = jest.fn();
+export const deleteRecipe = jest.fn();
+export const executeQuery = createLdsTestWireAdapter(jest.fn());
+export const getAnalyticsLimits = createLdsTestWireAdapter(jest.fn());
+export const getDataflowJob = createLdsTestWireAdapter(jest.fn());
+export const getDataflowJobNode = createLdsTestWireAdapter(jest.fn());
+export const getDataflowJobNodes = createLdsTestWireAdapter(jest.fn());
+export const getDataflowJobs = createLdsTestWireAdapter(jest.fn());
+export const getDataset = createLdsTestWireAdapter(jest.fn());
+export const getDatasets = createLdsTestWireAdapter(jest.fn());
+export const getRecipe = createLdsTestWireAdapter(jest.fn());
+export const getRecipes = createLdsTestWireAdapter(jest.fn());
+export const getReplicatedDatasets = createLdsTestWireAdapter(jest.fn());
+export const getSchedule = createLdsTestWireAdapter(jest.fn());
+export const getWaveFolders = createLdsTestWireAdapter(jest.fn());
+export const getXmd = createLdsTestWireAdapter(jest.fn());
+export const updateDataflowJob = jest.fn();
+export const updateSchedule = jest.fn();

src/lightning-stubs/combobox/combobox.js

@@ -7,6 +7,7 @@
 import { LightningElement, api } from 'lwc';
 
 export default class Combobox extends LightningElement {
+    @api autocomplete;
     @api disabled;
     @api dropdownAlignment;
     @api fieldLevelHelp;

src/lightning-stubs/datatable/datatable.js

@@ -22,6 +22,7 @@ export default class Datatable extends LightningElement {
     @api maxColumnWidth;
     @api maxRowSelection;
     @api minColumnWidth;
+    @api renderConfig;
     @api resizeColumnDisabled;
     @api resizeStep;
     @api rowNumberOffset;

src/lightning-stubs/formattedPhone/formattedPhone.js

@@ -7,5 +7,6 @@
 import { LightningElement, api } from 'lwc';
 
 export default class FormattedPhone extends LightningElement {
+    @api disabled;
     @api value;
 }

src/lightning-stubs/helptext/helptext.js

@@ -7,6 +7,7 @@
 import { LightningElement, api } from 'lwc';
 
 export default class Helptext extends LightningElement {
+    @api alternativeText;
     @api content;
     @api iconName;
     @api iconVariant;

src/lightning-stubs/input/input.js

@@ -43,6 +43,8 @@ export default class Input extends LightningElement {
     @api placeholder;
     @api readOnly;
     @api required;
+    @api selectionEnd;
+    @api selectionStart;
     @api step;
     @api timeAriaControls;
     @api timeAriaDescribedBy;

src/lightning-stubs/inputAddress/inputAddress.js

@@ -13,6 +13,7 @@ export default class InputAddress extends LightningElement {
     @api cityLabel;
     @api cityPlaceholder;
     @api country;
+    @api countryDisabled;
     @api countryLabel;
     @api countryOptions;
     @api countryPlaceholder;

src/lightning-stubs/inputRichText/inputRichText.js

@@ -10,6 +10,7 @@ export default class InputRichText extends LightningElement {
     @api customButtons;
     @api disabled;
     @api disabledCategories;
+    @api fieldLevelHelp;
     @api formats;
     @api label;
     @api labelVisible;