@maplibre/maplibre-react-native 10.0.0-alpha.25 → 10.0.0-alpha.27

package/scripts/templates/component.md.ejs

@@ -2,123 +2,124 @@
   const component = locals.component;
   const helpers = locals.helpers;
 -%>
-<!-- DO NOT MODIFY! -->
-<!-- This file is auto-generated from <%- component.filePath %> -->
-## <MapLibreGL.<%- component.name %> />
-### <%- helpers.replaceNewLine(component.description) %>
+<!-- <%= helpers.autoGeneratedHeader.doNotModify %> -->
+<!-- <%= helpers.autoGeneratedHeader.generatedFrom(component.filePath) %> -->
+# `<MapLibreGL.<%- component.name %> />`
+<%- helpers.replaceNewLine(component.description) %>
 
 <%_ if (component.props && component.props.length) { _%>
-### props
+## Props
 | Prop | Type | Default | Required | Description |
 | ---- | :--: | :-----: | :------: | :----------: |
 <%- helpers.propMarkdownTableRows(component) %>
 <%_ } _%>
 
 <%_ if (component.methods && component.methods.length) { _%>
-### methods
+## Methods
 <%_ for (let method of component.methods) { _%>
-#### <%- helpers.getMarkdownMethodSignature(method) %>
+### <%- helpers.getMarkdownMethodSignature(method) %>
 
 <%- helpers.replaceNewLine(method.description) %>
 
-##### arguments
+<%_ if (method.params && method.params.length) { _%>
+#### Arguments
 | Name | Type | Required | Description  |
 | ---- | :--: | :------: | :----------: |
 <%- helpers.methodMarkdownTableRow(method) %>
+<%_ } _%>
 
 <%- helpers.getMarkdownMethodExamples(method) %>
 <%_ } _%>
 <%_ } _%>
 
 <%_ if (component.styles && component.styles.length) { _%>
-### styles
+## Styles
 
 <%_ for (let i = 0; i < component.styles.length; i++) { _%>
 <%
 const style = component.styles[i];
 -%>
-* <a href="#name<%- i > 0 ? '-' + i : '' -%>"><%- style.name %></a><br/>
+* <a href="#name<%- i > 0 ? '-' + i : '' -%>">`<%- style.name %>`</a><br/>
 <%_ } _%>
 
 <%_ for (let style of component.styles) { _%>
-___
 
-#### Name
-`<%- style.name %>`
+### `<%- style.name %>`
 
-#### Description
 <%- style.description %>
 
-#### Type
-`<%- style.type %>`
-<%_ if (helpers.exists(style.default)) { _%>
-#### Default Value
-`<%= helpers.getStyleDefaultValue(style) %>`
-<%_ } _%>
-
-<%_ if (style.type === 'enum') { _%>
-#### Supported Values
-<%_ for (var i = 0; i < style.values.length; i++) { _%>
-**<%- style.values[i].value %>** - <%- style.values[i].doc %><br />
-<%_ } _%>
-
-<%_ } _%>
-<%_ if (helpers.exists(style.units)) { _%>
-#### Units
-`<%- style.units %>`
-
-<%_ } _%>
-<%_ if (helpers.exists(style.minimum)) { _%>
-#### Minimum
-`<%- style.minimum %>`
-
-<%_ } _%>
-
-<%_ if (helpers.exists(style.maximum)) { _%>
-#### Maximum
-`<%- style.maximum %>`
-
-<%_ } _%>
-<%_ if (style.requires.length) { _%>
-#### Requires
-`<%- style.requires.join(', ') %>`
-
-<%_ } _%>
-<%_ if (style.disabledBy.length) { _%>
-#### Disabled By
-`<%- style.disabledBy.join(', ') %>`
-
-<%_ } _%>
-<%_ if (style.allowedFunctionTypes.length) { _%>
-#### Supported Style Functions
-`<%- style.allowedFunctionTypes.join(', ') %>`
-<%_ } _%>
-<%_ if (style.expression) { _%>
-#### Expression
+<dl>
+    <dt>Type</dt>
+    <dd>
+        <code><%- style.type %></code>
+    </dd>
+    <%_ if (helpers.exists(style.default)) { _%>
+        <dt>Default Value</dt>
+        <dd><code><%= helpers.getStyleDefaultValue(style) %></code></dd>
+    <%_ } _%>
+    <%_ if (style.type === 'enum') { _%>
+    <dt>Supported Values</dt>
+    <dd>
+        <ul>
+            <%_ for (var i = 0; i < style.values.length; i++) { _%>
+                <li>
+                    <code><%- style.values[i].value %></code>: <%- style.values[i].doc %>
+                </li>
+            <%_ } _%>
+            <%_ } _%>
+        </ul>
+    </dd>
+    <%_ if (helpers.exists(style.units)) { _%>
+        <dt>Units</dt>
+        <dd><code><%- style.units %></code></dd>
+    <%_ } _%>
+    <%_ if (helpers.exists(style.minimum)) { _%>
+        <dt>Minimum</dt>
+        <dd><code><%- style.minimum %></code></dd>
+    <%_ } _%>
+    <%_ if (helpers.exists(style.maximum)) { _%>
+        <dt>Maximum</dt>
+        <dd><code><%- style.maximum %></code></dd>
+    <%_ } _%>
+    <%_ if (style.requires.length) { _%>
+        <dt>Requires</dt>
+        <dd><code><%- style.requires.join(', ') %></code></dd>
+    <%_ } _%>
+    <%_ if (style.disabledBy.length) { _%>
+        <dt>Disabled By</dt>
+        <dd><code><%- style.disabledBy.join(', ') %></code></dd>
+    <%_ } _%>
+    <%_ if (style.allowedFunctionTypes.length) { _%>
+        <dt>Supported Style Functions</dt>
+        <dd><code><%- style.allowedFunctionTypes.join(', ') %></code></dd>
+    <%_ } _%>
+    <%_ if (style.expression) { _%>
+        <dt>Expression Parameters</dt>
+        <dd><code><%- (style.expression.parameters || []).join(', ') %></code></dd>
+    <%_ } _%>
+</dl>
 
-Parameters: `<%- (style.expression.parameters || []).join(', ') %>`
-<%_ } _%>
 <%_ if (style.transition) { _%>
-___
-
-#### Name
-
-`<%- style.name %>Transition`
-
-#### Description
-
-The transition affecting any changes to this layer’s <%- style.name %> propery.
-
-#### Type
-
-`{ duration, delay }`
-
-#### Units
-`milliseconds`
-
-#### Default Value
-`{duration: 300, delay: 0}`
-
+### `<%- style.name %>Transition`
+
+The transition affecting any changes to this layer’s <%- style.name %> property.
+
+<dl>
+  <dt>Type</dt>
+  <dd>
+    <code>{ duration, delay }</code>
+  </dd>
+
+  <dt>Units</dt>
+  <dd>
+    <code>milliseconds</code>
+  </dd>
+
+  <dt>Default Value</dt>
+  <dd>
+    <code>{duration: 300, delay: 0}</code>
+  </dd>
+</dl>
 <%_ } %>
 <%_ } _%>
 <%_ } _%>

package/scripts/templates/styleMap.ts.ejs

@@ -3,8 +3,8 @@
   const helpers = locals.helpers;
 -%>
 /* eslint-disable */
-// DO NOT MODIFY
-// THIS FILE IS AUTOGENERATED
+// <%= helpers.autoGeneratedHeader.doNotModify %>
+// <%= helpers.autoGeneratedHeader.generatedFrom(locals.filePath) %>
 
 import { isAndroid } from './index';
 

package/scripts/utils/MarkdownBuilder.ts

@@ -4,18 +4,18 @@ import path from "node:path";
 
 import * as TemplateHelpers from "./TemplateHelpers";
 
-const TMPL_PATH = path.join(__dirname, "..", "templates");
+const TEMPLATE_PATH = path.join(__dirname, "..", "templates");
 
 export class MarkdownBuilder {
   async generateComponentFile(docJSON: any, componentName: string) {
-    const tmpl = ejs.compile(
-      await fs.readFile(path.join(TMPL_PATH, "component.md.ejs"), "utf8"),
+    const template = ejs.compile(
+      await fs.readFile(path.join(TEMPLATE_PATH, "component.md.ejs"), "utf8"),
       {
         async: true,
         strict: true,
       },
     );
-    const fileContents = await tmpl({
+    const fileContents = await template({
       component: docJSON[componentName],
       helpers: TemplateHelpers,
     });

package/scripts/utils/TemplateHelpers.ts

@@ -40,6 +40,12 @@ const iosSpecOverrides: Record<string, string> = {
   "text-writing-mode": "text-writing-modes",
 };
 
+export const autoGeneratedHeader = {
+  doNotModify: "DO NOT MODIFY",
+  generatedFrom: (filePath: string) =>
+    `This file is auto-generated from ${filePath}`,
+};
+
 export function exists<T>(value: T): value is NonNullable<T> {
   return typeof value !== "undefined" && value !== null;
 }
@@ -461,7 +467,7 @@ export function getMarkdownMethodSignature(method: {
     .map((param) => (param.optional ? `[${param.name}]` : param.name))
     .join(", ");
 
-  return `${method.name}(${params})`;
+  return `\`${method.name}(${params})\``;
 }
 
 export function getMarkdownMethodExamples(method: any) {

package/scripts/utils/getNativeVersion.ts

@@ -20,7 +20,7 @@ let cachedIosVersion: string;
 export const getAndroidVersion = async () => {
   if (!cachedAndroidVersion) {
     cachedAndroidVersion = await getNativeVersion(
-      ["android", "rctmln", "build.gradle"],
+      ["android", "build.gradle"],
       /^\s+implementation\s+"org.maplibre.gl:android-sdk:(\d+\.\d+\.\d+)"$/,
     );
   }

package/.husky/pre-commit

@@ -1,5 +0,0 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
-yarn lint-staged
-yarn codegen

package/android/rctmln/.settings/org.eclipse.buildship.core.prefs

@@ -1,2 +0,0 @@
-connection.project.dir=../../packages/react-native-app/android
-eclipse.preferences.version=1

package/android/rctmln/build.gradle

@@ -1,64 +0,0 @@
-apply plugin: 'com.android.library'
-
-def safeExtGet(prop, fallback) {
-    rootProject.ext.has(prop) ? rootProject.ext.get(prop) : fallback
-}
-
-def isNewArchitectureEnabled() {
-    return project.hasProperty("newArchEnabled") && project.newArchEnabled == "true"
-}
-
-android {
-    compileSdkVersion safeExtGet("compileSdkVersion", 33)
-    buildToolsVersion safeExtGet("buildToolsVersion", '33.0.1')
-
-    defaultConfig {
-        minSdkVersion safeExtGet('minSdkVersion', 16)
-        targetSdkVersion safeExtGet('targetSdkVersion', 26)
-        versionCode 1
-        versionName "1.0"
-        buildConfigField("boolean", "IS_NEW_ARCHITECTURE_ENABLED", isNewArchitectureEnabled().toString())
-    }
-
-    compileOptions {
-        sourceCompatibility JavaVersion.VERSION_1_8
-        targetCompatibility JavaVersion.VERSION_1_8
-    }
-
-    buildTypes {
-        release {
-            minifyEnabled false
-            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
-        }
-    }
-}
-
-dependencies {
-    // The version of react-native is set by the React Native Gradle Plugin
-    implementation("com.facebook.react:react-android")
-
-    // MapLibre SDK
-    implementation "org.maplibre.gl:android-sdk:11.5.0"
-    implementation "org.maplibre.gl:android-sdk-turf:6.0.1"
-
-    // Dependencies
-    implementation "androidx.vectordrawable:vectordrawable:1.1.0"
-    implementation "androidx.annotation:annotation:1.7.0"
-    implementation "androidx.appcompat:appcompat:1.6.1"
-    implementation "com.squareup.okhttp3:okhttp:${safeExtGet('okhttpVersion', '4.9.0')}"
-    implementation "com.squareup.okhttp3:okhttp-urlconnection:${safeExtGet('okhttpVersion', '4.9.0')}"
-
-
-    // MapLibre plugins
-    implementation ("org.maplibre.gl:android-plugin-localization-v9:3.0.1")
-    implementation ("org.maplibre.gl:android-plugin-annotation-v9:3.0.1")
-    implementation ("org.maplibre.gl:android-plugin-markerview-v9:3.0.1")
-}
-
-allprojects {
-    repositories {
-        maven {
-            url = "https://dl.bintray.com/maplibre/maplibre-gl-native"
-        }
-    }
-}

package/android/rctmln/proguard-rules.pro

@@ -1,25 +0,0 @@
-# Add project specific ProGuard rules here.
-# By default, the flags in this file are appended to flags specified
-# in /Users/nickitaliano/Library/Android/sdk/tools/proguard/proguard-android.txt
-# You can edit the include path and order by changing the proguardFiles
-# directive in build.gradle.
-#
-# For more details, see
-#   http://developer.android.com/guide/developing/tools/proguard.html
-
-# Add any project specific keep options here:
-
-# If your project uses WebView with JS, uncomment the following
-# and specify the fully qualified class name to the JavaScript interface
-# class:
-#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
-#   public *;
-#}
-
-# Uncomment this to preserve the line number information for
-# debugging stack traces.
-#-keepattributes SourceFile,LineNumberTable
-
-# If you keep the line number information, uncomment this to
-# hide the original source file name.
-#-renamesourcefileattribute SourceFile