@atlaskit/link-create 0.4.3 → 0.4.4

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/link-create
 
+## 0.4.4
+
+### Patch Changes
+
+- [`9d00501a414`](https://bitbucket.org/atlassian/atlassian-frontend/commits/9d00501a414) - Ensure legacy types are published for TS 4.5-4.8
+
 ## 0.4.3
 
 ### Patch Changes

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/link-create",
-	"version": "0.4.3",
+	"version": "0.4.4",
 	"sideEffects": false
 }

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/link-create",
-	"version": "0.4.3",
+	"version": "0.4.4",
 	"sideEffects": false
 }

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/link-create",
-	"version": "0.4.3",
+	"version": "0.4.4",
 	"sideEffects": false
 }

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

@@ -0,0 +1,3 @@
+export declare const ANALYTICS_CHANNEL = "media";
+export declare const COMPONENT_NAME = "linkCreate";
+export declare const CREATE_FORM_MAX_WIDTH_IN_PX = "600";

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

@@ -0,0 +1,88 @@
+import { ReactNode } from 'react';
+/** Map of field names to a list of validators for that field */
+export type ValidatorMap = Record<string, Validator[]>;
+export type Validator = {
+    /** Return true when the given input is valid */
+    isValid: (val: unknown) => boolean;
+    /** An error message is used to tell a user that the field input is invalid. For example, an error message could be 'Invalid username, needs to be more than 4 characters'. */
+    errorMessage: string;
+};
+export interface Group {
+    /**
+     * A label to display for the Group
+     */
+    label: string;
+    /**
+     * An icon to display for the Group
+     */
+    icon: string;
+    /**
+     * A unique key for the Group
+     */
+    key: string;
+}
+export interface LinkCreatePlugin {
+    /**
+     * The Group that this plugin entity belongs to
+     */
+    group: Group;
+    /**
+     * A label to display for the plugin entity
+     */
+    label: string;
+    /**
+     * An icon to display for the plugin entity
+     */
+    icon: string;
+    /**
+     * A unique key for the plugin entity
+     */
+    key: string;
+    /**
+     * A renderer function to render the form
+     */
+    form: ReactNode;
+}
+export interface LinkCreateProps {
+    /**
+     * A `testId` prop is provided for specified elements, which is a unique
+     * string that appears as a data attribute `data-testid` in the rendered code,
+     * serving as a hook for automated tests */
+    testId?: string;
+    plugins: LinkCreatePlugin[];
+    /**
+     * The initial group key for create. If this is provided, it will jump
+     * directly to the entity selection screen
+     */
+    groupKey?: string;
+    /**
+     * The initial entity name for create. If this is provided, it will jump
+     * directly to the entity creation form.
+     * Note: it will be non-optional for now and can move to optional when we have
+     * the meta creation flow built.
+     */
+    entityKey: string;
+    /**
+     * This callback for when the resource has been successfully created.
+     */
+    onCreate?: (url: string) => void;
+    /**
+     * This callback for any errors
+     */
+    onFailure?: (error: unknown) => void;
+    /**
+     * This callback for when the form was manually discarded by user
+     */
+    onCancel?: () => void;
+    /**
+     * This value controls whether the Create Modal should be active or hidden
+     * Default: false
+     */
+    active?: boolean;
+    /**
+     * This value tells where the linkCreate was triggered from. And it's for
+     * analytic purpose only.
+     * Default: unknown
+     */
+    triggeredFrom?: string;
+}

package/dist/types-ts4.5/common/utils/analytics/analytics.codegen.d.ts

@@ -0,0 +1,48 @@
+/**
+ * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
+ *
+ * Generates Typescript types for analytics events from analytics.spec.yaml
+ *
+ * @codegen <<SignedSource::6d7803f5c035dc3cde1be03caa91eb04>>
+ * @codegenCommand yarn workspace @atlaskit/link-create run codegen-analytics
+ */
+export type PackageMetaDataType = {
+    packageName: '@atlaskit/link-create';
+    packageVersion: string;
+    source: 'linkCreate';
+    componentName: 'linkCreate';
+};
+export type LinkCreateAnalyticsContextType = {
+    triggeredFrom: string;
+    objectName: string;
+    appearance: 'modal' | 'popup';
+};
+export type LinkCreateScreenViewedAttributesType = {};
+export type ButtonClickedCreateAttributesType = {};
+export type ButtonClickedCancelAttributesType = {};
+export type LinkCreateScreenClosedAttributesType = {};
+export type LinkCreateUnhandledErrorCaughtAttributesType = {
+    browserInfo: string;
+    error: string;
+    componentStack: string | null;
+};
+export type ObjectCreatedLinkCreateAttributesType = {
+    objectId: string;
+    objectType: string;
+};
+type AnalyticsEventAttributes = {
+    'screen.linkCreateScreen.viewed': LinkCreateScreenViewedAttributesType;
+    'ui.button.clicked.create': ButtonClickedCreateAttributesType;
+    'ui.button.clicked.cancel': ButtonClickedCancelAttributesType;
+    'screen.linkCreateScreen.closed': LinkCreateScreenClosedAttributesType;
+    'operational.linkCreate.unhandledErrorCaught': LinkCreateUnhandledErrorCaughtAttributesType;
+    'track.object.created.linkCreate': ObjectCreatedLinkCreateAttributesType;
+};
+declare function createEventPayload<K extends keyof AnalyticsEventAttributes>(eventKey: K, attributes: AnalyticsEventAttributes[K]): {
+    eventType: string;
+    actionSubject: string;
+    action: string;
+    actionSubjectId: string;
+    attributes: AnalyticsEventAttributes[K];
+};
+export default createEventPayload;

package/dist/types-ts4.5/common/utils/analytics/context.d.ts

@@ -0,0 +1,29 @@
+import React from 'react';
+import { LinkCreateProps } from '../../types';
+import { LinkCreateAnalyticsContextType } from './analytics.codegen';
+export type TrackAttribute = <K extends keyof LinkCreateAnalyticsContextType>(attribute: K, value: LinkCreateAnalyticsContextType[K]) => void;
+interface AnalyticsContextType {
+    /**
+     * Update a single attribute in the analytics context
+     */
+    trackAttribute: TrackAttribute;
+    /**
+     * Update a set of attributes in the analytics context
+     */
+    trackAttributes: (attributes: Partial<LinkCreateAnalyticsContextType>) => void;
+    /**
+     * Retrieve the current set of attributes
+     * Can be used by components to derive/compute new attributes for specific events
+     */
+    getAttributes: () => LinkCreateAnalyticsContextType;
+}
+/**
+ * Hook that exposes the context-level attribute getters and setters.
+ */
+export declare const useLinkCreateAnalytics: () => AnalyticsContextType;
+/**
+ * Wraps a component with the analytics context + listener to update events with contextual-level attributes.
+ * Should be implemented once at the root of the link create.
+ */
+export declare function withLinkCreateAnalyticsContext<P extends Pick<LinkCreateProps, 'groupKey' | 'entityKey' | 'triggeredFrom'>>(WrappedComponent: React.ComponentType<P>): React.ComponentType<P>;
+export {};

package/dist/types-ts4.5/common/utils/analytics/index.d.ts

@@ -0,0 +1 @@
+export { useLinkCreateAnalytics, withLinkCreateAnalyticsContext, } from './context';

package/dist/types-ts4.5/controllers/callback-context/index.d.ts

@@ -0,0 +1 @@
+export { LinkCreateCallbackProvider, useLinkCreateCallback } from './main';

package/dist/types-ts4.5/controllers/callback-context/main.d.ts

@@ -0,0 +1,22 @@
+import React from 'react';
+interface LinkCreateCallbackProviderProps {
+    /**
+     * This callback for when the resource has been successfully created.
+     */
+    onCreate?: (result: {
+        url: string;
+        objectId: string;
+        objectType: string;
+    }) => void;
+    /**
+     * This callback for any errors
+     */
+    onFailure?: (errorMessage: string) => void;
+    /**
+     * This callback for when the form was manually discarded by user
+     */
+    onCancel?: () => void;
+}
+declare const LinkCreateCallbackProvider: React.FC<LinkCreateCallbackProviderProps>;
+declare const useLinkCreateCallback: () => LinkCreateCallbackProviderProps;
+export { LinkCreateCallbackProvider, useLinkCreateCallback };

package/dist/types-ts4.5/controllers/form-context/index.d.ts

@@ -0,0 +1 @@
+export { FormContextProvider, useFormContext } from './main';

package/dist/types-ts4.5/controllers/form-context/main.d.ts

@@ -0,0 +1,12 @@
+import React from 'react';
+import { Validator, ValidatorMap } from '../../common/types';
+interface FormContextType {
+    assignValidator: (name: string, validators: Validator[]) => void;
+    getValidators: () => ValidatorMap;
+    setFormErrorMessage: (errorMessage?: string) => void;
+    formErrorMessage?: string;
+}
+export declare const FormContext: React.Context<FormContextType>;
+declare const FormContextProvider: React.FC<{}>;
+declare const useFormContext: () => FormContextType;
+export { FormContextProvider, useFormContext };

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

@@ -0,0 +1,7 @@
+export type { Option } from './ui/types';
+export type { CreateFormProps } from './ui/index';
+export type { LinkCreateProps, LinkCreatePlugin } from './common/types';
+export { default, TextField, CreateForm, AsyncSelect } from './ui/index';
+export { useLinkCreateCallback, LinkCreateCallbackProvider, } from './controllers/callback-context';
+export { FormContextProvider, useFormContext, } from './controllers/form-context';
+export type { Validator, ValidatorMap } from './common/types';

package/dist/types-ts4.5/ui/create-form/async-select/index.d.ts

@@ -0,0 +1 @@
+export { AsyncSelect } from './main';

package/dist/types-ts4.5/ui/create-form/async-select/main.d.ts

@@ -0,0 +1,10 @@
+import { jsx } from '@emotion/react';
+import { OptionType } from '@atlaskit/select';
+import { AsyncSelectProps } from './types';
+/**
+ * An async select utilising the Atlaskit AsyncSelect and Field objects from `@atlaskit/form`.
+ * Validation is handled by the form as it is on form submission. Any errors returned by
+ * the handleSubmit function passed to the form <Form> that have a key matching the `name`
+ * of this text field are shown above the field.
+ */
+export declare function AsyncSelect<T = OptionType>({ label, name, validationHelpText, isRequired, testId, validators, ...rest }: AsyncSelectProps<T>): jsx.JSX.Element;

package/dist/types-ts4.5/ui/create-form/async-select/types.d.ts

@@ -0,0 +1,18 @@
+import { AsyncSelectProps as AKAsyncSelectProps, OptionType } from '@atlaskit/select';
+import { Validator } from '../../../common/types';
+export type AsyncSelectProps<T = OptionType> = AKAsyncSelectProps<T> & {
+    /** Name passed to the <Field>.*/
+    name: string;
+    /** This should be properly internationalization-ed */
+    label: string;
+    /**
+     * Optional text below the textfield explaining any requirements for a valid value.
+     * eg. "Must be 4 or more letters"
+     */
+    validationHelpText?: string;
+    testId?: string;
+    /** Will display a red astrix next to the field title if true */
+    isRequired?: boolean;
+    /** Validators for this field */
+    validators?: Validator[];
+};

package/dist/types-ts4.5/ui/create-form/index.d.ts

@@ -0,0 +1,3 @@
+export { CreateForm } from './main';
+export { AsyncSelect } from './async-select';
+export { TextField } from './textfield';

package/dist/types-ts4.5/ui/create-form/main.d.ts

@@ -0,0 +1,10 @@
+/** @jsx jsx */
+import { ReactNode } from 'react';
+import { jsx } from '@emotion/react';
+export interface CreateFormProps<FormData> {
+    children: ReactNode;
+    testId?: string;
+    onCancel?: () => void;
+    onSubmit: (data: FormData) => void;
+}
+export declare const CreateForm: <FormData_1 extends Record<string, any> = {}>({ children, testId, onCancel, onSubmit, }: CreateFormProps<FormData_1>) => jsx.JSX.Element;

package/dist/types-ts4.5/ui/create-form/messages.d.ts

@@ -0,0 +1,12 @@
+export declare const messages: {
+    cancel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    create: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};

package/dist/types-ts4.5/ui/create-form/textfield/index.d.ts

@@ -0,0 +1 @@
+export { TextField } from './main';

package/dist/types-ts4.5/ui/create-form/textfield/main.d.ts

@@ -0,0 +1,9 @@
+import { jsx } from '@emotion/react';
+import { TextFieldProps } from './types';
+/**
+ * A text field utilising the Atlaskit Textfield and Field objects from `@atlaskit/form`.
+ * Validation is handled by the form as it is on form submission. Any errors returned by
+ * the handleSubmit function passed to the form <Form> that have a key matching the `name`
+ * of this text field are shown above the field.
+ */
+export declare function TextField({ label, name, validationHelpText, validators, ...restProps }: TextFieldProps): jsx.JSX.Element;

package/dist/types-ts4.5/ui/create-form/textfield/types.d.ts

@@ -0,0 +1,14 @@
+import { TextFieldProps as AKTextFieldProps } from '@atlaskit/textfield';
+import { Validator } from '../../../common/types';
+export type TextFieldProps = Omit<AKTextFieldProps, 'name' | 'isRequired'> & {
+    /** Name passed to the <Field>.*/
+    name: string;
+    label?: string;
+    /**
+     * Optional text below the textfield explaining any requirements for a valid value.
+     * eg. "Must be 4 or more letters"
+     */
+    validationHelpText?: string;
+    /** Validators for this field */
+    validators?: Validator[];
+};

package/dist/types-ts4.5/ui/create-form/types.d.ts

@@ -0,0 +1,6 @@
+export type Validator = {
+    /** Return true when the given input is valid */
+    isValid: (val: unknown) => boolean;
+    /** An error message is used to tell a user that the field input is invalid. For example, an error message could be 'Invalid username, needs to be more than 4 characters'. */
+    errorMessage: string;
+};

package/dist/types-ts4.5/ui/create-form/utils/index.d.ts

@@ -0,0 +1,13 @@
+import { ValidatorMap } from '../../../common/types';
+/** Map of field names to errors for that field (or undefined if no error for that field) */
+export type ValidatorResults = {
+    [name: string]: string | undefined;
+};
+/**
+ * Returns an object where the keys are names of form fields, and values are a string if the field
+ * has an error, or undefined if the field is valid.
+ */
+export declare function validateFormData({ data, validators, }: {
+    data: Record<string, unknown>;
+    validators: ValidatorMap;
+}): ValidatorResults;

package/dist/types-ts4.5/ui/error-boundary/error-boundary-base/index.d.ts

@@ -0,0 +1,18 @@
+import React, { Component, ReactNode } from 'react';
+export type ErrorBoundaryErrorInfo = {
+    componentStack: string;
+};
+type BaseErrorBoundaryState = {
+    hasError: boolean;
+};
+interface BaseErrorBoundaryProps {
+    children: ReactNode;
+    ErrorComponent?: React.ComponentType;
+    onError?: (error: Error, info?: ErrorBoundaryErrorInfo) => void;
+}
+export declare class BaseErrorBoundary extends Component<BaseErrorBoundaryProps, BaseErrorBoundaryState> {
+    constructor(props: BaseErrorBoundaryProps);
+    componentDidCatch(error: Error, info?: ErrorBoundaryErrorInfo): void;
+    render(): React.ReactNode;
+}
+export {};

package/dist/types-ts4.5/ui/error-boundary/error-boundary-ui/error-svg/index.d.ts

@@ -0,0 +1,4 @@
+/** @jsx jsx */
+import { jsx } from '@emotion/react';
+declare const ErrorSVG: () => jsx.JSX.Element;
+export default ErrorSVG;

package/dist/types-ts4.5/ui/error-boundary/error-boundary-ui/index.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+export declare const CONTACT_SUPPORT_LINK = "https://support.atlassian.com/contact/";
+export declare const ErrorBoundaryUI: () => JSX.Element;

package/dist/types-ts4.5/ui/error-boundary/error-boundary-ui/messages.d.ts

@@ -0,0 +1,13 @@
+declare const _default: {
+    heading: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    description: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};
+export default _default;

package/dist/types-ts4.5/ui/error-boundary/index.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const ErrorBoundary: React.FC<{}>;

package/dist/types-ts4.5/ui/group-selection/index.d.ts

@@ -0,0 +1,4 @@
+/** @jsx jsx */
+import { jsx } from '@emotion/react';
+import { GroupSelectProps } from './types';
+export default function GroupSelect({ testId, groups }: GroupSelectProps): jsx.JSX.Element;

package/dist/types-ts4.5/ui/group-selection/types.d.ts

@@ -0,0 +1,12 @@
+import { Group } from '../../common/types';
+export interface GroupSelectProps {
+    /**
+     * A `testId` prop is provided for specified elements, which is a unique
+     * string that appears as a data attribute `data-testid` in the rendered code,
+     * serving as a hook for automated tests */
+    testId?: string;
+    /**
+     * Available groups to display
+     */
+    groups: Group[];
+}

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

@@ -0,0 +1,5 @@
+export { default } from './main';
+export { TextField } from './create-form/textfield';
+export { CreateForm } from './create-form/main';
+export type { CreateFormProps } from './create-form/main';
+export { AsyncSelect } from './create-form/async-select';

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

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+import { jsx } from '@emotion/react';
+import { LinkCreateProps } from '../common/types';
+import { PackageMetaDataType } from '../common/utils/analytics/analytics.codegen';
+export declare const PACKAGE_DATA: PackageMetaDataType;
+declare const ComposedLinkCreate: import("react").MemoExoticComponent<(props: LinkCreateProps) => jsx.JSX.Element>;
+export default ComposedLinkCreate;

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

@@ -0,0 +1,7 @@
+export declare const messages: {
+    heading: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};

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

@@ -0,0 +1,6 @@
+export interface Option {
+    /** html `value` attribute to differentiate options */
+    value: string;
+    /** This should be properly internationalization-ed */
+    label: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/link-create",
-  "version": "0.4.3",
+  "version": "0.4.4",
   "description": "The driver component of meta creation flow",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -62,10 +62,10 @@
     "@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.0",
     "@atlassian/link-create-confluence": "^5.0.0",
     "@atlassian/link-create-presets": "^3.0.0",
-    "@atlassian/link-picker-atlassian-plugin": "^30.0.0",
-    "@atlassian/link-picker-plugins": "^20.0.0",
+    "@atlassian/link-picker-atlassian-plugin": "^30.1.0",
+    "@atlassian/link-picker-plugins": "^20.1.0",
     "@atlassian/recent-work-client": "^1.8.0",
-    "@atlassian/search-client": "^0.8.0",
+    "@atlassian/search-client": "^0.9.0",
     "@testing-library/react": "^12.1.5",
     "@testing-library/user-event": "^14.4.3",
     "fetch-mock": "^8.0.0",