@sigx/lynx-core 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Andreas Ekdahl
+
+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/dist/bridge.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Low-level bridge to LynxJS NativeModules.
+ *
+ * NativeModules is a global object injected by the Lynx runtime.
+ * Each registered native module (e.g. Haptics) appears as a property.
+ */
+/**
+ * Get a native module by name. Throws with actionable error if unavailable.
+ */
+export declare function getModule(name: string): Record<string, (...args: any[]) => any>;
+/**
+ * Call a sync native method. Returns the result directly.
+ */
+export declare function callSync<T = void>(module: string, method: string, ...args: any[]): T;
+/**
+ * Call an async native method that uses a callback as its last argument.
+ * Wraps the callback in a Promise.
+ */
+export declare function callAsync<T = any>(module: string, method: string, ...args: any[]): Promise<T>;
+/**
+ * Check if a native module is registered in the current runtime.
+ */
+export declare function isModuleAvailable(name: string): boolean;
+/**
+ * Guard that throws if a module is not available.
+ * Use at the top of module wrapper functions for early, clear errors.
+ */
+export declare function guardModule(name: string): void;
+//# sourceMappingURL=bridge.d.ts.map

package/dist/bridge.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bridge.d.ts","sourceRoot":"","sources":["../src/bridge.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAoBH;;GAEG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,CAc/E;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,CAEpF;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,CAAC,GAAG,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,CAQ7F;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAMvD;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAI9C"}

package/dist/bridge.js

@@ -0,0 +1,78 @@
+/**
+ * Low-level bridge to LynxJS NativeModules.
+ *
+ * NativeModules is a global object injected by the Lynx runtime.
+ * Each registered native module (e.g. Haptics) appears as a property.
+ */
+/** Known module → package mapping for actionable error messages. */
+const MODULE_PACKAGES = {
+    Haptics: '@sigx/lynx-haptics',
+    Clipboard: '@sigx/lynx-clipboard',
+    Storage: '@sigx/lynx-storage',
+    DeviceInfo: '@sigx/lynx-device-info',
+    Share: '@sigx/lynx-share',
+    Camera: '@sigx/lynx-camera',
+    Location: '@sigx/lynx-location',
+    ImagePicker: '@sigx/lynx-image-picker',
+    FileSystem: '@sigx/lynx-file-system',
+    Notifications: '@sigx/lynx-notifications',
+    Network: '@sigx/lynx-network',
+    Linking: '@sigx/lynx-linking',
+};
+/**
+ * Get a native module by name. Throws with actionable error if unavailable.
+ */
+export function getModule(name) {
+    if (typeof NativeModules === 'undefined' || !NativeModules[name]) {
+        const pkg = MODULE_PACKAGES[name] ?? `@sigx/lynx-${name.toLowerCase()}`;
+        throw new Error(`[@sigx/lynx-core] Module "${name}" is not available.\n` +
+            `\n` +
+            `This usually means one of:\n` +
+            `  1. You're not running in sigx-lynx-go (which has all modules pre-bundled)\n` +
+            `  2. For custom builds, add "${pkg}" to your sigx.lynx.config.ts modules array\n` +
+            `     and run \`sigx-lynx prebuild\` to regenerate the native project.\n` +
+            `  3. The native module failed to register — check native logs for errors.`);
+    }
+    return NativeModules[name];
+}
+/**
+ * Call a sync native method. Returns the result directly.
+ */
+export function callSync(module, method, ...args) {
+    return getModule(module)[method](...args);
+}
+/**
+ * Call an async native method that uses a callback as its last argument.
+ * Wraps the callback in a Promise.
+ */
+export function callAsync(module, method, ...args) {
+    return new Promise((resolve, reject) => {
+        try {
+            getModule(module)[method](...args, (result) => resolve(result));
+        }
+        catch (e) {
+            reject(e);
+        }
+    });
+}
+/**
+ * Check if a native module is registered in the current runtime.
+ */
+export function isModuleAvailable(name) {
+    try {
+        return typeof NativeModules !== 'undefined' && NativeModules[name] != null;
+    }
+    catch {
+        return false;
+    }
+}
+/**
+ * Guard that throws if a module is not available.
+ * Use at the top of module wrapper functions for early, clear errors.
+ */
+export function guardModule(name) {
+    if (!isModuleAvailable(name)) {
+        getModule(name); // triggers the descriptive error
+    }
+}
+//# sourceMappingURL=bridge.js.map

package/dist/bridge.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bridge.js","sourceRoot":"","sources":["../src/bridge.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH,oEAAoE;AACpE,MAAM,eAAe,GAA2B;IAC5C,OAAO,EAAE,oBAAoB;IAC7B,SAAS,EAAE,sBAAsB;IACjC,OAAO,EAAE,oBAAoB;IAC7B,UAAU,EAAE,wBAAwB;IACpC,KAAK,EAAE,kBAAkB;IACzB,MAAM,EAAE,mBAAmB;IAC3B,QAAQ,EAAE,qBAAqB;IAC/B,WAAW,EAAE,yBAAyB;IACtC,UAAU,EAAE,wBAAwB;IACpC,aAAa,EAAE,0BAA0B;IACzC,OAAO,EAAE,oBAAoB;IAC7B,OAAO,EAAE,oBAAoB;CAChC,CAAC;AAEF;;GAEG;AACH,MAAM,UAAU,SAAS,CAAC,IAAY;IAClC,IAAI,OAAO,aAAa,KAAK,WAAW,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;QAC/D,MAAM,GAAG,GAAG,eAAe,CAAC,IAAI,CAAC,IAAI,cAAc,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;QACxE,MAAM,IAAI,KAAK,CACX,6BAA6B,IAAI,uBAAuB;YACxD,IAAI;YACJ,8BAA8B;YAC9B,+EAA+E;YAC/E,gCAAgC,GAAG,+CAA+C;YAClF,yEAAyE;YACzE,2EAA2E,CAC9E,CAAC;IACN,CAAC;IACD,OAAO,aAAa,CAAC,IAAI,CAAC,CAAC;AAC/B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,QAAQ,CAAW,MAAc,EAAE,MAAc,EAAE,GAAG,IAAW;IAC7E,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,IAAI,CAAM,CAAC;AACnD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,SAAS,CAAU,MAAc,EAAE,MAAc,EAAE,GAAG,IAAW;IAC7E,OAAO,IAAI,OAAO,CAAI,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACtC,IAAI,CAAC;YACD,SAAS,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC,MAAS,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;QACvE,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACT,MAAM,CAAC,CAAC,CAAC,CAAC;QACd,CAAC;IACL,CAAC,CAAC,CAAC;AACP,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,iBAAiB,CAAC,IAAY;IAC1C,IAAI,CAAC;QACD,OAAO,OAAO,aAAa,KAAK,WAAW,IAAI,aAAa,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC;IAC/E,CAAC;IAAC,MAAM,CAAC;QACL,OAAO,KAAK,CAAC;IACjB,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,WAAW,CAAC,IAAY;IACpC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC;QAC3B,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,iCAAiC;IACtD,CAAC;AACL,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @sigx/lynx-core — Core native bridge for sigx-lynx
+ *
+ * Provides the low-level bridge to NativeModules injected by the Lynx runtime.
+ * Module packages (@sigx/lynx-haptics, @sigx/lynx-camera, etc.) depend on this.
+ *
+ * @packageDocumentation
+ */
+export { getModule, callSync, callAsync, isModuleAvailable, guardModule } from './bridge.js';
+export type { PermissionStatus, PermissionResponse } from './permissions.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC7F,YAAY,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC"}

package/dist/index.js

@@ -0,0 +1,10 @@
+/**
+ * @sigx/lynx-core — Core native bridge for sigx-lynx
+ *
+ * Provides the low-level bridge to NativeModules injected by the Lynx runtime.
+ * Module packages (@sigx/lynx-haptics, @sigx/lynx-camera, etc.) depend on this.
+ *
+ * @packageDocumentation
+ */
+export { getModule, callSync, callAsync, isModuleAvailable, guardModule } from './bridge.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC"}

package/dist/permissions.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Shared permission types for sigx-lynx native modules.
+ *
+ * All module packages that deal with permissions import these types from
+ * @sigx/lynx-core for consistent API surfaces across Camera, Location,
+ * Notifications, ImagePicker, etc.
+ */
+/** Permission status returned by native modules. */
+export type PermissionStatus = 'granted' | 'denied' | 'undetermined' | 'blocked';
+/** Response from requestPermission() and getPermissionStatus() calls. */
+export interface PermissionResponse {
+    /** Current permission status. */
+    status: PermissionStatus;
+    /**
+     * Whether the app can show the OS permission dialog again.
+     * `false` when the user selected "Don't ask again" (Android) or
+     * after the first denial (iOS — user must go to Settings).
+     */
+    canAskAgain: boolean;
+}
+//# sourceMappingURL=permissions.d.ts.map

package/dist/permissions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"permissions.d.ts","sourceRoot":"","sources":["../src/permissions.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,oDAAoD;AACpD,MAAM,MAAM,gBAAgB,GAAG,SAAS,GAAG,QAAQ,GAAG,cAAc,GAAG,SAAS,CAAC;AAEjF,yEAAyE;AACzE,MAAM,WAAW,kBAAkB;IAC/B,iCAAiC;IACjC,MAAM,EAAE,gBAAgB,CAAC;IACzB;;;;OAIG;IACH,WAAW,EAAE,OAAO,CAAC;CACxB"}

package/dist/permissions.js

@@ -0,0 +1,9 @@
+/**
+ * Shared permission types for sigx-lynx native modules.
+ *
+ * All module packages that deal with permissions import these types from
+ * @sigx/lynx-core for consistent API surfaces across Camera, Location,
+ * Notifications, ImagePicker, etc.
+ */
+export {};
+//# sourceMappingURL=permissions.js.map

package/dist/permissions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"permissions.js","sourceRoot":"","sources":["../src/permissions.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG"}

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@sigx/lynx-core",
+  "version": "0.1.0",
+  "description": "Core native bridge for sigx-lynx — low-level access to NativeModules",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "sigx",
+    "lynx",
+    "native",
+    "bridge"
+  ],
+  "author": "Andreas Ekdahl",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/signalxjs/core.git",
+    "directory": "packages/lynx-core"
+  },
+  "devDependencies": {
+    "typescript": "^5.9.3"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch"
+  }
+}