react-native-nitro-web-image 0.5.0-beta.5

package/package.json

@@ -0,0 +1,113 @@
+{
+    "name": "react-native-nitro-web-image",
+    "version": "0.5.0-beta.5",
+    "description": "react-native-nitro-web-image",
+    "main": "lib/commonjs/index",
+    "module": "lib/module/index",
+    "types": "lib/typescript/index.d.ts",
+    "react-native": "src/index",
+    "source": "src/index",
+    "workspaces": [
+        "example"
+    ],
+    "files": [
+        "src",
+        "react-native.config.js",
+        "lib",
+        "nitrogen",
+        "android/build.gradle",
+        "android/gradle.properties",
+        "android/CMakeLists.txt",
+        "android/src",
+        "ios/**/*.h",
+        "ios/**/*.m",
+        "ios/**/*.mm",
+        "ios/**/*.cpp",
+        "ios/**/*.swift",
+        "app.plugin.js",
+        "nitro.json",
+        "*.podspec",
+        "README.md"
+    ],
+    "scripts": {
+        "build": "rm -rf lib && bun typecheck && bob build",
+        "postinstall": "tsc || exit 0;",
+        "typecheck": "tsc --noEmit",
+        "clean": "rm -rf android/build node_modules/**/android/build lib",
+        "lint": "biome check . --fix",
+        "lint-ci": "biome check .",
+        "release": "release-it",
+        "typescript": "tsc",
+        "specs": "tsc && nitro-codegen --logLevel=\"debug\""
+    },
+    "keywords": [
+        "react-native",
+        "nitro"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/mrousavy/react-native-nitro-web-image.git"
+    },
+    "author": "Marc Rousavy <me@mrousavy.com> (https://github.com/mrousavy)",
+    "license": "MIT",
+    "bugs": {
+        "url": "https://github.com/mrousavy/react-native-nitro-web-image/issues"
+    },
+    "homepage": "https://github.com/mrousavy/react-native-nitro-web-image#readme",
+    "publishConfig": {
+        "registry": "https://registry.npmjs.org/"
+    },
+    "devDependencies": {
+        "@biomejs/biome": "2.1.1",
+        "@release-it/conventional-changelog": "^8.0.2",
+        "@types/react": "^19.0.6",
+        "nitro-codegen": "^0.27.2",
+        "react": "19.1.0",
+        "react-native": "0.80.2",
+        "react-native-nitro-modules": "^0.27.2",
+        "react-native-nitro-image": "../react-native-nitro-image",
+        "release-it": "^17.10.0",
+        "typescript": "^5.5.4"
+    },
+    "peerDependencies": {
+        "react": "*",
+        "react-native": "*",
+        "react-native-nitro-modules": "*",
+        "react-native-nitro-image": "*"
+    },
+    "prettier": {
+        "quoteProps": "consistent",
+        "singleQuote": true,
+        "tabWidth": 2,
+        "trailingComma": "es5",
+        "useTabs": false,
+        "semi": false
+    },
+    "react-native-builder-bob": {
+        "source": "src",
+        "output": "lib",
+        "targets": [
+            "commonjs",
+            "module",
+            [
+                "typescript",
+                {
+                    "project": "tsconfig.build.json"
+                }
+            ]
+        ]
+    },
+    "release-it": {
+        "npm": {
+            "publish": true
+        },
+        "git": false,
+        "github": {
+            "release": false
+        },
+        "hooks": {
+            "before:init": "bun typecheck && bun lint",
+            "after:bump": "bun run build"
+        }
+    }
+}

package/react-native.config.js

@@ -0,0 +1,16 @@
+// https://github.com/react-native-community/cli/blob/main/docs/dependencies.md
+
+module.exports = {
+    dependency: {
+        platforms: {
+            /**
+             * @type {import('@react-native-community/cli-types').IOSDependencyParams}
+             */
+            ios: {},
+            /**
+             * @type {import('@react-native-community/cli-types').AndroidDependencyParams}
+             */
+            android: {},
+        },
+    },
+};

package/src/index.ts

@@ -0,0 +1,5 @@
+import { NitroModules } from "react-native-nitro-modules";
+import type { WebImageFactory } from "./specs/WebImageFactory.nitro";
+
+export const WebImages =
+    NitroModules.createHybridObject<WebImageFactory>("WebImageFactory");

package/src/specs/WebImageFactory.nitro.ts

@@ -0,0 +1,76 @@
+import type { Image, ImageLoader } from "react-native-nitro-image";
+import type { HybridObject } from "react-native-nitro-modules";
+
+export type AsyncImagePriority = "low" | "default" | "high";
+
+export interface AsyncImageLoadOptions {
+    /**
+     * Specifies the priority of the image download.
+     * @default 'default'
+     */
+    priority?: AsyncImagePriority;
+
+    /**
+     * Forces a cache refresh even if the URL is changed.
+     * Use this if you cannot make your URLs static.
+     * @default false
+     */
+    forceRefresh?: boolean;
+
+    /**
+     * A custom cache key to use for the image. By default, the URL is used as a cache key.
+     * For customized access control/caching, provide a custom cache key.
+     * @default The URL of the image.
+     */
+    cacheKey?: string;
+
+    /**
+     * Allows the Image download to continue even when the app is backgrounded.
+     * @default false
+     */
+    continueInBackground?: boolean;
+
+    /**
+     * Enable to allow untrusted SSL certificates.
+     * @default false
+     */
+    allowInvalidSSLCertificates?: boolean;
+
+    /**
+     * Scales down larger images to respect the device's memory constraints (max. 60 MB, or 4096x4096)
+     * @default false
+     */
+    scaleDownLargeImages?: boolean;
+
+    /**
+     * By default, cached images are queried from memory **asynchronously** to avoid UI lag.
+     * If this flag is enabled, images are queried **synchronously** from memory.
+     * @default false
+     */
+    queryMemoryDataSync?: boolean;
+    /**
+     * By default, cached images are queried from disk **asynchronously** to avoid UI lag.
+     * If this flag is enabled, images are queried **synchronously** from disk.
+     * @default false
+     */
+    queryDiskDataSync?: boolean;
+
+    /**
+     * By default, images are decoded from binary data to actual image representations.
+     * Disabling this might speed up downloads, but could increase memory usage.
+     * @default true
+     */
+    decodeImage?: boolean;
+}
+
+export interface WebImageFactory
+    extends HybridObject<{ ios: "swift"; android: "kotlin" }> {
+    createWebImageLoader(
+        url: string,
+        options?: AsyncImageLoadOptions,
+    ): ImageLoader;
+    loadFromURLAsync(
+        url: string,
+        options?: AsyncImageLoadOptions,
+    ): Promise<Image>;
+}