@ansight/react-native-pencil 0.0.0-stage → 1.9.0

package/AnsightReactNativePencil.podspec

@@ -0,0 +1,18 @@
+require "json"
+
+package = JSON.parse(File.read(File.join(__dir__, "package.json")))
+
+Pod::Spec.new do |s|
+  s.name         = "AnsightReactNativePencil"
+  s.version      = package["version"]
+  s.summary      = package["description"]
+  s.homepage     = "https://github.com/ansight-ai/ansight-sdk"
+  s.license      = { :type => "PolyForm Shield 1.0.0", :file => "LICENSE" }
+  s.authors      = { "Ansight" => "dev@ansight.ai" }
+  s.source       = { :path => "." }
+  s.platforms    = { :ios => "15.0" }
+  s.source_files = "ios/**/*.{h,m,mm,swift}"
+  s.dependency "React-Core"
+  s.dependency "AnsightPencil", s.version.to_s
+  s.swift_version = "5.9"
+end

package/LICENSE

@@ -0,0 +1,166 @@
+# PolyForm Shield License 1.0.0
+
+<https://polyformproject.org/licenses/shield/1.0.0>
+
+## Acceptance
+
+In order to get any license under these terms, you must agree
+to them as both strict obligations and conditions to all
+your licenses.
+
+## Copyright License
+
+The licensor grants you a copyright license for the
+software to do everything you might do with the software
+that would otherwise infringe the licensor's copyright
+in it for any permitted purpose.  However, you may
+only distribute the software according to [Distribution
+License](#distribution-license) and make changes or new works
+based on the software according to [Changes and New Works
+License](#changes-and-new-works-license).
+
+## Distribution License
+
+The licensor grants you an additional copyright license
+to distribute copies of the software.  Your license
+to distribute covers distributing the software with
+changes and new works permitted by [Changes and New Works
+License](#changes-and-new-works-license).
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of
+the software from you also gets a copy of these terms or the
+URL for them above, as well as copies of any plain-text lines
+beginning with `Required Notice:` that the licensor provided
+with the software.  For example:
+
+> Required Notice: Copyright Yoyodyne, Inc. (http://example.com)
+
+## Changes and New Works License
+
+The licensor grants you an additional copyright license to
+make changes and new works based on the software for any
+permitted purpose.
+
+## Patent License
+
+The licensor grants you a patent license for the software that
+covers patent claims the licensor can license, or becomes able
+to license, that you would infringe by using the software.
+
+## Noncompete
+
+Any purpose is a permitted purpose, except for providing any
+product that competes with the software or any product the
+licensor or any of its affiliates provides using the software.
+
+## Competition
+
+Goods and services compete even when they provide functionality
+through different kinds of interfaces or for different technical
+platforms.  Applications can compete with services, libraries
+with plugins, frameworks with development tools, and so on,
+even if they're written in different programming languages
+or for different computer architectures.  Goods and services
+compete even when provided free of charge.  If you market a
+product as a practical substitute for the software or another
+product, it definitely competes.
+
+## New Products
+
+If you are using the software to provide a product that does
+not compete, but the licensor or any of its affiliates brings
+your product into competition by providing a new version of
+the software or another product using the software, you may
+continue using versions of the software available under these
+terms beforehand to provide your competing product, but not
+any later versions.
+
+## Discontinued Products
+
+You may begin using the software to compete with a product
+or service that the licensor or any of its affiliates has
+stopped providing, unless the licensor includes a plain-text
+line beginning with `Licensor Line of Business:` with the
+software that mentions that line of business.  For example:
+
+> Licensor Line of Business: YoyodyneCMS Content Management
+System (http://example.com/cms)
+
+## Sales of Business
+
+If the licensor or any of its affiliates sells a line of
+business developing the software or using the software
+to provide a product, the buyer can also enforce
+[Noncompete](#noncompete) for that product.
+
+## Fair Use
+
+You may have "fair use" rights for the software under the
+law. These terms do not limit them.
+
+## No Other Rights
+
+These terms do not allow you to sublicense or transfer any of
+your licenses to anyone else, or prevent the licensor from
+granting licenses to anyone else.  These terms do not imply
+any other licenses.
+
+## Patent Defense
+
+If you make any written claim that the software infringes or
+contributes to infringement of any patent, your patent license
+for the software granted under these terms ends immediately. If
+your company makes such a claim, your patent license ends
+immediately for work on behalf of your company.
+
+## Violations
+
+The first time you are notified in writing that you have
+violated any of these terms, or done anything with the software
+not covered by your licenses, your licenses can nonetheless
+continue if you come into full compliance with these terms,
+and take practical steps to correct past violations, within
+32 days of receiving notice.  Otherwise, all your licenses
+end immediately.
+
+## No Liability
+
+***As far as the law allows, the software comes as is, without
+any warranty or condition, and the licensor will not be liable
+to you for any damages arising out of these terms or the use
+or nature of the software, under any kind of legal claim.***
+
+## Definitions
+
+The **licensor** is the individual or entity offering these
+terms, and the **software** is the software the licensor makes
+available under these terms.
+
+A **product** can be a good or service, or a combination
+of them.
+
+**You** refers to the individual or entity agreeing to these
+terms.
+
+**Your company** is any legal entity, sole proprietorship,
+or other kind of organization that you work for, plus all
+its affiliates.
+
+**Affiliates** means the other organizations than an
+organization has control over, is under the control of, or is
+under common control with.
+
+**Control** means ownership of substantially all the assets of
+an entity, or the power to direct its management and policies
+by vote, contract, or otherwise.  Control can be direct or
+indirect.
+
+**Your licenses** are all the licenses granted to you for the
+software under these terms.
+
+**Use** means anything you do with the software requiring one
+of your licenses.
+
+Required Notice: Copyright (c) 2026 Ansight, Inc. (https://www.ansight.ai)

package/README.md

@@ -1,3 +1,7 @@
-# Temporary Holding Version
+# @ansight/react-native-pencil
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Optional Pencil support for iOS Simulator.
+
+[Documentation: integration, playback, capture, compatibility and package updates](https://www.ansight.ai/docs/sdk/react-native/pencil).
+
+These packages are currently local and unpublished.

package/index.d.ts

@@ -0,0 +1,19 @@
+import type { RefObject } from 'react';
+import type { View, ViewProps, NativeSyntheticEvent, PointerEvent } from 'react-native';
+import type { PenSample } from '@ansight/pencil-runtime';
+export type AnsightPencilEvent = NativeSyntheticEvent<PointerEvent & {
+  ansightPencil?: PenSample & {inputSource: string};
+}>;
+export declare const AnsightPencil: {
+  readonly id: "ansight.pencil";
+  /** Used by createOptionsBuilder().withPlugin(AnsightPencil). */
+  initialize(): Promise<void>;
+  /** Platform capability only. Does not register tools or install hooks. */
+  isSupported(): Promise<boolean>;
+  /** Low-level registration. Prefer withPlugin(AnsightPencil) in the options builder.
+   * Returns false outside iOS Simulator; rejects before initialization.
+   * Idempotent. Grants only Pencil tools; global disable still wins. Does not install hooks. */
+  register(): Promise<boolean>;
+};
+/** Spread the result on the same View as ref. Keeps real handlers and supplies scoped SDK playback. */
+export declare function usePencilSurface(id: string, ref: RefObject<View | null>, handlers: ViewProps): ViewProps;

package/index.js

@@ -0,0 +1,36 @@
+const { NativeModules, Platform } = require("react-native");
+const { createPencilRuntime } = require('@ansight/pencil-runtime');
+const runtime = createPencilRuntime({
+  checkPlayback: () => nativeModule().requirePlayback(),
+  capture: (sample, geometry, pointerId) => nativeModule().capture(JSON.stringify({sample, geometry, pointerId})),
+});
+let frameworkRegistration;
+
+function nativeModule() {
+  const module = NativeModules.AnsightReactNativePencil;
+  if (!module) {
+    throw new Error("Ansight Pencil is not linked. Install @ansight/react-native-pencil, run pod install and rebuild the iOS app.");
+  }
+  return module;
+}
+
+const AnsightPencil = {
+  id: 'ansight.pencil',
+  async initialize() {
+    if (await AnsightPencil.register() && !frameworkRegistration) {
+      const registration = require('@ansight/react-native').registerTool(runtime.definition, args => runtime.handle(args));
+      try { await registration.ready; frameworkRegistration = registration; }
+      catch (error) { await registration.unregister(); throw error; }
+    }
+  },
+  async isSupported() {
+    return Platform.OS === "ios" ? nativeModule().isSupported() : false;
+  },
+  async register() {
+    return Platform.OS === "ios" ? nativeModule().register() : false;
+  },
+};
+function usePencilSurface(id, ref, handlers) {
+  return require('./surface').usePencilSurface(runtime, id, ref, handlers);
+}
+module.exports = { AnsightPencil, usePencilSurface };

package/ios/AnsightReactNativePencil.swift

@@ -0,0 +1,51 @@
+import AnsightPencil
+import Foundation
+import React
+import UIKit
+
+@objc(AnsightReactNativePencil)
+final class AnsightReactNativePencil: NSObject {
+    @objc(hitTest:x:y:resolver:rejecter:)
+    func hitTest(_ identifier: String, x: Double, y: Double, resolver resolve: @escaping RCTPromiseResolveBlock,
+                 rejecter reject: @escaping RCTPromiseRejectBlock) {
+        DispatchQueue.main.async {
+            let windows = UIApplication.shared.connectedScenes.compactMap { $0 as? UIWindowScene }
+                .filter { $0.activationState == .foregroundActive }.flatMap(\.windows).filter(\.isKeyWindow)
+            var matches: [UIView] = []
+            func visit(_ view: UIView) {
+                guard !view.isHidden, view.alpha > 0.01, view.isUserInteractionEnabled else { return }
+                if view.accessibilityIdentifier == identifier { matches.append(view) }
+                view.subviews.forEach(visit)
+            }
+            windows.forEach(visit)
+            guard matches.count == 1, let target = matches.first, let window = target.window,
+                  let hit = window.hitTest(CGPoint(x: x, y: y), with: nil) else { resolve(false); return }
+            resolve(hit === target || hit.isDescendant(of: target))
+        }
+    }
+
+    @objc(requirePlayback:rejecter:)
+    func requirePlayback(_ resolve: RCTPromiseResolveBlock, rejecter reject: RCTPromiseRejectBlock) {
+        do { try AnsightPencil.requireFrameworkPlayback(); resolve(true) }
+        catch { reject("pen_playback_unavailable", error.localizedDescription, error) }
+    }
+
+    @objc(capture:resolver:rejecter:)
+    func capture(_ json: String, resolver resolve: RCTPromiseResolveBlock, rejecter reject: RCTPromiseRejectBlock) {
+        do { try AnsightPencil.captureFrameworkSample(json); resolve(true) }
+        catch { reject("pen_capture_failed", error.localizedDescription, error) }
+    }
+
+    @objc static func requiresMainQueueSetup() -> Bool { false }
+
+    @objc(isSupported:rejecter:)
+    func isSupported(_ resolve: RCTPromiseResolveBlock, rejecter reject: RCTPromiseRejectBlock) {
+        resolve(AnsightPencil.isSupported)
+    }
+
+    @objc(register:rejecter:)
+    func register(_ resolve: RCTPromiseResolveBlock, rejecter reject: RCTPromiseRejectBlock) {
+        do { resolve(try AnsightPencil.register()) }
+        catch { reject("pen_registration_failed", error.localizedDescription, error) }
+    }
+}

package/ios/AnsightReactNativePencilModule.m

@@ -0,0 +1,9 @@
+#import <React/RCTBridgeModule.h>
+
+@interface RCT_EXTERN_MODULE(AnsightReactNativePencil, NSObject)
+RCT_EXTERN_METHOD(hitTest:(NSString *)identifier x:(double)x y:(double)y resolver:(RCTPromiseResolveBlock)resolve rejecter:(RCTPromiseRejectBlock)reject)
+RCT_EXTERN_METHOD(requirePlayback:(RCTPromiseResolveBlock)resolve rejecter:(RCTPromiseRejectBlock)reject)
+RCT_EXTERN_METHOD(capture:(NSString *)json resolver:(RCTPromiseResolveBlock)resolve rejecter:(RCTPromiseRejectBlock)reject)
+RCT_EXTERN_METHOD(isSupported:(RCTPromiseResolveBlock)resolve rejecter:(RCTPromiseRejectBlock)reject)
+RCT_EXTERN_METHOD(register:(RCTPromiseResolveBlock)resolve rejecter:(RCTPromiseRejectBlock)reject)
+@end

package/package.json

@@ -1,6 +1,38 @@
 {
   "name": "@ansight/react-native-pencil",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.9.0",
+  "description": "Optional Ansight Pencil simulation for React Native on iOS Simulator.",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "license": "SEE LICENSE IN LICENSE",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ansight-ai/ansight-sdk.git",
+    "directory": "src/react-native-pencil"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "surface.js",
+    "index.js",
+    "index.d.ts",
+    "ios",
+    "AnsightReactNativePencil.podspec",
+    "react-native.config.js",
+    "README.md",
+    "LICENSE"
+  ],
+  "peerDependencies": {
+    "react": ">=18",
+    "@ansight/react-native": "1.9.0",
+    "react-native": ">=0.72"
+  },
+  "dependencies": {
+    "@ansight/pencil-runtime": "1.9.0"
+  },
+  "scripts": {
+    "check": "node --check index.js && npm test",
+    "test": "node --test test/*.test.js"
+  }
+}

package/react-native.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  dependency: { platforms: { ios: { podspecPath: "AnsightReactNativePencil.podspec" }, android: null } },
+};

package/surface.js

@@ -0,0 +1,63 @@
+const React = require('react');
+const { Dimensions, PixelRatio, findNodeHandle, NativeModules } = require('react-native');
+const { pointerProperties } = require('@ansight/pencil-runtime');
+const names = { down: 'onPointerDown', move: 'onPointerMove', up: 'onPointerUp', cancel: 'onPointerCancel', hoverEnter: 'onPointerEnter', hoverMove: 'onPointerMove', hoverExit: 'onPointerLeave' };
+const touchNames = {down:'onTouchStart',move:'onTouchMove',up:'onTouchEnd',cancel:'onTouchCancel'};
+
+function usePencilSurface(runtime, id, ref, handlers) {
+  const latest = React.useRef(handlers);
+  latest.current = handlers;
+  const real = React.useRef(new Set());
+  React.useEffect(() => {
+    const mountedView = ref.current;
+    const dispose = runtime.bindSurface(id, {
+      validate(samples) {
+        for (const sample of samples) if (typeof latest.current[names[sample.phase]] !== 'function' && typeof latest.current[touchNames[sample.phase]] !== 'function') throw new Error(`The Pencil surface has no handler for ${sample.phase}.`);
+        if (samples.some(sample => sample.phase === 'down') && typeof latest.current.onPointerCancel !== 'function' && typeof latest.current.onTouchCancel !== 'function') throw new Error('Supply onPointerCancel or onTouchCancel so interrupted strokes can be released.');
+      },
+      snapshot: () => new Promise((resolve, reject) => {
+        if (!mountedView || ref.current !== mountedView) { reject(new Error('Pencil view is unmounted or replaced.')); return; }
+        const timer = setTimeout(() => reject(new Error('Pencil view measurement timed out.')), 1000);
+        mountedView.measureInWindow((x, y, width, height) => {
+          clearTimeout(timer);
+          const viewport = Dimensions.get('window');
+          resolve({x, y, width, height, viewportWidth: viewport.width, viewportHeight: viewport.height, scale: PixelRatio.get()});
+        });
+      }),
+      hitTest: point => NativeModules.AnsightReactNativePencil.hitTest(id, point.x, point.y),
+      isBusy: () => real.current.size > 0,
+      dispatch(sample, rect, pointerId) {
+        const callback = latest.current[names[sample.phase]];
+        const touchCallback = latest.current[touchNames[sample.phase]];
+        if (!callback && sample.phase === 'hoverExit') return;
+        if (!callback && !touchCallback) throw new Error(`The Pencil surface has no handler for ${sample.phase}.`);
+        const nativeEvent = { ...pointerProperties(sample, rect, pointerId), target: findNodeHandle(mountedView), timestamp: Date.now() };
+        nativeEvent.locationX = nativeEvent.clientX - rect.x;
+        nativeEvent.locationY = nativeEvent.clientY - rect.y;
+        nativeEvent.offsetX = nativeEvent.locationX;
+        nativeEvent.offsetY = nativeEvent.locationY;
+        let stopped = false, prevented = false;
+        const event = { nativeEvent, target: nativeEvent.target, currentTarget: nativeEvent.target, timeStamp: nativeEvent.timestamp,
+          type: names[sample.phase].slice(2).toLowerCase(), eventPhase: 2,
+          bubbles: true, cancelable: true, isTrusted: false, get defaultPrevented() { return prevented; },
+          preventDefault() { prevented = true; }, stopPropagation() { stopped = true; }, persist() {},
+          isDefaultPrevented: () => prevented, isPropagationStopped: () => stopped };
+        callback?.(event);
+        if (touchCallback) {
+          const touch = {...nativeEvent, identifier: pointerId, force: sample.pressure};
+          touchCallback({...event, type: touchNames[sample.phase].slice(2).toLowerCase(), nativeEvent: {
+            ...touch, changedTouches:[touch], touches:['up','cancel'].includes(sample.phase) ? [] : [touch],
+          }});
+        }
+      },
+      onError: error => console.error('Ansight Pencil cleanup failed', error),
+    });
+    return () => { dispose().catch(error => console.error('Ansight Pencil cleanup failed', error)); };
+  }, [runtime, id, ref]);
+  return { ...handlers, testID: id, collapsable: false,
+    onTouchStart(event) { for (const touch of event.nativeEvent.changedTouches) real.current.add(touch.identifier); handlers.onTouchStart?.(event); },
+    onTouchEnd(event) { for (const touch of event.nativeEvent.changedTouches) real.current.delete(touch.identifier); handlers.onTouchEnd?.(event); },
+    onTouchCancel(event) { for (const touch of event.nativeEvent.changedTouches) real.current.delete(touch.identifier); handlers.onTouchCancel?.(event); },
+  };
+}
+module.exports = { usePencilSurface };