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

package/src/symbol-effect.ts

@@ -0,0 +1,225 @@
+import { Image, ImageSource, isIOS } from '@nativescript/core'
+import { toView } from './animate.js'
+import type { Animation } from './engine.js'
+import type { Target } from './types.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 reducedMotion = UIAccessibilityIsReduceMotionEnabled()
+
+    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 (
+        reducedMotion ||
+        !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 (
+      reducedMotion ||
+      !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)
+  }
+}

package/src/text-layout.ts

@@ -0,0 +1,216 @@
+/** TextKit lays out the complete string before any glyphs are separated. */
+type Insets = { top: number; left: number; bottom: number; right: number }
+type NativeLabel = UILabel & { padding?: Insets; borderThickness?: Insets }
+const MAX_PIECES = 256
+const MAX_PIXELS = 4_000_000
+
+/** Ligatures and composed characters may share glyphs. Never draw a shared glyph twice. */
+export function mergeGlyphRanges(ranges: readonly NSRange[]): NSRange[] {
+  const merged: NSRange[] = []
+  for (const range of ranges) {
+    if (!range.length) continue
+    const previous = merged.at(-1)
+    if (
+      previous &&
+      range.location < previous.location + previous.length &&
+      range.location + range.length > previous.location
+    ) {
+      const end = Math.max(
+        previous.location + previous.length,
+        range.location + range.length,
+      )
+      previous.location = Math.min(previous.location, range.location)
+      previous.length = end - previous.location
+    } else merged.push({ location: range.location, length: range.length })
+  }
+  return merged
+}
+
+export function textLayer(native: NativeLabel, by: 'letter' | 'word') {
+  if (native.adjustsFontSizeToFitWidth) return undefined
+  const original = native.attributedText
+  const text = original?.string ?? native.text ?? ''
+  if (!text.trim()) return { text, layer: undefined }
+  const string = NSString.stringWithString(text)
+  const full = { location: 0, length: string.length }
+  const attributed = original
+    ? NSMutableAttributedString.alloc().initWithAttributedString(original)
+    : NSMutableAttributedString.alloc().initWithString(text)
+  const paragraph = NSMutableParagraphStyle.new()
+  paragraph.alignment = native.textAlignment
+  paragraph.lineBreakMode = native.lineBreakMode
+  const defaults: [string, unknown][] = [
+    [NSFontAttributeName, native.font],
+    [NSForegroundColorAttributeName, native.textColor],
+    [NSParagraphStyleAttributeName, paragraph],
+  ]
+  if (native.shadowColor) {
+    const shadow = NSShadow.new()
+    shadow.shadowColor = native.shadowColor
+    shadow.shadowOffset = native.shadowOffset
+    defaults.push([NSShadowAttributeName, shadow])
+  }
+  for (const [key, value] of defaults) {
+    attributed.enumerateAttributeInRangeOptionsUsingBlock(
+      key,
+      full,
+      0 as NSAttributedStringEnumerationOptions,
+      (attribute, range) => {
+        if (attribute == null && value != null)
+          attributed.addAttributeValueRange(key, value, range)
+      },
+    )
+  }
+  const inset = (side: keyof Insets) =>
+    (native.padding?.[side] ?? 0) + (native.borderThickness?.[side] ?? 0)
+  const bounds = native.bounds
+  const width = bounds.size.width - inset('left') - inset('right')
+  const height = bounds.size.height - inset('top') - inset('bottom')
+  if (width <= 0 || height <= 0) return undefined
+  const storage = NSTextStorage.alloc().initWithAttributedString(attributed)
+  const manager = NSLayoutManager.new()
+  manager.usesFontLeading = false
+  const container = NSTextContainer.alloc().initWithSize(CGSizeMake(width, height))
+  container.lineFragmentPadding = 0
+  container.maximumNumberOfLines = native.numberOfLines
+  container.lineBreakMode = native.lineBreakMode
+  manager.addTextContainer(container)
+  storage.addLayoutManager(manager)
+  manager.ensureLayoutForTextContainer(container)
+  const visible = manager.glyphRangeForTextContainer(container)
+  if (visible.length !== manager.numberOfGlyphs) return undefined
+  // A truncation token is not an independently addressable character. Keep the real label.
+  for (let glyph = 0; glyph < manager.numberOfGlyphs;) {
+    if (manager.truncatedGlyphRangeInLineFragmentForGlyphAtIndex(glyph).length)
+      return undefined
+    const range = new interop.Reference<NSRange>()
+    manager.lineFragmentRectForGlyphAtIndexEffectiveRange(glyph, range)
+    const next = range.value.location + range.value.length
+    if (next <= glyph) return undefined
+    glyph = next
+  }
+  const characters: NSRange[] = []
+  string.enumerateSubstringsInRangeOptionsUsingBlock(
+    full,
+    by === 'letter' ? 2 : 3,
+    (substring, range) => {
+      if (substring?.trim())
+        characters.push({ location: range.location, length: range.length })
+    },
+  )
+  if (by === 'word') {
+    // Attach spaces and punctuation to the surrounding word, preserving every visible mark.
+    characters.forEach((range, index) => {
+      const start = index === 0 ? 0 : range.location
+      const end = characters[index + 1]?.location ?? full.length
+      range.location = start
+      range.length = end - start
+    })
+    if (!characters.length) characters.push(full)
+  }
+  const ranges = mergeGlyphRanges(
+    characters.map((range) =>
+      manager.glyphRangeForCharacterRangeActualCharacterRange(range, null),
+    ),
+  )
+  if (ranges.length > MAX_PIECES) return undefined
+  const used = manager.usedRectForTextContainer(container)
+  const offsetX = bounds.origin.x + inset('left')
+  const offsetY =
+    bounds.origin.y + inset('top') + (height - used.size.height) / 2 - used.origin.y
+  const scale = native.window?.screen.scale ?? UIScreen.mainScreen.scale
+  const padding = Math.max(4, native.font.pointSize * 0.1)
+  const pieces = ranges.map((range) => {
+    const glyph = manager.boundingRectForGlyphRangeInTextContainer(range, container)
+    return {
+      range,
+      rect: CGRectIntegral(
+        CGRectMake(
+          glyph.origin.x + offsetX - padding,
+          glyph.origin.y + offsetY - padding,
+          glyph.size.width + padding * 2,
+          glyph.size.height + padding * 2,
+        ),
+      ),
+    }
+  })
+  if (
+    pieces.reduce(
+      (pixels, { rect }) => pixels + rect.size.width * rect.size.height * scale * scale,
+      0,
+    ) > MAX_PIXELS
+  )
+    return undefined
+  const layer = CALayer.new()
+  layer.name = 'jolt:text'
+  layer.frame = bounds
+  const transparent = UIColor.clearColor
+  const noShadow = NSShadow.new()
+  noShadow.shadowColor = transparent
+  const hidden = NSMutableAttributedString.alloc().initWithAttributedString(attributed)
+  for (const key of [
+    NSForegroundColorAttributeName,
+    NSBackgroundColorAttributeName,
+    NSUnderlineColorAttributeName,
+    NSStrikethroughColorAttributeName,
+    NSStrokeColorAttributeName,
+  ]) {
+    hidden.addAttributeValueRange(key, transparent, full)
+  }
+  hidden.addAttributeValueRange(NSShadowAttributeName, noShadow, full)
+  let attachments = false
+  attributed.enumerateAttributeInRangeOptionsUsingBlock(
+    NSAttachmentAttributeName,
+    full,
+    0 as NSAttributedStringEnumerationOptions,
+    (value) => {
+      if (value != null) attachments = true
+    },
+  )
+  if (attachments) return undefined
+  const shadowColor = native.shadowColor
+  try {
+    native.shadowColor = null
+    for (const { range, rect } of pieces) {
+      const fragment = NSMutableAttributedString.alloc().initWithAttributedString(hidden)
+      const characters = manager.characterRangeForGlyphRangeActualGlyphRange(range, null)
+      attributed.enumerateAttributesInRangeOptionsUsingBlock(
+        characters,
+        0 as NSAttributedStringEnumerationOptions,
+        (attributes, part) => fragment.setAttributesRange(attributes, part),
+      )
+      native.attributedText = fragment
+      // UILabel draws its own glyphs, preserving its baseline rounding and fallback-font metrics.
+      // Other glyphs keep their shaping/advances but have transparent paint.
+      UIGraphicsBeginImageContextWithOptions(rect.size, false, scale)
+      let image: UIImage | null
+      try {
+        CGContextTranslateCTM(
+          UIGraphicsGetCurrentContext()!,
+          -rect.origin.x,
+          -rect.origin.y,
+        )
+        native.drawTextInRect(bounds)
+        image = UIGraphicsGetImageFromCurrentImageContext()
+      } finally {
+        UIGraphicsEndImageContext()
+      }
+      if (!image?.CGImage) return undefined
+      const piece = CALayer.new()
+      piece.frame = CGRectMake(
+        rect.origin.x - bounds.origin.x,
+        rect.origin.y - bounds.origin.y,
+        rect.size.width,
+        rect.size.height,
+      )
+      piece.contents = image.CGImage
+      piece.contentsScale = scale
+      layer.addSublayer(piece)
+    }
+  } finally {
+    if (original) native.attributedText = original
+    else native.text = text
+    native.shadowColor = shadowColor
+  }
+  return { text, layer }
+}