Migrate from Cypress.env() to Cypress.expose() for plugin configuration

[cacieprins]

Thank you for maintaining @bahmutov/cy-api!

Cypress.env() will be deprecated in Cypress 15.10, and fully removed in Cypress 16.

Starting in v15.10.0, users can pre-emptively disable Cypress.env() and its environment variable serialization. This is a security issue: values that can be retrieved by Cypress.env() may be freely accessed by the application under test (AUT) and any third party code that the AUT loads into the browser.
Until this plugin migrates, users who want to disable Cypress.env() for security reasons will not be able to.

Migration steps:

1. Replace references to Cypress.env with Cypress.expose for configuration values that are not sensitive
2. Use cy.env() when you have access to the current test context (like in custom commands) and need to access sensitive values like API keys
3. Directly reference environment variables when your plugin code runs in a Node.js context (like in task definitions)
4. Update configuration references and documents to use appropriate configuration methodology
5. Set your Cypress peer dependency to >= 15.10.0.

Pre-release resources:

• Updated guide on environment variables and secrets
• Documentation on cy.env() and Cypress.expose()
• Migrating away from Cypress.env()
• Preview binaries are available with the upcoming Cypress.expose() and cy.env() functionality:
  • Linux x64: https://cdn.cypress.io/beta/npm/15.10.0/linux-x64/develop-86649210a57b86baaaf9e1c92b1dcf718928eefd/cypress.tgz
  • Linux arm64: https://cdn.cypress.io/beta/npm/15.10.0/linux-arm64/develop-86649210a57b86baaaf9e1c92b1dcf718928eefd/cypress.tgz
  • Win32 x64: https://cdn.cypress.io/beta/npm/15.10.0/win32-x64/develop-86649210a57b86baaaf9e1c92b1dcf718928eefd/cypress.tgz
  • Darwin arm64: https://cdn.cypress.io/beta/npm/15.10.0/darwin-arm64/develop-86649210a57b86baaaf9e1c92b1dcf718928eefd/cypress.tgz
  • Darwin x64: https://cdn.cypress.io/beta/npm/15.10.0/darwin-x64/develop-86649210a57b86baaaf9e1c92b1dcf718928eefd/cypress.tgz

If you have questions about the migration, please ask! If you have issues with the pre-release binaries, please open an issue in cypress-io/cypress.

Thank you again for being an important part of the Cypress ecosystem.