Node.js SDK upgrade (v0.x to v1.0)

1. Fully Typed API: Complete TypeScript definitions for all requests and responses

2. Enhanced Error Handling: Typed errors with better context

3. Auto-pagination: Easily iterate through paginated resources

4. Request/Response Access: More control over raw responses

5. Configurable Logging: Better debugging capabilities

6. Configurable Timeouts and Retries: Fine-tune request behavior

7. New Resources: Additional resources like Audiences, Channels, and Integrations

1. The notify method is now workflows.trigger

2. Client initialization accepts an options object instead of just the API key

3. Some parameter names have changed to match the API (e.g., cancellationKey → cancellation_key)

4. Error handling has been completely revamped with typed errors

5. The signUserToken method should now be imported from @knocklabs/node/lib/tokenSigner if referenced directly.

6. Method naming convention changes:

   • users.getPreferences() now requires a preference set ID parameter
   • users.bulkIdentify() is now users.bulk.identify()
   • users.bulkDelete() is now users.bulk.delete()
   • users.bulkSetPreferences() is now users.bulk.setPreferences()
   • users.getSchedules() is now users.listSchedules()
   • workflows.createSchedules() is now schedules.create()
   • workflows.listSchedules() is now schedules.list()
   • workflows.updateSchedules() is now schedules.update()
   • workflows.deleteSchedules() is now schedules.delete()
   • Bulk schedule updates are available via schedules.bulk.create()

7. Parameter style changes:

   • All parameters are now in camelCase in the method signature but use snake_case in the request body
   • Query parameters are now passed as a separate object in most list methods

8. Response handling:

   • The new SDK returns the data directly in most cases rather than wrapped in a data property
   • Pagination is handled differently with cursor-based pagination

Old version:

1.x release:

Old version:

1.x release:

If you encounter any issues during migration, please reach out to our support team or open an issue on GitHub.