@hailer/app-sdk 2.0.0-beta-5 → 2.0.0-beta-7

package/lib/modules/network.d.ts

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

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

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

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

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

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

@@ -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/src/modules/product-version.d.ts

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

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

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

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

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

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

@@ -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>;
-}