|
1 | 1 | # Hypersync SDK Migration Guide |
2 | 2 |
|
| 3 | +## Version 6 |
| 4 | + |
| 5 | +### Package versions |
| 6 | + |
| 7 | +Update package.json imports to the following versions: |
| 8 | + |
| 9 | +```json |
| 10 | + "dependencies": { |
| 11 | + "@hyperproof/hypersync-models": "^6.0.0", |
| 12 | + "@hyperproof/hypersync-sdk": "^6.0.0", |
| 13 | + "@hyperproof/integration-sdk": "^6.0.0" |
| 14 | + } |
| 15 | +``` |
| 16 | + |
| 17 | +Update the package.json devDependencies accordingly: |
| 18 | + |
| 19 | +```json |
| 20 | + "devDependencies": { |
| 21 | + "@types/node": "22.10.10" |
| 22 | + } |
| 23 | +``` |
| 24 | + |
| 25 | +Due to specific type dependencies, the types.node package needs to be updated to a specific version. Note there is no wildcard caret ^ in the version number. |
| 26 | + |
| 27 | +If your code imported classes, types, interfaces, or enums from one of the other packages, those imports need to be updated after making this change. |
| 28 | + |
| 29 | +### IP address allowlist change (US Only) |
| 30 | + |
| 31 | +New internal infrastructure for custom apps running version ^6.0.0 of the hypersync-sdk will cause the outgoing API calls to come from a new IP address. If you had previously added a Hyperproof address to your private server's allowlist, you may need to add additional addresses for your custom app to continue to function. See the "Integrations" IP Address for your instance of Hyperproof: https://docs.hyperproof.io/admin/en/get-to-know-hyperproof/hp-instances.html |
| 32 | + |
| 33 | +### OAuth callback change (US Only) |
| 34 | + |
| 35 | +For the same reason as the IP address change, a new callback URL is required for all custom apps using oauth. Previous addresses are formatted according to the following template: |
| 36 | + |
| 37 | +``` |
| 38 | +https://api.us-west-1.fusebit.hyperproof.app/v1/run/sub-f63bb714ec30473e/org-{orgId}/{customAppId}/callback |
| 39 | +``` |
| 40 | + |
| 41 | +The new URL template is: |
| 42 | + |
| 43 | +``` |
| 44 | +https://hpip.hyperproof.app/v1/run/hpprod/org-{orgId}/{customAppId}/callback |
| 45 | +``` |
| 46 | + |
| 47 | +It is a known issue that Hypersync SDK version 1.2.4 generates incomplete, only relative URLs. Use the following base URLs for your Hyperproof instance: |
| 48 | + |
| 49 | +- Hyperproof US: `https://hpip.hyperproof.app/v1/run/hpprod` |
| 50 | +- Hyperproof EU: `https://hpip.hyperproof.eu/v1/run/hpprodeu` |
| 51 | + |
| 52 | +Update your oauth client's callback URL with this new value. |
| 53 | + |
3 | 54 | ## Version 2.X to Version 3.0 |
4 | 55 |
|
5 | 56 | Version 3.0 of the Hypersync SDK includes a number of new capabilities that |
|
0 commit comments