dce-reactkit 3.0.0-beta.1 → 3.0.0-beta.2

package/src/helpers/padZerosLeft.tsx

@@ -0,0 +1,21 @@
+/**
+ * Pad a number with zeros on the left (e.g. 5 becomes 05 with 2 digit padding)
+ * @author Gabe Abrams
+ * @param num the number to pad
+ * @param numDigits the minimum number of digits before the decimal
+ * @returns padded number
+ */
+const padZerosLeft = (num: number, numDigits: number): string => {
+  // Convert to string
+  let out = String(num);
+
+  // Add zeros
+  while (out.split('.')[0].length < numDigits) {
+    out = `0${out}`;
+  }
+
+  // Return
+  return out;
+};
+
+export default padZerosLeft;

package/src/helpers/roundToNumDecimals.tsx

@@ -0,0 +1,13 @@
+/**
+ * Round a number to a certain number of decimals
+ * @author Gabe Abrams
+ * @param num the number to round
+ * @param numDecimals the number of decimals to round to
+ * @returns rounded number
+ */
+const roundToNumDecimals = (num: number, numDecimals: number): number => {
+  const rounder = 10 ** numDecimals;
+  return (Math.round(num * rounder) / rounder);
+};
+
+export default roundToNumDecimals;

package/src/helpers/sum.tsx

@@ -0,0 +1,16 @@
+/**
+ * Sum the numbers in an array
+ * @author Gabe Abrams
+ * @param nums the numbers to sum
+ * @returns the sum of the numbers
+ */
+const sum = (nums: number[]): number => {
+  return nums.reduce(
+    (a: number, b: number) => {
+      return (a + b);
+    },
+    0,
+  );
+};
+
+export default sum;

package/src/helpers/waitMs.tsx

@@ -0,0 +1,12 @@
+/**
+ * Wait for a certain number of ms
+ * @author Gabe Abrams
+ * @param ms number of ms to wait
+ */
+const waitMs = async (ms = 0) => {
+  return new Promise((resolve) => {
+    setTimeout(resolve, ms);
+  });
+};
+
+export default waitMs;

package/src/index.ts

@@ -0,0 +1,61 @@
+// Import components
+import AppWrapper, { alert, confirm, showFatalError } from './components/AppWrapper';
+import LoadingSpinner from './components/LoadingSpinner';
+import ErrorBox from './components/ErrorBox';
+import Modal from './components/Modal';
+import TabBox from './components/TabBox';
+
+// Import errors
+import ErrorWithCode from './errors/ErrorWithCode';
+
+// Import helpers
+import abbreviate from './helpers/abbreviate';
+import avg from './helpers/avg';
+import ceilToNumDecimals from './helpers/ceilToNumDecimals';
+import floorToNumDecimals from './helpers/floorToNumDecimals';
+import forceNumIntoBounds from './helpers/forceNumIntoBounds';
+import padDecimalZeros from './helpers/padDecimalZeros';
+import padZerosLeft from './helpers/padZerosLeft';
+import roundToNumDecimals from './helpers/roundToNumDecimals';
+import sum from './helpers/sum';
+import waitMs from './helpers/waitMs';
+
+// Import types
+import ModalButtonType from './types/ModalButtonType';
+import ModalSize from './types/ModalSize';
+import ModalType from './types/ModalType';
+import ReactKitErrorCode from './types/ReactKitErrorCode';
+import Variant from './types/Variant';
+
+// Export each item
+export {
+  // Components
+  AppWrapper,
+  LoadingSpinner,
+  ErrorBox,
+  Modal,
+  TabBox,
+  // Global functions
+  alert,
+  confirm,
+  showFatalError,
+  // Errors
+  ErrorWithCode,
+  // Helpers
+  abbreviate,
+  avg,
+  ceilToNumDecimals,
+  floorToNumDecimals,
+  forceNumIntoBounds,
+  padDecimalZeros,
+  padZerosLeft,
+  roundToNumDecimals,
+  sum,
+  waitMs,
+  // Types
+  ModalButtonType,
+  ModalSize,
+  ModalType,
+  ReactKitErrorCode,
+  Variant,
+};

package/src/types/ModalButtonType.tsx

@@ -0,0 +1,18 @@
+/**
+ * Types of buttons in the modal
+ * @author Gabe Abrams
+ */
+enum ModalButtonType {
+  Okay = 'okay',
+  Cancel = 'cancel',
+  Yes = 'yes',
+  No = 'no',
+  Abandon = 'abandon',
+  GoBack = 'goBack',
+  Continue = 'continue',
+  ImSure = 'imSure',
+  Delete = 'delete',
+  Confirm = 'confirm',
+}
+
+export default ModalButtonType;

package/src/types/ModalSize.tsx

@@ -0,0 +1,12 @@
+/**
+ * Modal sizes
+ * @author Gabe Abrams
+ */
+enum ModalSize {
+  Small = 'sm',
+  Medium = 'md',
+  Large = 'lg',
+  ExtraLarge = 'xl',
+}
+
+export default ModalSize;

package/src/types/ModalType.tsx

@@ -0,0 +1,17 @@
+/**
+ * Types of modals
+ * @author Gabe Abrams
+ */
+enum ModalType {
+  Okay = 'okay', // [Okay]
+  OkayCancel = 'okay-cancel', // [Okay] [Cancel]
+  YesNo = 'yes-no', // [Yes] [No]
+  YesNoCancel = 'yes-no-cancel', // [Yes] [No] [Cancel]
+  AbandonGoBack = 'abandon-goBack', // [Abandon Changes] [Go Back]
+  ImSureCancel = 'imSure-cancel', // [I am sure] [Cancel]
+  DeleteCancel = 'delete-cancel', // [Yes, Delete] [Cancel]
+  ConfirmCancel = 'confirm-cancel', // [Confirm] [Cancel]
+  NoButtons = '-', // No buttons
+}
+
+export default ModalType;

package/src/types/ReactKitErrorCode.tsx

@@ -0,0 +1,16 @@
+// Highest error code = DRK2
+
+/**
+ * List of error codes built into the react kit
+ * @author Gabe Abrams
+ */
+enum ReactKitErrorCode {
+  NoResponse = 'DRK1',
+  NoCode = 'DRK2',
+  SessionExpired = 'DRK3',
+  MissingParameter = 'DRK4',
+  InvalidParameter = 'DRK5',
+  WrongCourse = 'DRK6',
+}
+
+export default ReactKitErrorCode;

package/src/types/Variant.tsx

@@ -0,0 +1,16 @@
+/**
+ * Bootstrap variants
+ * @author Gabe Abrams
+ */
+enum Variant {
+  Primary = 'primary',
+  Secondary = 'secondary',
+  Success = 'success',
+  Warning = 'warning',
+  Info = 'info',
+  Danger = 'danger',
+  Light = 'light',
+  Dark = 'dark',
+}
+
+export default Variant;

package/tsconfig.json

@@ -0,0 +1,23 @@
+{
+  "compilerOptions": {
+    "target": "es2016",
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "skipLibCheck": true,
+
+    "jsx": "react",
+    "module": "ESNext",
+    "declaration": true,
+    "declarationDir": "types",
+    "sourceMap": true,
+    "outDir": "dist",
+    "moduleResolution": "node",
+    "allowSyntheticDefaultImports": true,
+    "emitDeclarationOnly": true
+  },
+
+  "include": [
+    "./src/**/*"
+  ]
+}