react-native-jieba 0.2.0 → 0.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-jieba",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "Native Chinese text segmentation for React Native, powered by cppjieba.",
   "main": "./lib/module/index.js",
   "types": "./lib/typescript/src/index.d.ts",
@@ -15,6 +15,9 @@
   "files": [
     "src",
     "lib",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE",
     "android/build.gradle",
     "android/CMakeLists.txt",
     "android/generated",
@@ -23,6 +26,10 @@
     "ios/generated",
     "cpp/JiebaImpl.h",
     "cpp/JiebaImpl.cpp",
+    "cpp/JiebaEngine.h",
+    "cpp/JiebaEngine.cpp",
+    "cpp/JiebaDictAndroid.h",
+    "cpp/JiebaDictAndroid.cpp",
     "cpp/cppjieba/LICENSE",
     "cpp/cppjieba/include/cppjieba",
     "cpp/cppjieba/deps/limonp/LICENSE",

package/src/NativeJieba.ts

@@ -1,6 +1,7 @@
 import { TurboModuleRegistry, type TurboModule } from 'react-native';
 
 export interface Spec extends TurboModule {
+  isReady(): boolean;
   setDictPath(path: string): void;
   cut(sentence: string, hmm: boolean): string[];
   cutAll(sentence: string): string[];

package/src/NativeJieba.web.ts

@@ -3,7 +3,7 @@ import type { Spec } from './NativeJieba';
 // `jieba-wasm` exposes the same segmentation primitives as cppjieba, but a
 // smaller surface: cut / cutAll / cutForSearch / tag / add_word. The remaining
 // native methods are polyfilled on top of those where the semantics allow, and
-// throw otherwise. The wasm module is loaded lazily by `initJieba()` (see
+// throw otherwise. The wasm module is loaded lazily by `prepareJieba()` (see
 // `init.web.ts`) and handed to this shim via `setJiebaWasm`.
 
 export type JiebaWasmModule = {
@@ -23,17 +23,25 @@ export function setJiebaWasm(module: JiebaWasmModule): void {
   wasm = module;
 }
 
+export function isJiebaWasmReady(): boolean {
+  return wasm !== null;
+}
+
 function getWasm(): JiebaWasmModule {
   if (!wasm) {
     throw new Error(
-      'react-native-jieba: jieba-wasm is not initialized. ' +
-        'Call (and await) initJieba() before any segmentation call.'
+      'react-native-jieba: jieba-wasm is not loaded yet. ' +
+        'On web you must call (and await) prepareJieba() before any ' +
+        'segmentation call.'
     );
   }
   return wasm;
 }
 
 const Jieba: Spec = {
+  isReady() {
+    return isJiebaWasmReady();
+  },
   setDictPath() {
     // No-op on web: jieba-wasm bundles its own dictionary.
   },

package/src/index.tsx

@@ -10,4 +10,5 @@ export {
   find,
 } from './jieba';
 export type { Tagged, Keyword } from './jieba';
-export { initJieba } from './init';
+export { prepareJieba, isJiebaReady } from './init';
+export type { PrepareJiebaOptions } from './init';

package/src/init.ts

@@ -2,7 +2,7 @@ import { Platform } from 'react-native';
 import Jieba from './NativeJieba';
 import JiebaAndroidHelper from './NativeJiebaAndroidHelper';
 
-export type InitJiebaOptions = {
+export type PrepareJiebaOptions = {
   /**
    * Web only: URL (or fetch input) for the jieba-wasm `.wasm` binary. Most
    * bundlers resolve it automatically, so this is only needed when the asset
@@ -11,11 +11,28 @@ export type InitJiebaOptions = {
   wasmUrl?: string | URL | Request;
 };
 
-let initPromise: Promise<void> | null = null;
+let preparePromise: Promise<void> | null = null;
 
-export function initJieba(_options: InitJiebaOptions = {}): Promise<void> {
-  if (initPromise) return initPromise;
-  initPromise = (async () => {
+/**
+ * Optional on native (iOS/Android): the dictionary is located/extracted
+ * automatically on the first segmentation call, so you can call `cut`, `tag`,
+ * etc. directly without ever calling `prepareJieba`.
+ *
+ * Calling it is still useful as a *warm-up*: on Android's very first run the
+ * dictionary assets are extracted from the APK, and doing that work here
+ * (asynchronously, up front) avoids a one-time blocking pause on the first
+ * `cut`/`tag` call.
+ *
+ * On web it is **required** — it loads and instantiates the `jieba-wasm`
+ * binary, which cannot be done synchronously.
+ *
+ * Idempotent: repeated calls return the same promise.
+ */
+export function prepareJieba(
+  _options: PrepareJiebaOptions = {}
+): Promise<void> {
+  if (preparePromise) return preparePromise;
+  preparePromise = (async () => {
     if (Platform.OS === 'android') {
       if (!JiebaAndroidHelper) {
         throw new Error(
@@ -27,8 +44,19 @@ export function initJieba(_options: InitJiebaOptions = {}): Promise<void> {
     }
     // iOS: OnLoad.mm already configured the dict path from the bundle.
   })().catch((err) => {
-    initPromise = null;
+    preparePromise = null;
     throw err;
   });
-  return initPromise;
+  return preparePromise;
+}
+
+/**
+ * Whether jieba is ready to segment synchronously.
+ *
+ * Backed by the native engine state (not by whether `prepareJieba` was called),
+ * so it stays correct even when the dictionary is resolved lazily on the first
+ * `cut`/`tag` call. On iOS this is `true` from app launch.
+ */
+export function isJiebaReady(): boolean {
+  return Jieba.isReady();
 }

package/src/init.web.ts

@@ -1,13 +1,29 @@
-import { setJiebaWasm, type JiebaWasmModule } from './NativeJieba.web';
-import type { InitJiebaOptions } from './init';
+import {
+  setJiebaWasm,
+  isJiebaWasmReady,
+  type JiebaWasmModule,
+} from './NativeJieba.web';
 
-export type { InitJiebaOptions } from './init';
+export type PrepareJiebaOptions = {
+  /**
+   * URL (or fetch input) for the jieba-wasm `.wasm` binary. Most bundlers
+   * resolve it automatically, so this is only needed when the asset is served
+   * from a custom location.
+   */
+  wasmUrl?: string | URL | Request;
+};
 
-let initPromise: Promise<void> | null = null;
+let preparePromise: Promise<void> | null = null;
 
-export function initJieba(options: InitJiebaOptions = {}): Promise<void> {
-  if (initPromise) return initPromise;
-  initPromise = (async () => {
+/**
+ * **Required on web**: loads and instantiates the `jieba-wasm` binary (which
+ * cannot be done synchronously). Await it once before calling `cut`, `tag`, etc.
+ *
+ * Idempotent: repeated calls return the same promise.
+ */
+export function prepareJieba(options: PrepareJiebaOptions = {}): Promise<void> {
+  if (preparePromise) return preparePromise;
+  preparePromise = (async () => {
     // `jieba-wasm` resolves to its `web` build under the `browser`/`import`
     // conditions, whose default export is an async initializer that fetches
     // and instantiates the wasm binary.
@@ -25,8 +41,13 @@ export function initJieba(options: InitJiebaOptions = {}): Promise<void> {
     await wasm.default(options.wasmUrl);
     setJiebaWasm(wasm);
   })().catch((err) => {
-    initPromise = null;
+    preparePromise = null;
     throw err;
   });
-  return initPromise;
+  return preparePromise;
+}
+
+/** Whether the wasm module has been loaded and jieba can segment. */
+export function isJiebaReady(): boolean {
+  return isJiebaWasmReady();
 }

package/src/jieba.ts

@@ -27,6 +27,17 @@ export function tag(sentence: string): Tagged[] {
   return Jieba.tag(sentence);
 }
 
+/**
+ * TF-IDF keyword extraction.
+ *
+ * Requires the IDF dictionary, which is loaded lazily on the first call (every other API works
+ * without it). Throws when that dictionary is unavailable:
+ *  - on **web**, always — jieba-wasm ships no IDF data;
+ *  - on **native**, only in builds that opted out of bundling it via `RN_JIEBA_EXCLUDE_IDF_DICT=1`
+ *    (iOS) or `rnJiebaExcludeIdfDict=true` (Android), which drops ~5MB from the app.
+ *
+ * Guard it in cross-platform code, or in any app that may be built with the dictionary excluded.
+ */
 export function extract(sentence: string, topK: number = 5): Keyword[] {
   return Jieba.extract(sentence, topK);
 }

package/cpp/cppjieba/LICENSE

@@ -1,20 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2013
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
-the Software, and to permit persons to whom the Software is furnished to do so,
-subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/cpp/cppjieba/deps/limonp/LICENSE

@@ -1,20 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2013
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
-the Software, and to permit persons to whom the Software is furnished to do so,
-subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/cpp/cppjieba/deps/limonp/include/limonp/ArgvContext.hpp

@@ -1,70 +0,0 @@
-/************************************
- * file enc : ascii
- * author   : wuyanyi09@gmail.com
- ************************************/
-
-#ifndef LIMONP_ARGV_FUNCTS_H
-#define LIMONP_ARGV_FUNCTS_H
-
-#include <set>
-#include <sstream>
-#include "StringUtil.hpp"
-
-namespace limonp {
-
-using namespace std;
-
-class ArgvContext {
- public :
-  ArgvContext(int argc, const char* const * argv) {
-    for(int i = 0; i < argc; i++) {
-      if(StartsWith(argv[i], "-")) {
-        if(i + 1 < argc && !StartsWith(argv[i + 1], "-")) {
-          mpss_[argv[i]] = argv[i+1];
-          i++;
-        } else {
-          sset_.insert(argv[i]);
-        }
-      } else {
-        args_.push_back(argv[i]);
-      }
-    }
-  }
-  ~ArgvContext() {
-  }
-
-  friend ostream& operator << (ostream& os, const ArgvContext& args);
-  string operator [](size_t i) const {
-    if(i < args_.size()) {
-      return args_[i];
-    }
-    return "";
-  }
-  string operator [](const string& key) const {
-    map<string, string>::const_iterator it = mpss_.find(key);
-    if(it != mpss_.end()) {
-      return it->second;
-    }
-    return "";
-  }
-
-  bool HasKey(const string& key) const {
-    if(mpss_.find(key) != mpss_.end() || sset_.find(key) != sset_.end()) {
-      return true;
-    }
-    return false;
-  }
-
- private:
-  vector<string> args_;
-  map<string, string> mpss_;
-  set<string> sset_;
-}; // class ArgvContext
-
-inline ostream& operator << (ostream& os, const ArgvContext& args) {
-  return os<<args.args_<<args.mpss_<<args.sset_;
-}
-
-} // namespace limonp
-
-#endif

package/cpp/cppjieba/deps/limonp/include/limonp/Closure.hpp

@@ -1,206 +0,0 @@
-#ifndef LIMONP_CLOSURE_HPP
-#define LIMONP_CLOSURE_HPP
-
-namespace limonp {
-
-class ClosureInterface {
- public:
-  virtual ~ClosureInterface() {
-  }
-  virtual void Run() = 0;
-};
-
-template <class Funct>
-class Closure0: public ClosureInterface {
- public:
-  Closure0(Funct fun) {
-    fun_ = fun;
-  }
-  virtual ~Closure0() {
-  }
-  virtual void Run() {
-    (*fun_)();
-  }
- private:
-  Funct fun_;
-}; 
-
-template <class Funct, class Arg1>
-class Closure1: public ClosureInterface {
- public:
-  Closure1(Funct fun, Arg1 arg1) {
-    fun_ = fun;
-    arg1_ = arg1;
-  }
-  virtual ~Closure1() {
-  }
-  virtual void Run() {
-    (*fun_)(arg1_);
-  }
- private:
-  Funct fun_;
-  Arg1 arg1_;
-}; 
-
-template <class Funct, class Arg1, class Arg2>
-class Closure2: public ClosureInterface {
- public:
-  Closure2(Funct fun, Arg1 arg1, Arg2 arg2) {
-    fun_ = fun;
-    arg1_ = arg1;
-    arg2_ = arg2;
-  }
-  virtual ~Closure2() {
-  }
-  virtual void Run() {
-    (*fun_)(arg1_, arg2_);
-  }
- private:
-  Funct fun_;
-  Arg1 arg1_;
-  Arg2 arg2_;
-}; 
-
-template <class Funct, class Arg1, class Arg2, class Arg3>
-class Closure3: public ClosureInterface {
- public:
-  Closure3(Funct fun, Arg1 arg1, Arg2 arg2, Arg3 arg3) {
-    fun_ = fun;
-    arg1_ = arg1;
-    arg2_ = arg2;
-    arg3_ = arg3;
-  }
-  virtual ~Closure3() {
-  }
-  virtual void Run() {
-    (*fun_)(arg1_, arg2_, arg3_);
-  }
- private:
-  Funct fun_;
-  Arg1 arg1_;
-  Arg2 arg2_;
-  Arg3 arg3_;
-}; 
-
-template <class Obj, class Funct> 
-class ObjClosure0: public ClosureInterface {
- public:
-  ObjClosure0(Obj* p, Funct fun) {
-   p_ = p;
-   fun_ = fun;
-  }
-  virtual ~ObjClosure0() {
-  }
-  virtual void Run() {
-    (p_->*fun_)();
-  }
- private:
-  Obj* p_;
-  Funct fun_;
-}; 
-
-template <class Obj, class Funct, class Arg1> 
-class ObjClosure1: public ClosureInterface {
- public:
-  ObjClosure1(Obj* p, Funct fun, Arg1 arg1) {
-   p_ = p;
-   fun_ = fun;
-   arg1_ = arg1;
-  }
-  virtual ~ObjClosure1() {
-  }
-  virtual void Run() {
-    (p_->*fun_)(arg1_);
-  }
- private:
-  Obj* p_;
-  Funct fun_;
-  Arg1 arg1_;
-}; 
-
-template <class Obj, class Funct, class Arg1, class Arg2> 
-class ObjClosure2: public ClosureInterface {
- public:
-  ObjClosure2(Obj* p, Funct fun, Arg1 arg1, Arg2 arg2) {
-   p_ = p;
-   fun_ = fun;
-   arg1_ = arg1;
-   arg2_ = arg2;
-  }
-  virtual ~ObjClosure2() {
-  }
-  virtual void Run() {
-    (p_->*fun_)(arg1_, arg2_);
-  }
- private:
-  Obj* p_;
-  Funct fun_;
-  Arg1 arg1_;
-  Arg2 arg2_;
-}; 
-template <class Obj, class Funct, class Arg1, class Arg2, class Arg3> 
-class ObjClosure3: public ClosureInterface {
- public:
-  ObjClosure3(Obj* p, Funct fun, Arg1 arg1, Arg2 arg2, Arg3 arg3) {
-   p_ = p;
-   fun_ = fun;
-   arg1_ = arg1;
-   arg2_ = arg2;
-   arg3_ = arg3;
-  }
-  virtual ~ObjClosure3() {
-  }
-  virtual void Run() {
-    (p_->*fun_)(arg1_, arg2_, arg3_);
-  }
- private:
-  Obj* p_;
-  Funct fun_;
-  Arg1 arg1_;
-  Arg2 arg2_;
-  Arg3 arg3_;
-}; 
-
-template<class R>
-ClosureInterface* NewClosure(R (*fun)()) {
-  return new Closure0<R (*)()>(fun);
-}
-
-template<class R, class Arg1>
-ClosureInterface* NewClosure(R (*fun)(Arg1), Arg1 arg1) {
-  return new Closure1<R (*)(Arg1), Arg1>(fun, arg1);
-}
-
-template<class R, class Arg1, class Arg2>
-ClosureInterface* NewClosure(R (*fun)(Arg1, Arg2), Arg1 arg1, Arg2 arg2) {
-  return new Closure2<R (*)(Arg1, Arg2), Arg1, Arg2>(fun, arg1, arg2);
-}
-
-template<class R, class Arg1, class Arg2, class Arg3>
-ClosureInterface* NewClosure(R (*fun)(Arg1, Arg2, Arg3), Arg1 arg1, Arg2 arg2, Arg3 arg3) {
-  return new Closure3<R (*)(Arg1, Arg2, Arg3), Arg1, Arg2, Arg3>(fun, arg1, arg2, arg3);
-}
-
-template<class R, class Obj>
-ClosureInterface* NewClosure(Obj* obj, R (Obj::* fun)()) {
-  return new ObjClosure0<Obj, R (Obj::* )()>(obj, fun);
-}
-
-template<class R, class Obj, class Arg1>
-ClosureInterface* NewClosure(Obj* obj, R (Obj::* fun)(Arg1), Arg1 arg1) {
-  return new ObjClosure1<Obj, R (Obj::* )(Arg1), Arg1>(obj, fun, arg1);
-}
-
-template<class R, class Obj, class Arg1, class Arg2>
-ClosureInterface* NewClosure(Obj* obj, R (Obj::* fun)(Arg1, Arg2), Arg1 arg1, Arg2 arg2) {
-  return new ObjClosure2<Obj, R (Obj::*)(Arg1, Arg2), Arg1, Arg2>(obj, fun, arg1, arg2);
-}
-
-template<class R, class Obj, class Arg1, class Arg2, class Arg3>
-ClosureInterface* NewClosure(Obj* obj, R (Obj::* fun)(Arg1, Arg2, Arg3), Arg1 arg1, Arg2 arg2, Arg3 arg3) {
-  return new ObjClosure3<Obj, R (Obj::*)(Arg1, Arg2, Arg3), Arg1, Arg2, Arg3>(obj, fun, arg1, arg2, arg3);
-}
-
-} // namespace limonp
-
-#endif // LIMONP_CLOSURE_HPP

package/cpp/cppjieba/deps/limonp/include/limonp/Colors.hpp

@@ -1,31 +0,0 @@
-#ifndef LIMONP_COLOR_PRINT_HPP
-#define LIMONP_COLOR_PRINT_HPP
-
-#include <string>
-#include <stdarg.h>
-
-namespace limonp {
-
-using std::string;
-
-enum Color {
-  BLACK = 30,
-  RED,
-  GREEN,
-  YELLOW,
-  BLUE,
-  PURPLE
-}; // enum Color
-
-static void ColorPrintln(enum Color color, const char * fmt, ...) {
-  va_list ap;
-  printf("\033[0;%dm", color);
-  va_start(ap, fmt);
-  vprintf(fmt, ap);
-  va_end(ap);
-  printf("\033[0m\n"); // if not \n , in some situation , the next lines will be set the same color unexpectedly
-}
-
-} // namespace limonp
-
-#endif // LIMONP_COLOR_PRINT_HPP

package/cpp/cppjieba/deps/limonp/include/limonp/Condition.hpp

@@ -1,38 +0,0 @@
-#ifndef LIMONP_CONDITION_HPP
-#define LIMONP_CONDITION_HPP
-
-#include "MutexLock.hpp"
-
-namespace limonp {
-
-class Condition : NonCopyable {
- public:
-  explicit Condition(MutexLock& mutex)
-    : mutex_(mutex) {
-    XCHECK(!pthread_cond_init(&pcond_, NULL));
-  }
-
-  ~Condition() {
-    XCHECK(!pthread_cond_destroy(&pcond_));
-  }
-
-  void Wait() {
-    XCHECK(!pthread_cond_wait(&pcond_, mutex_.GetPthreadMutex()));
-  }
-
-  void Notify() {
-    XCHECK(!pthread_cond_signal(&pcond_));
-  }
-
-  void NotifyAll() {
-    XCHECK(!pthread_cond_broadcast(&pcond_));
-  }
-
- private:
-  MutexLock& mutex_;
-  pthread_cond_t pcond_;
-}; // class Condition
-
-} // namespace limonp
-
-#endif // LIMONP_CONDITION_HPP