Updating types

Author: perki

package.json

@@ -1,6 +1,6 @@
 {
   "name": "hds-lib",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "Health Data Safe - Library",
   "main": "src/index.js",
   "scripts": {

types/HDSModel/HDSItemDef.d.ts

@@ -1,7 +1,7 @@
 export = HDSItemDef;
 declare class HDSItemDef {
     constructor(key: string, definitionData: any);
-    get eventTypes(): any[];
+    get eventTypes(): string[];
     get key(): string;
     get data(): any;
     /** @type {string} label Localized */
@@ -13,6 +13,9 @@ declare class HDSItemDef {
      * // TODO handle variations
      * @returns {Object}
      */
-    eventTemplate(): any;
+    eventTemplate(): {
+        streamId: string,
+        type: string
+    };
     #private;
 }

types/HDSModel/HDSModel-Authorizations.d.ts

@@ -1,9 +1,11 @@
+import HDSModel from "./HDSModel";
+
 export = HDSModelAuthorizations;
 /**
  * Authorizations - Extension of HDSModel
  */
 declare class HDSModelAuthorizations {
-    constructor(model: any);
+    constructor(model: HDSModel);
     /**
      * Get minimal Authorization set for itemKeys
      * /!\ Does not handle requests with streamId = "*"
@@ -14,7 +16,7 @@ declare class HDSModelAuthorizations {
      * @param {Array<AuthorizationRequestItem>} [options.preRequest]
      * @return {Array<AuthorizationRequestItem>}
      */
-    forItemKeys(itemKeys: any, options?: {
+    forItemKeys(itemKeys: string[], options?: {
         defaultLevel?: string;
         includeDefaultName?: boolean;
         preRequest?: Array<AuthorizationRequestItem>;

types/HDSModel/HDSModel-ItemsDefs.d.ts

@@ -1,20 +1,23 @@
+import pryv = require('pryv');
+import HDSItemDef from './HDSItemDef';
+import HDSModel from './HDSModel';
 export = HDSModelItemsDefs;
 /**
  * ItemsDefs - Extension of HDSModel
  */
 declare class HDSModelItemsDefs {
-    constructor(model: any);
+    constructor(model: HDSModel);
     /**
      * get item for a key
      * @param {string} key
      * @param {boolean} [throwErrorIfNotFound] default `true`
      */
-    forKey(key: string, throwErrorIfNotFound?: boolean): any;
+    forKey(key: string, throwErrorIfNotFound?: boolean): HDSItemDef;
     /**
      * get a definition for an event
      * @param {Event} event
      * @param {boolean} [throwErrorIfNotFound] default `true`
      */
-    forEvent(event: Event, throwErrorIfNotFound?: boolean): any;
+    forEvent(event: pryv.Event, throwErrorIfNotFound?: boolean): HDSItemDef;
     #private;
 }

types/HDSModel/HDSModel-Streams.d.ts

@@ -1,10 +1,12 @@
+import pryv = require('pryv');
 import HDSItemDef from "./HDSItemDef";
+import HDSModel from './HDSModel';
 export = HDSModelStreams;
 /**
  * Streams - Extension of HDSModel
  */
 declare class HDSModelStreams {
-    constructor(model: any);
+    constructor(model: HDSModel);
     /**
      * Get a list of streams to be created for usage of these keys (whithout children)
      * @param {Array<string>|Array<HDSItemDef>} itemKeysOrDefs
@@ -16,20 +18,22 @@ declare class HDSModelStreams {
         nameProperty?: string;
         knowExistingStreamsIds?: Array<string>;
     }): {
-        id: any;
-        parentId: any;
+        id: string;
+        name?: string;
+        defaultName?: string;
+        parentId?: string;
     }[];
     /**
      * Get stream Data by Id;
      * @param {string} streamId
      */
-    getDataById(streamId: string, throwErrorIfNotFound?: boolean): any;
+    getDataById(streamId: string, throwErrorIfNotFound?: boolean): pryv.Stream;
     /**
      * Get all parents id;
      * @param {string} streamId
      * @param {boolean} [throwErrorIfNotFound] default `true`
      * @param {Array} [initialArray] - a pre-filled array
      */
-    getParentsIds(streamId: string, throwErrorIfNotFound?: boolean, initialArray?: any[]): any[];
+    getParentsIds(streamId: string, throwErrorIfNotFound?: boolean, initialArray?: string[]): string[];
     #private;
 }

types/appTemplates/AppClientAccount.d.ts

@@ -1,7 +1,8 @@
 
+import pryv = require('pryv');
 export = AppClientAccount;
 declare class AppClientAccount extends Application {
-    constructor(baseStreamId: any, connection: any, appName: any, features: any, ...args: any[]);
+    constructor(baseStreamId: string, connection: pryv.Connection, appName: string, features: any, ...args: Application.ApplicationFeatures[]);
     get appSettings(): {
         canBePersonnal: boolean;
         mustBeMaster: boolean;
@@ -13,8 +14,8 @@ declare class AppClientAccount extends Application {
      * @returns {CollectorClient}
      */
     handleIncomingRequest(apiEndpoint: string, incomingEventId?: string): CollectorClient;
-    getCollectorClientByKey(collectorKey: any): Promise<any>;
-    getCollectorClients(forceRefresh?: boolean): Promise<any[]>;
+    getCollectorClientByKey(collectorKey: any): Promise<CollectorClient>;
+    getCollectorClients(forceRefresh?: boolean): Promise<CollectorClient[]>;
 }
 import Application = require("./Application");
 import CollectorClient = require("./CollectorClient");

types/appTemplates/Collector.d.ts

@@ -50,14 +50,14 @@ declare class Collector {
     /**
      * Retrieve an invite by its key
      */
-    getInviteByKey(key: any): Promise<any>;
+    getInviteByKey(key: string): Promise<CollectorInvite>;
     /**
      * Retreive all invites
      * @param {boolean} [forceRefresh]
      * @returns {Array<CollectorInvite>}
      */
-    getInvites(forceRefresh?: boolean): Array<CollectorInvite>;
-    checkInbox(): Promise<any[]>;
+    getInvites(forceRefresh?: boolean): Promise<CollectorInvite[]>;
+    checkInbox(): Promise<CollectorInvite[]>;
     /**
      * Create a "pending" invite to be sent to an app using AppSharingAccount
      * @param {string} name a default display name for this request
@@ -66,11 +66,11 @@ declare class Collector {
      */
     createInvite(name: string, options?: {
         customData?: any;
-    }): Promise<any>;
+    }): Promise<CollectorInvite>;
     /**
      * Get sharing api endpoint
      */
-    sharingApiEndpoint(): Promise<any>;
+    sharingApiEndpoint(): Promise<string>;
     /**
      * @private
      * @param {CollectorInvite} invite
@@ -94,7 +94,7 @@ declare class Collector {
      * Invite Status for streamId
      * reverse of streamIdFor
      */
-    inviteStatusForStreamId(streamId: any): any;
+    inviteStatusForStreamId(streamId: string): string;
     #private;
 }
 import CollectorInvite = require("./CollectorInvite");

types/appTemplates/CollectorClient.d.ts

@@ -1,10 +1,13 @@
 import pryv = require('pryv');
 import AppClientAccount from './AppClientAccount';
+
 export = CollectorClient;
+
 /**
  * Client App in relation to an AppManagingAccount/Collector
  */
 declare class CollectorClient {
+     
     static STATUSES: Readonly<{
         incoming: "Incoming";
         active: "Active";
@@ -20,8 +23,8 @@ declare class CollectorClient {
      * return the key to discriminate collectorClients
      * @param {PryvAccessInfo} accessInfo
      */
-    static keyFromInfo(info: any): string;
-    constructor(app: any, eventData: any, accessData?: any);
+    static keyFromInfo(info: pryv.AccessInfo): string;
+    constructor(app: AppClientAccount, eventData: pryv.Event, accessData?: any);
     /** @type {AppClientAccount} */
     app: AppClientAccount;
     /** @type {PryvEvent} */
@@ -31,13 +34,13 @@ declare class CollectorClient {
     /** @property {String} - identified within user's account - can be used to retreive a Collector Client from an app */
     get key(): string;
     /** @property {String} - id matching an event within requester's account - used as a reference to communicate with requester */
-    get requesterEventId(): any;
+    get requesterEventId(): string;
     /** @property {String}  */
-    get requesterApiEndpoint(): any;
+    get requesterApiEndpoint(): string;
     /** @property {Object} - full content of the request */
     get requestData(): any;
     /** @property {string} - one of 'Incoming', 'Active', 'Deactivated', 'Refused' */
-    get status(): any;
+    get status(): string;
     /**
      * @private
      * reset with new request Event of ApiEndpoint
@@ -50,13 +53,13 @@ declare class CollectorClient {
      */
     accept(forceAndSkipAccessCreation?: boolean): Promise<{
         accessData: any;
-        requesterEvent: any;
+        requesterEvent: pryv.Event;
     }>;
     revoke(): Promise<{
-        requesterEvent: any;
+        requesterEvent: pryv.Event;
     }>;
     refuse(): Promise<{
-        requesterEvent: any;
+        requesterEvent: pryv.Event;
     }>;
     /**
      * Probable temporary internal to fix possible inconsenticies during lib early stages

types/appTemplates/CollectorInvite.d.ts

@@ -12,15 +12,15 @@ declare class CollectorInvite {
      * @param {pryv.Event} eventData
      * @returns {string}
      */
-    static getKeyForEvent(eventData: Event): string;
+    static getKeyForEvent(eventData: pryv.Event): string;
     constructor(collector: any, eventData: any);
     /** @type {Collector} */
     collector: Collector;
     /** @type {Event} */
     eventData: pryv.Event;
     get key(): string;
-    get status(): any;
-    get apiEndpoint(): any;
+    get status(): string;
+    get apiEndpoint(): string;
     /** @type {string} - on of 'revoked', 'refused' */
     get errorType(): string;
     get dateCreation(): Date;
@@ -30,16 +30,16 @@ declare class CollectorInvite {
      * If result is "forbidden" update and set as revoked
      * @returns {Object} accessInfo if valid.
      */
-    checkAndGetAccessInfo(forceRefresh?: boolean): any;
-    get displayName(): any;
+    checkAndGetAccessInfo(forceRefresh?: boolean): pryv.AccessInfo;
+    get displayName(): string;
     /**
      * private
      * @param {*} eventData
      */
-    setEventData(eventData: any): void;
+    setEventData(eventData: pryv.Event): void;
     getSharingData(): Promise<{
-        apiEndpoint: any;
-        eventId: any;
+        apiEndpoint: string;
+        eventId: string;
     }>;
     #private;
 }

types/index.d.ts

@@ -7,6 +7,6 @@ import appTemplates = require("./appTemplates/appTemplates");
 import { localizeText } from "./localizeText";
 import toolkit = require("./toolkit");
 import logger = require("./logger");
-export declare const model: any;
+export declare const model: HDSModel;
 export declare let initHDSModel: typeof HDSModelInitAndSingleton.initHDSModel;
 export { pryv, settings, HDService, HDSModel, appTemplates, localizeText, localizeText as l, toolkit, logger };