Shared Modules

Shared Modules are permissionless collections of resources that can be shared between other extensions and apps. Common uses of Shared Modules are:

  • As an API. You can distribute a Shared Module that can provide HTML, JS, and other source to provide an API which can be updated independently of the extensions that depend on it. This can be useful for runtimes and game engines, where apps are often smaller payloads of data that run on the Shared Module's code.
  • As a download optimization. The Shared Module contains common resources used by many extensions. It's downloaded once, the first time a dependent extension is installed.

Manifest

Shared Modules are used through two manifest fields: export and import.

The export field indicates an extension is a Shared Module that exports its resources:

{
  "version": "1.0",
  "name": "My Shared Module",
  "export": {
    // Optional list of extension IDs explicitly allowed to
    // import this Shared Module's resources.  If no whitelist
    // is given, all extensions are allowed to import it.
    "whitelist": [
      "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"
    ]
  }
  // Note: no permissions are allowed in Shared Modules
}

The import field is used by extensions and apps to declare that they depend on the resources from particular Shared Modules:

{
  "version": "1.0",
  "name": "My Importing Extension",
  ...
  "import": [
    {"id": "cccccccccccccccccccccccccccccccc"},
    {"id": "dddddddddddddddddddddddddddddddd"
     "minimum_version": "0.5" // optional
    },
  ]
}

Accessing Resources

Shared Module resources are accessed by a reserved path _modules/<shared_module_id> in the root of your importing extension. For example, to include the script 'foo.js' from a Shared Module with ID "cccccccccccccccccccccccccccccccc", use this path from the root of your extension:

<script src="_modules/cccccccccccccccccccccccccccccccc/foo.js">

If the importing extension has ID "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", then the full URL to resources in the Shared Module is:

chrome-extension://aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/_modules/cccccccccccccccccccccccccccccccc/

Note that since resources from Shared Modules are overlaid into the origin of the importing extension, all privileges granted to the importing extension are available to code in Shared Modules. Also, the Shared Module is able to access resources in the importing extension by using absolute paths.

Install / Uninstall

A Shared Module is automatically installed from the Chrome Web Store when needed by a dependent extension, and automatically uninstalled when the last extension which references it is uninstalled. In order to upload an extension which uses a Shared Module, the Shared Module must be published in the Chrome Web Store and the extension must not be restricted from using the Shared Module by its whitelist.

During development, you will need to manually install any Shared Modules your extension uses. Automatic installs do not happen for extensions that are side-loaded or loaded as unpacked extensions. For locally installed, unpacked Shared Modules, you must use the key field to ensure the Shared Modules use the correct IDs.