@xemahq/search-api-client 0.1.1 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (90) hide show
  1. package/LICENSE +36 -1
  2. package/README.md +62 -0
  3. package/dist/custom-fetch.d.ts +1 -1
  4. package/dist/custom-fetch.js +1 -1
  5. package/dist/endpoints/search/search.d.ts +3 -3
  6. package/dist/endpoints/search/search.js +6 -6
  7. package/dist/endpoints/search-types/search-types.d.ts +18 -0
  8. package/dist/endpoints/search-types/search-types.js +51 -0
  9. package/dist/index.d.ts +1 -3
  10. package/dist/index.js +2 -4
  11. package/dist/models/errorDetailsDto.d.ts +2 -2
  12. package/dist/models/errorDetailsDtoDetails.d.ts +1 -1
  13. package/dist/models/errorDetailsDtoDetails.js +1 -1
  14. package/dist/models/errorPayloadDto.d.ts +2 -2
  15. package/dist/models/errorResponseDto.d.ts +2 -2
  16. package/dist/models/facetBucket.d.ts +2 -2
  17. package/dist/models/facetBucketSubFacets.d.ts +1 -1
  18. package/dist/models/facetBucketSubFacets.js +1 -1
  19. package/dist/models/facetResponse.d.ts +2 -2
  20. package/dist/models/facetResponseDataEnvelope.d.ts +2 -2
  21. package/dist/models/index.d.ts +9 -20
  22. package/dist/models/index.js +9 -20
  23. package/dist/models/resolvedRouteDto.d.ts +21 -0
  24. package/dist/models/{reindexJobResponseDtoCompletedAt.js → resolvedRouteDto.js} +1 -1
  25. package/dist/models/resolvedRouteDtoDataEnvelope.d.ts +11 -0
  26. package/dist/models/resourceVisibilityPattern.d.ts +18 -0
  27. package/dist/models/resourceVisibilityPattern.js +17 -0
  28. package/dist/models/searchControllerFacetsParams.d.ts +1 -1
  29. package/dist/models/searchControllerFacetsParams.js +1 -1
  30. package/dist/models/searchControllerSearchParams.d.ts +2 -2
  31. package/dist/models/searchControllerSearchSearchMode.d.ts +1 -1
  32. package/dist/models/searchControllerSearchSearchMode.js +1 -1
  33. package/dist/models/searchHitDto.d.ts +8 -4
  34. package/dist/models/searchHitDtoDocType.d.ts +2 -2
  35. package/dist/models/searchHitDtoDocType.js +1 -1
  36. package/dist/models/searchHitDtoHighlights.d.ts +1 -1
  37. package/dist/models/searchHitDtoHighlights.js +1 -1
  38. package/dist/models/searchResultDto.d.ts +2 -2
  39. package/dist/models/searchResultDtoDataEnvelope.d.ts +2 -2
  40. package/dist/models/searchTypeAuthzDto.d.ts +14 -0
  41. package/dist/models/searchTypeDto.d.ts +29 -0
  42. package/dist/models/{reindexJobResponseDtoCompletedAt.d.ts → searchTypeListDto.d.ts} +5 -7
  43. package/dist/models/searchTypeListDtoDataEnvelope.d.ts +11 -0
  44. package/dist/models/searchTypeRenderHintsDto.d.ts +15 -0
  45. package/dist/models/{adminControllerGetTraceStatsParams.js → searchTypeRenderHintsDto.js} +1 -1
  46. package/dist/models/searchTypesControllerResolveRouteParams.d.ts +13 -0
  47. package/dist/models/{reindexJobResponseDtoError.js → searchTypesControllerResolveRouteParams.js} +1 -1
  48. package/package.json +12 -2
  49. package/dist/endpoints/admin/admin.d.ts +0 -28
  50. package/dist/endpoints/admin/admin.js +0 -98
  51. package/dist/endpoints/health/health.d.ts +0 -20
  52. package/dist/endpoints/health/health.js +0 -67
  53. package/dist/endpoints/mcp/mcp.d.ts +0 -6
  54. package/dist/endpoints/mcp/mcp.js +0 -44
  55. package/dist/models/adminControllerGetTraceStatsParams.d.ts +0 -13
  56. package/dist/models/adminControllerGetTracesParams.d.ts +0 -21
  57. package/dist/models/adminControllerGetTracesParams.js +0 -9
  58. package/dist/models/modeStatsDto.d.ts +0 -16
  59. package/dist/models/modeStatsDtoMode.d.ts +0 -16
  60. package/dist/models/modeStatsDtoMode.js +0 -15
  61. package/dist/models/reindexJobResponseDto.d.ts +0 -28
  62. package/dist/models/reindexJobResponseDtoDataEnvelope.d.ts +0 -11
  63. package/dist/models/reindexJobResponseDtoError.d.ts +0 -13
  64. package/dist/models/reindexJobResponseDtoStatus.d.ts +0 -17
  65. package/dist/models/reindexJobResponseDtoStatus.js +0 -16
  66. package/dist/models/reindexTriggerResponseDto.d.ts +0 -15
  67. package/dist/models/reindexTriggerResponseDto.js +0 -9
  68. package/dist/models/reindexTriggerResponseDtoDataEnvelope.d.ts +0 -11
  69. package/dist/models/searchStatsResponseDto.d.ts +0 -22
  70. package/dist/models/searchStatsResponseDtoDataEnvelope.d.ts +0 -11
  71. package/dist/models/searchStatsResponseDtoDataEnvelope.js +0 -2
  72. package/dist/models/searchTraceResponseDto.d.ts +0 -37
  73. package/dist/models/searchTraceResponseDto.js +0 -2
  74. package/dist/models/searchTraceResponseDtoCallerService.d.ts +0 -13
  75. package/dist/models/searchTraceResponseDtoCallerService.js +0 -9
  76. package/dist/models/searchTraceResponseDtoEmbeddingMs.d.ts +0 -13
  77. package/dist/models/searchTraceResponseDtoEmbeddingMs.js +0 -9
  78. package/dist/models/searchTraceResponseDtoSearchMode.d.ts +0 -16
  79. package/dist/models/searchTraceResponseDtoSearchMode.js +0 -15
  80. package/dist/models/searchTraceResponseDtoTopScore.d.ts +0 -13
  81. package/dist/models/searchTraceResponseDtoTopScore.js +0 -9
  82. package/dist/models/tracesListResponseDto.d.ts +0 -14
  83. package/dist/models/tracesListResponseDto.js +0 -2
  84. package/dist/models/tracesListResponseDtoDataEnvelope.d.ts +0 -11
  85. package/dist/models/tracesListResponseDtoDataEnvelope.js +0 -2
  86. /package/dist/models/{modeStatsDto.js → resolvedRouteDtoDataEnvelope.js} +0 -0
  87. /package/dist/models/{reindexJobResponseDto.js → searchTypeAuthzDto.js} +0 -0
  88. /package/dist/models/{reindexJobResponseDtoDataEnvelope.js → searchTypeDto.js} +0 -0
  89. /package/dist/models/{reindexTriggerResponseDtoDataEnvelope.js → searchTypeListDto.js} +0 -0
  90. /package/dist/models/{searchStatsResponseDto.js → searchTypeListDtoDataEnvelope.js} +0 -0
@@ -1,28 +0,0 @@
1
- /**
2
- * Generated by orval v8.6.2 🍺
3
- * Do not edit manually.
4
- * Search API
5
- * Full-text search service — indexes content via event-hub, provides search and MCP tools
6
- * OpenAPI spec version: 0.1.0
7
- */
8
- import type { ReindexJobResponseDtoCompletedAt } from './reindexJobResponseDtoCompletedAt';
9
- import type { ReindexJobResponseDtoError } from './reindexJobResponseDtoError';
10
- import type { ReindexJobResponseDtoStatus } from './reindexJobResponseDtoStatus';
11
- export interface ReindexJobResponseDto {
12
- /** Unique job ID */
13
- jobId: string;
14
- /** Organization ID */
15
- orgId: string;
16
- /** Current job status */
17
- status: ReindexJobResponseDtoStatus;
18
- /** Number of documents processed */
19
- progress: number;
20
- /** Total documents to process */
21
- total: number;
22
- /** Error message if the job failed */
23
- error?: ReindexJobResponseDtoError;
24
- /** Job creation timestamp */
25
- createdAt: string;
26
- /** Job completion timestamp */
27
- completedAt?: ReindexJobResponseDtoCompletedAt;
28
- }
@@ -1,11 +0,0 @@
1
- /**
2
- * Generated by orval v8.6.2 🍺
3
- * Do not edit manually.
4
- * Search API
5
- * Full-text search service — indexes content via event-hub, provides search and MCP tools
6
- * OpenAPI spec version: 0.1.0
7
- */
8
- import type { ReindexJobResponseDto } from './reindexJobResponseDto';
9
- export interface ReindexJobResponseDtoDataEnvelope {
10
- data: ReindexJobResponseDto;
11
- }
@@ -1,13 +0,0 @@
1
- /**
2
- * Generated by orval v8.6.2 🍺
3
- * Do not edit manually.
4
- * Search API
5
- * Full-text search service — indexes content via event-hub, provides search and MCP tools
6
- * OpenAPI spec version: 0.1.0
7
- */
8
- /**
9
- * Error message if the job failed
10
- */
11
- export type ReindexJobResponseDtoError = {
12
- [key: string]: unknown;
13
- };
@@ -1,17 +0,0 @@
1
- /**
2
- * Generated by orval v8.6.2 🍺
3
- * Do not edit manually.
4
- * Search API
5
- * Full-text search service — indexes content via event-hub, provides search and MCP tools
6
- * OpenAPI spec version: 0.1.0
7
- */
8
- /**
9
- * Current job status
10
- */
11
- export type ReindexJobResponseDtoStatus = typeof ReindexJobResponseDtoStatus[keyof typeof ReindexJobResponseDtoStatus];
12
- export declare const ReindexJobResponseDtoStatus: {
13
- readonly PENDING: "PENDING";
14
- readonly RUNNING: "RUNNING";
15
- readonly COMPLETED: "COMPLETED";
16
- readonly FAILED: "FAILED";
17
- };
@@ -1,16 +0,0 @@
1
- "use strict";
2
- /**
3
- * Generated by orval v8.6.2 🍺
4
- * Do not edit manually.
5
- * Search API
6
- * Full-text search service — indexes content via event-hub, provides search and MCP tools
7
- * OpenAPI spec version: 0.1.0
8
- */
9
- Object.defineProperty(exports, "__esModule", { value: true });
10
- exports.ReindexJobResponseDtoStatus = void 0;
11
- exports.ReindexJobResponseDtoStatus = {
12
- PENDING: 'PENDING',
13
- RUNNING: 'RUNNING',
14
- COMPLETED: 'COMPLETED',
15
- FAILED: 'FAILED',
16
- };
@@ -1,15 +0,0 @@
1
- /**
2
- * Generated by orval v8.6.2 🍺
3
- * Do not edit manually.
4
- * Search API
5
- * Full-text search service — indexes content via event-hub, provides search and MCP tools
6
- * OpenAPI spec version: 0.1.0
7
- */
8
- export interface ReindexTriggerResponseDto {
9
- /** Unique job ID */
10
- jobId: string;
11
- /** Job status */
12
- status: string;
13
- /** Organization ID */
14
- orgId: string;
15
- }
@@ -1,9 +0,0 @@
1
- "use strict";
2
- /**
3
- * Generated by orval v8.6.2 🍺
4
- * Do not edit manually.
5
- * Search API
6
- * Full-text search service — indexes content via event-hub, provides search and MCP tools
7
- * OpenAPI spec version: 0.1.0
8
- */
9
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,11 +0,0 @@
1
- /**
2
- * Generated by orval v8.6.2 🍺
3
- * Do not edit manually.
4
- * Search API
5
- * Full-text search service — indexes content via event-hub, provides search and MCP tools
6
- * OpenAPI spec version: 0.1.0
7
- */
8
- import type { ReindexTriggerResponseDto } from './reindexTriggerResponseDto';
9
- export interface ReindexTriggerResponseDtoDataEnvelope {
10
- data: ReindexTriggerResponseDto;
11
- }
@@ -1,22 +0,0 @@
1
- /**
2
- * Generated by orval v8.6.2 🍺
3
- * Do not edit manually.
4
- * Search API
5
- * Full-text search service — indexes content via event-hub, provides search and MCP tools
6
- * OpenAPI spec version: 0.1.0
7
- */
8
- import type { ModeStatsDto } from './modeStatsDto';
9
- export interface SearchStatsResponseDto {
10
- /** Total number of search queries */
11
- totalQueries: number;
12
- /** Average latency in milliseconds */
13
- avgLatencyMs: number;
14
- /** Maximum latency in milliseconds */
15
- maxLatencyMs: number;
16
- /** Minimum latency in milliseconds */
17
- minLatencyMs: number;
18
- /** Average number of hits per query */
19
- avgHitCount: number;
20
- /** Breakdown by search mode */
21
- byMode: ModeStatsDto[];
22
- }
@@ -1,11 +0,0 @@
1
- /**
2
- * Generated by orval v8.6.2 🍺
3
- * Do not edit manually.
4
- * Search API
5
- * Full-text search service — indexes content via event-hub, provides search and MCP tools
6
- * OpenAPI spec version: 0.1.0
7
- */
8
- import type { SearchStatsResponseDto } from './searchStatsResponseDto';
9
- export interface SearchStatsResponseDtoDataEnvelope {
10
- data: SearchStatsResponseDto;
11
- }
@@ -1,2 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,37 +0,0 @@
1
- /**
2
- * Generated by orval v8.6.2 🍺
3
- * Do not edit manually.
4
- * Search API
5
- * Full-text search service — indexes content via event-hub, provides search and MCP tools
6
- * OpenAPI spec version: 0.1.0
7
- */
8
- import type { SearchTraceResponseDtoCallerService } from './searchTraceResponseDtoCallerService';
9
- import type { SearchTraceResponseDtoEmbeddingMs } from './searchTraceResponseDtoEmbeddingMs';
10
- import type { SearchTraceResponseDtoSearchMode } from './searchTraceResponseDtoSearchMode';
11
- import type { SearchTraceResponseDtoTopScore } from './searchTraceResponseDtoTopScore';
12
- export interface SearchTraceResponseDto {
13
- /** Trace ID */
14
- id: string;
15
- /** Organization ID */
16
- orgId: string;
17
- /** Project ID */
18
- projectId: string;
19
- /** Search query text */
20
- query: string;
21
- /** Search mode used */
22
- searchMode: SearchTraceResponseDtoSearchMode;
23
- /** Calling service name */
24
- callerService?: SearchTraceResponseDtoCallerService;
25
- /** Number of hits returned */
26
- hitCount: number;
27
- /** Embedding generation latency in milliseconds */
28
- embeddingMs?: SearchTraceResponseDtoEmbeddingMs;
29
- /** Search execution latency in milliseconds */
30
- searchMs: number;
31
- /** Total request latency in milliseconds */
32
- totalMs: number;
33
- /** Score of the top-ranked hit */
34
- topScore?: SearchTraceResponseDtoTopScore;
35
- /** Trace creation timestamp */
36
- createdAt: string;
37
- }
@@ -1,2 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,13 +0,0 @@
1
- /**
2
- * Generated by orval v8.6.2 🍺
3
- * Do not edit manually.
4
- * Search API
5
- * Full-text search service — indexes content via event-hub, provides search and MCP tools
6
- * OpenAPI spec version: 0.1.0
7
- */
8
- /**
9
- * Calling service name
10
- */
11
- export type SearchTraceResponseDtoCallerService = {
12
- [key: string]: unknown;
13
- };
@@ -1,9 +0,0 @@
1
- "use strict";
2
- /**
3
- * Generated by orval v8.6.2 🍺
4
- * Do not edit manually.
5
- * Search API
6
- * Full-text search service — indexes content via event-hub, provides search and MCP tools
7
- * OpenAPI spec version: 0.1.0
8
- */
9
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,13 +0,0 @@
1
- /**
2
- * Generated by orval v8.6.2 🍺
3
- * Do not edit manually.
4
- * Search API
5
- * Full-text search service — indexes content via event-hub, provides search and MCP tools
6
- * OpenAPI spec version: 0.1.0
7
- */
8
- /**
9
- * Embedding generation latency in milliseconds
10
- */
11
- export type SearchTraceResponseDtoEmbeddingMs = {
12
- [key: string]: unknown;
13
- };
@@ -1,9 +0,0 @@
1
- "use strict";
2
- /**
3
- * Generated by orval v8.6.2 🍺
4
- * Do not edit manually.
5
- * Search API
6
- * Full-text search service — indexes content via event-hub, provides search and MCP tools
7
- * OpenAPI spec version: 0.1.0
8
- */
9
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,16 +0,0 @@
1
- /**
2
- * Generated by orval v8.6.2 🍺
3
- * Do not edit manually.
4
- * Search API
5
- * Full-text search service — indexes content via event-hub, provides search and MCP tools
6
- * OpenAPI spec version: 0.1.0
7
- */
8
- /**
9
- * Search mode used
10
- */
11
- export type SearchTraceResponseDtoSearchMode = typeof SearchTraceResponseDtoSearchMode[keyof typeof SearchTraceResponseDtoSearchMode];
12
- export declare const SearchTraceResponseDtoSearchMode: {
13
- readonly TEXT: "TEXT";
14
- readonly SEMANTIC: "SEMANTIC";
15
- readonly HYBRID: "HYBRID";
16
- };
@@ -1,15 +0,0 @@
1
- "use strict";
2
- /**
3
- * Generated by orval v8.6.2 🍺
4
- * Do not edit manually.
5
- * Search API
6
- * Full-text search service — indexes content via event-hub, provides search and MCP tools
7
- * OpenAPI spec version: 0.1.0
8
- */
9
- Object.defineProperty(exports, "__esModule", { value: true });
10
- exports.SearchTraceResponseDtoSearchMode = void 0;
11
- exports.SearchTraceResponseDtoSearchMode = {
12
- TEXT: 'TEXT',
13
- SEMANTIC: 'SEMANTIC',
14
- HYBRID: 'HYBRID',
15
- };
@@ -1,13 +0,0 @@
1
- /**
2
- * Generated by orval v8.6.2 🍺
3
- * Do not edit manually.
4
- * Search API
5
- * Full-text search service — indexes content via event-hub, provides search and MCP tools
6
- * OpenAPI spec version: 0.1.0
7
- */
8
- /**
9
- * Score of the top-ranked hit
10
- */
11
- export type SearchTraceResponseDtoTopScore = {
12
- [key: string]: unknown;
13
- };
@@ -1,9 +0,0 @@
1
- "use strict";
2
- /**
3
- * Generated by orval v8.6.2 🍺
4
- * Do not edit manually.
5
- * Search API
6
- * Full-text search service — indexes content via event-hub, provides search and MCP tools
7
- * OpenAPI spec version: 0.1.0
8
- */
9
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,14 +0,0 @@
1
- /**
2
- * Generated by orval v8.6.2 🍺
3
- * Do not edit manually.
4
- * Search API
5
- * Full-text search service — indexes content via event-hub, provides search and MCP tools
6
- * OpenAPI spec version: 0.1.0
7
- */
8
- import type { SearchTraceResponseDto } from './searchTraceResponseDto';
9
- export interface TracesListResponseDto {
10
- /** List of search traces */
11
- traces: SearchTraceResponseDto[];
12
- /** Total number of matching traces */
13
- total: number;
14
- }
@@ -1,2 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,11 +0,0 @@
1
- /**
2
- * Generated by orval v8.6.2 🍺
3
- * Do not edit manually.
4
- * Search API
5
- * Full-text search service — indexes content via event-hub, provides search and MCP tools
6
- * OpenAPI spec version: 0.1.0
7
- */
8
- import type { TracesListResponseDto } from './tracesListResponseDto';
9
- export interface TracesListResponseDtoDataEnvelope {
10
- data: TracesListResponseDto;
11
- }
@@ -1,2 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });