dce-reactkit 3.4.0 → 3.5.1-beta.1

package/src/components/ItemPicker/index.test.tsx

@@ -512,7 +512,7 @@ const assertExpectedItemsAreChecked = (
   }
 };
 
-test.skip(
+test(
   'All Checkboxes appear when initially rendered',
   async () => {
     Raixa.render(
@@ -530,7 +530,7 @@ test.skip(
   },
 );
 
-test.skip(
+test(
   'Collapsing item 3 results in only the first 3 items and item 24 showing',
   async () => {
     Raixa.render(
@@ -555,7 +555,7 @@ test.skip(
   },
 );
 
-test.skip(
+test(
   'Collapsing item 15 results hides items 16 through 21',
   async () => {
     Raixa.render(
@@ -580,7 +580,7 @@ test.skip(
   },
 );
 
-test.skip(
+test(
   'Collapsing item 10 results hides items 11 through 21',
   async () => {
     Raixa.render(
@@ -605,7 +605,7 @@ test.skip(
   },
 );
 
-test.skip(
+test(
   'All Checkboxes are unchecked when initially rendered',
   async () => {
     Raixa.render(
@@ -626,7 +626,7 @@ test.skip(
   },
 );
 
-test.skip(
+test(
   'Checking item 1 checks items 1',
   async () => {
     let updatedItems: PickableItem[] = [];
@@ -654,7 +654,7 @@ test.skip(
   },
 );
 
-test.skip(
+test(
   'Clicking item 1 unchecks items 1',
   async () => {
     let updatedItems: PickableItem[] = [];
@@ -686,7 +686,7 @@ test.skip(
   },
 );
 
-test.skip(
+test(
   'Checking item 3 checks items 3 through 23',
   async () => {
     let updatedItems: PickableItem[] = [];
@@ -720,7 +720,7 @@ test.skip(
   },
 );
 
-test.skip(
+test(
   'Clicking folder 3 checks unchecks 3 through 23',
   async () => {
     let updatedItems: PickableItem[] = [];
@@ -750,7 +750,7 @@ test.skip(
   },
 );
 
-test.skip(
+test(
   'Clicking dashed folder 3 checks 3 through 23',
   async () => {
     let updatedItems: PickableItem[] = [];

package/src/helpers/addDBEditorEndpoints.ts

@@ -0,0 +1,128 @@
+// Import express
+import express from 'express';
+
+// Import shared helpers
+import genRouteHandler from './genRouteHandler';
+import generateEndpointPath from '../components/DBEntryManagerPanel/helpers/generateEndpointPath';
+
+// Import shared types
+import ParamType from '../types/ParamType';
+
+/**
+ * Interface for a collection in the database
+ * @author Yuen Ler Chow
+ */
+type DCEMangoCollection = {
+  /**
+   * Find all items in the collection that match the filter query
+   * @param filterQuery 
+   * @returns list of items that match the filter query
+   */
+  find: (filterQuery: any) => Promise<any[]>,
+  /**
+   * Insert an item into the collection
+   * @param item the item to insert
+   */
+  insert: (item: any) => Promise<void>,
+  /**
+   * Delete an item in the collection
+   * @param id the id of the item to delete
+   */
+  delete: (filterQuery: { id: string }) => Promise<void>,
+};
+
+/**
+ * Add all routes for the DBEditor
+ * @author Yuen Ler Chow
+ * @param opts object containing all arguments
+ * @param opts.app express app to add routes too
+ * @param opts.collectionName the name of the collection
+ * @param opts.adminsOnly true if the endpoint is for admins only
+ * @param opts.collection dce-mango db collection
+ */
+const addDBEditorEndpoints = (
+  opts: {
+    app: express.Application,
+    collectionName: string,
+    adminsOnly: boolean,
+    collection: DCEMangoCollection,
+  },
+) => {
+  const {
+    app,
+    collectionName,
+    adminsOnly,
+    collection,
+  } = opts;
+
+  // Generate the endpoint path
+  const endpointPath = generateEndpointPath(collectionName, adminsOnly);
+
+  /**
+   * List all items in the collection
+   * @author Yuen Ler Chow
+   * @returns {any[]} the list of items in the collection
+   */
+  app.get(
+    endpointPath,
+    genRouteHandler({
+      paramTypes: {
+        filterQuery: ParamType.JSONOptional,
+      },
+      handler: async ({ params }) => {
+        const filterQuery = params.filterQuery ?? {};
+        const categories = await collection.find(filterQuery);
+        return categories;
+      },
+    }),
+  );
+
+  /**
+   * Create a new item in the collection
+   * @author Yuen Ler Chow
+   * @param {any} item the item to create
+   */
+  app.post(
+    endpointPath,
+    genRouteHandler({
+      paramTypes: {
+        item: ParamType.JSON,
+      },
+      handler: async ({
+        params,
+      }) => {
+        // Destructure params
+        const {
+          item,
+        } = params;
+
+        await collection.insert(item);
+      },
+    }),
+  );
+
+  /**
+   * Remove an item from the collection by id
+   * @author Yuen Ler Chow
+   */
+  app.delete(
+    `${endpointPath}/:id`,
+    genRouteHandler({
+      paramTypes: {
+        id: ParamType.String,
+      },
+      handler: async ({
+        params,
+      }) => {
+        // Destructure params
+        const {
+          id,
+        } = params;
+
+        await collection.delete({ id });
+      },
+    }),
+  );
+};
+
+export default addDBEditorEndpoints;

package/src/helpers/canReviewLogs.ts

@@ -4,29 +4,9 @@ import visitServerEndpoint from './visitServerEndpoint';
 // Import shared constants
 import LOG_REVIEW_STATUS_ROUTE from '../constants/LOG_REVIEW_STATUS_ROUTE';
 
-/*------------------------------------------------------------------------*/
-/* -------------------------------- Cache ------------------------------- */
-/*------------------------------------------------------------------------*/
-
 // Cache user's ability
 let canReview: boolean | undefined = undefined;
 
-/*------------------------------------------------------------------------*/
-/* ---------------------------- Other Helpers --------------------------- */
-/*------------------------------------------------------------------------*/
-
-/**
- * Reset the cached version of canReview
- * @author Gabe Abrams
- */
-export const resetCanReviewCache = () => {
-  canReview = undefined;
-};
-
-/*------------------------------------------------------------------------*/
-/* -------------------------------- Main -------------------------------- */
-/*------------------------------------------------------------------------*/
-
 /**
  * Check if the current user can review logs
  * @author Gabe Abrams

package/src/helpers/genCSV.ts

@@ -5,16 +5,13 @@
  * @returns escaped cell text
  */
 const escapeCellText = (text: string): string => {
-  if (
-    !String(text).includes(',')
-    && !String(text).includes('"')
-  ) {
+  if (!String(text).includes(',')) {
     // No need to escape
     return String(text);
   }
 
   // Perform escape
-  return `"${String(text).replace(/"/g, '""')}"`;
+  return `"${String(text).replace(/"/g, '""')}`;
 };
 
 /**

package/src/helpers/{getOrdinal.ts → getOrdinal.tsx}

@@ -1,4 +1,3 @@
-// Constants
 const ORDINALS = ['th', 'st', 'nd', 'rd'];
 
 /**

package/src/index.ts

@@ -17,6 +17,7 @@ import ItemPicker from './components/ItemPicker';
 import LogReviewer from './components/LogReviewer';
 import IntelliTable from './components/IntelliTable';
 import CSVDownloadButton from './components/CSVDownloadButton';
+import DBEntryManagerPanel from './components/DBEntryManagerPanel';
 
 // Import errors
 import ErrorWithCode from './errors/ErrorWithCode';
@@ -63,11 +64,8 @@ import canReviewLogs from './helpers/canReviewLogs';
 import isMobileOrTablet from './helpers/isMobileOrTablet';
 import extractProp from './helpers/extractProp';
 import compareArraysByProp from './helpers/compareArraysByProp';
-import genCommaList from './helpers/genCommaList';
-import validateEmail from './helpers/validators/validateEmail';
-import validatePhoneNumber from './helpers/validators/validatePhoneNumber';
-import validateString from './helpers/validators/validateString';
-import getLocalTimeInfo from './helpers/getLocalTimeInfo';  
+import getLocalTimeInfo from './helpers/getLocalTimeInfo';
+import addDBEditorEndpoints from './helpers/addDBEditorEndpoints';
 
 // Import types
 import ModalButtonType from './types/ModalButtonType';
@@ -87,6 +85,9 @@ import IntelliTableColumn from './types/IntelliTableColumn';
 
 // Component-specific-types
 import PickableItem from './components/ItemPicker/types/PickableItem';
+import DBEntry from './components/DBEntryManagerPanel/types/DBEntry';
+import DBEntryField from './components/DBEntryManagerPanel/types/DBEntryField';
+import DBEntryFieldType from './components/DBEntryManagerPanel/types/DBEntryFieldType';
 
 // Export each item
 export {
@@ -109,6 +110,7 @@ export {
   LogReviewer,
   IntelliTable,
   CSVDownloadButton,
+  DBEntryManagerPanel,
   // Global functions
   alert,
   confirm,
@@ -147,10 +149,6 @@ export {
   isMobileOrTablet,
   extractProp,
   compareArraysByProp,
-  genCommaList,
-  validateEmail,
-  validatePhoneNumber,
-  validateString,
   getLocalTimeInfo,
   // Client helpers
   initClient,
@@ -162,6 +160,7 @@ export {
   handleError,
   handleSuccess,
   initLogCollection,
+  addDBEditorEndpoints,
   // Types
   ModalButtonType,
   ModalSize,
@@ -178,6 +177,9 @@ export {
   IntelliTableColumn,
   // Component-specific-types
   PickableItem,
+  DBEntry,
+  DBEntryField,
+  DBEntryFieldType,
   // Server types
   ParamType,
 };

package/tsconfig.json

@@ -15,12 +15,8 @@
     "allowSyntheticDefaultImports": true,
     "emitDeclarationOnly": true
   },
+
   "include": [
     "./src/**/*"
-  ],
-  "ts-node": {
-    "compilerOptions": {
-      "module": "commonjs"
-    }
-  },
+  ]
 }

package/dist/cjs/types/helpers/abbreviate.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Unit tests for abbreviate helper
- * @author Gabe Abrams
- */
-export {};

package/dist/cjs/types/helpers/avg.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Unit tests for avg helper
- * @author Gabe Abrams
- */
-export {};

package/dist/cjs/types/helpers/canReviewLogs.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Unit tests for canReviewLogs
- * @author Gabe Abrams
- */
-export {};

package/dist/cjs/types/helpers/ceilToNumDecimals.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Test file for the ceilToNumDecimals helper
- * @author Gabe Abrams
- */
-export {};

package/dist/cjs/types/helpers/compareArraysByProp.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Test file for the compareArraysByProp helper
- * @author Gabe Abrams
- */
-export {};

package/dist/cjs/types/helpers/extractProp.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Test file for the extractProp helper
- * @author Gabe Abrams
- */
-export {};

package/dist/cjs/types/helpers/floorToNumDecimals.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Test file for the floorToNumDecimals helper
- * @author Gabe Abrams
- */
-export {};

package/dist/cjs/types/helpers/forceNumIntoBounds.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Test file for the forceNumIntoBounds helper
- * @author Gabe Abrams
- */
-export {};

package/dist/cjs/types/helpers/genCSV.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Test file for the genCSV helper
- * @author Gabe Abrams
- */
-export {};

package/dist/cjs/types/helpers/genCommaList.d.ts

@@ -1,12 +0,0 @@
-/**
- * Given an array of strings, create a single comma-separated string that includes
- * 'and' as well as an oxford comma.
- * Ex: ['apples'] => 'apples'
- * Ex: ['apples', 'bananas'] => 'apples and bananas'
- * Ex: ['apples', 'bananas', 'grapes'] => 'apples, bananas, and grapes'
- * @author Austen Money
- * @param list an array of elements to be made into a single comma-separated string.
- * @returns a comma-separated string.
- */
-declare const genCommaList: (list: string[]) => string;
-export default genCommaList;

package/dist/cjs/types/helpers/genCommaList.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/cjs/types/helpers/getHumanReadableDate.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Test file for the getHumanReadableDate helper
- * @author Gabe Abrams
- */
-export {};

package/dist/cjs/types/helpers/getLocalTimeInfo.test.d.ts

@@ -1,6 +0,0 @@
-/**
- * Test for getLocalTimeInfo helper function
- *   NOTE: only works if this test is run on a machine in ET
- * @author Gabe Abrams
- */
-export {};

package/dist/cjs/types/helpers/getMonthName.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Test for getMonthName helper
- * @author Gabe Abrams
- */
-export {};

package/dist/cjs/types/helpers/getOrdinal.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Test file for the getOrdinal helper
- * @author Gabe Abrams
- */
-export {};

package/dist/cjs/types/helpers/getPartOfDay.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Test file for the getPartOfDay helper
- * @author Gabe Abrams
- */
-export {};

package/dist/cjs/types/helpers/getTimeInfoInET.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Test file for the getTimeInfoInET helper
- * @author Gabe Abrams
- */
-export {};

package/dist/cjs/types/helpers/validators/shared/constants/ERROR_MESSAGES.d.ts

@@ -1,10 +0,0 @@
-export declare const INVALID_REGEX_ERROR = "input does not follow the requested format";
-export declare const INVALID_EMAIL_ERROR = "Please provide a valid email address.";
-export declare const INVALID_PHONE_ERROR = "Please provide a valid phone number.";
-export declare const INVALID_STRING_ERRORS: {
-    MIN_LEN: (minLen: number) => string;
-    MAX_LEN: (maxLen: number) => string;
-    LETTERS_ONLY: string;
-    NUMBERS_ONLY: string;
-    MESSAGE_INTRO: string;
-};

package/dist/cjs/types/helpers/validators/shared/helpers/validateRegex.d.ts

@@ -1,19 +0,0 @@
-import ValidationResult from '../types/ValidationResult';
-/**
- * Determines whether a given input string is considered valid based on
- *   the provided regex.
- * @author Austen Money
- * @param opts object containing all args
- * @param opts.input user-provided input to validate
- * @param opts.regex regular expression to check against input
- * @param [opts.regexDescription] description of what regexString is checking
- *   for, used to customize error message
- * @returns the unchanged input if valid, or a customized error message if
- *   invalid
- */
-declare const validateRegex: (opts: {
-    input: string;
-    regex: RegExp;
-    regexDescription?: string;
-}) => ValidationResult<string>;
-export default validateRegex;

package/dist/cjs/types/helpers/validators/shared/types/ValidationResult.d.ts

@@ -1,12 +0,0 @@
-/**
- * Result of a validation function.
- * @author Austen Money
- */
-type ValidationResult<CleanedValueType> = ({
-    isValid: true;
-    cleanedValue: CleanedValueType;
-} | {
-    isValid: false;
-    errorMessage: string;
-});
-export default ValidationResult;

package/dist/cjs/types/helpers/validators/validateEmail.d.ts

@@ -1,11 +0,0 @@
-import ValidationResult from './shared/types/ValidationResult';
-/**
- * Determines whether a given email address is valid.
- * @author Austen Money
- * @param email email address to validate
- * @returns whether email fulfills proper formatting requirements, includes a
- *   cleaned version of the address without leading or trailing
- *   whitespace if valid or an error message if invalid.
- */
-declare const validateEmail: (email: string) => ValidationResult<string>;
-export default validateEmail;

package/dist/cjs/types/helpers/validators/validateEmail.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/cjs/types/helpers/validators/validatePhoneNumber.d.ts

@@ -1,11 +0,0 @@
-import ValidationResult from './shared/types/ValidationResult';
-/**
- * Determines whether a given phone number is valid.
- * @author Austen Money
- * @param phoneNumber phone number to validate
- * @returns whether phone number is considered valid - if valid, also returns
- *   a cleaned version of the number without any formatting. If invalid,
- *   returns an error message.
- */
-declare const validatePhoneNumber: (phoneNumber: string) => ValidationResult<string>;
-export default validatePhoneNumber;

package/dist/cjs/types/helpers/validators/validatePhoneNumber.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/cjs/types/helpers/validators/validateString.d.ts

@@ -1,22 +0,0 @@
-import ValidationResult from './shared/types/ValidationResult';
-/**
- * Determines whether a given input string is considered valid based on
- *   the provided requirements.
- * @author Austen Money
- * @param input input string
- * @param opts options for validation
- * @returns whether input is considered valid according to reqs - if
- *   valid, returns a cleaned version of input; if invalid, returns
- *   a string containing error messages describing which requirements
- *   were not met.
- */
-declare const validateString: (input: string, opts: {
-    ignoreWhitespace?: boolean;
-    minLen?: number;
-    maxLen?: number;
-    lettersOnly?: boolean;
-    numbersOnly?: boolean;
-    regexTest?: RegExp;
-    regexDescription?: string;
-}) => ValidationResult<string>;
-export default validateString;

package/dist/cjs/types/helpers/validators/validateString.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/esm/types/helpers/abbreviate.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Unit tests for abbreviate helper
- * @author Gabe Abrams
- */
-export {};

package/dist/esm/types/helpers/avg.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Unit tests for avg helper
- * @author Gabe Abrams
- */
-export {};

package/dist/esm/types/helpers/canReviewLogs.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Unit tests for canReviewLogs
- * @author Gabe Abrams
- */
-export {};

package/dist/esm/types/helpers/ceilToNumDecimals.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Test file for the ceilToNumDecimals helper
- * @author Gabe Abrams
- */
-export {};

package/dist/esm/types/helpers/compareArraysByProp.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Test file for the compareArraysByProp helper
- * @author Gabe Abrams
- */
-export {};

package/dist/esm/types/helpers/extractProp.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Test file for the extractProp helper
- * @author Gabe Abrams
- */
-export {};

package/dist/esm/types/helpers/floorToNumDecimals.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Test file for the floorToNumDecimals helper
- * @author Gabe Abrams
- */
-export {};

package/dist/esm/types/helpers/forceNumIntoBounds.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Test file for the forceNumIntoBounds helper
- * @author Gabe Abrams
- */
-export {};

package/dist/esm/types/helpers/genCSV.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Test file for the genCSV helper
- * @author Gabe Abrams
- */
-export {};

package/dist/esm/types/helpers/genCommaList.d.ts

@@ -1,12 +0,0 @@
-/**
- * Given an array of strings, create a single comma-separated string that includes
- * 'and' as well as an oxford comma.
- * Ex: ['apples'] => 'apples'
- * Ex: ['apples', 'bananas'] => 'apples and bananas'
- * Ex: ['apples', 'bananas', 'grapes'] => 'apples, bananas, and grapes'
- * @author Austen Money
- * @param list an array of elements to be made into a single comma-separated string.
- * @returns a comma-separated string.
- */
-declare const genCommaList: (list: string[]) => string;
-export default genCommaList;

package/dist/esm/types/helpers/genCommaList.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/esm/types/helpers/getHumanReadableDate.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Test file for the getHumanReadableDate helper
- * @author Gabe Abrams
- */
-export {};