dce-reactkit 3.4.0 → 3.5.1-beta.1

package/dist/cjs/types/components/DBEntryManagerPanel/AddOrEditDBEntry/CreatableMultiselect.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+import DBEntryFieldType from '../types/DBEntryFieldType';
+declare type Props = {
+    type: DBEntryFieldType.StringArray | DBEntryFieldType.NumberArray;
+    values: string[] | number[];
+    onChange: (values: string[] | number[]) => void;
+    disabled?: boolean;
+};
+declare const CreatableMultiselect: React.FC<Props>;
+export default CreatableMultiselect;

package/dist/cjs/types/components/DBEntryManagerPanel/AddOrEditDBEntry/index.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Panel for adding a DBEntry to the database
+ * @author Yuen Ler Chow
+ */
+import React from 'react';
+import DBEntry from '../types/DBEntry';
+import DBEntryField from '../types/DBEntryField';
+declare type Props = {
+    /**
+     * Handler for when the user finishes adding the DBEntry
+     * (if no DBEntry is returned, process was cancelled)
+     * @param DBEntry the DBEntry that was just created
+     */
+    onFinished: (dbEntry?: DBEntry) => void;
+    /**
+     * Function to validate the DBEntry before saving
+     * @param dbEntry
+     */
+    validateEntry?: (dbEntry: DBEntry) => Promise<void>;
+    /**
+     * Function to modify the DBEntry before saving
+     * @param dbEntry
+     * @returns the modified DBEntry
+     */
+    modifyEntry?: (dbEntry: DBEntry) => DBEntry;
+    entryFields: DBEntryField[];
+    dbEntryToEdit?: DBEntry;
+    idPropName: string;
+    itemName: string;
+    saveEndpointPath: string;
+    entries: DBEntry[];
+};
+declare const AddOrEditDBEntry: React.FC<Props>;
+export default AddOrEditDBEntry;

package/dist/cjs/types/components/DBEntryManagerPanel/helpers/generateEndpointPath.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Generates the endpoint path for the given collection name
+ * @author Yuen Ler Chow
+ * @param collectionName the name of the collection
+ * @param [adminsOnly] true if the endpoint is for admins only
+ * @returns the endpoint path
+ */
+declare const generateEndpointPath: (collectionName: string, adminsOnly?: boolean | undefined) => string;
+export default generateEndpointPath;

package/dist/cjs/types/components/DBEntryManagerPanel/index.d.ts

@@ -0,0 +1,25 @@
+/**
+ * DB Entry Manager Panel
+ * @author Yuen Ler Chow
+ */
+import React from 'react';
+import DBEntry from './types/DBEntry';
+import DBEntryField from './types/DBEntryField';
+declare type Props = {
+    entryFields: DBEntryField[];
+    idPropName: string;
+    titlePropName: string;
+    descriptionPropName: string;
+    itemListTitle: string;
+    itemName: string;
+    validateEntry?: (dbEntry: DBEntry) => Promise<void>;
+    modifyEntry?: (dbEntry: DBEntry) => Promise<DBEntry>;
+    disableEdit?: boolean;
+    collectionName: string;
+    adminsOnly?: boolean;
+    filterQuery?: {
+        [k: string]: any;
+    };
+};
+declare const DBEntryManagerPanel: React.FC<Props>;
+export default DBEntryManagerPanel;

package/dist/cjs/types/components/DBEntryManagerPanel/types/DBEntry.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Generic type for an object
+ * @author Yuen Ler Chow
+ */
+declare type DBEntry = {
+    [k: string]: any;
+};
+export default DBEntry;

package/dist/cjs/types/components/DBEntryManagerPanel/types/DBEntryField.d.ts

@@ -0,0 +1,49 @@
+import DBEntryFieldType from './DBEntryFieldType';
+/**
+ * A database entry input field
+ * @author Yuen Ler Chow
+ */
+declare type DBEntryField = ({
+    label: string;
+    objectKey: string;
+    placeholder: string;
+    lockAfterCreation?: boolean;
+    required?: boolean;
+} & ({
+    type: DBEntryFieldType.String;
+    minNumChars?: number;
+    maxNumChars?: number;
+    defaultValue?: string;
+    choices?: {
+        title: string;
+        value: string;
+    }[];
+} | {
+    type: DBEntryFieldType.Number;
+    minNumber?: number;
+    maxNumber?: number;
+    defaultValue?: number;
+} | {
+    type: DBEntryFieldType.StringArray;
+    minNumElements?: number;
+    maxNumElements?: number;
+    defaultValue?: string[];
+    choices?: {
+        title: string;
+        value: string;
+    }[];
+} | {
+    type: DBEntryFieldType.NumberArray;
+    minNumElements?: number;
+    maxNumElements?: number;
+    minNumber?: number;
+    maxNumber?: number;
+    defaultValue?: number[];
+} | {
+    type: DBEntryFieldType.Object;
+    defaultValue?: {
+        [k: string]: any;
+    };
+    subfields: DBEntryField[];
+}));
+export default DBEntryField;

package/dist/cjs/types/components/DBEntryManagerPanel/types/DBEntryFieldType.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Options for field types
+ * @author Yuen Ler Chow
+ */
+declare enum DBEntryFieldType {
+    String = "String",
+    Number = "Number",
+    Object = "Object",
+    StringArray = "StringArray",
+    NumberArray = "NumberArray"
+}
+export default DBEntryFieldType;

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

@@ -0,0 +1,40 @@
+import express from 'express';
+/**
+ * Interface for a collection in the database
+ * @author Yuen Ler Chow
+ */
+interface Collection {
+    /**
+     * 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
+ */
+declare const addDBEditorEndpoints: (opts: {
+    app: express.Application;
+    collectionName: string;
+    adminsOnly: boolean;
+    collection: Collection;
+}) => void;
+export default addDBEditorEndpoints;

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

@@ -1,8 +1,3 @@
-/**
- * Reset the cached version of canReview
- * @author Gabe Abrams
- */
-export declare const resetCanReviewCache: () => void;
 /**
  * Check if the current user can review logs
  * @author Gabe Abrams

package/dist/cjs/types/index.d.ts

@@ -16,6 +16,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 ErrorWithCode from './errors/ErrorWithCode';
 import MINUTE_IN_MS from './constants/MINUTE_IN_MS';
 import HOUR_IN_MS from './constants/HOUR_IN_MS';
@@ -55,6 +56,7 @@ import isMobileOrTablet from './helpers/isMobileOrTablet';
 import extractProp from './helpers/extractProp';
 import compareArraysByProp from './helpers/compareArraysByProp';
 import getLocalTimeInfo from './helpers/getLocalTimeInfo';
+import addDBEditorEndpoints from './helpers/addDBEditorEndpoints';
 import ModalButtonType from './types/ModalButtonType';
 import ModalSize from './types/ModalSize';
 import ModalType from './types/ModalType';
@@ -70,4 +72,7 @@ import LogBuiltInMetadata from './types/LogBuiltInMetadata';
 import LogMetadataType from './types/LogMetadataType';
 import IntelliTableColumn from './types/IntelliTableColumn';
 import PickableItem from './components/ItemPicker/types/PickableItem';
-export { AppWrapper, LoadingSpinner, ErrorBox, Modal, TabBox, RadioButton, CheckboxButton, ButtonInputGroup, SimpleDateChooser, Drawer, PopSuccessMark, PopFailureMark, PopPendingMark, CopiableBox, ItemPicker, LogReviewer, IntelliTable, CSVDownloadButton, alert, confirm, showFatalError, ErrorWithCode, MINUTE_IN_MS, HOUR_IN_MS, DAY_IN_MS, DynamicWord, abbreviate, avg, ceilToNumDecimals, floorToNumDecimals, forceNumIntoBounds, padDecimalZeros, padZerosLeft, roundToNumDecimals, sum, waitMs, getOrdinal, getTimeInfoInET, stubServerEndpoint, startMinWait, getHumanReadableDate, getPartOfDay, stringsToHumanReadableList, onlyKeepLetters, parallelLimit, getMonthName, genCSV, canReviewLogs, isMobileOrTablet, extractProp, compareArraysByProp, getLocalTimeInfo, initClient, visitServerEndpoint, logClientEvent, initServer, genRouteHandler, handleError, handleSuccess, initLogCollection, ModalButtonType, ModalSize, ModalType, ReactKitErrorCode, Variant, DayOfWeek, Log, LogType, LogSource, LogAction, LogBuiltInMetadata, LogMetadataType, IntelliTableColumn, PickableItem, ParamType, };
+import DBEntry from './components/DBEntryManagerPanel/types/DBEntry';
+import DBEntryField from './components/DBEntryManagerPanel/types/DBEntryField';
+import DBEntryFieldType from './components/DBEntryManagerPanel/types/DBEntryFieldType';
+export { AppWrapper, LoadingSpinner, ErrorBox, Modal, TabBox, RadioButton, CheckboxButton, ButtonInputGroup, SimpleDateChooser, Drawer, PopSuccessMark, PopFailureMark, PopPendingMark, CopiableBox, ItemPicker, LogReviewer, IntelliTable, CSVDownloadButton, DBEntryManagerPanel, alert, confirm, showFatalError, ErrorWithCode, MINUTE_IN_MS, HOUR_IN_MS, DAY_IN_MS, DynamicWord, abbreviate, avg, ceilToNumDecimals, floorToNumDecimals, forceNumIntoBounds, padDecimalZeros, padZerosLeft, roundToNumDecimals, sum, waitMs, getOrdinal, getTimeInfoInET, stubServerEndpoint, startMinWait, getHumanReadableDate, getPartOfDay, stringsToHumanReadableList, onlyKeepLetters, parallelLimit, getMonthName, genCSV, canReviewLogs, isMobileOrTablet, extractProp, compareArraysByProp, getLocalTimeInfo, initClient, visitServerEndpoint, logClientEvent, initServer, genRouteHandler, handleError, handleSuccess, initLogCollection, addDBEditorEndpoints, ModalButtonType, ModalSize, ModalType, ReactKitErrorCode, Variant, DayOfWeek, Log, LogType, LogSource, LogAction, LogBuiltInMetadata, LogMetadataType, IntelliTableColumn, PickableItem, DBEntry, DBEntryField, DBEntryFieldType, ParamType, };