react-native-libraries.schema.json

{
  "definitions": {},
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://github.com/react-native-community/directory/blob/main/react-native-libraries.schema.json",
  "type": "array",
  "title": "React Native Directory entries",
  "items": {
    "$id": "#/items",
    "type": "object",
    "title": "React Native Directory package entry",
    "required": [
      "githubUrl"
    ],
    "properties": {
      "githubUrl": {
        "$id": "#/items/properties/githubUrl",
        "type": "string",
        "title": "Package GitHub repository URL",
        "default": "",
        "examples": [
          "https://github.com/joshswan/react-native-autolink"
        ],
        "pattern": "^(.*)$"
      },
      "ios": {
        "$id": "#/items/properties/ios",
        "type": "boolean",
        "title": "Package supports iOS",
        "default": false,
        "examples": [
          true
        ]
      },
      "android": {
        "$id": "#/items/properties/android",
        "type": "boolean",
        "title": "Package supports Android",
        "default": false,
        "examples": [
          true
        ]
      },
      "windows": {
        "$id": "#/items/properties/windows",
        "type": "boolean",
        "title": "Package supports Windows (react-native-windows)",
        "default": false,
        "examples": [
          true
        ]
      },
      "macos": {
        "$id": "#/items/properties/macos",
        "type": "boolean",
        "title": "Package supports macOS (react-native-macos)",
        "default": false,
        "examples": [
          true
        ]
      },
      "tvos": {
        "$id": "#/items/properties/tvos",
        "type": "boolean",
        "title": "Package supports tvOS (react-native-tvos)",
        "default": false,
        "examples": [
          true
        ]
      },
      "fireos": {
        "$id": "#/items/properties/fireos",
        "type": "boolean",
        "title": "Package is compatible with Fire OS",
        "default": false,
        "examples": [
          true
        ]
      },
      "expoGo": {
        "$id": "#/items/properties/expo",
        "type": "boolean",
        "title": "Package is compatible with Expo Go",
        "default": false,
        "examples": [
          true
        ]
      },
      "examples": {
        "$id": "#/items/properties/examples",
        "type": "array",
        "title": "List of example projects or Snacks URLs",
        "default": null,
        "items": {
          "$id": "#/items/properties/examples/items",
          "type": "string",
          "title": "Example entry URL",
          "default": "",
          "examples": [
            "https://github.com/expo/examples/tree/master/with-video-background",
            "https://snack.expo.io/SkRP2Ehrb"
          ],
          "pattern": "^(.*)$"
        }
      },
      "images": {
        "$id": "#/items/properties/images",
        "type": "array",
        "title": "List of image URLs demonstrating package functionality",
        "default": [
          null
        ],
        "items": {
          "$id": "#/items/properties/images/items",
          "type": "string",
          "title": "Image entry URL",
          "default": "",
          "examples": [
            "https://reactnative.dev/img/homepage/phones.png",
            "https://github.com/mattermost/react-native-paste-input/blob/master/example/gifs/iOSPasteInput.gif?raw=true"
          ],
          "pattern": "^(http(s?):)(\\w|\\/|\\.|:|-|%|\\+|\\*)+\\.(?:jp(e?)g|gif|png|webp|JP(E?)G|GIF|PNG|WEBP)(\\?\\S*)?$"
        }
      },
      "npmPkg": {
        "$id": "#/items/properties/npmPkg",
        "type": "string",
        "title": "npm package name in the registry (mostly for scoped packages)",
        "default": "",
        "examples": [
          "@expo/ex-navigation"
        ],
        "pattern": "^(@[a-z0-9-~][a-z0-9-._~]*/)?[a-z0-9-~][a-z0-9-._~]*$"
      },
      "unmaintained": {
        "$id": "#/items/properties/unmaintained",
        "type": [
          "boolean",
          "string"
        ],
        "title": "Package is unmaintained or archived",
        "default": false,
        "examples": [
          true,
          "expo-image"
        ]
      },
      "dev": {
        "$id": "#/items/properties/dev",
        "type": "boolean",
        "title": "Package is a Development Tool (should be installed as 'devDependency')",
        "default": false,
        "examples": [
          true
        ]
      },
      "template": {
        "$id": "#/items/properties/template",
        "type": "boolean",
        "title": "Package is a project template",
        "default": false,
        "examples": [
          true
        ]
      },
      "newArchitecture": {
        "$id": "#/items/properties/newArchitecture",
        "type": [
          "boolean",
          "string"
        ],
        "title": "Package supports New Architecture",
        "default": false,
        "examples": [
          true,
          "Only iOS supported"
        ]
      },
      "newArchitectureNote": {
        "$id": "#/items/properties/newArchitectureNote",
        "type": "string",
        "title": "Optional note about the New Architecture support",
        "default": "",
        "examples": [
          "Refer to https://github.com/MinaSamir11/react-native-in-app-review/issues/169 for the latest status"
        ]
      },
      "alternatives": {
        "$id": "#/items/properties/alternatives",
        "type": "array",
        "title": "Optional alternative libraries to use, if the library is not maintained anymore or does not support the New Architecture",
        "default": [
          null
        ],
        "items": {
          "$id": "#/items/properties/alternatives/items",
          "type": "string",
          "title": "Alternative library npm package name",
          "default": "",
          "examples": [
            "expo-image"
          ],
          "pattern": "^(@[a-z0-9-~][a-z0-9-._~]*/)?[a-z0-9-~][a-z0-9-._~]*$"
        }
      }
    }
  }
}