@tudopz/model 2.21.6 → 2.22.0

package/README.md

@@ -2,6 +2,10 @@
 
 ## Changelogs
 
+### v2.22.0
+
+- Add `LeadForm` and `LeadFormField`
+
 ### v2.21.5
 
 - Remove `No Preference` from university preference consts

package/lib/constant/lead-form.d.ts

@@ -0,0 +1,3 @@
+export declare const LEAD_FORM_ASSIGNMENT_VALUES: string[];
+export declare const LEAD_FORM_FIELD_TYPE_VALUES: string[];
+export declare const LEAD_FORM_FIELD_VALIDATION_VALUES: string[];

package/lib/constant/lead-form.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LEAD_FORM_ASSIGNMENT_VALUES = ['System Default', 'Forced Assignment'];
+exports.LEAD_FORM_FIELD_TYPE_VALUES = [
+    'Single-line Field',
+    'Radio buttons',
+    'Checkboxes',
+    'Dropdown list',
+];
+exports.LEAD_FORM_FIELD_VALIDATION_VALUES = [
+    'Alphabetical',
+    'Numerical',
+    'Alphanumerical',
+    'Email',
+    'Phone number',
+    'None',
+];

package/lib/index.d.ts

@@ -18,6 +18,8 @@ import { HighSchoolRecord } from './model/high-school-record';
 import { JourneyStage } from './model/journey-stage';
 import { JourneyToStudent } from './model/journey-to-student';
 import { Journey } from './model/journey';
+import { LeadFormField, LEAD_FORM_FIELD_TYPE, LEAD_FORM_FIELD_VALIDATION } from './model/lead-form-field';
+import { LeadForm, LEAD_FORM_ASSIGNMENT } from './model/lead-form';
 import { Lead } from './model/lead';
 import { PartTimeAssignment } from './model/part-time-assignment';
 import { Profile, GENDER, NATIONALITY, COUNTRY } from './model/profile';
@@ -54,12 +56,13 @@ import { EVENT_CATEGORY_VALUES, EVENT_VISIBILITY_VALUES, EVENT_STATUS_VALUES } f
 import { EXTRACURRICULAR_ACTIVITY_CATEGORY_VALUES } from './constant/extracurricular-activity';
 import { GUARDIAN_RELATIONSHIP_VALUES } from './constant/guardian';
 import { NATIONALITY_VALUES } from './constant/nationality';
+import { LEAD_FORM_ASSIGNMENT_VALUES, LEAD_FORM_FIELD_TYPE_VALUES, LEAD_FORM_FIELD_VALIDATION_VALUES } from './constant/lead-form';
 import { OFFICE_VALUES, ROOMS } from './constant/location';
 import { SALE_PAYMENT_MODE_VALUES, SALE_PAYMENT_TYPE_VALUES, SALE_TYPE_VALUES, SALE_SUB_TYPE_VALUES } from './constant/sale';
 import { EDUCATION_SYSTEM_VALUES, SCHOOL_VALUES, COURSES, COURSE_SUBJECTS, AREA_OF_STUDIES } from './constant/school';
 import { STUDENT_SERVICE_VALUES, UNDERGRAD_TEST_SERVICES, UNDERGRAD_ADMISSIONS_SERVICES, POSTGRAD_TEST_SERVICES, POSTGRAD_ADMISSIONS_SERVICES, SCHOOL_CURRICULUM_SERVICES, ENGLISH_PROFICIENCY_SERVICES, ENRICHMENT_SERVICES, NO_TARGETS, TEST_PREP_TARGETS, ADMISSIONS_TARGETS, UNDERGRAD_ALL_SERVICES, POSTGRAD_ALL_SERVICES } from './constant/student-service';
 import { UNI_PREF_SIZES, UNI_PREF_SETTINGS, UNI_PREF_LOCATIONS } from './constant/university-preference';
 import { USER_STATUS_VALUES } from './constant/user';
-export { CONVERSION_TABLE_TYPE, DIMENSION_TYPE, DIMENSION_CATEGORY, LOG_TYPE, LOG_ACTION, GENDER, NATIONALITY, COUNTRY, SALE_PAYMENT_TYPE, SALE_PAYMENT_MODE, SALE_TYPE, SALE_SUB_TYPE, STUDENT_SERVICE, TEST_ATTEMPT_STATUS, TEST_QUESTION_TYPE, GUARDIAN_RELATIONSHIP, USER_ROLE, USER_STATUS, SCHOOL_LEVEL, EVENT_CATEGORY, EVENT_VISIBILITY, EVENT_STATUS, OFFICE, MEMBERSHIP_LOG_TYPE, STUDENT_NOTE_VISIBILITY, STAFF_HOUR_LOG_TYPE, EXTRACURRICULAR_ACTIVITY_CATEGORY, };
-export { CONVERSION_TABLE_TYPE_VALUES, COUNTRY_VALUES, DIMENSION_TYPE_VALUES, DIMENSION_CATEGORY_VALUES, GUARDIAN_RELATIONSHIP_VALUES, NATIONALITY_VALUES, SALE_PAYMENT_TYPE_VALUES, SALE_PAYMENT_MODE_VALUES, SALE_TYPE_VALUES, SALE_SUB_TYPE_VALUES, STUDENT_SERVICE_VALUES, UNDERGRAD_TEST_SERVICES, UNDERGRAD_ADMISSIONS_SERVICES, POSTGRAD_TEST_SERVICES, POSTGRAD_ADMISSIONS_SERVICES, SCHOOL_CURRICULUM_SERVICES, ENGLISH_PROFICIENCY_SERVICES, ENRICHMENT_SERVICES, NO_TARGETS, TEST_PREP_TARGETS, ADMISSIONS_TARGETS, UNDERGRAD_ALL_SERVICES, POSTGRAD_ALL_SERVICES, EDUCATION_SYSTEM_VALUES, SCHOOL_VALUES, ROOMS, OFFICE_VALUES, EVENT_CATEGORY_VALUES, EVENT_VISIBILITY_VALUES, EVENT_STATUS_VALUES, USER_STATUS_VALUES, COURSES, COURSE_SUBJECTS, AREA_OF_STUDIES, UNI_PREF_SIZES, UNI_PREF_SETTINGS, UNI_PREF_LOCATIONS, EXTRACURRICULAR_ACTIVITY_CATEGORY_VALUES, };
-export { AccessToken, AnswerKey, ConversionTable, CourseTemplateEvent, CourseTemplate, Dimension, EducationSystem, EventLog, EventToUser, Event, ExtracurricularActivity, FileAccess, FileCategory, File, Guardian, HighSchoolRecord, JourneyStage, JourneyToStudent, Journey, Lead, Log, PartTimeAssignment, Profile, SaleSplit, Sale, School, StaffHour, StaffHourLog, StudentAnswer, StudentExtra, StudentGoal, StudentNoteChecklistItem, StudentNote, StudentServiceMembershipLog, StudentServiceMembership, StudentService, StudentTarget, TestAttempt, TestCategory, TestQuestion, BaseReport, Report, SATReport, ACTReport, GMATReport, UCATReport, LSATReport, MCATReport, ISATReport, BMATReport, TestScore, TestSection, Test, UniversityPreference, UserPreference, UserToGuardian, User, ZoomInfo, };
+export { CONVERSION_TABLE_TYPE, DIMENSION_TYPE, DIMENSION_CATEGORY, LOG_TYPE, LOG_ACTION, GENDER, NATIONALITY, COUNTRY, SALE_PAYMENT_TYPE, SALE_PAYMENT_MODE, SALE_TYPE, SALE_SUB_TYPE, STUDENT_SERVICE, TEST_ATTEMPT_STATUS, TEST_QUESTION_TYPE, GUARDIAN_RELATIONSHIP, USER_ROLE, USER_STATUS, SCHOOL_LEVEL, EVENT_CATEGORY, EVENT_VISIBILITY, EVENT_STATUS, OFFICE, MEMBERSHIP_LOG_TYPE, STUDENT_NOTE_VISIBILITY, STAFF_HOUR_LOG_TYPE, EXTRACURRICULAR_ACTIVITY_CATEGORY, LEAD_FORM_FIELD_VALIDATION, LEAD_FORM_FIELD_TYPE, LEAD_FORM_ASSIGNMENT, };
+export { CONVERSION_TABLE_TYPE_VALUES, COUNTRY_VALUES, DIMENSION_TYPE_VALUES, DIMENSION_CATEGORY_VALUES, GUARDIAN_RELATIONSHIP_VALUES, NATIONALITY_VALUES, SALE_PAYMENT_TYPE_VALUES, SALE_PAYMENT_MODE_VALUES, SALE_TYPE_VALUES, SALE_SUB_TYPE_VALUES, STUDENT_SERVICE_VALUES, UNDERGRAD_TEST_SERVICES, UNDERGRAD_ADMISSIONS_SERVICES, POSTGRAD_TEST_SERVICES, POSTGRAD_ADMISSIONS_SERVICES, SCHOOL_CURRICULUM_SERVICES, ENGLISH_PROFICIENCY_SERVICES, ENRICHMENT_SERVICES, NO_TARGETS, TEST_PREP_TARGETS, ADMISSIONS_TARGETS, UNDERGRAD_ALL_SERVICES, POSTGRAD_ALL_SERVICES, EDUCATION_SYSTEM_VALUES, SCHOOL_VALUES, ROOMS, OFFICE_VALUES, EVENT_CATEGORY_VALUES, EVENT_VISIBILITY_VALUES, EVENT_STATUS_VALUES, USER_STATUS_VALUES, COURSES, COURSE_SUBJECTS, AREA_OF_STUDIES, UNI_PREF_SIZES, UNI_PREF_SETTINGS, UNI_PREF_LOCATIONS, EXTRACURRICULAR_ACTIVITY_CATEGORY_VALUES, LEAD_FORM_FIELD_VALIDATION_VALUES, LEAD_FORM_FIELD_TYPE_VALUES, LEAD_FORM_ASSIGNMENT_VALUES, };
+export { AccessToken, AnswerKey, ConversionTable, CourseTemplateEvent, CourseTemplate, Dimension, EducationSystem, EventLog, EventToUser, Event, ExtracurricularActivity, FileAccess, FileCategory, File, Guardian, HighSchoolRecord, JourneyStage, JourneyToStudent, Journey, LeadFormField, LeadForm, Lead, Log, PartTimeAssignment, Profile, SaleSplit, Sale, School, StaffHour, StaffHourLog, StudentAnswer, StudentExtra, StudentGoal, StudentNoteChecklistItem, StudentNote, StudentServiceMembershipLog, StudentServiceMembership, StudentService, StudentTarget, TestAttempt, TestCategory, TestQuestion, BaseReport, Report, SATReport, ACTReport, GMATReport, UCATReport, LSATReport, MCATReport, ISATReport, BMATReport, TestScore, TestSection, Test, UniversityPreference, UserPreference, UserToGuardian, User, ZoomInfo, };

package/lib/index.js

@@ -50,6 +50,13 @@ const journey_to_student_1 = require("./model/journey-to-student");
 exports.JourneyToStudent = journey_to_student_1.JourneyToStudent;
 const journey_1 = require("./model/journey");
 exports.Journey = journey_1.Journey;
+const lead_form_field_1 = require("./model/lead-form-field");
+exports.LeadFormField = lead_form_field_1.LeadFormField;
+exports.LEAD_FORM_FIELD_TYPE = lead_form_field_1.LEAD_FORM_FIELD_TYPE;
+exports.LEAD_FORM_FIELD_VALIDATION = lead_form_field_1.LEAD_FORM_FIELD_VALIDATION;
+const lead_form_1 = require("./model/lead-form");
+exports.LeadForm = lead_form_1.LeadForm;
+exports.LEAD_FORM_ASSIGNMENT = lead_form_1.LEAD_FORM_ASSIGNMENT;
 const lead_1 = require("./model/lead");
 exports.Lead = lead_1.Lead;
 const part_time_assignment_1 = require("./model/part-time-assignment");
@@ -150,6 +157,10 @@ const guardian_2 = require("./constant/guardian");
 exports.GUARDIAN_RELATIONSHIP_VALUES = guardian_2.GUARDIAN_RELATIONSHIP_VALUES;
 const nationality_1 = require("./constant/nationality");
 exports.NATIONALITY_VALUES = nationality_1.NATIONALITY_VALUES;
+const lead_form_2 = require("./constant/lead-form");
+exports.LEAD_FORM_ASSIGNMENT_VALUES = lead_form_2.LEAD_FORM_ASSIGNMENT_VALUES;
+exports.LEAD_FORM_FIELD_TYPE_VALUES = lead_form_2.LEAD_FORM_FIELD_TYPE_VALUES;
+exports.LEAD_FORM_FIELD_VALIDATION_VALUES = lead_form_2.LEAD_FORM_FIELD_VALIDATION_VALUES;
 const location_1 = require("./constant/location");
 exports.OFFICE_VALUES = location_1.OFFICE_VALUES;
 exports.ROOMS = location_1.ROOMS;

package/lib/model/lead-form-field.d.ts

@@ -0,0 +1,26 @@
+import { LeadForm } from './lead-form';
+export declare enum LEAD_FORM_FIELD_TYPE {
+    SINGLE_LINE = 1,
+    RADIO = 2,
+    CHECKBOX = 3,
+    DROPDOWN = 4
+}
+export declare enum LEAD_FORM_FIELD_VALIDATION {
+    ALPHABETICAL = 1,
+    NUMERICAL = 2,
+    ALPHANUMERICAL = 3,
+    EMAIL = 4,
+    PHONE_NUMBER = 5,
+    NONE = 6
+}
+export declare class LeadFormField {
+    id: number;
+    name: string;
+    label: string;
+    type: LEAD_FORM_FIELD_TYPE;
+    validation: LEAD_FORM_FIELD_VALIDATION;
+    options: string;
+    required: boolean;
+    formId: number;
+    form: LeadForm;
+}

package/lib/model/lead-form-field.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const typeorm_1 = require("typeorm");
+const lead_form_1 = require("./lead-form");
+var LEAD_FORM_FIELD_TYPE;
+(function (LEAD_FORM_FIELD_TYPE) {
+    LEAD_FORM_FIELD_TYPE[LEAD_FORM_FIELD_TYPE["SINGLE_LINE"] = 1] = "SINGLE_LINE";
+    LEAD_FORM_FIELD_TYPE[LEAD_FORM_FIELD_TYPE["RADIO"] = 2] = "RADIO";
+    LEAD_FORM_FIELD_TYPE[LEAD_FORM_FIELD_TYPE["CHECKBOX"] = 3] = "CHECKBOX";
+    LEAD_FORM_FIELD_TYPE[LEAD_FORM_FIELD_TYPE["DROPDOWN"] = 4] = "DROPDOWN";
+})(LEAD_FORM_FIELD_TYPE = exports.LEAD_FORM_FIELD_TYPE || (exports.LEAD_FORM_FIELD_TYPE = {}));
+var LEAD_FORM_FIELD_VALIDATION;
+(function (LEAD_FORM_FIELD_VALIDATION) {
+    LEAD_FORM_FIELD_VALIDATION[LEAD_FORM_FIELD_VALIDATION["ALPHABETICAL"] = 1] = "ALPHABETICAL";
+    LEAD_FORM_FIELD_VALIDATION[LEAD_FORM_FIELD_VALIDATION["NUMERICAL"] = 2] = "NUMERICAL";
+    LEAD_FORM_FIELD_VALIDATION[LEAD_FORM_FIELD_VALIDATION["ALPHANUMERICAL"] = 3] = "ALPHANUMERICAL";
+    LEAD_FORM_FIELD_VALIDATION[LEAD_FORM_FIELD_VALIDATION["EMAIL"] = 4] = "EMAIL";
+    LEAD_FORM_FIELD_VALIDATION[LEAD_FORM_FIELD_VALIDATION["PHONE_NUMBER"] = 5] = "PHONE_NUMBER";
+    LEAD_FORM_FIELD_VALIDATION[LEAD_FORM_FIELD_VALIDATION["NONE"] = 6] = "NONE";
+})(LEAD_FORM_FIELD_VALIDATION = exports.LEAD_FORM_FIELD_VALIDATION || (exports.LEAD_FORM_FIELD_VALIDATION = {}));
+let LeadFormField = class LeadFormField {
+};
+tslib_1.__decorate([
+    typeorm_1.PrimaryGeneratedColumn(),
+    tslib_1.__metadata("design:type", Number)
+], LeadFormField.prototype, "id", void 0);
+tslib_1.__decorate([
+    typeorm_1.Column({ type: 'varchar', length: 200 }),
+    tslib_1.__metadata("design:type", String)
+], LeadFormField.prototype, "name", void 0);
+tslib_1.__decorate([
+    typeorm_1.Column({ type: 'varchar', length: 200 }),
+    tslib_1.__metadata("design:type", String)
+], LeadFormField.prototype, "label", void 0);
+tslib_1.__decorate([
+    typeorm_1.Column({ type: 'int' }),
+    tslib_1.__metadata("design:type", Number)
+], LeadFormField.prototype, "type", void 0);
+tslib_1.__decorate([
+    typeorm_1.Column({ type: 'int' }),
+    tslib_1.__metadata("design:type", Number)
+], LeadFormField.prototype, "validation", void 0);
+tslib_1.__decorate([
+    typeorm_1.Column({ type: 'text' }),
+    tslib_1.__metadata("design:type", String)
+], LeadFormField.prototype, "options", void 0);
+tslib_1.__decorate([
+    typeorm_1.Column({ type: 'boolean' }),
+    tslib_1.__metadata("design:type", Boolean)
+], LeadFormField.prototype, "required", void 0);
+tslib_1.__decorate([
+    typeorm_1.Column({ type: 'int' }),
+    tslib_1.__metadata("design:type", Number)
+], LeadFormField.prototype, "formId", void 0);
+tslib_1.__decorate([
+    typeorm_1.ManyToOne(type => lead_form_1.LeadForm, form => form.fields),
+    typeorm_1.JoinColumn(),
+    tslib_1.__metadata("design:type", lead_form_1.LeadForm)
+], LeadFormField.prototype, "form", void 0);
+LeadFormField = tslib_1.__decorate([
+    typeorm_1.Entity({ name: 'lead_form_fields' })
+], LeadFormField);
+exports.LeadFormField = LeadFormField;

package/lib/model/lead-form.d.ts

@@ -0,0 +1,21 @@
+import { STUDENT_SERVICE } from './student-service';
+import { User } from './user';
+import { LeadFormField } from './lead-form-field';
+export declare enum LEAD_FORM_ASSIGNMENT {
+    DEFAULT = 1,
+    FORCED = 2
+}
+export declare class LeadForm {
+    id: number;
+    name: string;
+    formId: string;
+    description: string;
+    service: STUDENT_SERVICE;
+    assignment: LEAD_FORM_ASSIGNMENT;
+    assigneeId?: number;
+    redirectUrl: string;
+    createdAt: Date;
+    updatedAt: Date;
+    assignee?: User;
+    fields: LeadFormField[];
+}

package/lib/model/lead-form.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const typeorm_1 = require("typeorm");
+const student_service_1 = require("./student-service");
+const user_1 = require("./user");
+const lead_form_field_1 = require("./lead-form-field");
+var LEAD_FORM_ASSIGNMENT;
+(function (LEAD_FORM_ASSIGNMENT) {
+    LEAD_FORM_ASSIGNMENT[LEAD_FORM_ASSIGNMENT["DEFAULT"] = 1] = "DEFAULT";
+    LEAD_FORM_ASSIGNMENT[LEAD_FORM_ASSIGNMENT["FORCED"] = 2] = "FORCED";
+})(LEAD_FORM_ASSIGNMENT = exports.LEAD_FORM_ASSIGNMENT || (exports.LEAD_FORM_ASSIGNMENT = {}));
+let LeadForm = class LeadForm {
+};
+tslib_1.__decorate([
+    typeorm_1.PrimaryGeneratedColumn(),
+    tslib_1.__metadata("design:type", Number)
+], LeadForm.prototype, "id", void 0);
+tslib_1.__decorate([
+    typeorm_1.Column({ type: 'varchar', length: 200 }),
+    tslib_1.__metadata("design:type", String)
+], LeadForm.prototype, "name", void 0);
+tslib_1.__decorate([
+    typeorm_1.Column({ type: 'varchar', length: 200 }),
+    tslib_1.__metadata("design:type", String)
+], LeadForm.prototype, "formId", void 0);
+tslib_1.__decorate([
+    typeorm_1.Column({ type: 'text' }),
+    tslib_1.__metadata("design:type", String)
+], LeadForm.prototype, "description", void 0);
+tslib_1.__decorate([
+    typeorm_1.Column({ type: 'int' }),
+    tslib_1.__metadata("design:type", Number)
+], LeadForm.prototype, "service", void 0);
+tslib_1.__decorate([
+    typeorm_1.Column({ type: 'int' }),
+    tslib_1.__metadata("design:type", Number)
+], LeadForm.prototype, "assignment", void 0);
+tslib_1.__decorate([
+    typeorm_1.Column({ type: 'int', nullable: true }),
+    tslib_1.__metadata("design:type", Number)
+], LeadForm.prototype, "assigneeId", void 0);
+tslib_1.__decorate([
+    typeorm_1.Column({ type: 'varchar', length: 500 }),
+    tslib_1.__metadata("design:type", String)
+], LeadForm.prototype, "redirectUrl", void 0);
+tslib_1.__decorate([
+    typeorm_1.CreateDateColumn(),
+    tslib_1.__metadata("design:type", Date)
+], LeadForm.prototype, "createdAt", void 0);
+tslib_1.__decorate([
+    typeorm_1.UpdateDateColumn(),
+    tslib_1.__metadata("design:type", Date)
+], LeadForm.prototype, "updatedAt", void 0);
+tslib_1.__decorate([
+    typeorm_1.ManyToOne(type => user_1.User),
+    typeorm_1.JoinColumn(),
+    tslib_1.__metadata("design:type", user_1.User)
+], LeadForm.prototype, "assignee", void 0);
+tslib_1.__decorate([
+    typeorm_1.OneToMany(type => lead_form_field_1.LeadFormField, field => field.form),
+    tslib_1.__metadata("design:type", Array)
+], LeadForm.prototype, "fields", void 0);
+LeadForm = tslib_1.__decorate([
+    typeorm_1.Entity({ name: 'lead_forms' })
+], LeadForm);
+exports.LeadForm = LeadForm;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tudopz/model",
-  "version": "2.21.6",
+  "version": "2.22.0",
   "description": "PZ Models",
   "author": "Tu Do <angelwing1001@gmail.com>",
   "homepage": "",