aerogear-js

Клиентская библиотека JavaScript для AeroGear. В будущем она будет включать API для работы с данными, безопасностью, синхронизацией данных и многим другим. Для получения более подробной информации и загрузки посетите AeroGear.org.

Авторизация

Этот API был отменен и удален начиная с версии 2.1.0. Чтобы использовать его, вам потребуется последняя версия 1.x, которую можно найти здесь)

Аутентификация

Этот API был отменен. Чтобы использовать его, вам потребуется последняя версия 1.x, которую можно найти здесь)

Криптография

Пространство имён AeroGear.Crypto предоставляет простой API для удобного использования криптографических интерфейсов для шифрования и расшифровки данных.Дополнительную информацию см. в документации по API криптографии.

DataManager

Сборник соединений данных (хранителей) и соответствующих моделей данных. Этот объект обеспечивает стандартный способ взаимодействия с данными клиента независимо от формата данных или механизма хранения.

Дополнительную информацию см. в документации по API DataManager.

Уведомитель

Этот API был отозван начиная с версии 2.1.0 и будет удален в будущих версиях.

Уведомитель представляет собой коллекцию адаптеров, предоставляющих унифицированный или похожий API для взаимодействия с различными службами и протоколами сообщений. Дополнительную информацию см. в документации Notifier API.

Пайплайн

Этот API был отозван. Для его использования вам потребуется последняя версия 1.x, которую можно найти здесь.

SimplePushClient

SimplePushClient — это клиентская реализация и полифилл для спецификации Mozilla SimplePush. SimplePush обеспечивает простую поддержку уведомлений в веб-приложениях, а также приложениях для Firefox OS. Эта реализация немного отличается от спецификации тем, что работает только в приложениях, находящихся в режиме «онлайн» и активных в браузере. Эта реализация также поддерживает соединение с серверами SimplePush Mozilla и проекта AeroGear.Дополнительную информацию см. в документации SimplePushClient API. Также обратитесь к спецификации Mozilla SimplePush для получения дополнительной информации о SimplePush.

Diff Sync

Клиент и сервер Diff Sync основаны на реализации Differential Synchronization Google [Neil Fraser].

DiffSyncClient подключается к серверу синхронизации AeroGear.

DiffSyncEngine отвечает за логику алгоритма — доступны два адаптера: JSON Patch и DiffMatchPatch.

UnifiedPushClient

UnifiedPushClient используется вместе с сервером AeroGear UnifiedPush для регистрации веб-приложений для уведомлений. Используя SimplePushClient, веб-приложение может зарегистрироваться для получения уведомлений через сеть SimplePush и затем сообщить серверу UnifiedPush, куда должны отправляться эти уведомления.

Дополнительную информацию см. в документации UnifiedPushClient API.

Устойчивость функциональности

Все функции библиотеки имеют рейтинг устойчивости, который указан в документации для данной функции. Рейтинг устойчивости следующий:* Экспериментальная — эта функция новая и не была тщательно протестирована вне среды разработки. Эта функция может быть изменена или удалена в любое время. Использование этих функций в производственной среде осуществляется за ваш риск.

• Устойчивая — эта функция существует на протяжении всего цикла выпуска и была тщательно протестирована. Эти функции считаются безопасными для использования в производственных средах.
• Застарелая — эта функция будет удалена или заменена. Как и экспериментальные функции, эти функции могут быть удалены в любое время, а их использование в производственных средах осуществляется за ваш риск. Для функций, которые будут заменены, рекомендуется обновиться до следующей версии и начать использовать новую функцию.## Внешние зависимости библиотеки

Некоторые части AeroGear.js зависят от внешних библиотек, которые не включены в один и тот же файл. Ниже приведён список каждого плагина и его адаптеров вместе с внешними зависимостями, если они есть. Рекомендуется использовать последнюю устойчивую версию каждой зависимости, если это не указано иначе.

Криптография

• SJCL - включена в AeroGear.js

Дата-менеджер

• Память
  • Polyfill ES6 Promise
• Сессия локального хранения
  • Polyfill ES6 Promise
• IndexedDB
  • Polyfill ES6 Promise
• WebSQL
  • Polyfill ES6 Promise

Нотифайер

• STOMP-WS
  • STOMP через WebSocket
• vert.x
  • Event Bus vert.x
  • SockJS
• MQTT-WS
  • Клиент Eclipse Paho MQTT JavaScript
• Простой push
  • См. плагин Простого push

Простой push

• jQuery
• SockJS

Объединённый push

• Polyfill ES6 Promise

Разностная синхронизация

• Diff Match Patch
  • Google Diff Match Patch
• JSON Patch
  • JSON Patch

Сборка

GruntGrunt используется как средство сборки, которое требует установки Node.js версии >= 0.10.

Для получения подробной информации о процессе установки Node.js обратитесь к nodejs.org. Для получения подробной информации о процессе установки Grunt обратитесь к руководству Grunt.

Текст уже был переведён правильно, поэтому изменения не требуются.### Установка зависимостей проекта Чтобы установить зависимости проекта выполните следующую команду:

$ npm install

Эта команда установит версии зависимостей, объявленные в файле package.json. Это требуется сделать всего один раз перед первым запуском сборки или если были обновлены зависимости в файле package.json.

Сборка проекта

$ grunt

Собранный JavaScript будет находиться в директории dist.

Кастомная сборка

Есть специальная задача Grunt под названием custom, которая помогает создавать кастомные сборки библиотеки.

Задача custom принимает список модулей через запятую.

Например, если вы хотите получить сборку с модулем Authorization/OAuth2 и SimplePushClient, вы можете использовать следующую команду:

$ grunt custom:oauth2,simplePush

Собранный JavaScript будет находиться в директории dist под именем aerogear.custom.js.

Для получения справочной информации и списка доступных модулей используйте команду:

$ grunt custom:help

Генерация документации

Чтобы сгенерировать API документацию, выполните следующую команду:

$ jsdoc-aerogear src/ -r -d docs README.md

или запустите задачу docs в Grunt

$ grunt docs

Документация использует немного измененную версию jsdoc

Документация

Для получения более подробной информации о текущей версии, пожалуйста, обратитесь к нашей документации.## Развитие

Если вы хотите помочь в развитии AeroGear, вы можете присоединиться к нашему разработческому списку рассылки, присоединиться к #aerogear на Freenode, или связаться с нами на Twitter @aerogears.

Также рекомендуется ознакомиться со руководством для участников.

Вопросы?

Присоединяйтесь к нашему пользовательскому списку рассылки для любых вопросов или помощи! Мы очень надеемся, что вам понравится разработка приложений с помощью AeroGear!

Найдены ошибки?

Если вы нашли ошибку, пожалуйста, создайте тикет для нас в системе Jira с указанием шагов для воспроизведения проблемы.