Skip to content

fix(Search, Typescript): addresses issues with GFilter and GBucket types #779

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

Merged
jbottigliero merged 2 commits into from
Mar 3, 2026
Merged

fix(Search, Typescript): addresses issues with GFilter and GBucket types #779

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cba40bc
fix(Search, Typescript): addresses issues with GFilter and GBucket types
jbottigliero Mar 3, 2026
7595e93
docs: improve comments
jbottigliero Mar 3, 2026
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
58 changes: 26 additions & 32 deletions src/services/search/service/query.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,15 @@ import type { JSONFetchResponse, SDKOptions, ServiceMethodOptions } from '../../
import type { OpenAPI } from '../index.js';
import type { ResultFormatVersion } from '../types.js';

type Content = NonNullable<OpenAPI.components['schemas']['ResultEntry']['content']>;
export type MatchedPrincipalSets =
OpenAPI.components['schemas']['ResultEntry']['matched_principal_sets'];
type Schemas = OpenAPI.components['schemas'];

type Content = NonNullable<Schemas['ResultEntry']['content']>;
export type MatchedPrincipalSets = Schemas['ResultEntry']['matched_principal_sets'];
/**
* @see https://docs.globus.org/api/search/reference/post_query/#gmetaresult
*/
export type GMetaResult<C extends Content = Content> = Omit<
OpenAPI.components['schemas']['GMetaResult'],
'entries'
> & {
entries: (Omit<OpenAPI.components['schemas']['ResultEntry'], 'content'> & { content: C })[];
export type GMetaResult<C extends Content = Content> = Omit<Schemas['GMetaResult'], 'entries'> & {
entries: (Omit<Schemas['ResultEntry'], 'content'> & { content: C })[];
};

/**
Expand All @@ -33,7 +31,13 @@ export type GFacetResult = {
* @see https://docs.globus.org/api/search/reference/post_query/#gbucket
*/
export type GBucket = {
value: string | GFilter;
value:
| string
| number
| {
to: string;
from: string;
};
count: number;
};

Expand Down Expand Up @@ -137,32 +141,22 @@ export const post = function <C extends Content = Content>(
);
};

type OptionalKeys<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;

/**
* @see https://docs.globus.org/api/search/reference/post_query/#gfilter
* Utility type to make specific keys in a union of objects optional.
* This is used to account for `defaultNonNullable: true` when generating types.
* @see file://./../../../../scripts/open-api/generate-types.mjs#L54-L55
*/
export type GFilter = GFilterMatch | GFilterRange | GFilterExists | GFilterNot;
type OptionalKeysInUnion<T, K extends string> = T extends object ? OptionalKeys<T, K & keyof T> : T;

type GFilterTypeMatch = 'match_any' | 'match_all';
type GFilterTypeRange = 'range';

type GFilterMatch = {
type: GFilterTypeMatch;
field_name: string;
values: Array<string>;
};
type GFilterRange = {
type: GFilterTypeRange;
field_name: string;
values: Array<{ from: string; to: string }>;
};
type GFilterExists = {
type: 'exists';
field_name: string;
};
type GFilterNot = {
type: 'not';
filter: GFilter;
};
/**
* @see https://docs.globus.org/api/search/reference/post_query/#gfilter
*
* @privateRemarks
* The `GFilter` type includes `@version` and `post_filter` with `"default"` values.
*/
export type GFilter = OptionalKeysInUnion<Schemas['GFilter'], '@version' | 'post_filter'>;

type HistogramRange = { low: number | string; high: number | string };

Expand Down