user.mqschema.js

{
  paths:{
    orgID: {
      name: "orgID",
      isSearchable:true,
      isProjectable: false,
      isUpdatable: false,
      isInsertable: true,
      isRequired: true ,
      required:true,
      type: "String",
      makeTestData: ()=>{return 'OrgID:' + Math.random()},
      notes: {
        "purpose": "This field is used for: ...",
        "restriction": "max length, min value, explaination of validate "
      },
      maxlength: 50,
      minlength: 3
    },
    companyName: {
      name: "companyName",
      isSearchable: true,
      isProjectable: true,
      isUpdatable: true,
      isInsertable: true,
      isRequired: true,
      type: "String",
      makeTestData: ()=>{return 'The ABC Co.' + Math.random();},
      notes: {
        "purpose": "This field is used for: ...",
        "restriction": "Required to be longer than 5 characters."
      },
      maxlength: 50,
      minlength: 3
    },
    city: {
      name: "city",
      isSearchable: true,
      isProjectable: true,
      isUpdatable: true,
      isInsertable: true,
      isRequired: false,
      type: "String",
      makeTestData: ()=>{return 'Lewiston ' + Math.random();},
      notes: {
        "purpose": "Instead of 'delete' deactive",
        "restriction": "true or false"
      },
      maxlength: 100,
      minlength: 2
    },
    "state": {
      name: "state",
      isSearchable: true,
      isProjectable: true,
      isUpdatable: false,
      isInsertable: true,
      isRequired: false,
      type: "String",
      makeTestData: ()=>{return randomElement(['ME','CA','NE','LA','NY','MN','TX','CO','OR','FL','NC','UT','NV','WA','OH'])},
      notes: {
        "purpose": "Instead of 'delete' deactive",
        "restriction": "Must be a state in USA or Candada"
      },
      maxlength: 2,
      minlength: 2
    },
    yearsInBusiness: {
      name: "yearsInBusiness",
      isSearchable: false,
      isProjectable: false,
      isUpdatable: true,
      isInsertable: true,
      isRequired: false,
      type: "Number",
      makeTestData: ()=>{return Math.floor(200 * Math.random())},
      notes: {
        "purpose": "Instead of 'delete' deactive",
        "restriction": "true or false"
      },
      "max": 300
    },
    idxBucket: {
      name: "idxBucket",
      isSearchable: true,
      isProjectable: true,
      isUpdatable: true,
      isInsertable: true,
      isRequired: false,
      type: "Number",
      makeTestData: ()=>{return Math.floor(10 * Math.random())},
      notes: {
        "purpose": "Instead of 'delete' deactive",
        "restriction": "true or false"
      },
      "max": 9
    },
    restrictedPath: {
      name: "restrictedPath",
      isSearchable: false,
      isProjectable: false,
      isUpdatable: false,
      isInsertable: true,
      isRequired: true,
      type: "Number",
      makeTestData: ()=>{return Math.floor(10 * Math.random())},
       notes: {
        "purpose": "debug testing functionality",
        "restriction": "number 0-9"
      },
      "max": 9
    },
    someDate: {
      name: "someDate",
      isSearchable: true,
      isProjectable: false,
      isUpdatable: true,
      isInsertable: true,
      isRequired: true,
      type: "Date",
      makeTestData: ()=>{return new Date()},
      notes: {
        "purpose": "Instead of 'delete' deactive",
        "restriction": "true or false"
      }
    },
    memberSinceDate: {
      name: "memberSinceDate",
      isSearchable: true,
      isProjectable: false,
      isUpdatable: false,
      isInsertable: false,
      isRequired: true,
      default: ()=>{return new Date()},
      type: "Date",
      makeTestData: ()=>{return new Date()},
      notes: {
        "purpose": "Instead of 'delete' deactive",
        "restriction": "true or false"
      }
    },
    isActive: {
      name: "isActive",
      isSearchable: true,
      isProjectable: true,
      isUpdatable: false,
      isInsertable: true,
      isRequired: true,
      type: "Boolean",
      makeTestData: ()=>{return (Math.random()<0.5) ? true : false;},
      notes: {
        "purpose": "Instead of 'delete' deactive",
        "restriction": "true or false"
      }
    }
  
  },
  systemPaths:{
    _id: {
      name: "_id",
      isSearchable: false,
      isProjectable: false,
      isUpdatable: false,
      isInsertable: false,
      isRequired: true,
      type: "ObjectId",
      notes: {
        "purpose": "Instead of 'delete' deactive",
        "restriction": "true or false"
      }
    },
    updatedAt: {
      name: "updatedAt",
      isSearchable: false,
      isProjectable: false,
      isUpdatable: false,
      isInsertable: false,
      isRequired: true,
      notes: {
        "purpose": "Instead of 'delete' deactive",
        "restriction": "true or false"
      }
    },
    createdAt: {
      name: "createdAt",
      isSearchable: false,
      isProjectable: false,
      isUpdatable: false,
      isInsertable: false,
      isRequired: true,
      notes: {
        "purpose": "Instead of 'delete' deactive",
        "restriction": "true or false"
      }
    },
    __v: {
      name: "__v",
      isSearchable: false,
      isProjectable: false,
      isUpdatable: false,
      isInsertable: false,
      isRequired: true,
      type: "Number",
      notes: {
        "purpose": "Instead of 'delete' deactive",
        "restriction": "true or false"
      }
    },
    schemaVersionKey: {
      name: "schemaVersionKey",
      isSearchable: false,
      isProjectable: false,
      isUpdatable: false,
      isInsertable: false,
      isRequired: true,
      type: "String",
      makeTestData:()=>{},
      notes: {
        "purpose": "Track schema used to insert document, eg: schema compliancy ",
        "restriction": "match this schema schema's  schemaVersionKey "
      }
    }
  },
  
  options:
    {
      documentation:`some document stuff goes here`,
      collection: 'userinfo',
      timestamps:true,
      writeConcern:{ w: 1, j: false},
      schemaVersionKey:'0001'
    }
  };