Clay Upgrade & Migration

Overview

Guide for upgrading Clay SDK versions and handling breaking changes.

Prerequisites

•Current Clay SDK installed
•Git for version control
•Test suite available
•Staging environment

Instructions

Step 1: Check Current Version

bash

npm list @clay/sdk
npm view @clay/sdk version

Step 2: Review Changelog

bash

open https://github.com/clay/sdk/releases

Step 3: Create Upgrade Branch

bash

git checkout -b upgrade/clay-sdk-vX.Y.Z
npm install @clay/sdk@latest
npm test

Step 4: Handle Breaking Changes

Update import statements, configuration, and method signatures as needed.

Output

•Updated SDK version
•Fixed breaking changes
•Passing test suite
•Documented rollback procedure

Error Handling

SDK Version	API Version	Node.js	Breaking Changes
3.x	2024-01	18+	Major refactor
2.x	2023-06	16+	Auth changes
1.x	2022-01	14+	Initial release

Examples

Import Changes

typescript

// Before (v1.x)
import { Client } from '@clay/sdk';

// After (v2.x)
import { ClayClient } from '@clay/sdk';

Configuration Changes

typescript

// Before (v1.x)
const client = new Client({ key: 'xxx' });

// After (v2.x)
const client = new ClayClient({
  apiKey: 'xxx',
});

Rollback Procedure

bash

npm install @clay/sdk@1.x.x --save-exact

Deprecation Handling

typescript

// Monitor for deprecation warnings in development
if (process.env.NODE_ENV === 'development') {
  process.on('warning', (warning) => {
    if (warning.name === 'DeprecationWarning') {
      console.warn('[Clay]', warning.message);
      // Log to tracking system for proactive updates
    }
  });
}

// Common deprecation patterns to watch for:
// - Renamed methods: client.oldMethod() -> client.newMethod()
// - Changed parameters: { key: 'x' } -> { apiKey: 'x' }
// - Removed features: Check release notes before upgrading

Resources

•Clay Changelog
•Clay Migration Guide

Next Steps

For CI integration during upgrades, see clay-ci-integration.