diff --git a/.changeset/chatty-lemons-reply.md b/.changeset/chatty-lemons-reply.md new file mode 100644 index 0000000000..118f832646 --- /dev/null +++ b/.changeset/chatty-lemons-reply.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-search-backend-module-elasticsearch': patch +--- + +Export `decodeElasticSearchPageCursor` utility function diff --git a/plugins/search-backend-module-elasticsearch/api-report.md b/plugins/search-backend-module-elasticsearch/api-report.md index 9e3ca40ec7..8545e3fd8f 100644 --- a/plugins/search-backend-module-elasticsearch/api-report.md +++ b/plugins/search-backend-module-elasticsearch/api-report.md @@ -67,6 +67,11 @@ export interface BaseElasticSearchClientOptions { Transport?: ElasticSearchTransportConstructor; } +// @public (undocumented) +export function decodeElasticSearchPageCursor(pageCursor?: string): { + page: number; +}; + // @public (undocumented) export interface ElasticSearchAgentOptions { // (undocumented) diff --git a/plugins/search-backend-module-elasticsearch/src/engines/ElasticSearchSearchEngine.ts b/plugins/search-backend-module-elasticsearch/src/engines/ElasticSearchSearchEngine.ts index 9edad973de..c2f4224db3 100644 --- a/plugins/search-backend-module-elasticsearch/src/engines/ElasticSearchSearchEngine.ts +++ b/plugins/search-backend-module-elasticsearch/src/engines/ElasticSearchSearchEngine.ts @@ -408,6 +408,9 @@ export class ElasticSearchSearchEngine implements SearchEngine { } } +/** + * @public + */ export function decodePageCursor(pageCursor?: string): { page: number } { if (!pageCursor) { return { page: 0 }; diff --git a/plugins/search-backend-module-elasticsearch/src/engines/index.ts b/plugins/search-backend-module-elasticsearch/src/engines/index.ts index 8c3b9e3c6d..cb24bdc56a 100644 --- a/plugins/search-backend-module-elasticsearch/src/engines/index.ts +++ b/plugins/search-backend-module-elasticsearch/src/engines/index.ts @@ -14,7 +14,10 @@ * limitations under the License. */ -export { ElasticSearchSearchEngine } from './ElasticSearchSearchEngine'; +export { + decodePageCursor as decodeElasticSearchPageCursor, + ElasticSearchSearchEngine, +} from './ElasticSearchSearchEngine'; export { isOpenSearchCompatible } from './ElasticSearchClientOptions'; export type { BaseElasticSearchClientOptions, diff --git a/plugins/search-backend-module-elasticsearch/src/index.ts b/plugins/search-backend-module-elasticsearch/src/index.ts index cb4f62098a..e0b05014cc 100644 --- a/plugins/search-backend-module-elasticsearch/src/index.ts +++ b/plugins/search-backend-module-elasticsearch/src/index.ts @@ -20,7 +20,11 @@ * @packageDocumentation */ -export { ElasticSearchSearchEngine, isOpenSearchCompatible } from './engines'; +export { + decodeElasticSearchPageCursor, + ElasticSearchSearchEngine, + isOpenSearchCompatible, +} from './engines'; export type { BaseElasticSearchClientOptions, ElasticSearchAgentOptions,