index.ts

/**
 * General @nativescript/core types used throughout the library.
 */

// imported for definition purposes only
import * as animationModule from '../ui/animation';
import { makeValidator, makeParser } from '../ui/core/properties';

export namespace CoreTypes {
	/**
	 * Denotes a length number that is in device independent pixel units.
	 */
	export type dip = number;

	/**
	 * Denotes a length number that is in physical device pixels.
	 */
	export type px = number;

	/**
	 * Denotes a normalized percent number.
	 * 0% is represented as 0
	 * 50% is represented as 0.5
	 * 100% is represented as 1
	 */
	export type percent = number;

	export type LengthDipUnit = { readonly unit: 'dip'; readonly value: dip };
	export type LengthPxUnit = { readonly unit: 'px'; readonly value: px };
	export type LengthPercentUnit = { readonly unit: '%'; readonly value: percent };

	export type LengthType = 'auto' | dip | LengthDipUnit | LengthPxUnit;
	export type PercentLengthType = 'auto' | dip | LengthDipUnit | LengthPxUnit | LengthPercentUnit;

	export const zeroLength: LengthType = {
		value: 0,
		unit: 'px',
	};

	export type KeyboardInputType = 'datetime' | 'phone' | 'number' | 'url' | 'email' | 'integer';
	export namespace KeyboardType {
		export const datetime = 'datetime';
		export const phone = 'phone';
		export const number = 'number';
		export const url = 'url';
		export const email = 'email';
		export const integer = 'integer';
	}
	export type AutofillType = 'username' | 'password' | 'none' | string;
	export namespace AutofillType {
		export const username = 'username';
		export const password = 'password';
		export const newUsername = 'newUsername';
		export const newPassword = 'newPassword';
		export const oneTimeCode = 'oneTimeCode';
		export const none = 'none';
	}

	export type ReturnKeyButtonType = 'done' | 'next' | 'go' | 'search' | 'send';
	export namespace ReturnKeyType {
		export const done = 'done';
		export const next = 'next';
		export const go = 'go';
		export const search = 'search';
		export const send = 'send';
	}

	export type TextAlignmentType = 'initial' | 'left' | 'center' | 'right' | 'justify';
	export namespace TextAlignment {
		export const left = 'left';
		export const center = 'center';
		export const right = 'right';
		export const justify = 'justify';
	}

	export type TextDecorationType = 'none' | 'underline' | 'line-through' | 'underline line-through';
	export namespace TextDecoration {
		export const none = 'none';
		export const underline = 'underline';
		export const lineThrough = 'line-through';
	}

	export type TextTransformType = 'initial' | 'none' | 'capitalize' | 'uppercase' | 'lowercase';
	export namespace TextTransform {
		export const none = 'none';
		export const capitalize = 'capitalize';
		export const uppercase = 'uppercase';
		export const lowercase = 'lowercase';
	}

	export type WhiteSpaceType = 'initial' | 'normal' | 'nowrap';
	export namespace WhiteSpace {
		export const normal = 'normal';
		export const nowrap = 'nowrap';
	}

	export type TextOverflowType = 'clip' | 'ellipsis' | 'initial' | 'unset';
	export namespace TextOverflow {
		export const clip = 'clip';
		export const ellipsis = 'ellipsis';
		export const initial = 'initial';
		export const unset = 'unset';
	}

	export type MaxLinesType = number;

	export type OrientationType = 'horizontal' | 'vertical';
	export namespace Orientation {
		export const horizontal = 'horizontal';
		export const vertical = 'vertical';
	}

	export type DeviceOrientationType = 'portrait' | 'landscape' | 'unknown';
	export namespace DeviceOrientation {
		export const portrait = 'portrait';
		export const landscape = 'landscape';
		export const unknown = 'unknown';
	}

	export type HorizontalAlignmentType = 'left' | 'center' | 'right' | 'stretch';
	export namespace HorizontalAlignment {
		export const left = 'left';
		export const center = 'center';
		export const right = 'right';
		export const stretch = 'stretch';
		export const isValid = makeValidator<HorizontalAlignmentType>(left, center, right, stretch);
		export const parse = makeParser<HorizontalAlignmentType>(isValid);
	}

	export type VerticalAlignmentType = 'top' | 'middle' | 'bottom' | 'stretch';
	export namespace VerticalAlignment {
		export const top = 'top';
		export const middle = 'middle';
		export const bottom = 'bottom';
		export const stretch = 'stretch';
	}
	export type VerticalAlignmentTextType = VerticalAlignmentType | 'text-top' | 'text-bottom' | 'sup' | 'sub' | 'baseline';
	export namespace VerticalAlignmentText {
		export const top = 'top';
		export const middle = 'middle';
		export const bottom = 'bottom';
		export const stretch = 'stretch';
		export const texttop = 'text-top';
		export const textbottom = 'text-bottom';
		export const sup = 'sup';
		export const sub = 'sub';
		export const baseline = 'baseline';
		export const isValid = makeValidator<VerticalAlignmentTextType>(top, middle, bottom, stretch, texttop, textbottom, sup, sub, baseline);
		export const parse = (value: string) => (value.toLowerCase() === 'center' ? middle : parseStrict(value));
		const parseStrict = makeParser<CoreTypes.VerticalAlignmentTextType>(isValid);
	}

	export type ImageStretchType = 'none' | 'aspectFill' | 'aspectFit' | 'fill';
	export namespace ImageStretch {
		export const none: ImageStretchType = 'none';
		export const aspectFill: ImageStretchType = 'aspectFill';
		export const aspectFit: ImageStretchType = 'aspectFit';
		export const fill: ImageStretchType = 'fill';
	}

	export type VisibilityType = 'visible' | 'hidden' | 'collapse' | 'collapsed';
	export namespace Visibility {
		export const visible: VisibilityType = 'visible';
		export const collapse: VisibilityType = 'collapse';
		export const collapsed: VisibilityType = 'collapsed';
		export const hidden: VisibilityType = 'hidden';
		export const isValid = makeValidator<CoreTypes.VisibilityType>(visible, hidden, collapse);
		export const parse = (value: string) => (value.toLowerCase() === 'collapsed' ? collapse : parseStrict(value));
		const parseStrict = makeParser<CoreTypes.VisibilityType>(isValid);
	}

	export namespace FontAttributes {
		export const Normal = 0;
		export const Bold = 1;
		export const Italic = 1 << 1;
	}

	export namespace DeviceType {
		export const Phone: string = 'Phone';
		export const Tablet: string = 'Tablet';
	}

	export type UpdateTextTriggerType = 'focusLost' | 'textChanged';
	export namespace UpdateTextTrigger {
		export const focusLost: UpdateTextTriggerType = 'focusLost';
		export const textChanged: UpdateTextTriggerType = 'textChanged';
	}

	export namespace Accuracy {
		export const any: number = 300;
		export const high: number = 3;
	}

	export type DockType = 'left' | 'top' | 'right' | 'bottom';
	export namespace Dock {
		export const left: DockType = 'left';
		export const top: DockType = 'top';
		export const right: DockType = 'right';
		export const bottom: DockType = 'bottom';
	}

	export type AutocapitalizationInputType = 'none' | 'words' | 'sentences' | 'allcharacters';
	export namespace AutocapitalizationType {
		export const none: AutocapitalizationInputType = 'none';
		export const words: AutocapitalizationInputType = 'words';
		export const sentences: AutocapitalizationInputType = 'sentences';
		export const allCharacters: AutocapitalizationInputType = 'allcharacters';
	}

	export namespace NavigationBarVisibility {
		export const auto: string = 'auto';
		export const never: string = 'never';
		export const always: string = 'always';
	}

	export namespace AndroidActionBarIconVisibility {
		export const auto: string = 'auto';
		export const never: string = 'never';
		export const always: string = 'always';
	}

	export namespace AndroidActionItemPosition {
		export const actionBar: string = 'actionBar';
		export const actionBarIfRoom: string = 'actionBarIfRoom';
		export const popup: string = 'popup';
	}

	export namespace IOSActionItemPosition {
		export const left: string = 'left';
		export const right: string = 'right';
	}

	export namespace ImageFormat {
		export const png: string = 'png';
		export const jpeg: string = 'jpeg';
		export const jpg: string = 'jpg';
	}

	export namespace FontStyle {
		export const normal: string = 'normal';
		export const italic: string = 'italic';
	}

	export namespace FontWeight {
		export const thin: string = '100';
		export const extraLight: string = '200';
		export const light: string = '300';
		export const normal: string = 'normal'; // 400
		export const medium: string = '500';
		export const semiBold: string = '600';
		export const bold: string = 'bold'; // 700
		export const extraBold: string = '800';
		export const black: string = '900';
	}

	export type BackgroundRepeatType = 'repeat' | 'repeat-x' | 'repeat-y' | 'no-repeat';
	export namespace BackgroundRepeat {
		export const repeat: BackgroundRepeatType = 'repeat';
		export const repeatX: BackgroundRepeatType = 'repeat-x';
		export const repeatY: BackgroundRepeatType = 'repeat-y';
		export const noRepeat: BackgroundRepeatType = 'no-repeat';
		export const isValid = makeValidator<BackgroundRepeatType>(repeat, repeatX, repeatY, noRepeat);
		export const parse = makeParser<BackgroundRepeatType>(isValid);
	}

	let animation: typeof animationModule;

	export namespace AnimationCurve {
		export const ease = 'ease';
		export const easeIn = 'easeIn';
		export const easeOut = 'easeOut';
		export const easeInOut = 'easeInOut';
		export const linear = 'linear';
		export const spring = 'spring';
		export function cubicBezier(x1: number, y1: number, x2: number, y2: number) {
			animation = animation || require('../ui/animation');

			return new animation.CubicBezierAnimationCurve(x1, y1, x2, y2);
		}
	}

	export namespace StatusBarStyle {
		export const light = 'light';
		export const dark = 'dark';
	}

	export namespace SystemAppearance {
		export const light = 'light';
		export const dark = 'dark';
	}
}

/**
 * NOTE: Auto migrate deprecations via eslint-plugin in future
 */

/**
 * @deprecated Use `CoreTypes.dip` instead.
 */
export type dip = number;

/**
 * @deprecated Use `CoreTypes.px` instead.
 */
export type px = number;

/**
 * @deprecated Use `CoreTypes.percent` instead.
 */
export type percent = number;

/**
 * @deprecated Use `CoreTypes.LengthDipUnit` instead.
 */
export type LengthDipUnit = CoreTypes.LengthDipUnit;
/**
 * @deprecated Use `CoreTypes.LengthPxUnit` instead.
 */
export type LengthPxUnit = CoreTypes.LengthPxUnit;
/**
 * @deprecated Use `CoreTypes.LengthPercentUnit` instead.
 */
export type LengthPercentUnit = CoreTypes.LengthPercentUnit;

/**
 * @deprecated Use `CoreTypes.LengthType` instead.
 */
export type LengthType = CoreTypes.LengthType;
/**
 * @deprecated Use `CoreTypes.PercentLengthType` instead.
 */
export type PercentLengthType = CoreTypes.PercentLengthType;

/**
 * @deprecated Use `CoreTypes.AnimationCurve` instead.
 */
export const AnimationCurve = CoreTypes.AnimationCurve;

/**
 * @deprecated Use `CoreTypes.HorizontalAlignmentType` instead.
 */
export type HorizontalAlignment = CoreTypes.HorizontalAlignmentType;

/**
 * @deprecated Use `CoreTypes.VerticalAlignmentType` instead.
 */
export type VerticalAlignment = CoreTypes.VerticalAlignmentType;

/**
 * @deprecated Use `CoreTypes` instead. Enums will be removed in 9.0
 */
export const Enums = {
	Accuracy: CoreTypes.Accuracy,
	AndroidActionBarIconVisibility: CoreTypes.AndroidActionBarIconVisibility,
	AndroidActionItemPosition: CoreTypes.AndroidActionItemPosition,
	AnimationCurve: CoreTypes.AnimationCurve,
	AutocapitalizationType: CoreTypes.AutocapitalizationType,
	BackgroundRepeat: CoreTypes.BackgroundRepeat,
	DeviceOrientation: CoreTypes.DeviceOrientation,
	DeviceType: CoreTypes.DeviceType,
	Dock: CoreTypes.Dock,
	FontAttributes: CoreTypes.FontAttributes,
	FontStyle: CoreTypes.FontStyle,
	FontWeight: CoreTypes.FontWeight,
	HorizontalAlignment: CoreTypes.HorizontalAlignment,
	IOSActionItemPosition: CoreTypes.IOSActionItemPosition,
	ImageFormat: CoreTypes.ImageFormat,
	KeyboardType: CoreTypes.KeyboardType,
	NavigationBarVisibility: CoreTypes.NavigationBarVisibility,
	Orientation: CoreTypes.Orientation,
	ReturnKeyType: CoreTypes.ReturnKeyType,
	StatusBarStyle: CoreTypes.StatusBarStyle,
	Stretch: CoreTypes.ImageStretch,
	SystemAppearance: CoreTypes.SystemAppearance,
	TextAlignment: CoreTypes.TextAlignment,
	TextDecoration: CoreTypes.TextDecoration,
	TextTransform: CoreTypes.TextTransform,
	UpdateTextTrigger: CoreTypes.UpdateTextTrigger,
	VerticalAlignment: CoreTypes.VerticalAlignment,
	Visibility: CoreTypes.Visibility,
	WhiteSpace: CoreTypes.WhiteSpace,
};