@atlaskit/smart-hooks 0.2.6 → 0.2.7

package/dist/types-ts4.5/i18n/ru.d.ts

@@ -1,18 +0,0 @@
-/**
- * NOTE:
- *
- * This file is automatically generated by Traduki 2.0.
- * DO NOT CHANGE IT BY HAND or your changes will be lost.
- */
-declare const _default: {
-    'smart-experiences.smart-hooks.external.sourced.from': string;
-    'smart-experiences.smart-hooks.github.provider': string;
-    'smart-experiences.smart-hooks.google.provider': string;
-    'smart-experiences.smart-hooks.guest.lozenge.text': string;
-    'smart-experiences.smart-hooks.guest.lozenge.tooltip.group': string;
-    'smart-experiences.smart-hooks.guest.lozenge.tooltip.user': string;
-    'smart-experiences.smart-hooks.member.lozenge.text': string;
-    'smart-experiences.smart-hooks.microsoft.provider': string;
-    'smart-experiences.smart-hooks.slack.provider': string;
-};
-export default _default;

package/dist/types-ts4.5/i18n/sk.d.ts

@@ -1,8 +0,0 @@
-/**
- * NOTE:
- *
- * This file is automatically generated by i18n-tools.
- * DO NOT CHANGE IT BY HAND or your changes will be lost.
- */
-declare const _default: {};
-export default _default;

package/dist/types-ts4.5/i18n/sv.d.ts

@@ -1,18 +0,0 @@
-/**
- * NOTE:
- *
- * This file is automatically generated by Traduki 2.0.
- * DO NOT CHANGE IT BY HAND or your changes will be lost.
- */
-declare const _default: {
-    'smart-experiences.smart-hooks.external.sourced.from': string;
-    'smart-experiences.smart-hooks.github.provider': string;
-    'smart-experiences.smart-hooks.google.provider': string;
-    'smart-experiences.smart-hooks.guest.lozenge.text': string;
-    'smart-experiences.smart-hooks.guest.lozenge.tooltip.group': string;
-    'smart-experiences.smart-hooks.guest.lozenge.tooltip.user': string;
-    'smart-experiences.smart-hooks.member.lozenge.text': string;
-    'smart-experiences.smart-hooks.microsoft.provider': string;
-    'smart-experiences.smart-hooks.slack.provider': string;
-};
-export default _default;

package/dist/types-ts4.5/i18n/th.d.ts

@@ -1,18 +0,0 @@
-/**
- * NOTE:
- *
- * This file is automatically generated by Traduki 2.0.
- * DO NOT CHANGE IT BY HAND or your changes will be lost.
- */
-declare const _default: {
-    'smart-experiences.smart-hooks.external.sourced.from': string;
-    'smart-experiences.smart-hooks.github.provider': string;
-    'smart-experiences.smart-hooks.google.provider': string;
-    'smart-experiences.smart-hooks.guest.lozenge.text': string;
-    'smart-experiences.smart-hooks.guest.lozenge.tooltip.group': string;
-    'smart-experiences.smart-hooks.guest.lozenge.tooltip.user': string;
-    'smart-experiences.smart-hooks.member.lozenge.text': string;
-    'smart-experiences.smart-hooks.microsoft.provider': string;
-    'smart-experiences.smart-hooks.slack.provider': string;
-};
-export default _default;

package/dist/types-ts4.5/i18n/tr.d.ts

@@ -1,18 +0,0 @@
-/**
- * NOTE:
- *
- * This file is automatically generated by Traduki 2.0.
- * DO NOT CHANGE IT BY HAND or your changes will be lost.
- */
-declare const _default: {
-    'smart-experiences.smart-hooks.external.sourced.from': string;
-    'smart-experiences.smart-hooks.github.provider': string;
-    'smart-experiences.smart-hooks.google.provider': string;
-    'smart-experiences.smart-hooks.guest.lozenge.text': string;
-    'smart-experiences.smart-hooks.guest.lozenge.tooltip.group': string;
-    'smart-experiences.smart-hooks.guest.lozenge.tooltip.user': string;
-    'smart-experiences.smart-hooks.member.lozenge.text': string;
-    'smart-experiences.smart-hooks.microsoft.provider': string;
-    'smart-experiences.smart-hooks.slack.provider': string;
-};
-export default _default;

package/dist/types-ts4.5/i18n/uk.d.ts

@@ -1,18 +0,0 @@
-/**
- * NOTE:
- *
- * This file is automatically generated by Traduki 2.0.
- * DO NOT CHANGE IT BY HAND or your changes will be lost.
- */
-declare const _default: {
-    'smart-experiences.smart-hooks.external.sourced.from': string;
-    'smart-experiences.smart-hooks.github.provider': string;
-    'smart-experiences.smart-hooks.google.provider': string;
-    'smart-experiences.smart-hooks.guest.lozenge.text': string;
-    'smart-experiences.smart-hooks.guest.lozenge.tooltip.group': string;
-    'smart-experiences.smart-hooks.guest.lozenge.tooltip.user': string;
-    'smart-experiences.smart-hooks.member.lozenge.text': string;
-    'smart-experiences.smart-hooks.microsoft.provider': string;
-    'smart-experiences.smart-hooks.slack.provider': string;
-};
-export default _default;

package/dist/types-ts4.5/i18n/vi.d.ts

@@ -1,18 +0,0 @@
-/**
- * NOTE:
- *
- * This file is automatically generated by Traduki 2.0.
- * DO NOT CHANGE IT BY HAND or your changes will be lost.
- */
-declare const _default: {
-    'smart-experiences.smart-hooks.external.sourced.from': string;
-    'smart-experiences.smart-hooks.github.provider': string;
-    'smart-experiences.smart-hooks.google.provider': string;
-    'smart-experiences.smart-hooks.guest.lozenge.text': string;
-    'smart-experiences.smart-hooks.guest.lozenge.tooltip.group': string;
-    'smart-experiences.smart-hooks.guest.lozenge.tooltip.user': string;
-    'smart-experiences.smart-hooks.member.lozenge.text': string;
-    'smart-experiences.smart-hooks.microsoft.provider': string;
-    'smart-experiences.smart-hooks.slack.provider': string;
-};
-export default _default;

package/dist/types-ts4.5/i18n/zh.d.ts

@@ -1,18 +0,0 @@
-/**
- * NOTE:
- *
- * This file is automatically generated by Traduki 2.0.
- * DO NOT CHANGE IT BY HAND or your changes will be lost.
- */
-declare const _default: {
-    'smart-experiences.smart-hooks.external.sourced.from': string;
-    'smart-experiences.smart-hooks.github.provider': string;
-    'smart-experiences.smart-hooks.google.provider': string;
-    'smart-experiences.smart-hooks.guest.lozenge.text': string;
-    'smart-experiences.smart-hooks.guest.lozenge.tooltip.group': string;
-    'smart-experiences.smart-hooks.guest.lozenge.tooltip.user': string;
-    'smart-experiences.smart-hooks.member.lozenge.text': string;
-    'smart-experiences.smart-hooks.microsoft.provider': string;
-    'smart-experiences.smart-hooks.slack.provider': string;
-};
-export default _default;

package/dist/types-ts4.5/i18n/zh_TW.d.ts

@@ -1,18 +0,0 @@
-/**
- * NOTE:
- *
- * This file is automatically generated by Traduki 2.0.
- * DO NOT CHANGE IT BY HAND or your changes will be lost.
- */
-declare const _default: {
-    'smart-experiences.smart-hooks.external.sourced.from': string;
-    'smart-experiences.smart-hooks.github.provider': string;
-    'smart-experiences.smart-hooks.google.provider': string;
-    'smart-experiences.smart-hooks.guest.lozenge.text': string;
-    'smart-experiences.smart-hooks.guest.lozenge.tooltip.group': string;
-    'smart-experiences.smart-hooks.guest.lozenge.tooltip.user': string;
-    'smart-experiences.smart-hooks.member.lozenge.text': string;
-    'smart-experiences.smart-hooks.microsoft.provider': string;
-    'smart-experiences.smart-hooks.slack.provider': string;
-};
-export default _default;

package/dist/types-ts4.5/index.d.ts

@@ -1,3 +0,0 @@
-import useUserRecommendations from './services/use-user-recommendations';
-import transformRecommendationsToOptions from './utils/transform-recommendations-to-options';
-export { useUserRecommendations, transformRecommendationsToOptions };

package/dist/types-ts4.5/messages.d.ts

@@ -1,47 +0,0 @@
-export declare const messages: {
-    externalUserSourcesHeading: {
-        id: string;
-        defaultMessage: string;
-        description: string;
-    };
-    slackProvider: {
-        id: string;
-        defaultMessage: string;
-        description: string;
-    };
-    googleProvider: {
-        id: string;
-        defaultMessage: string;
-        description: string;
-    };
-    microsoftProvider: {
-        id: string;
-        defaultMessage: string;
-        description: string;
-    };
-    gitHubProvider: {
-        id: string;
-        defaultMessage: string;
-        description: string;
-    };
-    memberLozengeText: {
-        id: string;
-        defaultMessage: string;
-        description: string;
-    };
-    guestLozengeText: {
-        id: string;
-        defaultMessage: string;
-        description: string;
-    };
-    guestUserLozengeTooltip: {
-        id: string;
-        defaultMessage: string;
-        description: string;
-    };
-    guestGroupLozengeTooltip: {
-        id: string;
-        defaultMessage: string;
-        description: string;
-    };
-};

package/dist/types-ts4.5/services/use-function-usage-tracking/index.d.ts

@@ -1,5 +0,0 @@
-declare function useFunctionUsageTracking<InputFunctionType extends (...any: any) => any>(trackedFunction: InputFunctionType): {
-    isUsed: boolean;
-    trackingFunction: import("memoize-one").MemoizedFn<() => InputFunctionType>;
-};
-export default useFunctionUsageTracking;

package/dist/types-ts4.5/services/use-user-recommendations/analytics.d.ts

@@ -1,20 +0,0 @@
-import { AnalyticsEventPayload, CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
-import { UserSearchItem } from '@atlaskit/smart-common';
-import { UseUserRecommendationsProps } from '../../types';
-export declare const findUserPosition: (loadedUsers: UserSearchItem[], userId: string) => number;
-export declare const createDefaultAttributes: (props: UseUserRecommendationsProps, renderId: string, sessionId: string, query: string) => {
-    context: string;
-    childObjectId: string | undefined;
-    containerId: string | undefined;
-    includeTeams: boolean | undefined;
-    maxNumberOfResults: number | undefined;
-    objectId: string | undefined;
-    preload: boolean | undefined;
-    principalId: string | undefined;
-    productKey: string;
-    queryLength: number;
-    renderId: string;
-    sessionId: string;
-    tenantId: string;
-};
-export declare const fireUserSelectedEvent: (createAnalyticsEvent: CreateUIAnalyticsEvent, payloadAttributes: AnalyticsEventPayload) => import("@atlaskit/analytics-next").UIAnalyticsEvent;

package/dist/types-ts4.5/services/use-user-recommendations/index.d.ts

@@ -1,21 +0,0 @@
-import { EntityType, UserSearchItem } from '@atlaskit/smart-common';
-import type { UseUserRecommendationsProps } from '../../types';
-export declare const instrumentFailureOption: {
-    id: string;
-    name: string;
-    entityType: EntityType;
-    avatarUrl: string;
-}[];
-declare const useUserRecommendations: (props: UseUserRecommendationsProps) => {
-    recommendations: UserSearchItem[] | {
-        id: string;
-        name: string;
-        entityType: EntityType;
-        avatarUrl: string;
-    }[];
-    triggerSearchFactory: import("memoize-one").MemoizedFn<() => (query?: string) => void>;
-    selectUserFactory: import("memoize-one").MemoizedFn<() => (userId: string) => void>;
-    isLoading: boolean;
-    error: any;
-};
-export default useUserRecommendations;

package/dist/types-ts4.5/services/use-user-recommendations/ufoExperiences.d.ts

@@ -1,2 +0,0 @@
-import { ConcurrentExperience } from '@atlaskit/ufo';
-export declare const UsersFetchedUfoExperience: ConcurrentExperience;

package/dist/types-ts4.5/types.d.ts

@@ -1,91 +0,0 @@
-import type { UserSearchProductAttributes, UserSearchQuery } from '@atlaskit/smart-common';
-export 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/
-     */
-    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;
-};

package/dist/types-ts4.5/utils/transform-recommendations-to-options/index.d.ts

@@ -1,5 +0,0 @@
-import { IntlShape } from 'react-intl-next';
-import { UserSearchItem } from '@atlaskit/smart-common';
-import { OptionData } from '@atlaskit/user-picker';
-declare const _default: (recommendations: UserSearchItem[], intl: IntlShape) => OptionData[];
-export default _default;

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

@@ -1,54 +0,0 @@
-## 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) => 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)
-
-```