@owox/api-client 0.35.0-next-20260917211534 → 0.36.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.
package/dist/index.d.ts CHANGED
@@ -14,7 +14,7 @@ export { type OWOXMarkdownParseRequest, type OWOXMarkdownParseResponse } from '.
14
14
  export { type OWOXProjectDataMartRun, type OWOXProjectDataMartRunRef, type OWOXProjectDataMartRunsResponse, type OWOXProjectDataMartRunStatus, type OWOXProjectDataMartRunTriggerType, type OWOXProjectDataMartRunType, type OWOXProjectDataMartRunUser, type OWOXProjectRunHistoryOptions, type OWOXDataMartRunsScope, } from './runs.js';
15
15
  export { type OWOXProjectSettings, type OWOXProjectSetupProgress, type OWOXProjectSetupProgressSteps, type OWOXProjectSetupStepState, } from './project.js';
16
16
  export { type OWOXReportOutputSchemaField } from './reports.js';
17
- export { type OWOXSearchEntityType, type OWOXSearchOptions, type OWOXSearchResult, } from './search.js';
17
+ export { type OWOXSearchEntityType, type OWOXSearchOptions, type OWOXSearchReportRef, type OWOXSearchResult, } from './search.js';
18
18
  export { HttpNdjsonTraversal,
19
19
  /** @deprecated Use {@link HttpNdjsonTraversal} instead. Kept for backward compatibility. */
20
20
  HttpNdjsonTraversal as DataMartDataTraversal, } from './traversal.js';
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,KAAK,gBAAgB,EAAE,MAAM,cAAc,CAAC;AACtF,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,KAAK,oBAAoB,EAAE,MAAM,aAAa,CAAC;AACvE,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC3E,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,mBAAmB,EACxB,KAAK,0BAA0B,EAC/B,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,eAAe,EACpB,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,EACxB,KAAK,uBAAuB,EAC5B,KAAK,gBAAgB,EACrB,KAAK,6BAA6B,EAClC,KAAK,2BAA2B,EAChC,KAAK,yBAAyB,EAC9B,KAAK,sBAAsB,EAC3B,KAAK,mBAAmB,EACxB,KAAK,8BAA8B,EACnC,KAAK,oBAAoB,GAC1B,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,KAAK,6BAA6B,EAClC,KAAK,eAAe,EACpB,KAAK,qBAAqB,EAC1B,KAAK,0BAA0B,EAC/B,KAAK,2BAA2B,EAChC,KAAK,wBAAwB,EAC7B,KAAK,qBAAqB,EAC1B,KAAK,0BAA0B,EAC/B,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,uBAAuB,EAC5B,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,EACzB,KAAK,uBAAuB,EAC5B,KAAK,sBAAsB,EAC3B,KAAK,2BAA2B,EAChC,KAAK,uBAAuB,GAC7B,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,KAAK,sBAAsB,EAC3B,KAAK,qBAAqB,EAC1B,KAAK,0BAA0B,EAC/B,KAAK,8BAA8B,EACnC,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,GAC1B,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,KAAK,aAAa,EAAE,KAAK,+BAA+B,EAAE,MAAM,gBAAgB,CAAC;AAC1F,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,EACL,KAAK,0BAA0B,EAC/B,KAAK,qCAAqC,EAC1C,KAAK,qCAAqC,EAC1C,KAAK,mCAAmC,EACxC,KAAK,8BAA8B,GACpC,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,KAAK,4BAA4B,EACjC,KAAK,mBAAmB,EACxB,KAAK,4BAA4B,EACjC,KAAK,mBAAmB,GACzB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,KAAK,wBAAwB,EAAE,KAAK,yBAAyB,EAAE,MAAM,eAAe,CAAC;AAC9F,OAAO,EACL,KAAK,sBAAsB,EAC3B,KAAK,yBAAyB,EAC9B,KAAK,+BAA+B,EACpC,KAAK,4BAA4B,EACjC,KAAK,iCAAiC,EACtC,KAAK,0BAA0B,EAC/B,KAAK,0BAA0B,EAC/B,KAAK,4BAA4B,EACjC,KAAK,qBAAqB,GAC3B,MAAM,WAAW,CAAC;AACnB,OAAO,EACL,KAAK,mBAAmB,EACxB,KAAK,wBAAwB,EAC7B,KAAK,6BAA6B,EAClC,KAAK,yBAAyB,GAC/B,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,KAAK,2BAA2B,EAAE,MAAM,cAAc,CAAC;AAChE,OAAO,EACL,KAAK,oBAAoB,EACzB,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,GACtB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,mBAAmB;AACnB,4FAA4F;AAC5F,mBAAmB,IAAI,qBAAqB,GAC7C,MAAM,gBAAgB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,KAAK,gBAAgB,EAAE,MAAM,cAAc,CAAC;AACtF,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,KAAK,oBAAoB,EAAE,MAAM,aAAa,CAAC;AACvE,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC3E,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,mBAAmB,EACxB,KAAK,0BAA0B,EAC/B,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,eAAe,EACpB,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,EACxB,KAAK,uBAAuB,EAC5B,KAAK,gBAAgB,EACrB,KAAK,6BAA6B,EAClC,KAAK,2BAA2B,EAChC,KAAK,yBAAyB,EAC9B,KAAK,sBAAsB,EAC3B,KAAK,mBAAmB,EACxB,KAAK,8BAA8B,EACnC,KAAK,oBAAoB,GAC1B,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,KAAK,6BAA6B,EAClC,KAAK,eAAe,EACpB,KAAK,qBAAqB,EAC1B,KAAK,0BAA0B,EAC/B,KAAK,2BAA2B,EAChC,KAAK,wBAAwB,EAC7B,KAAK,qBAAqB,EAC1B,KAAK,0BAA0B,EAC/B,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,uBAAuB,EAC5B,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,EACzB,KAAK,uBAAuB,EAC5B,KAAK,sBAAsB,EAC3B,KAAK,2BAA2B,EAChC,KAAK,uBAAuB,GAC7B,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,KAAK,sBAAsB,EAC3B,KAAK,qBAAqB,EAC1B,KAAK,0BAA0B,EAC/B,KAAK,8BAA8B,EACnC,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,GAC1B,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,KAAK,aAAa,EAAE,KAAK,+BAA+B,EAAE,MAAM,gBAAgB,CAAC;AAC1F,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,EACL,KAAK,0BAA0B,EAC/B,KAAK,qCAAqC,EAC1C,KAAK,qCAAqC,EAC1C,KAAK,mCAAmC,EACxC,KAAK,8BAA8B,GACpC,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,KAAK,4BAA4B,EACjC,KAAK,mBAAmB,EACxB,KAAK,4BAA4B,EACjC,KAAK,mBAAmB,GACzB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,KAAK,wBAAwB,EAAE,KAAK,yBAAyB,EAAE,MAAM,eAAe,CAAC;AAC9F,OAAO,EACL,KAAK,sBAAsB,EAC3B,KAAK,yBAAyB,EAC9B,KAAK,+BAA+B,EACpC,KAAK,4BAA4B,EACjC,KAAK,iCAAiC,EACtC,KAAK,0BAA0B,EAC/B,KAAK,0BAA0B,EAC/B,KAAK,4BAA4B,EACjC,KAAK,qBAAqB,GAC3B,MAAM,WAAW,CAAC;AACnB,OAAO,EACL,KAAK,mBAAmB,EACxB,KAAK,wBAAwB,EAC7B,KAAK,6BAA6B,EAClC,KAAK,yBAAyB,GAC/B,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,KAAK,2BAA2B,EAAE,MAAM,cAAc,CAAC;AAChE,OAAO,EACL,KAAK,oBAAoB,EACzB,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,gBAAgB,GACtB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,mBAAmB;AACnB,4FAA4F;AAC5F,mBAAmB,IAAI,qBAAqB,GAC7C,MAAM,gBAAgB,CAAC"}
package/dist/search.d.ts CHANGED
@@ -1,6 +1,16 @@
1
- export type OWOXSearchEntityType = 'DATA_MART' | 'DATA_STORAGE' | 'DATA_DESTINATION';
2
- export type OWOXSearchResult = {
3
- entityType: OWOXSearchEntityType;
1
+ export type OWOXSearchEntityType = 'DATA_MART' | 'DATA_STORAGE' | 'DATA_DESTINATION' | 'REPORT';
2
+ export type OWOXSearchReportRef = {
3
+ dataMart: {
4
+ id: string;
5
+ title: string;
6
+ };
7
+ dataDestination: {
8
+ id: string;
9
+ title: string;
10
+ type: string;
11
+ };
12
+ };
13
+ type OWOXSearchResultBase = {
4
14
  entityId: string;
5
15
  title: string;
6
16
  description: string | null;
@@ -8,6 +18,13 @@ export type OWOXSearchResult = {
8
18
  kwScore: number;
9
19
  vecScore: number | null;
10
20
  };
21
+ export type OWOXSearchResult = (OWOXSearchResultBase & {
22
+ entityType: Exclude<OWOXSearchEntityType, 'REPORT'>;
23
+ }) | (OWOXSearchResultBase & {
24
+ entityType: 'REPORT';
25
+ report: OWOXSearchReportRef;
26
+ url: string;
27
+ });
11
28
  export type OWOXSearchOptions = {
12
29
  limit?: number;
13
30
  entityTypes?: OWOXSearchEntityType[];
@@ -1 +1 @@
1
- {"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../src/search.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,oBAAoB,GAAG,WAAW,GAAG,cAAc,GAAG,kBAAkB,CAAC;AAErF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,UAAU,EAAE,oBAAoB,CAAC;IACjC,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,oBAAoB,EAAE,CAAC;IACrC,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB,CAAC;AAEF,KAAK,eAAe,GAAG;IACrB,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;CACtE,CAAC;AAoCF,qBAAa,SAAS;IACR,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,eAAe;IAEjD,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;CAYzF"}
1
+ {"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../src/search.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,oBAAoB,GAAG,WAAW,GAAG,cAAc,GAAG,kBAAkB,GAAG,QAAQ,CAAC;AAEhG,MAAM,MAAM,mBAAmB,GAAG;IAChC,QAAQ,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IACxC,eAAe,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;CAC9D,CAAC;AAEF,KAAK,oBAAoB,GAAG;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GACxB,CAAC,oBAAoB,GAAG;IAAE,UAAU,EAAE,OAAO,CAAC,oBAAoB,EAAE,QAAQ,CAAC,CAAA;CAAE,CAAC,GAChF,CAAC,oBAAoB,GAAG;IAAE,UAAU,EAAE,QAAQ,CAAC;IAAC,MAAM,EAAE,mBAAmB,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC;AAEhG,MAAM,MAAM,iBAAiB,GAAG;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,oBAAoB,EAAE,CAAC;IACrC,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB,CAAC;AAEF,KAAK,eAAe,GAAG;IACrB,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;CACtE,CAAC;AAuDF,qBAAa,SAAS;IACR,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,eAAe;IAEjD,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;CAYzF"}
package/dist/search.js CHANGED
@@ -3,20 +3,32 @@ const SEARCH_ENTITY_TYPES = new Set([
3
3
  'DATA_MART',
4
4
  'DATA_STORAGE',
5
5
  'DATA_DESTINATION',
6
+ 'REPORT',
6
7
  ]);
7
8
  function isRecord(value) {
8
9
  return typeof value === 'object' && value !== null && !Array.isArray(value);
9
10
  }
10
- function isSearchResult(value) {
11
+ function hasStringFields(value, fields) {
12
+ return isRecord(value) && fields.every(field => typeof value[field] === 'string');
13
+ }
14
+ function isReportRef(value) {
11
15
  return (isRecord(value) &&
12
- typeof value.entityType === 'string' &&
13
- SEARCH_ENTITY_TYPES.has(value.entityType) &&
14
- typeof value.entityId === 'string' &&
15
- typeof value.title === 'string' &&
16
- (typeof value.description === 'string' || value.description === null) &&
17
- typeof value.finalScore === 'number' &&
18
- typeof value.kwScore === 'number' &&
19
- (typeof value.vecScore === 'number' || value.vecScore === null));
16
+ hasStringFields(value.dataMart, ['id', 'title']) &&
17
+ hasStringFields(value.dataDestination, ['id', 'title', 'type']));
18
+ }
19
+ function isSearchResult(value) {
20
+ if (!isRecord(value) ||
21
+ typeof value.entityType !== 'string' ||
22
+ !SEARCH_ENTITY_TYPES.has(value.entityType) ||
23
+ typeof value.entityId !== 'string' ||
24
+ typeof value.title !== 'string' ||
25
+ !(typeof value.description === 'string' || value.description === null) ||
26
+ typeof value.finalScore !== 'number' ||
27
+ typeof value.kwScore !== 'number' ||
28
+ !(typeof value.vecScore === 'number' || value.vecScore === null)) {
29
+ return false;
30
+ }
31
+ return (value.entityType !== 'REPORT' || (isReportRef(value.report) && typeof value.url === 'string'));
20
32
  }
21
33
  function parseSearchResults(response) {
22
34
  if (!Array.isArray(response) || !response.every(isSearchResult)) {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@owox/api-client",
3
- "version": "0.35.0-next-20260917211534",
3
+ "version": "0.36.0",
4
4
  "description": "HTTP API client for OWOX Data Marts",
5
5
  "type": "module",
6
6
  "author": "OWOX",