@rnmapbox/maps 10.0.0-beta.49 → 10.0.0-beta.53

package/docs/snapshotManager.md

@@ -1,55 +0,0 @@
-<!-- This file was autogenerated from snapshotManager.js do not modify -->
-# <MapboxGL.snapshotManager />
-The snapshotManager generates static raster images of the map.
-Each snapshot image depicts a portion of a map defined by an SnapshotOptions object you provide.
-The snapshotter generates the snapshot asynchronous.
-
-
-## methods
-### takeSnap(options)
-
-Takes a snapshot of the base map using the provided Snapshot options. NOTE pitch, heading, zoomLevel only works when centerCoordinate is set!
-
-#### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-| `options` | `SnapshotOptions` | `Yes` | Snapshot options for create a static image of the base map |
-
-
-
-```javascript
-// creates a temp file png of base map
-const uri = await MapboxGL.snapshotManager.takeSnap({
-  centerCoordinate: [-74.126410, 40.797968],
-  width: width,
-  height: height,
-  zoomLevel: 12,
-  pitch: 30,
-  heading: 20,
-  styleURL: MapboxGL.StyleURL.Dark,
-  writeToDisk: true, // Create a temporary file
-});
-
-// creates base64 png of base map without logo
-const uri = await MapboxGL.snapshotManager.takeSnap({
-  centerCoordinate: [-74.126410, 40.797968],
-  width: width,
-  height: height,
-  zoomLevel: 12,
-  pitch: 30,
-  heading: 20,
-  styleURL: MapboxGL.StyleURL.Dark,
-  withLogo: false, // Disable Mapbox logo (Android only)
-});
-
-// creates snapshot with bounds
-const uri = await MapboxGL.snapshotManager.takeSnap({
-  bounds: [[-74.126410, 40.797968], [-74.143727, 40.772177]],
-  width: width,
-  height: height,
-  styleURL: MapboxGL.StyleURL.Dark,
-});
-```
-
-
-

package/scripts/.eslintrc.js

@@ -1,12 +0,0 @@
-module.exports = {
-  globals: {
-    camelCase: true,
-    pascelCase: true,
-    startAtSpace: true,
-    replaceNewLine: true,
-    exists: true,
-    androidInputType: true,
-    androidOutputType: true,
-    iosPropName: true,
-  },
-};

package/scripts/autogenHelpers/DocJSONBuilder.js

@@ -1,458 +0,0 @@
-const fs = require('fs');
-const path = require('path');
-const { exec } = require('child_process');
-
-const dir = require('node-dir');
-const docgen = require('react-docgen');
-const parseJsDoc = require('react-docgen/dist/utils/parseJsDoc').default;
-
-const JSDocNodeTree = require('./JSDocNodeTree');
-
-const COMPONENT_PATH = path.join(
-  __dirname,
-  '..',
-  '..',
-  'javascript',
-  'components',
-);
-const MODULES_PATH = path.join(__dirname, '..', '..', 'javascript', 'modules');
-
-const OUTPUT_PATH = path.join(__dirname, '..', '..', 'docs', 'docs.json');
-const IGNORE_FILES = [
-  'AbstractLayer',
-  'AbstractSource',
-  'NativeBridgeComponent',
-];
-const IGNORE_PATTERN = /\.web\./;
-
-const IGNORE_METHODS = ['setNativeProps'];
-
-const fileExtensionsRegex = /.(js|tsx|(?<!d.)ts)$/;
-
-class DocJSONBuilder {
-  constructor(styledLayers) {
-    this._styledLayers = {};
-
-    for (const styleLayer of styledLayers) {
-      let ComponentName = pascelCase(styleLayer.name);
-      const fakeLayers = ['Light', 'Atmosphere', 'Terrain'];
-      if (fakeLayers.includes(ComponentName)) {
-        this._styledLayers[ComponentName] = styleLayer;
-      } else {
-        this._styledLayers[ComponentName + 'Layer'] = styleLayer;
-      }
-    }
-  }
-
-  get options() {
-    return {
-      match: fileExtensionsRegex,
-      shortName: true,
-      sort: true,
-    };
-  }
-
-  isPrivateMethod(methodName = '') {
-    return !methodName || methodName.charAt(0) === '_';
-  }
-
-  postprocess(component, name) {
-    // Remove all private methods and parse examples from docblock
-
-    if (!Array.isArray(component.methods)) {
-      return;
-    }
-
-    component.name = name;
-
-    // Main description
-    component.description = component.description.replace(
-      /(\n*)(@\w+) (\{.*\})/g,
-      '',
-    );
-
-    // Styles
-    if (this._styledLayers[name] && this._styledLayers[name].properties) {
-      component.styles = [];
-
-      for (const prop of this._styledLayers[name].properties) {
-        const docStyle = {
-          name: prop.name,
-          type: prop.type,
-          values: [],
-          minimum: prop.doc.minimum,
-          maximum: prop.doc.maximum,
-          units: prop.doc.units,
-          default: prop.doc.default,
-          description: prop.doc.description,
-          requires: prop.doc.requires,
-          disabledBy: prop.doc.disabledBy,
-          allowedFunctionTypes: prop.allowedFunctionTypes || [],
-          expression: prop.expression,
-          transition: prop.transition,
-        };
-        if (prop.type === 'enum') {
-          docStyle.values = Object.keys(prop.doc.values).map((value) => {
-            return { value, doc: prop.doc.values[value].doc };
-          });
-        } else if (prop.type === 'array') {
-          docStyle.type = `${docStyle.type}<${prop.value}>`;
-        }
-
-        component.styles.push(docStyle);
-      }
-    }
-
-    function mapNestedProp(propMeta) {
-      const result = {
-        type: {
-          name: propMeta.name,
-          value: propMeta.value,
-        },
-        description: propMeta.description,
-        required: propMeta.required,
-      };
-      if (propMeta.value) {
-        result.type.value = propMeta.value;
-      }
-      return result;
-    }
-
-    function tsTypeDesc(tsType) {
-      if (!tsType?.name) {
-        return null;
-      }
-
-      if (tsType.name === 'signature') {
-        if (tsType.raw.length < 200) {
-          return `${tsType.raw
-            .replace(/(\n|\s)/g, '')
-            .replace(/(\|)/g, '\\|')}`;
-        } else {
-          return 'FIX ME FORMAT BIG OBJECT';
-        }
-      } else if (tsType.name === 'union') {
-        if (tsType.raw) {
-          // Props
-          return tsType.raw.replace(/\|/g, '\\|');
-        } else if (tsType.elements) {
-          // Methods
-          return tsType.elements.map((e) => e.name).join(' \\| ');
-        }
-      } else {
-        return tsType.name;
-      }
-    }
-
-    /**
-     * @typedef {{arguments: {type:TSType,name:string}[], return: TSType]}} TSFuncSignature
-     * @typedef {{key:string, value:TSType}[]} TSKVProperties
-     * @typedef {{properties: TSKVProperties}} TSObjectSignature
-     * @typedef {{name: 'void'}} TSVoidType
-     * @typedef {{name: string}} TSTypeType
-     * @typedef {{name: 'signature', type:'function', raw:string, signature: TSFuncSignature}} TSFunctionType
-     * @typedef {{name: 'signature', type:'object', raw:string, signature: TSObjectSignature}} TSObjectType
-     * @typedef {TSVoidType | TSFunctionType | TSTypeType | TSObjectType} TSType
-     */
-
-    /**
-     * @params {TSType} tsType
-     * @returns {tsType is TSFunctionType}
-     */
-    function tsTypeIsFunction(tsType) {
-      return tsType.type === 'function';
-    }
-
-    /**
-     * @params {TSType} tsType
-     * @returns {tsType is TSObjectType}
-     */
-    function tsTypeIsObject(tsType) {
-      return tsType.type === 'object';
-    }
-
-    /**
-     * @param {TSType} tsType
-     */
-    function tsTypeDump(tsType) {
-      if (tsTypeIsFunction(tsType)) {
-        let { signature } = tsType;
-        return `(${signature.arguments
-          .map(({ name, type }) => `${name}:${tsTypeDump(type)}`)
-          .join(', ')}) => ${tsTypeDump(signature.return)}`;
-      } else if (tsTypeIsObject(tsType)) {
-        let { signature } = tsType;
-        return `{${signature.properties
-          .map(({ key, value }) => `${key}: ${tsTypeDump(value)}`)
-          .join(', ')}}`;
-      } else {
-        return tsType.name;
-      }
-    }
-
-    function tsTypeDescType(tsType) {
-      if (!tsType?.name) {
-        return null;
-      }
-
-      if (tsType.name === 'signature' && tsType.type === 'object') {
-        const { properties } = tsType.signature;
-        if (properties) {
-          const value = properties.map((kv) => {
-            return mapProp(
-              mapNestedProp({ ...kv.value, description: kv.description }),
-              kv.key,
-              false,
-            );
-          });
-          return { name: 'shape', value };
-        } else if (tsType.raw.length < 200) {
-          return `${tsType.raw
-            .replace(/(\n|\s)/g, '')
-            .replace(/(\|)/g, '\\|')}`;
-        } else {
-          return 'FIX ME FORMAT BIG OBJECT';
-        }
-      } else if (tsType.name === 'signature' && tsType.type === 'function') {
-        return { name: 'func', funcSignature: tsTypeDump(tsType) };
-      } else if (tsType.name === 'union') {
-        if (tsType.raw) {
-          // Props
-          return tsType.raw.replace(/\|/g, '\\|');
-        } else if (tsType.elements) {
-          // Methods
-          return tsType.elements.map((e) => e.name).join(' \\| ');
-        }
-      } else {
-        return tsType.name;
-      }
-    }
-
-    function mapProp(propMeta, propName, array) {
-      let result = {};
-      if (!array) {
-        result = {
-          name: propName || 'FIX ME NO NAME',
-          required: propMeta.required || false,
-          type:
-            propMeta.type?.name ||
-            tsTypeDescType(propMeta.tsType) ||
-            'FIX ME UNKNOWN TYPE',
-          default: !propMeta.defaultValue
-            ? 'none'
-            : propMeta.defaultValue.value.replace(/\n/g, ''),
-          description: propMeta.description || 'FIX ME NO DESCRIPTION',
-        };
-        if (
-          result.type &&
-          result.type.name === 'func' &&
-          result.type.funcSignature
-        ) {
-          result.description = `${result.description}\n*signature:*\`${result.type.funcSignature}\``;
-        }
-      } else {
-        if (propName) {
-          result.name = propName;
-        }
-        if (propMeta.required !== undefined) {
-          result.required = propMeta.required;
-        }
-        result.type =
-          (propMeta.type && propMeta.type.name) ||
-          tsTypeDescType(propMeta.tsType) ||
-          'FIX ME UNKNOWN TYPE';
-        if (propMeta.defaultValue) {
-          result.default = propMeta.defaultValue.value.replace(/\n/g, '');
-        }
-        if (propMeta.description) {
-          result.description = propMeta.description;
-        }
-      }
-
-      if (
-        propMeta.type &&
-        propMeta.type.name === 'arrayOf' &&
-        propMeta.type.value
-      ) {
-        result.type = {
-          name: 'array',
-          value: mapProp(mapNestedProp(propMeta.type.value), undefined, true),
-        };
-      }
-
-      if (propMeta.type && propMeta.type.name === 'func') {
-        const jsdoc = parseJsDoc(propMeta.description);
-        if (jsdoc && jsdoc.description) {
-          result.description = jsdoc.description;
-        }
-        if (jsdoc && jsdoc.params && jsdoc.params.length > 0) {
-          result.params = jsdoc.params;
-        }
-        if (jsdoc && jsdoc.returns) {
-          result.returns = jsdoc.returns;
-        }
-      }
-      if (
-        propMeta.type &&
-        propMeta.type.name === 'shape' &&
-        propMeta.type.value
-      ) {
-        const type = propMeta.type.value;
-        const value = Object.keys(type).map((_name) =>
-          mapProp(mapNestedProp(type[_name]), _name, false),
-        );
-        result.type = { name: 'shape', value };
-      }
-      return result;
-    }
-
-    // props
-    component.props = Object.keys(component.props).map((propName) => {
-      const propMeta = component.props[propName];
-
-      return mapProp(propMeta, propName, false);
-    });
-
-    // methods
-    const privateMethods = [];
-    for (const method of component.methods) {
-      if (this.isPrivateMethod(method.name)) {
-        privateMethods.push(method.name);
-        continue;
-      }
-
-      if (method.docblock) {
-        const examples = method.docblock
-          .split('@')
-          .filter((block) => block.startsWith('example'));
-        method.examples = examples.map((example) =>
-          example.substring('example'.length),
-        );
-      }
-    }
-    privateMethods.push(...IGNORE_METHODS);
-
-    component.methods = component.methods.filter(
-      (method) => !privateMethods.includes(method.name),
-    );
-
-    component.methods.forEach((method) => {
-      method.params.forEach((param) => {
-        param.type = { name: tsTypeDesc(param.type) };
-      });
-    });
-
-    console.log(
-      `Processed ${component.name} (${component.props?.length ?? 0} props, ${
-        component.methods?.length ?? 0
-      } methods)`,
-    );
-  }
-
-  generateReactComponentsTask(results, filePath) {
-    return new Promise((resolve, reject) => {
-      dir.readFiles(
-        filePath,
-        this.options,
-        (err, content, fileNameWithExt, next) => {
-          if (err) {
-            return reject(err);
-          }
-
-          let fileName = fileNameWithExt.replace(/\.(js|tsx|ts$)/, '');
-          if (
-            IGNORE_FILES.includes(fileName) ||
-            fileName.match(IGNORE_PATTERN)
-          ) {
-            next();
-            return;
-          }
-
-          let parsedComponents = docgen.parse(content, {
-            babelOptions: {
-              filename: fileNameWithExt,
-            },
-          });
-          let [parsed] = parsedComponents;
-          fileName = fileName.replace(fileExtensionsRegex, '');
-          parsed.fileNameWithExt = fileNameWithExt;
-          results[fileName] = parsed;
-
-          this.postprocess(results[fileName], fileName);
-
-          return next();
-        },
-        () => resolve(),
-      );
-    });
-  }
-
-  generateModulesTask(results, filePath) {
-    return new Promise((resolve, reject) => {
-      exec(
-        `npx documentation build ${MODULES_PATH} -f json`,
-        (err, stdout, stderr) => {
-          if (err || stderr) {
-            reject(err || stderr);
-            return;
-          }
-
-          const modules = JSON.parse(stdout);
-          for (const module of modules) {
-            const node = new JSDocNodeTree(module);
-            const name = `${module.name
-              .charAt(0)
-              .toLowerCase()}${module.name.substring(1)}`;
-
-            const pathParts = module.context.file.split('/');
-            const fileNameWithExt = pathParts[pathParts.length - 1];
-
-            results[name] = {
-              name,
-              fileNameWithExt,
-              description: node.getText(),
-              props: [],
-              styles: [],
-              methods: node.getMethods(),
-            };
-          }
-
-          resolve();
-        },
-      );
-    });
-  }
-
-  sortObject(not_sorted) {
-    return Object.keys(not_sorted)
-      .sort()
-      .reduce(
-        (acc, key) => ({
-          ...acc,
-          [key]: not_sorted[key],
-        }),
-        {},
-      );
-  }
-
-  async generate() {
-    this.generateModulesTask({}, MODULES_PATH);
-
-    const results = {};
-
-    const tasks = [
-      this.generateReactComponentsTask(results, COMPONENT_PATH),
-      this.generateModulesTask(results, MODULES_PATH),
-    ];
-
-    return Promise.all(tasks).then(() => {
-      fs.writeFileSync(
-        OUTPUT_PATH,
-        JSON.stringify(this.sortObject(results), null, 2),
-      );
-      return true;
-    });
-  }
-}
-
-module.exports = DocJSONBuilder;

package/scripts/autogenHelpers/JSDocNodeTree.js

@@ -1,134 +0,0 @@
-class JSDocNodeTree {
-  constructor(root) {
-    this._root = root;
-  }
-
-  getChildrenByTag(node, tag) {
-    if (!node || !Array.isArray(node.children)) {
-      return [];
-    }
-    return node.children.filter((child) => child.type === tag);
-  }
-
-  getName() {
-    if (!this._root) {
-      return '';
-    }
-    return this._root.namespace;
-  }
-
-  getText() {
-    if (!this.hasChildren()) {
-      return '';
-    }
-
-    let text = '';
-    for (let paragraph of this.getChildrenByTag(
-      this._root.description,
-      'paragraph',
-    )) {
-      for (let textNode of this.getChildrenByTag(paragraph, 'text')) {
-        text += textNode.value;
-      }
-    }
-
-    return text;
-  }
-
-  getMethods() {
-    if (!this._hasArray(this._root.members, 'instance')) {
-      return [];
-    }
-
-    const methods = [];
-    for (let field of this._root.members.instance) {
-      if (field.kind !== 'function' || this._isPrivateMethod(field)) {
-        continue;
-      }
-
-      const node = new JSDocNodeTree(field);
-      methods.push({
-        name: field.name,
-        description: node.getText(),
-        params: this.getMethodParams(field),
-        examples: this.getExamples(field),
-        returns: this.getReturnValue(field),
-      });
-    }
-
-    return methods;
-  }
-
-  getMethodParams(field) {
-    if (!this._hasArray(field, 'params')) {
-      return [];
-    }
-
-    const methodParams = [];
-    for (let param of field.params) {
-      if (param.title !== 'param') {
-        continue;
-      }
-
-      const node = new JSDocNodeTree(param);
-      methodParams.push({
-        name: param.name,
-        description: node.getText(),
-        type: { name: this.getType(param.type) },
-        optional: param.type.type === 'OptionalType',
-      });
-    }
-
-    return methodParams;
-  }
-
-  getExamples(field) {
-    if (!this._hasArray(field, 'examples')) {
-      return [];
-    }
-    return field.examples.map((example) => example.description);
-  }
-
-  getReturnValue(field) {
-    if (!this._hasArray(field, 'returns')) {
-      return null;
-    }
-
-    const returnNode = field.returns[0];
-    const descriptionNode = new JSDocNodeTree(returnNode);
-
-    return {
-      description: descriptionNode.getText(),
-      type: { name: this.getType(returnNode.type) },
-    };
-  }
-
-  getType(typeNode) {
-    if (!typeNode) {
-      return '';
-    }
-
-    if (typeNode.expression) {
-      return typeNode.expression.name;
-    }
-
-    return typeNode.name || '';
-  }
-
-  hasChildren() {
-    return this._hasArray(this._root.description, 'children');
-  }
-
-  _hasArray(node, propName) {
-    if (!this._root) {
-      return false;
-    }
-    return Array.isArray(node[propName]) && node[propName].length;
-  }
-
-  _isPrivateMethod(field) {
-    return field.name.charAt(0) === '_';
-  }
-}
-
-module.exports = JSDocNodeTree;

package/scripts/autogenHelpers/MarkdownBuilder.js

@@ -1,38 +0,0 @@
-const fs = require('fs');
-const path = require('path');
-
-const ejs = require('ejs');
-
-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 (let componentPath of componentPaths) {
-      this.generateComponentFile(docJSON, componentPath);
-    }
-
-    console.log('Markdown is finish generating');
-  }
-}
-
-module.exports = MarkdownBuilder;