@coveo/platform-client 40.5.0 → 40.7.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 (9) hide show
  1. package/dist/cjs/resources/Sources/SourcesMetadata/SourcesMetadata.js.map +1 -1
  2. package/dist/cjs/resources/Sources/SourcesMetadata/SourcesMetadataInterfaces.js +7 -0
  3. package/dist/cjs/resources/Sources/SourcesMetadata/SourcesMetadataInterfaces.js.map +1 -1
  4. package/dist/esm/resources/Sources/SourcesMetadata/SourcesMetadata.js.map +1 -1
  5. package/dist/esm/resources/Sources/SourcesMetadata/SourcesMetadataInterfaces.js +6 -1
  6. package/dist/esm/resources/Sources/SourcesMetadata/SourcesMetadataInterfaces.js.map +1 -1
  7. package/dist/types/resources/Sources/SourcesMetadata/SourcesMetadata.d.ts +2 -3
  8. package/dist/types/resources/Sources/SourcesMetadata/SourcesMetadataInterfaces.d.ts +25 -1
  9. package/package.json +1 -1
package/dist/cjs/resources/Sources/SourcesMetadata/SourcesMetadata.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"SourcesMetadata.js","sourceRoot":"","sources":["../../../../../src/resources/Sources/SourcesMetadata/SourcesMetadata.ts"],"names":[],"mappings":";;;;;AAAA,oEAAyC;AACzC,qEAAsC;AAItC,MAAqB,eAAgB,SAAQ,qBAAQ;IACjD,MAAM,CAAC,OAAO,GAAG,uBAAuB,oBAAG,CAAC,cAAc,UAAU,CAAC;IAErE,cAAc,CAAC,QAAgB;QAC3B,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAO,GAAG,eAAe,CAAC,OAAO,IAAI,QAAQ,WAAW,CAAC,CAAC;IAClF,CAAC;IAED,SAAS,CAAC,QAAgB,EAAE,MAAkB;QAC1C,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,GAAG,eAAe,CAAC,OAAO,IAAI,QAAQ,WAAW,EAAE,MAAM,CAAC,CAC5E,CAAC;IACN,CAAC;IAED,eAAe,CAAC,QAAgB;QAC5B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAuB,GAAG,eAAe,CAAC,OAAO,IAAI,QAAQ,kBAAkB,CAAC,CAAC;IACxG,CAAC;;AAfL,kCAgBC"}
1
+ {"version":3,"file":"SourcesMetadata.js","sourceRoot":"","sources":["../../../../../src/resources/Sources/SourcesMetadata/SourcesMetadata.ts"],"names":[],"mappings":";;;;;AAAA,oEAAyC;AACzC,qEAAsC;AAGtC,MAAqB,eAAgB,SAAQ,qBAAQ;IACjD,MAAM,CAAC,OAAO,GAAG,uBAAuB,oBAAG,CAAC,cAAc,UAAU,CAAC;IAErE,cAAc,CAAC,QAAgB;QAC3B,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAO,GAAG,eAAe,CAAC,OAAO,IAAI,QAAQ,WAAW,CAAC,CAAC;IAClF,CAAC;IAED,SAAS,CAAC,QAAgB,EAAE,MAAuB;QAC/C,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,GAAG,eAAe,CAAC,OAAO,IAAI,QAAQ,WAAW,EAAE,MAAM,CAAC,CAC5E,CAAC;IACN,CAAC;IAED,eAAe,CAAC,QAAgB;QAC5B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAuB,GAAG,eAAe,CAAC,OAAO,IAAI,QAAQ,kBAAkB,CAAC,CAAC;IACxG,CAAC;;AAfL,kCAgBC"}
package/dist/cjs/resources/Sources/SourcesMetadata/SourcesMetadataInterfaces.js CHANGED
@@ -1,3 +1,10 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.MetadataIndexedBy = void 0;
4
+ var MetadataIndexedBy;
5
+ (function (MetadataIndexedBy) {
6
+ MetadataIndexedBy["NONE"] = "NONE";
7
+ MetadataIndexedBy["FIELD"] = "FIELD";
8
+ MetadataIndexedBy["MAPPING"] = "MAPPING";
9
+ })(MetadataIndexedBy = exports.MetadataIndexedBy || (exports.MetadataIndexedBy = {}));
3
10
  //# sourceMappingURL=SourcesMetadataInterfaces.js.map
package/dist/cjs/resources/Sources/SourcesMetadata/SourcesMetadataInterfaces.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"SourcesMetadataInterfaces.js","sourceRoot":"","sources":["../../../../../src/resources/Sources/SourcesMetadata/SourcesMetadataInterfaces.ts"],"names":[],"mappings":""}
1
+ {"version":3,"file":"SourcesMetadataInterfaces.js","sourceRoot":"","sources":["../../../../../src/resources/Sources/SourcesMetadata/SourcesMetadataInterfaces.ts"],"names":[],"mappings":";;;AAGA,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IACzB,kCAAa,CAAA;IACb,oCAAe,CAAA;IACf,wCAAmB,CAAA;AACvB,CAAC,EAJW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAI5B"}
package/dist/esm/resources/Sources/SourcesMetadata/SourcesMetadata.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"SourcesMetadata.js","sourceRoot":"","sources":["../../../../../src/resources/Sources/SourcesMetadata/SourcesMetadata.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,mBAAmB,CAAC;AACzC,OAAO,GAAG,MAAM,qBAAqB,CAAC;AAItC,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,QAAQ;IACjD,MAAM,CAAC,OAAO,GAAG,uBAAuB,GAAG,CAAC,cAAc,UAAU,CAAC;IAErE,cAAc,CAAC,QAAgB;QAC3B,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAO,GAAG,eAAe,CAAC,OAAO,IAAI,QAAQ,WAAW,CAAC,CAAC;IAClF,CAAC;IAED,SAAS,CAAC,QAAgB,EAAE,MAAkB;QAC1C,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,GAAG,eAAe,CAAC,OAAO,IAAI,QAAQ,WAAW,EAAE,MAAM,CAAC,CAC5E,CAAC;IACN,CAAC;IAED,eAAe,CAAC,QAAgB;QAC5B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAuB,GAAG,eAAe,CAAC,OAAO,IAAI,QAAQ,kBAAkB,CAAC,CAAC;IACxG,CAAC"}
1
+ {"version":3,"file":"SourcesMetadata.js","sourceRoot":"","sources":["../../../../../src/resources/Sources/SourcesMetadata/SourcesMetadata.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,mBAAmB,CAAC;AACzC,OAAO,GAAG,MAAM,qBAAqB,CAAC;AAGtC,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,QAAQ;IACjD,MAAM,CAAC,OAAO,GAAG,uBAAuB,GAAG,CAAC,cAAc,UAAU,CAAC;IAErE,cAAc,CAAC,QAAgB;QAC3B,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAO,GAAG,eAAe,CAAC,OAAO,IAAI,QAAQ,WAAW,CAAC,CAAC;IAClF,CAAC;IAED,SAAS,CAAC,QAAgB,EAAE,MAAuB;QAC/C,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,GAAG,eAAe,CAAC,OAAO,IAAI,QAAQ,WAAW,EAAE,MAAM,CAAC,CAC5E,CAAC;IACN,CAAC;IAED,eAAe,CAAC,QAAgB;QAC5B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAuB,GAAG,eAAe,CAAC,OAAO,IAAI,QAAQ,kBAAkB,CAAC,CAAC;IACxG,CAAC"}
package/dist/esm/resources/Sources/SourcesMetadata/SourcesMetadataInterfaces.js CHANGED
@@ -1,2 +1,7 @@
1
- export {};
1
+ export var MetadataIndexedBy;
2
+ (function (MetadataIndexedBy) {
3
+ MetadataIndexedBy["NONE"] = "NONE";
4
+ MetadataIndexedBy["FIELD"] = "FIELD";
5
+ MetadataIndexedBy["MAPPING"] = "MAPPING";
6
+ })(MetadataIndexedBy = MetadataIndexedBy || (MetadataIndexedBy = {}));
2
7
  //# sourceMappingURL=SourcesMetadataInterfaces.js.map
package/dist/esm/resources/Sources/SourcesMetadata/SourcesMetadataInterfaces.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"SourcesMetadataInterfaces.js","sourceRoot":"","sources":["../../../../../src/resources/Sources/SourcesMetadata/SourcesMetadataInterfaces.ts"],"names":[],"mappings":""}
1
+ {"version":3,"file":"SourcesMetadataInterfaces.js","sourceRoot":"","sources":["../../../../../src/resources/Sources/SourcesMetadata/SourcesMetadataInterfaces.ts"],"names":[],"mappings":"AAGA,MAAM,CAAN,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IACzB,kCAAa,CAAA;IACb,oCAAe,CAAA;IACf,wCAAmB,CAAA;AACvB,CAAC,EAJW,iBAAiB,GAAjB,iBAAiB,KAAjB,iBAAiB,QAI5B"}
package/dist/types/resources/Sources/SourcesMetadata/SourcesMetadata.d.ts CHANGED
@@ -1,9 +1,8 @@
1
1
  import Resource from '../../Resource.js';
2
- import { Paginated } from '../../BaseInterfaces.js';
3
- import { MetadataPageModel, MetadataReportStatus } from './SourcesMetadataInterfaces.js';
2
+ import { MetadataParams, MetadataPageModel, MetadataReportStatus } from './SourcesMetadataInterfaces.js';
4
3
  export default class SourcesMetadata extends Resource {
5
4
  static baseUrl: string;
6
5
  generateReport(sourceId: string): Promise<void>;
7
- getReport(sourceId: string, params?: Paginated): Promise<MetadataPageModel>;
6
+ getReport(sourceId: string, params?: MetadataParams): Promise<MetadataPageModel>;
8
7
  getReportStatus(sourceId: string): Promise<MetadataReportStatus>;
9
8
  }
package/dist/types/resources/Sources/SourcesMetadata/SourcesMetadataInterfaces.d.ts CHANGED
@@ -1,4 +1,10 @@
1
- import { PageModel } from '../../BaseInterfaces.js';
1
+ import { PageModel, Paginated } from '../../BaseInterfaces.js';
2
+ import { SortingOrder } from '../../Enums.js';
3
+ export declare enum MetadataIndexedBy {
4
+ NONE = "NONE",
5
+ FIELD = "FIELD",
6
+ MAPPING = "MAPPING"
7
+ }
2
8
  export interface MetadataPageModel extends PageModel {
3
9
  items: Metadata[];
4
10
  creationDate: number;
@@ -37,6 +43,10 @@ export interface Metadata {
37
43
  * Whether the origin is mapped or not.
38
44
  */
39
45
  isMapped: boolean;
46
+ /**
47
+ * How is the metadata indexed
48
+ */
49
+ indexedBy: MetadataIndexedBy;
40
50
  }
41
51
  export interface MetadataReportStatus {
42
52
  /**
@@ -53,3 +63,17 @@ export interface MetadataReportStatus {
53
63
  */
54
64
  sampleAvailable: boolean;
55
65
  }
66
+ export interface MetadataParams extends Paginated {
67
+ /**
68
+ * Filters applied to the returned metadata. Only applies to metadata names, not values or origins.
69
+ */
70
+ filter?: string;
71
+ /**
72
+ * Indicate the sorting order, either ASC for ascending or DESC for descending
73
+ */
74
+ order?: SortingOrder;
75
+ /**
76
+ * Field on which the table is sorted
77
+ */
78
+ sortBy?: string;
79
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@coveo/platform-client",
3
- "version": "40.5.0",
3
+ "version": "40.7.0",
4
4
  "description": "",
5
5
  "type": "module",
6
6
  "exports": {