@hailer/app-sdk 1.0.3 → 2.0.0-beta-1

package/lib/hailer-api.d.ts

@@ -1,9 +1,8 @@
 import { UserApi } from './modules/user';
 import { ActivityApi } from './modules/activity';
 import { WorkspaceApi } from './modules/workspace';
-import { HailerApiInfo, HailerSettings, HailerSignal } from './types';
+import { ApiInfo, Settings, Signal } from './types';
 import { Ui } from './modules/ui';
-import { Process } from './modules/process';
 import { HailerPublicApi } from './modules/public';
 import { WorkflowApi } from './modules/workflow';
 import { AppApi } from './modules/app';
@@ -20,23 +19,13 @@ export interface Options {
     /** Callback called on app init and when permissions have changed */
     permissions?: () => void;
     /** Callback called on app init and when settings have changed */
-    settings?: (data: HailerSettings) => void;
+    settings?: (data: Settings) => void;
     /** Callback called on app init and when config has changed */
     config?: (config: any) => void;
     /** Will be called each time a subscribed signal is emitted from Hailer frontend. To subscribe to signals, add them to options.subscribedSignals[] */
-    signals?: (signal: HailerSignal) => void;
+    signals?: (signal: Signal) => void;
     /** Urls the sdk is allowed to connect to. Defaults to all Hailer instances*/
     allowedUrls?: string[];
-    /**
-     * Optional signal filter, passes all signals by default
-     *
-     * Example:
-     *
-     *     subscribedSignals: ['activity.create', 'activity.update']
-     */
-    subscribedSignals?: string[];
-    /** Api version to be used in the app by default */
-    apiVersion?: 1;
     /** Public backend Api url. Defaults to https://api.hailer.com */
     publicBackendUrl?: string;
 }
@@ -47,7 +36,6 @@ export declare class HailerApi {
     activity: ActivityApi;
     insight: InsightApi;
     workspace: WorkspaceApi;
-    process: Process;
     workflow: WorkflowApi;
     permission: PermissionApi;
     product: ProductApi;
@@ -61,10 +49,7 @@ export declare class HailerApi {
     /** If set it indicates that app is locked to a specific workspaceId */
     private workspaceId?;
     private client;
-    private apiVersion;
-    private settings?;
     private config?;
-    private subscribedSignals?;
     private timer?;
     /**
      * Hailer API state
@@ -83,6 +68,5 @@ export declare class HailerApi {
      */
     constructor(options?: Options);
     private createEventListener;
-    info(): HailerApiInfo;
-    request(op: string, args: any[]): Promise<any>;
+    info(): ApiInfo;
 }

package/lib/modules/activity.d.ts

@@ -1,5 +1,5 @@
 import { Client } from '@wishcore/wish-rpc';
-import { ActivityCreateOptions, ActivityListOptions, Activity } from '../types';
+import { ActivityCreateOptions, ActivityListOptions, Activity, ActivityFieldUpdateValue, ActivityUpdateOptions, ActivityFieldValue } from '../types';
 import { Kanban } from './activity/kanban';
 export declare class ActivityApi {
     private client;
@@ -33,30 +33,17 @@ export declare class ActivityApi {
     /**
      * Creates activities
      *
-     * @param processId The process where the activity is created
-     * @param activities new activities as objects
-     * @param activities.name name of the activity
-     * @param activities.fields fields of the activity
-     * @param options ActivityCreateOptions
-     *
      * @throws {HailerError} if request is incorrect
      */
-    create(processId: string, activities: {
-        name: string;
+    create(workflowId: string | undefined, activities: {
+        name?: string;
         fields?: {
-            [id: string]: string | number;
+            [id: string]: ActivityFieldValue;
         };
     }[], options?: ActivityCreateOptions): Promise<Activity[]>;
     /**
      * Updates activites
      *
-     * Each activity has the following parameters
-     * @param activities updated activity objects of an activity to edit
-     * @param activities.name New name of the activity
-     * @param activities.fields change values of fields, null removes current value
-     * @param activities.phaseId New phase of the activity
-     * @param options
-     *
      * @returns The number of updated activities
      *
      * @throws {HailerError} if request is incorrect
@@ -65,10 +52,10 @@ export declare class ActivityApi {
         _id: string;
         name?: string;
         fields?: {
-            [id: string]: string | number | null;
+            [id: string]: ActivityFieldUpdateValue;
         };
         phaseId?: string;
-    }[], options: any): Promise<number>;
+    }[], options?: ActivityUpdateOptions): Promise<number>;
     /**
      * Removes activities
      *

package/lib/modules/app.d.ts

@@ -1,5 +1,5 @@
 import { Client } from '@wishcore/wish-rpc';
-import { HailerAppConfig, ProductVersion, Version } from '../types';
+import { Config, ProductVersion, Version } from '../types';
 /**
  * This class is used to access Hailer public API even when the app is outside of Hailer
  */
@@ -19,7 +19,9 @@ export declare class AppApi {
     };
     constructor(client: Client);
     config: {
-        update: (appId: string | undefined, config: HailerAppConfig) => Promise<void>;
+        update: (config: Config, option?: {
+            appId?: string;
+        }) => Promise<void>;
     };
     /**
      * Check if product is installed

package/lib/modules/insight.d.ts

@@ -27,7 +27,6 @@ export declare class InsightApi {
     /**
      * Get Insight data
      *
-     *
      * @returns data from the Insight
      *
      * @throws {HailerError} if request is incorrect

package/lib/modules/permission.d.ts

@@ -1,9 +1,10 @@
 import { Client } from '@wishcore/wish-rpc';
+import { PermissionMap } from '../types';
 /**
  * This class is used to access Hailer public API even when the app is outside of Hailer
  */
 export declare class PermissionApi {
     private client;
     constructor(client: Client);
-    map: () => Promise<void>;
+    map: () => Promise<PermissionMap>;
 }

package/lib/modules/public/app.d.ts

@@ -1,5 +1,5 @@
 import { Options } from '../../hailer-api';
-import { HailerAppConfig } from '../../types';
+import { Config } from '../../types';
 export declare class App {
     private options;
     constructor(options: Options);
@@ -13,5 +13,5 @@ export declare class App {
      * @throws {HailerError} if there is something wrong with the request or insight cannot be found
      * @throws {TypeError} if Hailer cannot be reached
      */
-    config(): Promise<HailerAppConfig>;
+    config(): Promise<Config>;
 }

package/lib/modules/team.d.ts

@@ -0,0 +1,17 @@
+import { Client } from '@wishcore/wish-rpc';
+import { TeamMap } from '../types';
+export declare class TeamApi {
+    private client;
+    constructor(client: Client);
+    /**
+     * Lists all Hailer teams from a workspace
+     *
+     *
+     * @returns list of Hailer teams in the workspace the app user is currently in
+     *
+     * @throws {HailerError} if request is incorrect
+     */
+    list(): Promise<{
+        [workspaceId: string]: TeamMap;
+    }>;
+}

package/lib/modules/user.d.ts

@@ -30,7 +30,5 @@ export declare class UserApi {
      *
      * @throws {HailerError} if request is incorrect
      */
-    list(): Promise<{
-        [key: string]: User;
-    }>;
+    list(): Promise<User[]>;
 }

package/lib/modules/workflow.d.ts

@@ -1,5 +1,5 @@
 import { Client } from '@wishcore/wish-rpc';
-import { Workflow } from '../types';
+import { IdsMap, Workflow } from '../types';
 export declare class WorkflowApi {
     private client;
     constructor(client: Client);
@@ -11,6 +11,16 @@ export declare class WorkflowApi {
      * @throws {HailerError} if request is incorrect
      */
     list(): Promise<Workflow[]>;
+    /**
+     * Gets a single process from a workspace
+     *
+     * @param workflowId the id of the process in question
+     *
+     * @returns the specified Hailer process
+     *
+     * @throws {HailerError} if request is incorrect
+     */
+    get(workflowId: string): Promise<Workflow>;
     /**
      * Gets a single process from a workspace
      *
@@ -20,5 +30,7 @@ export declare class WorkflowApi {
      *
      * @throws {HailerError} if request is incorrect
      */
-    get(processId: string): Promise<Workflow>;
+    install(workflowSpec: any, option?: {
+        workspaceId?: string;
+    }): Promise<IdsMap>;
 }

package/lib/tools/replace-private.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/tools/replace-private.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = require("fs");
+const path_1 = require("path");
+const srcFolder = (0, path_1.join)(__dirname, '../src');
+const publicSrcFolder = (0, path_1.join)(__dirname, '../public-src');
+const replacePrivateComments = (fileContent) => {
+    // Replaces all occurences of /* @ private */ with private
+    return fileContent.replace(/\/\* @private \*\//g, 'private');
+};
+const copyAndReplaceFiles = (src, dest) => {
+    (0, fs_1.mkdirSync)(dest, { recursive: true });
+    console.log('Created folder: ', dest);
+    (0, fs_1.readdirSync)(src).forEach((file) => {
+        const srcFile = (0, path_1.join)(src, file);
+        const destFile = (0, path_1.join)(dest, file);
+        if ((0, fs_1.lstatSync)(srcFile).isDirectory()) {
+            copyAndReplaceFiles(srcFile, destFile);
+        }
+        else if (srcFile.endsWith('.ts')) {
+            const updatedContent = replacePrivateComments((0, fs_1.readFileSync)(srcFile, 'utf8'));
+            (0, fs_1.writeFileSync)(destFile, updatedContent, 'utf8');
+        }
+        else {
+            (0, fs_1.copyFileSync)(srcFile, destFile);
+        }
+    });
+};
+if ((0, fs_1.existsSync)(publicSrcFolder)) {
+    (0, fs_1.rmdirSync)(publicSrcFolder, { recursive: true });
+}
+copyAndReplaceFiles(srcFolder, publicSrcFolder);
+console.log('Public source files generated in /public-src/');

package/lib/types.d.ts

@@ -2,24 +2,35 @@ export interface User {
     _id: string;
     firstname: string;
     lastname: string;
-    email: string;
-    lastSeen: number;
-    status?: string;
-    managedUser?: boolean;
-    removed?: number;
-    defaultProfilepic: string;
 }
 export interface Workspace {
     _id: string;
     name: string;
 }
+export interface ActivityFieldRange {
+    start: number;
+    end: number;
+}
+export interface ActivityFieldLink {
+    _id: string;
+    name: string;
+}
+export interface ActivityFieldError {
+    error?: string;
+}
+export type ActivityFieldValue = boolean | number | string | (ActivityFieldCountry & ActivityFieldError & ActivityFieldRange & ActivityFieldLink);
+export type ActivityFieldUpdateValue = ActivityFieldValue | null;
+export interface ActivityFieldCountry {
+    /** ISO 3166-1 alpha-2 (cca2) */
+    code: string;
+}
 export interface Activity {
     _id: string;
     process: string;
     teamAccount: TeamAccount;
     created: number;
     uid: string;
-    cid: string;
+    workspaceId: string;
     discussion: string;
     currentPhase: string;
     active?: boolean;
@@ -35,7 +46,9 @@ export interface Activity {
             lng: number;
         }[];
     };
-    fields?: any;
+    fields?: {
+        [fieldId: string]: ActivityFieldValue;
+    };
     files?: any[];
     updated?: number;
     updatedBy?: string;
@@ -119,23 +132,30 @@ export interface InsightResponseData {
     rows: [];
     time: number;
 }
-export interface HailerAppConfig {
-    fields?: {
-        [fieldName: string]: {
-            type: string;
-            value?: string | number | boolean;
-        };
-    };
+export interface Config {
+    [fieldName: string]: string;
+}
+export type WorkflowFieldType = ('activitylink' | 'country' | 'date' | 'daterange' | 'datetime' | 'numeric' | 'numericunit' | 'teams' | 'text' | 'textarea' | 'textunit' | 'textpredefinedoptions' | 'time' | 'timerange' | 'datetimerange' | 'users' | 'linkedfrom' | 'subheader');
+export interface WorkflowField {
+    _id: string;
+    type: WorkflowFieldType;
+    label: string;
+    required: boolean;
+    unit: string;
+    placeholder: string;
+    description: string;
+    data: string[];
+    functionEnabled: boolean;
+    editable: boolean;
 }
-export type HailerProcess = Workflow;
 export interface Workflow {
     _id: string;
-    cid: string;
     name: string;
     description?: string;
     fields: {
         [fieldId: string]: any;
     };
+    fieldsOrder: string[];
     phases: {
         [phase_id: string]: WorkflowPhase;
     };
@@ -144,12 +164,23 @@ export interface Workflow {
     nameFunctionEnabled?: boolean;
     nameEditable?: boolean;
     productInstalledId: string;
+    workspaceId: string;
 }
 export interface WorkflowPhase {
     _id: string;
     name: string;
     description?: string;
     fields?: string[];
+    primaryDateField?: string;
+    primaryNumericField?: string;
+}
+/**
+ * ```ts
+ * { [templateId: string]: string }
+ * ```
+ */
+export interface IdsMap {
+    [templateId: string]: string;
 }
 export type PermissionType = 'admin' | 'own' | 'ownteam' | 'any' | 'edit';
 export interface Member {
@@ -159,6 +190,41 @@ export interface Member {
     };
     permissions: PermissionType[];
 }
+export type WorkflowPermission = 'admin' | 'any' | 'ownteam' | 'own' | 'guest' | 'none';
+export type WorkflowPhasePermission = 'edit' | 'view' | 'none';
+export interface PermissionPath {
+    type: 'network' | 'user' | 'team' | 'group';
+    id: string;
+    permission: WorkflowPermission | WorkflowPhasePermission;
+}
+export interface WorkflowPermissionMap {
+    [workflowId: string]: {
+        isAdmin: boolean;
+        permission: WorkflowPermission;
+        permissions: PermissionPath;
+        phases: {
+            [phaseId: string]: {
+                permission: WorkflowPhasePermission;
+                permissions: PermissionPath[];
+                restricted: boolean;
+            };
+        };
+        teams: string[];
+    };
+}
+export interface WorkspaceRolesPermission {
+    isAdmin: boolean;
+    isOwner: boolean;
+    isGuest: boolean;
+    isInviter: boolean;
+    isUser: boolean;
+}
+export interface PermissionMap {
+    [userId: string]: {
+        workflow: WorkflowPermissionMap;
+        workspace: WorkspaceRolesPermission;
+    };
+}
 export interface InsightWorkflowSource {
     name: string;
     workflowId: string;
@@ -174,24 +240,17 @@ export interface InsightWorkflowSource {
 export interface InsightDoc {
     _id: string;
     name: string;
-    sources: InsightWorkflowSource[];
-    cid: string;
-    /** User id of creator */
-    uid: string;
-    members: Member[];
-    updated: number;
-    public: boolean;
     /** Key for accessing Insight when set to public */
     publicKey?: string;
-    /** sandboxed javascript with access to all activities in given workflows */
-    function?: string;
-    /** To be used with SQLite if we want to.... */
-    query?: string;
     presets: {
         version: 1;
         name: string | 'default';
         options: any;
     }[];
+    /** To be used with SQLite if we want to.... */
+    query?: string;
+    sources: InsightWorkflowSource[];
+    public: boolean;
 }
 export type InsightPublic = Omit<InsightDoc, '_id'>;
 export interface InsightData {
@@ -267,6 +326,29 @@ export interface ActivityCreateOptions {
     phaseId?: string;
     returnDocument?: boolean;
 }
+/** Simplistic syntax for add/remove/replace */
+export interface IdSetUpdate {
+    /** Clear all existing */
+    '*'?: null;
+    /** Add: true, Remove: null */
+    [id: string]: true | null | undefined;
+}
+export interface ActivityLocation {
+    data: {
+        lat: number;
+        lng: number;
+    }[];
+    label?: string;
+    type: 'area' | 'point' | 'polyline';
+}
+export interface ActivityUpdateOptions {
+    fields?: ActivityFieldUpdateValue;
+    teamId?: string;
+    location?: ActivityLocation;
+    phaseId?: string;
+    files?: IdSetUpdate;
+    followers?: IdSetUpdate;
+}
 export interface ActivityKanbanListOptions {
     filter: {
         user?: {
@@ -288,35 +370,41 @@ export interface ActivityKanbanListOptions {
     includeUsers?: boolean;
     includeTeams?: boolean;
 }
-export interface HailerSettings {
+export interface Settings {
     theme: 'light' | 'dark';
     preferredLanguages: string[];
 }
-export interface HailerError {
-    code: number;
-    msg: string;
-    debug: object;
-}
-export interface HailerApiInfo {
+export interface ApiInfo {
     /** Url of the Hailer instance hosting the API */
     hostUrl?: string;
-    config?: HailerAppConfig;
+    config?: Config;
     outside: boolean | null;
     workspaceId?: string;
 }
-export declare class HailerError extends Error {
+export interface ApiError {
     code: number;
     msg: string;
     debug: object;
+}
+declare class CustomError extends Error {
+    msg: string;
+    code: number;
+    constructor(message: string, code: number);
+}
+export declare class HailerError extends CustomError {
+    debug: object;
+    details?: any;
     constructor(error: {
         code: number;
         msg: string;
-        debug: object;
+        details?: any;
+        debug: any;
     });
+    toString(): string;
 }
-export interface HailerSignal {
-    sig: string;
-    meta: any;
+export interface Signal {
+    name: string;
+    data: any;
 }
 export interface Product extends ProductType {
     _id: string;
@@ -329,7 +417,7 @@ export interface Product extends ProductType {
     publisher?: string;
     /** Available or not in app store  */
     public?: boolean;
-    cid?: string;
+    workspaceId?: string;
     uid: string;
 }
 export interface ProductSearchOption {
@@ -360,3 +448,4 @@ export interface Version {
     packageHash: string;
     created: number;
 }
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hailer/app-sdk",
-    "version": "1.0.3",
+    "version": "2.0.0-beta-1",
     "description": "SDK for building Hailer Apps",
     "author": "",
     "license": "ISC",

package/lib/modules/product-installed.d.ts

@@ -1,40 +0,0 @@
-import { Client } from '@wishcore/wish-rpc';
-import { ProductInstalled } from '../types';
-export declare class ProductInstalledApi {
-    private client;
-    constructor(client: Client);
-    /**
-     * Lists products from Hailer market
-     *
-     * @param cid WorkspaceId
-     * @param productId productId
-     *
-     * @returns List of installed products in Hailer market
-     *
-     * @throws {HailerError} if request is incorrect
-     */
-    list(productInstalled: {
-        cid: string;
-        productId: string;
-    }): Promise<ProductInstalled[]>;
-    /**
-     * Gets installed product from Hailer market
-     *
-     * @param id Product Installed Id
-     *
-     * @returns Single installed product from Hailer market or undefined if no installed product found
-     *
-     * @throws {HailerError} if request is incorrect
-     */
-    get(id: string): Promise<ProductInstalled | undefined>;
-    /**
-     * Remove installed product from Hailer market
-     *
-     * @param id Id of installed product in Hailer market
-     *
-     * @returns true, if removed
-     *
-     * @throws {HailerError} if request is incorrect
-     */
-    remove(id: string): Promise<boolean>;
-}

package/lib/modules/product-version.d.ts

@@ -1,38 +0,0 @@
-import { Client } from '@wishcore/wish-rpc';
-import { ProductVersion } from '../types';
-export declare class ProductVersionApi {
-    private client;
-    constructor(client: Client);
-    /**
-     * Gets single version from Hailer market
-     *
-     * @param id Version Id
-     *
-     * @returns Single version from Hailer market or undefined if no version found
-     *
-     * @throws {HailerError} if request is incorrect
-     */
-    get(id: string): Promise<ProductVersion | undefined>;
-    /**
-     * Publish template in Hailer market
-     *
-     * @param workspaceId Id of workspace
-     * @param versionId link to version (empty if first publish)
-     * @param version Version number
-     * @param versionDescription Version description
-     * @param title
-     * @param description
-     *
-     * @returns Created version in Hailer market
-     *
-     * @throws {HailerError} if request is incorrect
-     */
-    publishTemplate(template: {
-        workspaceId?: string;
-        versionId?: string;
-        version: string;
-        versionDescription: string;
-        title: string;
-        description: string;
-    }): Promise<ProductVersion>;
-}

package/lib/modules/public/product-version.d.ts

@@ -1,16 +0,0 @@
-import { Options } from '../../hailer-api';
-import { ProductVersion } from '../../types';
-export declare class ProductVersionPublicApi {
-    private options;
-    constructor(options: Options);
-    /**
-     * Gets single version from Hailer market
-     *
-     * @param id Version Id
-     *
-     * @returns Single version from Hailer market or undefined if no version found
-     *
-     * @throws {HailerError} if request is incorrect
-     */
-    get(id: string): Promise<ProductVersion | undefined>;
-}

package/lib/modules/public/version.d.ts

@@ -1,16 +0,0 @@
-import { Options } from '../../hailer-api';
-import { Version } from '../../types';
-export declare class VersionPublicApi {
-    private options;
-    constructor(options: Options);
-    /**
-     * Gets single version from Hailer market
-     *
-     * @param id Version Id
-     *
-     * @returns Single version from Hailer market or undefined if no version found
-     *
-     * @throws {HailerError} if request is incorrect
-     */
-    get(id: string): Promise<Version | undefined>;
-}