@reekon-tools/react-native-pdf-canvas 0.1.0

package/dist/web-init.d.ts

@@ -0,0 +1,68 @@
+/**
+ * `@reekon-tools/react-native-pdf-canvas/web-init` — load CanvasKit, then say so.
+ *
+ * WEB ONLY, and the one subpath a web host is expected to await before anything
+ * else in this package renders:
+ *
+ *     import {loadPdfCanvasSkiaWeb} from
+ *       '@reekon-tools/react-native-pdf-canvas/web-init';
+ *
+ *     await loadPdfCanvasSkiaWeb({
+ *       locateFile: file =>
+ *         `https://cdn.jsdelivr.net/npm/canvaskit-wasm@${version}/bin/full/${file}`,
+ *     });
+ *
+ * ------------------------------------------------------------------------
+ * NO URL IS HARDCODED HERE, AND NONE MAY BE ADDED.
+ * ------------------------------------------------------------------------
+ *
+ * `locateFile` is the HOST's. rock-desktop serves CanvasKit from jsdelivr pinned
+ * to the `canvaskit-wasm` version its own tree installed, and a URL baked into
+ * this package would either fight that pin or silently serve a different wasm
+ * than the JS bindings were built against. Same contract as boldr-utils'
+ * `canvasKitOpts.locateFile`, which this mirrors deliberately: a host that
+ * already has one locator should be able to pass the same object to both.
+ *
+ * ------------------------------------------------------------------------
+ * WHY THIS IS AWAITABLE AND WHY THAT MATTERS
+ * ------------------------------------------------------------------------
+ *
+ * On web `Skia` is built ONCE from `global.CanvasKit` at module-evaluation time
+ * and is unrecoverable if that happens too early (see `./skia/skia-api.ts`).
+ * This package never lets that module be evaluated on the import path, so the
+ * remaining requirement is only that CanvasKit exists before the FIRST RASTER —
+ * and this function is how a host guarantees it, with an awaitable it can put in
+ * front of a route, a loader, or a `<Suspense>` boundary.
+ *
+ * ------------------------------------------------------------------------
+ * THIS IS NOT `WithSkiaWeb`, AND `PdfContentView` MUST NOT WRAP ITSELF IN ONE.
+ * ------------------------------------------------------------------------
+ *
+ * `WithSkiaWeb` is a lazy COMPONENT boundary. `PdfContentView` mounts inside
+ * somebody else's `<Group transform={...}>` inside somebody else's `<Canvas>`;
+ * introducing a `Suspense` there would break the Skia subtree, and boldr-utils
+ * already found that `WithSkiaWeb` cannot forward refs through its lazy
+ * boundary (which is why its canvas takes an `imperativeRef` prop instead). A
+ * host that wants a component boundary should put its OWN `WithSkiaWeb` around
+ * the whole canvas; a host that wants a promise uses this.
+ */
+import { installWebSkiaResolver } from './skia/resolve.web.js';
+/**
+ * The subset of `CanvasKitInitOptions` this package passes through.
+ *
+ * Declared locally rather than imported from `canvaskit-wasm`, which is not a
+ * dependency of this package and must not become one — the version that matters
+ * is the HOST's. Structurally compatible with boldr-utils' `CanvasKitOpts`.
+ */
+export interface CanvasKitOpts {
+    locateFile?: (file: string) => string;
+}
+/**
+ * Load CanvasKit and install this package's Skia resolver.
+ *
+ * Idempotent and cheap to call again: `LoadSkiaWeb` returns immediately once
+ * `global.CanvasKit` is set, and memoises its own init promise, so concurrent
+ * callers share one download.
+ */
+export declare function loadPdfCanvasSkiaWeb(opts?: CanvasKitOpts): Promise<void>;
+export { installWebSkiaResolver };

package/dist/web-init.js

@@ -0,0 +1,64 @@
+/**
+ * `@reekon-tools/react-native-pdf-canvas/web-init` — load CanvasKit, then say so.
+ *
+ * WEB ONLY, and the one subpath a web host is expected to await before anything
+ * else in this package renders:
+ *
+ *     import {loadPdfCanvasSkiaWeb} from
+ *       '@reekon-tools/react-native-pdf-canvas/web-init';
+ *
+ *     await loadPdfCanvasSkiaWeb({
+ *       locateFile: file =>
+ *         `https://cdn.jsdelivr.net/npm/canvaskit-wasm@${version}/bin/full/${file}`,
+ *     });
+ *
+ * ------------------------------------------------------------------------
+ * NO URL IS HARDCODED HERE, AND NONE MAY BE ADDED.
+ * ------------------------------------------------------------------------
+ *
+ * `locateFile` is the HOST's. rock-desktop serves CanvasKit from jsdelivr pinned
+ * to the `canvaskit-wasm` version its own tree installed, and a URL baked into
+ * this package would either fight that pin or silently serve a different wasm
+ * than the JS bindings were built against. Same contract as boldr-utils'
+ * `canvasKitOpts.locateFile`, which this mirrors deliberately: a host that
+ * already has one locator should be able to pass the same object to both.
+ *
+ * ------------------------------------------------------------------------
+ * WHY THIS IS AWAITABLE AND WHY THAT MATTERS
+ * ------------------------------------------------------------------------
+ *
+ * On web `Skia` is built ONCE from `global.CanvasKit` at module-evaluation time
+ * and is unrecoverable if that happens too early (see `./skia/skia-api.ts`).
+ * This package never lets that module be evaluated on the import path, so the
+ * remaining requirement is only that CanvasKit exists before the FIRST RASTER —
+ * and this function is how a host guarantees it, with an awaitable it can put in
+ * front of a route, a loader, or a `<Suspense>` boundary.
+ *
+ * ------------------------------------------------------------------------
+ * THIS IS NOT `WithSkiaWeb`, AND `PdfContentView` MUST NOT WRAP ITSELF IN ONE.
+ * ------------------------------------------------------------------------
+ *
+ * `WithSkiaWeb` is a lazy COMPONENT boundary. `PdfContentView` mounts inside
+ * somebody else's `<Group transform={...}>` inside somebody else's `<Canvas>`;
+ * introducing a `Suspense` there would break the Skia subtree, and boldr-utils
+ * already found that `WithSkiaWeb` cannot forward refs through its lazy
+ * boundary (which is why its canvas takes an `imperativeRef` prop instead). A
+ * host that wants a component boundary should put its OWN `WithSkiaWeb` around
+ * the whole canvas; a host that wants a promise uses this.
+ */
+import { LoadSkiaWeb } from '@shopify/react-native-skia/lib/module/web/index.js';
+import { installWebSkiaResolver } from './skia/resolve.web.js';
+/**
+ * Load CanvasKit and install this package's Skia resolver.
+ *
+ * Idempotent and cheap to call again: `LoadSkiaWeb` returns immediately once
+ * `global.CanvasKit` is set, and memoises its own init promise, so concurrent
+ * callers share one download.
+ */
+export async function loadPdfCanvasSkiaWeb(opts) {
+    await LoadSkiaWeb(opts);
+    // AFTER the await, always. Installing the resolver is what clears any api
+    // cached from an earlier, failed attempt.
+    installWebSkiaResolver();
+}
+export { installWebSkiaResolver };

package/ios/Package.swift

@@ -0,0 +1,58 @@
+// swift-tools-version:5.9
+//
+// A SECOND BUILD SYSTEM FOR THE SAME SOURCES, and it earns its keep.
+//
+// `PdfCanvasCore` is the React-free iOS rasterizer. The podspec at the repository
+// root compiles it into a host app; this manifest compiles the identical files
+// for macOS so that `swift test` proves them on a laptop — no device, no
+// simulator, no app, no CocoaPods. That is the same arrangement Android has, where
+// `android/src/main` is a React-free library provable by
+// `./gradlew connectedDebugAndroidTest`, and it exists for the same reason: a bug
+// in the React binding must never be able to hide as a bug in rasterizing.
+//
+// It also enforces a rule that would otherwise be a comment. CoreGraphics and
+// PDFKit exist on macOS; UIKit does not. So a UIKit import anywhere in
+// `PdfCanvasCore` breaks this build immediately, which is exactly when it should
+// break — rather than at the point somebody tries to reuse the core somewhere it
+// cannot go.
+//
+// WHAT IS DELIBERATELY NOT HERE: `PdfCanvasBridge`. It imports `<jsi/jsi.h>` and
+// `<React/RCTBridgeModule.h>`, which come from a pod and cannot be resolved by
+// SwiftPM. Its only build is the podspec's, and its only proof is a device
+// session — which is precisely the split the Android README describes and the
+// reason both platforms name what is unproven.
+//
+// The test target is SWIFT, not Objective-C, which forces the core's public
+// headers to stay importable from Swift: no C++ in a header, no `void *` where a
+// typed pointer belongs, nothing that only an Objective-C++ translation unit can
+// parse. That constraint is worth having on a library whose one C++ file lives on
+// the other side of a protocol.
+
+import PackageDescription
+
+let package = Package(
+  name: "PdfCanvasCore",
+  platforms: [.macOS(.v11), .iOS(.v13)],
+  products: [
+    .library(name: "PdfCanvasCore", targets: ["PdfCanvasCore", "PdfCanvasSlots"])
+  ],
+  targets: [
+    .target(
+      name: "PdfCanvasCore",
+      path: "Sources/PdfCanvasCore",
+      publicHeadersPath: "include"
+    ),
+    .target(
+      name: "PdfCanvasSlots",
+      dependencies: ["PdfCanvasCore"],
+      path: "Sources/PdfCanvasSlots",
+      publicHeadersPath: "include"
+    ),
+    .testTarget(
+      name: "PdfCanvasCoreTests",
+      dependencies: ["PdfCanvasCore", "PdfCanvasSlots"],
+      path: "Tests/PdfCanvasCoreTests"
+    ),
+  ],
+  cxxLanguageStandard: .cxx17
+)