@await-widget/runtime 0.0.6 → 0.0.8

package/types/model.d.ts

@@ -0,0 +1,274 @@
+type AudioOption = 'mix' | 'duckOthers' | 'solo';
+
+type ColorScheme = 'light' | 'dark';
+
+type RenderingMode = 'fullColor' | 'accented' | 'vibrant';
+
+type Update = Date | 'end' | 'rapid' | 'never';
+
+type WidgetFamily =
+	| 'small'
+	| 'medium'
+	| 'large'
+	| 'extraLarge'
+	| 'extraLargePortrait'
+	| 'accessoryInline'
+	| 'accessoryCircular'
+	| 'accessoryRectangular'
+	| 'unknown';
+
+type SingleNativeView =
+	| string
+	| number
+	| undefined
+	| {
+			kind: string;
+			flat?: unknown[];
+			children?: NativeView;
+	  };
+
+type NativeView = SingleNativeView | NativeView[];
+
+type AudioConfig = {
+	soundFont?: string;
+	volume?: number;
+	duration?: number;
+	delay?: number;
+	velocity?: number;
+	preset?: number;
+	bank?: number;
+	loop?: boolean;
+	audioOption?: AudioOption;
+};
+
+type SoundFontManualMapping = {
+	path: string;
+	key: number;
+};
+
+type SoundFontBuildConfig = {
+	savePath: string;
+	dataSizeLimitMB?: number;
+	mediaFiles?: string[];
+	mappings?: SoundFontManualMapping[];
+};
+
+type SoundFontCompressConfig = {
+	fromPath: string;
+	savePath: string;
+	dataSizeLimitMB?: number;
+};
+
+type SoundFontBuildResult = {
+	ok: true;
+	output: string;
+	resolvedOutput: string;
+	sizeBytes: number;
+};
+
+type AwaitWeatherConfig = {
+	latitude?: number;
+	longitude?: number;
+	hourlyLimit?: number;
+	dailyLimit?: number;
+};
+
+type AwaitWeatherCurrent = {
+	date: string;
+	condition: string;
+	symbolName: string;
+	temperatureCelsius: number;
+	apparentTemperatureCelsius: number;
+	humidity: number;
+	uvIndex: number;
+	windSpeedMetersPerSecond: number;
+	windDirectionDegrees: number;
+	pressureHectopascals: number;
+	visibilityKilometers: number;
+};
+
+type AwaitWeatherHourly = {
+	date: string;
+	condition: string;
+	symbolName: string;
+	temperatureCelsius: number;
+	humidity: number;
+	uvIndex: number;
+	windSpeedMetersPerSecond: number;
+	precipitationChance: number;
+};
+
+type AwaitWeatherDaily = {
+	date: string;
+	condition: string;
+	symbolName: string;
+	highTemperatureCelsius: number;
+	lowTemperatureCelsius: number;
+	precipitationChance: number;
+	uvIndex: number;
+};
+
+type AwaitWeatherResult = {
+	location: {
+		latitude: number;
+		longitude: number;
+	};
+	current: AwaitWeatherCurrent;
+	hourly: AwaitWeatherHourly[];
+	daily: AwaitWeatherDaily[];
+};
+
+type AwaitHealthInfo = {
+	stepCount?: number;
+	distanceWalkingRunning?: number;
+	flightsClimbed?: number;
+};
+
+type AwaitLocationConfig = {
+	desiredAccuracyMeters?: number;
+	timeoutSeconds?: number;
+};
+
+type AwaitLocationInfo = {
+	latitude: number;
+	longitude: number;
+	date: Date;
+	altitudeMeters?: number;
+	speedMetersPerSecond?: number;
+	courseDegrees?: number;
+};
+
+type AwaitNowPlayingConfig = {
+	artworkSize?: number;
+};
+
+type AwaitNowPlayingInfo = {
+	state?:
+		| 'playing'
+		| 'paused'
+		| 'stopped'
+		| 'interrupted'
+		| 'seekingForward'
+		| 'seekingBackward';
+	sourceConfig?: AwaitMediaPlayConfig;
+	id?: string;
+	title?: string;
+	artistName?: string;
+	albumTitle?: string;
+	artworkURL?: string;
+	maximumWidth?: number;
+	maximumHeight?: number;
+	backgroundColor?: Color;
+	primaryTextColor?: Color;
+	secondaryTextColor?: Color;
+	tertiaryTextColor?: Color;
+	quaternaryTextColor?: Color;
+};
+
+type AwaitMusicPlayerCommand = 'start' | 'toggle' | 'next' | 'previous';
+
+type AwaitMediaPlayConfig =
+	| {
+			source: 'song';
+			id?: string;
+			query?: string;
+			limit?: number;
+			shuffle?: boolean;
+			loop?: boolean;
+			offset?: number;
+	  }
+	| {
+			source: 'album';
+			id?: string;
+			query?: string;
+			shuffle?: boolean;
+			loop?: boolean;
+	  }
+	| {
+			source: 'station';
+			query?: string;
+			type?: 'discovery' | 'user';
+			id?: string;
+	  };
+
+type AwaitCalendarConfig = {
+	start?: Date;
+	end?: Date;
+	limit?: number;
+};
+
+type AwaitCalendarItem = {
+	calendarTitle: string;
+	title: string;
+	startDate: Date;
+	endDate: Date;
+	isAllDay: boolean;
+	location?: string;
+	notes?: string;
+	url?: string;
+};
+
+type AwaitReminderConfig = {
+	type?: 'all' | 'incomplete' | 'completed';
+	limit?: number;
+};
+
+type AwaitReminderItem = {
+	calendarTitle: string;
+	title: string;
+	notes?: string;
+	isCompleted: boolean;
+	priority: number;
+	startDate?: Date;
+	dueDate?: Date;
+	completionDate?: Date;
+};
+
+type AwaitSystemInfo = {
+	battery: {
+		state: 'charging' | 'full' | 'unplugged' | 'unknown';
+		percent: number;
+		lowPowerMode: boolean;
+	};
+	memory?: {
+		used: number;
+		free: number;
+		total: number;
+		percent: number;
+	};
+	cpu: {
+		percent?: number;
+	};
+	storage?: {
+		total: number;
+		free: number;
+		used: number;
+		percent: number;
+	};
+};
+
+type AwaitAlarmScheduleConfig = {
+	title?: string;
+	duration?: number;
+	date?: Date;
+	tint?: Color;
+};
+
+type WidgetEntry<T extends Record<string, unknown> = Record<string, unknown>> =
+	TimelineContext &
+		T & {
+			date: Date;
+			colorScheme: ColorScheme;
+			renderingMode: RenderingMode;
+		};
+
+type TimelineContext = {
+	size: Size;
+	family: WidgetFamily;
+};
+
+type Timeline<T extends Record<string, unknown> = Record<string, unknown>> = {
+	entries: Array<{date: Date} & T>;
+	update?: Update;
+	skipOnPlayingNote?: boolean;
+};

package/types/prop.d.ts

@@ -1,231 +1,249 @@
 type Props = Record<string, unknown>;
 
 type VStackValue = {
-  spacing?: number;
-  /** Horizontal alignment for child views. */
-  alignment?: HorizontalAlignment;
+	/** Default 0. */
+	spacing?: number;
+	/** Horizontal alignment for child views. */
+	alignment?: HorizontalAlignment;
 };
 
 type HStackValue = {
-  spacing?: number;
-  /** Vertical alignment for child views. */
-  alignment?: VerticalAlignment;
+	/** Default 0. */
+	spacing?: number;
+	/** Vertical alignment for child views. */
+	alignment?: VerticalAlignment;
 };
 
 type ZStackValue = {
-  /** Horizontal and vertical alignment for child views. */
-  alignment?: Alignment;
+	/** Horizontal and vertical alignment for child views. */
+	alignment?: Alignment;
 };
 
 type ButtonValue = {
-  /** 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;
+	/** 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 ShapeValue = {
-  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;
-    };
-  };
+	/** 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 RoundedRectangleValue = {
-  rectRadius?: Dimension;
-  style?: CornerRadiusStyle;
+	rectRadius?: Dimension;
+	/** Default `continuous`. */
+	style?: CornerRadiusStyle;
 };
 
 type UnevenRoundedRectangleValue = {
-  rectRadius?: {
-    topLeft?: Dimension;
-    topRight?: Dimension;
-    bottomRight?: Dimension;
-    bottomLeft?: Dimension;
-    bottom?: Dimension;
-    top?: Dimension;
-    left?: Dimension;
-    right?: Dimension;
-  };
-  style?: CornerRadiusStyle;
+	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 LinkValue = {
-  url?: string;
+	url?: string;
 };
 
 type ColorValue = {
-  value?: Color;
+	value?: Color;
 };
 
 type TextValue = {
-  /** Text or encodable value rendered by the component. */
-  value?: Encodable;
+	/** Text or encodable value rendered by the component. */
+	value?: Encodable;
 };
 
 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;
+	/** 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 IconValue = {
-  /** The name of the system symbol image. Use the SF Symbols app to look up the names of system symbol images. */
-  value?: string;
+	/** The name of the system symbol image. Use the SF Symbols app to look up the names of system symbol images. */
+	value?: string;
 };
 
 type TimeValue = {
-  date?: Date;
-  /** Use `timer` to update once per second. */
-  style?: TimeStyle;
+	date?: Date;
+	/** Use `timer` to update once per second. */
+	style?: TimeStyle;
 };
 
 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;
+	/** 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 SpacerValue = {
-  minLength?: number;
+	minLength?: number;
 };
 
 type GifValue = {
-  size: Size;
-  duration: GifDuration;
+	size: Size;
+	duration: GifDuration;
+};
+
+type TickerValue = {
+	size: Size;
+	style: TickerStyle;
+};
+
+type FlipValue = {
+	index: number;
+	delta: number;
+	curr: NativeView;
+	prev: NativeView;
+	perspective?: number;
+	shadowOpacity?: number;
+	leadingHidden?: boolean;
+	trailingHidden?: boolean;
 };
 
 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 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;
+	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;
 };