@apexnative/navigation 0.0.0-stage → 1.0.0-alpha.1

package/android/MATERIAL_SYMBOLS_LICENSE.txt

@@ -0,0 +1,205 @@
+The icons src/main/res/drawable/apex_navigation_ic_*.xml and ic_fab_add_24dp.xml are Material Symbols (Outlined)
+by Google, https://github.com/google/material-design-icons, under the Apache License 2.0 below.
+
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/android/RECIPES.md

@@ -0,0 +1,39 @@
+# Android core: recipes
+
+The steps for adding an option and for adding a command to the Android core; read it when doing exactly that.
+
+## Adding an option
+
+1. The type and its JSDoc in `src/interfaces/Options.ts` (`.claude/rules/options.md`). A name that ends in `color` or
+   `icon` is converted by `src/engine/options.ts`.
+2. The Kotlin group in `options/`: a field of a value type (`Bool`, `Text`, `Fraction`, `Variant`, `ThemeColour`), its
+   `parse` (use `parsers/`; a value of the wrong kind stays unset), `mergeWith`, `mergeWithDefault`, `copy` and
+   `hasValue`. A new group also needs a field in `Options` and a line in its `parse`, `mergeWith` and `withDefaultOptions`.
+   An option that acts once is cleared in `Options.clearOneShotOptions`.
+3. The presenter of the area applies it when the screen shows and again on `mergeOptions` and `onConfigurationChanged`
+   (a repaint after a light/dark switch or `setDefaultOptions`); a system-bar option goes through `SystemUiRules`.
+   Read colors with `ThemeColour.get` at apply so they follow the theme.
+4. The cache needs nothing: own options are written only through `ViewController.options`, `changeOptions` and
+   `mergeOptions`, defaults only through `DefaultOptions.set`. Never change a resolved result.
+5. Tests: add the field to `OptionsFixture.full()`. `WholeTreeTest` walks the tree by reflection and fails when a field
+   is not read, copied, merged or defaulted. Add cases to `ReadersTest`, `MergeRuleTest` and the area's rules test.
+6. The docs page and a Showcase control; one meaning on both platforms, and where Android can't do it the JSDoc says so
+   (`.claude/rules/general.md`).
+
+## Adding a command
+
+1. The method in the codegen spec `src/adapters/NativeANNTurboModule.ts` and the engine in `src/engine/commands.ts`
+   (`.claude/rules/native-contract.md`). The Gradle build regenerates `NativeANNTurboModuleSpec`.
+2. The override in `NavigationTurboModule`: `runner.run(name, commandId, what, promise, check) { node, answer -> … }`
+   for a command with a promise (the `check` reads the layout with `LayoutReader`), `runner.runVoid` without one.
+3. The body goes to the owner of the area: `Navigator` (root, modals, overlays), `StackCommands` (stacks), a
+   coordinator. A stack operation is a `StackQueue` operation.
+4. New layout fields are read and checked in `LayoutReader`; checks against what shows are in `LayoutChecks` or in the
+   command, before any node is made. Every rejection text is a function in `ErrorTexts` (same words as iOS).
+5. The answer goes through `CommandAnswer`: add the name to `COMPLETED_COMMANDS` when the command changes what shows
+   (then the state, the promise and `CommandCompleted` follow in that order). A transition ends through
+   `AppearanceDispatcher.endTransition`.
+6. Tests: `CommandRunnerTest`, `CommandAnswerTest`, `ErrorTextsTest`, `LayoutReaderTest`; a stack operation also needs a
+   case in the queue tests (`StackQueueHarness`).
+7. A new event: `EventEmitter` (`emit…`), the payload type in `src/interfaces`, and for an appearance event the
+   `AppearanceDispatcher.Sender`.

package/android/build.gradle

@@ -0,0 +1,108 @@
+// The library's Android module: Kotlin, with React Native's codegen of the TurboModule and the components
+// (`ApexNavigationSpec`). The C++ of the components (src/main/jni/CMakeLists.txt) builds with the app's autolinking.
+// -PapexNavigationWarningsAsErrors (scripts/build-android.sh) fails the build of this module on a Kotlin or Java
+// warning.
+buildscript {
+    // The Kotlin of the app, or this one: an app that has its Kotlin plugin on the classpath keeps it.
+    def kotlinVersion = rootProject.ext.has("kotlinVersion") ? rootProject.ext.get("kotlinVersion") : "2.1.20"
+    repositories {
+        google()
+        mavenCentral()
+    }
+    dependencies {
+        classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlinVersion")
+    }
+}
+
+apply plugin: "com.android.library"
+// AGP 9 compiles Kotlin itself unless the app opts out (`android.builtInKotlin=false`, as React Native's template does).
+def agpMajor = com.android.Version.ANDROID_GRADLE_PLUGIN_VERSION.tokenize(".")[0].toInteger()
+// Not an Elvis: Groovy's `false ?: true` is true, which would read `android.builtInKotlin=false` as true.
+def builtInKotlinProperty = providers.gradleProperty("android.builtInKotlin").orNull
+def builtInKotlin = agpMajor >= 9 && (builtInKotlinProperty == null || builtInKotlinProperty.toBoolean())
+if (!builtInKotlin) {
+    apply plugin: "org.jetbrains.kotlin.android"
+}
+apply plugin: "com.facebook.react"
+
+def appValue(name, fallback) {
+    return rootProject.ext.has(name) ? rootProject.ext.get(name) : fallback
+}
+
+def warningsAsErrors = project.hasProperty("apexNavigationWarningsAsErrors")
+
+react {
+    libraryName = "ApexNavigationSpec"
+    codegenJavaPackageName = "dev.apexnative.navigation.react"
+    jsRootDir = file("../src")
+}
+
+android {
+    namespace "dev.apexnative.navigation"
+    compileSdk Math.max(appValue("compileSdkVersion", 36) as int, 36)
+
+    defaultConfig {
+        minSdk Math.max(appValue("minSdkVersion", 24) as int, 24)
+        consumerProguardFiles "consumer-rules.pro"
+        // NavigationActivity draws edge to edge when the app asks for it (`edgeToEdgeEnabled` in gradle.properties).
+        def edgeToEdge = project.findProperty("edgeToEdgeEnabled")?.toString()?.toBoolean() ?: false
+        buildConfigField "boolean", "EDGE_TO_EDGE_ENABLED", edgeToEdge.toString()
+    }
+
+    buildFeatures {
+        buildConfig true
+    }
+
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_17
+        targetCompatibility JavaVersion.VERSION_17
+    }
+
+    lint {
+        abortOnError false
+    }
+
+    // The unit tests are plain JUnit: android.util.Log and the like answer with defaults instead of throwing.
+    testOptions {
+        unitTests.returnDefaultValues = true
+    }
+}
+
+kotlin {
+    compilerOptions {
+        jvmTarget = org.jetbrains.kotlin.gradle.dsl.JvmTarget.JVM_17
+        allWarningsAsErrors = warningsAsErrors
+    }
+}
+
+tasks.withType(JavaCompile).configureEach {
+    if (warningsAsErrors) {
+        options.compilerArgs += ["-Xlint:unchecked", "-Xlint:deprecation", "-Werror"]
+    }
+}
+
+repositories {
+    google()
+    mavenCentral()
+}
+
+dependencies {
+    // The version of react-native comes from the app, through the React Native Gradle plugin.
+    implementation "com.facebook.react:react-android"
+    implementation "androidx.core:core-ktx:1.18.0"
+    implementation "androidx.appcompat:appcompat:1.8.0"
+    implementation "androidx.activity:activity:1.13.0"
+    implementation "androidx.annotation:annotation:1.11.0"
+    implementation "com.google.android.material:material:1.14.0"
+    // The side menu's drawer. 1.1.1, what Material 1.14 brings: 1.2.0 registers a back callback of its own on Android
+    // 13+ that would close an open menu before JavaScript's `BackHandler` and the navigation's back.
+    implementation "androidx.drawerlayout:drawerlayout:1.1.1"
+    implementation "androidx.slidingpanelayout:slidingpanelayout:1.2.0"
+    implementation "androidx.window:window:1.5.1"
+    implementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:1.10.2"
+
+    testImplementation "junit:junit:4.13.2"
+    // AndroidX's `FastOutSlowInInterpolator`, only for the test that compares the core's own table of `fastOutSlowIn`
+    // with it; the library doesn't use it.
+    testImplementation "androidx.interpolator:interpolator:1.0.0"
+}

package/android/consumer-rules.pro

@@ -0,0 +1,2 @@
+# The native screens `npx apex-navigation codegen` lists in the app: the navigation finds the list by its name.
+-keep class dev.apexnative.navigation.generated.ApexNavigationGeneratedScreens { *; }

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,9 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+
+    <application>
+        <!-- React Native's developer settings, which its developer menu opens in a debug build. -->
+        <activity
+            android:name="com.facebook.react.devsupport.DevSettingsActivity"
+            android:exported="false" />
+    </application>
+</manifest>

package/android/src/main/java/dev/apexnative/navigation/EdgeToEdgeDecision.kt

@@ -0,0 +1,25 @@
+package dev.apexnative.navigation
+
+import android.os.Build
+
+/**
+ * Whether a navigation activity draws edge to edge, by Android's rules: the app asks for it (`edgeToEdgeEnabled=true`
+ * in its gradle.properties) — always; Android 16 and later with a target of 36 or more — always, Android enforces it;
+ * Android 15 and later with a target of 35 or more — unless the theme opts out (`windowOptOutEdgeToEdgeEnforcement`
+ * true); Android 15 and later with a lower target — only when the theme sets that attribute to `false` itself; below
+ * Android 15 — never without the app's flag.
+ */
+internal object EdgeToEdgeDecision {
+    /**
+     * The decision for an app that asks for it or not ([appEnabled]), on Android [sdk], with [targetSdk], and the
+     * theme's `windowOptOutEdgeToEdgeEnforcement` ([themeOptOut]; null when the theme doesn't set it).
+     */
+    fun isEnabled(appEnabled: Boolean, sdk: Int, targetSdk: Int, themeOptOut: Boolean?): Boolean = when {
+        appEnabled -> true
+        sdk >= Build.VERSION_CODES.BAKLAVA && targetSdk >= Build.VERSION_CODES.BAKLAVA -> true
+        sdk >= Build.VERSION_CODES.VANILLA_ICE_CREAM && targetSdk >= Build.VERSION_CODES.VANILLA_ICE_CREAM ->
+            themeOptOut != true
+        sdk >= Build.VERSION_CODES.VANILLA_ICE_CREAM -> themeOptOut == false
+        else -> false
+    }
+}