@ironcode/vas-lib 0.0.12 → 0.0.14

package/lib/entity/vas-job-data.model.d.ts

@@ -0,0 +1,27 @@
+import { VasAccountObjectModel } from './vas-account-object.model';
+/**
+ * VasJobDataModel
+ */
+export declare abstract class VasJobDataModel extends VasAccountObjectModel {
+    id: string;
+    created: string;
+    serverCreated: string;
+    createdBy: string;
+    modified: string;
+    serverModified: string;
+    modifiedBy: string;
+    account: string;
+    job: string;
+    /**
+     * @param {string} id
+     * @param {string} created
+     * @param {string} serverCreated
+     * @param {string} createdBy
+     * @param {string} modified
+     * @param {string} serverModified
+     * @param {string} modifiedBy
+     * @param {string} account
+     * @param {string} job
+     */
+    constructor(id: string, created: string, serverCreated: string, createdBy: string, modified: string, serverModified: string, modifiedBy: string, account: string, job: string);
+}

package/lib/entity/vas-job.dto.d.ts

@@ -1,12 +1,18 @@
+import { VasFileDto } from './vas-file.dto';
 import { VasRestrictedAccountObjectDto } from './vas-restricted-account-object.dto';
-import { VasFieldDtoValue } from './vas-field.dto';
+import { VasFieldDto, VasFieldDtoValue } from './vas-field.dto';
 export interface VasJobStaticDto extends VasRestrictedAccountObjectDto {
     reference: string;
     jobDate: string;
     jobStatus: string;
     jobType: string;
-    assignee: string;
+    assigneeId: string;
     formId: string;
     timeZoneOffset: number;
+    pendingFields: number;
+    childModified: string;
+    version: number;
+    files: Array<VasFileDto>;
+    fields: Array<VasFieldDto>;
 }
 export declare type VasJobDto = VasJobStaticDto & Record<string, VasFieldDtoValue>;

package/lib/entity/vas-job.model.d.ts

@@ -1,9 +1,10 @@
-import { VasJobDto } from './vas-job.dto';
-import { VasBaseModel } from './vas-base.model';
-import { VasFieldDtoValue } from './vas-field.dto';
-import { VasFormModel } from './vas-form.model';
+import { VasFileDto } from './vas-file.dto';
 import { VasBaseDto } from './vas-base.dto';
-declare interface VasJobModelDynamicInterface {
+import { VasFieldDto, VasFieldDtoValue } from './vas-field.dto';
+import { VasFormModel } from './vas-form.model';
+import { VasJobDto } from './vas-job.dto';
+import { VasRestrictedAccountObjectModel } from './vas-restricted-account-object.model';
+export declare interface VasJobModelDynamicInterface {
     [s: string]: string | number | Record<string, VasFieldDtoValue>;
 }
 export interface ParseSyntaxOptions {
@@ -13,7 +14,7 @@ export interface ParseSyntaxOptions {
 /**
  * JobModel
  */
-export declare class VasJobModel extends VasBaseModel {
+export declare class VasJobModel extends VasRestrictedAccountObjectModel {
     id: string;
     created: string;
     serverCreated: string;
@@ -27,9 +28,14 @@ export declare class VasJobModel extends VasBaseModel {
     jobDate: string;
     jobStatus: string;
     jobType: string;
-    assignee: string;
+    assigneeId: string;
     formId: string;
     timeZoneOffset: number;
+    pendingFields: number;
+    childModified: string;
+    version: number;
+    fields: Array<VasFieldDto>;
+    files: Array<VasFileDto>;
     /**
      * @param {string} id
      * @param {string} created
@@ -44,11 +50,16 @@ export declare class VasJobModel extends VasBaseModel {
      * @param {string} jobDate
      * @param {string} jobStatus
      * @param {string} jobType
-     * @param {string} assignee
+     * @param {string} assigneeId
      * @param {string} formId
      * @param {number} timeZoneOffset
+     * @param {number} pendingFields
+     * @param {string} childModified
+     * @param {number} version
+     * @param {Array<VasFieldDto>} fields
+     * @param {Array<VasFileDto>} files
      */
-    constructor(id: string, created: string, serverCreated: string, createdBy: string, modified: string, serverModified: string, modifiedBy: string, account: string, accessGroup: string, reference: string, jobDate: string, jobStatus: string, jobType: string, assignee: string, formId: string, timeZoneOffset: number);
+    constructor(id: string, created: string, serverCreated: string, createdBy: string, modified: string, serverModified: string, modifiedBy: string, account: string, accessGroup: string, reference: string, jobDate: string, jobStatus: string, jobType: string, assigneeId: string, formId: string, timeZoneOffset: number, pendingFields: number, childModified: string, version: number, fields: Array<VasFieldDto>, files: Array<VasFileDto>);
     /**
      * Returns this with the dynamic interface
      * @return {VasJobModelDynamicInterface}
@@ -87,6 +98,87 @@ export declare class VasJobModel extends VasBaseModel {
      * @return {Record<string, VasFieldDtoValue>}
      */
     getFields2(): Record<string, VasFieldDtoValue>;
+    /**
+     * This method will hydrate the `fields` property of the model. The reason for
+     * this is that we have different ways to store the field data. One way, is
+     * we store them as dynamic properties of the job. For example job.foo.bar,
+     * where `foo` is the name of a Group, and `bar` is the name of a control.
+     * Thus, when we create a job using a form in the client, the job object will
+     * have its static properties (id, account, reference etc), and also a number
+     * of dynamic properties determined by the Groups and Controls. This kind of
+     * object is nice to work with in certain circumstances. However, the api
+     * works differently. In the API a Job is a record, and references a number of
+     * Field records. Each Field stores the value. Comparing these two models we
+     * have:
+     * A) job with dynamic properties, e.g.
+     * {
+     *   id: <guid>,
+     *   reference: "something"
+     *   <other static job properties>...
+     *   foo: {
+     *     bar: "value"
+     *   }
+     * }
+     *
+     * B) job with fields
+     * {
+     *   id: <guid>,
+     *   reference: "something"
+     *   <other static job properties>...
+     *   <will not have dynamic properties>...
+     *   fields: [
+     *     {
+     *       id: <guid>,
+     *       <other field properties>,
+     *       value: "value"
+     *     }
+     *   ]
+     * }
+     *
+     * So, what this method does is given a JobModel in the form of A, read all
+     * of those dynamic properties and set them into `fields`. Doing this requires
+     * knowledge of the Form that was used to create the job. Moreover, since the
+     * dynamic properties do not contain the ids of the fields, we also allow to
+     * pass in a `controlFieldIdMap`. This map stores the mapping between Control
+     * and the Field that was created in the Job to store the value for that
+     * Control. This is useful, if for example you want to compare a Job in form A
+     * with a Job in form B, for example if you want to update the Job on the API
+     * with a Job that was saved by a client in form A.
+     *
+     * E.g.
+     * Client -> API: client requests form
+     * User -> Client: user fills in the form and submits
+     * Client -> Firestore: client saves the Job in form A i.e. dynamic props
+     * Firestore -> Function: A function is triggered to sync the job to the API
+     * Function -> API: Function checks if job already exists, it receives 404
+     * Function -> Function: The function calls `hydrateFields(...)`
+     * Function -> API: The function POST the Job to /jobs
+     * Function -> API: The function POST each field to /fields
+     *
+     * Similarly, if the user updates the job
+     * Client -> API: client requests form
+     * User -> Client: user fills in the form and submits an update
+     * Client -> Firestore: client saves the Job in form A i.e. dynamic props
+     * Firestore -> Function: A function is triggered to sync the job to the API
+     * Function -> API: Function checks if job already exists, it receives 200
+     * Function -> Function: The function calls `hydrateFields(...)` passing in
+     *                       the map is made by iterating over the fields it
+     *                       received from the API and storing the mappings
+     *                       between controlId and fieldId for each field
+     * Function -> API: The function PATCH the Job to /jobs
+     * Function -> API: The function POST/PATCH each field to /fields
+     * treated as new
+     *
+     * @param {VasFormModel} formModel the VasFormModel that was used to create
+     * the job
+     * @param {Map<string, string>} controlFieldIdMap a mapping of control to
+     * field ids. This is used to determine whether a new id for the field should
+     * be generated, or to reuse an existing one from the map.
+     * @param {Array<string>} controlNames if a value is provided, it will be used
+     * to filter the fields that are returned.
+     * @return {Array<VasFieldDto>}
+     */
+    hydrateFields(formModel: VasFormModel, controlFieldIdMap?: Map<string, string>, controlNames?: Array<string>): void;
     /**
   
      * @param {string[]} path path segments
@@ -144,5 +236,8 @@ export declare class VasJobModel extends VasBaseModel {
      * @return {string} the results of parsing the syntax on this job
      */
     parseSyntax(value: string, options?: ParseSyntaxOptions): string;
+    /**
+     * @return {object}
+     */
+    toApiDto(): Record<string, string | number | boolean>;
 }
-export {};

package/lib/entity/vas-report-layout.model.d.ts

@@ -0,0 +1,17 @@
+import { VasRestrictedAccountObjectModel } from './vas-restricted-account-object.model';
+export declare class VasReportLayoutModel extends VasRestrictedAccountObjectModel {
+    id: string;
+    created: string;
+    serverCreated: string;
+    createdBy: string;
+    modified: string;
+    serverModified: string;
+    modifiedBy: string;
+    account: string;
+    accessGroup: string;
+    jobType: string;
+    title: string;
+    description: string;
+    entryPoint: string;
+    constructor(id: string, created: string, serverCreated: string, createdBy: string, modified: string, serverModified: string, modifiedBy: string, account: string, accessGroup: string, jobType: string, title: string, description: string, entryPoint: string);
+}

package/package.json

@@ -1,10 +1,9 @@
 {
   "name": "@ironcode/vas-lib",
-  "version": "0.0.12",
+  "version": "0.0.14",
   "peerDependencies": {
     "angular2-uuid": "^1.1.1",
-    "moment": "^2.0.0",
-    "@types/nodemailer": "^6.4.6"
+    "moment": "^2.0.0"
   },
   "dependencies": {
     "tslib": "^2.3.0"