Merged
Conversation
Contributor
calvinbrewer
commented
May 28, 2025
- add support for createSearchTerms method on the protectClient to impove the developer experience of encrypting search terms for use with SQL queries
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for a new createSearchTerms method on the ProtectClient to simplify encrypting search terms for SQL queries. Key changes include:
- New type definitions for SearchTerm and EncryptedSearchTerm in types.ts.
- A new SearchTermsOperation in the ffi operations that encrypts an array of search terms.
- Integration of the createSearchTerms method in the ProtectClient along with corresponding tests and documentation updates.
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/protect/src/types.ts | Added type definitions for search term encryption. |
| packages/protect/src/ffi/operations/search-terms.ts | Implements encryption logic for search terms with special formatting based on return type. |
| packages/protect/src/ffi/index.ts | Exposes the createSearchTerms method in the ProtectClient API. |
| packages/protect/tests/search-terms.test.ts | Added tests to validate the functionality for default, composite-literal, and escaped composite literal returns. |
| docs/reference/supabase-sdk.md | Updated documentation to demonstrate the new API usage. |
| .changeset/fruity-shoes-talk.md | New changeset note documenting the minor release. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.