@coveo/platform-client 35.0.1 → 35.1.0

package/README.md

@@ -226,6 +226,41 @@ const notifyOnError = (message) => (currentOptions) => ({
 platform.withFeatures(notifyOnSuccess('It worked!'), notifyOnError('It failed!')).field.delete('unwanted-field-id');
 ```
 
+### Extending the client
+
+In cases where you want to expand the standard capabilities of the platform client with internal or experimental resources, you can do so within the scope of your own project by extending the `PlatformClient` class.
+
+```ts
+import {API, PlatformClient, PlatformClientOptions, Resource} from '@coveo/platform-client';
+
+class Something extends Resource {
+    static baseUrl = `/rest/organizations/${API.orgPlaceholder}/something`;
+
+    list() {
+        this.api.get(Something.baseUrl);
+    }
+}
+
+const experimentalResources: Array<{key: string; resource: typeof Resource}> = [
+    {key: 'something', resource: Something},
+];
+
+class ExperimentalPlatformClient extends PlatformClient {
+    something: Something;
+
+    constructor(options: PlatformClientOptions) {
+        super(options);
+
+        experimentalResources.forEach(({key, resource}) => {
+            this[key] = new resource(this.API, this.ServerlessAPI);
+        });
+    }
+}
+
+// usage
+ExperimentalPlatformClient.something.list();
+```
+
 ## Contributing
 
 ### Guidelines

package/dist/Entry.js

@@ -1,13 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.API = void 0;
 var tslib_1 = require("tslib");
 var PlatformClient_1 = tslib_1.__importDefault(require("./PlatformClient"));
 tslib_1.__exportStar(require("./PlatformClient"), exports);
 tslib_1.__exportStar(require("./ConfigurationInterfaces"), exports);
-tslib_1.__exportStar(require("./APICore"), exports);
 tslib_1.__exportStar(require("./handlers"), exports);
 tslib_1.__exportStar(require("./resources"), exports);
 tslib_1.__exportStar(require("./utils"), exports);
 tslib_1.__exportStar(require("./Endpoints"), exports);
+var APICore_1 = require("./APICore");
+Object.defineProperty(exports, "API", { enumerable: true, get: function () { return tslib_1.__importDefault(APICore_1).default; } });
 exports.default = PlatformClient_1.default;
 //# sourceMappingURL=Entry.js.map

package/dist/Entry.js.map

@@ -1 +1 @@
-{"version":3,"file":"Entry.js","sourceRoot":"","sources":["../src/Entry.ts"],"names":[],"mappings":";;;AAAA,4EAA8C;AAE9C,2DAAiC;AACjC,oEAA0C;AAC1C,oDAA0B;AAC1B,qDAA2B;AAC3B,sDAA4B;AAC5B,kDAAwB;AACxB,sDAA4B;AAE5B,kBAAe,wBAAc,CAAC"}
+{"version":3,"file":"Entry.js","sourceRoot":"","sources":["../src/Entry.ts"],"names":[],"mappings":";;;;AAAA,4EAA8C;AAE9C,2DAAiC;AACjC,oEAA0C;AAC1C,qDAA2B;AAC3B,sDAA4B;AAC5B,kDAAwB;AACxB,sDAA4B;AAE5B,qCAAyC;AAAjC,uHAAA,OAAO,OAAO;AACtB,kBAAe,wBAAc,CAAC"}

package/dist/definitions/Entry.d.ts

@@ -1,9 +1,9 @@
 import PlatformClient from './PlatformClient';
 export * from './PlatformClient';
 export * from './ConfigurationInterfaces';
-export * from './APICore';
 export * from './handlers';
 export * from './resources';
 export * from './utils';
 export * from './Endpoints';
+export { default as API } from './APICore';
 export default PlatformClient;

package/dist/definitions/resources/Activities/Activities.d.ts

@@ -1,11 +1,11 @@
 import { PageModel } from '../BaseInterfaces';
 import Resource from '../Resource';
-import { ActivityModel, ListActivitiesParams, ActivityFacetModel } from './ActivitiesInterfaces';
+import { ActivityModel, ListActivitiesParams, ListActivitiesFacetsParams, ActivityFacetModel, ActivityListingFilters } from './ActivitiesInterfaces';
 export default class Activity extends Resource {
     static getBaseUrl: () => string;
     get(activityId: string): Promise<ActivityModel>;
     getResourceTypes(): Promise<string[]>;
-    list(params?: ListActivitiesParams): Promise<PageModel<ActivityModel, "items">>;
-    listFacets(params?: ListActivitiesParams): Promise<ActivityFacetModel>;
-    cancelActivity(activityId: string, options: ActivityModel): Promise<Record<string, unknown>>;
+    list(params?: ListActivitiesParams, activityFacet?: ActivityListingFilters): Promise<PageModel<ActivityModel, "items">>;
+    listFacets(params?: ListActivitiesFacetsParams, activityFacet?: ActivityListingFilters): Promise<ActivityFacetModel>;
+    abortActivity(activityId: string, abortActivityModel: ActivityModel): Promise<Record<string, unknown>>;
 }

package/dist/definitions/resources/Activities/ActivitiesInterfaces.d.ts

@@ -26,11 +26,25 @@ export interface ActivityModel {
     isInitialBuild?: boolean;
     showOrgCol?: boolean;
 }
+export interface ListActivitiesFacetsParams {
+    from?: string;
+    to?: string;
+}
 export interface ListActivitiesParams extends Paginated {
-    facetsOnly?: boolean;
+    from?: string;
+    to?: string;
+    page?: number;
+    perPage?: number;
 }
 export interface ActivityListingFilters {
     facet?: FacetOrSortStatus;
+    operations?: string[];
+    organizationIds?: string[];
+    resourceIds?: string[];
+    resourceTypes?: string[];
+    resultTypes?: string[];
+    sections?: string[];
+    states?: string[];
 }
 export interface TriggeredByAttributes {
     type: string;

package/dist/definitions/resources/Activities/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Activities';
+export * from './ActivitiesInterfaces';

package/dist/definitions/resources/index.d.ts

@@ -1,3 +1,5 @@
+export { default as Resource } from './Resource';
+export * from './Activities';
 export * from './ApiKeys';
 export * from './AWS';
 export * from './BaseInterfaces';

package/dist/resources/Activities/Activities.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 var tslib_1 = require("tslib");
 var APICore_1 = tslib_1.__importDefault(require("../../APICore"));
-var Indexes_1 = tslib_1.__importDefault(require("../Indexes/Indexes"));
 var Resource_1 = tslib_1.__importDefault(require("../Resource"));
 var Activity = /** @class */ (function (_super) {
     tslib_1.__extends(Activity, _super);
@@ -15,14 +14,14 @@ var Activity = /** @class */ (function (_super) {
     Activity.prototype.getResourceTypes = function () {
         return this.api.get("".concat(Activity.getBaseUrl(), "/resourcetypes"));
     };
-    Activity.prototype.list = function (params) {
-        return this.api.post(this.buildPath("".concat(Indexes_1.default.baseUrl, "/public"), params));
+    Activity.prototype.list = function (params, activityFacet) {
+        return this.api.post(this.buildPath("".concat(Activity.getBaseUrl(), "/public"), params), activityFacet);
     };
-    Activity.prototype.listFacets = function (params) {
-        return this.api.post(this.buildPath("".concat(Indexes_1.default.baseUrl, "/facets/public"), params));
+    Activity.prototype.listFacets = function (params, activityFacet) {
+        return this.api.post(this.buildPath("".concat(Activity.getBaseUrl(), "/facets/public"), params), activityFacet);
     };
-    Activity.prototype.cancelActivity = function (activityId, options) {
-        return this.api.put("".concat(Activity.getBaseUrl(), "/").concat(activityId), options);
+    Activity.prototype.abortActivity = function (activityId, abortActivityModel) {
+        return this.api.post("".concat(Activity.getBaseUrl(), "/").concat(activityId, "/abort"), abortActivityModel);
     };
     Activity.getBaseUrl = function () { return "/rest/organizations/".concat(APICore_1.default.orgPlaceholder, "/activities"); };
     return Activity;

package/dist/resources/Activities/Activities.js.map

@@ -1 +1 @@
-{"version":3,"file":"Activities.js","sourceRoot":"","sources":["../../../src/resources/Activities/Activities.ts"],"names":[],"mappings":";;;AAAA,kEAAgC;AAEhC,uEAAyC;AACzC,iEAAmC;AAGnC;IAAsC,oCAAQ;IAA9C;;IAqBA,CAAC;IAlBG,sBAAG,GAAH,UAAI,UAAkB;QAClB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAgB,UAAG,QAAQ,CAAC,UAAU,EAAE,cAAI,UAAU,CAAE,CAAC,CAAC;IACjF,CAAC;IACD,mCAAgB,GAAhB;QACI,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAW,UAAG,QAAQ,CAAC,UAAU,EAAE,mBAAgB,CAAC,CAAC;IAC5E,CAAC;IAED,uBAAI,GAAJ,UAAK,MAA6B;QAC9B,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAA2B,IAAI,CAAC,SAAS,CAAC,UAAG,iBAAO,CAAC,OAAO,YAAS,EAAE,MAAM,CAAC,CAAC,CAAC;IACxG,CAAC;IAED,6BAAU,GAAV,UAAW,MAA6B;QACpC,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAqB,IAAI,CAAC,SAAS,CAAC,UAAG,iBAAO,CAAC,OAAO,mBAAgB,EAAE,MAAM,CAAC,CAAC,CAAC;IACzG,CAAC;IAED,iCAAc,GAAd,UAAe,UAAkB,EAAE,OAAsB;QACrD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,UAAG,QAAQ,CAAC,UAAU,EAAE,cAAI,UAAU,CAAE,EAAE,OAAO,CAAC,CAAC;IAC3E,CAAC;IAnBM,mBAAU,GAAG,cAAM,OAAA,8BAAuB,iBAAG,CAAC,cAAc,gBAAa,EAAtD,CAAsD,CAAC;IAoBrF,eAAC;CAAA,AArBD,CAAsC,kBAAQ,GAqB7C;kBArBoB,QAAQ"}
+{"version":3,"file":"Activities.js","sourceRoot":"","sources":["../../../src/resources/Activities/Activities.ts"],"names":[],"mappings":";;;AAAA,kEAAgC;AAEhC,iEAAmC;AASnC;IAAsC,oCAAQ;IAA9C;;IA2BA,CAAC;IAxBG,sBAAG,GAAH,UAAI,UAAkB;QAClB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAgB,UAAG,QAAQ,CAAC,UAAU,EAAE,cAAI,UAAU,CAAE,CAAC,CAAC;IACjF,CAAC;IACD,mCAAgB,GAAhB;QACI,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAW,UAAG,QAAQ,CAAC,UAAU,EAAE,mBAAgB,CAAC,CAAC;IAC5E,CAAC;IAED,uBAAI,GAAJ,UAAK,MAA6B,EAAE,aAAsC;QACtE,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,IAAI,CAAC,SAAS,CAAC,UAAG,QAAQ,CAAC,UAAU,EAAE,YAAS,EAAE,MAAM,CAAC,EACzD,aAAa,CAChB,CAAC;IACN,CAAC;IAED,6BAAU,GAAV,UAAW,MAAmC,EAAE,aAAsC;QAClF,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,IAAI,CAAC,SAAS,CAAC,UAAG,QAAQ,CAAC,UAAU,EAAE,mBAAgB,EAAE,MAAM,CAAC,EAChE,aAAa,CAChB,CAAC;IACN,CAAC;IAED,gCAAa,GAAb,UAAc,UAAkB,EAAE,kBAAiC;QAC/D,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,UAAG,QAAQ,CAAC,UAAU,EAAE,cAAI,UAAU,WAAQ,EAAE,kBAAkB,CAAC,CAAC;IAC7F,CAAC;IAzBM,mBAAU,GAAG,cAAM,OAAA,8BAAuB,iBAAG,CAAC,cAAc,gBAAa,EAAtD,CAAsD,CAAC;IA0BrF,eAAC;CAAA,AA3BD,CAAsC,kBAAQ,GA2B7C;kBA3BoB,QAAQ"}

package/dist/resources/Activities/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./Activities"), exports);
+tslib_1.__exportStar(require("./ActivitiesInterfaces"), exports);
+//# sourceMappingURL=index.js.map

package/dist/resources/Activities/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/Activities/index.ts"],"names":[],"mappings":";;;AAAA,uDAA6B;AAC7B,iEAAuC"}

package/dist/resources/index.js

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.Resource = void 0;
 var tslib_1 = require("tslib");
+var Resource_1 = require("./Resource");
+Object.defineProperty(exports, "Resource", { enumerable: true, get: function () { return tslib_1.__importDefault(Resource_1).default; } });
+tslib_1.__exportStar(require("./Activities"), exports);
 tslib_1.__exportStar(require("./ApiKeys"), exports);
 tslib_1.__exportStar(require("./AWS"), exports);
 tslib_1.__exportStar(require("./BaseInterfaces"), exports);

package/dist/resources/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/index.ts"],"names":[],"mappings":";;;AAAA,oDAA0B;AAC1B,gDAAsB;AACtB,2DAAiC;AACjC,8DAAoC;AACpC,qDAA2B;AAC3B,qDAA2B;AAC3B,yDAA+B;AAC/B,2DAAiC;AACjC,kDAAwB;AACxB,uDAA6B;AAC7B,mDAAyB;AACzB,mDAAyB;AACzB,yDAA+B;AAC/B,mDAAyB;AACzB,oDAA0B;AAC1B,iEAAuC;AACvC,gEAAsC;AACtC,mEAAyC;AACzC,oDAA0B;AAC1B,mDAAyB;AACzB,kDAAwB;AACxB,iDAAuB;AACvB,4DAAkC;AAClC,8DAAoC;AACpC,yDAA+B;AAC/B,0DAAgC;AAChC,+DAAqC;AACrC,sDAA4B;AAC5B,8DAAoC;AACpC,+DAAqC;AACrC,qDAA2B;AAC3B,oDAA0B;AAC1B,8DAAoC;AACpC,iDAAuB;AACvB,0DAAgC;AAChC,mDAAyB;AACzB,6DAAmC;AACnC,wDAA8B;AAC9B,+DAAqC;AACrC,0DAAgC;AAChC,oDAA0B;AAC1B,2DAAiC;AACjC,2DAAiC;AACjC,mDAAyB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/index.ts"],"names":[],"mappings":";;;;AAAA,uCAA+C;AAAvC,6HAAA,OAAO,OAAY;AAE3B,uDAA6B;AAC7B,oDAA0B;AAC1B,gDAAsB;AACtB,2DAAiC;AACjC,8DAAoC;AACpC,qDAA2B;AAC3B,qDAA2B;AAC3B,yDAA+B;AAC/B,2DAAiC;AACjC,kDAAwB;AACxB,uDAA6B;AAC7B,mDAAyB;AACzB,mDAAyB;AACzB,yDAA+B;AAC/B,mDAAyB;AACzB,oDAA0B;AAC1B,iEAAuC;AACvC,gEAAsC;AACtC,mEAAyC;AACzC,oDAA0B;AAC1B,mDAAyB;AACzB,kDAAwB;AACxB,iDAAuB;AACvB,4DAAkC;AAClC,8DAAoC;AACpC,yDAA+B;AAC/B,0DAAgC;AAChC,+DAAqC;AACrC,sDAA4B;AAC5B,8DAAoC;AACpC,+DAAqC;AACrC,qDAA2B;AAC3B,oDAA0B;AAC1B,8DAAoC;AACpC,iDAAuB;AACvB,0DAAgC;AAChC,mDAAyB;AACzB,6DAAmC;AACnC,wDAA8B;AAC9B,+DAAqC;AACrC,0DAAgC;AAChC,oDAA0B;AAC1B,2DAAiC;AACjC,2DAAiC;AACjC,mDAAyB"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@coveo/platform-client",
-    "version": "35.0.1",
+    "version": "35.1.0",
     "description": "",
     "main": "dist/Entry.js",
     "types": "dist/definitions/Entry.d.ts",