@hailer/app-sdk 1.0.1-beta8 → 1.0.2

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/tools/publish.cjs

@@ -42,6 +42,8 @@ if (!process.env.EMAIL && !process.env.LOCAL) {
 (async () => {
     let email = process.env.EMAIL;
     let password = process.env.LOCAL || await (0, minimal_password_prompt_1.default)('enter password for ' + email + ': ');
+    // Market code
+    const market = process.env.MARKET === 'true';
     const appPackageFile = process.argv[2];
     /** Alternatives: `--development` | `--staging` | `--production` */
     const mode = process.argv[3];
@@ -79,6 +81,22 @@ if (!process.env.EMAIL && !process.env.LOCAL) {
         const manifest = JSON.parse((0, fs_1.readFileSync)('./dist/manifest.json').toString());
         const content = (0, fs_1.readFileSync)(appPackageFile);
         const info = await cli.request('v2.core.init', [['network', 'networks', 'apps']], undefined);
+        // Market code
+        if (market) {
+            // Check if version exist in manifest.json. If not, add empty version and let user fill it in
+            if (!manifest.version) {
+                manifest.version = '';
+                manifest.versionDescription = '';
+                // Convert the modified object back to JSON
+                const updatedManifestContent = JSON.stringify(manifest, null, 2);
+                // Write the updated JSON content back to manifest.json
+                (0, fs_1.writeFileSync)('./public/manifest.json', updatedManifestContent, 'utf-8');
+                console.log('');
+                console.log('Please set version & versionDescription in file public/manifest.json! You have added MARKET=true in your publish string.');
+                console.log('');
+                process.exit(10);
+            }
+        }
         const getAppById = (manifestAppId) => {
             for (const appMap of Object.values(info.apps)) {
                 for (const [appId, app] of Object.entries(appMap)) {
@@ -106,6 +124,10 @@ if (!process.env.EMAIL && !process.env.LOCAL) {
         }
         console.log('  Environment:', host);
         console.log();
+        // Market code
+        if (market) {
+            console.log('  Note: Also publishing app to Hailer market');
+        }
         /** Default to publish (yes) */
         const promptOverwriteQuestion = () => {
             return new Promise(resolve => {
@@ -140,20 +162,35 @@ if (!process.env.EMAIL && !process.env.LOCAL) {
                         }
                     },
                     appId: manifest.appId,
+                    // Market code
+                    publishMarket: market.toString(),
                 }
             }, function (error, resp, body) {
                 if (error) {
                     console.log('Publish error uploading file:', error);
                     process.exit(9);
                 }
-                let manifest;
+                let response;
+                let infoMarket = '';
                 try {
-                    manifest = JSON.parse(body);
+                    response = JSON.parse(body);
+                    // Market code
+                    if (response.manifest && response.manifest.versionId) {
+                        infoMarket = 'Note! Use versionId in public/manifest.json file when creating the product in market!';
+                        // Write versionId to manifest.json
+                        manifest.versionId = response.manifest.versionId;
+                        // Convert the modified object back to JSON
+                        const updatedManifestContent = JSON.stringify(manifest, null, 2);
+                        // Write the updated JSON content back to manifest.json
+                        (0, fs_1.writeFileSync)('./public/manifest.json', updatedManifestContent, 'utf-8');
+                    }
                 }
                 catch (error) {
                     // ingore
                 }
-                console.log('App info:', (0, util_1.inspect)(manifest, { depth: 10, colors: true }));
+                console.log('App info:', (0, util_1.inspect)(response, { depth: 10, colors: true }));
+                console.log();
+                console.log(infoMarket);
                 console.log();
                 console.log('Published successfully!');
                 resolve();

package/lib/types.d.ts

@@ -1,4 +1,5 @@
 export interface User {
+    _id: string;
     firstname: string;
     lastname: string;
     email: string;
@@ -6,25 +7,11 @@ export interface User {
     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;
@@ -156,6 +143,7 @@ export interface Workflow {
     enablePredefinedName?: boolean;
     nameFunctionEnabled?: boolean;
     nameEditable?: boolean;
+    productInstalledId: string;
 }
 export interface WorkflowPhase {
     _id: string;
@@ -330,3 +318,49 @@ export interface HailerSignal {
     sig: string;
     meta: any;
 }
+export interface Product extends ProductType {
+    _id: string;
+    versionId: string;
+    name: 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;
+        created: number;
+    }[];
+    cid?: string;
+}
+export interface ProductInstalled {
+    _id: string;
+    productId: string;
+    versionId: string;
+    version: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hailer/app-sdk",
-    "version": "1.0.1-beta8",
+    "version": "1.0.2",
     "description": "SDK for building Hailer Apps",
     "author": "",
     "license": "ISC",

package/lib/modules/team.d.ts

@@ -1,17 +0,0 @@
-import { Client } from '@wishcore/wish-rpc';
-import { TeamMap } from '../types';
-export declare class TeamApi {
-    private client;
-    constructor(client: Client);
-    /**
-     * Lists all Hailer teams from a workspace
-     *
-     *
-     * @returns list of Hailer teams in the workspace the app user is currently in
-     *
-     * @throws {HailerError} if request is incorrect
-     */
-    list(): Promise<{
-        [workspaceId: string]: TeamMap;
-    }>;
-}