共有モジュール

共有モジュールは、拡張機能間で共有できる、権限のないリソースのコレクションです。共有モジュールの一般的な用途は次のとおりです。

  • API として。HTML、JS、その他のリソースを提供できる共有モジュールを配布して、それに依存する拡張機能とは別に更新できる API を提供できます。
  • ダウンロードを最適化するため。共有モジュールには、多くの拡張機能で使用される共通のリソースが含まれています。ダウンロードは、依存する拡張機能が初めてインストールされたときに 1 回だけ行われます。

マニフェスト

共有モジュールは、"export" と "import" の 2 つのマニフェスト フィールドで使用されます。

エクスポート

export フィールドは、拡張機能がリソースをエクスポートする共有モジュールであることを示します。

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

インポート

import フィールドは、拡張機能とアプリが特定の共有モジュールのリソースへの依存を宣言するために使用されます。

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

リソースへのアクセス

共有モジュール リソースには、インポートする拡張機能のルートにある予約済みパス _modules/SHARED_MODULE_ID によってアクセスされます。たとえば、ID が「cccccccccccccccccccccccccccccc」の共有モジュールの foo.js スクリプトを含めるには、拡張機能のルートから次のパスを使用します。

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

インポートする拡張機能の ID が「aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa」の場合、共有モジュール内のリソースの完全な URL は次のようになります。

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

共有モジュールのリソースはインポート拡張機能のオリジンにオーバーレイされるため、インポート拡張機能に付与されているすべての権限は共有モジュール内のコードで使用できます。また、共有モジュールは、絶対パスを使用して、インポートする拡張機能のリソースにアクセスできます。

インストール / アンインストール

共有モジュールは、依存している拡張機能が必要とするときに Chrome ウェブストアから自動的にインストールされ、それを参照している最後の拡張機能がアンインストールされると、自動的にアンインストールされます。 共有モジュールを使用する拡張機能をアップロードするには、その共有モジュールが Chrome ウェブストアで公開されている必要があります。また、許可リストによって拡張機能の共有モジュールの使用が制限されていない必要があります。

開発中に、拡張機能で使用する共有モジュールを手動でインストールする必要があります。サイドローディングされた拡張機能や、パッケージ化されていない拡張機能として読み込まれた拡張機能については、自動インストールは行われません。ローカルにインストールされ、パッケージ化されていない共有モジュールの場合は、key フィールドを使用して、共有モジュールが正しい ID を使用するようにする必要があります。