\n\nFaster is a framework which provides analytics, account, billing and remote-config features.\nThis project is related to SDK for Javascript development given a easy-to-use API to work with.\n\nCurrently released features:\n\n- Analytics (This package):\n\n - Track Device Installation\n - Session Control\n - Track & Send Events\n\n- Remote Config ([Check Package](https://www.npmjs.com/package/faster-remote-config-sdk-js)):\n\n - Run AB Tests\n - Manage Feature Rollout\n\n- Account ([Check Package](https://www.npmjs.com/package/faster-account-sdk-js)):\n\n - Manage Sessions\n - Create, Link and Manage Credentials\n\n- Billing: **coming soon**\n\n## 1 - Getting Started\n\n### Installing\n\nGet the package from the public npm registry, with your favorite package manager:\n\n```bash\nyarn add faster-sdk-js\n```\n\nor\n\n```bash\nnpm install faster-sdk-js\n```\n\n### Request credentials\n\nRequest a new _applicationKey_ and _applicationSecret_ with faster-team at Movile.\n\nFor security purpose **DO NOT** share or store your _applicationSecret_.\n\n### Usage\n\nImport the Faster module and FasterConfiguration object using ES6 syntax.\n\n```javascript\nimport Faster, { FasterConfiguration } from 'faster-sdk-js';\n```\n\n### Configuring & Running\n\nNow, configure and start Faster SDK:\n\n```javascript\nconst configuration = new FasterConfiguration('__appKey__', '__secretKey__', options);\nFaster.configure(configuration);\nconst fasterAnalyticsInstance = Faster.start();\n```\n\n### Event Builder\n\nEvent builder used to create proper Faster Event instances.\n\n```javascript\nimport { EventBuilder } from 'faster-sdk-js';\n\nconst eventBuilder = new EventBuilder(eventId, eventRevision);\nconst event = eventBuilder\n .id('some-event-id')\n .externalId('another_tracking_tool_id')\n .dimension('someStringProperty', 'someValue')\n .dimension('someBooleanProperty', true)\n .dimension('someNumberProperty', 300)\n .build();\n```\n\nThen you can register the event in Faster Analytics:\n\n```javascript\nfasterAnalyticsInstance.event.register(event);\n```\n\n## 2 - API Reference\n\n### Faster Analytics\n\n#### **FasterConfiguration.constructor(applicationKey, secretKey, appVersion, [options])**\n\n- **applicationKey**: The application key created for your application in the Faster Admin system.\n- **secretKey**: The application secret key created for your application in the Faster Admin system.\n- **options**: Optional parameters to configure the Faster modules:\n - **appVersion**: Your application version string, used for tracking.\n - **timeout**: Request timeout in miliseconds for all Faster operations.\n - **sessionTtl**: Faster Session maximum lifetime in seconds.\n - **sessionProperties**: properties to add in every new session. This does not change the session properties if the session has already started. This merges with properties from expired sessions, but in case of conflicts, the expired session properties wins over. See [Faster.session.putProperties](<####Faster.session.putProperties(properties):>) for other use cases\n\n#### Faster.configure(configuration):\n\n- **configuration** : FasterConfiguration instance.\n\n#### **Faster.start([trackInstall])**:\n\nMost common startup way for faster\n\n- **trackInstall**: Indicates whether or not a new install event should be registered when creating the device information.\n\n#### **Faster.startEmbedded(externalDeviceId, externalSessionId)**:\n\nFor applications embedded inside other applications that use Faster. In this mode, only event tracking will be available, as Device and Session information are handled by the parent application.\n\n- **externalDeviceId**: External application Faster Device ID.\n- **externalSessionId**: External application Faster Session ID.\n\n#### ServerDate\n\nIt provides a date that is synchronized with the server time.\nThis is really useful when you want to keep track of a timeline of facts.\n\n##### `now(): Date`:\n\nCalculates what would be the given moment taking into consideration the time difference with the server.\n\nIf the time difference is bellow 4 seconds, only the client time is considered.\nIf the time from the serve is not yet retrieved it returns null instead.\n\n##### Example of usage:\n\n```\nimport FasterAnalytics, { ServerDate } from 'faster-sdk-js'\n\nFasterAnalytics.configure(fstrConfig);\nconst fasterAnalytics = FasterAnalytics.start();\n\nconsole.log(ServerDate.now())\n\n```\n\n#### Faster.device.get():\n\nReturns the entire Device object with all information collected by Faster.\n\n#### Faster.device.putProperty(name, value):\n\nInserts a new custom property in the device information.\n\n- **name**: The property identification name.\n- **value**: The property value, must be boolean, number or string.\n\n#### Faster.device.putProperties(properties):\n\nInserts a new set of custom properties in the device information.\n\n- **properties**: Object with new properties. The values must be boolean, number or string.\n\n#### Faster.device.removeProperty(name):\n\nRemoves a property with the given name from properties in the device information.\n\n- **name**: Property identification name.\n\n#### Faster.device.updatePushToken(pushSubscription):\n\nUpdates the push identifier of the client in the device information.\n\n- **pushSubscription**: [PushSubscription](https://developer.mozilla.org/en-US/docs/Web/API/PushSubscription) object from PushAPI.\n\n#### Faster.session.get():\n\nReturns the entire Session object with all information collected by Faster.\n\n#### Faster.session.putProperty(name, value):\n\nInserts a new custom property in the Session information.\n\n- **name**: The property identification name.\n- **value**: The property value, must be boolean, number or string.\n\n#### Faster.session.putProperties(properties):\n\nInserts a new set of custom properties in the Session information.\n\n- **properties**: Object with new properties. The values must be boolean, number or string.\n\n#### Faster.session.removeProperty(name):\n\nRemoves a property with the given name from properties in the Session information.\n\n- **name**: Property identification name.\n\n#### Faster.session.updateUserId(userId):\n\nUpdates the user id of the client in the Session information.\n\n- **userId**: String with the user id.\n\n#### Faster.session.updateGeoPoint(geopoint):\n\nUpdates the geopoint of the client in the Session information, if the client moves more than approximately 100m.\n\n- **geoPoint**: Property composed by latitude and longitude.\n\n```\nimport { GeoPoint } from 'faster-sdk-js'\n\nnew GeoPoint(100, 100)\n```\n\n#### Faster.event.register(event):\n\nRegisters a new event in the Faster database. This method provides request count control and retry mechanisms.\n\n- **event**: A Faster Event object, can be instanced using the event builder packed with the SDK.\n\n#### Faster.event.registerWithPromise(event):\n\nRegisters a new event in the Faster database, returning a promise of the process. This method does not provide retry and request count control.\n\n- **event**: A Faster Event object, can be instanced using the event builder packed with the SDK.\n\n### EventBuilder\n\n#### EventBuilder.constructor(eventType, eventRevision):\n\n- **eventType**: Event type string identifier from Faster Admin system.\n- **eventRevision**: Event type revision number from Faster Admin system.\n\n#### EventBuilder.id(id):\n\nSet the id value used by Faster for the built event.\n\n- **id**: String identification value.\n\n#### EventBuilder.externalId(id):\n\nSet the id value from external sources for the built event.\n\n- **id**: String identification value.\n\n#### EventBuilder.dimension(key, value):\n\nAdd a new custom property to the built event.\n\n- **key**: Property identification string key.\n- **value**: Property value, must be boolean, number or string.\n\n#### EventBuilder.dimensions(dimensions):\n\nAdd multiple custom properties to the built event.\n\n- **dimensions**: Object containing properties to be added, values must be boolean, number or string.\n","readmeFilename":"README.md","homepage":"https://github.com/faster/faster-sdk-js#readme","bugs":{"url":"https://github.com/faster/faster-sdk-js/issues"}}
![\"Faster\"](\"https://faster-dropbox.s3.amazonaws.com/assets/faster-logo.png\"){kind=logo}
\n