@coveo/platform-client 48.2.0 → 48.3.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 (7) hide show
  1. package/dist/cjs/resources/Projects/Project.js +11 -2
  2. package/dist/cjs/resources/Projects/Project.js.map +1 -1
  3. package/dist/esm/resources/Projects/Project.js +11 -2
  4. package/dist/esm/resources/Projects/Project.js.map +1 -1
  5. package/dist/types/resources/Projects/Project.d.ts +10 -3
  6. package/dist/types/resources/Resources/ResourcesInterfaces.d.ts +1 -0
  7. package/package.json +4 -4
package/dist/cjs/resources/Projects/Project.js CHANGED
@@ -50,11 +50,20 @@ class Project extends Resource_js_1.default {
50
50
  delete(projectId) {
51
51
  return this.api.delete(this.buildPath(`${Project.baseUrl}/${projectId}`));
52
52
  }
53
+ /**
54
+ * Returns resource IDs grouped by resource status, for a given project.
55
+ *
56
+ * @param {string} projectId
57
+ * @returns {Promise<Record<ResourceStatus, Record<ProjectResourceType, string[]>>>} A series of resource IDs grouped by their status and resource type.
58
+ */
59
+ listResourcesByStatus(projectId) {
60
+ return this.api.get(this.buildPath(`${Project.baseUrl}/${projectId}/resources`));
61
+ }
53
62
  /**
54
63
  * Returns a paginated list of resources associated to a project.
55
64
  *
56
- * @param projectId
57
- * @param resourceType
65
+ * @param {string} projectId
66
+ * @param {ProjectResourceType} resourceType
58
67
  * @param {ResourceParams} params
59
68
  * @returns {Promise<PageModel<ResourceModel>>} A paginated list of resources associated to a project.
60
69
  */
package/dist/cjs/resources/Projects/Project.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"Project.js","sourceRoot":"","sources":["../../../../src/resources/Projects/Project.ts"],"names":[],"mappings":";;;AAAA,0EAAmC;AAEnC,yEAAsC;AAItC,MAAqB,OAAQ,SAAQ,qBAAQ;IACzC,MAAM,CAAC,OAAO,GAAG,uBAAuB,oBAAG,CAAC,cAAc,WAAW,CAAC;IAEtE;;;;;OAKG;IACH,IAAI,CAAC,MAA0B;QAC3B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAA0B,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,OAAyB;QAC5B,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAe,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,SAAiB,EAAE,kBAAgC;QACtD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAe,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,SAAS,EAAE,CAAC,EAAE,kBAAkB,CAAC,CAAC;IAC7G,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,SAAiB;QACjB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAe,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC;IACzF,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,SAAiB;QACpB,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;OAOG;IACH,aAAa,CACT,SAAiB,EACjB,YAAiC,EACjC,MAAuB;QAEvB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,SAAS,cAAc,YAAY,EAAE,EAAE,MAAM,CAAC,CACtF,CAAC;IACN,CAAC;;AArEL,0BAsEC"}
1
+ {"version":3,"file":"Project.js","sourceRoot":"","sources":["../../../../src/resources/Projects/Project.ts"],"names":[],"mappings":";;;AAAA,0EAAmC;AAEnC,yEAAsC;AAItC,MAAqB,OAAQ,SAAQ,qBAAQ;IACzC,MAAM,CAAC,OAAO,GAAG,uBAAuB,oBAAG,CAAC,cAAc,WAAW,CAAC;IAEtE;;;;;OAKG;IACH,IAAI,CAAC,MAA0B;QAC3B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAA0B,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,OAAyB;QAC5B,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAe,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,SAAiB,EAAE,kBAAgC;QACtD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAe,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,SAAS,EAAE,CAAC,EAAE,kBAAkB,CAAC,CAAC;IAC7G,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,SAAiB;QACjB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAe,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC;IACzF,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,SAAiB;QACpB,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;OAKG;IACH,qBAAqB,CAAC,SAAiB;QACnC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,SAAS,YAAY,CAAC,CAC9D,CAAC;IACN,CAAC;IAED;;;;;;;OAOG;IACH,aAAa,CACT,SAAiB,EACjB,YAAiC,EACjC,MAAuB;QAEvB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,SAAS,cAAc,YAAY,EAAE,EAAE,MAAM,CAAC,CACtF,CAAC;IACN,CAAC;;AAjFL,0BAkFC"}
package/dist/esm/resources/Projects/Project.js CHANGED
@@ -47,11 +47,20 @@ export default class Project extends Resource {
47
47
  delete(projectId) {
48
48
  return this.api.delete(this.buildPath(`${Project.baseUrl}/${projectId}`));
49
49
  }
50
+ /**
51
+ * Returns resource IDs grouped by resource status, for a given project.
52
+ *
53
+ * @param {string} projectId
54
+ * @returns {Promise<Record<ResourceStatus, Record<ProjectResourceType, string[]>>>} A series of resource IDs grouped by their status and resource type.
55
+ */
56
+ listResourcesByStatus(projectId) {
57
+ return this.api.get(this.buildPath(`${Project.baseUrl}/${projectId}/resources`));
58
+ }
50
59
  /**
51
60
  * Returns a paginated list of resources associated to a project.
52
61
  *
53
- * @param projectId
54
- * @param resourceType
62
+ * @param {string} projectId
63
+ * @param {ProjectResourceType} resourceType
55
64
  * @param {ResourceParams} params
56
65
  * @returns {Promise<PageModel<ResourceModel>>} A paginated list of resources associated to a project.
57
66
  */
package/dist/esm/resources/Projects/Project.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"Project.js","sourceRoot":"","sources":["../../../../src/resources/Projects/Project.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,kBAAkB,CAAC;AAEnC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AAItC,MAAM,CAAC,OAAO,OAAO,OAAQ,SAAQ,QAAQ;IACzC,MAAM,CAAC,OAAO,GAAG,uBAAuB,GAAG,CAAC,cAAc,WAAW,CAAC;IAEtE;;;;;OAKG;IACH,IAAI,CAAC,MAA0B;QAC3B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAA0B,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,OAAyB;QAC5B,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAe,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,SAAiB,EAAE,kBAAgC;QACtD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAe,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,SAAS,EAAE,CAAC,EAAE,kBAAkB,CAAC,CAAC;IAC7G,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,SAAiB;QACjB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAe,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC;IACzF,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,SAAiB;QACpB,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;OAOG;IACH,aAAa,CACT,SAAiB,EACjB,YAAiC,EACjC,MAAuB;QAEvB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,SAAS,cAAc,YAAY,EAAE,EAAE,MAAM,CAAC,CACtF,CAAC;IACN,CAAC"}
1
+ {"version":3,"file":"Project.js","sourceRoot":"","sources":["../../../../src/resources/Projects/Project.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,kBAAkB,CAAC;AAEnC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AAItC,MAAM,CAAC,OAAO,OAAO,OAAQ,SAAQ,QAAQ;IACzC,MAAM,CAAC,OAAO,GAAG,uBAAuB,GAAG,CAAC,cAAc,WAAW,CAAC;IAEtE;;;;;OAKG;IACH,IAAI,CAAC,MAA0B;QAC3B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAA0B,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,OAAyB;QAC5B,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAe,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,SAAiB,EAAE,kBAAgC;QACtD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAe,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,SAAS,EAAE,CAAC,EAAE,kBAAkB,CAAC,CAAC;IAC7G,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,SAAiB;QACjB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAe,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC;IACzF,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,SAAiB;QACpB,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;OAKG;IACH,qBAAqB,CAAC,SAAiB;QACnC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,SAAS,YAAY,CAAC,CAC9D,CAAC;IACN,CAAC;IAED;;;;;;;OAOG;IACH,aAAa,CACT,SAAiB,EACjB,YAAiC,EACjC,MAAuB;QAEvB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,SAAS,cAAc,YAAY,EAAE,EAAE,MAAM,CAAC,CACtF,CAAC;IACN,CAAC"}
package/dist/types/resources/Projects/Project.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { PageModel } from '../BaseInterfaces.js';
2
2
  import Resource from '../Resource.js';
3
- import { ResourceModel, ResourceParams } from '../Resources/index.js';
3
+ import { ResourceModel, ResourceParams, ResourceStatus } from '../Resources/index.js';
4
4
  import { ListProjectParams, ProjectModel, BaseProjectModel, ProjectResourceType } from './ProjectInterfaces.js';
5
5
  export default class Project extends Resource {
6
6
  static baseUrl: string;
@@ -39,11 +39,18 @@ export default class Project extends Resource {
39
39
  * @param {string} projectId
40
40
  */
41
41
  delete(projectId: string): Promise<void>;
42
+ /**
43
+ * Returns resource IDs grouped by resource status, for a given project.
44
+ *
45
+ * @param {string} projectId
46
+ * @returns {Promise<Record<ResourceStatus, Record<ProjectResourceType, string[]>>>} A series of resource IDs grouped by their status and resource type.
47
+ */
48
+ listResourcesByStatus(projectId: string): Promise<Record<ResourceStatus, Record<ProjectResourceType, string[]>>>;
42
49
  /**
43
50
  * Returns a paginated list of resources associated to a project.
44
51
  *
45
- * @param projectId
46
- * @param resourceType
52
+ * @param {string} projectId
53
+ * @param {ProjectResourceType} resourceType
47
54
  * @param {ResourceParams} params
48
55
  * @returns {Promise<PageModel<ResourceModel>>} A paginated list of resources associated to a project.
49
56
  */
package/dist/types/resources/Resources/ResourcesInterfaces.d.ts CHANGED
@@ -1,4 +1,5 @@
1
1
  import { Paginated } from '../BaseInterfaces.js';
2
+ export type ResourceStatus = 'existingResources' | 'deletedResources';
2
3
  export interface ResourceModel {
3
4
  /**
4
5
  * The unique identifier of a resource within a project
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@coveo/platform-client",
3
- "version": "48.2.0",
3
+ "version": "48.3.0",
4
4
  "description": "",
5
5
  "type": "module",
6
6
  "exports": {
@@ -32,8 +32,8 @@
32
32
  "prepare": "husky install"
33
33
  },
34
34
  "devDependencies": {
35
- "@commitlint/cli": "17.7.2",
36
- "@commitlint/config-conventional": "17.7.0",
35
+ "@commitlint/cli": "17.8.0",
36
+ "@commitlint/config-conventional": "17.8.0",
37
37
  "@types/jest": "29.5.5",
38
38
  "@typescript-eslint/eslint-plugin": "6.7.5",
39
39
  "@typescript-eslint/parser": "6.7.5",
@@ -48,7 +48,7 @@
48
48
  "jest": "29.7.0",
49
49
  "jest-fetch-mock": "3.0.3",
50
50
  "jest-runner-eslint": "2.1.2",
51
- "lint-staged": "14.0.1",
51
+ "lint-staged": "15.0.1",
52
52
  "prettier": "3.0.3",
53
53
  "semantic-release": "22.0.5",
54
54
  "ts-jest": "29.1.1",