@vtex/faststore-plugin-buyer-portal 1.3.34 → 1.3.35

package/.vtex/catalog.yaml

@@ -4,7 +4,7 @@ metadata:
   name: organization-account
   annotations:
     github.com/project-slug: vtex/faststore-plugin-buyer-portal
-    backstage.io/techdocs-ref: dir:../
+    vtex.com/application-id: XCQV318B
 spec:
   type: frontend-ui
   lifecycle: stable

package/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.3.35] - 2025-12-02
+
+### Added
+
+- Add runbooks to docs
+
 ## [1.3.34] - 2025-12-01
 
 ### Added
@@ -321,7 +327,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Add CHANGELOG file
 - Add README file
 
-[unreleased]: https://github.com/vtex/faststore-plugin-buyer-portal/compare/v1.3.34...HEAD
+[unreleased]: https://github.com/vtex/faststore-plugin-buyer-portal/compare/1.3.35...HEAD
 [1.2.3]: https://github.com/vtex/faststore-plugin-buyer-portal/compare/v1.2.2...1.2.3
 [1.2.3]: https://github.com/vtex/faststore-plugin-buyer-portal/releases/tag/1.2.3
 [1.2.4]: https://github.com/vtex/faststore-plugin-buyer-portal/releases/tag/1.2.4
@@ -362,3 +368,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 > > > > > > > main
 > > > > > > > [1.3.11]: https://github.com/vtex/faststore-plugin-buyer-portal/releases/tag/1.3.11
+
+[1.3.35]: https://github.com/vtex/faststore-plugin-buyer-portal/releases/tag/1.3.35

package/docs/Runbook.md

@@ -0,0 +1,29 @@
+# Organization Account (Previously known as Buyer Portal) - Troubleshooting Guide
+
+This document serves as the main index for troubleshooting guides for the Organization Account.
+
+## 📋 Troubleshooting Guides
+
+### Cache Policies
+
+- **[Cache Policies Known Issues and Guides](./troubleshooting/Cache%20Policies.md.md)**
+  - Redirect not working between pages - But navigation via url is working.
+  - How to navigate without being affected by cache policies
+
+### Backend For Front
+
+- **[Backend for Front Guides](./troubleshooting/BFF.md)**
+  - How to run Organization Account with a linked instance of the BFF
+
+### Bug reproduction
+
+- **[Best pratices for reproducing bugs](./troubleshooting/Bugs.md)**
+
+### Experimental versions
+
+- **[How to generate experimental versions](./troubleshooting/Experimental%20Versions.md)**
+  - What to do when a bug happens only in production
+
+> 📚 **Additional Resources:**
+>
+> - [VTEX B2B Documentation](https://developers.vtex.com/vtex-rest-api/docs/b2b-overview)

package/docs/troubleshooting/BFF.md

@@ -0,0 +1,42 @@
+## Backend for Front - Buyer Portal Graphql
+
+### How to run the Organization Account with a linked workspace
+
+#### How to create and link an workspace
+
+Clone the [Buyer Portal Graphql Repo](https://github.com/vtex/buyer-portal-graphql)
+
+Via terminal, login into your development account with the following command (IE: `b2bfaststoredev`)
+
+```
+vtex login {{accountName}}
+```
+
+In the same terminal instance, create your workspace with
+the following command:
+
+- The `-r` option resets the workspace if you are using the same name as one created previously
+
+```
+vtex use {{workspaceName}} -r
+```
+
+Once inside your workspace, link the app with the following command:
+
+```
+vtex link
+```
+
+Wait for the build and the link and at the end you should see all the REST apis listed on your terminal.
+
+#### How to make Organization Account use the linked workspace
+
+Go to the follwing file `src/features/shared/utils/constants.ts`
+
+Replace `{{workspace}}` on line 7 with your workspace name
+
+Comment the default function - Lines 3 and 4
+
+Uncomment the changed function - Lines 6 and 7.
+
+If the plugin is already started - re-start it.

package/docs/troubleshooting/Bugs.md

@@ -0,0 +1,13 @@
+## Bug Reproduction: Best Practices
+
+### Replicating the bug
+
+Things to check when trying to reproduce a bug
+
+- You are using the same account as the report
+- You are using the same app versions as the report
+- You created a new user and added it to the same Org Unit and Contract as the report
+
+### Why use the same Org Unit and Contract:
+
+Bug can be, and ofter are, related to Scope. The best way to emulate the circustances where the bug happened is to have the same Scope apply to your user.

package/docs/troubleshooting/Cache Policies.md

@@ -0,0 +1,39 @@
+## Cache policies
+
+### Known Issue with new accounts: Redirects are not working inside Organization Account
+
+One of the reasons that redirects might not work inside organization account or in the drawer that redirects to it is the cache policies from the CDN that control what is passed in terms of cookies and headers to every new page.
+
+Since the Organization Account relies heavily on the authentication cookie (Ex: `VtexIdclientAutCookie_{{accountName}})`), if this cookie is not sent with the page load, most pages won't load.
+
+To validate if the cookies are being sent, follow this steps:
+
+#### How to check if the cookie is being sent:
+
+- Open your account using the production domain, IE: `faststore.vtexfaststore.com` and be sure to be logged in.
+
+- Open your browsers's developer tools (F12, usually) and go to the network tab
+
+- Activate the `preserve log` or equivalent option
+
+- Use the `Company` drawer to go to Organization Account -> It's important to go through the drawer and not typing the url directly
+
+- After you click `Manage` on the drawer, one of the first requests in your `network` tab should follow this format: `https://{{accountDomain}}/_next/data/{{buildId}}/{{locale}}/pvt/organization-account/org-unit/{{orgUnitId}}`
+
+- Check the `Response` on this request, inside of it, there should be a `clientContext` object and this object should have a `cookie` property, inside of it, the auth cookie must be present.
+
+##### The auth cookie is not present on Response
+
+- Check the request `Response Headers` for the `X-Cache` key, it should have the value `Miss from cloudfront`
+
+##### The request doesn't have the `Miss from cloudfront` value on header
+
+- Contact the traffic team (#traffic) and explain that you need to change the cache policy of this new account to respect the `/_next/data/*/pvt/` rule.
+
+### How to navigate in a production build without being afected by cache policies.
+
+Most accounts have a `vtex.app` domain, this domain is not subject to the rules coming from the CDN and can be used to check if the problem is related to cache policies.
+
+Just go to `{{accountName}}.vtex.app` and manually insert you auth cookie so it recognizes you as logged in
+
+If your bug doesn't happen while using this domain, there is a good chance it's related to a cache policy.

package/docs/troubleshooting/Experimental Versions.md

@@ -0,0 +1,27 @@
+## Experimental Versions
+
+### What to do when a bug happens only in the production environment?
+
+#### First, generate an experimental version
+
+Make sure that your working tree is clean
+
+Run the following command:
+
+```
+yarn release:beta
+```
+
+This will copy your current branch to a `beta` branch, generate an experimental version on `npm` and then go back to your working branch.
+
+To get the version id, go to the [Registry Page](https://www.npmjs.com/package/@vtex/faststore-plugin-buyer-portal)
+
+#### Install the experimental version on the development store
+
+Clone the [development store repo](https://github.com/vtex-sites/b2bfaststoredev.store)
+
+Open a pull request replacing the version on `package.json` with your experimental one.
+
+Wait for the preview to be generated, with it, you have a production environment with your experimental version.
+
+If you need to test it in the main domain, you will need to merge this PR, just **make sure to have a revert PR ready and warn the rest of the team about the installation**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vtex/faststore-plugin-buyer-portal",
-  "version": "1.3.34",
+  "version": "1.3.35",
   "description": "A plugin for faststore with buyer portal",
   "main": "index.js",
   "scripts": {

package/src/features/shared/utils/constants.ts

@@ -4,7 +4,7 @@ export const API_URL = (checkoutUrl: string, operation?: string) =>
   `${checkoutUrl}/_v/store-front/${operation}`;
 // DEV URL - CHANGE BEFORE MERGE
 // export const API_URL = (checkoutUrl?: string, operation?: string) =>
-//   `https://permission--b2bfaststoredev.myvtex.com/_v/store-front/${operation}`;
+//   `https://{{workspace}}--b2bfaststoredev.myvtex.com/_v/store-front/${operation}`;
 
 export const DEBOUNCE_TIMEOUT = 500;
 
@@ -13,4 +13,4 @@ export const LOCAL_STORAGE_LOCATION_EDIT_KEY = "bp_hide_edit_location_confirm";
 export const LOCAL_STORAGE_RECIPIENT_EDIT_KEY =
   "bp_hide_edit_recipient_confirm";
 
-export const CURRENT_VERSION = "1.3.34";
+export const CURRENT_VERSION = "1.3.35";