@atlaskit/smart-hooks 0.1.5 → 0.1.7

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/smart-hooks
 
+## 0.1.7
+
+### Patch Changes
+
+- Updated dependencies
+
+## 0.1.6
+
+### Patch Changes
+
+- [`8cc2f888c83`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8cc2f888c83) - Upgrade Typescript from `4.3.5` to `4.5.5`
+
 ## 0.1.5
 
 ### Patch Changes

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/smart-hooks",
-	"version": "0.1.5",
+	"version": "0.1.7",
 	"sideEffects": false
 }

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/smart-hooks",
-	"version": "0.1.5",
+	"version": "0.1.7",
 	"sideEffects": false
 }

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/smart-hooks",
-	"version": "0.1.5",
+	"version": "0.1.7",
 	"sideEffects": false
 }

package/example-helpers/mock-urs-data.ts

@@ -38,8 +38,7 @@ export const mockUserSearchData = [
   },
   {
     id: '12312412',
-    name:
-      "Dude with long name and time that doesn't seem to stop and should overflow",
+    name: "Dude with long name and time that doesn't seem to stop and should overflow",
     mentionName:
       "Dudewithlongnamethatdoesn'tseemtostopandshouldoverflowwithtime",
     presence: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/smart-hooks",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   },
@@ -23,7 +23,7 @@
     "@atlaskit/analytics-next": "^8.0.0",
     "@atlaskit/smart-common": "^0.1.0",
     "@atlaskit/ufo": "^0.1.0",
-    "@atlaskit/user-picker": "^9.3.0",
+    "@atlaskit/user-picker": "^10.0.0",
     "@babel/runtime": "^7.0.0",
     "lodash": "^4.17.21",
     "memoize-one": "^6.0.0",
@@ -35,24 +35,24 @@
   },
   "devDependencies": {
     "@atlaskit/analytics-viewer": "^0.4.5",
-    "@atlaskit/button": "^16.3.0",
+    "@atlaskit/button": "^16.5.0",
     "@atlaskit/docs": "*",
     "@atlaskit/smart-hooks": "*",
     "@atlaskit/ssr": "*",
-    "@atlaskit/textfield": "^5.0.5",
+    "@atlaskit/textfield": "^5.3.0",
     "@atlaskit/visual-regression": "*",
     "@atlaskit/webdriver-runner": "*",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
     "@atlassian/ufo": "^0.1.0",
-    "@atlassiansox/analytics-web-client": "^4.7.0",
+    "@atlassiansox/analytics-web-client": "^4.9.0",
     "@storybook/addon-knobs": "^5.3.18",
-    "@testing-library/react": "^8.0.1",
-    "@testing-library/react-hooks": "^1.0.4",
+    "@testing-library/react": "^12.1.5",
+    "@testing-library/react-hooks": "^8.0.1",
     "@welldone-software/why-did-you-render": "^6.2.0",
     "enzyme": "^3.10.0",
     "fetch-mock": "^8.0.0",
     "react-dom": "^16.8.0",
-    "typescript": "4.3.5",
+    "typescript": "4.5.5",
     "wait-for-expect": "^1.2.0"
   },
   "techstack": {
@@ -69,7 +69,8 @@
         "analytics-next"
       ],
       "theming": [
-        "react-context"
+        "react-context",
+        "tokens"
       ],
       "ui-components": [
         "lite-mode"

package/report.api.md

@@ -1,8 +1,18 @@
-## API Report File for "@atlaskit/smart-hooks".
+<!-- API Report Version: 2.3 -->
 
-> Do not edit this file. This report is auto-generated by [API Extractor](https://api-extractor.com/).
+## API Report File for "@atlaskit/smart-hooks"
 
-[Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
+> Do not edit this file. This report is auto-generated using [API Extractor](https://api-extractor.com/).
+> [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
+
+### Table of contents
+
+- [Main Entry Types](#main-entry-types)
+- [Peer Dependencies](#peer-dependencies)
+
+### Main Entry Types
+
+<!--SECTION START: Main Entry Types-->
 
 ```ts
 import { EntityType } from '@atlaskit/smart-common';
@@ -13,14 +23,14 @@ import { UserSearchItem } from '@atlaskit/smart-common';
 import type { UserSearchProductAttributes } from '@atlaskit/smart-common';
 import type { UserSearchQuery } from '@atlaskit/smart-common';
 
-export declare const transformRecommendationsToOptions: (
+// @public (undocumented)
+export const transformRecommendationsToOptions: (
   recommendations: UserSearchItem[],
   intl: IntlShape,
 ) => OptionData[];
 
-export declare const useUserRecommendations: (
-  props: UseUserRecommendationsProps,
-) => {
+// @public (undocumented)
+export const useUserRecommendations: (props: UseUserRecommendationsProps) => {
   recommendations:
     | UserSearchItem[]
     | {
@@ -35,96 +45,40 @@ export declare const useUserRecommendations: (
   error: any;
 };
 
-declare type UseUserRecommendationsProps = {
-  /**
-   * Base url override for downstream APIs.
-   * Note: there is a trend for browsers blocking cookies for cross-site resources.
-   * This prop is added for legacy reasons and will likely be removed in the future.
-   * https://webkit.org/blog/10218/full-third-party-cookie-blocking-and-more/
-   */
+// @public (undocumented)
+type UseUserRecommendationsProps = {
   baseUrl?: string;
-  /**
-   * Context information for analytics. Eg: if the hook was consumed inside a ticket's comment, the childObjectId would be
-   *  the ID of the comment and the ticket would be the objectId. Optional, but please provide if available.
-   */
   childObjectId?: string;
-  /**
-   * The container Id to identify context. e.g. Jira: projectId. Confluence: spaceId. Bitbucket: repositoryId.
-   */
   containerId?: string;
-  /**
-   * Time to debounce the suggestions fetching (in milliseconds). Defaults to 150ms.
-   */
   debounceTimeMs?: number;
-  /**
-   * Identifier for informing the server on what experience the hook is powering.
-   * The server uses the fieldId to determine which model to utilize when
-   * generating suggestions.
-   * All fieldId's will be bucketed into a model that provides generic smart results,
-   * except "assignee", "mentions" which are specifically trained for Jira Assignee and
-   * @Mentions. For specifically trained models, please contact #help-smart-experiences.
-   */
   fieldId: string;
-  /**
-   * Whether to include users in the result set  (@default: true).
-   */
   includeUsers?: boolean;
-  /**
-   * Whether to include groups in the resultset (@default: false).
-   */
   includeGroups?: boolean;
-  /**
-   * Whether to include teams in the resultset  (@default: false).
-   */
   includeTeams?: boolean;
-  /**
-   *  (@default: 25)
-   */
   maxNumberOfResults?: number;
-  /**
-   * An identifier of the closest context object, e.g. issueId, pageId, pullRequestId.
-   * Used for analytics. Optional, but please include if available.
-   */
   objectId?: string;
-  /**
-   * Preload the list of suggested users with an empty-query ('') search as soon as
-   * the hook is used.
-   * WARNING: please consider carefully before deciding to preload your suggestions
-   * as this will increase the load on the recommendations services (has caused HOTs).
-   * Please give #help-smart-experiences a ballpark on the expected request volume.
-   * (@default: false)
-   */
   preload?: boolean;
-  /**
-   * AAID of the user interacting with the component.
-   * If not provided, server will extract principalId from the context header, assuming that the user is logged in
-   * when making the request. (@default: “context”)
-   */
   principalId?: string;
-  /**
-   * Product-specific Attributes - you should pass in the attribute type that matches your current SupportedProduct.
-   * Currently we support additional attributes (BitbucketAttributes) for bitbucket and (ConfluenceAttributes) for Confluence.
-   */
   productAttributes?: UserSearchProductAttributes;
-  /**
-   * Product identifier. If you are an NPF, please ensure your product has been onboarded with
-   * Cross-product user-search @see https://developer.atlassian.com/cloud/cross-product-user-search/
-   * If you are still waiting for CPUS, you can use the `people` productKey in the interim.
-   */
   productKey: string;
-  /**
-   * Pass-through for CPUS. Refer to @see https://developer.atlassian.com/cloud/cross-product-user-search/rest/api-group-search/#api-group-search
-   * for detailed docs on parameters.
-   */
   cpusSearchQuery?: UserSearchQuery;
-  /**
-   * Identifier for the product's tenant, also known as siteId or cloudId.
-   * If product is not tenanted, the convention is to provide the productKey
-   * as the tenantId (e.g. "bitbucket") but this may vary across products.
-   * Check with #help-smart-experiences.
-   */
   tenantId: string;
 };
 
-export {};
+// (No @packageDocumentation comment for this package)
+```
+
+<!--SECTION END: Main Entry Types-->
+
+### Peer Dependencies
+
+<!--SECTION START: Peer Dependencies-->
+
+```json
+{
+  "react": "^16.8.0",
+  "react-intl-next": "npm:react-intl@^5.18.1"
+}
 ```
+
+<!--SECTION END: Peer Dependencies-->

package/tmp/api-report-tmp.d.ts

@@ -0,0 +1,54 @@
+## API Report File for "@atlaskit/smart-hooks"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { EntityType } from '@atlaskit/smart-common';
+import { IntlShape } from 'react-intl-next';
+import { MemoizedFn } from 'memoize-one';
+import { OptionData } from '@atlaskit/user-picker';
+import { UserSearchItem } from '@atlaskit/smart-common';
+import type { UserSearchProductAttributes } from '@atlaskit/smart-common';
+import type { UserSearchQuery } from '@atlaskit/smart-common';
+
+// @public (undocumented)
+export const transformRecommendationsToOptions: (recommendations: UserSearchItem[], intl: IntlShape) => OptionData[];
+
+// @public (undocumented)
+export const useUserRecommendations: (props: UseUserRecommendationsProps) => {
+    recommendations: UserSearchItem[] | {
+        id: string;
+        name: string;
+        entityType: EntityType;
+        avatarUrl: string;
+    }[];
+    triggerSearchFactory: MemoizedFn<() => (query?: string | undefined) => void>;
+    selectUserFactory: MemoizedFn<() => (userId: string) => void>;
+    isLoading: boolean;
+    error: any;
+};
+
+// @public (undocumented)
+type UseUserRecommendationsProps = {
+    baseUrl?: string;
+    childObjectId?: string;
+    containerId?: string;
+    debounceTimeMs?: number;
+    fieldId: string;
+    includeUsers?: boolean;
+    includeGroups?: boolean;
+    includeTeams?: boolean;
+    maxNumberOfResults?: number;
+    objectId?: string;
+    preload?: boolean;
+    principalId?: string;
+    productAttributes?: UserSearchProductAttributes;
+    productKey: string;
+    cpusSearchQuery?: UserSearchQuery;
+    tenantId: string;
+};
+
+// (No @packageDocumentation comment for this package)
+
+```