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

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

@@ -0,0 +1,104 @@
+import { Client } from '@wishcore/wish-rpc';
+import { Product, ProductSearchOption, ProductSearchFilter } from '../types';
+export declare class ProductApi {
+    private client;
+    constructor(client: Client);
+    /**
+     * Lists products from Hailer market
+     *
+     * @param filter ProductSearchFilter
+     * @param options ProductSearchOption
+     *
+     * @returns List of products in Hailer market filtered with supplied options
+     *
+     * @throws {HailerError} if request is incorrect
+     */
+    list(filter?: ProductSearchFilter, options?: ProductSearchOption): Promise<Product[]>;
+    /**
+     * Gets single product from Hailer market
+     *
+     * @param id Product Id
+     *
+     * @returns Single product from Hailer market or undefined if no product found
+     *
+     * @throws {HailerError} if request is incorrect
+     */
+    get(id: string): Promise<Product | undefined>;
+    /**
+     * Creates product in Hailer market
+     *
+     * @param versionId link to version
+     * @param name Name of the product
+     * @param header Header of the product
+     * @param description Description what this product is doing
+     * @param icon Icon id for the product
+     * @param images List of fileIds for showing pictures of the product
+     * @param externalUrl Public URL for creator to show more information about the product
+     * @param publisher Publisher (author)
+     * @param type App, template, music etc.
+     *
+     * @returns Created product in Hailer market
+     *
+     * @throws {HailerError} if request is incorrect
+     */
+    create(product: {
+        versionId: string;
+        name: string;
+        header?: string;
+        description?: string;
+        icon?: string;
+        images?: string[];
+        externalUrl?: string;
+        publisher?: string;
+        type?: string;
+    }): Promise<Product>;
+    /**
+     * Updates product in Hailer market
+     *
+     * @param id Id of product in Hailer market
+     * @param name Name of the product
+     * @param header Header of the product
+     * @param description Description what this product is doing
+     * @param icon Icon id for the product
+     * @param images List of fileIds for showing pictures of the product
+     * @param externalUrl Public URL for creator to show more information about the product
+     * @param publisher Publisher (Author)
+     * @param public: Visible or not in Hailer market
+     * @param type App, template, music etc.
+     *
+     * @returns Updated product in Hailer market
+     *
+     * @throws {HailerError} if request is incorrect
+     */
+    update(id: string, product: {
+        name?: string;
+        header?: string;
+        description?: string;
+        icon?: string;
+        images?: string[];
+        externalUrl?: string;
+        publisher?: string;
+        public?: string;
+        type?: string;
+    }): Promise<Product>;
+    /**
+     * Remove product from Hailer market
+     *
+     * @param id Id of product in Hailer market
+     *
+     * @returns true, if removed
+     *
+     * @throws {HailerError} if request is incorrect
+     */
+    remove(id: string): Promise<boolean>;
+    /**
+     * Install something from Hailer market
+     *
+     * @param id Id of product in Hailer market
+     *
+     * @returns true, if installed else error
+     *
+     * @throws {HailerError} if request is incorrect
+     */
+    install(id: string): Promise<boolean>;
+}

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

@@ -0,0 +1,17 @@
+import { Options } from '../../hailer-api';
+import { HailerAppConfig } from '../../types';
+export declare class App {
+    private options;
+    constructor(options: Options);
+    /**
+     * Read data from app API
+     *
+     * @param appId key of a specific insight
+     *
+     * @returns App manifest
+     *
+     * @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>;
+}

package/lib/src/modules/public/form.d.ts

@@ -0,0 +1,31 @@
+import { Options } from '../../hailer-api';
+import { FormCreateResponse, FormsData, FormsResponse } from '../../types';
+export declare class Form {
+    private options;
+    constructor(options: Options);
+    /**
+     * Read data from forms
+     *
+     * @param formsKey key of a form
+     * @param options Overrides default request options, url defaults to https://api.hailer.com/api/v2/forms
+     *
+     * @returns forms data as object or null if form could not be found
+     *
+     * @throws {HailerError} if there is something wrong with the request or form cannot be found
+     * @throws {TypeError} if Hailer cannot be reached
+     */
+    data(formsKey: string): Promise<FormsResponse>;
+    /**
+     * Submits form to specified process
+     *
+     * @param formsKey key of a form
+     * @param formsData Data to be sent to form endpoint
+     * @param options Overrides default request options, url defaults to https://api.hailer.com/api/v2/forms
+     *
+     * @returns form creation data or null if form could not be created
+     *
+     * @throws {HailerError} if there is something wrong with the request or form cannot be found
+     * @throws {TypeError} if Hailer cannot be reached
+     */
+    submit(formsKey: string, formsData: FormsData): Promise<FormCreateResponse>;
+}

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

@@ -0,0 +1,30 @@
+import { Options } from '../../hailer-api';
+import { InsightResponse, InsightResponseAsObjects } from '../../types';
+export declare class InsightPublicApi {
+    private options;
+    constructor(options: Options);
+    /**
+     * Read data from insight API
+     *
+     * @param insightKey key of a specific insight
+     * @param options Overrides default request options, url defaults to https://api.hailer.com/api/v3/insight/public
+     *
+     * @returns Insight data as object
+     *
+     * @throws {HailerError} if there is something wrong with the request or insight cannot be found
+     * @throws {TypeError} if Hailer cannot be reached
+     */
+    data(insightKey: string): Promise<InsightResponse>;
+    /**
+     * Read data from insight API and return in an array of JavaScript objects
+     *
+     * @param insightKey key of a specific insight
+     * @param options Overrides default request options, url defaults to https://api.hailer.com/api/v3/insight/public
+     *
+     * @returns Insight data as array of JavaScript objects
+     *
+     * @throws {HailerError} if there is something wrong with the request or insight cannot be found
+     * @throws {TypeError} if Hailer cannot be reached
+     */
+    dataAsObject(insightKey: string): Promise<InsightResponseAsObjects>;
+}

package/lib/src/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/src/modules/public/product.d.ts

@@ -0,0 +1,27 @@
+import { Options } from '../../hailer-api';
+import { Product, ProductSearchFilter, ProductSearchOption } from '../../types';
+export declare class ProductPublicApi {
+    private options;
+    constructor(options: Options);
+    /**
+     * Lists products from Hailer market
+     *
+     * @param filter ProductSearchFilter
+     * @param options ProductSearchOption
+     *
+     * @returns List of products in Hailer market filtered with supplied options
+     *
+     * @throws {HailerError} if request is incorrect
+     */
+    list(filter?: ProductSearchFilter, options?: ProductSearchOption): Promise<Product[]>;
+    /**
+     * Gets single product from Hailer market
+     *
+     * @param id Product Id
+     *
+     * @returns Single product from Hailer market or undefined if no product found
+     *
+     * @throws {HailerError} if request is incorrect
+     */
+    get(id: string): Promise<Product | undefined>;
+}

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

@@ -0,0 +1,22 @@
+import { Options } from '../hailer-api';
+import { App } from './public/app';
+import { Form } from './public/form';
+import { InsightPublicApi } from './public/insight';
+import { ProductPublicApi } from './public/product';
+import { ProductVersionPublicApi } from './public/product-version';
+/**
+ * This class is used to access Hailer public API even when the app is outside of Hailer
+ */
+export declare class HailerPublicApi {
+    /** Allows accessing public insight methods. Used for reading data from Hailer even when app is outside of Hailer */
+    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 */
+    app: App;
+    /** Access public Product information */
+    product: ProductPublicApi;
+    /** Access public Version information */
+    productVersion: ProductVersionPublicApi;
+    constructor(options: Options);
+}

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

@@ -0,0 +1,30 @@
+import { Client } from '@wishcore/wish-rpc';
+export type ActivityTabTypes = 'detail' | 'discussion' | 'files' | 'location' | 'linkedFrom' | 'options';
+export declare class Activity {
+    private client;
+    constructor(client: Client);
+    /** Opens an activity in Hailer sidebar */
+    open(
+    /** Hailer Activity Id */
+    activityId: string, options?: {
+        /** Which tab to open in activity aside */
+        tab?: ActivityTabTypes;
+    }): Promise<void>;
+    /** Opens activity creation view in Hailer sidebar */
+    create(processId: string, options?: {
+        /** Activity name/title */
+        name?: string;
+        /** Prepopulate fields */
+        fields?: {
+            [fieldId: string]: number | string | {
+                start: number;
+                end: number;
+            };
+        };
+    }): Promise<{
+        _id: string;
+        name: string;
+    } | null>;
+    /** Opens multiple activity edit view in Hailer sidebar */
+    editMultiple(activityIds: string[]): Promise<any>;
+}

package/lib/src/modules/ui/files.d.ts

@@ -0,0 +1,18 @@
+import { Client } from '@wishcore/wish-rpc';
+export declare class Files {
+    private client;
+    constructor(client: Client);
+    /**
+    * Uploads a file to Hailer
+    *
+    * @param file file to be uploaded
+    * @param publicFile is the file accessible outside of Hailer
+    * @param options if file is public
+    *
+    * @returns File ID in Hailer as string
+    */
+    uploadFile(file: File, filename: string, options: {
+        isPublic?: boolean;
+    }): Promise<string>;
+    private toBase64;
+}

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

@@ -0,0 +1,18 @@
+import { Client } from '@wishcore/wish-rpc';
+export declare class Snackbar {
+    private client;
+    constructor(client: Client);
+    /**
+     * Opens a snackbar in Hailer
+     * @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
+     */
+    open(
+    /** The text displayed on the snackbar */
+    text: string, 
+    /** The label for the button on the snackbar, for example 'OK' */
+    buttonLabel: string, 
+    /** The time the snackbar is visible in ms */
+    duration?: number): Promise<void>;
+}

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

@@ -0,0 +1,17 @@
+import { Client } from '@wishcore/wish-rpc';
+import { Activity } from './ui/activity';
+import { Snackbar } from './ui/snackbar';
+import { Files } from './ui/files';
+export declare class Ui {
+    private client;
+    activity: Activity;
+    snackbar: Snackbar;
+    files: Files;
+    insight: {
+        create: (workspaceId?: string) => Promise<void>;
+        edit: (insightId: string) => Promise<void>;
+        delete: (insightId: string) => Promise<void>;
+        permission: (insightId: string) => Promise<void>;
+    };
+    constructor(client: Client);
+}

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

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

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

@@ -0,0 +1,24 @@
+import { Client } from '@wishcore/wish-rpc';
+import { Workflow } from '../types';
+export declare class WorkflowApi {
+    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<Workflow[]>;
+    /**
+     * 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<Workflow>;
+}