@maplibre/maplibre-react-native 10.0.0-alpha.24 → 10.0.0-alpha.26

package/docs/OfflineManager.md

@@ -1,246 +0,0 @@
-<!-- This file was autogenerated from offlineManager.js do not modify -->
-## <MapLibreGL.offlineManager />
-### OfflineManager implements a singleton (shared object) that manages offline packs.<br/>All of this class’s instance methods are asynchronous, reflecting the fact that offline resources are stored in a database.<br/>The shared object maintains a canonical collection of offline packs.
-
-
-### methods
-#### createPack(options[, progressListener][, errorListener])
-
-Creates and registers an offline pack that downloads the resources needed to use the given region offline.
-
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-| `options` | `OfflineCreatePackOptions` | `Yes` | Create options for a offline pack that specifices zoom levels, style url, and the region to download. |
-| `progressListener` | `Callback` | `No` | Callback that listens for status events while downloading the offline resource. |
-| `errorListener` | `Callback` | `No` | Callback that listens for status events while downloading the offline resource. |
-
-
-
-```javascript
-const progressListener = (offlineRegion, status) => console.log(offlineRegion, status);
-const errorListener = (offlineRegion, err) => console.log(offlineRegion, err);
-
-await MapLibreGL.offlineManager.createPack({
-  name: 'offlinePack',
-  styleURL: 'mapbox://...',
-  minZoom: 14,
-  maxZoom: 20,
-  bounds: [[neLng, neLat], [swLng, swLat]]
-}, progressListener, errorListener)
-```
-
-
-#### invalidatePack(name)
-
-Invalidates the specified offline pack. This method checks that the tiles in the specified offline pack match those from the server. Local tiles that do not match the latest version on the server are updated.This is more efficient than deleting the offline pack and downloading it again. If the data stored locally matches that on the server, new data will not be downloaded.
-
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-| `name` | `String` | `Yes` | Name of the offline pack. |
-
-
-
-```javascript
-await MapLibreGL.offlineManager.invalidatePack('packName')
-```
-
-
-#### deletePack(name)
-
-Unregisters the given offline pack and allows resources that are no longer required by any remaining packs to be potentially freed.
-
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-| `name` | `String` | `Yes` | Name of the offline pack. |
-
-
-
-```javascript
-await MapLibreGL.offlineManager.deletePack('packName')
-```
-
-
-#### invalidateAmbientCache()
-
-Forces a revalidation of the tiles in the ambient cache and downloads a fresh version of the tiles from the tile server.<br/>This is the recommend method for clearing the cache.<br/>This is the most efficient method because tiles in the ambient cache are re-downloaded to remove outdated data from a device.<br/>It does not erase resources from the ambient cache or delete the database, which can be computationally expensive operations that may carry unintended side effects.
-
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-
-
-
-
-```javascript
-await MapLibreGL.offlineManager.invalidateAmbientCache();
-```
-
-
-#### clearAmbientCache()
-
-Erases resources from the ambient cache.<br/>This method clears the cache and decreases the amount of space that map resources take up on the device.
-
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-
-
-
-
-```javascript
-await MapLibreGL.offlineManager.clearAmbientCache();
-```
-
-
-#### setMaximumAmbientCacheSize(size)
-
-Sets the maximum size of the ambient cache in bytes. Disables the ambient cache if set to 0.<br/>This method may be computationally expensive because it will erase resources from the ambient cache if its size is decreased.
-
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-| `size` | `Number` | `Yes` | Size of ambient cache. |
-
-
-
-```javascript
-await MapLibreGL.offlineManager.setMaximumAmbientCacheSize(5000000);
-```
-
-
-#### resetDatabase()
-
-Deletes the existing database, which includes both the ambient cache and offline packs, then reinitializes it.
-
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-
-
-
-
-```javascript
-await MapLibreGL.offlineManager.resetDatabase();
-```
-
-
-#### getPacks()
-
-Retrieves all the current offline packs that are stored in the database.
-
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-
-
-
-
-```javascript
-const offlinePacks = await MapLibreGL.offlineManager.getPacks();
-```
-
-
-#### getPack(name)
-
-Retrieves an offline pack that is stored in the database by name.
-
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-| `name` | `String` | `Yes` | Name of the offline pack. |
-
-
-
-```javascript
-const offlinePack = await MapLibreGL.offlineManager.getPack();
-```
-
-
-#### mergeOfflineRegions(path)
-
-Sideloads offline db
-
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-| `path` | `String` | `Yes` | Path to offline tile db on file system. |
-
-
-
-```javascript
-await MapLibreGL.offlineManager.mergeOfflineRegions(path);
-```
-
-
-#### setTileCountLimit(limit)
-
-Sets the maximum number of tiles that may be downloaded and stored on the current device.<br/>Consult the Terms of Service for your map tile host before changing this value.
-
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-| `limit` | `Number` | `Yes` | Map tile limit count. |
-
-
-
-```javascript
-MapLibreGL.offlineManager.setTileCountLimit(1000);
-```
-
-
-#### setProgressEventThrottle(throttleValue)
-
-Sets the period at which download status events will be sent over the React Native bridge.<br/>The default is 500ms.
-
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-| `throttleValue` | `Number` | `Yes` | event throttle value in ms. |
-
-
-
-```javascript
-MapLibreGL.offlineManager.setProgressEventThrottle(500);
-```
-
-
-#### subscribe(packName, progressListener, errorListener)
-
-Subscribe to download status/error events for the requested offline pack.<br/>Note that createPack calls this internally if listeners are provided.
-
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-| `packName` | `String` | `Yes` | Name of the offline pack. |
-| `progressListener` | `Callback` | `Yes` | Callback that listens for status events while downloading the offline resource. |
-| `errorListener` | `Callback` | `Yes` | Callback that listens for status events while downloading the offline resource. |
-
-
-
-```javascript
-const progressListener = (offlinePack, status) => console.log(offlinePack, status)
-const errorListener = (offlinePack, err) => console.log(offlinePack, err)
-MapLibreGL.offlineManager.subscribe('packName', progressListener, errorListener)
-```
-
-
-#### unsubscribe(packName)
-
-Unsubscribes any listeners associated with the offline pack.<br/>It's a good idea to call this on componentWillUnmount.
-
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-| `packName` | `String` | `Yes` | Name of the offline pack. |
-
-
-
-```javascript
-MapLibreGL.offlineManager.unsubscribe('packName')
-```
-
-
-

package/react-native.config.js

@@ -1,10 +0,0 @@
-module.exports = {
-  dependency: {
-    platforms: {
-      ios: {},
-      android: {
-        sourceDir: "./android/rctmln",
-      },
-    },
-  },
-};

package/scripts/download-style-spec.sh

@@ -1,15 +0,0 @@
-#!/bin/sh
-
-echo "Downloading MapLibre Style Spec"
-cd style-spec/
-
-FILENAME=v8.json
-
-if [ -e "./${FILENAME}" ]; then
-  echo "Removing old style spec ${FILENAME}"
-  rm "./${FILENAME}"
-fi
-
-echo "Fetching new style spec ${FILENAME}"
-curl -sS https://raw.githubusercontent.com/maplibre/maplibre-style-spec/main/src/reference/${FILENAME} -o ${FILENAME}
-cd ..

package/scripts/generate-docs.js

@@ -1,396 +0,0 @@
-require("./utils/template-globals");
-
-const { execSync } = require("child_process");
-const ejs = require("ejs");
-const prettierrc = require("eslint-config-universe");
-const fs = require("fs");
-const path = require("path");
-const prettier = require("prettier");
-
-const { camelCase } = require("./utils/template-globals");
-const styleSpecJSON = require("../style-spec/v8.json");
-const DocJSONBuilder = require("./utils/DocJSONBuilder");
-const MarkdownBuilder = require("./utils/MarkdownBuilder");
-
-function readIosVersion() {
-  const podspecPath = path.join(
-    __dirname,
-    "..",
-    "maplibre-react-native.podspec",
-  );
-  const lines = fs.readFileSync(podspecPath, "utf8").split("\n");
-  const maplibreLineRegex = /^\s+version:\s*"(\d+\.\d+\.\d+)"$/;
-  const maplibreLine = lines.filter((i) => maplibreLineRegex.exec(i))[0];
-  return `${maplibreLineRegex.exec(maplibreLine)[1]}.0`;
-}
-
-function readAndroidVersion() {
-  const buildGradlePath = path.join(
-    __dirname,
-    "..",
-    "android",
-    "rctmln",
-    "build.gradle",
-  );
-  const lines = fs.readFileSync(buildGradlePath, "utf8").split("\n");
-  const maplibreLineRegex =
-    /^\s+implementation\s+"org.maplibre.gl:android-sdk:(\d+\.\d+\.\d+)"$/;
-  const maplibreLine = lines.filter((i) => maplibreLineRegex.exec(i))[0];
-  return maplibreLineRegex.exec(maplibreLine)[1];
-}
-
-if (!styleSpecJSON) {
-  console.log(
-    'Could not find style spec, try running "yarn generate:fetch-style-spec"',
-  );
-  process.exit(1);
-}
-
-const layers = [];
-const androidVersion = readAndroidVersion();
-const iosVersion = readIosVersion();
-
-const TMPL_PATH = path.join(__dirname, "templates");
-
-const outputToExample = false;
-const OUTPUT_EXAMPLE_PREFIX = [
-  "..",
-  "example",
-  "node_modules",
-  "@maplibre",
-  "maplibre-react-native",
-];
-const OUTPUT_PREFIX = outputToExample ? OUTPUT_EXAMPLE_PREFIX : [".."];
-
-const IOS_OUTPUT_PATH = path.join(__dirname, ...OUTPUT_PREFIX, "ios", "RCTMLN");
-const ANDROID_OUTPUT_PATH = path.join(
-  __dirname,
-  ...OUTPUT_PREFIX,
-  "android",
-  "rctmln",
-  "src",
-  "main",
-  "java",
-  "com",
-  "maplibre",
-  "rctmln",
-  "components",
-  "styles",
-);
-const JS_OUTPUT_PATH = path.join(
-  __dirname,
-  ...OUTPUT_PREFIX,
-  "javascript",
-  "utils",
-);
-
-getSupportedLayers(Object.keys(styleSpecJSON.layer.type.values)).forEach(
-  (layerName) => {
-    layers.push({
-      name: layerName,
-      properties: getPropertiesForLayer(layerName),
-    });
-  },
-);
-
-// add light as a layer
-layers.push({ name: "light", properties: getPropertiesForLight() });
-
-function getPropertiesForLight() {
-  const lightAttributes = styleSpecJSON.light;
-
-  return getSupportedProperties(lightAttributes).map((attrName) => {
-    return Object.assign({}, buildProperties(lightAttributes, attrName), {
-      allowedFunctionTypes: [],
-    });
-  });
-}
-
-function getPropertiesForLayer(layerName) {
-  const paintAttributes = styleSpecJSON[`paint_${layerName}`];
-  const layoutAttributes = styleSpecJSON[`layout_${layerName}`];
-
-  const paintProps = getSupportedProperties(paintAttributes).map((attrName) => {
-    const prop = buildProperties(paintAttributes, attrName);
-
-    // overrides
-    if (["line-width"].includes(attrName)) {
-      prop.allowedFunctionTypes = ["camera"];
-    }
-
-    return prop;
-  });
-
-  const layoutProps = getSupportedProperties(layoutAttributes).map(
-    (attrName) => {
-      const prop = buildProperties(layoutAttributes, attrName);
-
-      // overrides
-      if (
-        [
-          "line-join",
-          "text-max-width",
-          "text-letter-spacing",
-          "text-anchor",
-          "text-justify",
-          "text-font",
-        ].includes(attrName)
-      ) {
-        prop.allowedFunctionTypes = ["camera"];
-      }
-      // Overide type padding
-      if (prop.type === "padding") {
-        prop.type = "array";
-        prop.value = "number";
-        prop.length = 4;
-      }
-      return prop;
-    },
-  );
-
-  return layoutProps.concat(paintProps);
-}
-
-function getSupportedLayers(layerNames) {
-  const layerMap = styleSpecJSON.layer.type.values;
-
-  const supportedLayers = [];
-  for (const layerName of layerNames) {
-    const layer = layerMap[layerName];
-    const support = getAttributeSupport(layer["sdk-support"]);
-
-    if (support.basic.android && support.basic.ios) {
-      supportedLayers.push(layerName);
-    }
-  }
-
-  return supportedLayers;
-}
-
-function getSupportedProperties(attributes) {
-  return Object.keys(attributes).filter((attrName) =>
-    isAttrSupported(attributes[attrName]),
-  );
-}
-
-function buildProperties(attributes, attrName) {
-  return {
-    name: camelCase(attrName),
-    doc: {
-      default: attributes[attrName].default,
-      minimum: attributes[attrName].minimum,
-      maximum: attributes[attrName].maximum,
-      units: attributes[attrName].units,
-      description: formatDescription(attributes[attrName].doc),
-      requires: getRequires(attributes[attrName].requires),
-      disabledBy: getDisables(attributes[attrName].requires),
-      values: attributes[attrName].values,
-    },
-    type: attributes[attrName].type,
-    value: attributes[attrName].value,
-    image: isImage(attrName),
-    translate: isTranslate(attrName),
-    transition: attributes[attrName].transition,
-    expression: attributes[attrName].expression,
-    expressionSupported:
-      Object.keys(attributes[attrName].expression || {}).length > 0,
-    support: getAttributeSupport(attributes[attrName]["sdk-support"]),
-    allowedFunctionTypes: getAllowedFunctionTypes(attributes[attrName]),
-  };
-}
-
-function formatDescription(description) {
-  const words = description.split(" ");
-
-  for (let i = 0; i < words.length; i++) {
-    const word = words[i];
-
-    if (word.includes("-")) {
-      words[i] = camelCase(word);
-    }
-  }
-
-  return words.join(" ");
-}
-
-function getRequires(requiredItems) {
-  const items = [];
-
-  if (!requiredItems) {
-    return items;
-  }
-
-  for (const item of requiredItems) {
-    if (typeof item === "string") {
-      items.push(camelCase(item, "-"));
-    }
-  }
-
-  return items;
-}
-
-function getDisables(disabledItems) {
-  const items = [];
-
-  if (!disabledItems) {
-    return items;
-  }
-
-  for (const item of disabledItems) {
-    if (item["!"]) {
-      items.push(camelCase(item["!"], "-"));
-    }
-  }
-
-  return items;
-}
-
-function isImage(attrName) {
-  return (
-    attrName.toLowerCase().indexOf("pattern") !== -1 ||
-    attrName.toLowerCase().indexOf("image") !== -1
-  );
-}
-
-function isTranslate(attrName) {
-  return attrName.toLowerCase().indexOf("translate") !== -1;
-}
-
-function isAttrSupported(attr) {
-  const support = getAttributeSupport(attr["sdk-support"]);
-  if (attr.private) {
-    return false;
-  }
-  return support.basic.android && support.basic.ios;
-}
-
-function getAttributeSupport(sdkSupport) {
-  const support = {
-    basic: { android: false, ios: false },
-    data: { android: false, ios: false },
-  };
-
-  const basicSupport = sdkSupport && sdkSupport["basic functionality"];
-  if (basicSupport && basicSupport.android) {
-    support.basic.android = isVersionGTE(androidVersion, basicSupport.android);
-  }
-  if (basicSupport && basicSupport.ios) {
-    support.basic.ios = isVersionGTE(iosVersion, basicSupport.ios);
-  }
-
-  const dataDrivenSupport = sdkSupport && sdkSupport["data-driven styling"];
-  if (dataDrivenSupport && dataDrivenSupport.android) {
-    support.data.android = isVersionGTE(
-      androidVersion,
-      dataDrivenSupport.android,
-    );
-  }
-  if (dataDrivenSupport && dataDrivenSupport.ios) {
-    support.data.ios = isVersionGTE(iosVersion, dataDrivenSupport.ios);
-  }
-
-  if (support.data.ios !== true || support.data.android !== true) {
-    support.data.ios = false;
-    support.data.android = false;
-  }
-
-  return support;
-}
-
-function isVersionGTE(version, otherVersion) {
-  const v = +version
-    .split(".")
-    .map((i) => String(i).padStart(3, "0"))
-    .join("");
-  const ov = +otherVersion
-    .split(".")
-    .map((i) => String(i).padStart(3, "0"))
-    .join("");
-  return v >= ov;
-}
-
-function getAllowedFunctionTypes(paintAttr) {
-  const allowedFunctionTypes = [];
-
-  if (paintAttr["zoom-function"]) {
-    allowedFunctionTypes.push("camera");
-  }
-
-  if (paintAttr["property-function"]) {
-    allowedFunctionTypes.push("source");
-    allowedFunctionTypes.push("composite");
-  }
-
-  return allowedFunctionTypes;
-}
-
-async function generate() {
-  const templateMappings = [
-    {
-      input: path.join(TMPL_PATH, "RCTMLNStyle.h.ejs"),
-      output: path.join(IOS_OUTPUT_PATH, "RCTMLNStyle.h"),
-    },
-    {
-      input: path.join(TMPL_PATH, "MaplibreStyles.ts.ejs"),
-      output: path.join(JS_OUTPUT_PATH, "MaplibreStyles.d.ts"),
-    },
-    {
-      input: path.join(TMPL_PATH, "RCTMLNStyle.m.ejs"),
-      output: path.join(IOS_OUTPUT_PATH, "RCTMLNStyle.m"),
-    },
-    {
-      input: path.join(TMPL_PATH, "RCTMLNStyleFactory.java.ejs"),
-      output: path.join(ANDROID_OUTPUT_PATH, "RCTMLNStyleFactory.java"),
-    },
-    {
-      input: path.join(TMPL_PATH, "styleMap.ts.ejs"),
-      output: path.join(JS_OUTPUT_PATH, "styleMap.ts"),
-    },
-  ];
-  const outputPaths = templateMappings.map((m) => m.output);
-
-  // autogenerate code
-  await Promise.all(
-    templateMappings.map(async ({ input, output }) => {
-      const filename = output.split("/").pop();
-      console.log(`Generating ${filename}`);
-      const tmpl = ejs.compile(fs.readFileSync(input, "utf8"), {
-        strict: true,
-      });
-      let results = tmpl({ layers });
-      if (filename.endsWith("ts")) {
-        results = await prettier.format(results, {
-          ...prettierrc,
-          filepath: filename,
-        });
-        // Ensure all enums are exported
-        results = results.replace(/enum (\w+Enum) \{[^}]+\}\n/g, "export $&");
-        // Replace Array<any> with any[]
-        results = results.replace(/Array<any>/g, "any[]");
-        // Replace padding type with float array
-        results = results.replace(/padding: string;/g, "padding: number[];");
-      }
-      fs.writeFileSync(output, results);
-    }),
-  );
-
-  // autogenerate docs
-  const docBuilder = new DocJSONBuilder(layers);
-  const markdownBuilder = new MarkdownBuilder();
-  await docBuilder.generate();
-  await markdownBuilder.generate();
-
-  // Check if any generated files changed
-  try {
-    execSync(`git diff --exit-code docs/ ${outputPaths.join(" ")}`);
-  } catch (_error) {
-    console.error(
-      "\n\nThere are unstaged changes in the generated code. " +
-        "Please add them to your commit.\n" +
-        'If you would really like to exclude them, run "git commit -n" to skip.\n\n',
-    );
-    process.exit(1);
-  }
-}
-
-generate();

package/scripts/utils/MarkdownBuilder.js

@@ -1,37 +0,0 @@
-const ejs = require("ejs");
-const fs = require("fs");
-const path = require("path");
-
-const TMPL_PATH = path.join(__dirname, "..", "templates");
-const TMPL_FILE = fs.readFileSync(
-  path.join(TMPL_PATH, "component.md.ejs"),
-  "utf8",
-);
-
-class MarkdownBuilder {
-  generateComponentFile(docJSON, componentName) {
-    const tmpl = ejs.compile(TMPL_FILE, { strict: true });
-    const fileContents = tmpl({ component: docJSON[componentName] });
-    fs.writeFileSync(
-      path.join(__dirname, "..", "..", "docs", `${componentName}.md`),
-      fileContents,
-    );
-  }
-
-  generate() {
-    const docJSONFile = fs.readFileSync(
-      path.join(__dirname, "..", "..", "docs", "docs.json"),
-      "utf8",
-    );
-    const docJSON = JSON.parse(docJSONFile);
-    const componentPaths = Object.keys(docJSON);
-
-    for (const componentPath of componentPaths) {
-      this.generateComponentFile(docJSON, componentPath);
-    }
-
-    console.log("Markdown is finished generating");
-  }
-}
-
-module.exports = MarkdownBuilder;