@atlaskit/link-create 5.3.3 → 6.0.0

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

@@ -1,2 +0,0 @@
-import React from 'react';
-export declare const SubmitButton: () => React.JSX.Element;

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

@@ -1,6 +0,0 @@
-import { type SpinnerProps } from '@atlaskit/spinner';
-/**
- * Wrapper component for the Spinner, shows while the form
- * performs async functions on load.
- */
-export declare const CreateFormLoader: ({ size }: Partial<SpinnerProps>) => JSX.Element;

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

@@ -1,12 +0,0 @@
-import React from 'react';
-export type FormSpyProps<T> = {
-    children: ({ values }: {
-        values: T;
-    }) => React.ReactNode;
-};
-/**
- * Lightweight wrapper around the react-final-form
- * FormSpy component so that we can control selectively
- * how much of the API we are commited to.
- */
-export declare const FormSpy: <T extends Record<string, unknown>>({ children, }: FormSpyProps<T>) => React.JSX.Element;

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

@@ -1,55 +0,0 @@
-/**
- * @jsxRuntime classic
- * @jsx jsx
- */
-import { type ReactNode } from 'react';
-type ReservedFields = {
-    [Field in (typeof RESERVED_FIELDS)[number]]?: unknown;
-};
-declare const RESERVED_FIELDS: readonly [
-    '__post_create__'
-];
-type DisallowReservedFields<T> = T & {
-    [Field in (typeof RESERVED_FIELDS)[number]]?: never;
-};
-type OmitReservedFields<T> = Omit<T, keyof ReservedFields>;
-type Errors = Record<string, string>;
-export interface CreateFormProps<FormData> {
-    /**
-     * Should resolve to void, or resolve to an object of
-     * keys (field names) with error messages (key values)
-     */
-    onSubmit: (data: OmitReservedFields<FormData>) => void | Errors | Promise<void | Errors>;
-    /**
-     * Children to render in the form (form fields)
-     */
-    children: ReactNode;
-    /**
-     * Test id to render on the form element
-     */
-    testId?: string;
-    /**
-     * Callback when the cancel button is fired
-     */
-    onCancel?: () => void;
-    /**
-     * Renders a spinner when true
-     */
-    isLoading?: boolean;
-    /**
-     * Hides the rendering of the footer buttons
-     */
-    hideFooter?: boolean;
-    /**
-     * Hides the "Required fields are marked with an asterisk" message
-     */
-    hideRequiredFieldMessage?: boolean;
-    /**
-     * Values to initialise the forms initial state with
-     * Should not include values for reserved fields
-     */
-    initialValues?: DisallowReservedFields<FormData>;
-}
-export declare const TEST_ID = "link-create-form";
-export declare const CreateForm: <FormData extends Record<string, any> = {}>({ children, testId, onSubmit, onCancel, isLoading, hideFooter, hideRequiredFieldMessage, initialValues, }: CreateFormProps<FormData>) => JSX.Element;
-export {};

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

@@ -1,19 +0,0 @@
-import { type PropsWithChildren } from 'react';
-import { type OptionProps, type OptionType, type SingleValueProps } from '@atlaskit/select';
-import { type SelectProps, type SitePickerOptionType } from './types';
-export declare const TEST_ID = "link-create-select";
-/**
- * A select component utilising the Atlaskit Select and CreateField.
- * Validation is handled by the form on form submission. Any
- * errors returned by the handleSubmit function passed to the form <Form> that
- * have a key matching the `name` of this field are shown below the field.
- */
-export declare function Select<T = OptionType>({ id, name, label, isRequired, validators, validationHelpText, testId, ...restProps }: SelectProps<T>): JSX.Element;
-export type SiteSelectProps = {
-    testId?: string;
-    options?: SitePickerOptionType[];
-    name?: string;
-};
-export declare const SiteSelect: ({ options, name, testId }: SiteSelectProps) => JSX.Element;
-export declare const SitePickerOption: ({ children, ...props }: PropsWithChildren<OptionProps<SitePickerOptionType, false>>) => JSX.Element;
-export declare const SitePickerSingleValue: ({ children, ...props }: PropsWithChildren<SingleValueProps<SitePickerOptionType, false>>) => JSX.Element;

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

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

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

@@ -1,27 +0,0 @@
-import { type SelectProps as AKSelectProps, type OptionType } from '@atlaskit/select';
-import { type Validator } from '../../../common/types';
-export type SelectProps<T = OptionType> = AKSelectProps<T> & {
-    /** Name passed to the <Field> */
-    name: string;
-    /** This should be properly internationalization-ed */
-    label: string;
-    /**
-     * Optional text below the field 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[];
-};
-export type SitePickerOptionValue = {
-    avatarUrl?: string;
-    cloudId: string;
-    url: string;
-};
-export type SitePickerOptionType = {
-    label: string;
-    value: SitePickerOptionValue;
-};

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

@@ -1,9 +0,0 @@
-import { type TextFieldProps } from './types';
-export declare const TEST_ID = "link-create-text-field";
-/**
- * A text field utilising the Atlaskit Textfield and CreateField.
- * 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 const TextField: ({ id, name, label, isRequired, validators, validationHelpText, testId, ...restProps }: TextFieldProps) => JSX.Element;

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

@@ -1,14 +0,0 @@
-import { type TextFieldProps as AKTextFieldProps } from '@atlaskit/textfield';
-import { type Validator } from '../../../common/types';
-export type TextFieldProps = Omit<AKTextFieldProps, 'name'> & {
-    /** 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

@@ -1,6 +0,0 @@
-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/user-picker/main.d.ts

@@ -1,6 +0,0 @@
-import { type UserPickerProps } from './types';
-export declare const TEST_ID = "link-create-user-picker";
-/**
- * A user picker utilising the SmartUserPicker.
- */
-export declare const UserPicker: ({ productKey, siteId, name, label, placeholder, validators, testId, defaultValue, }: UserPickerProps) => JSX.Element;

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

@@ -1,23 +0,0 @@
-import { type Validator } from '../../../common/types';
-export type UserPickerProps = {
-    /** Name to pass into the <Field>  */
-    name: string;
-    /** Refers to a product identifier, Jira, Confluence, Townsquare, ect. */
-    productKey: string;
-    /** Identifier for the product's tenant, also known as tenantId or cloudId */
-    siteId: string;
-    /** The label text above the component */
-    label?: string;
-    /** Placeholder text to display in the text field whenever it is empty. */
-    placeholder?: string;
-    /** Validators for this field */
-    validators?: Validator[];
-    testId?: string;
-    defaultValue: User | undefined;
-};
-type User = {
-    id: string;
-    name?: string;
-    avatarUrl?: string;
-};
-export {};

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

@@ -1,13 +0,0 @@
-import { type 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/inline-create/index.d.ts

@@ -1,4 +0,0 @@
-import React from 'react';
-import type { LinkCreateProps } from '../../common/types';
-declare const ComposedLinkCreate: React.MemoExoticComponent<(props: LinkCreateProps) => React.JSX.Element>;
-export default ComposedLinkCreate;

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

@@ -1,9 +0,0 @@
-import React, { type PropsWithChildren } from 'react';
-import type { AnalyticsEventAttributes } from '../../../common/utils/analytics/analytics.codegen';
-type InlineAnalyticsProps = {
-    screen: keyof {
-        [Key in keyof AnalyticsEventAttributes as Key extends `screen.${infer ScreenName}.viewed` ? ScreenName : never]: any;
-    };
-};
-export declare const InlineAnalytics: ({ screen, children, }: PropsWithChildren<InlineAnalyticsProps>) => React.JSX.Element;
-export {};

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

@@ -1,4 +0,0 @@
-import React from 'react';
-import type { LinkCreateProps } from '../../common/types';
-declare const InlineCreate: (props: LinkCreateProps) => React.JSX.Element;
-export default InlineCreate;

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

@@ -1,4 +0,0 @@
-import React from 'react';
-import { type LinkCreateWithModalProps } from '../../common/types';
-declare const ComposedLinkCreate: React.MemoExoticComponent<(props: LinkCreateWithModalProps) => React.JSX.Element>;
-export default ComposedLinkCreate;

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

@@ -1,4 +0,0 @@
-import React from 'react';
-import type { LinkCreateWithModalProps } from '../../common/types';
-declare const LinkCreateModal: (props: LinkCreateWithModalProps) => React.JSX.Element;
-export default LinkCreateModal;

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

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