MiniApp Manifest

[zhangyongjing]

Hello TAG!

I'm requesting a TAG review of MiniApp Manifest.

MiniApp Manifest defines a JSON-based profile file that provides developers with a centralized place to put essential information associated with a MiniApp. Such information include the basic metadata of a MiniApp as well as configurations regarding version control, window style, page resources, permission control etc.

• Explainer¹ (minimally containing user needs and example code): https://github.com/w3c/miniapp/blob/gh-pages/specs/manifest/docs/explainer.md
• Security and Privacy self-review²:
  https://w3c.github.io/miniapp/specs/manifest/#security-and-privacy-considerations
• GitHub repo (if you prefer feedback filed there):
  https://github.com/w3c/miniapp/
• Primary contacts (and their relationship to the specification):
  • [Yongjing Zhang] (zhangyongjing), Huawei
  • [Zhiqiang Yu] (zhiqiangyu), Huawei
  • [Shouren Lan] (ShourenLan), Huawei
• Organization/project driving the design: W3C MiniApps CG
• External status/issue trackers for this feature (publicly visible, e.g. Chrome Status): n/a

Further details:

• I have reviewed the TAG's API Design Principles
• The group where the incubation/design work on this is being done (or is intended to be done in the future): W3C MiniApps CG
• The group where standardization of this work is intended to be done ("unknown" if not known): W3C MiniApp WG (under preparation)
• Existing major pieces of multi-stakeholder review or discussion of this design: Issues
• Major unresolved issues with or opposition to this design: n/a
• This work is being funded by: Huawei

You should also know that...

The attribute list in the MiniApp Manifest would be further extended so as to provide more feature settings of the MiniApp as the project progresses. Other useful attributes from the Web App Manifest may also be mirrored (see Explainer) when the MiniApp community agrees on the necessity.

We'd prefer the TAG provide feedback as (please delete all but the desired option):

🐛 open issues in our GitHub repo for each point of feedback

[cynthia]

Before we get to a full review, why is this intentionally incompatible with Web App Manifest?

[zhangyongjing]

Before we get to a full review, why is this intentionally incompatible with Web App Manifest?

On the contrary, it's intended to be compatible with Web App Manifest, while focusing more on other aspects that are not covered (e.g. UI configuration, version control). Comparison is given in the Explainer.

[cynthia]

Additional features aside, the names are not compatible according to the explainer.

[zhangyongjing]

Additional features aside, the names are not compatible according to the explainer.

This is can be fixed easily and is under discussion, but it's also subject to the naming convension that the community needs to agree on (e.g. short_name vs shortName).

[xfq]

@cynthia See w3c/miniapp#94

[siusin]

Follow-up discussions:

• the TAG suggested to extend the WebApp Manifest for MiniApps
• MiniApp Virtual Meeting 2020-07-30, 2020-07-31
• WebApps Manifest & MiniApp Manifest Editors' Meeting 2020-08-26

[cynthia]

We were told that this is being re-worked as an extension of Webapp Manifest - we'd like to revisit this review when that work is done. Please let us know when you have an update!

[zhangyongjing]

Sure. We'll post the update here once available.

[xfq]

The pull request to re-work MAM as an extension of the WAM has been merged. See w3c/miniapp#136

[cynthia]

That's great news! Aside from that detail we are happy to see this work move forward.

[kenchris]

It seems that it would be great if the keys would follow the TAG guideline for naming, ie use underscope:

https://www.w3.org/TR/design-principles/#casing-rules

[xfq]

It seems that it would be great if the keys would follow the TAG guideline for naming, ie use underscope:

I filed https://github.com/w3c/miniapp/issues/155 to track this.

[torgo]

We're going to close this for now and we look forward to reviewing when you have a manifest extension proposal for us to look at.