@rafaelaugusto/jolt 0.1.0-beta.1 → 0.1.0-beta.11

package/src/svg-path.ts

@@ -0,0 +1,355 @@
+/** SVG path geometry in local DIPs. No DOM or platform path API is used. */
+export interface PathPoint {
+  x: number
+  y: number
+}
+export interface PathPose extends PathPoint {
+  rotate: number
+}
+type Segment = { point(t: number): PathPoint; tangent(t: number): PathPoint }
+type Vertex = PathPoint & {
+  segment: number
+  t: number
+  distance: number
+  heading: number
+}
+export interface MotionPath {
+  readonly length: number
+  at(progress: number): PathPose
+}
+const LIMIT = 1_000_000
+const MAX_SEGMENTS = 1024
+const MAX_VERTICES = 8192
+const TOLERANCE = 0.025
+const distance = (a: PathPoint, b: PathPoint) => Math.hypot(b.x - a.x, b.y - a.y)
+const mix = (a: PathPoint, b: PathPoint, t: number): PathPoint => ({
+  x: a.x + (b.x - a.x) * t,
+  y: a.y + (b.y - a.y) * t,
+})
+const checked = (p: PathPoint) => {
+  if (![p.x, p.y].every((n) => Number.isFinite(n) && Math.abs(n) <= LIMIT))
+    throw new RangeError('Path coordinates must stay within ±1000000 DIPs.')
+  return p
+}
+const unwrap = (angle: number, reference: number) =>
+  angle + 360 * Math.round((reference - angle) / 360)
+
+class Scanner {
+  index = 0
+  private hasNumber = false
+  constructor(readonly text: string) {}
+  peek() {
+    while (/[\t\n\r ]/.test(this.text[this.index] ?? '\0')) this.index++
+    return this.text[this.index]
+  }
+  command() {
+    const value = this.peek()!
+    this.index++
+    this.hasNumber = false
+    return value
+  }
+  number(flag = false) {
+    this.peek()
+    if (this.text[this.index] === ',') {
+      if (!this.hasNumber) this.error()
+      this.index++
+      this.peek()
+    }
+    const rest = this.text.slice(this.index)
+    const token = flag
+      ? /^[01]/.exec(rest)?.[0]
+      : /^[+-]?(?:\d+\.?\d*|\.\d+)(?:e[+-]?\d+)?/i.exec(rest)?.[0]
+    if (!token) this.error()
+    const value = Number(token)
+    if (!Number.isFinite(value) || Math.abs(value) > LIMIT)
+      throw new RangeError('Path numbers must be finite and within ±1000000.')
+    this.index += token!.length
+    this.hasNumber = true
+    return value
+  }
+  error(): never {
+    throw new SyntaxError(`Invalid SVG path at character ${this.index}.`)
+  }
+}
+
+function line(a: PathPoint, b: PathPoint): Segment {
+  return { point: (t) => mix(a, b, t), tangent: () => ({ x: b.x - a.x, y: b.y - a.y }) }
+}
+function bezier(points: readonly PathPoint[]): Segment {
+  const evaluate = (values: readonly PathPoint[], t: number): PathPoint => {
+    let row = [...values]
+    while (row.length > 1) row = row.slice(1).map((p, i) => mix(row[i]!, p, t))
+    return row[0]!
+  }
+  const derivative = points.slice(1).map((p, i) => ({
+    x: (p.x - points[i]!.x) * (points.length - 1),
+    y: (p.y - points[i]!.y) * (points.length - 1),
+  }))
+  return { point: (t) => evaluate(points, t), tangent: (t) => evaluate(derivative, t) }
+}
+
+/** Endpoint-to-center conversion: https://www.w3.org/TR/SVG/implnote.html#ArcConversionEndpointToCenter */
+function arc(
+  a: PathPoint,
+  b: PathPoint,
+  rx: number,
+  ry: number,
+  degrees: number,
+  large: boolean,
+  sweep: boolean,
+): Segment {
+  rx = Math.abs(rx)
+  ry = Math.abs(ry)
+  if (!rx || !ry || distance(a, b) === 0) return line(a, b)
+  const phi = ((degrees % 360) * Math.PI) / 180,
+    cos = Math.cos(phi),
+    sin = Math.sin(phi)
+  const dx = (a.x - b.x) / 2,
+    dy = (a.y - b.y) / 2
+  const xp = cos * dx + sin * dy,
+    yp = -sin * dx + cos * dy
+  const correction = Math.max(1, Math.hypot(xp / rx, yp / ry))
+  rx *= correction
+  ry *= correction
+  const u = xp / rx,
+    v = yp / ry,
+    norm = u * u + v * v
+  const factor = (large === sweep ? -1 : 1) * Math.sqrt(Math.max(0, (1 - norm) / norm))
+  const cxp = factor * rx * v,
+    cyp = -factor * ry * u
+  const cx = cos * cxp - sin * cyp + (a.x + b.x) / 2,
+    cy = sin * cxp + cos * cyp + (a.y + b.y) / 2
+  const ux = (xp - cxp) / rx,
+    uy = (yp - cyp) / ry,
+    vx = (-xp - cxp) / rx,
+    vy = (-yp - cyp) / ry
+  const start = Math.atan2(uy, ux)
+  let delta = Math.atan2(ux * vy - uy * vx, ux * vx + uy * vy)
+  if (!sweep && delta > 0) delta -= 2 * Math.PI
+  if (sweep && delta < 0) delta += 2 * Math.PI
+  if (![cx, cy, rx, ry, start, delta].every(Number.isFinite))
+    throw new RangeError('Path arc exceeds finite geometry limits.')
+  return {
+    point(t) {
+      if (t === 0) return a
+      if (t === 1) return b
+      const angle = start + t * delta,
+        x = rx * Math.cos(angle),
+        y = ry * Math.sin(angle)
+      return checked({ x: cx + cos * x - sin * y, y: cy + sin * x + cos * y })
+    },
+    tangent(t) {
+      const angle = start + t * delta,
+        x = -rx * Math.sin(angle) * delta,
+        y = ry * Math.cos(angle) * delta
+      return { x: cos * x - sin * y, y: sin * x + cos * y }
+    },
+  }
+}
+
+export function parsePath(data: string): MotionPath {
+  if (typeof data !== 'string' || !data.trim())
+    throw new TypeError('Path must be a nonempty SVG path string.')
+  if (data.length > 100_000)
+    throw new RangeError('SVG path is too long (100000 characters maximum).')
+  const scanner = new Scanner(data)
+  const segments: Segment[] = []
+  let current: PathPoint = { x: 0, y: 0 },
+    first: PathPoint | undefined
+  let command = '',
+    previous = '',
+    control: PathPoint = current
+  const add = (segment: Segment, end: PathPoint) => {
+    if (segments.length >= MAX_SEGMENTS)
+      throw new RangeError('SVG path has too many segments (1024 maximum).')
+    segments.push(segment)
+    current = checked(end)
+  }
+  while (scanner.peek() !== undefined) {
+    const token = scanner.peek()!
+    if (/[a-z]/i.test(token)) {
+      command = scanner.command()
+      if (!/[mlhvcsqtaz]/i.test(command)) scanner.error()
+    } else if (!command) scanner.error()
+    const upper = command.toUpperCase(),
+      relative = command !== upper,
+      origin = current
+    const point = () =>
+      checked({
+        x: scanner.number() + (relative ? origin.x : 0),
+        y: scanner.number() + (relative ? origin.y : 0),
+      })
+    if (!first && upper !== 'M') throw new SyntaxError('SVG path must start with M or m.')
+    if (upper === 'M') {
+      if (first)
+        throw new SyntaxError(
+          'Motion paths support one continuous subpath; use a single M command.',
+        )
+      first = current = point()
+      command = relative ? 'l' : 'L'
+    } else if (upper === 'Z') {
+      add(line(current, first!), first!)
+      command = ''
+    } else if (upper === 'L') {
+      const end = point()
+      add(line(current, end), end)
+    } else if (upper === 'H' || upper === 'V') {
+      const n = scanner.number(),
+        end = checked(
+          upper === 'H'
+            ? { x: n + (relative ? origin.x : 0), y: current.y }
+            : { x: current.x, y: n + (relative ? origin.y : 0) },
+        )
+      add(line(current, end), end)
+    } else if (upper === 'C' || upper === 'S') {
+      const c1 =
+        upper === 'C'
+          ? point()
+          : /[CS]/.test(previous)
+            ? { x: 2 * current.x - control.x, y: 2 * current.y - control.y }
+            : current
+      const c2 = point(),
+        end = point()
+      checked(c1)
+      add(bezier([current, c1, c2, end]), end)
+      control = c2
+    } else if (upper === 'Q' || upper === 'T') {
+      const c =
+        upper === 'Q'
+          ? point()
+          : /[QT]/.test(previous)
+            ? { x: 2 * current.x - control.x, y: 2 * current.y - control.y }
+            : current
+      const end = point()
+      checked(c)
+      add(bezier([current, c, end]), end)
+      control = c
+    } else if (upper === 'A') {
+      const rx = scanner.number(),
+        ry = scanner.number(),
+        rotation = scanner.number(),
+        large = scanner.number(true),
+        sweep = scanner.number(true),
+        end = point()
+      add(arc(current, end, rx, ry, rotation, !!large, !!sweep), end)
+    }
+    previous = upper
+  }
+  return measure(first!, segments)
+}
+
+function measure(first: PathPoint, segments: readonly Segment[]): MotionPath {
+  const vertices: Vertex[] = [{ ...first, segment: -1, t: 0, distance: 0, heading: 0 }]
+  const heading = (segment: Segment, t: number, fallback: PathPoint) => {
+    let v = segment.tangent(t)
+    if (Math.hypot(v.x, v.y) < 1e-9) {
+      const a = segment.point(Math.max(0, t - 1e-5)),
+        b = segment.point(Math.min(1, t + 1e-5))
+      v = { x: b.x - a.x, y: b.y - a.y }
+      if (Math.hypot(v.x, v.y) < 1e-9) v = fallback
+    }
+    return (Math.atan2(v.y, v.x) * 180) / Math.PI
+  }
+  const append = (p: PathPoint, index: number, t: number) => {
+    const last = vertices.at(-1)!,
+      length = distance(last, p)
+    if (!length) return
+    if (vertices.length >= MAX_VERTICES)
+      throw new RangeError('Path needs too many geometry samples (8192 maximum).')
+    const direction = { x: p.x - last.x, y: p.y - last.y }
+    const start = heading(
+      segments[index]!,
+      last.segment === index ? last.t : 0,
+      direction,
+    )
+    if (vertices.length === 1) last.heading = start
+    const angle = unwrap(
+      heading(segments[index]!, t, direction),
+      unwrap(start, last.heading),
+    )
+    vertices.push({
+      ...checked(p),
+      segment: index,
+      t,
+      distance: last.distance + length,
+      heading: angle,
+    })
+  }
+  segments.forEach((segment, index) => {
+    const flatten = (
+      t0: number,
+      t1: number,
+      a: PathPoint,
+      b: PathPoint,
+      depth: number,
+    ) => {
+      const span = t1 - t0,
+        q1 = segment.point(t0 + span * 0.25),
+        mid = segment.point(t0 + span * 0.5),
+        q3 = segment.point(t0 + span * 0.75)
+      const poly =
+          distance(a, q1) + distance(q1, mid) + distance(mid, q3) + distance(q3, b),
+        chord = distance(a, b)
+      const deviation = Math.max(
+        distance(q1, mix(a, b, 0.25)),
+        distance(mid, mix(a, b, 0.5)),
+        distance(q3, mix(a, b, 0.75)),
+      )
+      const directions = [
+        t0,
+        t0 + span * 0.25,
+        t0 + span * 0.5,
+        t0 + span * 0.75,
+        t1,
+      ].map((t) => segment.tangent(t))
+      const turn = directions.some((v, i) => {
+        const before = directions[i - 1]
+        return (
+          before &&
+          Math.hypot(v.x, v.y) > 1e-12 &&
+          Math.hypot(before.x, before.y) > 1e-12 &&
+          Math.abs(
+            Math.atan2(before.x * v.y - before.y * v.x, before.x * v.x + before.y * v.y),
+          ) >
+            Math.PI / 8
+        )
+      })
+      const flat = poly - chord <= TOLERANCE && deviation <= TOLERANCE
+      if (flat && (!turn || depth >= 18)) {
+        append(b, index, t1)
+        return
+      }
+      if (depth >= 18)
+        throw new RangeError('Path geometry exceeds the sampling precision limit.')
+      flatten(t0, (t0 + t1) / 2, a, mid, depth + 1)
+      flatten((t0 + t1) / 2, t1, mid, b, depth + 1)
+    }
+    flatten(0, 1, segment.point(0), segment.point(1), 0)
+  })
+  const length = vertices.at(-1)!.distance
+  return {
+    length,
+    at(progress) {
+      if (!length) return { ...first, rotate: 0 }
+      const target = Math.max(0, Math.min(1, progress)) * length
+      let low = 1,
+        high = vertices.length - 1
+      while (low < high) {
+        const middle = (low + high) >>> 1
+        if (vertices[middle]!.distance <= target) low = middle + 1
+        else high = middle
+      }
+      const b = vertices[low]!,
+        a = vertices[low - 1]!,
+        fraction = Math.max(
+          0,
+          Math.min(1, (target - a.distance) / (b.distance - a.distance)),
+        )
+      const point = mix(a, b, fraction),
+        t0 = a.segment === b.segment ? a.t : 0,
+        t = t0 + (b.t - t0) * fraction
+      const angle = heading(segments[b.segment]!, t, { x: b.x - a.x, y: b.y - a.y })
+      return { ...point, rotate: unwrap(angle, b.heading) }
+    },
+  }
+}

package/src/symbol-effect.ts

@@ -0,0 +1,226 @@
+import { Image, ImageSource, isIOS } from '@nativescript/core'
+import { toView } from './animate.js'
+import type { Animation } from './engine.js'
+import type { Target } from './types.js'
+import { reducedMotion } from './config.js'
+
+export type SymbolEffectName = 'bounce' | 'pulse' | 'scale' | 'variableColor'
+
+export type SymbolEffect = SymbolEffectName | { replace: `sys://${string}` }
+
+export interface SymbolEffectOptions {
+  /** Native playback speed multiplier. Defaults to 1. */
+  speed?: number
+  /** Repeat bounce, pulse or variableColor until stopped. Defaults to false. */
+  repeat?: boolean
+}
+
+const running = new WeakMap<Image, SymbolAnimation>()
+const names: readonly string[] = ['bounce', 'pulse', 'scale', 'variableColor']
+
+/**
+ * Plays an iOS 17+ SF Symbol effect on a NativeScript Image.
+ * Scale holds until stopped; replacements also update the Image's src.
+ *
+ * ```ts
+ * symbolEffect(icon, 'bounce')
+ * symbolEffect(icon, { replace: 'sys://heart.fill' })
+ * ```
+ */
+export function symbolEffect(
+  target: Target,
+  effect: SymbolEffect,
+  options: SymbolEffectOptions = {},
+): Animation {
+  const view = toView(target)
+  if (!(view instanceof Image)) throw new TypeError('symbolEffect expects an Image.')
+  if (
+    typeof effect === 'string'
+      ? !names.includes(effect)
+      : !effect ||
+        typeof effect.replace !== 'string' ||
+        !/^sys:\/\/[^\s/]+$/.test(effect.replace)
+  ) {
+    throw new TypeError('Expected a symbol effect name or { replace: "sys://name" }.')
+  }
+  const speed = options.speed ?? 1
+  if (!Number.isFinite(speed) || speed <= 0)
+    throw new RangeError('Symbol effect speed must be a positive finite number.')
+  if (options.repeat !== undefined && typeof options.repeat !== 'boolean')
+    throw new TypeError('Symbol effect repeat must be a boolean.')
+  if (options.repeat && (typeof effect !== 'string' || effect === 'scale'))
+    throw new TypeError('Only bounce, pulse and variableColor can repeat.')
+
+  return new SymbolAnimation(view, effect, speed, options.repeat ?? false)
+}
+
+class SymbolAnimation implements Animation {
+  readonly finished: Promise<boolean>
+  private resolve!: (finished: boolean) => void
+  private settled = false
+  private started = false
+  private changingSource = false
+  private waitingForLoad: boolean
+  private native: UIImageView | undefined
+  private nativeEffect: NSSymbolEffect | undefined
+  private replacement: UIImage | undefined
+
+  constructor(
+    private readonly view: Image,
+    private readonly effect: SymbolEffect,
+    private readonly speed: number,
+    private readonly repeat: boolean,
+  ) {
+    this.finished = new Promise((resolve) => (this.resolve = resolve))
+    this.waitingForLoad = !view.isLoaded
+    running.get(view)?.stop()
+    running.set(view, this)
+    view.on('unloaded', this.stop)
+    view.on('srcChange', this.sourceChanged)
+    view.on('imageSourceChange', this.imageChanged)
+    view.on('loaded', this.loaded)
+    view.on('isLoadingChange', this.start)
+    this.start()
+  }
+
+  then<A = boolean, B = never>(
+    onfulfilled?: ((finished: boolean) => A | PromiseLike<A>) | null,
+    onrejected?: ((reason: unknown) => B | PromiseLike<B>) | null,
+  ): Promise<A | B> {
+    return this.finished.then(onfulfilled, onrejected)
+  }
+
+  stop = () => this.end(false, true)
+
+  private sourceChanged = () => {
+    if (!this.changingSource) this.stop()
+  }
+
+  private imageChanged = () => {
+    if (this.changingSource) return
+    if (this.started) this.stop()
+    else this.start()
+  }
+
+  private loaded = () => {
+    this.waitingForLoad = false
+    this.start()
+  }
+
+  private start = () => {
+    if (this.settled || this.started) return
+    if (!isIOS) return this.end(false)
+    const { view, effect } = this
+    // isLoaded becomes true before NativeScript resumes native property updates.
+    // Wait for the loaded event so intermediate image resets don't start playback.
+    if (
+      this.waitingForLoad ||
+      !view.isLoaded ||
+      !view.nativeViewProtected ||
+      view.isLoading
+    )
+      return
+    this.started = true
+    const native = (this.native = view.nativeViewProtected as UIImageView)
+    const reduced = reducedMotion()
+
+    if (typeof effect !== 'string') {
+      // Resolve first so a symbol absent on this OS doesn't clear the current image.
+      if (!ImageSource.fromSystemImageSync(effect.replace.slice(6))?.ios)
+        return this.end(false)
+      const previous = native.image
+      const loadMode = view.loadMode
+      this.changingSource = true
+      try {
+        // Let NativeScript update its source, tint, configuration and pending loads.
+        // Both assignments happen in this turn, before UIKit draws the next frame.
+        view.loadMode = 'sync'
+        view.src = effect.replace
+      } finally {
+        view.loadMode = loadMode
+        this.changingSource = false
+      }
+      // A source-change listener may have started another effect or changed the src.
+      if (this.settled) return
+      if (view.src !== effect.replace) return this.end(false)
+      const image = native.image
+      if (!image) return this.end(false)
+      if (
+        reduced ||
+        !previous?.symbolImage ||
+        !native.respondsToSelector(
+          'setSymbolImage:withContentTransition:options:completion:',
+        )
+      )
+        return this.end(true)
+
+      this.replacement = image
+      native.image = previous
+      native.setSymbolImageWithContentTransitionOptionsCompletion(
+        image,
+        NSSymbolReplaceContentTransition.transition(),
+        this.options(),
+        this.completed,
+      )
+      return
+    }
+
+    if (
+      reduced ||
+      !native.image?.symbolImage ||
+      !native.respondsToSelector('addSymbolEffect:options:animated:completion:')
+    )
+      return this.end(false)
+
+    const factories = {
+      bounce: NSSymbolBounceEffect,
+      pulse: NSSymbolPulseEffect,
+      scale: NSSymbolScaleEffect,
+      variableColor: NSSymbolVariableColorEffect,
+    }
+    this.nativeEffect = factories[effect].effect()
+    native.addSymbolEffectOptionsAnimatedCompletion(
+      this.nativeEffect,
+      this.options(),
+      true,
+      this.completed,
+    )
+  }
+
+  private options(): NSSymbolEffectOptions {
+    const options = this.repeat
+      ? NSSymbolEffectOptions.optionsWithRepeating()
+      : NSSymbolEffectOptions.optionsWithNonRepeating()
+    return options.optionsWithSpeed(this.speed)
+  }
+
+  private completed = (context: UISymbolEffectCompletionContext) => {
+    // Scale's entrance can complete while the effect is still holding its state.
+    if (context.finished && (this.effect === 'scale' || this.repeat)) return
+    this.end(context.finished)
+  }
+
+  private end(finished: boolean, remove = false) {
+    if (this.settled) return
+    this.settled = true
+    const { view, native, nativeEffect, replacement } = this
+    view.off('loaded', this.loaded)
+    view.off('isLoadingChange', this.start)
+    view.off('unloaded', this.stop)
+    view.off('srcChange', this.sourceChanged)
+    view.off('imageSourceChange', this.imageChanged)
+    if (running.get(view) === this) running.delete(view)
+    if (remove && native) {
+      if (nativeEffect) native.removeSymbolEffectOfType(nativeEffect)
+      // Content transitions have no removal API. Keep the destination icon.
+      if (replacement && native.image === replacement) {
+        native.image = null
+        native.image = replacement
+      }
+    }
+    this.native = undefined
+    this.nativeEffect = undefined
+    this.replacement = undefined
+    this.resolve(finished)
+  }
+}