Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: clarify listViewApiName needs updated if not using recipe org #818

Merged

Conversation

spencer-brooks-sf
Copy link
Contributor

What does this PR do?

Document that the listViewApiName should be updated when copying this code to a non-recipe org.

What issues does this PR fix or reference?

#663 -- seems to be confused that because this is deprecated it is not working. The wire still works despite being deprecated, it is likely they hit an error due to the org not having the list view referenced.

The PR fulfills these requirements:

comment only change
[ ] Tests for the proposed changes have been added/updated.
[ ] Code linting and formatting was performed.

Functionality Before

No code comment which led to confusion when copying code to other orgs.

Functionality After

Code comment added for clarity.

@spencer-brooks-sf spencer-brooks-sf requested a review from a team as a code owner June 27, 2023 13:23
@salesforce-cla
Copy link

Thanks for the contribution! Before we can merge this, we need @spencer-brooks-sf to sign the Salesforce Inc. Contributor License Agreement.

@spencer-brooks-sf
Copy link
Contributor Author

Signed the CLA

@pozil pozil merged commit c99e9fa into trailheadapps:main Jun 28, 2023
pozil added a commit that referenced this pull request Sep 22, 2023
* fix: graphQL custom field reference

* Multi object query graphql recipe (#817)

* fix: graphQL custom field reference

* feat: add multiple object query GraphQL recipe
fix: data and errors can be returned at the same time

* fix: data and errors can come at the same time
fix: code review suggestions

* fix: revert getContact changes

---------

Co-authored-by: pozil <pozil@salesforce.com>

* docs: clarify listViewApiName needs updated if not using recipe org (#818)

* build(deps-dev): bump @lwc/eslint-plugin-lwc from 1.6.2 to 1.6.3

Bumps [@lwc/eslint-plugin-lwc](https://github.com/salesforce/eslint-plugin-lwc) from 1.6.2 to 1.6.3.
- [Release notes](https://github.com/salesforce/eslint-plugin-lwc/releases)
- [Commits](salesforce/eslint-plugin-lwc@v1.6.2...v1.6.3)

---
updated-dependencies:
- dependency-name: "@lwc/eslint-plugin-lwc"
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

* build(deps-dev): bump eslint-plugin-jest from 27.2.1 to 27.2.2

Bumps [eslint-plugin-jest](https://github.com/jest-community/eslint-plugin-jest) from 27.2.1 to 27.2.2.
- [Release notes](https://github.com/jest-community/eslint-plugin-jest/releases)
- [Changelog](https://github.com/jest-community/eslint-plugin-jest/blob/main/CHANGELOG.md)
- [Commits](jest-community/eslint-plugin-jest@v27.2.1...v27.2.2)

---
updated-dependencies:
- dependency-name: eslint-plugin-jest
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

* build(deps-dev): bump eslint from 8.42.0 to 8.44.0

Bumps [eslint](https://github.com/eslint/eslint) from 8.42.0 to 8.44.0.
- [Release notes](https://github.com/eslint/eslint/releases)
- [Changelog](https://github.com/eslint/eslint/blob/main/CHANGELOG.md)
- [Commits](eslint/eslint@v8.42.0...v8.44.0)

---
updated-dependencies:
- dependency-name: eslint
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

* build(deps-dev): bump @salesforce/eslint-config-lwc from 3.4.0 to 3.5.0

Bumps [@salesforce/eslint-config-lwc](https://github.com/salesforce/eslint-config-lwc) from 3.4.0 to 3.5.0.
- [Release notes](https://github.com/salesforce/eslint-config-lwc/releases)
- [Commits](salesforce/eslint-config-lwc@v3.4.0...v3.5.0)

---
updated-dependencies:
- dependency-name: "@salesforce/eslint-config-lwc"
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

* build(deps-dev): bump jest-canvas-mock from 2.5.1 to 2.5.2

Bumps [jest-canvas-mock](https://github.com/hustcc/jest-canvas-mock) from 2.5.1 to 2.5.2.
- [Release notes](https://github.com/hustcc/jest-canvas-mock/releases)
- [Changelog](https://github.com/hustcc/jest-canvas-mock/blob/master/CHANGELOG.md)
- [Commits](https://github.com/hustcc/jest-canvas-mock/commits)

---
updated-dependencies:
- dependency-name: jest-canvas-mock
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

* build(deps-dev): bump @sa11y/jest from 5.1.0 to 5.2.0

Bumps [@sa11y/jest](https://github.com/salesforce/sa11y/tree/HEAD/packages/jest) from 5.1.0 to 5.2.0.
- [Release notes](https://github.com/salesforce/sa11y/releases)
- [Changelog](https://github.com/salesforce/sa11y/blob/master/CHANGELOG.md)
- [Commits](https://github.com/salesforce/sa11y/commits/v5.2.0/packages/jest)

---
updated-dependencies:
- dependency-name: "@sa11y/jest"
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

* build(deps-dev): bump lint-staged from 13.2.2 to 13.2.3

Bumps [lint-staged](https://github.com/okonet/lint-staged) from 13.2.2 to 13.2.3.
- [Release notes](https://github.com/okonet/lint-staged/releases)
- [Commits](lint-staged/lint-staged@v13.2.2...v13.2.3)

---
updated-dependencies:
- dependency-name: lint-staged
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

* build(deps-dev): bump word-wrap from 1.2.3 to 1.2.4

Bumps [word-wrap](https://github.com/jonschlinkert/word-wrap) from 1.2.3 to 1.2.4.
- [Release notes](https://github.com/jonschlinkert/word-wrap/releases)
- [Commits](jonschlinkert/word-wrap@1.2.3...1.2.4)

---
updated-dependencies:
- dependency-name: word-wrap
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>

* ci: moved default issue assignee to variable

* ci: clean/align conditions syntax

* ci: merged regular and prerelease worflows

* ci: fix prerelease PR check

* feat: upgraded in-app guidance

* ci: conditional pre-release build

* build(deps-dev): bump eslint-plugin-import from 2.27.5 to 2.28.0

Bumps [eslint-plugin-import](https://github.com/import-js/eslint-plugin-import) from 2.27.5 to 2.28.0.
- [Release notes](https://github.com/import-js/eslint-plugin-import/releases)
- [Changelog](https://github.com/import-js/eslint-plugin-import/blob/main/CHANGELOG.md)
- [Commits](import-js/eslint-plugin-import@v2.27.5...v2.28.0)

---
updated-dependencies:
- dependency-name: eslint-plugin-import
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

* build(deps-dev): bump eslint-plugin-jest from 27.2.2 to 27.2.3

Bumps [eslint-plugin-jest](https://github.com/jest-community/eslint-plugin-jest) from 27.2.2 to 27.2.3.
- [Release notes](https://github.com/jest-community/eslint-plugin-jest/releases)
- [Changelog](https://github.com/jest-community/eslint-plugin-jest/blob/main/CHANGELOG.md)
- [Commits](jest-community/eslint-plugin-jest@v27.2.2...v27.2.3)

---
updated-dependencies:
- dependency-name: eslint-plugin-jest
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

* build(deps-dev): bump eslint from 8.44.0 to 8.46.0

Bumps [eslint](https://github.com/eslint/eslint) from 8.44.0 to 8.46.0.
- [Release notes](https://github.com/eslint/eslint/releases)
- [Changelog](https://github.com/eslint/eslint/blob/main/CHANGELOG.md)
- [Commits](eslint/eslint@v8.44.0...v8.46.0)

---
updated-dependencies:
- dependency-name: eslint
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

* ci: simplified packaging PR process

* build(deps-dev): bump @salesforce/eslint-config-lwc from 3.5.0 to 3.5.2

Bumps [@salesforce/eslint-config-lwc](https://github.com/salesforce/eslint-config-lwc) from 3.5.0 to 3.5.2.
- [Release notes](https://github.com/salesforce/eslint-config-lwc/releases)
- [Commits](salesforce/eslint-config-lwc@v3.5.0...v3.5.2)

---
updated-dependencies:
- dependency-name: "@salesforce/eslint-config-lwc"
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

* build: bumped dependencies

* build: bumped dependencies

* feat: migrated from promises to async/await (#836)

* feat: migrated from promises to async/await

* fix: clean test CSS selectors

* fix: removed duplicate lightning mocks

* Released new package version 04t3t0000037toQAAQ (#837)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* feat: simplified test code

* Released new package version 04t3t0000037tozAAA (#838)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* feat: shortened function body

* Released new package version 04t3t0000037tp9AAA (#839)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* feat: align test comments

* Released new package version 04t3t0000037tpEAAQ (#840)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* build: upgraded to API v59.0

* Multi object query graphql recipe (#817)

* fix: graphQL custom field reference

* feat: add multiple object query GraphQL recipe
fix: data and errors can be returned at the same time

* fix: data and errors can come at the same time
fix: code review suggestions

* fix: revert getContact changes

---------

Co-authored-by: pozil <pozil@salesforce.com>

* build: bumped dependencies

* feat: migrated from promises to async/await (#836)

* feat: migrated from promises to async/await

* fix: clean test CSS selectors

* fix: removed duplicate lightning mocks

* feat: align test comments

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Alba Rivas <arivas@salesforce.com>
Co-authored-by: spencer-brooks-sf <42548303+spencer-brooks-sf@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Philippe Ozil <pozil@pozil-ltmjx7n.internal.salesforce.com>
Co-authored-by: Trailheadapps Bot <69584871+trailheadapps-bot@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
pozil added a commit that referenced this pull request Oct 16, 2023
* build: upgraded to API v59.0

* remove "(beta)" from GraphQL recipes (#852)

* fix: roll back graphQL custom field reference (#816)

* fix: graphQL custom field reference

* Multi object query graphql recipe (#817)

* fix: graphQL custom field reference

* feat: add multiple object query GraphQL recipe
fix: data and errors can be returned at the same time

* fix: data and errors can come at the same time
fix: code review suggestions

* fix: revert getContact changes

---------

Co-authored-by: pozil <pozil@salesforce.com>

* docs: clarify listViewApiName needs updated if not using recipe org (#818)

* build(deps-dev): bump @lwc/eslint-plugin-lwc from 1.6.2 to 1.6.3

Bumps [@lwc/eslint-plugin-lwc](https://github.com/salesforce/eslint-plugin-lwc) from 1.6.2 to 1.6.3.
- [Release notes](https://github.com/salesforce/eslint-plugin-lwc/releases)
- [Commits](salesforce/eslint-plugin-lwc@v1.6.2...v1.6.3)

---
updated-dependencies:
- dependency-name: "@lwc/eslint-plugin-lwc"
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

* build(deps-dev): bump eslint-plugin-jest from 27.2.1 to 27.2.2

Bumps [eslint-plugin-jest](https://github.com/jest-community/eslint-plugin-jest) from 27.2.1 to 27.2.2.
- [Release notes](https://github.com/jest-community/eslint-plugin-jest/releases)
- [Changelog](https://github.com/jest-community/eslint-plugin-jest/blob/main/CHANGELOG.md)
- [Commits](jest-community/eslint-plugin-jest@v27.2.1...v27.2.2)

---
updated-dependencies:
- dependency-name: eslint-plugin-jest
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

* build(deps-dev): bump eslint from 8.42.0 to 8.44.0

Bumps [eslint](https://github.com/eslint/eslint) from 8.42.0 to 8.44.0.
- [Release notes](https://github.com/eslint/eslint/releases)
- [Changelog](https://github.com/eslint/eslint/blob/main/CHANGELOG.md)
- [Commits](eslint/eslint@v8.42.0...v8.44.0)

---
updated-dependencies:
- dependency-name: eslint
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

* build(deps-dev): bump @salesforce/eslint-config-lwc from 3.4.0 to 3.5.0

Bumps [@salesforce/eslint-config-lwc](https://github.com/salesforce/eslint-config-lwc) from 3.4.0 to 3.5.0.
- [Release notes](https://github.com/salesforce/eslint-config-lwc/releases)
- [Commits](salesforce/eslint-config-lwc@v3.4.0...v3.5.0)

---
updated-dependencies:
- dependency-name: "@salesforce/eslint-config-lwc"
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

* build(deps-dev): bump jest-canvas-mock from 2.5.1 to 2.5.2

Bumps [jest-canvas-mock](https://github.com/hustcc/jest-canvas-mock) from 2.5.1 to 2.5.2.
- [Release notes](https://github.com/hustcc/jest-canvas-mock/releases)
- [Changelog](https://github.com/hustcc/jest-canvas-mock/blob/master/CHANGELOG.md)
- [Commits](https://github.com/hustcc/jest-canvas-mock/commits)

---
updated-dependencies:
- dependency-name: jest-canvas-mock
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

* build(deps-dev): bump @sa11y/jest from 5.1.0 to 5.2.0

Bumps [@sa11y/jest](https://github.com/salesforce/sa11y/tree/HEAD/packages/jest) from 5.1.0 to 5.2.0.
- [Release notes](https://github.com/salesforce/sa11y/releases)
- [Changelog](https://github.com/salesforce/sa11y/blob/master/CHANGELOG.md)
- [Commits](https://github.com/salesforce/sa11y/commits/v5.2.0/packages/jest)

---
updated-dependencies:
- dependency-name: "@sa11y/jest"
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

* build(deps-dev): bump lint-staged from 13.2.2 to 13.2.3

Bumps [lint-staged](https://github.com/okonet/lint-staged) from 13.2.2 to 13.2.3.
- [Release notes](https://github.com/okonet/lint-staged/releases)
- [Commits](lint-staged/lint-staged@v13.2.2...v13.2.3)

---
updated-dependencies:
- dependency-name: lint-staged
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

* build(deps-dev): bump word-wrap from 1.2.3 to 1.2.4

Bumps [word-wrap](https://github.com/jonschlinkert/word-wrap) from 1.2.3 to 1.2.4.
- [Release notes](https://github.com/jonschlinkert/word-wrap/releases)
- [Commits](jonschlinkert/word-wrap@1.2.3...1.2.4)

---
updated-dependencies:
- dependency-name: word-wrap
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>

* ci: moved default issue assignee to variable

* ci: clean/align conditions syntax

* ci: merged regular and prerelease worflows

* ci: fix prerelease PR check

* feat: upgraded in-app guidance

* ci: conditional pre-release build

* build(deps-dev): bump eslint-plugin-import from 2.27.5 to 2.28.0

Bumps [eslint-plugin-import](https://github.com/import-js/eslint-plugin-import) from 2.27.5 to 2.28.0.
- [Release notes](https://github.com/import-js/eslint-plugin-import/releases)
- [Changelog](https://github.com/import-js/eslint-plugin-import/blob/main/CHANGELOG.md)
- [Commits](import-js/eslint-plugin-import@v2.27.5...v2.28.0)

---
updated-dependencies:
- dependency-name: eslint-plugin-import
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

* build(deps-dev): bump eslint-plugin-jest from 27.2.2 to 27.2.3

Bumps [eslint-plugin-jest](https://github.com/jest-community/eslint-plugin-jest) from 27.2.2 to 27.2.3.
- [Release notes](https://github.com/jest-community/eslint-plugin-jest/releases)
- [Changelog](https://github.com/jest-community/eslint-plugin-jest/blob/main/CHANGELOG.md)
- [Commits](jest-community/eslint-plugin-jest@v27.2.2...v27.2.3)

---
updated-dependencies:
- dependency-name: eslint-plugin-jest
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

* build(deps-dev): bump eslint from 8.44.0 to 8.46.0

Bumps [eslint](https://github.com/eslint/eslint) from 8.44.0 to 8.46.0.
- [Release notes](https://github.com/eslint/eslint/releases)
- [Changelog](https://github.com/eslint/eslint/blob/main/CHANGELOG.md)
- [Commits](eslint/eslint@v8.44.0...v8.46.0)

---
updated-dependencies:
- dependency-name: eslint
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

* ci: simplified packaging PR process

* build(deps-dev): bump @salesforce/eslint-config-lwc from 3.5.0 to 3.5.2

Bumps [@salesforce/eslint-config-lwc](https://github.com/salesforce/eslint-config-lwc) from 3.5.0 to 3.5.2.
- [Release notes](https://github.com/salesforce/eslint-config-lwc/releases)
- [Commits](salesforce/eslint-config-lwc@v3.5.0...v3.5.2)

---
updated-dependencies:
- dependency-name: "@salesforce/eslint-config-lwc"
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

* build: bumped dependencies

* build: bumped dependencies

* feat: migrated from promises to async/await (#836)

* feat: migrated from promises to async/await

* fix: clean test CSS selectors

* fix: removed duplicate lightning mocks

* Released new package version 04t3t0000037toQAAQ (#837)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* feat: simplified test code

* Released new package version 04t3t0000037tozAAA (#838)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* feat: shortened function body

* Released new package version 04t3t0000037tp9AAA (#839)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* feat: align test comments

* Released new package version 04t3t0000037tpEAAQ (#840)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* build: upgraded to API v59.0

* Multi object query graphql recipe (#817)

* fix: graphQL custom field reference

* feat: add multiple object query GraphQL recipe
fix: data and errors can be returned at the same time

* fix: data and errors can come at the same time
fix: code review suggestions

* fix: revert getContact changes

---------

Co-authored-by: pozil <pozil@salesforce.com>

* build: bumped dependencies

* feat: migrated from promises to async/await (#836)

* feat: migrated from promises to async/await

* fix: clean test CSS selectors

* fix: removed duplicate lightning mocks

* feat: align test comments

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Alba Rivas <arivas@salesforce.com>
Co-authored-by: spencer-brooks-sf <42548303+spencer-brooks-sf@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Philippe Ozil <pozil@pozil-ltmjx7n.internal.salesforce.com>
Co-authored-by: Trailheadapps Bot <69584871+trailheadapps-bot@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* feat: create LWC recipes (Hello & Dynamic Target sObject) for lightning-record-picker (#864)

* boilerplate

* chore: rename entity to target

* update sfdx-lwc-jest dependency to have access to lightning-record-picker component

* feat: create dedicated test for recordPickerDynamicTarget use case

* display entity selector and record picker ina row

* add a flaxipage in LWC recipes app having RecordPickerDynamicTarget cmp

* clean u html file

* change component and tab icons

* hide the target selector when a record is selected

* feat: adding new recordPicker cmp for basic use case

* add component's source and a tooltip

* remove fixed widths and use flex shrink instead

* feat: using contact-tile to display details of the selected record

* feat: using icon + view-source component

* move data folder to __tests__

* fix handle change event in recordPickerHello

* visual improvements

* clean up and remove dead code

* improve test coverage

* update flexipage to include recordPickerHello

* remove non relevant files

* revert changes in package.json + add .npmrc

* bump @salesforce/sfdx-lwc-jest to access lightning-record picker (correct npm registry)

* pr comments

* remove unnecessary variables

* add error panel to show getObjectInfos errors

* add error panel to show graphql errors

* remove unnecessary variable

* remove getObjectInfos wire

* remove getObjectInfos wire from test

---------

Co-authored-by: Antoine Rosenbach <arosenbach@salesforce.com>
Co-authored-by: skempf <skempf@salesforce.com>

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Mike Burr <39976424+mburr-salesforce@users.noreply.github.com>
Co-authored-by: Alba Rivas <arivas@salesforce.com>
Co-authored-by: spencer-brooks-sf <42548303+spencer-brooks-sf@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Philippe Ozil <pozil@pozil-ltmjx7n.internal.salesforce.com>
Co-authored-by: Trailheadapps Bot <69584871+trailheadapps-bot@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Rami Noufal <rnoufal@salesforce.com>
Co-authored-by: Antoine Rosenbach <arosenbach@salesforce.com>
Co-authored-by: skempf <skempf@salesforce.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants