@hailer/app-sdk 2.0.0-beta-15 → 2.0.0-beta-17

package/lib/src/types.d.ts

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

@@ -7,6 +7,13 @@ export interface Workspace {
     _id: string;
     name: string;
 }
+export interface Team {
+    _id: string;
+    name: string;
+}
+export interface TeamsByWorkspace {
+    [workspaceId: string]: Team[];
+}
 export interface ActivityFieldRange {
     start: number;
     end: number;
@@ -151,6 +158,11 @@ export interface WorkflowField {
         [key: string]: any;
     };
 }
+export interface DocumentTemplate {
+    templateId?: string;
+    name: string;
+    order?: number;
+}
 export interface Workflow {
     _id: string;
     name: string;
@@ -168,6 +180,7 @@ export interface Workflow {
     nameEditable?: boolean;
     productInstalledId: string;
     workspaceId: string;
+    documentTemplates?: DocumentTemplate[];
 }
 export interface WorkflowPhase {
     _id: string;
@@ -373,6 +386,21 @@ export interface ActivityKanbanListOptions {
     includeUsers?: boolean;
     includeTeams?: boolean;
 }
+export interface PrintRequest {
+    activityId: string;
+    /** Template ID for regular templates */
+    templateId?: string;
+    /** Template name for multi-pdf templates (when templateId is empty) */
+    templateName?: string;
+    /** Whether to save the PDF to the file system */
+    savePdf?: boolean;
+}
+export interface PrintResponse {
+    filename: string;
+    /** Base64-encoded document data */
+    data: string;
+    mimeType: string;
+}
 export interface Settings {
     theme: 'light' | 'dark';
     preferredLanguages: string[];
@@ -1035,4 +1063,77 @@ export interface StripeTaxCalculationResponse {
     currency: string;
     lineItems: StripeTaxLineItemResult[];
 }
+export interface AdminReferralCode {
+    _id: string;
+    code: string;
+    uid: string;
+    cid: string;
+    ownerEmail?: string;
+    workspaceName?: string;
+    bonusTokens: number;
+    isActive: boolean;
+    totalReferrals: number;
+    totalTokensAwarded: number;
+    created: number;
+}
+export interface AdminReferralCodeListRequest {
+    filter?: {
+        isActive?: boolean;
+        cid?: string;
+    };
+    options?: {
+        search?: string;
+        limit?: number;
+        skip?: number;
+        sortBy?: string;
+        sortOrder?: 'asc' | 'desc';
+    };
+}
+export interface AdminReferralCodeListResponse {
+    codes: AdminReferralCode[];
+    totalCount: number;
+    stats: {
+        activeCount: number;
+        totalReferrals: number;
+        totalTokensAwarded: number;
+    };
+}
+export interface AdminReferralEvent {
+    _id: string;
+    referralCodeId: string;
+    referralCode: string;
+    referrerUid: string;
+    referrerCid: string;
+    refereeUid: string;
+    refereeCid: string;
+    refereeEmail?: string;
+    refereeWorkspaceName?: string;
+    status: 'pending' | 'completed' | 'failed';
+    bonusTokensAwarded: number;
+    failureReason?: string;
+    created: number;
+    completedAt?: number;
+}
+export interface AdminReferralEventListRequest {
+    filter?: {
+        referralCodeId?: string;
+        referrerCid?: string;
+        status?: 'pending' | 'completed' | 'failed';
+    };
+    options?: {
+        limit?: number;
+        skip?: number;
+        sortBy?: string;
+        sortOrder?: 'asc' | 'desc';
+    };
+}
+export interface AdminReferralEventListResponse {
+    events: AdminReferralEvent[];
+    totalCount: number;
+    stats: {
+        completedCount: number;
+        pendingCount: number;
+        totalTokensAwarded: number;
+    };
+}
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hailer/app-sdk",
-    "version": "2.0.0-beta-15",
+    "version": "2.0.0-beta-17",
     "description": "SDK for building Hailer Apps",
     "author": "",
     "license": "ISC",

package/lib/tools/minimal-password-prompt.d.ts

@@ -1 +0,0 @@
-export declare const prompt: (question: string, ctrlcExits?: boolean) => Promise<string>;

package/lib/tools/minimal-password-prompt.js

@@ -1,50 +0,0 @@
-"use strict";
-// Re-written to TypeScript to fix typing issue, see: https://www.npmjs.com/package/minimal-password-prompt/v/1.1.0
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.prompt = void 0;
-const stdin = process.stdin;
-const stdout = process.stdout;
-const captureStdin = (onData) => {
-    stdin.setEncoding('utf-8');
-    stdin.setRawMode(true);
-    stdin.on('data', onData);
-    stdin.resume();
-};
-const releaseStdin = (onData) => {
-    stdin.pause();
-    stdin.removeListener('data', onData);
-    stdin.setRawMode(false);
-    stdout.write('\n');
-};
-const prompt = (question, ctrlcExits = true) => (new Promise((resolve, reject) => {
-    let input = '';
-    const onData = (data) => {
-        switch (data) {
-            case '\u000A': // \n
-            case '\u000D': // \r
-            case '\u0004': // Ctrl+D
-                releaseStdin(onData);
-                resolve(input);
-                break;
-            case '\u0003': // Ctrl+C
-                releaseStdin(onData);
-                if (ctrlcExits) { // exit or raise error
-                    process.exit();
-                }
-                else {
-                    reject(new Error('Ctrl+C'));
-                }
-                break;
-            case '\u0008': // Backspace
-            case '\u007F': // Delete
-                input = input.slice(0, -1);
-                break;
-            default: // any other
-                input += data;
-        }
-        ;
-    };
-    captureStdin(onData);
-    stdout.write(question);
-}));
-exports.prompt = prompt;