Adding type definitions

Author: perki

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "hds-lib",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Health Data Safe - Library",
   "main": "src/index.js",
   "scripts": {
@@ -15,6 +15,7 @@
     "type": "git",
     "url": "git+https://github.com/healthdatasafe/hds-lib-js.git"
   },
+  "types": "types/index.d.ts",
   "keywords": [
     "HDS",
     "Health",

package.json

@@ -57,7 +57,6 @@ class Collector {
   }
 
   /**
-   * @type {StatusData}
    * Payload that can be modified
    * */
   get statusData () {

src/appTemplates/Collector.js

@@ -0,0 +1,21 @@
+{
+  // Change this to match your project
+  "include": ["src/**/*"],
+  "compilerOptions": {
+    // Tells TypeScript to read JS files, as
+    // normally they are ignored as source files
+    "allowJs": true,
+    // Generate d.ts files
+    "declaration": true,
+    // This compiler run should
+    // only output d.ts files
+    "emitDeclarationOnly": true,
+    // Types should go into this directory.
+    // Removing this would place the .d.ts files
+    // next to the .js files
+    "outDir": "types",
+    // go to js file when using IDE functions like
+    // "Go to Definition" in VSCode
+    "declarationMap": true
+  }
+}

tsconfig.json

@@ -0,0 +1,18 @@
+export = HDSItemDef;
+declare class HDSItemDef {
+    constructor(key: string, definitionData: any);
+    get eventTypes(): any[];
+    get key(): string;
+    get data(): any;
+    /** @type {string} label Localized */
+    get label(): string;
+    /** @type {string} description Localized */
+    get description(): string;
+    /**
+     * a template event with eventType and streamIds
+     * // TODO handle variations
+     * @returns {Object}
+     */
+    eventTemplate(): any;
+    #private;
+}

types/HDSModel/HDSItemDef.d.ts

@@ -0,0 +1,31 @@
+export = HDSModelAuthorizations;
+/**
+ * Authorizations - Extension of HDSModel
+ */
+declare class HDSModelAuthorizations {
+    constructor(model: any);
+    /**
+     * Get minimal Authorization set for itemKeys
+     * /!\ Does not handle requests with streamId = "*"
+     * @param {Array<itemKeys>} itemKeys
+     * @param {Object} [options]
+     * @param {string} [options.defaultLevel] (default = write) one of 'read', 'manage', 'contribute', 'writeOnly'
+     * @param {boolean} [options.includeDefaultName] (default = true) defaultNames are needed for permission requests but not for access creation
+     * @param {Array<AuthorizationRequestItem>} [options.preRequest]
+     * @return {Array<AuthorizationRequestItem>}
+     */
+    forItemKeys(itemKeys: any, options?: {
+        defaultLevel?: string;
+        includeDefaultName?: boolean;
+        preRequest?: Array<AuthorizationRequestItem>;
+    }): Array<AuthorizationRequestItem>;
+    #private;
+}
+declare namespace HDSModelAuthorizations {
+    export { AuthorizationRequestItem };
+}
+type AuthorizationRequestItem = {
+    streamId: string;
+    level: string;
+    defaultName: string;
+};

types/HDSModel/HDSModel-Authorizations.d.ts

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

types/HDSModel/HDSModel-ItemsDefs.d.ts

@@ -0,0 +1,35 @@
+import HDSItemDef from "./HDSItemDef";
+export = HDSModelStreams;
+/**
+ * Streams - Extension of HDSModel
+ */
+declare class HDSModelStreams {
+    constructor(model: any);
+    /**
+     * Get a list of streams to be created for usage of these keys (whithout children)
+     * @param {Array<string>|Array<HDSItemDef>} itemKeysOrDefs
+     * @param {Object} params
+     * @param {String} [params.nameProperty = 'name'] - can be set to 'name' (default), 'defaultName' or 'none' => if you want nothing
+     * @param {Array<string>} [params.knowExistingStreamsIds]
+     */
+    getNecessaryListForItems(itemKeysOrDefs: Array<string> | Array<HDSItemDef>, params?: {
+        nameProperty?: string;
+        knowExistingStreamsIds?: Array<string>;
+    }): {
+        id: any;
+        parentId: any;
+    }[];
+    /**
+     * Get stream Data by Id;
+     * @param {string} streamId
+     */
+    getDataById(streamId: string, throwErrorIfNotFound?: boolean): any;
+    /**
+     * 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[];
+    #private;
+}

types/HDSModel/HDSModel-Streams.d.ts

@@ -0,0 +1,27 @@
+export = HDSModel;
+/**
+ * @class {HDSModel}
+ * @property {object} modelData - Raw ModelData
+ * @property {HDSModelItemsDefs} itemsDefs
+ * @property {HDSModelStreams} streams
+ * @property {HDSModelAuthorizations} authorizations
+ */
+declare class HDSModel {
+    /**
+     * @param {string} modelUrl - JSON definition file URL. Should come from service/info assets.hds-model
+     */
+    constructor(modelUrl: string);
+    /**
+     * @private
+     * Map of properties loaded "on demand"
+     */
+    private laziliyLoadedMap;
+    get isLoaded(): boolean;
+    /**
+     * Load model definitions
+     */
+    load(modelUrl?: any): Promise<void>;
+    /** RAW model data */
+    get modelData(): any;
+    #private;
+}

types/HDSModel/HDSModel.d.ts

@@ -0,0 +1,7 @@
+export function getModel(): any;
+/**
+ * Initialized model singleton
+ * @returns {HDSModel}
+ */
+export function initHDSModel(): HDSModel;
+import HDSModel = require("./HDSModel");