TypeScript declarations

_tools/tsconfig.json

@@ -1,7 +1,6 @@
 {
   "compilerOptions": {
-    "removeComments": true,
-    "preserveConstEnums": true,
+    "declaration": true,
     "moduleResolution": "node",
     "target": "es2015",
     "module": "commonjs",

broid-alexa/lib/core/Adapter.d.ts

@@ -0,0 +1,26 @@
+/// <reference types="bluebird" />
+import * as Promise from 'bluebird';
+import { Router } from 'express';
+import { Observable } from 'rxjs/Rx';
+import { IAdapter, IAdapterOptions } from './interfaces';
+export declare class Adapter implements IAdapter {
+    private serviceID;
+    private connected;
+    private emitter;
+    private parser;
+    private logLevel;
+    private logger;
+    private router;
+    private webhookServer;
+    constructor(obj?: IAdapterOptions);
+    serviceName(): string;
+    getRouter(): Router | null;
+    users(): Promise<Map<string, object> | Error>;
+    channels(): Promise<Map<string, object> | Error>;
+    serviceId(): string;
+    connect(): Observable<object>;
+    disconnect(): Promise<null>;
+    listen(): Observable<object>;
+    send(data: any): Promise<object | Error>;
+    private setupRouter();
+}

broid-alexa/lib/core/Parser.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="bluebird" />
+import * as Promise from 'bluebird';
+export declare class Parser {
+    serviceID: string;
+    generatorName: string;
+    private logger;
+    constructor(serviceName: string, serviceID: string, logLevel: string);
+    validate(event: any): Promise<object | null>;
+    parse(event: any): Promise<object | null>;
+    private createActivityStream();
+}

broid-alexa/lib/core/WebHookServer.d.ts

@@ -0,0 +1,16 @@
+/// <reference types="bluebird" />
+import * as Promise from 'bluebird';
+import * as express from 'express';
+import { IAdapterHTTPOptions } from './interfaces';
+export declare class WebHookServer {
+    emitAsync: any;
+    private express;
+    private logger;
+    private httpClient;
+    private host;
+    private port;
+    constructor(options: IAdapterHTTPOptions, router: express.Router, logLevel?: string);
+    listen(): void;
+    close(): Promise<null>;
+    private setupExpress(router);
+}

broid-alexa/lib/core/index.d.ts

@@ -0,0 +1,2 @@
+import { Adapter } from './Adapter';
+export = Adapter;

broid-alexa/lib/core/interfaces.d.ts

@@ -0,0 +1,24 @@
+/// <reference types="bluebird" />
+import * as Promise from 'bluebird';
+import { Router } from 'express';
+import { Observable } from 'rxjs/Rx';
+export interface IAdapterHTTPOptions {
+    host: string;
+    port: number;
+}
+export interface IAdapterOptions {
+    http?: IAdapterHTTPOptions;
+    logLevel?: string;
+    serviceID?: string;
+}
+export interface IAdapter {
+    serviceName(): string;
+    serviceId(): string;
+    getRouter(): Router | null;
+    users(): Promise<Map<string, object> | Error>;
+    channels(): Promise<Map<string, object> | Error>;
+    connect(): Observable<object>;
+    disconnect(): Promise<null>;
+    listen(): Observable<object>;
+    send(data: any): Promise<object | Error>;
+}

broid-alexa/package.json

@@ -2,6 +2,7 @@
   "name": "@broid/alexa",
   "version": "2.1.0",
   "main": "lib/core/index.js",
+  "types": "lib/core/index.d.ts",
   "license": "AGPL-3.0+",
   "author": "Broid Team <opensource@broid.ai> (https://broid.ai)",
   "description": "Convert Alexa messages into Activity Streams 2 with Broid Integration",

broid-alexa/src/core/interfaces.ts

@@ -9,8 +9,8 @@ export interface IAdapterHTTPOptions {
 
 export interface IAdapterOptions {
   http?: IAdapterHTTPOptions;
-  logLevel: string;
-  serviceID: string;
+  logLevel?: string;
+  serviceID?: string;
 }
 
 export interface IAdapter {

broid-callr/lib/core/Adapter.d.ts

@@ -0,0 +1,30 @@
+import * as Promise from 'bluebird';
+import { Router } from 'express';
+import { Observable } from 'rxjs/Rx';
+import { IAdapterOptions } from './interfaces';
+export declare class Adapter {
+    private serviceID;
+    private token;
+    private tokenSecret;
+    private connected;
+    private emitter;
+    private session;
+    private parser;
+    private logLevel;
+    private username;
+    private logger;
+    private router;
+    private webhookServer;
+    private webhookURL;
+    constructor(obj: IAdapterOptions);
+    users(): Promise<Error>;
+    channels(): Promise<Error>;
+    serviceName(): string;
+    serviceId(): string;
+    getRouter(): Router;
+    connect(): Observable<object>;
+    disconnect(): Promise<null>;
+    listen(): Observable<object>;
+    send(data: object): Promise<object | Error>;
+    private setupRouter();
+}

broid-callr/lib/core/Parser.d.ts

@@ -0,0 +1,14 @@
+import { IActivityStream } from '@broid/schemas';
+import * as Promise from 'bluebird';
+import { ICallrWebHookEvent } from './interfaces';
+export declare class Parser {
+    serviceID: string;
+    generatorName: string;
+    private logger;
+    constructor(serviceName: string, serviceID: string, logLevel: string);
+    validate(event: any): Promise<object>;
+    parse(event: any): Promise<IActivityStream>;
+    normalize(event: ICallrWebHookEvent): Promise<any>;
+    private createIdentifier();
+    private createActivityStream(normalized);
+}

broid-callr/lib/core/WebHookServer.d.ts

@@ -0,0 +1,14 @@
+import * as Promise from 'bluebird';
+import * as express from 'express';
+import { IAdapterHTTPOptions } from './interfaces';
+export declare class WebHookServer {
+    private express;
+    private logger;
+    private httpClient;
+    private host;
+    private port;
+    constructor(options: IAdapterHTTPOptions, router: express.Router, logLevel?: string);
+    listen(): void;
+    close(): Promise<null>;
+    private setupExpress(router);
+}

broid-callr/lib/core/index.d.ts

@@ -0,0 +1,2 @@
+import { Adapter } from './Adapter';
+export = Adapter;

broid-callr/lib/core/interfaces.d.ts

@@ -0,0 +1,17 @@
+export interface IAdapterHTTPOptions {
+    host: string;
+    port: number;
+}
+export interface IAdapterOptions {
+    token: string;
+    tokenSecret: string;
+    webhookURL: string;
+    logLevel?: string;
+    username?: string;
+    serviceID?: string;
+    http?: IAdapterHTTPOptions;
+}
+export interface ICallrWebHookEvent {
+    request: any;
+    response: any;
+}

broid-callr/package.json

@@ -2,6 +2,7 @@
   "name": "@broid/callr",
   "version": "2.1.0",
   "main": "lib/core/index.js",
+  "types": "lib/core/index.d.ts",
   "license": "AGPL-3.0+",
   "author": "Broid Team <opensource@broid.ai> (https://broid.ai)",
   "description": "Convert Callr messages into Activity Streams 2 with Broid Integration",

broid-callr/src/core/interfaces.ts

@@ -4,12 +4,12 @@ export interface IAdapterHTTPOptions {
 }
 
 export interface IAdapterOptions {
-  logLevel: string;
-  serviceID: string;
   token: string;
   tokenSecret: string;
-  username: string;
   webhookURL: string;
+  logLevel?: string;
+  username?: string;
+  serviceID?: string;
   http?: IAdapterHTTPOptions;
 }
 

broid-callr/yarn.lock

@@ -21,11 +21,7 @@
     request "^2.81.0"
     valid-url "^1.0.9"
 
-"@types/node@*":
-  version "8.0.12"
-  resolved "https://registry.yarnpkg.com/@types/node/-/node-8.0.12.tgz#0560c3e8c9e3da0aa07d0b86e0b0a02b5fd29480"
-
-"@types/node@^7.0.12":
+"@types/node@*", "@types/node@^7.0.12":
   version "7.0.12"
   resolved "https://registry.yarnpkg.com/@types/node/-/node-7.0.12.tgz#ae5f67a19c15f752148004db07cbbb372e69efc9"
 
@@ -3792,11 +3788,7 @@ uuid@^2.0.1:
   version "2.0.3"
   resolved "https://registry.yarnpkg.com/uuid/-/uuid-2.0.3.tgz#67e2e863797215530dff318e5bf9dcebfd47b21a"
 
-uuid@^3.0.0:
-  version "3.0.1"
-  resolved "https://registry.yarnpkg.com/uuid/-/uuid-3.0.1.tgz#6544bba2dfda8c1cf17e629a3a305e2bb1fee6c1"
-
-uuid@^3.1.0:
+uuid@^3.0.0, uuid@^3.1.0:
   version "3.1.0"
   resolved "https://registry.yarnpkg.com/uuid/-/uuid-3.1.0.tgz#3dd3d3e790abc24d7b0d3a034ffababe28ebbc04"
 

broid-discord/lib/core/Adapter.d.ts

@@ -0,0 +1,23 @@
+/// <reference types="bluebird" />
+import * as Promise from 'bluebird';
+import { Observable } from 'rxjs/Rx';
+import { IAdapterOptions } from './interfaces';
+export declare class Adapter {
+    serviceID: string;
+    token: string | null;
+    private connected;
+    private session;
+    private parser;
+    private logLevel;
+    private logger;
+    constructor(obj?: IAdapterOptions);
+    users(): Promise<any>;
+    channels(): Promise<any>;
+    serviceId(): string;
+    serviceName(): string;
+    getRouter(): null;
+    connect(): Observable<any>;
+    disconnect(): Promise<null>;
+    listen(): Observable<any>;
+    send(data: object): Promise<object | Error>;
+}

broid-discord/lib/core/Parser.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="bluebird" />
+import * as Promise from 'bluebird';
+export declare class Parser {
+    serviceID: string;
+    generatorName: string;
+    private logger;
+    constructor(serviceName: string, serviceID: string, logLevel: string);
+    validate(event: any): Promise<object | null>;
+    parse(event: any): Promise<any>;
+    private parseMedia(media, content);
+    private createActivityStream(normalized);
+}

broid-discord/lib/core/index.d.ts

@@ -0,0 +1,2 @@
+import { Adapter } from './Adapter';
+export = Adapter;

broid-discord/lib/core/interfaces.d.ts

@@ -0,0 +1,17 @@
+export interface IAdapterOptions {
+    token: string;
+    serviceID?: string;
+    logLevel?: string;
+}
+export interface IUserInformations {
+    readonly id: string;
+    readonly username: string;
+    readonly is_bot: boolean;
+    readonly avatar: string;
+}
+export interface IChannelInformations {
+    readonly guildID: string;
+    readonly id: string;
+    readonly name: string;
+    readonly topic: string;
+}

broid-discord/package.json

@@ -2,6 +2,7 @@
   "name": "@broid/discord",
   "version": "2.2.0",
   "main": "lib/core/index.js",
+  "types": "lib/core/index.d.ts",
   "license": "AGPL-3.0+",
   "author": "Broid Team <opensource@broid.ai> (https://broid.ai)",
   "description": "Convert Discord messages into Activity Streams 2 with Broid Integration",

broid-discord/src/core/interfaces.ts

@@ -1,7 +1,7 @@
 export interface IAdapterOptions {
   token: string;
-  serviceID: string;
-  logLevel: string;
+  serviceID?: string;
+  logLevel?: string;
 }
 
 export interface IUserInformations {

broid-discord/yarn.lock

@@ -31,11 +31,7 @@
   version "3.5.2"
   resolved "https://registry.yarnpkg.com/@types/bluebird/-/bluebird-3.5.2.tgz#ecf1104217495e50fe0b588d538146cd6f733b89"
 
-"@types/node@*":
-  version "8.0.12"
-  resolved "https://registry.yarnpkg.com/@types/node/-/node-8.0.12.tgz#0560c3e8c9e3da0aa07d0b86e0b0a02b5fd29480"
-
-"@types/node@^7.0.12":
+"@types/node@*", "@types/node@^7.0.12":
   version "7.0.12"
   resolved "https://registry.yarnpkg.com/@types/node/-/node-7.0.12.tgz#ae5f67a19c15f752148004db07cbbb372e69efc9"
 
@@ -3675,11 +3671,7 @@ uuid@^2.0.1:
   version "2.0.3"
   resolved "https://registry.yarnpkg.com/uuid/-/uuid-2.0.3.tgz#67e2e863797215530dff318e5bf9dcebfd47b21a"
 
-uuid@^3.0.0:
-  version "3.0.1"
-  resolved "https://registry.yarnpkg.com/uuid/-/uuid-3.0.1.tgz#6544bba2dfda8c1cf17e629a3a305e2bb1fee6c1"
-
-uuid@^3.1.0:
+uuid@^3.0.0, uuid@^3.1.0:
   version "3.1.0"
   resolved "https://registry.yarnpkg.com/uuid/-/uuid-3.1.0.tgz#3dd3d3e790abc24d7b0d3a034ffababe28ebbc04"
 

broid-flowdock/lib/core/Adapter.d.ts

@@ -0,0 +1,26 @@
+import * as Promise from 'bluebird';
+import { Observable } from 'rxjs/Rx';
+import { IAdapterOptions } from './interfaces';
+export declare class Adapter {
+    private connected;
+    private serviceID;
+    private token;
+    private session;
+    private parser;
+    private logLevel;
+    private logger;
+    private storeUsers;
+    private storeFlows;
+    constructor(obj?: IAdapterOptions);
+    users(): Promise<Map<string, any>>;
+    channels(): Promise<Map<string, any>>;
+    serviceId(): string;
+    serviceName(): string;
+    getRouter(): null;
+    connect(): Observable<object>;
+    disconnect(): Promise<null>;
+    listen(): Observable<object>;
+    send(data: any): Promise<object | Error>;
+    private userByID(userID);
+    private flowByID(flowID);
+}

broid-flowdock/lib/core/Parser.d.ts

@@ -0,0 +1,11 @@
+import * as Promise from 'bluebird';
+export declare class Parser {
+    serviceID: string;
+    generatorName: string;
+    private logger;
+    constructor(serviceName: string, serviceID: string, logLevel: string);
+    validate(event: any): Promise<object>;
+    parse(event: any): Promise<any>;
+    private createIdentifier();
+    private createActivityStream(normalized);
+}

broid-flowdock/lib/core/index.d.ts

@@ -0,0 +1,2 @@
+import { Adapter } from './Adapter';
+export = Adapter;

broid-flowdock/lib/core/interfaces.d.ts

@@ -0,0 +1,5 @@
+export interface IAdapterOptions {
+    token: string;
+    serviceID?: string;
+    logLevel?: string;
+}