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

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

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

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

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

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

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

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

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

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

package/lib/src/types.d.ts

@@ -1,381 +0,0 @@
-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;
-    members: string[];
-    settings: {
-        isolatedTeams?: boolean;
-        defaultView: string;
-        functionFieldVersion?: 1 | 2;
-        color?: string;
-        allowPublicCopy?: boolean;
-    };
-    license: object;
-    invoicing?: any;
-    propertyFields?: {
-        [section: string]: {
-            [field: string]: any;
-        };
-    };
-}
-export interface Activity {
-    _id: string;
-    process: string;
-    teamAccount: TeamAccount;
-    created: number;
-    uid: string;
-    cid: string;
-    discussion: string;
-    currentPhase: string;
-    active?: boolean;
-    history?: any[];
-    name?: string;
-    followers?: string[];
-    completePhases?: string[];
-    location?: {
-        type: 'point' | 'area' | 'polyline';
-        label: string | null;
-        data: {
-            lat: number;
-            lng: number;
-        }[];
-    };
-    fields?: any;
-    files?: any[];
-    updated?: number;
-    updatedBy?: string;
-    priority?: number;
-    sequence?: number;
-}
-export interface TeamAccount {
-    account: string;
-    team: string;
-}
-export interface FormsData {
-    files: string[];
-    history: {
-        0: {
-            [fieldId: string]: {
-                value: any;
-            };
-        };
-    };
-    name: string;
-    location?: boolean;
-    uid?: string;
-}
-export interface FormsResponse {
-    name: string;
-    description?: string;
-    enableUnlinkedMode: boolean;
-    enableAttachments: boolean;
-    enableMapLocation: boolean;
-    locationRequired: 1;
-    phases: {
-        _id: string;
-        followers: [];
-        name: string;
-        description: string;
-        uid: string;
-        created: number;
-        fields: string[];
-        announcementFields: [];
-        announcementRecipients: [];
-        announcementFieldsOrder: [];
-        isEndpoint: boolean;
-    }[];
-    phasesOrder: string[];
-    fields: {
-        [id: string]: {
-            data: [];
-            label: string;
-            required: boolean;
-            type: string;
-            inviteToDiscussionOnChange: boolean;
-            _id: string;
-            created: number;
-            updated: number;
-            uid: string;
-            functionEnabled: boolean;
-        };
-    };
-    enableMessenger: boolean;
-    publicForm: {
-        enableMessaging: boolean;
-    };
-    fieldsOrder: [];
-}
-export interface FormCreateResponse {
-    key: string;
-    creator: string;
-    followers: string;
-    active: boolean;
-    enableMessaging: boolean;
-    allowRead: boolean;
-}
-export interface InsightResponse {
-    insight: {
-        name: string;
-    };
-    data: InsightResponseData;
-}
-export interface InsightResponseData {
-    headers: string[];
-    rows: [];
-    time: number;
-}
-export interface HailerAppConfig {
-    fields?: {
-        [fieldName: string]: {
-            type: string;
-            value?: string | number | boolean;
-        };
-    };
-}
-export type HailerProcess = Workflow;
-export interface Workflow {
-    _id: string;
-    cid: string;
-    name: string;
-    description?: string;
-    fields: {
-        [fieldId: string]: any;
-    };
-    phases: {
-        [phase_id: string]: WorkflowPhase;
-    };
-    phasesOrder: string[];
-    enablePredefinedName?: boolean;
-    nameFunctionEnabled?: boolean;
-    nameEditable?: boolean;
-    productInstalledId: string;
-}
-export interface WorkflowPhase {
-    _id: string;
-    name: string;
-    description?: string;
-    fields?: string[];
-}
-export type PermissionType = 'admin' | 'own' | 'ownteam' | 'any' | 'edit';
-export interface Member {
-    id: string;
-    info: {
-        [key: string]: string | number | boolean | null;
-    };
-    permissions: PermissionType[];
-}
-export interface InsightWorkflowSource {
-    name: string;
-    workflowId: string;
-    fields: {
-        name: string;
-        fieldId?: string;
-        /** Used for phaseLastMove meta */
-        phaseId?: string;
-        /** Activity information, like _id, created, phaseId etc. */
-        meta?: string;
-    }[];
-}
-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;
-    }[];
-}
-export type InsightPublic = Omit<InsightDoc, '_id'>;
-export interface InsightData {
-    headers: string[];
-    rows: (string | number | null)[][];
-    time: number;
-}
-export interface InsightResponseAsObjectItem {
-    [key: string]: any;
-}
-export type InsightResponseAsObjects = InsightResponseAsObjectItem[];
-export interface KanbanListResponse {
-    map: {
-        [phaseId: string]: {
-            activities: {
-                _id: string;
-                followers: string[];
-                name: string;
-                fields: {
-                    [key: string]: any;
-                };
-                files: string[];
-                primaryDateField: number;
-                priority: number;
-            }[];
-            meta: {
-                count: number;
-                totalPrimaryNumericValue: number;
-                primaryNumericFieldUnit: string | null;
-            };
-        };
-    };
-}
-export interface KanbanLoadResponse {
-    activity: {
-        _id: string;
-        followers: string[];
-        name: string;
-        fields: {
-            [key: string]: any;
-        };
-        files: string[];
-        primaryDateField: number | null;
-        priority: number;
-        linkedFromCount: number;
-    };
-    process: string;
-    phase: string;
-}
-export interface ActivityListOptions {
-    sortBy?: 'name' | 'created' | 'updated' | 'following' | 'owner' | 'team' | 'completedOn' | 'priority';
-    sortOrder?: 'asc' | 'desc';
-    limit?: number;
-    skip?: number;
-    includeUsers?: boolean;
-    includeTeams?: boolean;
-    includeHistory?: boolean;
-    filters?: any;
-}
-export interface ActivityCreateOptions {
-    teamId?: string;
-    fileIds?: string[];
-    followerIds?: string[];
-    location?: {
-        label?: string;
-        type: 'area' | 'point' | 'polyline';
-        data: [{
-            lat: number;
-            lng: number;
-        }];
-    };
-    discussionId?: string;
-    phaseId?: string;
-    returnDocument?: boolean;
-}
-export interface ActivityKanbanListOptions {
-    filter: {
-        user?: {
-            uid: string;
-            field: string;
-        };
-        account?: string;
-        team?: string;
-        dates?: {
-            field: string;
-            start: number;
-            end: number;
-        };
-    };
-    search?: string;
-    limit?: number;
-    skip?: number;
-    phase?: string;
-    includeUsers?: boolean;
-    includeTeams?: boolean;
-}
-export interface HailerSettings {
-    theme: 'light' | 'dark';
-    preferredLanguages: string[];
-}
-export interface HailerError {
-    code: number;
-    msg: string;
-    debug: object;
-}
-export interface HailerApiInfo {
-    /** Url of the Hailer instance hosting the API */
-    hostUrl?: string;
-    config?: HailerAppConfig;
-    outside: boolean | null;
-    workspaceId?: string;
-}
-export declare class HailerError extends Error {
-    code: number;
-    msg: string;
-    debug: object;
-    constructor(error: {
-        code: number;
-        msg: string;
-        debug: object;
-    });
-}
-export interface HailerSignal {
-    sig: string;
-    meta: any;
-}
-export interface Product extends ProductType {
-    _id: string;
-    versionId: string;
-    name: string;
-    header?: string;
-    description?: string;
-    icon?: string;
-    images?: string[];
-    externalUrl?: string;
-    publisher?: string;
-    /** Available or not in app store  */
-    public?: boolean;
-    cid?: string;
-}
-export interface ProductSearchOption {
-    limit?: number;
-    skip?: number;
-    search?: string;
-    reverse?: boolean;
-    sortBy?: 'name' | 'created' | 'updated' | 'type';
-    sortOrder?: 'asc' | 'desc';
-}
-export interface ProductSearchFilter extends ProductType {
-    public?: boolean;
-    cid?: string;
-    uid?: string;
-}
-export interface ProductType {
-    type?: 'app' | 'template' | 'document-template';
-}
-export interface ProductVersion {
-    _id: string;
-    name: string;
-    versions?: {
-        version: string;
-        description: string;
-        packageHash: string;
-    }[];
-    cid?: string;
-}
-export interface ProductInstalled {
-    _id: string;
-    productId: string;
-    versionId: string;
-    version: string;
-}

package/lib/tools/publish.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/tools/replace-private.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/tools/replace-private.js

@@ -1,33 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const fs_1 = require("fs");
-const path_1 = require("path");
-const srcFolder = (0, path_1.join)(__dirname, '../src');
-const publicSrcFolder = (0, path_1.join)(__dirname, '../public-src');
-const replacePrivateComments = (fileContent) => {
-    // Replaces all occurences of /* @ private */ with private
-    return fileContent.replace(/\/\* @private \*\//g, 'private');
-};
-const copyAndReplaceFiles = (src, dest) => {
-    (0, fs_1.mkdirSync)(dest, { recursive: true });
-    console.log('Created folder: ', dest);
-    (0, fs_1.readdirSync)(src).forEach((file) => {
-        const srcFile = (0, path_1.join)(src, file);
-        const destFile = (0, path_1.join)(dest, file);
-        if ((0, fs_1.lstatSync)(srcFile).isDirectory()) {
-            copyAndReplaceFiles(srcFile, destFile);
-        }
-        else if (srcFile.endsWith('.ts')) {
-            const updatedContent = replacePrivateComments((0, fs_1.readFileSync)(srcFile, 'utf8'));
-            (0, fs_1.writeFileSync)(destFile, updatedContent, 'utf8');
-        }
-        else {
-            (0, fs_1.copyFileSync)(srcFile, destFile);
-        }
-    });
-};
-if ((0, fs_1.existsSync)(publicSrcFolder)) {
-    (0, fs_1.rmdirSync)(publicSrcFolder, { recursive: true });
-}
-copyAndReplaceFiles(srcFolder, publicSrcFolder);
-console.log('Public source files generated in /public-src/');