MiniApp Manifest

1.1 Conformance

A MiniApp manifest MUST contain the following members at its root:

• app_id
• icons
• name
• version_name
• version_code
• min_platform_version
• pages

Each image resource object within the MiniApp manifest's icons member MUST contain:

• src

A MiniApp manifest MAY contain a widgets member at its root. This member MUST contain an array of MiniApp widget resources. Each MiniApp widget resource object MUST contain the following members:

• name
• path

A MiniApp manifest MAY contain a req_permissions member at its root. This member MUST contain an array of MiniApp permission resources. Each MiniApp permission resource object MUST contain the following member:

• name

The presence of other members in a MiniApp manifest is optional, but vendor-specific extensions MAY modify this.

As the application manifest is JSON, this specification relies on the [JSON] specification. This specification includes members typed as number, boolean literals, object, array, and string.

1.2 Summary of Members

The following table shows a summary of the MiniApp manifest's members:

1.4 Web Application Manifest members

The MiniApp manifest uses the following essential application manifest's members.

1.5 Application Information members

The following member is defined in the Web App Manifest - Application Information specification [MANIFEST-APP-INFO].

1.6 Supplementary members

The following members are defined under the scope of the MiniApp manifest, addressing specific aspects of MiniApp.

appIdRule = name *("." name)
name = ALPHA [*( ALPHA / DIGIT / "-" ) ( ALPHA / DIGIT)]

1.7 Processing the manifest

The MiniApp manifest, as an extension of the Application manifest, provides a supplementary algorithm to be processed at the extension point of the processing a manifest algorithm defined in [APPMANIFEST].

To process a MiniApp manifest, given object json and ordered map manifest:

1. Process the app_id member passing json and manifest.
2. Process the description member passing json and manifest.
3. Process the min_platform_version member passing json and manifest.
4. Process the pages member passing json and manifest.
5. Process the req_permissions member passing json and manifest.
6. Process the version_code member passing json and manifest.
7. Process the version_name member passing json and manifest.
8. Process the widgets member passing json and manifest.
9. Process the window member passing json and manifest.

2.1 name member

The MiniApp permission resource's name member is a string that indicates the name of the feature requested.

To process the permission resource's name member, given object json and ordered map permission:

1. If json["name"] does not exist, or
   if the type of json["name"] is not string, or if json["name"] is the empty string, return failure.
2. Set permission["name"] to json["name"].

2.2 reason member

The optional MiniApp permission resource's reason member is a string that indicates the reason given to request the feature specified in the name attribute.

To process the permission resource's reason member, given object json and ordered map permission:

1. If json["reason"] does not exist, or
   if the type of json["reason"] is not string, or if json["reason"] is the empty string, return.
2. Set permission["reason"] to json["reason"].

3.1 name member

The MiniApp widget resource's name member is a string that indicates the title of a widget.

To process the widget's name member, given object json and ordered map widget:

1. If json["name"] does not exist, or if the type of json["name"] is not string, return failure.
2. Set widget["name"] to json["name"].

3.2 path member

The MiniApp widget resource's path member is a relative-url string that defines the corresponding page route of a widget, represented as in the pages array.

To process the widget's path member, given object json and ordered map widget:

1. If json["path"] does not exist, or if the type of json["path"] is not string, return failure.
2. Let url be the result of parsing json["path"].
3. If url is failure, return failure.
4. Set widget["path"] to url.

3.3 min_platform_version member

The optional MiniApp widget resource's min_platform_version member is a string that indicates the minimum platform version supported for a MiniApp widget.

To process the widget's min_platform_version member, given object json, ordered map widget and ordered map manifest:

1. Set widget["min_platform_version"] to manifest["min_platform_version"].
2. If json["min_platform_version"] does not exist, or if the type of json["min_platform_version"] is not string, return.
3. Set widget["min_platform_version"] to json["min_platform_version"].

4.1 auto_design_width member

The auto_design_width member is a boolean that indicates whether the design_width of the page is auto-calculated by the user agent. When auto_design_width is true, the value of design_width is ignored. In this case, the system's baseline width is automatically determined according to the pixel density of the screen.

Value by default: false.

To process the window's auto_design_width member, given object json and ordered map window:

1. If json["auto_design_width"] does not exist, or if the type of json["auto_design_width"] is not boolean, return.
2. Set window["auto_design_width"] to json["auto_design_width"].

4.2 background_color member

The background_color member is a string that specifies the background color of the window that contains a MiniApp.

This member supports sRGB colors, and it is equivalent to the application manifest's background_color.

Value by default: "#ffffff".

4.3 background_text_style member

The background_text_style member is a string that specifies the background text style, indicating a light or dark color theme.

This member supports the values of prefers-color-scheme and MUST contain one of the following background text style values:

"light"

For light style.

"dark" (default)

For dark style.

To process the window's background_text_style member, given object json and ordered map window:

1. If json["background_text_style"] does not exist, or
   if the type of json["background_text_style"] is not string, or
   if json["background_text_style"] doesn't match one of the background text style values, return.
2. Set window["background_text_style"] to json["background_text_style"].

4.4 design_width member

The design_width member is a number that indicates the baseline width of the page design in pixel unit. It is used for visually adjusting the page components.

The value is a non-negative integer and the value by default is 750.

To process the window's design_width member, given object json and ordered map window:

1. If json["design_width"] does not exist, or
   if the type of json["design_width"] is not number, or if the type of json["design_width"] is less than 0, return.
2. Set window["design_width"] to json["design_width"].

4.5 enable_pull_down_refresh member

The enable_pull_down_refresh member is a boolean that specifies if the pull-to-refresh event is enabled during the interaction with the MiniApp.

Value by default: false.

To process the window's enable_pull_down_refresh member, given object json and ordered map window:

1. If json["enable_pull_down_refresh"] does not exist,
   or if the type of json["enable_pull_down_refresh"] is not boolean, return.
2. Set window["enable_pull_down_refresh"] to json["enable_pull_down_refresh"].

4.6 fullscreen member

The fullscreen member is a boolean that indicates if the MiniApp is shown in full-screen display mode.

Value by default: false.

To process the window's fullscreen member, given object json and ordered map window:

1. If json["fullscreen"] does not exist,
   or if the type of json["fullscreen"] is not boolean, return.
2. Set window["fullscreen"] to json["fullscreen"].

4.7 navigation_bar_background_color member

The navigation_bar_background_color member is a string that specifies the color of the background of the navigation bar of the MiniApp.

This member supports sRGB colors.

Value by default: "#000000".

This member is processed according to the specified in [APPMANIFEST].

4.8 navigation_bar_text_style member

The navigation_bar_text_style member is a string that indicates the text color of the navigation bar title.

This member MUST contain one of the following text style values:

"white" (default)

For white text color.

"black"

For black text color.

To process the window's navigation_bar_text_style member, given object json and ordered map window:

1. If json["navigation_bar_text_style"] does not exist, or
   if the type of json["navigation_bar_text_style"] is not string, or
   if json["navigation_bar_text_style"] doesn't match one of the text style values, return.
2. Set window["navigation_bar_text_style"] to json["navigation_bar_text_style"].

4.9 navigation_bar_title_text member

The navigation_bar_title_text member is a string that specifies the title of the navigation bar of the MiniApp.

To process the window's navigation_bar_title_text member, given object json and ordered map window:

1. If json["navigation_bar_title_text"] does not exist, or
   if the type of json["navigation_bar_title_text"] is not string, return.
2. Set window["navigation_bar_title_text"] to json["navigation_bar_title_text"].

4.10 navigation_style member

The navigation_style member is a string that specifies the style of the navigation bar.

This member MUST contain one of the following navigation style values:

"default" (default)

For applying the style by default.

"custom"

For applying a customized navigation bar.

To process the window's navigation_style member, given object json and ordered map window:

1. If json["navigation_style"] does not exist, or
   if the type of json["navigation_style"] is not string, or
   if json["navigation_style"] doesn't match one of the navigation style values, return.
2. Set window["navigation_style"] to json["navigation_style"].

4.11 on_reach_bottom_distance member

The on_reach_bottom_distance member is a number that defines the vertical offset from the bottom of the window required to trigger a page pull-up event. Values for this member are non-negative integers expressed in pixel unit.

Value by default: 50.

To process the window's on_reach_bottom_distance member, given object json and ordered map window:

1. If json["on_reach_bottom_distance"] does not exist, or
   if the type of json["on_reach_bottom_distance"] is not number, or
   if if the type of json["on_reach_bottom_distance"] is less than 0, return.
2. Set window["on_reach_bottom_distance"] to json["on_reach_bottom_distance"].

4.12 orientation member

The orientation member is a string that specifies the configuration of the screen orientation for the MiniApp.

This member supports the orientation values: "portrait" and "landscape" defined in OrientationLockType [SCREEN-ORIENTATION].

Value by default: "portrait".

To process the window's orientation member, given object json and ordered map window:

1. If json["orientation"] does not exist, or
   if the type of json["orientation"] is not string, or
   if json["orientation"] doesn't match one of the orientation values, return.
2. Set window["orientation"] to json["orientation"].

7.1 Content constraint

As the manifest is a JSON document and will commonly be encoded using [UNICODE], the security considerations described in [[JSON] and [UNICODE-SECURITY] apply. In order to prevent developers from including custom/unrestrained data in a manifest, implementors may use a more strict schema than that defined in JSON Schema to impose their implementation-specific limits on the member names, types, and value ranges (e.g., to guard against memory overflow, or to meet platform-specific limitations).

7.2 Local resource access

Members like icons, pages, and widgets contain paths referring to local resources on the hosting platform. Implementors and the hosting platform should check the validity of those paths to prevent illegal access out of the scope of the MiniApp Package. On the other hand, the MiniApp itself (e.g., using scripting code) may provide mechanisms to access external resources either on the hosting platform or on remote websites (e.g., through a URI). In this case, the hosting platform is responsible for providing a clear indication to an end-user about such a context switch.

Additionally, the req_permissions member provides a specific means to control the access the local software, hardware, and data resources on the user's device. User's consent should be asked when it comes to privacy-related or high-level privileged resources.

7.3 Integrity

The integrity of the manifest document is protected by a cryptographic hash mechanism as part of the whole MiniApp Package, as detailed in [MINIAPP-PACKAGING].

7.4 Transparency

The user agent SHOULD provide the end-user with transparent metadata about a MiniApp (i.e., app_id, name, short_name, icons, version_name, description), offering users enough information, allowing them to make a conscious decision about its usage. This practice could also help to identify spoofing MiniApps.