tern-def-tbext/README.md

tern definition file for Thunderbird Extension.

# tern-def-tbext
![Screenshot](images/2019-02-11_readme-img_01.jpg)

At ver 0.1.0, `webextensions-desktop-nightly.json` is included.
since ver **1.0.0**,  that file is droped, because it is irrelevant.

 * Thunderbird extension definition files for [tern](http://ternjs.net/).
   * for completion
 * [Thunderbird WebExtension APIs](https://thunderbird-webextensions.readthedocs.io/en/latest/)
 * all things are rough.
 * this does not include any URL of online doc for Thunderbird extension (MDN does not support.
   [comment](https://github.com/mdn/browser-compat-data/pull/2333#issuecomment-435333658))
 * [npm package](https://www.npmjs.com/package/tern-def-tbext) provides definition-file.
   * distilled from comm-central and mozilla-central repositories.


## how to use with tern

I confirmed only with vim. install [tern-for-vim](https://github.com/ternjs/tern_for_vim) 
and add to project's `.tern-project` file.
This package include a definition-file.

```.tern-project
{
  "libs": [
    "browser",
    "node_modules/tern-def-tbext/defs/tbext-nightly"
  ]
}
```


## make definition files

```console
$ npm run build -- --mozilla-repo /path/to/mozilla --comm-repo /path/to/comm
```

This create only `tbext-nightly.json` definition-file.

*Notice*
Since ver. 1.1.1, ``--mozilla-repo`` is necessary to include Firefox APIs.

(At 2019-04-11) You will see following error messages, but no problem.

```console
> tern-def-tbext@1.5.0 build X:\path\to\tern-def-tbext
> node build.js "--mozilla-repo" "x:/repository/mozilla-central" "--comm-repo" "x:/repository/mozilla-central/comm"
"--shrink"

(API: commAPI, Schema Name: commands): Error: ENOENT: no such file or directory, open 'x:\repository\mozilla-central\comm\mail\components\extensions\schemas\commands.json'
(API: commAPI, Schema Name: geckoProfiler): Error: ENOENT: no such file or directory, open 'x:\repository\mozilla-central\comm\toolkit\components\extensions\schemas\geckoProfiler.json'
WARN:split over some files menus
  Problem:dup at menus !doc
(API: commAPI, Schema Name: pkcs11): Error: ENOENT: no such file or directory, open 'x:\repository\mozilla-central\comm\mail\components\extensions\schemas\pkcs11.json'
```


### use not nightly

In case of that you would like to use **beta**.

```console
$ npm run build -- --mozilla-repo /path/to/mozilla-beta --comm-repo /path/to/comm-beta --channel beta
```

This create `tbext-beta.json`. 
`--channel` option only effects to filename. 
Using this option is for switching files specified within `.tern-project`. 
If you don't need to switch, there is no need for this option.


# License
MPL-2.0.

npm package includes json files. These contains contents which come from 
json schema files of comm-central repository. 
Some ones are under 3-Clause BSD License, others are under MPL-2.0 License. 
Both are in `License` directory.

# Release Notes

* 0.1.0 initial release.
* 1.0.0 `webextensions-desktop-nightly.json` is droped.
* 1.1.0 `browser.compose`
* 1.1.1 fix: add Firefox APIs.

  * contentScripts
  * experiments
  * extension
  * i18n
  * management
  * permissions
  * pkcs11
  * runtime
  * theme

* 1.2.0 geckoProfiler
* 1.3.0 fix: pick up `getTargetElement()` of menus API.
  fix: the place of `commands` API files changed.
* 1.4.0 new functions

  * `browser.accounts.createSubfolder()`
  * `browser.accounts.renameFolder()`
  * `browser.accounts.deleteFolder()`

* 1.5.0 new function

  * `browser.contacts.quickSearch()`

* 1.6.0 new function

  * `browser.messages.archive()`

* 1.7.0 new API `folders` and permission `accountsFolders`

  * `MailFolder` move from `accounts` to `folders`
  * `browser.accounts.createSubolder` etc. move to `browser.folders`

* 1.8.0 new arg `id` of `contacts.create()`
* 1.9.0 new property `mailTabs.QuickFilterTextDetail`
* 1.10.0 New: `query()` function of `messages` API
  [1531317](https://bugzilla.mozilla.org/show_bug.cgi?id=1531317)
* 1.11.0 New: `getProfileAsGzippedArrayBuffer()` function of `geckoProfiler` API
  [1551992](https://bugzilla.mozilla.org/show_bug.cgi?id=1551992)
* 1.12.0 New: `dumpProfileToFile()` of `geckoProfiler` API
  [1552845](https://bugzilla.mozilla.org/show_bug.cgi?id=1552845)
* 1.13.0 New: `messageDisplay` API
  [1575708](https://bugzilla.mozilla.org/show_bug.cgi?id=1575708)
* 1.14.0 New: `messageDisplayAction` API
  [1531597](https://bugzilla.mozilla.org/show_bug.cgi?id=1531597)
* 1.15.0

  * Removal: `settingsUrl` of `CloudFile` API
    [1581496](https://bugzilla.mozilla.org/show_bug.cgi?id=1581496)
  * Removal: `sender`  from `mailTabs` API
    [1581498](https://bugzilla.mozilla.org/show_bug.cgi?id=1581498)

* 1.16.0 New: `getRaw()` of `messages` API
  [1525274](https://bugzilla.mozilla.org/show_bug.cgi?id=1525274)
* 1.17.0 New: `subFolders` of `folders.MailFolder`
  [1606584](https://bugzilla.mozilla.org/show_bug.cgi?id=1606584)
* 1.18.0 New: `onBeforeSend()` of `compose` API
  [1532528](https://bugzilla.mozilla.org/show_bug.cgi?id=1532528)
* 1.19.0

  * New: `getComposeDetails()/setComposeDetails` of `compose` API
    [1590121](https://bugzilla.mozilla.org/show_bug.cgi?id=1590121)
  * fix: failed to include many top level definitions

* 2020-02-09 (NO RELEASE) New permission `compose`
  [1613562](https://bugzilla.mozilla.org/show_bug.cgi?id=1613562)

* 2020-02-11 (NO RELEASE. This project does not handle the details of arguments of each function.)

  * Removal: `legacy` API
    [1614237](https://bugzilla.mozilla.org/show_bug.cgi?id=1614237)
  * New: `tags` property in argument of `query()` of `messages` API. / Change: `tags` property in argument of `setQuickFilter()` of `mailTab` API
    [1600547](https://bugzilla.mozilla.org/show_bug.cgi?id=1600547)

* 2020-02-20 1.20.0

  * New: `tabId` argument of `onBeforeSend()` of `compose` API / New: `tabId` argument of `onClicked()` of `composeAction` API
    [1615934](https://bugzilla.mozilla.org/show_bug.cgi?id=1615934)

* 2020-02-25 1.21.0 Change and New: argument of some functions; `onClicked()` of `browserAction`, `onBeforeSend()` of `compose`, `onClicked()` of `composeAction`, `onClicked()` of `messageDisplayAction`
  [1617514](https://bugzilla.mozilla.org/show_bug.cgi?id=1617514)

* 2020-03-10 1.22.0

  * New: `onNewMailReceived()` of `messages` API
    [1599380](https://bugzilla.mozilla.org/show_bug.cgi?id=1599380)
  * New: `plainTextBody` and `isPlainText` properties in arguments of functions of `compose` API
    [1613534](https://bugzilla.mozilla.org/show_bug.cgi?id=1613534)

* 2020-03-28 1.23.0 New: `setDefaultIdentity()` of `accounts` API
  [1531593](https://bugzilla.mozilla.org/show_bug.cgi?id=1531593)

* 2020-04-01 New: `details` argument of `beginReply()` of `compose` API
* 2020-10-26 very many changes from April To October.
  This may fail to handle informations about `mail/components/extensions/schemas/extensionScripts.json`.
* 2020-11-28 1.25.0 New: `setLabel()` and `getLabel()` of `browser_action`, `compose_action`, and `message_display_action`
  [1583478](https://bugzilla.mozilla.org/show_bug.cgi?id=1583478)
* 2020-11-28 1.26.0 New: `openDefaultBrowser()` of `windows`
  [1664708](https://bugzilla.mozilla.org/show_bug.cgi?id=1664708)
* 2020-12-10 1.27.0

  * New: `getDefault()` and `getDefaultIdentity()` of `accounts` API
    [1681141](https://bugzilla.mozilla.org/show_bug.cgi?id=1681141)
  * New schema file: `toolkit/components/extensions/schemas/browsing_data.json`

* 2021-02-04 1.27.1 fix: some APIs are not included
* 2021-02-23 1.28.0 New: `type` property of `ComposeDetails` of `compose` API
  [1677062](https://bugzilla.mozilla.org/show_bug.cgi?id=1677062)
* 2021-02-26 No Release: only docstring
  [1681131](https://bugzilla.mozilla.org/show_bug.cgi?id=1681131)
* 2021-03-05 1.29.0 Modified: arguments of `onShown()` and `onClicked()` of `menus` API
  [1625746](https://bugzilla.mozilla.org/show_bug.cgi?id=1625746)
* 2021-03-05 1.30.0 New: `from` property of argument of functions of `compose` API; `beginNew()`, `beginReply()`, `beginForward()`, `setComposeDetails()`, `onBeforeSend()`.
  [1691253](https://bugzilla.mozilla.org/show_bug.cgi?id=1691253)
* 2021-03-11 1.31.0 New: `listAttachments()` and `getAttachmentFile()` of `messages` API
  [1550960](https://bugzilla.mozilla.org/show_bug.cgi?id=1550960)
* 2021-03-13 No Release: only docstring
  [1697743](https://bugzilla.mozilla.org/show_bug.cgi?id=1697743)
* 2021-04-06 1.32.0 New: `get()` and `getCurrent()` of `mailTabs` API
  [1698306](https://bugzilla.mozilla.org/show_bug.cgi?id=1698306)

  Modified: new argument `callback` for `query()` and `getSelectedMessages()`

* 2021-04-08 1.33.0
  [1703276](https://bugzilla.mozilla.org/show_bug.cgi?id=1703276)

  * Modified: new argument `callback` for `list()`, `get()`, `getDefault()` and `getDefaultIdentity()` of `accounts` API
  * Modified: new argument `callback` for `list()`, `get()`, `create()` of `addressBooks` API
  * Modified: new argument `callback` for `isEnabled()` of `browserAction` API
  * Modified: new argument `callback` for `getAccount()`, `getAllAccounts()`, `updateAccount()` of `cloudFile` API
  * Modified: new argument `callback` for `beginNew()`, `beginReply()`, `beginForward()` and `getComposeDetails()` of `compose` API
  
  Removed: `get()` and `getCurrent()` of `mailTabs` API in 1.32.0

* 2021-04-09 1.34.0 New(again): `get()` and `getCurrent()` of `mailTabs` API
  [1698306](https://bugzilla.mozilla.org/show_bug.cgi?id=1698306)

* 2021-04-18 1.35.0 New: `fieldId` for `onShown()` and `onClicked()` of `menus` API
  [1656506](https://bugzilla.mozilla.org/show_bug.cgi?id=1656506)

* 2021-04-30 No Update
  [1708187](https://bugzilla.mozilla.org/show_bug.cgi?id=1708187)

* 2021-05-22 No Update: property of `details` argument of `browserAction.setIcon()`, or so.
  [1712058](https://bugzilla.mozilla.org/show_bug.cgi?id=1712058)

* 2021-05-28 1.36.0 New: `sendMessage()`, `getComposeState()` and `onComposeStateChanged()` of `compose` API
  [1699672](https://bugzilla.mozilla.org/show_bug.cgi?id=1699672)

* 2021-06-14 No Update
  [1605937](https://bugzilla.mozilla.org/show_bug.cgi?id=1605937)

* 2021-06-18 1.37.0 New: `identity` API. 10 functions.
  [1642690](https://bugzilla.mozilla.org/show_bug.cgi?id=1642690)

* 2021-06-25 1.38.0 New: `provider.onSearchRequest()` of `addressBooks` API
  [1670752](https://bugzilla.mozilla.org/show_bug.cgi?id=1670752)

* 2021-07-02 1.39.0 New: `onUpdated()`, `onMoved()`, `onCopied()`, `onDeleted()` of `messages` API
  [1627604](https://bugzilla.mozilla.org/show_bug.cgi?id=1627604)

* 2021-07-06 No Update
  [1719091](https://bugzilla.mozilla.org/show_bug.cgi?id=1719091)

* 2021-07-08 No Update
  [1616114](https://bugzilla.mozilla.org/show_bug.cgi?id=1616114)

* 2021-07-08 1.40.0 Modified: new `tab` argument for `onFileUpload()`, `onFileUploadAbort()`, `onFileDeleted()` of `cloudFile` API
  [1674374](https://bugzilla.mozilla.org/show_bug.cgi?id=1674374)

* 2021-07-13 1.41.0 Removed: `accountsFolders` permission

  * `viewType` property for callback function of `query()`, `get()`, `getCurrent()` of `mailTab` API.
    [1719093](https://bugzilla.mozilla.org/show_bug.cgi?id=1719093)

  * `includeFolders` argument of `list()`, `get()`, `getDefault()` of `accounts` API.
  * And change in arguments of `create()` of `folders` API.
  * And New: `getParentFolders()`, `getSubFolders()` of `folders` API.
  * And `accountsFolders` permission was removed from manifest-wide `permissions` array.
    [1520427](https://bugzilla.mozilla.org/show_bug.cgi?id=1520427)

  * maybe nothing.
    [1719908](https://bugzilla.mozilla.org/show_bug.cgi?id=1719908)

* 2021-07-14 1.42.0
  [1719813](https://bugzilla.mozilla.org/show_bug.cgi?id=1719813)

  * Modified: argument of `quickSearch()` of `contacts` API.
  * `remote` property for many functions.

    * `list()`, `get()`, `onCreated()`, `onUpdated()` of `addressBooks` API.
    * Contact information of `contacts` API and others.
    * MailingLists information of `mailingLists` API and others.

* maybe completion fails for `addressBooks.provider.onSearchRequest()`.

* 2021-07-20 1.43.0 New: `type` property of `tab` object, for many place.
  [1720662](https://bugzilla.mozilla.org/show_bug.cgi?id=1720662)

* 2021-07-21 1.44.0 New: many for `folders` API.
  [1708644](https://bugzilla.mozilla.org/show_bug.cgi?id=1708644)

  * New callback argument for `create()`, `rename()`
  * New functions. `move()`, `copy()`, `getFolderInfo()`
      "onFolderInfoChanged": {
  * `onCreated()`, `onRenamed()`, `onMoved()`, `onCopied()`, `onDeleted()`, `()`

* 2021-08-27 1.45.0 New: `resetScrollPosition` property of argument of `captureTab()` and `captureVisibleTab()` of `tabs` API.
  [1708403](https://bugzilla.mozilla.org/show_bug.cgi?id=1708403)

[//]: # (vim:expandtab ff=unix fenc=utf-8 sw=2)