stripe-search-ql

A TypeScript query builder library for easily constructing queries for the Stripe Search API.

Installation

npm install stripe-search-ql

Usage

Basic Examples

import { stripeQuery } from "stripe-search-ql";

// Exact match search
const query = stripeQuery()
  .field("email")
  .equals("[email protected]")
  .build();
// => 'email:"[email protected]"'

// Numeric comparison
const amountQuery = stripeQuery()
  .field("amount")
  .greaterThan(1000)
  .build();
// => 'amount>1000'

// Substring match
const substringQuery = stripeQuery()
  .field("email")
  .contains("amy")
  .build();
// => 'email~"amy"'

Combining Multiple Conditions

// AND operator
const andQuery = stripeQuery()
  .field("email")
  .equals("[email protected]")
  .and()
  .field("currency")
  .equals("usd")
  .build();
// => 'email:"[email protected]" AND currency:"usd"'

// OR operator
const orQuery = stripeQuery()
  .field("currency")
  .equals("usd")
  .or()
  .field("currency")
  .equals("eur")
  .build();
// => 'currency:"usd" OR currency:"eur"'

Metadata Search

// Exact match for metadata
const metadataQuery = stripeQuery()
  .metadata("donation-id")
  .equals("asdf-jkl")
  .build();
// => 'metadata["donation-id"]:"asdf-jkl"'

// Substring match for metadata
const metadataSubstringQuery = stripeQuery()
  .metadata("key")
  .contains("value")
  .build();
// => 'metadata["key"]~"value"'

Negation Search

// Field negation
const negatedQuery = stripeQuery()
  .not("currency")
  .equals("jpy")
  .build();
// => '-currency:"jpy"'

// Metadata negation
const negatedMetadataQuery = stripeQuery()
  .notMetadata("donation-id")
  .equals("asdf-jkl")
  .build();
// => '-metadata["donation-id"]:"asdf-jkl"'

NULL Value Checks

// Check if field is NULL
const nullCheckQuery = stripeQuery()
  .field("url")
  .isNull()
  .build();
// => 'url:null'

// Check if metadata key does not exist
const metadataNullQuery = stripeQuery()
  .notMetadata("donation-id")
  .isNull()
  .build();
// => '-metadata["donation-id"]:null'

Numeric Comparison Operators

// Greater than
stripeQuery().field("amount").greaterThan(1000).build();
// => 'amount>1000'

// Less than
stripeQuery().field("amount").lessThan(1000).build();
// => 'amount<1000'

// Greater than or equal
stripeQuery().field("amount").greaterThanOrEqual(1000).build();
// => 'amount>=1000'

// Less than or equal
stripeQuery().field("amount").lessThanOrEqual(1000).build();
// => 'amount<=1000'

Complex Query Examples

// Combining multiple conditions
const complexQuery = stripeQuery()
  .field("email")
  .equals("[email protected]")
  .and()
  .metadata("donation-id")
  .equals("asdf-jkl")
  .and()
  .field("amount")
  .greaterThan(1000)
  .build();
// => 'email:"[email protected]" AND metadata["donation-id"]:"asdf-jkl" AND amount>1000'

API Reference

stripeQuery()

Creates a new query builder instance.

Returns: SearchQueryBuilder instance

SearchQueryBuilder

Field Search

• field(field: string): FieldBuilder - Specify a field to build search conditions
• not(field: string): FieldBuilder - Specify a negated field to build search conditions

Metadata Search

• metadata(key: string): MetadataFieldBuilder - Specify a metadata field to build search conditions
• notMetadata(key: string): MetadataFieldBuilder - Specify a negated metadata field to build search conditions

Logical Operators

• and(): SearchQueryBuilder - Add AND operator
• or(): SearchQueryBuilder - Add OR operator

Others

• build(): string - Returns the constructed query as a string
• reset(): SearchQueryBuilder - Reset the query

FieldBuilder

• equals(value: string | number | null): SearchQueryBuilder - Exact match (:)
• contains(value: string): SearchQueryBuilder - Substring match (~, minimum 3 characters)
• greaterThan(value: number): SearchQueryBuilder - Greater than (>)
• lessThan(value: number): SearchQueryBuilder - Less than (<)
• greaterThanOrEqual(value: number): SearchQueryBuilder - Greater than or equal (>=)
• lessThanOrEqual(value: number): SearchQueryBuilder - Less than or equal (<=)
• isNull(): SearchQueryBuilder - NULL value check

MetadataFieldBuilder

• equals(value: string | number | null): SearchQueryBuilder - Exact match (:)
• contains(value: string): SearchQueryBuilder - Substring match (~, minimum 3 characters)
• isNull(): SearchQueryBuilder - NULL value check (when metadata key does not exist)

Integration with Stripe Search API

The constructed query can be used with the Stripe SDK or API client.

import { stripeQuery } from "stripe-search-ql";
import Stripe from "stripe";

const stripe = new Stripe(process.env.STRIPE_SECRET_KEY!);

// Build query
const query = stripeQuery()
  .field("email")
  .equals("[email protected]")
  .build();

// Search with Stripe API
const customers = await stripe.customers.search({
  query: query,
});

Limitations

• Substring match (~) requires a minimum of 3 characters
• You cannot mix AND and OR in the same query (Stripe Search API limitation)
• Parentheses for specifying precedence are not supported (Stripe Search API limitation)

Development

# Install dependencies
npm install

# Build
npm run build

# Test
npm test

# Test (watch mode)
npm run test:watch

# Linter
npm run lint

# Formatter
npm run format

# Type check
npm run typecheck

License

MIT