@await-widget/runtime 0.0.5 → 0.0.7

package/types/prop.d.ts

@@ -1,563 +1,233 @@
-type CornerRadiusStyle = "circular" | "continuous";
-
-type ShapeStyle =
-  | Color
-  | Material
-  | "primary"
-  | "secondary"
-  | "tertiary"
-  | "quaternary"
-  | "quinary"
-  | LinearGradient
-  | RadialGradient
-  | AngularGradient;
-
-type NativeAnimation = (
-  | {
-      type?:
-        | "linear"
-        | "default"
-        | "easeIn"
-        | "easeInOut"
-        | "easeOut"
-        | "circularEaseIn"
-        | "circularEaseInOut"
-        | "circularEaseOut";
-      duration?: number;
-    }
-  | {
-      type: "interactiveSpring";
-      blendDuration?: number;
-      duration?: number;
-      bounce?: number;
-    }
-  | {
-      type: "bouncy";
-      bounce?: number;
-      duration?: number;
-    }
-  | {
-      type: "smooth";
-      duration?: number;
-      bounce?: number;
-    }
-  | {
-      type: "spring";
-      blendDuration?: number;
-      duration?: number;
-      bounce?: number;
-    }
-  | {
-      type: "timingCurve";
-      start: UnitPoint;
-      end: UnitPoint;
-      duration?: number;
-    }
-  | {
-      type: "snappy";
-      bounce?: number;
-      duration?: number;
-    }
-) & {
-  value?: unknown;
-  delay?: number;
-  autoreverses?: boolean;
-  speed?: number;
-  loop?: boolean | number;
-};
-
-type ContentTransition =
-  | "identity"
-  | "interpolate"
-  | "opacity"
-  | "symbolEffect"
-  | "numericText"
-  | ["numericText", boolean]
-  | ["numericText", number];
-
-type Edge = "top" | "bottom" | "leading" | "trailing";
-
-type RawTransition =
-  | "identity"
-  | "blurReplace"
-  | "opacity"
-  | "slide"
-  | "scale"
-  | ["scale", number, UnitPoint?]
-  | ["push", Edge]
-  | ["offset", number, number]
-  | ["move", Edge];
-
-type Transition = RawTransition | [RawTransition, RawTransition];
-
-type Padding =
-  | {
-      left?: number;
-      right?: number;
-      top?: number;
-      bottom?: number;
-      vertical?: number;
-      horizontal?: number;
-      other?: number;
-    }
-  | number;
-
-type UnevenRoundedRectangleValue = {
-  rectRadius?: {
-    topLeft?: Dimension;
-    topRight?: Dimension;
-    bottomRight?: Dimension;
-    bottomLeft?: Dimension;
-    bottom?: Dimension;
-    top?: Dimension;
-    left?: Dimension;
-    right?: Dimension;
-  };
-  style?: CornerRadiusStyle;
-};
-
-type ShapeValue = {
-  fill?: ShapeStyle;
-  stroke?: {
-    color?: Color;
-    lineWidth?: number;
-    lineCap?: string;
-    lineJoin?: string;
-    miterLimit?: number;
-    dash?: number[];
-    dashPhase?: number;
-  };
-  shape?: {
-    trim?: [number, number];
-    rotation?: RotationEffect;
-    offset?: Point;
-    scale?: ScaleEffect;
-    in?: {
-      x: number;
-      y: number;
-      width: number;
-      height: number;
-    };
-  };
-};
-
-type RoundedRectangleValue = {
-  rectRadius?: Dimension;
-  style?: CornerRadiusStyle;
-};
+type Props = Record<string, unknown>;
 
 type VStackValue = {
-  spacing?: number;
-  alignment?: HorizontalAlignment;
+	/** Default 0. */
+	spacing?: number;
+	/** Horizontal alignment for child views. */
+	alignment?: HorizontalAlignment;
 };
 
 type HStackValue = {
-  spacing?: number;
-  alignment?: VerticalAlignment;
+	/** Default 0. */
+	spacing?: number;
+	/** Vertical alignment for child views. */
+	alignment?: VerticalAlignment;
 };
 
 type ZStackValue = {
-  alignment?: Alignment;
-};
-
-type LinkValue = {
-  url?: string;
+	/** Horizontal and vertical alignment for child views. */
+	alignment?: Alignment;
 };
 
 type ButtonValue = {
-  intent?: IntentInfo;
-  fast?: boolean;
-  audio?: boolean;
-  url?: string;
-};
-
-type ColorValue = {
-  value?: Color;
-};
-
-type TextValue = {
-  value?: Encodable;
-};
-
-type ImageValue = {
-  url?: string;
-  resizable?: Resizable;
-  interpolation?: Interpolation;
-  style?: TemplateRenderingMode;
+	/** Intent returned by `Await.define(...)`, used to run a registered widget intent when the button is tapped. */
+	intent?: IntentInfo;
+	/** Only applies in the app; triggers the button as soon as the touch begins. */
+	fast?: boolean;
+	/** Requests permission to play audio. */
+	audio?: boolean;
+	/** Opens a universal link directly, such as `https://github.com/await-widget/skills`. */
+	url?: string;
 };
 
-type IconValue = {
-  value?: string;
-};
-
-type TimeValueStrict = {
-  value?: number;
-  style?: "time" | "date" | "relative" | "offset" | "timer";
+type ShapeValue = {
+	/** Default black on light theme, white on dark theme. */
+	fill?: ShapeStyle;
+	/** Only centered strokes are supported. */
+	stroke?: {
+		color?: Color;
+		lineWidth?: number;
+		lineCap?: string;
+		lineJoin?: string;
+		miterLimit?: number;
+		dash?: number[];
+		dashPhase?: number;
+	};
+	shape?: {
+		trim?: [number, number];
+		rotation?: RotationEffect;
+		offset?: Point;
+		scale?: ScaleEffect;
+		in?: {
+			x: number;
+			y: number;
+			width: number;
+			height: number;
+		};
+	};
 };
 
-type TimeValue = {
-  date?: Date;
-  style?: "time" | "date" | "relative" | "offset" | "timer";
+type RoundedRectangleValue = {
+	rectRadius?: Dimension;
+	/** Default `continuous`. */
+	style?: CornerRadiusStyle;
 };
 
-type SvgValue = {
-  url?: string;
-  value?: string;
+type UnevenRoundedRectangleValue = {
+	rectRadius?: {
+		topLeft?: Dimension;
+		topRight?: Dimension;
+		bottomRight?: Dimension;
+		bottomLeft?: Dimension;
+		bottom?: Dimension;
+		top?: Dimension;
+		left?: Dimension;
+		right?: Dimension;
+	};
+	style?: CornerRadiusStyle;
 };
 
 type CapsuleValue = {
-  style?: CornerRadiusStyle;
+	style?: CornerRadiusStyle;
 };
 
 type SectorValue = {
-  value: [start: number, end: number];
+	value: [start: number, end: number];
 };
 
 type PolygonValue = {
-  value: Array<[x: number, y: number]>;
+	value: Array<[x: number, y: number]>;
 };
 
-type SpacerValue = {
-  minLength?: number;
+type LinkValue = {
+	url?: string;
 };
 
-type RadialGradient = {
-  gradient: "radial";
-  colors?: Color[];
-  stops?: Array<[Color, number]>;
-  startRadius?: number;
-  endRadius?: number;
+type ColorValue = {
+	value?: Color;
 };
 
-type AngularGradient = {
-  gradient: "angular";
-  colors?: Color[];
-  stops?: Array<[Color, number]>;
-  angle?: number;
-  center?: UnitPoint;
+type TextValue = {
+	/** Text or encodable value rendered by the component. */
+	value?: Encodable;
 };
 
-type LinearGradient = {
-  gradient: "linear";
-  colors?: Color[];
-  stops?: Stop[];
-  startPoint?: UnitPoint;
-  endPoint?: UnitPoint;
+type ImageValue = {
+	/** Local or remote path such as `img.png` `path/img.png` `https://example.com/img.png` */
+	url?: string;
+	/** The modes used to resize an image to fit within its containing view. */
+	resizable?: Resizable;
+	/** The level of quality for rendering an image that requires interpolation, such as a scaled image. */
+	interpolation?: Interpolation;
+	/** A type that indicates how images are rendered */
+	style?: TemplateRenderingMode;
 };
 
-type UnitPoint =
-  | "center"
-  | "zero"
-  | "leading"
-  | "trailing"
-  | "top"
-  | "topLeading"
-  | "topTrailing"
-  | "bottom"
-  | "bottomLeading"
-  | "bottomTrailing"
-  | Point;
-
-type Stop = [Color, number];
-
-type RawColor =
-  | ""
-  | "background"
-  | "black"
-  | "blue"
-  | "brown"
-  | "cyan"
-  | "gray"
-  | "green"
-  | "indigo"
-  | "magenta"
-  | "mint"
-  | "orange"
-  | "pink"
-  | "primary"
-  | "purple"
-  | "red"
-  | "secondary"
-  | "teal"
-  | "white"
-  | "yellow"
-  | string
-  | number;
-
-type RawThemeColor = RawColor | [RawColor, number];
-
-type Color =
-  | RawThemeColor
-  | {
-      dark?: RawThemeColor;
-      light?: RawThemeColor;
-    };
-
-type VerticalAlignment =
-  | "firstTextBaseline"
-  | "lastTextBaseline"
-  | "top"
-  | "bottom"
-  | "center";
-
-type HorizontalAlignment =
-  | "listRowSeparatorLeading"
-  | "listRowSeparatorTrailing"
-  | "leading"
-  | "trailing"
-  | "center";
-
-type Alignment =
-  | "leading"
-  | "trailing"
-  | "top"
-  | "bottom"
-  | "topLeading"
-  | "topTrailing"
-  | "bottomLeading"
-  | "bottomTrailing"
-  | "center"
-  | "trailingFirstTextBaseline"
-  | "leadingLastTextBaseline"
-  | "leadingFirstTextBaseline"
-  | "centerLastTextBaseline"
-  | "centerFirstTextBaseline"
-  | "trailingLastTextBaseline";
-
-type Dimension = "max" | number;
-type AspectRatio =
-  | "fill"
-  | "fit"
-  | [aspectRatio: number, contentMode: "fill" | "fit"];
-
-type LooseValues = {
-  [P in keyof (ButtonValue &
-    HStackValue &
-    VStackValue &
-    ZStackValue &
-    ColorValue &
-    ImageValue &
-    LinkValue &
-    SpacerValue &
-    SvgValue &
-    IconValue &
-    TextValue &
-    TimeValueStrict &
-    CapsuleValue &
-    RoundedRectangleValue &
-    SectorValue &
-    ShapeValue &
-    UnevenRoundedRectangleValue)]?: unknown;
+type IconValue = {
+	/** The name of the system symbol image. Use the SF Symbols app to look up the names of system symbol images. */
+	value?: string;
 };
 
-type Props = ID & Mods & LooseValues & { children?: NativeView };
-type ID = { id?: Encodable };
-type TextAlignment = "center" | "leading" | "trailing";
-type FontDesign = "monospaced" | "rounded" | "serif" | "default";
-type FontWeight =
-  | "black"
-  | 900
-  | "heavy"
-  | 800
-  | "bold"
-  | 700
-  | "semibold"
-  | 600
-  | "medium"
-  | 500
-  | "light"
-  | 300
-  | "thin"
-  | 200
-  | "ultraLight"
-  | 100
-  | "regular"
-  | 400;
-
-type Material = "regular" | "thin" | "thick" | "ultraThin" | "ultraThick";
-type FontWidth = "compressed" | "condensed" | "standard" | "expanded" | number;
-type Interpolation = "none" | "low" | "medium" | "high";
-type Resizable = boolean | "stretch" | "tile";
-
-type Point = { x?: number; y?: number } | number;
-type ScaleEffect =
-  | { x?: number; y?: number; anchor?: UnitPoint }
-  | { scale?: number; anchor?: UnitPoint }
-  | number;
-type Font = {
-  name: string;
-  size: number;
-  wght?: number;
-  wdth?: number;
-  opsz?: number;
-  slnt?: number;
-  ital?: number;
-
-  GRAD?: number;
-  HGHT?: number;
-  SOFT?: number;
-
-  monospacedDigit?: boolean;
-  features?: string[] | string;
-};
-type Rotation3DEffect = {
-  angle: number;
-  x?: number;
-  y?: number;
-  z?: number;
-  anchor?: UnitPoint;
-  anchorZ?: number;
-  perspective?: number;
+type TimeValue = {
+	date?: Date;
+	/** Use `timer` to update once per second. */
+	style?: TimeStyle;
 };
-type RotationEffect = { angle: number; anchor: UnitPoint } | number;
 
-type Frame =
-  | { maxWidth?: Dimension; maxHeight?: Dimension; alignment?: Alignment }
-  | { width?: number; height?: number; alignment?: Alignment };
-type Shadow = {
-  color?: Color;
-  x?: number;
-  y?: number;
-  blur?: number;
+type SvgValue = {
+	/** For example, `img.png`, `path/img.png`, or `https://example.com/img.png`. */
+	url?: string;
+	/** For example, `<svg><path d="M0 0h10v10h-10z"/></svg>`. */
+	value?: string;
 };
-type Pattern = "dash" | "dashDot" | "dashDotDot" | "dot" | "solid";
-type BlendMode =
-  | "normal"
-  | "multiply"
-  | "screen"
-  | "overlay"
-  | "darken"
-  | "lighten"
-  | "colorDodge"
-  | "colorBurn"
-  | "softLight"
-  | "hardLight"
-  | "difference"
-  | "exclusion"
-  | "hue"
-  | "saturation"
-  | "color"
-  | "luminosity"
-  | "sourceAtop"
-  | "destinationOver"
-  | "destinationOut"
-  | "plusDarker"
-  | "plusLighter";
-
-type ButtonStyle =
-  | "automatic"
-  | "bordered"
-  | "borderedProminent"
-  | "borderless"
-  | "plain"
-  | CustomButtonStyle;
 
-type CustomButtonStyle = {
-  press: NativeView;
-  normal: NativeView;
+type SpacerValue = {
+	minLength?: number;
 };
 
-type LineHeight =
-  | number
-  | [type: "multiple" | "leading", value: number]
-  | "loose"
-  | "normal"
-  | "tight"
-  | "variable";
-
-type BaseMods = {
-  animation?: NativeAnimation | number | "";
-  aspectRatio?: AspectRatio;
-  background?:
-    | ShapeStyle
-    | NativeView
-    | { alignment: Alignment; content: NativeView };
-  baselineOffset?: number;
-  blendMode?: BlendMode;
-  blur?: number | { blur: number; opaque: boolean };
-  brightness?: number;
-  buttonStyle?: ButtonStyle;
-  clipped?: boolean;
-  clipShape?: NativeView | "";
-  colorInvert?: boolean;
-  colorMultiply?: Color;
-  compositingGroup?: boolean;
-  contentShape?: NativeView | "";
-  contentTransition?: ContentTransition;
-  contrast?: number;
-  cornerRadius?: number;
-  debug?: boolean;
-  disable?: boolean;
-  drawingGroup?: boolean;
-  fixedSize?: boolean | { horizontal?: boolean; vertical?: boolean };
-  font?: Font | "";
-  fontDesign?: FontDesign | "";
-  fontSize?: number;
-  fontWeight?: FontWeight | "";
-  fontWidth?: FontWidth | "";
-  foreground?: ShapeStyle;
-  frame?: Frame;
-  geometryGroup?: boolean;
-  grayscale?: number;
-  height?: number;
-  hidden?: boolean;
-  hueRotation?: number;
-  ignoresSafeArea?: boolean;
-  italic?: boolean;
-  kerning?: number;
-  layoutPriority?: number;
-  lineLimit?: number | "";
-  lineSpacing?: number;
-  lineHeight?: LineHeight | "";
-  luminanceToAlpha?: boolean;
-  mask?: NativeView;
-  maxHeight?: Dimension | boolean;
-  maxSides?: Dimension | boolean;
-  maxWidth?: Dimension | boolean;
-  minimumScaleFactor?: number;
-  monospaced?: boolean;
-  monospacedDigit?: boolean;
-  offset?: Point;
-  offsetX?: number;
-  offsetY?: number;
-  opacity?: number;
-  overlay?:
-    | ShapeStyle
-    | NativeView
-    | { alignment: Alignment; content: NativeView };
-  padding?: Padding | boolean;
-  pixelPerfectCenter?: boolean | Point;
-  position?: Point;
-  reverseMask?: NativeView;
-  rotation3DEffect?: Rotation3DEffect;
-  rotationEffect?: RotationEffect;
-  saturation?: number;
-  scaleEffect?: ScaleEffect;
-  shadow?: Shadow;
-  sides?: number;
-  strikethrough?: boolean | { isActive?: boolean; color?: Color };
-  test?: unknown;
-  textAlignment?: TextAlignment;
-  tint?: ShapeStyle;
-  tracking?: number;
-  transform?: [number, number, number, number, number, number];
-  transition?: Transition;
-  truncationMode?: "head" | "middle" | "tail";
-  underline?:
-    | boolean
-    | { isActive?: boolean; pattern?: Pattern; color?: Color };
-  width?: number;
-  zIndex?: number;
+type GifValue = {
+	size: Size;
+	duration: GifDuration;
 };
 
 type Mods = {
-  [K in keyof BaseMods]?: BaseMods[K];
+	[K in keyof BaseMods]?: BaseMods[K];
 } & {
-  [K in keyof BaseMods as `${K & string}_${string}`]?: BaseMods[K];
+	[K in keyof BaseMods as `${K & string}_${string}`]?: BaseMods[K];
 };
 
-type ObjectToTuple<T> = {
-  [K in keyof T]: [K, T[K]];
-}[keyof T];
-
-type ModTuple = ObjectToTuple<BaseMods>;
+type BaseMods = {
+	animation?: NativeAnimation | number | '';
+	aspectRatio?: AspectRatio;
+	background?:
+		| ShapeStyle
+		| NativeView
+		| {alignment: Alignment; content: NativeView};
+	baselineOffset?: number;
+	blendMode?: BlendMode;
+	blur?: Blur;
+	brightness?: number;
+	buttonStyle?: ButtonStyle;
+	clipped?: boolean;
+	clipShape?: NativeView | '';
+	colorInvert?: boolean;
+	colorMultiply?: Color;
+	compositingGroup?: boolean;
+	contentShape?: NativeView | '';
+	contentTransition?: ContentTransition;
+	contrast?: number;
+	cornerRadius?: number;
+	debug?: boolean;
+	disable?: boolean;
+	drawingGroup?: boolean;
+	fixedSize?: FixedSize;
+	font?: Font | '';
+	fontDesign?: FontDesign | '';
+	fontSize?: number;
+	fontWeight?: FontWeight | '';
+	fontWidth?: FontWidth | '';
+	foreground?: ShapeStyle;
+	frame?: Frame;
+	geometryGroup?: boolean;
+	grayscale?: number;
+	height?: number;
+	hidden?: boolean;
+	hueRotation?: number;
+	ignoresSafeArea?: boolean;
+	italic?: boolean;
+	kerning?: number;
+	layoutPriority?: number;
+	lineHeight?: LineHeight | '';
+	lineLimit?: number | '';
+	lineSpacing?: number;
+	luminanceToAlpha?: boolean;
+	mask?: NativeView;
+	maxHeight?: Dimension | boolean;
+	maxSides?: Dimension | boolean;
+	maxWidth?: Dimension | boolean;
+	minimumScaleFactor?: number;
+	monospaced?: boolean;
+	monospacedDigit?: boolean;
+	offset?: Point;
+	offsetX?: number;
+	offsetY?: number;
+	opacity?: number;
+	overlay?:
+		| ShapeStyle
+		| NativeView
+		| {alignment: Alignment; content: NativeView};
+	padding?: Padding | boolean;
+	pixelPerfectCenter?: boolean | Point;
+	position?: Point;
+	reverseMask?: NativeView;
+	rotation3DEffect?: Rotation3DEffect;
+	rotationEffect?: RotationEffect;
+	saturation?: number;
+	scaleEffect?: ScaleEffect;
+	shadow?: Shadow;
+	sides?: number;
+	strikethrough?:
+		| boolean
+		| {isActive?: boolean; pattern?: Pattern; color?: Color};
+	test?: unknown;
+	textAlignment?: TextAlignment;
+	tint?: ShapeStyle;
+	tracking?: number;
+	transform?: [number, number, number, number, number, number];
+	transition?: Transition;
+	truncationMode?: 'head' | 'middle' | 'tail';
+	typesettingLanguage?: string;
+	underline?: boolean | {isActive?: boolean; pattern?: Pattern; color?: Color};
+	width?: number;
+	zIndex?: number;
+};