myredvest utilities library

Publishing

Automated publishing

1. Ensure the accurate version is reflected in the feature branch
2. Open a PR against master with that feature branch
3. Ensure the PR build succeeds and approvals have been met
4. Merge to master
5. Let the CI/CD pipeline on master build, test, and publish, noting the version from step 1 for npm install elsewhere

Manual Publishing (if necessary)

Initial One-Time Setup

1. Login to Artifactory
2. Select "Set Me Up" in the profile dropdown menu
3. Select npm and e-mrv-npm-virtual for the "Package Type" and "Repository" respectively
4. Type your Artifactory password into the credentials input and submit (lock icon button) to populate the commands with the properly formatted text
5. Copy the "Using basic authentication" code snippet, including your base64 encoded username:password combo
6. Paste that code snippet into your global .npmrc file; this is most likely located at ~/.npmrc A. These changes can also be made in the .npmrc file at the root of this repo, BUT they must NOT be committed as the code contains private user-specific information
7. Modify or add the registry value in that global .npmrc to https://artifactory.lowes.com/artifactory/api/npm/e-mrv-npm-virtual/

Repeat For Every New Published Version

1. Ensure all changes are committed and have been approved and merged to master via a PR
2. Checkout the latest master branch
3. Bump the package version number accordingly (can do via npm version command as needed; be sure to use "patch" or correct version bump strategy)
4. npm run build - Build the compiled files
5. npm run test - Ensure 100% of tests are passing with 100% test coverage, otherwise fix to meet those thresholds
6. npm publish - Publish the new version (this relies on .npmrc authentication steps above)

Store Number logic

For production we will always use 1 store number, which is where the application is deployed. For lower environments, including local, we can override the store number value for various conditions using localStorage

1. storenumber - this is the "real" store number set by the myredvest login application
2. apiStoreNumber - the store number used in the base URL portion of all API requests, including BFF and Genesis
3. itemSearchStoreNumber - the store number used as a query param in all item search requests
4. bffStoreNumber - the store number used in the base URL portion of only BFF requests (like apiStoreNumber, but more specific and will override that value for BFF requests if this is set)

Each of these values has defaults, so it is safe to use them without having declared their localStorage counterparts