MiniApp パッケージング

MiniAppルートディレクトリーは、MiniAppパッケージファイルシステムの基底 ディレクトリーです。

ルートディレクトリーは、MiniAppパッケージのものであり、 MiniAppのライフサイクル管理に関するグローバルデータおよび情報を含む複数の予約済みファイルを保持します。これには次のものが含まれます:

manifest.json

MiniAppマニフェストは、MiniAppのグローバル構成を担うJSON文書です。マニフェストファイルには、 MiniApp Manifest仕様 [MINIAPP-MANIFEST]に従って、ページのルートおよびパス、 MiniAppのウィンドウ構成（例: ナビゲーションバーのスタイル、背景画像、 背景色、ページタイトルなど）を含むMiniAppの設定を示す必須および任意の 属性の集合が含まれます。

app.css

このファイルはアプリケーションのメインスタイルシートであり、開発者がMiniApp内のページの共通スタイルおよび ルックアンドフィールの側面を定義する場所です。これは空であってもよい。

app.js

このスクリプト文書にはMiniAppの基本サービスロジックがあり、MiniApp Lifecycle [MINIAPP-LIFECYCLE]における、MiniAppの起動、表示、非表示のための イベント管理を含む、MiniAppライフサイクルの基本的な構成および制御が含まれます。

pagesディレクトリーには、MiniAppページの表示およびユーザーインタラクションのための一連のファイルが含まれます。

MiniAppページは、一意のファイル名 （例: intro）およびリソース型を定義する特定の拡張子によって識別される、一連のリソースによって定義されます。たとえば、アプリケーションのビジネスロジック （例: intro.js）、構造およびコンテンツ（例: intro.html）、および スコープ付きスタイルシート（例: intro.css）です。

開発者は、必要に応じて他の型のリソースを含めても よい。また、ページに関連するファイル（同じファイル名で識別される）は、各ページ用の特定のサブディレクトリーに整理しても、 pagesディレクトリー直下に保存してもよい。

/
|___manifest.json
|___app.js
|___app.css
|___pages/
        |___detail.js
        |___detail.html
        |___detail.css
        |___list.js
        |___list.html
        |___list.css

/
|___manifest.json
|___app.js
|___app.css
|___pages/
        |___detail/
                |___detail.js
                |___detail.html
                |___detail.css
        |___list
                |___list.js
                |___list.html
                |___list.css

• .htmlリソースは、MiniAppページの構造およびコンテンツを定義します。HTMLに基づき、この型のファイルの構文、構造、およびその他の 要件はHTML リソースセクションで定義されます。
• .cssリソースは、MiniAppページのスタイルシートを定義します。この型のリソースの構文、 構造、およびその他の要件はCSSリソースセクションで定義されます。
• .jsリソースには、アプリケーションの運用に必要な関数、データ、およびその他の構成 要素を含む、MiniAppページのビジネスロジックが含まれます。この型のリソースは、 MiniApp Lifecycle仕様 [MINIAPP-LIFECYCLE]で定義されるように、 MiniAppページの設定およびライフサイクル管理を担います。 これらの型のファイルの構文および形式はスクリプティングリソースセクションで定義されます。

任意のcommonディレクトリーには、MiniApp内のページからアクセス可能な、コンポーネント、マルチメディアリソース、文書、ライブラリーなどのリソースが含まれます。このディレクトリーの内部構造は 柔軟であるため、これらの共通リソースは必要に応じてカスタマイズされた サブディレクトリー内に、また異なる命名規則を用いて整理してもよい。

任意のi18nディレクトリーは、ルートディレクトリー内の サブディレクトリーであり、MiniAppパッケージのローカライゼーションリソースを含みます。

i18nディレクトリーには、MiniAppコンテンツの 国際化をサポートするための多言語ローカライゼーションリソースが含まれます。このディレクトリー内の各.json文書のファイル名は、 [BCP47]で定義されるLanguage-Tag表記に従い、 その特定の言語に対する具体的な構成を表します。

i18nディレクトリーは、MiniAppがサポートする言語またはロケールの数に応じて、 任意の数のローカライゼーションリソースを含んでもよい。これらのファイルの形式は、 ローカライゼーションリソースセクションで定義されます。

MiniAppパッケージ内のすべてのファイル名およびパス名は、オペレーティングシステムの潜在的な 制限に対応し、プラットフォームおよびファイルシステムの大多数との相互運用性を促進するために、仕様開発者のための国際化ベストプラクティスで指定される 次の制限に従わなければなりません。

• ファイル名およびファイルパスは大文字と小文字を区別します。
• ファイル名およびファイルパスはUTF-8 [Unicode]で符号化されなければなりません。
• ファイル名は長さが255バイトを超えるべきではありません。
• パス名は長さが65535バイトを超えるべきではありません。
• ファイル名およびパス名は、次の[Unicode]ポイントを使用してはなりません:
  • " [U+0022 QUOTATION MARK]
  • * [U+002A ASTERISK]
  • / [U+002F SOLIDUS]
  • : [U+003A COLON]
  • < [U+003C LESS-THAN SIGN]
  • > [U+003E GREATER-THAN SIGN]
  • \ [U+005C REVERSE SOLIDUS]
  • | [U+007C VERTICAL LINE]
  • U+007F DEL
  • U+E0001 LANGUAGE TAG
  • U+E007F CANCEL TAG
  • 次の範囲のコードポイント:
    • C0 Controls [U+0000...U+001F]
    • C1 Controls [U+0080...U+009F]
    • Private Use [U+E000...U+F8FF]
    • Specials [U+FFF0...U+FFFF]
    • Supplementary Private Use [U+F0000...U+FFFFF]
    • Supplementary Private Use [U+100000...U+10FFFF]
  • . [U+002E FULL STOP]
  • すべてのUnicode非文字コードポイント、具体的には:
    • 基本多言語面内の32個の連続する文字（U+FDD0 … U+FDEF）
    • 基本多言語面の最後の2つのコードポイント（U+FFFEおよびU+FFFF）
    • 補助面の末尾にある最後の2つのコードポイント（U+1FFFE、 U+1FFFF … U+EFFFE、U+EFFFF）

同じディレクトリー内のすべてのファイル名は、Unicode正準正規化 [UAX15]の後に完全ケース フォールディング [Unicode]を行った結果として一意でなければなりません。（詳細については、 Unicode正準ケース フォールド正規化ステップ [CHARMOD-NORM]を参照してください。）

HTML リソースは、MiniAppページおよびそのユーザーインターフェイスを定義するためのマークアップおよび情報を含む文書であり、 構造、視覚コンポーネント、およびインタラクション要素を含みます。

HTMLリソースは、次のすべての基準を満たさなければなりません:

構文および内容

HTMLリソースは、 [HTML]で定義されるHTML構文を使用しなければ なりません。

ファイル名

HTMLリソースは、単一のMiniAppページを識別し、存在する場合はそのページに対応するCSSリソースおよびスクリプティング リソースと一致する、一意のファイル名を持つべきです。

ファイル拡張子

HTMLリソースは、 ファイル拡張子.htmlを使用するべきです。

CSS リソースは、MiniAppページのレンダリングおよび外観を記述するスタイルシートです。CSSリソースは、MiniApp内のすべてのページに影響するグローバルなもの （すなわち、ルート ディレクトリー内のapp.css）であっても、MiniApp内の特定のページのみに影響するローカルスコープのものであってもよいです。

この仕様は、[CSS-SNAPSHOT]で定義されるCSSモジュールをサポートします。

CSSリソースは、次のすべての基準を満たさなければなりません:

構文および内容

CSSリソースは、 [CSS-SNAPSHOT]で記述されるCSSの構文および定義を用いて記述されたものに従わなければ なりません。

ファイル名

MiniApp内のすべてのページに影響するグローバルCSSリソースは、app.cssという名前で、ルート ディレクトリーに保存されなければなりません。

ページに関連付けられたローカルCSSリソースは、MiniAppページを識別し、存在する場合は対応するHTMLリソースおよびスクリプティング リソースと一致する、一意のファイル名を持つべきです。

ファイル拡張子

CSSリソースのファイル名は、 ファイル拡張子.cssを使用するべきです。

スクリプティングリソースは、アプリケーションのビジネスロジックおよび機能を制御し、 インタラクティビティを追加し、MiniAppのライフサイクルを管理するためのスクリプト要素および データを含む文書です。グローバルなスクリプティング リソース（すなわち、ルート ディレクトリー内のapp.js）があり、MiniAppのすべてのページで利用可能なデータおよび関数、ならびに アプリケーションのライフサイクルを制御する固有のロジックを含みます。各MiniAppページは、具体的なページにスコープが限定された、関連する固有のスクリプティングリソースを持っても よい。

スクリプティングリソースは、次のすべての基準を満たさなければなりません:

構文および内容

スクリプティングリソースは、ECMAScript仕様 [ECMA-262]の要件に適合しなければ なりません。

グローバルスクリプティングリソースは、app.jsという名前で、ルート ディレクトリーに保存されなければなりません。

ページに関連付けられたローカルスクリプティングリソースは、MiniAppページを識別し、存在する場合は対応するHTMLリソースおよびCSS リソースと一致する、一意のファイル名を持つべきです。

ファイル拡張子

スクリプティングリソースのファイル名は、ファイル拡張子.jsを使用するべき です。

MiniAppローカライゼーションリソースは、MiniAppの国際化機構の一部としてローカライズされたコンテンツを含む、MiniAppパッケージの文書です。

多言語MiniAppは、システムロケールまたはユーザーの言語設定に従ってコンテンツをレンダリングするために、ユーザーエージェントによるローカライゼーションプロセス中に使用される複数のローカライゼーションリソースを持っても よい。これらのリソースには、ローカライズ可能な用語または表現の一意の識別子（キー）と、 具体的な言語での表現（値）を含むキー値ペアのJSONオブジェクトが含まれます。

{
    "title": "Cool MiniApp",
    "about": "About this MiniApp",
    "intro-page": {
        "title" : "Introduction",
        "main" : "This is the body of the page"
    }
}

ローカライゼーションリソースは、次のすべての基準を満たさなければ なりません:

ファイル拡張子

ローカライゼーションリソースのファイル名は、 ファイル拡張子.jsonを使用するべきです。

形式

ローカライゼーションリソースは、有効なJSON文書 [JSON]でなければ なりません。

構造

ローカライゼーションリソースは、 キー値ペアで構成されなければなりません。各キーは、ローカライズ可能な各文字列（値）の一意の識別子を表します。

MiniApp ZIPコンテナーは、1つ以上の署名を含む署名ブロックを含んでもよい。 署名スキームおよび暗号機構は、ユーザーエージェントによる具体的な実装に依存します。

署名スキームは、MiniApp ZIPコンテナーに含まれるマジックナンバーセクションによって識別されます。これは、 ZIPパッケージの中央ディレクトリーの直前に配置された16バイトのシーケンスです。

MiniApp ZIPコンテナー miniapp_zip_fileが与えられたとき、 デジタル署名を処理するには、次の手順を実行します:

1. magic_numbersをバイトシーケンスとします。
2. eocd_pointerを、miniapp_zip_file内で中央ディレクトリー終端を示す 0x06054b50（リトルエンディアンとして読み取る）のバイトシーケンスを特定した結果として得られる バイトシーケンスとします [ZIP]。
3. eocd_pointerをeocd_pointer + 0x00000010に設定します。
4. cd_pointerを、eocd_pointerにある 4バイトシーケンスを読み取った結果とします。
5. magic_numbers_pointerをeocd_pointer - 0x00000010とします。
6. magic_numbersを、magic_numbers_pointerにある16バイトブロックに設定します。
7. magic_numbersおよびminiapp_zip_fileを用いてデジタル署名を処理します。

ユーザーエージェントは、MiniAppが自分たちと互換性があり、自分たちのプラットフォームで適切に実行できることを 検証しなければなりません。この検証は、MiniAppマニフェストで指定されたメタデータを使用して実行されます。これには、 プラットフォームのサポート対象バージョン、および実行に必要なページとリソースの確認が含まれます。

MiniAppパッケージ miniapp_packageおよび順序付きマップ manifestが与えられたとき、プラットフォーム互換性を検証するには、次の手順を実行します:

1. platform_requiredをmanifest["platform_version"]に設定します。
2. platform_requiredがユーザーエージェント構成と互換性がない場合、失敗を返します。
3. それぞれについて、 リスト manifest["pages"]のpage:
   1. pageがminiapp_package内に存在しない場合、失敗を返します。
4. manifest["widgets"]が存在する場合:
   それぞれについて、 リスト manifest["widgets"]のwidget_path:
   1. widget_pathがminiapp_package内に存在しない場合、失敗を返します。

既定では、ユーザーエージェントは、MiniAppが起動されるときに、MiniAppマニフェストで示される開始ページをエントリーポイントとして読み込まなければ なりません。次のアルゴリズムで指定されるように、MiniApp URI内に有効なページが指定されている場合、この既定の開始ページは上書きされなければなりません。

MiniAppパッケージ miniapp_package、URL miniapp_uri、 および順序付きマップ manifestが与えられたとき、開始ページを決定するには、次の手順を実行します。これらはURLを返します。

1. start_pageを、miniapp_uriを渡してURIから開始ページを抽出する結果とします。
2. start_pageが設定されていない場合、またはstart_page がnullに等しい場合、またはstart_pageがminiapp_package内に存在しない場合:
   start_pageを、manifestを渡してマニフェストから開始ページを抽出する結果に設定します。
3. start_pageを返します

順序付きマップ manifestが与えられたとき、ロケールを抽出するには、 次の手順を実行します。これらは文字列を返します。

1. 文字列 localeを、ユーザーエージェントの 既定ロケールとします。
2. manifest["lang"]が存在する場合、かつmanifest["lang"]がユーザーエージェントによってサポートされている場合:
   localeをmanifest["lang"]に設定します。
3. localeを返します。