@openfin/workspace-platform 5.5.0 → 5.7.2

package/package.json

@@ -1 +1 @@
-{"name":"@openfin/workspace-platform","description":"An API for creating your own Workspace platform.","contributors":[],"version":"5.5.0","main":"index.ts","scripts":{"deploy":"npm run deploy:npm && npm run deploy:docs","deploy:npm":"cd out && npm publish","deploy:docs":"aws s3 cp --recursive ./docs/ s3://cdn.openfin.co/workspace/api/platform/docs/","deploy:next":"npm run deploy:next:npm && npm run deploy:next:docs","deploy:next:npm":"cd out && npm publish --tag next","deploy:next:docs":"aws s3 cp --recursive ./docs/ s3://cdn.openfin.co/workspace/api/platform/docs/next/","cp:readme":"copyfiles README.md out","cp:package":"node ../common/scripts/cp-package.js","create:rootIndex":"node ../common/scripts/cp-root-index.js","package":"npm run cp:readme && npm run cp:package && npm run create:rootIndex","clean":"rimraf ./out && rimraf ./docs","build:common":"cross-env ENV=prod webpack --mode=production --config ./webpack.common.config.js","build":"npm run clean && npm run build:common && npm run build:docs","build:docs":"typedoc --tsconfig ./tsconfig.json --readme none --disableSources ./src/index.ts","test":"jest --watch --colors","test:ci":"jest","check":"node ../common/scripts/check-npm.js"},"keywords":["client","api","workspace","platform"],"license":"MIT"}
+{"name":"@openfin/workspace-platform","description":"An API for creating your own Workspace platform.","contributors":[],"version":"5.7.2","main":"index.js","scripts":{"promote:docs":"chmod +x ../common/scripts/deploy-latest-docs.sh && ./scripts/deploy-latest-docs.sh $(node ../common/scripts/echo-version.js) /platform","promote":"node ../common/scripts/promote-npm.js && npm run promote:docs","deploy:next":"npm run deploy:next:npm && npm run deploy:next:docs","deploy:next:npm":"cd out && npm publish --tag next","deploy:next:docs":"DIR=/platform node ../common/scripts/archive-docs.js","cp:readme":"copyfiles README.md out","cp:package":"node ../common/scripts/cp-package.js","create:rootIndex":"node ../common/scripts/cp-root-index.js","package":"npm run cp:readme && npm run cp:package && npm run create:rootIndex","clean":"rimraf ./out && rimraf ./docs","build:common":"cross-env ENV=prod webpack --mode=production --config ./webpack.common.config.js","build":"npm run clean && npm run build:common && npm run build:docs","build:docs":"typedoc --tsconfig ./tsconfig.json --readme none --disableSources ./src/index.ts","test":"jest --watch --colors","test:ci":"jest"},"keywords":["client","api","workspace","platform"],"license":"MIT"}

package/search-api/src/shapes.d.ts

@@ -394,6 +394,15 @@ export interface SearchListenerRequest extends SearchRequest {
     onClose(listener: () => void): void;
     /**
      * Remove a registered listener.
+     *
+     * ```ts
+     *
+     * function myListener(request, listener) {
+     *     // Do something
+     * }
+     *
+     * request.removeListener(myListener);
+     * ```
      * @param listener the listener to remove.
      */
     removeListener(listener: () => void): void;
@@ -423,22 +432,55 @@ export interface SearchListenerResponse {
      * there are new or updated search results that have yet to be pushed
      * by the current provider.
      * @experimental
+     *
+     * ```ts
+     * import type { SearchListenerResponse } from './my-shape-definition';
+     * function openStream(response:SearchListenerResponse) {
+     *      response.open();
+     * }
+     *
+     * openStream();
+     * ```
      */
     open(): void;
     /**
      * Close the response stream.
      * This notifies the requester that the current search provider is done sending results.
+     *
+     * ```ts
+     * import type { SearchListenerResponse } from './my-shape-definition';
+     * function closeStream(request:SearchListenerRequest, response:SearchListenerResponse) {
+     *      response.close();
+     * }
+     *
+     * closeStream();
+     * ```
      * @experimental
      */
     close(): void;
     /**
      * Respond to the search request with new or updated search results.
+     *
+     * ```ts
+     *
+     * response.respond([
+     *      { name: 'result-1' },
+     *      { name: 'result-2' },
+     *      { name: 'result-3' },
+     * ]);
+     *
+     * ```
+     *
      * @param results new or updated search results to respond with.
      * @experimental
      */
     respond(results: SearchResult[]): void;
     /**
      * Remove a search result from the list of responded search results.
+     *
+     * ```ts
+     * response.revoke({ name: 'result-1' }, { name: 'result-2' });
+     * ```
      * @param resultKeys the keys of the search results to revoke.
      * @experimental
      */