react-native-hls-cache 0.1.0

package/nitrogen/generated/ios/swift/HybridHlsCacheSpec_cxx.swift

@@ -0,0 +1,237 @@
+///
+/// HybridHlsCacheSpec_cxx.swift
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+import NitroModules
+
+/**
+ * A class implementation that bridges HybridHlsCacheSpec over to C++.
+ * In C++, we cannot use Swift protocols - so we need to wrap it in a class to make it strongly defined.
+ *
+ * Also, some Swift types need to be bridged with special handling:
+ * - Enums need to be wrapped in Structs, otherwise they cannot be accessed bi-directionally (Swift bug: https://github.com/swiftlang/swift/issues/75330)
+ * - Other HybridObjects need to be wrapped/unwrapped from the Swift TCxx wrapper
+ * - Throwing methods need to be wrapped with a Result<T, Error> type, as exceptions cannot be propagated to C++
+ */
+open class HybridHlsCacheSpec_cxx {
+  /**
+   * The Swift <> C++ bridge's namespace (`margelo::nitro::hlscache::bridge::swift`)
+   * from `HlsCache-Swift-Cxx-Bridge.hpp`.
+   * This contains specialized C++ templates, and C++ helper functions that can be accessed from Swift.
+   */
+  public typealias bridge = margelo.nitro.hlscache.bridge.swift
+
+  /**
+   * Holds an instance of the `HybridHlsCacheSpec` Swift protocol.
+   */
+  private var __implementation: any HybridHlsCacheSpec
+
+  /**
+   * Holds a weak pointer to the C++ class that wraps the Swift class.
+   */
+  private var __cxxPart: bridge.std__weak_ptr_HybridHlsCacheSpec_
+
+  /**
+   * Create a new `HybridHlsCacheSpec_cxx` that wraps the given `HybridHlsCacheSpec`.
+   * All properties and methods bridge to C++ types.
+   */
+  public init(_ implementation: any HybridHlsCacheSpec) {
+    self.__implementation = implementation
+    self.__cxxPart = .init()
+    /* no base class */
+  }
+
+  /**
+   * Get the actual `HybridHlsCacheSpec` instance this class wraps.
+   */
+  @inline(__always)
+  public func getHybridHlsCacheSpec() -> any HybridHlsCacheSpec {
+    return __implementation
+  }
+
+  /**
+   * Casts this instance to a retained unsafe raw pointer.
+   * This acquires one additional strong reference on the object!
+   */
+  public func toUnsafe() -> UnsafeMutableRawPointer {
+    return Unmanaged.passRetained(self).toOpaque()
+  }
+
+  /**
+   * Casts an unsafe pointer to a `HybridHlsCacheSpec_cxx`.
+   * The pointer has to be a retained opaque `Unmanaged<HybridHlsCacheSpec_cxx>`.
+   * This removes one strong reference from the object!
+   */
+  public class func fromUnsafe(_ pointer: UnsafeMutableRawPointer) -> HybridHlsCacheSpec_cxx {
+    return Unmanaged<HybridHlsCacheSpec_cxx>.fromOpaque(pointer).takeRetainedValue()
+  }
+
+  /**
+   * Gets (or creates) the C++ part of this Hybrid Object.
+   * The C++ part is a `std::shared_ptr<HybridHlsCacheSpec>`.
+   */
+  public func getCxxPart() -> bridge.std__shared_ptr_HybridHlsCacheSpec_ {
+    let cachedCxxPart = self.__cxxPart.lock()
+    if Bool(fromCxx: cachedCxxPart) {
+      return cachedCxxPart
+    } else {
+      let newCxxPart = bridge.create_std__shared_ptr_HybridHlsCacheSpec_(self.toUnsafe())
+      __cxxPart = bridge.weakify_std__shared_ptr_HybridHlsCacheSpec_(newCxxPart)
+      return newCxxPart
+    }
+  }
+
+  
+
+  /**
+   * Get the memory size of the Swift class (plus size of any other allocations)
+   * so the JS VM can properly track it and garbage-collect the JS object if needed.
+   */
+  @inline(__always)
+  public var memorySize: Int {
+    return MemoryHelper.getSizeOf(self.__implementation) + self.__implementation.memorySize
+  }
+
+  /**
+   * Compares this object with the given [other] object for reference equality.
+   */
+  @inline(__always)
+  public func equals(other: HybridHlsCacheSpec_cxx) -> Bool {
+    return self.__implementation === other.__implementation
+  }
+
+  /**
+   * Call dispose() on the Swift class.
+   * This _may_ be called manually from JS.
+   */
+  @inline(__always)
+  public func dispose() {
+    self.__implementation.dispose()
+  }
+
+  /**
+   * Call toString() on the Swift class.
+   */
+  @inline(__always)
+  public func toString() -> String {
+    return self.__implementation.toString()
+  }
+
+  // Properties
+  
+
+  // Methods
+  @inline(__always)
+  public final func startServer(port: bridge.std__optional_double_, maxCacheSize: bridge.std__optional_double_, headOnlyCache: bridge.std__optional_bool_) -> bridge.Result_void_ {
+    do {
+      try self.__implementation.startServer(port: { () -> Double? in
+        if bridge.has_value_std__optional_double_(port) {
+          let __unwrapped = bridge.get_std__optional_double_(port)
+          return __unwrapped
+        } else {
+          return nil
+        }
+      }(), maxCacheSize: { () -> Double? in
+        if bridge.has_value_std__optional_double_(maxCacheSize) {
+          let __unwrapped = bridge.get_std__optional_double_(maxCacheSize)
+          return __unwrapped
+        } else {
+          return nil
+        }
+      }(), headOnlyCache: { () -> Bool? in
+        if bridge.has_value_std__optional_bool_(headOnlyCache) {
+          let __unwrapped = bridge.get_std__optional_bool_(headOnlyCache)
+          return __unwrapped
+        } else {
+          return nil
+        }
+      }())
+      return bridge.create_Result_void_()
+    } catch (let __error) {
+      let __exceptionPtr = __error.toCpp()
+      return bridge.create_Result_void_(__exceptionPtr)
+    }
+  }
+  
+  @inline(__always)
+  public final func convertUrl(url: std.string, isCacheable: bridge.std__optional_bool_) -> bridge.Result_std__string_ {
+    do {
+      let __result = try self.__implementation.convertUrl(url: String(url), isCacheable: { () -> Bool? in
+        if bridge.has_value_std__optional_bool_(isCacheable) {
+          let __unwrapped = bridge.get_std__optional_bool_(isCacheable)
+          return __unwrapped
+        } else {
+          return nil
+        }
+      }())
+      let __resultCpp = std.string(__result)
+      return bridge.create_Result_std__string_(__resultCpp)
+    } catch (let __error) {
+      let __exceptionPtr = __error.toCpp()
+      return bridge.create_Result_std__string_(__exceptionPtr)
+    }
+  }
+  
+  @inline(__always)
+  public final func clearCache() -> bridge.Result_std__shared_ptr_Promise_void___ {
+    do {
+      let __result = try self.__implementation.clearCache()
+      let __resultCpp = { () -> bridge.std__shared_ptr_Promise_void__ in
+        let __promise = bridge.create_std__shared_ptr_Promise_void__()
+        let __promiseHolder = bridge.wrap_std__shared_ptr_Promise_void__(__promise)
+        __result
+          .then({ __result in __promiseHolder.resolve() })
+          .catch({ __error in __promiseHolder.reject(__error.toCpp()) })
+        return __promise
+      }()
+      return bridge.create_Result_std__shared_ptr_Promise_void___(__resultCpp)
+    } catch (let __error) {
+      let __exceptionPtr = __error.toCpp()
+      return bridge.create_Result_std__shared_ptr_Promise_void___(__exceptionPtr)
+    }
+  }
+  
+  @inline(__always)
+  public final func prefetch(url: std.string, segmentCount: bridge.std__optional_double_) -> bridge.Result_std__string_ {
+    do {
+      let __result = try self.__implementation.prefetch(url: String(url), segmentCount: { () -> Double? in
+        if bridge.has_value_std__optional_double_(segmentCount) {
+          let __unwrapped = bridge.get_std__optional_double_(segmentCount)
+          return __unwrapped
+        } else {
+          return nil
+        }
+      }())
+      let __resultCpp = std.string(__result)
+      return bridge.create_Result_std__string_(__resultCpp)
+    } catch (let __error) {
+      let __exceptionPtr = __error.toCpp()
+      return bridge.create_Result_std__string_(__exceptionPtr)
+    }
+  }
+  
+  @inline(__always)
+  public final func cancelPrefetch(taskId: std.string) -> bridge.Result_void_ {
+    do {
+      try self.__implementation.cancelPrefetch(taskId: String(taskId))
+      return bridge.create_Result_void_()
+    } catch (let __error) {
+      let __exceptionPtr = __error.toCpp()
+      return bridge.create_Result_void_(__exceptionPtr)
+    }
+  }
+  
+  @inline(__always)
+  public final func cancelAllPrefetch() -> bridge.Result_void_ {
+    do {
+      try self.__implementation.cancelAllPrefetch()
+      return bridge.create_Result_void_()
+    } catch (let __error) {
+      let __exceptionPtr = __error.toCpp()
+      return bridge.create_Result_void_(__exceptionPtr)
+    }
+  }
+}

package/nitrogen/generated/shared/c++/HybridHlsCacheSpec.cpp

@@ -0,0 +1,26 @@
+///
+/// HybridHlsCacheSpec.cpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+#include "HybridHlsCacheSpec.hpp"
+
+namespace margelo::nitro::hlscache {
+
+  void HybridHlsCacheSpec::loadHybridMethods() {
+    // load base methods/properties
+    HybridObject::loadHybridMethods();
+    // load custom methods/properties
+    registerHybrids(this, [](Prototype& prototype) {
+      prototype.registerHybridMethod("startServer", &HybridHlsCacheSpec::startServer);
+      prototype.registerHybridMethod("convertUrl", &HybridHlsCacheSpec::convertUrl);
+      prototype.registerHybridMethod("clearCache", &HybridHlsCacheSpec::clearCache);
+      prototype.registerHybridMethod("prefetch", &HybridHlsCacheSpec::prefetch);
+      prototype.registerHybridMethod("cancelPrefetch", &HybridHlsCacheSpec::cancelPrefetch);
+      prototype.registerHybridMethod("cancelAllPrefetch", &HybridHlsCacheSpec::cancelAllPrefetch);
+    });
+  }
+
+} // namespace margelo::nitro::hlscache

package/nitrogen/generated/shared/c++/HybridHlsCacheSpec.hpp

@@ -0,0 +1,69 @@
+///
+/// HybridHlsCacheSpec.hpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+#pragma once
+
+#if __has_include(<NitroModules/HybridObject.hpp>)
+#include <NitroModules/HybridObject.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+
+
+
+#include <optional>
+#include <string>
+#include <NitroModules/Promise.hpp>
+
+namespace margelo::nitro::hlscache {
+
+  using namespace margelo::nitro;
+
+  /**
+   * An abstract base class for `HlsCache`
+   * Inherit this class to create instances of `HybridHlsCacheSpec` in C++.
+   * You must explicitly call `HybridObject`'s constructor yourself, because it is virtual.
+   * @example
+   * ```cpp
+   * class HybridHlsCache: public HybridHlsCacheSpec {
+   * public:
+   *   HybridHlsCache(...): HybridObject(TAG) { ... }
+   *   // ...
+   * };
+   * ```
+   */
+  class HybridHlsCacheSpec: public virtual HybridObject {
+    public:
+      // Constructor
+      explicit HybridHlsCacheSpec(): HybridObject(TAG) { }
+
+      // Destructor
+      ~HybridHlsCacheSpec() override = default;
+
+    public:
+      // Properties
+      
+
+    public:
+      // Methods
+      virtual void startServer(std::optional<double> port, std::optional<double> maxCacheSize, std::optional<bool> headOnlyCache) = 0;
+      virtual std::string convertUrl(const std::string& url, std::optional<bool> isCacheable) = 0;
+      virtual std::shared_ptr<Promise<void>> clearCache() = 0;
+      virtual std::string prefetch(const std::string& url, std::optional<double> segmentCount) = 0;
+      virtual void cancelPrefetch(const std::string& taskId) = 0;
+      virtual void cancelAllPrefetch() = 0;
+
+    protected:
+      // Hybrid Setup
+      void loadHybridMethods() override;
+
+    protected:
+      // Tag for logging
+      static constexpr auto TAG = "HlsCache";
+  };
+
+} // namespace margelo::nitro::hlscache

package/package.json

@@ -0,0 +1,174 @@
+{
+  "name": "react-native-hls-cache",
+  "version": "0.1.0",
+  "description": "HSL",
+  "main": "./lib/module/index.js",
+  "types": "./lib/typescript/src/index.d.ts",
+  "exports": {
+    ".": {
+      "source": "./src/index.tsx",
+      "types": "./lib/typescript/src/index.d.ts",
+      "default": "./lib/module/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "src",
+    "lib",
+    "android",
+    "ios",
+    "cpp",
+    "nitrogen",
+    "nitro.json",
+    "*.podspec",
+    "react-native.config.js",
+    "!ios/build",
+    "!android/build",
+    "!android/gradle",
+    "!android/gradlew",
+    "!android/gradlew.bat",
+    "!android/local.properties",
+    "!**/__tests__",
+    "!**/__fixtures__",
+    "!**/__mocks__",
+    "!**/.*"
+  ],
+  "scripts": {
+    "example": "yarn workspace react-native-hls-cache-example",
+    "clean": "del-cli lib",
+    "prepare": "bob build",
+    "nitrogen": "nitrogen",
+    "typecheck": "tsc",
+    "release": "release-it --only-version",
+    "test": "jest",
+    "lint": "eslint \"**/*.{js,ts,tsx}\""
+  },
+  "keywords": [
+    "react-native",
+    "ios",
+    "android"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/chanphiromsok/react-native-hls-cache.git"
+  },
+  "author": "Rom <chanphiromsok2109@gmail.com> (https://github.com/chanphiromsok)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/chanphiromsok/react-native-hls-cache/issues"
+  },
+  "homepage": "https://github.com/chanphiromsok/react-native-hls-cache#readme",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "devDependencies": {
+    "@commitlint/config-conventional": "^19.8.1",
+    "@eslint/compat": "^1.3.2",
+    "@eslint/eslintrc": "^3.3.1",
+    "@eslint/js": "^9.35.0",
+    "@react-native/babel-preset": "0.83.0",
+    "@react-native/eslint-config": "0.83.0",
+    "@release-it/conventional-changelog": "^10.0.1",
+    "@types/jest": "^29.5.14",
+    "@types/react": "^19.1.12",
+    "commitlint": "^19.8.1",
+    "del-cli": "^6.0.0",
+    "eslint": "^9.35.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.4",
+    "jest": "^29.7.0",
+    "lefthook": "^2.0.3",
+    "nitrogen": "^0.35.2",
+    "prettier": "^2.8.8",
+    "react": "19.2.0",
+    "react-native": "0.83.2",
+    "react-native-builder-bob": "^0.40.18",
+    "react-native-nitro-modules": "^0.35.2",
+    "release-it": "^19.0.4",
+    "turbo": "^2.5.6",
+    "typescript": "^5.9.2"
+  },
+  "peerDependencies": {
+    "react": "*",
+    "react-native": "*",
+    "react-native-nitro-modules": "^0.35.2"
+  },
+  "workspaces": [
+    "example"
+  ],
+  "packageManager": "yarn@4.11.0",
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      [
+        "custom",
+        {
+          "script": "nitrogen",
+          "clean": "nitrogen/"
+        }
+      ],
+      [
+        "module",
+        {
+          "esm": true
+        }
+      ],
+      [
+        "typescript",
+        {
+          "project": "tsconfig.build.json"
+        }
+      ]
+    ]
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "release-it": {
+    "git": {
+      "commitMessage": "chore: release ${version}",
+      "tagName": "v${version}"
+    },
+    "npm": {
+      "publish": true
+    },
+    "github": {
+      "release": true
+    },
+    "plugins": {
+      "@release-it/conventional-changelog": {
+        "preset": {
+          "name": "angular"
+        }
+      }
+    }
+  },
+  "jest": {
+    "preset": "react-native",
+    "modulePathIgnorePatterns": [
+      "<rootDir>/example/node_modules",
+      "<rootDir>/lib/"
+    ]
+  },
+  "prettier": {
+    "quoteProps": "consistent",
+    "singleQuote": true,
+    "tabWidth": 2,
+    "trailingComma": "es5",
+    "useTabs": false
+  },
+  "create-react-native-library": {
+    "type": "nitro-module",
+    "languages": "kotlin-swift",
+    "tools": [
+      "lefthook",
+      "release-it",
+      "jest",
+      "eslint"
+    ],
+    "version": "0.57.2"
+  }
+}

package/src/HlsCache.nitro.ts

@@ -0,0 +1,15 @@
+import type { HybridObject } from 'react-native-nitro-modules';
+
+export interface HlsCache
+  extends HybridObject<{ ios: 'swift'; android: 'kotlin' }> {
+  startServer(
+    port?: number,
+    maxCacheSize?: number,
+    headOnlyCache?: boolean
+  ): void;
+  convertUrl(url: string, isCacheable?: boolean): string;
+  clearCache(): Promise<void>;
+  prefetch(url: string, segmentCount?: number): string;
+  cancelPrefetch(taskId: string): void;
+  cancelAllPrefetch(): void;
+}

package/src/index.tsx

@@ -0,0 +1,75 @@
+import { NitroModules } from 'react-native-nitro-modules';
+import { Platform } from 'react-native';
+import type { HlsCache } from './HlsCache.nitro';
+
+let _instance: HlsCache | null = null;
+
+function getInstance(): HlsCache {
+  if (_instance == null) {
+    _instance = NitroModules.createHybridObject<HlsCache>('HlsCache');
+  }
+  return _instance;
+}
+
+/**
+ * Starts the local HLS proxy server.
+ *
+ * @param port - Local port to bind. Defaults to 9000.
+ * @param maxCacheSize - Max disk cache size in bytes. Defaults to 1 GB.
+ * @param headOnlyCache - If true, only caches the first ~3 segments per video (optimised for vertical feeds).
+ */
+export function startServer(
+  port?: number,
+  maxCacheSize?: number,
+  headOnlyCache?: boolean
+): void {
+  if (Platform.OS !== 'ios') return;
+  getInstance().startServer(port, maxCacheSize, headOnlyCache);
+}
+
+/**
+ * Rewrites a remote URL to route through the local proxy (iOS only).
+ * Returns the original URL unchanged on Android/Web or when the server is not running.
+ *
+ * @param url - Remote HLS URL (e.g. `https://cdn.example.com/video.m3u8`).
+ * @param isCacheable - Set to `false` to bypass the proxy. Defaults to `true`.
+ */
+export function convertUrl(url: string, isCacheable?: boolean): string {
+  if (Platform.OS !== 'ios') return url;
+  return getInstance().convertUrl(url, isCacheable);
+}
+
+/**
+ * Purges all cached video files from disk.
+ */
+export function clearCache(): Promise<void> {
+  if (Platform.OS !== 'ios') return Promise.resolve();
+  return getInstance().clearCache();
+}
+
+/**
+ * Prefetches an HLS stream into the local cache in the background.
+ * Downloads the manifest + first `segmentCount` segments (default: 3).
+ *
+ * @returns A taskId that can be passed to `cancelPrefetch` to stop the download.
+ */
+export function prefetch(url: string, segmentCount?: number): string {
+  if (Platform.OS !== 'ios') return '';
+  return getInstance().prefetch(url, segmentCount);
+}
+
+/**
+ * Cancels a specific prefetch task by its taskId.
+ */
+export function cancelPrefetch(taskId: string): void {
+  if (Platform.OS !== 'ios') return;
+  getInstance().cancelPrefetch(taskId);
+}
+
+/**
+ * Cancels all active prefetch tasks.
+ */
+export function cancelAllPrefetch(): void {
+  if (Platform.OS !== 'ios') return;
+  getInstance().cancelAllPrefetch();
+}