@hailer/app-sdk 1.0.0 → 1.0.1-beta

package/lib/constants.js

@@ -1,6 +1,6 @@
 // Changing this will be a breaking change
 export const DEFAULT_API_VERSION = 1;
-export const DEFAULT_ALLOWED_URLS = ['https://app.hailer.com', 'https://next.hailer.com', 'https://testapp.hailer.biz', 'https://app.hailer.biz'];
+export const DEFAULT_ALLOWED_URLS = ['https://app.hailer.com', 'https://next.hailer.com', 'https://testapp.hailer.biz', 'https://app.hailer.biz', 'https://localhost:9443'];
 export const DEFAULT_BACKEND_URL = 'https://api.hailer.com';
 /** Map of which backend to use depending on which frontend is hosting the app frame, be sure to fall back to production backend if no match */
 export const publicBackendMap = {

package/lib/hailer-api.d.ts

@@ -1,12 +1,13 @@
-import { User } from './modules/user';
-import { Activity } from './modules/activity';
-import { Network } from './modules/network';
-import { ApiVersion, HailerApiInfo, HailerSettings, HailerSignal } from './types';
+import { UserApi } from './modules/user';
+import { ActivityApi } from './modules/activity';
+import { WorkspaceApi } from './modules/network';
+import { HailerApiInfo, HailerSettings, HailerSignal } from './types';
 import { Ui } from './modules/ui';
-import { Insight } from './modules/insight';
 import { Process } from './modules/process';
-import { HailerApiPublic } from './modules/public';
-import { Workflow } from './modules/workflow';
+import { HailerPublicApi } from './modules/public';
+import { WorkflowApi } from './modules/workflow';
+import { AppApi } from './modules/app';
+import { InsightApi } from './modules/insight';
 export interface Options {
     /** When connected is called the host is ready to receive calls */
     connected?: () => void;
@@ -27,20 +28,21 @@ export interface Options {
     /** The signals we want the Hailer frontend to pass to the app. If an empty array is provided, all signals will be passed. */
     subscribedSignals?: string[];
     /** Api version to be used in the app by default */
-    apiVersion?: ApiVersion;
+    apiVersion?: 1;
     /** Public backend Api url. Defaults to https://api.hailer.com */
     publicBackendUrl?: string;
 }
 export declare class HailerApi {
     options: Options;
-    user: User;
-    activity: Activity;
-    insight: Insight;
-    network: Network;
+    user: UserApi;
+    app: AppApi;
+    activity: ActivityApi;
+    insight: InsightApi;
+    network: WorkspaceApi;
     process: Process;
-    workflow: Workflow;
+    workflow: WorkflowApi;
     /** All public endpoints, which can be accessed while not logged in to Hailer. */
-    public: HailerApiPublic;
+    public: HailerPublicApi;
     /** User interface commands */
     ui: Ui;
     /** Url of the Hailer instance hosting the API */

package/lib/hailer-api.js

@@ -8,15 +8,16 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { Client } from '@wishcore/wish-rpc';
-import { User } from './modules/user';
-import { Activity } from './modules/activity';
-import { Network } from './modules/network';
+import { UserApi } from './modules/user';
+import { ActivityApi } from './modules/activity';
+import { WorkspaceApi } from './modules/network';
 import { Ui } from './modules/ui';
-import { Insight } from './modules/insight';
 import { Process } from './modules/process';
 import { DEFAULT_ALLOWED_URLS, DEFAULT_API_VERSION, DEFAULT_BACKEND_URL, publicBackendMap } from './constants';
-import { HailerApiPublic } from './modules/public';
-import { Workflow } from './modules/workflow';
+import { HailerPublicApi } from './modules/public';
+import { WorkflowApi } from './modules/workflow';
+import { AppApi } from './modules/app';
+import { InsightApi } from './modules/insight';
 export class HailerApi {
     /**
      * Create a Hailer API client for inteacting with Hailer. **NOTE** This only works when inside Hailer.
@@ -44,13 +45,14 @@ export class HailerApi {
                 parent.postMessage(JSON.stringify(msg), this.hostUrl);
             }
         });
-        this.user = new User(this.client);
-        this.activity = new Activity(this.client);
-        this.insight = new Insight(this.client);
-        this.network = new Network(this.client);
+        this.user = new UserApi(this.client);
+        this.app = new AppApi(this.client);
+        this.activity = new ActivityApi(this.client);
+        this.insight = new InsightApi(this.client);
+        this.network = new WorkspaceApi(this.client);
         this.process = new Process(this.client);
-        this.workflow = new Workflow(this.client);
-        this.public = new HailerApiPublic(this.options);
+        this.workflow = new WorkflowApi(this.client);
+        this.public = new HailerPublicApi(this.options);
         this.ui = new Ui(this.client);
         const registerMessage = JSON.stringify({ op: 'register', args: [] });
         // If we are not in Iframe set location to outside, else wait 100ms for response to register to check if we are in Hailer

package/lib/modules/activity/kanban.d.ts

@@ -7,7 +7,7 @@ export declare class Kanban {
      * Lists all activities in a kanban grouped by phases
      *
      * @param processId the id of the process the kanban relates to
-     * @param options object containing apiVersion option and requestOptions to be passed to the backend endpoint
+     * @param options ActivityKanbanListOptions
      *
      * @returns activities in kanban list format
      *
@@ -18,7 +18,6 @@ export declare class Kanban {
      * Loads a single activity in kanban format
      *
      * @param activityId activityId of the wanted activity
-     * @param options object containing apiVersion option
      *
      * @returns activity in kanban format
      *
@@ -30,7 +29,6 @@ export declare class Kanban {
      *
      * @param activityId activityId of the wanted activity
      * @param priority new priority for the activity
-     * @param options object containing apiVersion option
      *
      * @throws {HailerError} if request is incorrect
      */

package/lib/modules/activity/kanban.js

@@ -16,7 +16,7 @@ export class Kanban {
      * Lists all activities in a kanban grouped by phases
      *
      * @param processId the id of the process the kanban relates to
-     * @param options object containing apiVersion option and requestOptions to be passed to the backend endpoint
+     * @param options ActivityKanbanListOptions
      *
      * @returns activities in kanban list format
      *
@@ -37,7 +37,6 @@ export class Kanban {
      * Loads a single activity in kanban format
      *
      * @param activityId activityId of the wanted activity
-     * @param options object containing apiVersion option
      *
      * @returns activity in kanban format
      *
@@ -59,7 +58,6 @@ export class Kanban {
      *
      * @param activityId activityId of the wanted activity
      * @param priority new priority for the activity
-     * @param options object containing apiVersion option
      *
      * @throws {HailerError} if request is incorrect
      */

package/lib/modules/activity.d.ts

@@ -1,7 +1,7 @@
 import { Client } from '@wishcore/wish-rpc';
-import { ActivityCreateOptions, ActivityListOptions, HailerActivity } from '../types';
+import { ActivityCreateOptions, ActivityListOptions, Activity } from '../types';
 import { Kanban } from './activity/kanban';
-export declare class Activity {
+export declare class ActivityApi {
     private client;
     kanban: Kanban;
     constructor(client: Client);
@@ -10,13 +10,13 @@ export declare class Activity {
      *
      * @param processId process from current network
      * @param phaseId phase in the process specified in processId
-     * @param options options with apiVersion and requestOptions, default values can be found in api.hailer.com/docs v3.activity.list
+     * @param options ActivityListOptions
      *
      * @returns List of Hailer activities from process and phase filtered with supplied options
      *
      * @throws {HailerError} if request is incorrect
      */
-    list(processId: string, phaseId: string, options?: ActivityListOptions): Promise<HailerActivity[]>;
+    list(processId: string, phaseId: string, options?: ActivityListOptions): Promise<Activity[]>;
     /**
      * Gets single activity
      *
@@ -29,7 +29,7 @@ export declare class Activity {
      *
      * @throws {HailerError} if request is incorrect
      */
-    get(activityId: string): Promise<HailerActivity | undefined>;
+    get(activityId: string): Promise<Activity | undefined>;
     /**
      * Creates activities
      *
@@ -37,7 +37,7 @@ export declare class Activity {
      * @param activities new activities as objects
      * @param activities.name name of the activity
      * @param activities.fields fields of the activity
-     * @param options optional options with apiVersion and requestOptions to be passed to the backend endpoint
+     * @param options ActivityCreateOptions
      *
      * @throws {HailerError} if request is incorrect
      */
@@ -46,7 +46,7 @@ export declare class Activity {
         fields: {
             [id: string]: string | number;
         };
-    }[], options?: ActivityCreateOptions): Promise<HailerActivity[]>;
+    }[], options?: ActivityCreateOptions): Promise<Activity[]>;
     /**
      * Updates activites
      *
@@ -55,7 +55,7 @@ export declare class Activity {
      * @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 options containing apiVersion
+     * @param options
      *
      * @returns The number of updated activities
      *

package/lib/modules/activity.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { HailerError } from '../types';
 import { Kanban } from './activity/kanban';
-export class Activity {
+export class ActivityApi {
     constructor(client) {
         this.client = client;
         this.kanban = new Kanban(client);
@@ -19,7 +19,7 @@ export class Activity {
      *
      * @param processId process from current network
      * @param phaseId phase in the process specified in processId
-     * @param options options with apiVersion and requestOptions, default values can be found in api.hailer.com/docs v3.activity.list
+     * @param options ActivityListOptions
      *
      * @returns List of Hailer activities from process and phase filtered with supplied options
      *
@@ -66,7 +66,7 @@ export class Activity {
      * @param activities new activities as objects
      * @param activities.name name of the activity
      * @param activities.fields fields of the activity
-     * @param options optional options with apiVersion and requestOptions to be passed to the backend endpoint
+     * @param options ActivityCreateOptions
      *
      * @throws {HailerError} if request is incorrect
      */
@@ -89,7 +89,7 @@ export class Activity {
      * @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 options containing apiVersion
+     * @param options
      *
      * @returns The number of updated activities
      *

package/lib/modules/app.d.ts

@@ -0,0 +1,12 @@
+import { Client } from '@wishcore/wish-rpc';
+import { HailerAppConfig } from '../types';
+/**
+ * This class is used to access Hailer public API even when the app is outside of Hailer
+ */
+export declare class AppApi {
+    private client;
+    constructor(client: Client);
+    config: {
+        update: (appId: string, config: HailerAppConfig) => Promise<void>;
+    };
+}

package/lib/modules/app.js

@@ -0,0 +1,29 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { HailerError } from '../types';
+/**
+ * This class is used to access Hailer public API even when the app is outside of Hailer
+ */
+export class AppApi {
+    constructor(client) {
+        this.client = client;
+        this.config = {
+            update: (appId, config) => __awaiter(this, void 0, void 0, function* () {
+                try {
+                    return yield this.client.requestAsync('v1.app.config.update', [appId, config]);
+                }
+                catch (error) {
+                    console.log('Errorasd ', error);
+                    throw new HailerError(error);
+                }
+            })
+        };
+    }
+}

package/lib/modules/insight.d.ts

@@ -1,13 +1,12 @@
 import { Client } from '@wishcore/wish-rpc';
 import { InsightData, InsightDoc } from '../types';
-export declare class Insight {
+export declare class InsightApi {
     private client;
     constructor(client: Client);
     /**
      * Get Insight data
      *
      * @param insightId the id of the Insight the data is fetched from
-     * @param options object containing apiVersion option
      *
      * @returns data from the Insight
      *
@@ -17,7 +16,6 @@ export declare class Insight {
     /**
      * Get Insight data
      *
-     * @param options object containing apiVersion option
      *
      * @returns data from the Insight
      *

package/lib/modules/insight.js

@@ -8,7 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { HailerError } from '../types';
-export class Insight {
+export class InsightApi {
     constructor(client) {
         this.client = client;
     }
@@ -16,7 +16,6 @@ export class Insight {
      * Get Insight data
      *
      * @param insightId the id of the Insight the data is fetched from
-     * @param options object containing apiVersion option
      *
      * @returns data from the Insight
      *
@@ -35,7 +34,6 @@ export class Insight {
     /**
      * Get Insight data
      *
-     * @param options object containing apiVersion option
      *
      * @returns data from the Insight
      *

package/lib/modules/network.d.ts

@@ -1,6 +1,6 @@
 import { Client } from '@wishcore/wish-rpc';
-import { HailerWorkspace } from '../types';
-export declare class Network {
+import { Workspace } from '../types';
+export declare class WorkspaceApi {
     private client;
     constructor(client: Client);
     /**
@@ -10,5 +10,5 @@ export declare class Network {
      *
      * @throws {HailerError} if request is incorrect
      */
-    current(): Promise<HailerWorkspace>;
+    current(): Promise<Workspace>;
 }

package/lib/modules/network.js

@@ -8,7 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { HailerError } from '../types';
-export class Network {
+export class WorkspaceApi {
     constructor(client) {
         this.client = client;
     }

package/lib/modules/process.d.ts

@@ -18,7 +18,6 @@ export declare class Process {
      * Gets a single process from a workspace
      *
      * @param processId the id of the process in question
-     * @param options object containing apiVersion option
      *
      * @returns the specified Hailer process
      *
@@ -30,7 +29,6 @@ export declare class Process {
      *
      * @param processId the id of the process in question
      * @param fieldName name of the field
-     * @param options object containing apiVersion option
      *
      * @returns the field id as string
      *

package/lib/modules/process.js

@@ -35,7 +35,6 @@ export class Process {
      * Gets a single process from a workspace
      *
      * @param processId the id of the process in question
-     * @param options object containing apiVersion option
      *
      * @returns the specified Hailer process
      *
@@ -57,7 +56,6 @@ export class Process {
      *
      * @param processId the id of the process in question
      * @param fieldName name of the field
-     * @param options object containing apiVersion option
      *
      * @returns the field id as string
      *

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

@@ -1,6 +1,6 @@
 import { Options } from '../../hailer-api';
 import { InsightResponse, InsightResponseAsObjects } from '../../types';
-export declare class Insight {
+export declare class InsightPublicApi {
     private options;
     constructor(options: Options);
     /**

package/lib/modules/public/insight.js

@@ -8,7 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { HailerError } from '../../types';
-export class Insight {
+export class InsightPublicApi {
     constructor(options) {
         this.options = options;
     }

package/lib/modules/public.d.ts

@@ -1,13 +1,13 @@
 import { Options } from '../hailer-api';
 import { App } from './public/app';
 import { Form } from './public/form';
-import { Insight } from './public/insight';
+import { InsightPublicApi } from './public/insight';
 /**
  * This class is used to access Hailer public API even when the app is outside of Hailer
  */
-export declare class HailerApiPublic {
+export declare class HailerPublicApi {
     /** Allows accessing public insight methods. Used for reading data from Hailer even when app is outside of Hailer */
-    insight: Insight;
+    insight: InsightPublicApi;
     /** Allows accessing public forms methods. Used for sending data to Hailer even when app is outside of Hailer */
     form: Form;
     /** Access public App information */

package/lib/modules/public.js

@@ -1,12 +1,12 @@
 import { App } from './public/app';
 import { Form } from './public/form';
-import { Insight } from './public/insight';
+import { InsightPublicApi } from './public/insight';
 /**
  * This class is used to access Hailer public API even when the app is outside of Hailer
  */
-export class HailerApiPublic {
+export class HailerPublicApi {
     constructor(options) {
-        this.insight = new Insight(options);
+        this.insight = new InsightPublicApi(options);
         this.form = new Form(options);
         this.app = new App(options);
     }

package/lib/modules/ui/activity.d.ts

@@ -21,5 +21,8 @@ export declare class Activity {
                 end: number;
             };
         };
-    }): Promise<void>;
+    }): Promise<{
+        _id: string;
+        name: string;
+    } | null>;
 }

package/lib/modules/ui/snackbar.d.ts

@@ -7,7 +7,6 @@ export declare class Snackbar {
      * @param text the text displayed on the snackbar
      * @param buttonLabel the label for the button on the snackbar, for example 'OK'
      * @param duration the time the snackbar is visible in ms
-     * @param options object containing apiVersion option
      */
     open(
     /** The text displayed on the snackbar */

package/lib/modules/ui/snackbar.js

@@ -16,7 +16,6 @@ export class Snackbar {
      * @param text the text displayed on the snackbar
      * @param buttonLabel the label for the button on the snackbar, for example 'OK'
      * @param duration the time the snackbar is visible in ms
-     * @param options object containing apiVersion option
      */
     open(
     /** The text displayed on the snackbar */

package/lib/modules/user.d.ts

@@ -1,39 +1,36 @@
 import { Client } from '@wishcore/wish-rpc';
-import { HailerUser } from '../types';
-export declare class User {
+import { User } from '../types';
+export declare class UserApi {
     private client;
     constructor(client: Client);
     /**
      * Returns the specified user
      *
      * @param userId id of the Hailer user
-     * @param options object containing apiVersion option
      *
      * @returns Hailer user information
      *
      * @throws {HailerError} if request is incorrect
      */
-    get(userId: string): Promise<HailerUser>;
+    get(userId: string): Promise<User>;
     /**
      * Returns the current user
      *
-     * @param options object containing apiVersion option
      *
      * @returns the current Hailer user information
      *
      * @throws {HailerError} if request is incorrect
      */
-    current(): Promise<HailerUser>;
+    current(): Promise<User>;
     /**
      * Lists all Hailer users from a workspace
      *
-     * @param options object containing apiVersion option
      *
      * @returns list of Hailer users in the workspace the app user is currently in
      *
      * @throws {HailerError} if request is incorrect
      */
     list(): Promise<{
-        [key: string]: HailerUser;
+        [key: string]: User;
     }>;
 }

package/lib/modules/user.js

@@ -8,7 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { HailerError } from '../types';
-export class User {
+export class UserApi {
     constructor(client) {
         this.client = client;
     }
@@ -16,7 +16,6 @@ export class User {
      * Returns the specified user
      *
      * @param userId id of the Hailer user
-     * @param options object containing apiVersion option
      *
      * @returns Hailer user information
      *
@@ -36,7 +35,6 @@ export class User {
     /**
      * Returns the current user
      *
-     * @param options object containing apiVersion option
      *
      * @returns the current Hailer user information
      *
@@ -56,7 +54,6 @@ export class User {
     /**
      * Lists all Hailer users from a workspace
      *
-     * @param options object containing apiVersion option
      *
      * @returns list of Hailer users in the workspace the app user is currently in
      *

package/lib/modules/workflow.d.ts

@@ -1,6 +1,6 @@
 import { Client } from '@wishcore/wish-rpc';
-import { HailerProcess } from '../types';
-export declare class Workflow {
+import { Workflow } from '../types';
+export declare class WorkflowApi {
     private client;
     constructor(client: Client);
     /**
@@ -10,16 +10,15 @@ export declare class Workflow {
      *
      * @throws {HailerError} if request is incorrect
      */
-    list(): Promise<HailerProcess[]>;
+    list(): Promise<Workflow[]>;
     /**
      * Gets a single process from a workspace
      *
      * @param processId the id of the process in question
-     * @param options object containing apiVersion option
      *
      * @returns the specified Hailer process
      *
      * @throws {HailerError} if request is incorrect
      */
-    get(processId: string): Promise<HailerProcess>;
+    get(processId: string): Promise<Workflow>;
 }

package/lib/modules/workflow.js

@@ -8,7 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { HailerError } from '../types';
-export class Workflow {
+export class WorkflowApi {
     constructor(client) {
         this.client = client;
     }
@@ -34,7 +34,6 @@ export class Workflow {
      * Gets a single process from a workspace
      *
      * @param processId the id of the process in question
-     * @param options object containing apiVersion option
      *
      * @returns the specified Hailer process
      *

package/lib/types.d.ts

@@ -1,4 +1,4 @@
-export interface HailerUser {
+export interface User {
     firstname: string;
     lastname: string;
     email: string;
@@ -7,7 +7,7 @@ export interface HailerUser {
     managedUser?: boolean;
     removed?: number;
 }
-export interface HailerWorkspace {
+export interface Workspace {
     _id: string;
     name: string;
     members: string[];
@@ -26,7 +26,7 @@ export interface HailerWorkspace {
         };
     };
 }
-export interface HailerActivity {
+export interface Activity {
     _id: string;
     process: string;
     teamAccount: TeamAccount;
@@ -59,13 +59,6 @@ export interface TeamAccount {
     account: string;
     team: string;
 }
-export interface Link {
-    id: string;
-    linkId: string;
-    type: LinkType;
-    created: string;
-}
-export type LinkType = 'user-mention' | 'reaction' | 'tag' | 'apple-id' | 'feed.lastseen' | 'google-folder-id';
 export interface FormsData {
     files: string[];
     history: {
@@ -147,7 +140,8 @@ export interface HailerAppConfig {
         };
     };
 }
-export interface HailerProcess {
+export type HailerProcess = Workflow;
+export interface Workflow {
     _id: string;
     cid: string;
     name: string;
@@ -156,16 +150,17 @@ export interface HailerProcess {
         [fieldId: string]: any;
     };
     phases: {
-        [phase_id: string]: HailerPhase;
+        [phase_id: string]: WorkflowPhase;
     };
+    phasesOrder: string[];
 }
-export interface HailerPhase {
+export interface WorkflowPhase {
     _id: string;
     name: string;
     description?: string;
 }
 export type PermissionType = 'admin' | 'own' | 'ownteam' | 'any' | 'edit';
-export interface MemberDoc {
+export interface Member {
     id: string;
     info: {
         [key: string]: string | number | boolean | null;
@@ -190,7 +185,7 @@ export interface InsightDoc {
     cid: string;
     /** User id of creator */
     uid: string;
-    members: MemberDoc[];
+    members: Member[];
     updated: number;
     public: boolean;
     /** Key for accessing Insight when set to public */
@@ -294,7 +289,6 @@ export interface ActivityKanbanListOptions {
     includeUsers?: boolean;
     includeTeams?: boolean;
 }
-export type ApiVersion = 1;
 export interface HailerSettings {
     theme: 'light' | 'dark';
     preferredLanguages: string[];

package/package.json

@@ -1,10 +1,11 @@
 {
     "name": "@hailer/app-sdk",
-    "version": "1.0.0",
+    "version": "1.0.1-beta",
     "description": "SDK for building Hailer Apps",
     "author": "",
     "license": "ISC",
     "main": "./lib/index.js",
+    "type": "module",
     "types": "./lib/index.d.ts",
     "files": [
         "./lib/**/*"