dce-expresskit 4.0.0-beta-logreviewer.1

package/src/index.ts

@@ -0,0 +1,125 @@
+// Import dce-reactkit
+import {
+  abbreviate,
+  avg,
+  ceilToNumDecimals,
+  floorToNumDecimals,
+  forceNumIntoBounds,
+  padDecimalZeros,
+  padZerosLeft,
+  roundToNumDecimals,
+  sum,
+  waitMs,
+  getOrdinal,
+  getTimeInfoInET,
+  startMinWait,
+  getHumanReadableDate,
+  getPartOfDay,
+  stringsToHumanReadableList,
+  onlyKeepLetters,
+  parallelLimit,
+  getMonthName,
+  genCSV,
+  extractProp,
+  compareArraysByProp,
+  getLocalTimeInfo,
+  genCommaList,
+  prefixWithAOrAn,
+  everyAsync,
+  filterAsync,
+  forEachAsync,
+  mapAsync,
+  someAsync,
+  capitalize,
+  shuffleArray,
+  DayOfWeek,
+  Log,
+  LogType,
+  LogSource,
+  LogAction,
+  LogBuiltInMetadata,
+  LogMetadataType,
+  LogFunction,
+  MINUTE_IN_MS,
+  HOUR_IN_MS,
+  DAY_IN_MS,
+  ErrorWithCode,
+  ParamType,
+} from 'dce-reactkit';
+
+// Import helpers
+import initCrossServerCredentialCollection from './helpers/initCrossServerCredentialCollection';
+import initLogCollection from './helpers/initLogCollection';
+import initServer from './helpers/initServer';
+import genRouteHandler from './helpers/genRouteHandler';
+import handleError from './helpers/handleError';
+import handleSuccess from './helpers/handleSuccess';
+import addDBEditorEndpoints from './helpers/addDBEditorEndpoints';
+import visitEndpointOnAnotherServer from './helpers/visitEndpointOnAnotherServer';
+
+// Import types
+import CrossServerCredential from './types/CrossServerCredential';
+
+// Export each item
+export {
+  // Errors
+  ErrorWithCode,
+  // Constants
+  MINUTE_IN_MS,
+  HOUR_IN_MS,
+  DAY_IN_MS,
+  // Helpers
+  abbreviate,
+  avg,
+  ceilToNumDecimals,
+  floorToNumDecimals,
+  forceNumIntoBounds,
+  padDecimalZeros,
+  padZerosLeft,
+  roundToNumDecimals,
+  sum,
+  waitMs,
+  getOrdinal,
+  getTimeInfoInET,
+  startMinWait,
+  getHumanReadableDate,
+  getPartOfDay,
+  stringsToHumanReadableList,
+  onlyKeepLetters,
+  parallelLimit,
+  getMonthName,
+  genCSV,
+  extractProp,
+  compareArraysByProp,
+  genCommaList,
+  getLocalTimeInfo,
+  prefixWithAOrAn,
+  everyAsync,
+  filterAsync,
+  forEachAsync,
+  mapAsync,
+  someAsync,
+  capitalize,
+  shuffleArray,
+  // Server helpers
+  initServer,
+  genRouteHandler,
+  handleError,
+  handleSuccess,
+  initLogCollection,
+  initCrossServerCredentialCollection,
+  addDBEditorEndpoints,
+  visitEndpointOnAnotherServer,
+  // Types
+  DayOfWeek,
+  Log,
+  LogType,
+  LogSource,
+  LogAction,
+  LogBuiltInMetadata,
+  LogMetadataType,
+  LogFunction,
+  CrossServerCredential,
+  // Server types
+  ParamType,
+};

package/src/types/CrossServerCredential.ts

@@ -0,0 +1,16 @@
+/**
+ * Single cross-server credential
+ * @author Gabe Abrams
+ */
+type CrossServerCredential = {
+  // Description of the credential (human-readable)
+  description: string,
+  // The key of the credential
+  key: string,
+  // The encoded secret of the credential
+  encodedeSecret: string,
+  // The list of scopes for the credential
+  scopes: string[],
+};
+
+export default CrossServerCredential;

package/src/types/ExpressKitErrorCode.ts

@@ -0,0 +1,37 @@
+// Highest error code = DEK34
+
+/**
+ * List of error codes built into the express kit
+ * @author Gabe Abrams
+ */
+enum ExpressKitErrorCode {
+  // General errors
+  WrongCourse = 'DEK6',
+  NotTTM = 'DEK9',
+  NotAdmin = 'DEK10',
+  NotAllowedToReviewLogs = 'DEK11',
+  ThemeCheckedBeforeReactKitReady = 'DEK12',
+  InvalidParameter = 'DEK5',
+  MissingParameter = 'DEK4',
+
+  // Server-to-server requests
+  NotConnected = 'DEK14',
+  SelfSigned = 'DEK15',
+  ResponseParseError = 'DEK16',
+  SignedRequestUnparseable = 'DEK28',
+  SignedRequestInvalidCollection = 'DEK21',
+  SignedRequestInvalidCredential = 'DEK23',
+  SignedRequestInvalidScope = 'DEK22',
+  SignedRequestInvalidTimestamp = 'DEK24',
+  SignedRequestInvalidSignature = 'DEK25',
+  SignedRequestInvalidBody = 'DEK26',
+  CrossServerNoCredentialsToSignWith = 'DEK27',
+  CrossServerMissingSignedRequestInfo = 'DEK29',
+  CrossServerNoCredentialEncodingSalt = 'DEK30',
+  NoOauthLib = 'DEK31',
+  NoCryptoLib = 'DEK32',
+  InvalidCrossServerCredentialsFormat = 'DEK33',
+  UnknownCrossServerError = 'DEK34',
+}
+
+export default ExpressKitErrorCode;

package/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "esModuleInterop": true,
+    "noImplicitAny": true,
+    "noEmitOnError": true,
+    "removeComments": false,
+    "declaration": true,
+    "sourceMap": true,
+    "target": "es5",
+    "outDir": "./lib"
+  },
+  "include": [
+    "./src"
+  ],
+  "ts-node": {
+    "files": true
+  }
+}