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

package/lib/types.d.ts

@@ -2,29 +2,40 @@ 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;
     history?: any[];
-    name?: string;
+    name: string;
     followers?: string[];
     completePhases?: string[];
     location?: {
@@ -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,39 +370,45 @@ 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;
-    versionId: string;
+    targetId: string;
     name: string;
     description?: string;
     icon?: string;
@@ -329,7 +417,8 @@ export interface Product extends ProductType {
     publisher?: string;
     /** Available or not in app store  */
     public?: boolean;
-    cid?: string;
+    workspaceId?: string;
+    uid: string;
 }
 export interface ProductSearchOption {
     limit?: number;
@@ -350,17 +439,13 @@ export interface ProductType {
 export interface ProductVersion {
     _id: string;
     name: string;
-    versions?: {
-        version: string;
-        description: string;
-        packageHash: string;
-        created: number;
-    }[];
+    versions?: Version[];
     cid?: string;
 }
-export interface ProductInstalled {
-    _id: string;
-    productId: string;
-    versionId: string;
+export interface Version {
     version: string;
+    description: string;
+    packageHash: string;
+    created: number;
 }
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hailer/app-sdk",
-    "version": "1.0.2",
+    "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>;
-}

package/lib/modules/version.d.ts

@@ -1,16 +0,0 @@
-import { Client } from '@wishcore/wish-rpc';
-import { Version } from '../types';
-export declare class VersionApi {
-    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<Version | undefined>;
-}

package/lib/src/constants.d.ts

@@ -1,7 +0,0 @@
-export declare const DEFAULT_API_VERSION = 1;
-export declare const DEFAULT_ALLOWED_URLS: string[];
-export declare 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 declare const publicBackendMap: {
-    [host: string]: string;
-};

package/lib/src/hailer-api.d.ts

@@ -1,92 +0,0 @@
-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 { Process } from './modules/process';
-import { HailerPublicApi } from './modules/public';
-import { WorkflowApi } from './modules/workflow';
-import { AppApi } from './modules/app';
-import { InsightApi } from './modules/insight';
-import { PermissionApi } from './modules/permission';
-import { ProductApi } from './modules/product';
-import { ProductVersionApi } from './modules/product-version';
-import { ProductInstalledApi } from './modules/product-installed';
-export interface Options {
-    /** When connected is called the host is ready to receive calls */
-    connected?: () => void;
-    /** Callback when app is determined to be outside of Hailer, as a standalone app */
-    outside?: (config?: any) => void;
-    /** Callback on errors, defaults to printing errors in console */
-    error?: (error: Error) => void;
-    /** 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;
-    /** 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;
-    /** 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;
-}
-export declare class HailerApi {
-    options: Options;
-    user: UserApi;
-    app: AppApi;
-    activity: ActivityApi;
-    insight: InsightApi;
-    network: WorkspaceApi;
-    process: Process;
-    workflow: WorkflowApi;
-    permission: PermissionApi;
-    product: ProductApi;
-    productVersion: ProductVersionApi;
-    productInstalled: ProductInstalledApi;
-    /** All public endpoints, which can be accessed while not logged in to Hailer. */
-    public: HailerPublicApi;
-    /** User interface commands */
-    ui: Ui;
-    /** Url of the Hailer instance hosting the API */
-    private hostUrl?;
-    private appId?;
-    /** 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
-     *
-     * ```
-     * true // outside hailer
-     * false // logged into hailer
-     * null // state not yet detected
-     * ```
-     */
-    private outside;
-    /**
-     * Create a Hailer API client for inteacting with Hailer. **NOTE** This only works when inside Hailer.
-     *
-     * This should be run after window is initialized for example in ***onMount*** in Svelte or in ***useEffect*** in React
-     */
-    constructor(options?: Options);
-    private createEventListener;
-    info(): HailerApiInfo;
-    request(op: string, args: any[]): Promise<any>;
-}

package/lib/src/index.d.ts

@@ -1,2 +0,0 @@
-export { HailerApi } from './hailer-api';
-export * from './types';

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

@@ -1,36 +0,0 @@
-import { Client } from '@wishcore/wish-rpc';
-import { ActivityKanbanListOptions, KanbanListResponse, KanbanLoadResponse } from '../../types';
-export declare class Kanban {
-    private client;
-    constructor(client: Client);
-    /**
-     * Lists all activities in a kanban grouped by phases
-     *
-     * @param processId the id of the process the kanban relates to
-     * @param options ActivityKanbanListOptions
-     *
-     * @returns activities in kanban list format
-     *
-     * @throws {HailerError} if request fails
-     */
-    list(processId: string, options?: ActivityKanbanListOptions): Promise<KanbanListResponse>;
-    /**
-     * Loads a single activity in kanban format
-     *
-     * @param activityId activityId of the wanted activity
-     *
-     * @returns activity in kanban format
-     *
-     * @throws {HailerError} if request is incorrect
-     */
-    load(activityId: string): Promise<KanbanLoadResponse>;
-    /**
-     * Updates priority of activities in kanban
-     *
-     * @param activityId activityId of the wanted activity
-     * @param priority new priority for the activity
-     *
-     * @throws {HailerError} if request is incorrect
-     */
-    updatePriority(activityId: string, priority: number): Promise<void>;
-}

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

@@ -1,83 +0,0 @@
-import { Client } from '@wishcore/wish-rpc';
-import { ActivityCreateOptions, ActivityListOptions, Activity } from '../types';
-import { Kanban } from './activity/kanban';
-export declare class ActivityApi {
-    private client;
-    kanban: Kanban;
-    constructor(client: Client);
-    /**
-     * Lists all activities from the specified process and phase
-     *
-     * @param processId process from current network
-     * @param phaseId phase in the process specified in processId
-     * @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<Activity[]>;
-    /**
-     * Gets single activity
-     *
-     * @param activityId activity Id of the process specified in processId
-     * @param processId Process where the activityId is
-     * @param phaseId Phase where the activityId is in process specified by processId
-     * @param options options containing apiVersion
-     *
-     * @returns Hailer activity information or undefined if no activity is found
-     *
-     * @throws {HailerError} if request is incorrect
-     */
-    get(activityId: string): Promise<Activity | undefined>;
-    /**
-     * 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;
-        fields?: {
-            [id: string]: string | number;
-        };
-    }[], 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
-     */
-    update(activities: {
-        _id: string;
-        name?: string;
-        fields?: {
-            [id: string]: string | number | null;
-        };
-        phaseId?: string;
-    }[], options: any): Promise<number>;
-    /**
-     * Removes activities
-     *
-     * @param activities Ids of activities to be removed
-     * @param options options containing apiVersion
-     *
-     * @returns The number of removed activities
-     *
-     * @throws {HailerError} if request is incorrect
-     */
-    remove(activities: string[]): Promise<number>;
-}

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

@@ -1,12 +0,0 @@
-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 | undefined, config: HailerAppConfig) => Promise<void>;
-    };
-}