dce-reactkit 3.11.4 → 3.12.1-beta-cross-server.2

package/src/server/initServer.ts

@@ -27,6 +27,9 @@ let _cacclGetLaunchInfo: GetLaunchInfoFunction;
 // Stored copy of dce-mango log collection
 let _logCollection: any;
 
+// Stored copy of dce-mango cross-server credential collection
+let _crossServerCredentialCollection: any;
+
 /*------------------------------------------------------------------------*/
 /*                                 Helpers                                */
 /*------------------------------------------------------------------------*/
@@ -58,6 +61,16 @@ export const internalGetLogCollection = () => {
   return _logCollection ?? null;
 };
 
+/**
+ * Get cross-server credential collection
+ * @author Gabe Abrams
+ * @return cross-server credential collection if one was included during launch or null
+ *   if we don't have a cross-server credential collection (yet)
+ */
+export const internalGetCrossServerCredentialCollection = () => {
+  return _crossServerCredentialCollection ?? null;
+};
+
 /*------------------------------------------------------------------------*/
 /*                                  Main                                  */
 /*------------------------------------------------------------------------*/
@@ -78,6 +91,9 @@ export const internalGetLogCollection = () => {
  *   userIds are allowed to review logs. If a dce-mango collection, only
  *   Canvas admins with entries in that collection ({ userId, ...}) are allowed
  *   to review logs
+ * @param [opts.crossServerCredentialCollection] mongo collection from dce-mango to use for
+ *   storing cross-server credentials. If none is included, cross-server credentials
+ *   are not supported
  */
 const initServer = (
   opts: {
@@ -85,10 +101,12 @@ const initServer = (
     getLaunchInfo: GetLaunchInfoFunction,
     logCollection?: any,
     logReviewAdmins?: (number[] | any),
+    crossServerCredentialCollection?: any,
   },
 ) => {
   _cacclGetLaunchInfo = opts.getLaunchInfo;
   _logCollection = opts.logCollection;
+  _crossServerCredentialCollection = opts.crossServerCredentialCollection;
 
   /*----------------------------------------*/
   /*                Logging                 */

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/ReactKitErrorCode.tsx

@@ -1,4 +1,4 @@
-// Highest error code = DRK18
+// Highest error code = DRK30
 
 /**
  * List of error codes built into the react kit
@@ -25,6 +25,18 @@ enum ReactKitErrorCode {
   NotConnected = 'DRK14',
   SelfSigned = 'DRK15',
   ResponseParseError = 'DRK16',
+  PackUnparseable = 'DRK28',
+  PackInvalidMethod = 'DRK19',
+  PackInvalidPath = 'DRK20',
+  PackInvalidCollection = 'DRK21',
+  PackInvalidCredential = 'DRK23',
+  PackInvalidScope = 'DRK22',
+  PackInvalidTimestamp = 'DRK24',
+  PackInvalidSignature = 'DRK25',
+  PackInvalidBody = 'DRK26',
+  CrossServerNoCredentialsToSignWith = 'DRK27',
+  CrossServerNoPack = 'DRK29',
+  CrossServerNoCredentialEncodingSalt = 'DRK30',
 }
 
 export default ReactKitErrorCode;

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

@@ -1,10 +0,0 @@
-/**
- * Get number of words in string
- * @author Gardenia Liu
- * @author Allison Zhang
- * @author Gabe Abrams
- * @param text the string to check
- * @returns number of words in the string
- */
-declare const getWordCount: (text: string) => number;
-export default getWordCount;

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

@@ -1,10 +0,0 @@
-/**
- * Get number of words in string
- * @author Gardenia Liu
- * @author Allison Zhang
- * @author Gabe Abrams
- * @param text the string to check
- * @returns number of words in the string
- */
-declare const getWordCount: (text: string) => number;
-export default getWordCount;

package/src/helpers/getWordCount.ts

@@ -1,26 +0,0 @@
-const punctuationRegex = /[!@#$%^&*(),.?\/;:'"\-\[\]]/g;
-
-/**
- * Get number of words in string 
- * @author Gardenia Liu
- * @author Allison Zhang
- * @author Gabe Abrams
- * @param text the string to check
- * @returns number of words in the string
- */
-const getWordCount = (text: string): number => {
-  const trimmedTextWithoutPunctuation = (
-    text
-      // Remove leading and trailing whitespace
-      .trim()
-      // Remove punctuation
-      .replace(punctuationRegex, '')
-  );
-  if (trimmedTextWithoutPunctuation.length === 0) {
-    return 0;
-  }
-
-  return trimmedTextWithoutPunctuation.split(/\s+/g).length;
-};
-
-export default getWordCount;