Skip to content

Upgrade ordercloud-javascript-sdk to v12 #20

Open

Description

@esitarz

Summary

Upgrade @ordercloud/react-sdk from ordercloud-javascript-sdk v10 to v12.

Why

The JavaScript SDK is this package's foundational API dependency. The React provider, authentication and token flows, generated resource hooks, models, errors, and exported types all rely on it.

Breaking-Change Assessment

This must be evaluated as a React SDK major release unless validation shows we can support v10, v11, and v12 concurrently through an expanded peer range. Raising the peer dependency to ^12.0.0 would make npm reject consumers on v10/v11 and may expose changed types or runtime behavior.

Scope

  • Review upstream v11 and v12 migration guides and release notes.
  • Inventory all SDK imports and public type exposure.
  • Decide support policy: v12-only major release or validated multi-major peer support.
  • Update provider authentication, token/configuration, resource operations, errors, and models as required.
  • Add coverage for authentication, token persistence, query/mutation wrappers, resource operations, and public declarations.
  • Validate packed consumer fixture and representative downstream flows.
  • Update peer dependency documentation, changelog, and migration guidance.

Acceptance Criteria

  • Chosen peer-version policy is documented and semver-correct.
  • SDK lint, tests, build, and packed-consumer checks pass.
  • Runtime behavior is validated for impacted authentication and resource flows.
  • Release notes clearly identify consumer upgrade requirements.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    dependenciesSomething related to the packagesenhancementNew feature or request

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions