First commit

.gitignore

@@ -0,0 +1,32 @@
+# Node
+node_modules
+npm-debug.log
+
+# TypeScript
+src/*.js
+src/*.map
+src/*.d.ts
+
+# JetBrains
+.idea
+.project
+.settings
+.idea/*
+*.iml
+
+# VS Code
+.vscode/*
+
+# Windows
+Thumbs.db
+Desktop.ini
+
+# Mac
+.DS_Store
+**/.DS_Store
+
+# Ngc generated files
+**/*.ngfactory.ts
+
+# Build files
+dist

.npmignore

@@ -0,0 +1,32 @@
+# Node
+node_modules
+npm-debug.log
+docs
+# DO NOT IGNORE TYPESCRIPT FILES FOR NPM
+# TypeScript
+# *.js
+# *.map
+# *.d.ts
+
+# JetBrains
+.idea
+.project
+.settings
+*.iml
+
+# VS Code
+.vscode/*
+
+# Windows
+Thumbs.db
+Desktop.ini
+
+# Mac
+.DS_Store
+
+# Ngc generated files
+**/*.ngfactory.ts
+
+# Library files
+src/*
+build/*

.travis.yml

@@ -0,0 +1,4 @@
+language: node_js
+sudo: false
+node_js:
+  - '6.0.0'

.yo-rc.json

@@ -0,0 +1,7 @@
+{
+  "generator-angular2-library": {
+    "promptValues": {
+      "gitRepositoryUrl": "https://github.com/OpenDecide/ngx-segment-analytics"
+    }
+  }
+}

LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 OpenDecide
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,113 @@
+# ngx-segment-analytics
+
+[![Build Status](https://travis-ci.org/opendecide/ngx-segment-analytics.svg?branch=master)](https://travis-ci.org/opendecide/ngx-segment-analytics)
+[![GitHub Downloads All Releases](https://img.shields.io/github/downloads/opendecide/ngx-segment-analytics/total.svg)](https://github.com/opendecide/ngx-segment-analytics)
+[![npm Downloads All Releases](https://img.shields.io/npm/dw/ngx-segment-analytics.svg)](https://www.npmjs.com/package/ngx-segment-analytics)
+[![npm Version](https://img.shields.io/npm/v/ngx-segment-analytics.svg)](https://www.npmjs.com/package/ngx-segment-analytics)
+[![node Version Required](https://img.shields.io/node/v/ngx-segment-analytics.svg)](https://www.npmjs.com/package/ngx-segment-analytics)
+
+This Angular module provides an API for Segment using the `analytics.js` official library.
+
+## Installation
+
+To install this library, run:
+
+```bash
+$ npm install --save ngx-segment-analytics
+```
+
+## Consuming Segment
+
+Add the `SegmentModule` to your Angular `AppModule`:
+
+```typescript
+import { BrowserModule } from '@angular/platform-browser';
+import { NgModule } from '@angular/core';
+
+import { AppComponent } from './app.component';
+
+// Import the Segment module
+import { SegmentModule } from 'ngx-segment-analytics';
+
+@NgModule({
+  declarations: [
+    AppComponent
+  ],
+  imports: [
+    BrowserModule,
+    // Segment Importation
+    SegmentModule.forRoot({ apiKey: 'YOUR_WRITE_APIKEY', debug: true })
+  ],
+  providers: [],
+  bootstrap: [AppComponent]
+})
+export class AppModule { }
+```
+
+You can use the `SegmentService` in any constructor as a injected service :
+
+```typescript
+import { Component, OnInit } from '@angular/core';
+import { SegmentService } from 'ngx-segment-analytics';
+@Component({
+    selector: 'hero',
+    templateUrl: './hero.component.html',
+    styleUrls: ['./hero.component.css']
+})
+export class HeroComponent implements OnInit {
+
+    constructor(private segment: SegmentService) { }
+
+    public ngOnInit() {
+        this.segment.track('load an hero')
+            .then(() => console.log("Event sended"));
+    }
+
+}
+```
+
+## API
+
+This API is compatible with `analytics.js` but returns `Promises` instead of taking `callbacks` in parameters.
+
+```typescript
+identify(userId?: string, traits?: any, options?: any): Promise<SegmentService>;
+track(event: string, properties?: any, options?: any): Promise<SegmentService>;
+page(category?: string, name?: string, properties?: any, options?: any): Promise<SegmentService>;
+group(groupId: string, traits?: any): Promise<SegmentService>;
+alias(userId: string, previousId?: string, options?: any): Promise<SegmentService>;
+ready(): Promise<SegmentService>;
+user(): any;
+id(): any;
+traits(): any;
+reset(): void;
+debug(enabled?: boolean): void;
+on(method: string, callback: (event?: string, properties?: any, options?: any) => any): void;
+trackLink(elements: HTMLElement | HTMLElement[], event: string | Function, properties?: Object | Function): void;
+trackForm(forms: HTMLElement | HTMLElement[], event: string | Function, properties?: Object | Function): void;
+timeout(timeout: number): void;
+```
+
+## Development
+
+To lint all `*.ts` files:
+
+```bash
+$ npm run lint
+```
+
+To generate all `*.js`, `*.d.ts` and `*.metadata.json` files:
+
+```bash
+$ npm run build
+```
+
+To publish on npmjs registry :
+```bash
+$ npm publish dist
+```
+
+
+## License
+
+MIT ©2017 [OpenDecide](https://www.opendecide.com)