@hailer/app-sdk 2.0.0-beta-2 → 2.0.0-beta-4

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

@@ -0,0 +1,40 @@
+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

@@ -0,0 +1,38 @@
+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/product.d.ts

@@ -1,5 +1,5 @@
 import { Client } from '@wishcore/wish-rpc';
-import { Product, ProductSearchOption, ProductSearchFilter } from '../types';
+import { Product, ProductSearchOption, ProductSearchFilter, ProductListResponse } from '../types';
 export declare class ProductApi {
     private client;
     constructor(client: Client);
@@ -13,7 +13,7 @@ export declare class ProductApi {
      *
      * @throws {HailerError} if request is incorrect
      */
-    list(filter?: ProductSearchFilter, options?: ProductSearchOption): Promise<Product[]>;
+    list(filter?: ProductSearchFilter, options?: ProductSearchOption): Promise<ProductListResponse>;
     /**
      * Gets single product from Hailer market
      *
@@ -27,7 +27,7 @@ export declare class ProductApi {
     /**
      * Creates product in Hailer market
      *
-     * @param versionId link to version
+     * @param targetId link to targetId (version)
      * @param name Name of the product
      * @param description Description what this product is doing
      * @param icon Icon id for the product
@@ -41,7 +41,7 @@ export declare class ProductApi {
      * @throws {HailerError} if request is incorrect
      */
     create(product: {
-        versionId: string;
+        targetId?: string;
         name: string;
         description?: string;
         icon?: string;

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

@@ -0,0 +1,16 @@
+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/product.d.ts

@@ -1,5 +1,5 @@
 import { Options } from '../../hailer-api';
-import { Product, ProductSearchFilter, ProductSearchOption } from '../../types';
+import { Product, ProductListResponse, ProductSearchFilter, ProductSearchOption } from '../../types';
 export declare class ProductPublicApi {
     private options;
     constructor(options: Options);
@@ -13,7 +13,7 @@ export declare class ProductPublicApi {
      *
      * @throws {HailerError} if request is incorrect
      */
-    list(filter?: ProductSearchFilter, options?: ProductSearchOption): Promise<Product[]>;
+    list(filter?: ProductSearchFilter, options?: ProductSearchOption): Promise<ProductListResponse>;
     /**
      * Gets single product from Hailer market
      *

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

@@ -0,0 +1,16 @@
+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

@@ -0,0 +1,16 @@
+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/modules/workspace.d.ts

@@ -17,7 +17,7 @@ export declare class WorkspaceApi {
         /** Get version */
         get(id: string): Promise<ProductVersion | undefined>;
         /** Install template from Hailer market */
-        install(id: string): Promise<boolean>;
+        install(productId: string, workspaceId: string): Promise<boolean>;
         /** Get manifest content from Hailer market */
         getManifest(id: string): Promise<any>;
     };
@@ -76,7 +76,9 @@ export declare class WorkspaceApi {
     /**
      * Install template from Hailer market
      *
-     * @param id Id of product in Hailer market
+     * @param productId Id of product in Hailer market
+     *
+     * @param workspaceId Id of workspace where the product will be installed
      *
      * @returns true, if installed else error
      *

package/lib/src/constants.d.ts

@@ -0,0 +1,7 @@
+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

@@ -0,0 +1,92 @@
+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/{index.js → src/index.d.ts}

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

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

@@ -0,0 +1,36 @@
+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

@@ -0,0 +1,83 @@
+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

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

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

@@ -0,0 +1,36 @@
+import { Client } from '@wishcore/wish-rpc';
+import { InsightData, InsightDoc } from '../types';
+export declare class InsightApi {
+    private client;
+    constructor(client: Client);
+    /**
+     * Get Insight data
+     *
+     * @param insightId the id of the Insight the data is fetched from
+     *
+     * @returns data from the Insight
+     *
+     * @throws {HailerError} if request is incorrect
+     */
+    data(insightId: string, options: {
+        update?: true;
+    }): Promise<InsightData>;
+    /**
+     * Get Insight data
+     *
+     *
+     * @returns data from the Insight
+     *
+     * @throws {HailerError} if request is incorrect
+     */
+    list(): Promise<InsightDoc[]>;
+    /**
+     * Get Insight data
+     *
+     *
+     * @returns data from the Insight
+     *
+     * @throws {HailerError} if request is incorrect
+     */
+    update(insightId: string, update: Partial<InsightDoc>): Promise<InsightDoc[]>;
+}

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

@@ -0,0 +1,14 @@
+import { Client } from '@wishcore/wish-rpc';
+import { Workspace } from '../types';
+export declare class WorkspaceApi {
+    private client;
+    constructor(client: Client);
+    /**
+     * Returns the current network
+     *
+     * @returns the Hailer Workspace information the user is currently in
+     *
+     * @throws {HailerError} if request is incorrect
+     */
+    current(): Promise<Workspace>;
+}

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

@@ -0,0 +1,9 @@
+import { Client } from '@wishcore/wish-rpc';
+/**
+ * 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>;
+}

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

@@ -0,0 +1,38 @@
+import { Client } from '@wishcore/wish-rpc';
+import { HailerProcess } from '../types';
+/** @deprecated Use Workflow instead */
+export declare class Process {
+    private client;
+    constructor(client: Client);
+    /**
+     * Lists all processes from a workspace
+     *
+     * @returns all Hailer processes in the workspace the app user is currently in
+     *
+     * @throws {HailerError} if request is incorrect
+     */
+    list(): Promise<{
+        [key: string]: HailerProcess;
+    }>;
+    /**
+     * Gets a single process from a workspace
+     *
+     * @param processId the id of the process in question
+     *
+     * @returns the specified Hailer process
+     *
+     * @throws {HailerError} if request is incorrect
+     */
+    get(processId: string): Promise<HailerProcess>;
+    /**
+     * Gets an id of a field in a process by its name
+     *
+     * @param processId the id of the process in question
+     * @param fieldName name of the field
+     *
+     * @returns the field id as string
+     *
+     * @throws {HailerError} if request is incorrect
+     */
+    getFieldIdByName(processId: string, fieldName: string): Promise<string>;
+}

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

@@ -0,0 +1,40 @@
+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/src/modules/product-version.d.ts

@@ -0,0 +1,16 @@
+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>;
+}