Skip to content

fix(ts-sdk): export ClusterSortOption type #1171

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
realfishsam wants to merge 1 commit into
base: main
Choose a base branch
from
+13 −1
Open

fix(ts-sdk): export ClusterSortOption type #1171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion sdks/typescript/pmxt/models.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -983,7 +983,10 @@ export interface EventMatchResult extends Readonly<UnifiedEvent> {
marketMatches: MatchResult[];
}

export type MatchedClusterSort = 'volume' | 'confidence';
/** Canonical cluster sort literal shared with the Python SDK. */
export type ClusterSortOption = 'volume' | 'confidence';

export type MatchedClusterSort = ClusterSortOption;

/** Shared filters for matched market/event cluster discovery. */
export interface MatchedClusterFilterParams {
Expand Down
9 changes: 9 additions & 0 deletions sdks/typescript/tests/public-exports.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
import * as pmxt from '../index';
import { FeedClient as DirectFeedClient } from '../pmxt/feed-client';
import type { ClusterSortOption, MatchedClusterSort } from '../index';

const acceptsClusterSortOption = (sort: ClusterSortOption): MatchedClusterSort => sort;

describe('public exports', () => {
it('exports FeedClient as a top-level named export', () => {
Expand All @@ -16,4 +19,10 @@ describe('public exports', () => {
const client = new pmxt.FeedClient('chainlink');
expect(client).toBeInstanceOf(DirectFeedClient);
});

it('exports ClusterSortOption as a public type alias matching MatchedClusterSort', () => {
const byVolume = acceptsClusterSortOption('volume');
const byConfidence = acceptsClusterSortOption('confidence');
expect([byVolume, byConfidence]).toEqual(['volume', 'confidence']);
});
});
Loading