@coast/service-common 1.0.5 → 1.0.7

package/dist/lib/models/Constants.d.ts

@@ -0,0 +1,4 @@
+export declare const Constants: {
+    LOGGER_OPTIONS: symbol;
+    COAST_API_OPTIONS: symbol;
+};

package/dist/lib/models/Constants.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Constants = void 0;
+exports.Constants = {
+    LOGGER_OPTIONS: Symbol.for('LOGGER_OPTIONS'),
+    COAST_API_OPTIONS: Symbol.for('COAST_API_OPTIONS'),
+};

package/dist/lib/models/coast-api/CoastApiModuleAsyncOptions.d.ts

@@ -0,0 +1,7 @@
+import { InjectionToken, ModuleMetadata, OptionalFactoryDependency } from '@nestjs/common';
+import { CoastApiOptions } from './CoastApiOptions';
+export interface CoastApiModuleAsyncOptions extends Pick<ModuleMetadata, 'imports'> {
+    name?: string;
+    useFactory: (...args: any[]) => CoastApiOptions | Promise<CoastApiOptions>;
+    inject?: Array<InjectionToken | OptionalFactoryDependency>;
+}

package/dist/lib/models/coast-api/CoastApiOptions.d.ts

@@ -0,0 +1,4 @@
+export interface CoastApiOptions {
+    endpoint: string;
+    authToken: string;
+}

package/dist/lib/models/coast-api/CoastApiRequests.d.ts

@@ -0,0 +1,70 @@
+import { SamlUser } from '@coast/core-api-types/auth/SamlUser';
+import { Card } from '@coast/core-api-types/card/Card';
+import { UpdateCard } from '@coast/core-api-types/card/UpdateCard';
+import { Channel } from '@coast/core-api-types/channel/Channel';
+import { ListEntitiesFormData } from '@coast/core-api-types/export/ListEntitiesFormData';
+import { ListEntitiesFormDataResult } from '@coast/core-api-types/export/ListEntitiesFormDataResult';
+import { CreateUserV2 } from '@coast/core-api-types/user/CreateUserV2';
+import { UpdateUser } from '@coast/core-api-types/user/UpdateUser';
+import { User } from '@coast/core-api-types/user/User';
+import { CreateWorkflowAutomationEvent } from '@coast/core-api-types/workflow-automation/CreateWorkflowAutomationEvent';
+import { AggregateNumberStats } from '@coast/core-api-types/workflow-template/entities/AggregateNumberStats';
+import { AggregateRelatedCardQuantity } from '@coast/core-api-types/workflow-template/entities/AggregateRelatedCardQuantity';
+import { CreateEntityAuditTrailEvent } from '@coast/core-api-types/workflow-template/entities/audit-trail/CreateEntityAuditTrailEvent';
+import { EntityAuditTrailEvent } from '@coast/core-api-types/workflow-template/entities/audit-trail/EntityAuditTrailEvent';
+import { CreateWorkflowEntity } from '@coast/core-api-types/workflow-template/entities/CreateWorkflowEntity';
+import { GetWorkflowEntityResult } from '@coast/core-api-types/workflow-template/entities/GetWorkflowEntityResult';
+import { UpdateWorkflowEntity } from '@coast/core-api-types/workflow-template/entities/UpdateWorkflowEntity';
+import { UpdateWorkflowTemplate } from '@coast/core-api-types/workflow-template/UpdateWorkflowTemplate';
+import { WorkflowTemplate } from '@coast/core-api-types/workflow-template/WorkflowTemplate';
+import { GqlRequestBody } from '../../modules/utils/graphql/GqlRequestBody';
+export declare class CoastApiRequests {
+    static aggregateRelatedCardQuantityStats(filter: AggregateRelatedCardQuantity): GqlRequestBody<AggregateRelatedCardQuantity, {
+        aggregateRelatedCardQuantityStats: AggregateNumberStats;
+    }>;
+    static createEntityAuditTrailEvent(createEntityAuditTrailEvent: CreateEntityAuditTrailEvent): GqlRequestBody<CreateEntityAuditTrailEvent, {
+        createEntityAuditTrailEvent: EntityAuditTrailEvent;
+    }>;
+    static createUsers(createUsers: CreateUserV2[]): GqlRequestBody<CreateUserV2[], {
+        createUserV2: User[];
+    }>;
+    static createWorkflowAutomationEvent(createWorkflowAutomationEvent: CreateWorkflowAutomationEvent): GqlRequestBody<CreateWorkflowAutomationEvent, {
+        createWorkflowAutomationEvent: boolean;
+    }>;
+    static createWorkflowEntity(createWorkflowEntity: CreateWorkflowEntity): GqlRequestBody<CreateWorkflowEntity, {
+        createWorkflowEntity: GetWorkflowEntityResult;
+    }>;
+    static getCard(cardId: string): GqlRequestBody<string, {
+        getCard: Card;
+    }>;
+    static getChannel(channelId: number): GqlRequestBody<number, {
+        getChannel: Channel;
+    }>;
+    static getSamlUser(email: string, samlOrganizationId: string): GqlRequestBody<{
+        email: string;
+        samlOrganizationId: string;
+    }, {
+        getSamlUser: SamlUser;
+    }>;
+    static getWorkflowEntity(workflowEntityId: string): GqlRequestBody<string, {
+        getWorkflowEntity: GetWorkflowEntityResult;
+    }>;
+    static getWorkflowTemplate(workflowTemplateId: string): GqlRequestBody<string, {
+        getWorkflowTemplate: WorkflowTemplate;
+    }>;
+    static listWorkflowEntitiesFormData(filter: ListEntitiesFormData): GqlRequestBody<ListEntitiesFormData, {
+        listEntitiesFormData: ListEntitiesFormDataResult;
+    }>;
+    static updateCard(card: UpdateCard): GqlRequestBody<UpdateCard, {
+        updateCard: Card;
+    }>;
+    static updateUser(updateUser: UpdateUser): GqlRequestBody<UpdateUser, {
+        updateUserV2: User;
+    }>;
+    static updateWorkflowEntity(updateWorkflowEntity: UpdateWorkflowEntity): GqlRequestBody<UpdateWorkflowEntity, {
+        updateWorkflowEntity: GetWorkflowEntityResult;
+    }>;
+    static updateWorkflowTemplate(updateWorkflowTemplate: UpdateWorkflowTemplate): GqlRequestBody<UpdateWorkflowTemplate, {
+        updateWorkflowTemplate: WorkflowTemplate;
+    }>;
+}

package/dist/lib/models/coast-api/CoastApiRequests.js

@@ -0,0 +1,254 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CoastApiRequests = void 0;
+const WorkflowEntityGqlFields_1 = require("./WorkflowEntityGqlFields");
+const WorkflowTemplateGqlFields_1 = require("./WorkflowTemplateGqlFields");
+class CoastApiRequests {
+    static aggregateRelatedCardQuantityStats(filter) {
+        return {
+            query: `
+                query ($input: AggregateRelatedCardQuantity!) {
+                    aggregateRelatedCardQuantityStats(input: $input)
+                }
+            `,
+            variables: { input: filter },
+        };
+    }
+    static createEntityAuditTrailEvent(createEntityAuditTrailEvent) {
+        return {
+            query: `
+                mutation ($input: CreateEntityAuditTrailEvent!) {
+                    createEntityAuditTrailEvent(input: $input) { id }
+                }
+            `,
+            variables: { input: createEntityAuditTrailEvent },
+        };
+    }
+    static createUsers(createUsers) {
+        return {
+            query: `
+                mutation ($input: [CreateUserV2!]!) {
+                    createUsersV2(input: $input) {
+                        id
+                        firstName
+                        lastName
+                        email
+                        phoneNumber
+                        role
+                        createdAt
+                        updatedAt
+                    }
+                }
+            `,
+            variables: { input: createUsers },
+        };
+    }
+    static createWorkflowAutomationEvent(createWorkflowAutomationEvent) {
+        return {
+            query: `
+                mutation ($input: CreateWorkflowAutomationEvent!) {
+                    createWorkflowAutomationEvent(input: $input)
+                }
+            `,
+            variables: { input: createWorkflowAutomationEvent },
+        };
+    }
+    static createWorkflowEntity(createWorkflowEntity) {
+        return {
+            query: `
+                mutation ($input: CreateWorkflowEntity!) {
+                    createWorkflowEntity(input: $input) {
+                        entity {
+                            id
+                            workflowTemplateId
+                            fields
+                        }
+                        refs {
+                            workflowEntityRefs {
+                                id
+                            }
+                            personRefs {
+                                id
+                            }
+                            workflowTemplateRefs {
+                                id
+                            }
+                        }
+                    }
+                }
+            `,
+            variables: { input: createWorkflowEntity },
+        };
+    }
+    static getCard(cardId) {
+        return {
+            query: `
+                query ($id: UUID!) {
+                    getCard(id: $id) {
+                        id
+                        fields
+                    }
+                }
+            `,
+            variables: { id: cardId },
+        };
+    }
+    static getChannel(channelId) {
+        return {
+            query: `
+                query ($id: Int!) {
+                    getChannel(id: $id) {
+                        id
+                        name
+                        slug
+                    }
+                }
+            `,
+            variables: { id: channelId },
+        };
+    }
+    static getSamlUser(email, samlOrganizationId) {
+        return {
+            query: `
+                query ($input: GetSamlUser!) {
+                    getSamlUser(input: $input) {
+                        id
+                        email
+                        businessId
+                    }
+                }
+            `,
+            variables: { input: { email, samlOrganizationId } },
+        };
+    }
+    static getWorkflowEntity(workflowEntityId) {
+        return {
+            query: `
+                query ($id: UUID!) {
+                    getWorkflowEntity(id: $id) {
+                        ${WorkflowEntityGqlFields_1.WorkflowEntityGqlFields.fields}
+                    }
+                }
+            `,
+            variables: { id: workflowEntityId },
+        };
+    }
+    static getWorkflowTemplate(workflowTemplateId) {
+        return {
+            query: `
+                query ($id: UUID!) {
+                    getWorkflowTemplate(id: $id) {
+                        components {
+                            ${WorkflowTemplateGqlFields_1.WorkflowTemplateGqlFields.componentFields}
+                        }
+                    }
+                }
+            `,
+            variables: { id: workflowTemplateId },
+        };
+    }
+    static listWorkflowEntitiesFormData(filter) {
+        return {
+            query: `
+                query ($input: ListEntitiesFormData!) {
+                    listEntitiesFormData(input: $input) {
+                        hasMore 
+                        totalResults 
+                        exports { 
+                            type 
+                            title 
+                            targetFormat 
+                            data {
+                                ... on ComponentDataExport {
+                                    label 
+                                    value 
+                                    imageUrls 
+                                    type
+                                }
+                                ... on SubformDataExport {
+                                    type
+                                    title
+                                    businessName
+                                    data {
+                                        ... on ComponentDataExport {
+                                            label 
+                                            value 
+                                            imageUrls 
+                                            type
+                                        }
+                                    }
+                                }
+                            } 
+                            businessName 
+                            url 
+                        } 
+                    }
+                }
+            `,
+            variables: { input: filter },
+        };
+    }
+    static updateCard(card) {
+        return {
+            query: `
+                mutation ($input: UpdateCard!) {
+                    updateCard(input: $input) {
+                        id
+                    }
+                }
+            `,
+            variables: { input: card },
+        };
+    }
+    static updateUser(updateUser) {
+        return {
+            query: `
+                mutation ($input: UpdateUser!) {
+                    updateUserV2(input: $input) {
+                        id
+                    }
+                }
+            `,
+            variables: { input: updateUser },
+        };
+    }
+    static updateWorkflowEntity(updateWorkflowEntity) {
+        return {
+            query: `
+                mutation ($input: UpdateWorkflowEntity!) {
+                    updateWorkflowEntity(input: $input) {
+                        entity {
+                            id
+                            fields
+                        }
+                        refs {
+                            workflowEntityRefs {
+                                id
+                            }
+                            personRefs {
+                                id
+                            }
+                            workflowTemplateRefs {
+                                id
+                            }
+                        }
+                    }
+                }
+            `,
+            variables: { input: updateWorkflowEntity },
+        };
+    }
+    static updateWorkflowTemplate(updateWorkflowTemplate) {
+        return {
+            query: `
+                mutation ($input: UpdateWorkflowTemplate!) {
+                    updateWorkflowTemplate(input: $input) {
+                        id
+                    }
+                }
+            `,
+            variables: { input: updateWorkflowTemplate },
+        };
+    }
+}
+exports.CoastApiRequests = CoastApiRequests;

package/dist/lib/models/coast-api/WorkflowEntityGqlFields.d.ts

@@ -0,0 +1,3 @@
+export declare const WorkflowEntityGqlFields: {
+    fields: string;
+};

package/dist/lib/models/coast-api/WorkflowEntityGqlFields.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkflowEntityGqlFields = void 0;
+const WorkflowTemplateGqlFields_1 = require("./WorkflowTemplateGqlFields");
+exports.WorkflowEntityGqlFields = {
+    fields: `
+        entity { id workflowTemplateId fields }
+        refs {
+            workflowEntityRefs { id workflowTemplateId fields }
+            personRefs { id }
+            workflowTemplateRefs { id components { ${WorkflowTemplateGqlFields_1.WorkflowTemplateGqlFields.componentFields} } }
+        }
+    `,
+};

package/dist/lib/models/coast-api/WorkflowTemplateGqlFields.d.ts

@@ -0,0 +1,3 @@
+export declare const WorkflowTemplateGqlFields: {
+    componentFields: string;
+};

package/dist/lib/models/coast-api/WorkflowTemplateGqlFields.js

@@ -0,0 +1,129 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkflowTemplateGqlFields = void 0;
+const inputComponentFields = [
+    'id',
+    'type',
+    'label',
+    'placeholder',
+    'readonly',
+    'required',
+    'isFilterable',
+    'isSortable',
+    'isServerManaged',
+];
+exports.WorkflowTemplateGqlFields = {
+    componentFields: `
+        ... on AddressComponent {
+            ${inputComponentFields.join(' ')}
+        }
+        ... on AuditCheckboxComponent {
+            ${inputComponentFields.join(' ')}
+        }
+        ... on AuditTagComponent {
+            ${inputComponentFields.join(' ')}
+            multiselect
+            options { label value archived }
+        }
+        ... on AuditTextComponent {
+            ${inputComponentFields.join(' ')}
+            maxlength
+            multiline
+        }
+        ... on CombinedTagsComponent {
+            id
+            type
+            label
+            icon
+            locked
+            isServerManaged
+            componentIds
+        }
+        ... on DateComponent {
+            ${inputComponentFields.join(' ')}
+        }
+        ... on EmailComponent {
+            ${inputComponentFields.join(' ')}
+            default { value }
+        }
+        ... on FileComponent {
+            ${inputComponentFields.join(' ')}
+            acceptedContentTypes
+        }
+        ... on GeolocationComponent {
+            ${inputComponentFields.join(' ')}
+        }
+        ... on InputButtonComponent {
+            id
+            type
+            locked
+            isServerManaged
+            buttonText
+            inputComponentId
+          }
+        ... on NumberComponent {
+            ${inputComponentFields.join(' ')}
+            format
+        }
+        ... on PersonComponent {
+            ${inputComponentFields.join(' ')}
+            default { token userIds }
+        }
+        ... on RelatedCardComponent {
+            ${inputComponentFields.join(' ')}
+            workflowTemplateId
+            default { cardIds }
+            listDefault {
+                sortByComponents { componentId direction }
+                filterByComponents {
+                    componentId
+                    value {
+                        containsCurrentUser { value }
+                        containsNumber { values }
+                        containsString { values }
+                        dateRange { before after }
+                        dateTokenIs { value }
+                        isEmpty { value }
+                        numberIs { value }
+                        stringWildcard { value }
+                    }
+                }
+                omniSearchQuery
+                limit
+                offset
+            }
+        }
+        ... on RelatedCardLookupComponent {
+            ${inputComponentFields.join(' ')}
+            relatedCardComponentId
+            lookupWorkflowTemplateId
+            lookupComponentId
+        }
+        ... on SignatureComponent {
+            ${inputComponentFields.join(' ')}
+        }
+        ... on StaticTextComponent {
+            id type text
+        }
+        ... on SubformComponent {
+            ${inputComponentFields.join(' ')}
+            workflowTemplateIds
+            default { workflowTemplateId }
+        }
+        ... on TagComponent {
+            ${inputComponentFields.join(' ')}
+            multiselect
+            options { label value archived }
+            default { value }
+        }
+        ... on TextComponent {
+            ${inputComponentFields.join(' ')}
+            maxlength
+            multiline
+            default { text }
+        }
+        ... on TodoComponent {
+            ${inputComponentFields.join(' ')}
+        }
+        `,
+};

package/dist/lib/models/logger/LogLevel.d.ts

@@ -0,0 +1,8 @@
+export declare enum LogLevel {
+    DEBUG = "debug",
+    ERROR = "error",
+    FATAL = "fatal",
+    INFO = "info",
+    SILENT = "silent",
+    WARN = "warn"
+}

package/dist/lib/models/logger/LogLevel.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LogLevel = void 0;
+var LogLevel;
+(function (LogLevel) {
+    LogLevel["DEBUG"] = "debug";
+    LogLevel["ERROR"] = "error";
+    LogLevel["FATAL"] = "fatal";
+    LogLevel["INFO"] = "info";
+    LogLevel["SILENT"] = "silent";
+    LogLevel["WARN"] = "warn";
+})(LogLevel || (exports.LogLevel = LogLevel = {}));

package/dist/lib/models/logger/LoggerModuleAsyncOptions.d.ts

@@ -0,0 +1,7 @@
+import { InjectionToken, ModuleMetadata, OptionalFactoryDependency } from '@nestjs/common';
+import { LoggerOptions } from './LoggerOptions';
+export interface LoggerModuleAsyncOptions extends Pick<ModuleMetadata, 'imports'> {
+    name?: string;
+    useFactory: (...args: any[]) => LoggerOptions | Promise<LoggerOptions>;
+    inject?: Array<InjectionToken | OptionalFactoryDependency>;
+}

package/dist/lib/models/logger/LoggerModuleAsyncOptions.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/lib/models/logger/LoggerOptions.d.ts

@@ -0,0 +1,5 @@
+import { LogLevel } from './LogLevel';
+export interface LoggerOptions {
+    level?: LogLevel;
+    pretty?: boolean;
+}

package/dist/lib/models/logger/LoggerOptions.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/lib/modules/coast-api/CoastApiClient.d.ts

@@ -0,0 +1,46 @@
+import { SamlUser } from '@coast/core-api-types/auth/SamlUser';
+import { AutomationId } from '@coast/core-api-types/automations/AutomationId';
+import { BusinessId } from '@coast/core-api-types/business/BusinessId';
+import { Card } from '@coast/core-api-types/card/Card';
+import { UpdateCard } from '@coast/core-api-types/card/UpdateCard';
+import { Channel } from '@coast/core-api-types/channel/Channel';
+import { ListEntitiesFormData } from '@coast/core-api-types/export/ListEntitiesFormData';
+import { ListEntitiesFormDataResult } from '@coast/core-api-types/export/ListEntitiesFormDataResult';
+import { FileDetails } from '@coast/core-api-types/file-upload/FileDetails';
+import { CreateUserV2 } from '@coast/core-api-types/user/CreateUserV2';
+import { UpdateUser } from '@coast/core-api-types/user/UpdateUser';
+import { User } from '@coast/core-api-types/user/User';
+import { CreateWorkflowAutomationEvent } from '@coast/core-api-types/workflow-automation/CreateWorkflowAutomationEvent';
+import { AggregateNumberStats } from '@coast/core-api-types/workflow-template/entities/AggregateNumberStats';
+import { AggregateRelatedCardQuantity } from '@coast/core-api-types/workflow-template/entities/AggregateRelatedCardQuantity';
+import { CreateEntityAuditTrailEvent } from '@coast/core-api-types/workflow-template/entities/audit-trail/CreateEntityAuditTrailEvent';
+import { EntityAuditTrailEvent } from '@coast/core-api-types/workflow-template/entities/audit-trail/EntityAuditTrailEvent';
+import { CreateWorkflowEntity } from '@coast/core-api-types/workflow-template/entities/CreateWorkflowEntity';
+import { GetWorkflowEntityResult } from '@coast/core-api-types/workflow-template/entities/GetWorkflowEntityResult';
+import { UpdateWorkflowEntity } from '@coast/core-api-types/workflow-template/entities/UpdateWorkflowEntity';
+import { UpdateWorkflowTemplate } from '@coast/core-api-types/workflow-template/UpdateWorkflowTemplate';
+import { WorkflowTemplate } from '@coast/core-api-types/workflow-template/WorkflowTemplate';
+import { CoastApiOptions } from '../../models/coast-api/CoastApiOptions';
+import { CoastLogger } from '../logger/CoastLogger';
+export declare class CoastApiClient {
+    private readonly logger;
+    private readonly options;
+    constructor(logger: CoastLogger, options: CoastApiOptions);
+    aggregateRelatedCardQuantityStats(businessId: BusinessId, aggregate: AggregateRelatedCardQuantity): Promise<AggregateNumberStats>;
+    createEntityAuditTrailEvent(businessId: BusinessId, createEntityAuditTrailEvent: CreateEntityAuditTrailEvent): Promise<EntityAuditTrailEvent>;
+    createUsers(createUsers: CreateUserV2[], businessId: BusinessId): Promise<User[] | undefined>;
+    createWorkflowAutomationEvent(businessId: BusinessId, createWorkflowAutomationEvent: CreateWorkflowAutomationEvent): Promise<boolean>;
+    createWorkflowEntity(businessId: BusinessId, sourceAutomationId: AutomationId, createWorkflowEntity: CreateWorkflowEntity): Promise<GetWorkflowEntityResult>;
+    getCard(businessId: BusinessId, cardId: string): Promise<Card | null>;
+    getChannel(businessId: BusinessId, channelId: number): Promise<Channel>;
+    getFileDetails(): Promise<FileDetails>;
+    getSamlUser(businessId: BusinessId, email: string, samlOrganizationId: string): Promise<SamlUser>;
+    getWorkflowEntity(businessId: BusinessId, id: string): Promise<GetWorkflowEntityResult>;
+    getWorkflowTemplate(businessId: BusinessId, workflowTemplateId: string): Promise<WorkflowTemplate>;
+    listWorkflowEntitiesFormData(businessId: BusinessId, filter: ListEntitiesFormData): Promise<ListEntitiesFormDataResult>;
+    updateCard(businessId: BusinessId, updateCard: UpdateCard): Promise<Card>;
+    updateUser(businessId: BusinessId, updateUser: UpdateUser): Promise<User>;
+    updateWorkflowEntity(businessId: BusinessId, sourceAutomationId: AutomationId, updateWorkflowEntity: UpdateWorkflowEntity): Promise<GetWorkflowEntityResult>;
+    updateWorkflowTemplate(businessId: BusinessId, updateWorkflowTemplate: UpdateWorkflowTemplate): Promise<WorkflowTemplate>;
+    private execute;
+}