@amazon-devices/kepler-compatibility 0.0.5

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { isAppTargeting, isPresentOnOS } from './turbo-modules/KeplerCompatibility';

package/dist/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPresentOnOS = exports.isAppTargeting = void 0;
+var KeplerCompatibility_1 = require("./turbo-modules/KeplerCompatibility");
+Object.defineProperty(exports, "isAppTargeting", { enumerable: true, get: function () { return KeplerCompatibility_1.isAppTargeting; } });
+Object.defineProperty(exports, "isPresentOnOS", { enumerable: true, get: function () { return KeplerCompatibility_1.isPresentOnOS; } });

package/dist/kepler/tm-manifest.json

@@ -0,0 +1 @@
+{"schema":1,"fileSets":{"native":[{"arch":"armv7","variant":"release","directoryPath":"armv7-release"},{"arch":"x86_64","variant":"release","directoryPath":"x86_64-release"},{"arch":"aarch64","variant":"release","directoryPath":"aarch64-release"},{"arch":"armv7","variant":"debug","directoryPath":"armv7-debug"},{"arch":"x86_64","variant":"debug","directoryPath":"x86_64-debug"},{"arch":"aarch64","variant":"debug","directoryPath":"aarch64-debug"}]}}

package/dist/turbo-modules/KeplerCompatibility.d.ts

@@ -0,0 +1,2 @@
+export declare const isAppTargeting: (libraryName: string, version: string) => boolean;
+export declare const isPresentOnOS: (libraryName: string, version: string) => boolean;

package/dist/turbo-modules/KeplerCompatibility.js

@@ -0,0 +1,86 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPresentOnOS = exports.isAppTargeting = exports.KeplerCompatibility = void 0;
+const KeplerCompatibilityNative_1 = __importDefault(require("./KeplerCompatibilityNative"));
+/** @internal */
+const isEmptyMap = (element) => element == null || Object.keys(element).length === 0;
+/** @internal */
+class KeplerCompatibility {
+    static instance;
+    keplerModuleMap;
+    constructor() {
+        // DEV NOTE: This global will be generated by metro config change
+        // to polyfills. The metro config change will be injected by
+        // Kepler-CLI and other build-tooling as necessary.
+        this.keplerModuleMap = global.KEPLER_MODULE_MAP || {};
+        console.log('[debug] Kepler Manifest: ', this.keplerModuleMap);
+    }
+    static getInstance() {
+        if (!KeplerCompatibility.instance) {
+            KeplerCompatibility.instance = new KeplerCompatibility();
+        }
+        return KeplerCompatibility.instance;
+    }
+    /** @internal */
+    static resetInstance() {
+        KeplerCompatibility.instance = new KeplerCompatibility();
+    }
+    /**
+     * For Library developers, this runtime check returns True
+     * if the application developer has requested this version to be enabled.
+     *
+     * @version 0.0.1
+     * @param libraryName The name of the NPM library `@amazon-devices/react-native-gesture-handler`
+     * @param version A valid semver string, for example 2.1.0
+     * @returns truthy Boolean
+     */
+    isAppTargeting(libraryName, version) {
+        if (isEmptyMap(this.keplerModuleMap)) {
+            console.error('Required Lookup Map not populated! Check the output of @amazon-devices/kepler-compatibility-metro-config to determine the source of failure.');
+            return false;
+        }
+        if (!this.keplerModuleMap[libraryName]) {
+            console.warn(`No compatibility information found for ${libraryName}`);
+            return false;
+        }
+        const moduleRevision = this.keplerModuleMap[libraryName]?.[version];
+        if (!moduleRevision) {
+            console.warn(`No compatibility information found for ${libraryName}@${version}`);
+            return false;
+        }
+        return KeplerCompatibilityNative_1.default.isKeplerModuleEnabled(moduleRevision);
+    }
+    /**
+     * For Application developers, Checks whether the `libraryName` and `version`
+     * are available on the system the App is running on.
+     *
+     * @version 0.0.1
+     * @param libraryName The name of the NPM library `@amazon-devices/react-native-gesture-handler`
+     * @param version A valid semver string, for example 2.1.0
+     * @returns truthy Boolean
+     */
+    isPresentOnOS(libraryName, version) {
+        if (isEmptyMap(this.keplerModuleMap)) {
+            // FIXME: Should we just throw error in these scenarios? Should the error happen in the ctor()?
+            console.error('Required Lookup Map not populated! Check the output of @amazon-devices/kepler-compatibility-metro-config to determine the source of failure.');
+            return false;
+        }
+        if (!this.keplerModuleMap[libraryName]) {
+            console.warn(`No compatibility information found for ${libraryName}`);
+            return false;
+        }
+        const moduleRevision = this.keplerModuleMap[libraryName]?.[version];
+        if (!moduleRevision) {
+            console.warn(`No compatibility information found for ${libraryName}@${version}`);
+            return false;
+        }
+        return KeplerCompatibilityNative_1.default.isKeplerModuleEnabled(moduleRevision);
+    }
+}
+exports.KeplerCompatibility = KeplerCompatibility;
+const KeplerCompatibilityAPI = KeplerCompatibility.getInstance();
+exports.isAppTargeting = KeplerCompatibilityAPI.isAppTargeting.bind(KeplerCompatibilityAPI);
+exports.isPresentOnOS = KeplerCompatibilityAPI.isPresentOnOS.bind(KeplerCompatibilityAPI);

package/dist/turbo-modules/KeplerCompatibilityNative.d.ts

@@ -0,0 +1,6 @@
+import type { KeplerTurboModule } from '@amazon-devices/keplerscript-turbomodule-api';
+export interface KeplerCompatibilityNative extends KeplerTurboModule {
+    isKeplerModuleEnabled: (keplerModule: string) => boolean;
+}
+declare const _default: KeplerCompatibilityNative;
+export default _default;

package/dist/turbo-modules/KeplerCompatibilityNative.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const keplerscript_turbomodule_api_1 = require("@amazon-devices/keplerscript-turbomodule-api");
+exports.default = keplerscript_turbomodule_api_1.TurboModuleRegistry.getEnforcing('KeplerCompatibility');

package/dist/turbo-modules/__mocks__/KeplerCompatibilityNative.d.ts

@@ -0,0 +1,4 @@
+declare const _default: {
+    isKeplerModuleEnabled: () => boolean;
+};
+export default _default;

package/dist/turbo-modules/__mocks__/KeplerCompatibilityNative.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = {
+    isKeplerModuleEnabled: () => true,
+};

package/kepler-compatibility.json

@@ -0,0 +1,9 @@
+{
+    "versions": {
+        "0.0.1": ["/com.amazon.kepler.experimental.features_2025_02@IFeature", "/com.amazon.kepler.security@ISecurityModule"],
+        "0.0.2": ["/com.amazon.kepler.experimental.features_2025_02@IFeature", "/com.amazon.kepler.security@ISecurityModule"],
+        "0.0.3": ["/com.amazon.kepler.experimental.features_2025_02@IFeature", "/com.amazon.kepler.security@ISecurityModule"],
+        "0.0.4": ["/com.amazon.kepler.experimental.features_2025_02@IFeature", "/com.amazon.kepler.security@ISecurityModule"],
+        "0.0.5": ["/com.amazon.kepler.experimental.features_2025_02@IFeature", "/com.amazon.kepler.security@ISecurityModule"]
+    }
+}

package/package.json

@@ -0,0 +1 @@
+{"name": "@amazon-devices/kepler-compatibility", "version": "0.0.5", "main": "./dist/index.js", "types": "./dist/index.d.ts", "files": ["dist", "kepler-compatibility.json", "react-native.config.js", "THIRD-PARTY-LICENSES.txt"], "scripts": {"clean": "rm -rf node_modules buildinfo.json dist bvm build", "test": "jest --colors", "test:debug": "node --inspect-brk node_modules/.bin/jest --runInBand", "lint": "eslint src test --ext .ts,.tsx", "lint:fix": "eslint src test --ext .ts,.tsx --fix", "build:js": "tsc -p tsconfig.json", "build:native:debug": "kepler build -b Debug", "build:native:release": "kepler build -b Release", "build": "npm-run-all build:js build:native:release", "build:debug": "npm-run-all build:js build:native:debug"}, "dependencies": {"@amazon-devices/keplerscript-turbomodule-api": "^1.0.0"}, "devDependencies": {"@react-native/eslint-config": "0.72.2", "@types/jest": "^28.0.0", "@typescript-eslint/eslint-plugin": "^5.30.0", "babel-jest": "^28.0.0", "eslint": "^8.12.0", "jest": "^28.0.0", "metro-react-native-babel-preset": "^0.76.5", "npm-run-all": "^4.1.5", "prettier": "^2.6.2", "ts-jest": "^28.0.0", "typescript": "4.8.4"}, "kepler": {"projectType": "turbomodule", "targets": ["tv"], "features": ["vega"], "api": 0.1}, "license": "See license in LICENSE"}

package/react-native.config.js

@@ -0,0 +1,27 @@
+module.exports = {
+    dependency: {
+        platforms: {
+            kepler: {
+                autolink: {
+                    "KeplerCompatibility": {
+                        "libraryName": "libKeplerCompatibility.so",
+                        "linkDynamic": true,
+                        "provider": "application",
+                        "components": [],
+                        "turbomodules": [
+                            "KeplerCompatibility"
+                        ]
+                    }
+                }
+            }
+
+        }
+    },
+    project: {
+        kepler: {
+            runtimeFeatures: {
+                "USE_ABI_STABLE_UI_COMPONENTS": true
+            },
+        }
+    }
+}