dce-reactkit 3.12.1-beta-cross-server.1 → 3.12.1-beta-cross-server.3

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

@@ -1,5 +1,5 @@
 /**
- * Sign data with a private reactkit key, package it into a signed data pack
+ * Sign a request and get the new request params
  * @author Gabe Abrams
  * @param opts object containing all arguments
  * @param opts.method the method to sign
@@ -7,9 +7,9 @@
  * @param opts.params the data in the body to sign
  * @param opts.key the reactkit key to sign with
  * @param opts.secret the reactkit secret to sign with
- * @return the signed data
+ * @return augmented params for the request, including a signature, timestamp, and key
  */
-export declare const createSignedPack: (opts: {
+export declare const signRequest: (opts: {
     method: string;
     path: string;
     params: {
@@ -17,22 +17,24 @@ export declare const createSignedPack: (opts: {
     };
     key: string;
     secret: string;
-}) => string;
+}) => Promise<{
+    [key: string]: any;
+}>;
 /**
- * Parse signed pack. Throws an error if invalid
+ * Validate a signed request. Throws an error if invalid
  * @author Gabe Abrams
  * @param opts object containing all arguments
  * @param opts.method the method of the data validate
  * @param opts.path the http request path to validate
  * @param opts.scope the name of the scope to validate
- * @param opts.signedPack the signed data pack to validate
+ * @param opts.params the request data to validate
  * @returns parsed and validated params
  */
-export declare const parseSignedPack: (opts: {
+export declare const validateSignedRequest: (opts: {
     method: string;
     path: string;
     scope: string;
-    signedPack: string;
-}) => Promise<{
-    [key: string]: any;
-}>;
+    params: {
+        [key: string]: any;
+    };
+}) => Promise<void>;

package/dist/esm/types/helpers/visitEndpointOnAnotherServer/index.d.ts

@@ -5,10 +5,6 @@
  * @param opts.method the method of the endpoint
  * @param opts.path the path of the other server's endpoint
  * @param opts.host the host of the other server
- * @param [opts.key=process.env.REACTKIT_CROSS_SERVER_CREDENTIAL_KEY] reactkit cross-server
- *   credential key
- * @param [opts.secret=process.env.REACTKIT_CROSS_SERVER_CREDENTIAL_SECRET reactkit cross-server
- *   credential secret
  * @param [opts.params={}] query/body parameters to include
  * @param [opts.responseType=JSON] the response type from the other server
  */
@@ -16,8 +12,6 @@ declare const visitEndpointOnAnotherServer: (opts: {
     method: 'GET' | 'POST' | 'DELETE' | 'PUT';
     path: string;
     host: string;
-    key?: string | undefined;
-    secret?: string | undefined;
     params?: {
         [x: string]: any;
     } | undefined;

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

@@ -54,6 +54,7 @@ import onlyKeepLetters from './helpers/onlyKeepLetters';
 import parallelLimit from './helpers/parallelLimit';
 import logClientEvent, { setClientEventMetadataPopulator } from './helpers/logClientEvent';
 import initLogCollection from './server/initLogCollection';
+import initCrossServerCredentialCollection from './server/initCrossServerCredentialCollection';
 import getMonthName from './helpers/getMonthName';
 import genCSV from './helpers/genCSV';
 import canReviewLogs from './helpers/canReviewLogs';
@@ -100,4 +101,4 @@ 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 { AppWrapper, LoadingSpinner, ErrorBox, Modal, TabBox, RadioButton, CheckboxButton, ButtonInputGroup, SimpleDateChooser, Drawer, PopSuccessMark, PopFailureMark, PopPendingMark, CopiableBox, ItemPicker, LogReviewer, IntelliTable, CSVDownloadButton, DBEntryManagerPanel, Tooltip, ToggleSwitch, AutoscrollToBottomContainer, MultiSwitch, Dropdown, alert, prompt, 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, genCommaList, validateEmail, validatePhoneNumber, validateString, getLocalTimeInfo, idify, makeLinksClickable, prefixWithAOrAn, everyAsync, filterAsync, forEachAsync, mapAsync, someAsync, capitalize, shuffleArray, initClient, visitServerEndpoint, logClientEvent, addFatalErrorHandler, leaveToURL, combineClassNames, useForceRender, setClientEventMetadataPopulator, initServer, genRouteHandler, handleError, handleSuccess, initLogCollection, addDBEditorEndpoints, visitEndpointOnAnotherServer, ModalButtonType, ModalSize, ModalType, ReactKitErrorCode, Variant, DayOfWeek, Log, LogType, LogSource, LogAction, LogBuiltInMetadata, LogMetadataType, LogFunction, IntelliTableColumn, DropdownItemType, CrossServerCredential, PickableItem, DBEntry, DBEntryField, DBEntryFieldType, ParamType, };
+export { AppWrapper, LoadingSpinner, ErrorBox, Modal, TabBox, RadioButton, CheckboxButton, ButtonInputGroup, SimpleDateChooser, Drawer, PopSuccessMark, PopFailureMark, PopPendingMark, CopiableBox, ItemPicker, LogReviewer, IntelliTable, CSVDownloadButton, DBEntryManagerPanel, Tooltip, ToggleSwitch, AutoscrollToBottomContainer, MultiSwitch, Dropdown, alert, prompt, 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, genCommaList, validateEmail, validatePhoneNumber, validateString, getLocalTimeInfo, idify, makeLinksClickable, prefixWithAOrAn, everyAsync, filterAsync, forEachAsync, mapAsync, someAsync, capitalize, shuffleArray, initClient, visitServerEndpoint, logClientEvent, addFatalErrorHandler, leaveToURL, combineClassNames, useForceRender, setClientEventMetadataPopulator, initServer, genRouteHandler, handleError, handleSuccess, initLogCollection, initCrossServerCredentialCollection, addDBEditorEndpoints, visitEndpointOnAnotherServer, ModalButtonType, ModalSize, ModalType, ReactKitErrorCode, Variant, DayOfWeek, Log, LogType, LogSource, LogAction, LogBuiltInMetadata, LogMetadataType, LogFunction, IntelliTableColumn, DropdownItemType, CrossServerCredential, PickableItem, DBEntry, DBEntryField, DBEntryFieldType, ParamType, };

package/dist/esm/types/types/ReactKitErrorCode.d.ts

@@ -21,17 +21,19 @@ declare 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",
+    SignedRequestUnparseable = "DRK28",
+    SignedRequestInvalidCollection = "DRK21",
+    SignedRequestInvalidCredential = "DRK23",
+    SignedRequestInvalidScope = "DRK22",
+    SignedRequestInvalidTimestamp = "DRK24",
+    SignedRequestInvalidSignature = "DRK25",
+    SignedRequestInvalidBody = "DRK26",
     CrossServerNoCredentialsToSignWith = "DRK27",
-    CrossServerNoPack = "DRK29",
-    CrossServerNoCredentialEncodingSalt = "DRK30"
+    CrossServerMissingSignedRequestInfo = "DRK29",
+    CrossServerNoCredentialEncodingSalt = "DRK30",
+    NoOauthLib = "DRK31",
+    NoCryptoLib = "DRK32",
+    InvalidCrossServerCredentialsFormat = "DRK33",
+    UnknownCrossServerError = "DRK34"
 }
 export default ReactKitErrorCode;

package/dist/index.d.ts

@@ -1339,6 +1339,14 @@ declare const logClientEvent: LogFunction;
  */
 declare const initLogCollection: (Collection: any) => any;
 
+/**
+ * Initialize a cross-server credential collection given the dce-mango Collection class
+ * @author Gabe Abrams
+ * @param Collection the Collection class from dce-mango
+ * @returns initialized logCollection
+ */
+declare const initCrossServerCredentialCollection: (Collection: any) => any;
+
 /**
  * Get the name of a month given the month number (1 = January, etc.)
  *   If an invalid number is provided, we will treat it like January
@@ -1666,10 +1674,6 @@ declare const shuffleArray: <T>(arr: T[]) => T[];
  * @param opts.method the method of the endpoint
  * @param opts.path the path of the other server's endpoint
  * @param opts.host the host of the other server
- * @param [opts.key=process.env.REACTKIT_CROSS_SERVER_CREDENTIAL_KEY] reactkit cross-server
- *   credential key
- * @param [opts.secret=process.env.REACTKIT_CROSS_SERVER_CREDENTIAL_SECRET reactkit cross-server
- *   credential secret
  * @param [opts.params={}] query/body parameters to include
  * @param [opts.responseType=JSON] the response type from the other server
  */
@@ -1677,8 +1681,6 @@ declare const visitEndpointOnAnotherServer: (opts: {
     method: 'GET' | 'POST' | 'DELETE' | 'PUT';
     path: string;
     host: string;
-    key?: string | undefined;
-    secret?: string | undefined;
     params?: {
         [x: string]: any;
     } | undefined;
@@ -1708,18 +1710,20 @@ declare 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",
+    SignedRequestUnparseable = "DRK28",
+    SignedRequestInvalidCollection = "DRK21",
+    SignedRequestInvalidCredential = "DRK23",
+    SignedRequestInvalidScope = "DRK22",
+    SignedRequestInvalidTimestamp = "DRK24",
+    SignedRequestInvalidSignature = "DRK25",
+    SignedRequestInvalidBody = "DRK26",
     CrossServerNoCredentialsToSignWith = "DRK27",
-    CrossServerNoPack = "DRK29",
-    CrossServerNoCredentialEncodingSalt = "DRK30"
+    CrossServerMissingSignedRequestInfo = "DRK29",
+    CrossServerNoCredentialEncodingSalt = "DRK30",
+    NoOauthLib = "DRK31",
+    NoCryptoLib = "DRK32",
+    InvalidCrossServerCredentialsFormat = "DRK33",
+    UnknownCrossServerError = "DRK34"
 }
 
 /**
@@ -1763,4 +1767,4 @@ type CrossServerCredential = {
     scopes: string[];
 };
 
-export { AppWrapper, AutoscrollToBottomContainer, ButtonInputGroup, CSVDownloadButton, CheckboxButton, CopiableBox, CrossServerCredential, DAY_IN_MS, DBEntry, DBEntryField, DBEntryFieldType, DBEntryManagerPanel, DayOfWeek, Drawer, Dropdown, DropdownItemType, DynamicWord, ErrorBox, ErrorWithCode, HOUR_IN_MS, IntelliTable, IntelliTableColumn, ItemPicker, LoadingSpinner, Log, LogAction, LogBuiltInMetadata, LogFunction, LogMetadataType, LogReviewer, LogSource, LogType, MINUTE_IN_MS, Modal, ModalButtonType, ModalSize, ModalType, MultiSwitch, ParamType, PickableItem, PopFailureMark, PopPendingMark, PopSuccessMark, RadioButton, ReactKitErrorCode, SimpleDateChooser, TabBox, ToggleSwitch, Tooltip, Variant, abbreviate, addDBEditorEndpoints, addFatalErrorHandler, alert, avg, canReviewLogs, capitalize, ceilToNumDecimals, combineClassNames, compareArraysByProp, confirm, everyAsync, extractProp, filterAsync, floorToNumDecimals, forEachAsync, forceNumIntoBounds, genCSV, genCommaList, genRouteHandler, getHumanReadableDate, getLocalTimeInfo, getMonthName, getOrdinal, getPartOfDay, getTimeInfoInET, handleError, handleSuccess, idify, initClient, initLogCollection, initServer, isMobileOrTablet, leaveToURL, logClientEvent, makeLinksClickable, mapAsync, onlyKeepLetters, padDecimalZeros, padZerosLeft, parallelLimit, prefixWithAOrAn, prompt, roundToNumDecimals, setClientEventMetadataPopulator, showFatalError, shuffleArray, someAsync, startMinWait, stringsToHumanReadableList, stubServerEndpoint, sum, useForceRender, validateEmail, validatePhoneNumber, validateString, visitEndpointOnAnotherServer, visitServerEndpoint, waitMs };
+export { AppWrapper, AutoscrollToBottomContainer, ButtonInputGroup, CSVDownloadButton, CheckboxButton, CopiableBox, CrossServerCredential, DAY_IN_MS, DBEntry, DBEntryField, DBEntryFieldType, DBEntryManagerPanel, DayOfWeek, Drawer, Dropdown, DropdownItemType, DynamicWord, ErrorBox, ErrorWithCode, HOUR_IN_MS, IntelliTable, IntelliTableColumn, ItemPicker, LoadingSpinner, Log, LogAction, LogBuiltInMetadata, LogFunction, LogMetadataType, LogReviewer, LogSource, LogType, MINUTE_IN_MS, Modal, ModalButtonType, ModalSize, ModalType, MultiSwitch, ParamType, PickableItem, PopFailureMark, PopPendingMark, PopSuccessMark, RadioButton, ReactKitErrorCode, SimpleDateChooser, TabBox, ToggleSwitch, Tooltip, Variant, abbreviate, addDBEditorEndpoints, addFatalErrorHandler, alert, avg, canReviewLogs, capitalize, ceilToNumDecimals, combineClassNames, compareArraysByProp, confirm, everyAsync, extractProp, filterAsync, floorToNumDecimals, forEachAsync, forceNumIntoBounds, genCSV, genCommaList, genRouteHandler, getHumanReadableDate, getLocalTimeInfo, getMonthName, getOrdinal, getPartOfDay, getTimeInfoInET, handleError, handleSuccess, idify, initClient, initCrossServerCredentialCollection, initLogCollection, initServer, isMobileOrTablet, leaveToURL, logClientEvent, makeLinksClickable, mapAsync, onlyKeepLetters, padDecimalZeros, padZerosLeft, parallelLimit, prefixWithAOrAn, prompt, roundToNumDecimals, setClientEventMetadataPopulator, showFatalError, shuffleArray, someAsync, startMinWait, stringsToHumanReadableList, stubServerEndpoint, sum, useForceRender, validateEmail, validatePhoneNumber, validateString, visitEndpointOnAnotherServer, visitServerEndpoint, waitMs };

package/genEncodedSecret.ts

@@ -1,13 +1,26 @@
-// Import jwt
-import jwt from 'jwt-simple';
+// Import crypto
+import crypto from 'crypto';
+
+const chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
 
 // Get args
-let { REACTKIT_CRED_ENCODING_SALT } = process.env;
+const REACTKIT_CRED_ENCODING_SALT = process.env.npm_config_salt;
 if (!REACTKIT_CRED_ENCODING_SALT) {
-  REACTKIT_CRED_ENCODING_SALT = process.env.npm_config_salt;
+  console.log('Encoding salt is required: --salt=...');
+  process.exit(1);
 }
-if (!REACTKIT_CRED_ENCODING_SALT) {
-  console.log('REACTKIT_CRED_ENCODING_SALT is required either as an environment variable or as: --salt=...');
+
+// Get the key
+let key = process.env.npm_config_key;
+if (!key) {
+  console.log('Key is required: --key=...');
+  process.exit(1);
+}
+
+// Get the description
+let description = process.env.npm_config_description;
+if (!description) {
+  console.log('Description is required: --description=...');
   process.exit(1);
 }
 
@@ -15,14 +28,57 @@ if (!REACTKIT_CRED_ENCODING_SALT) {
 let secret = process.env.npm_config_secret;
 if (!secret) {
   // Generate a random secret
-  const chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
   secret = '';
-  for (let i = 0; i < 64; i++) {
+  for (let i = 0; i < 32; i++) {
     secret += chars.charAt(Math.floor(Math.random() * chars.length));
   }
   console.log('Generated a random secret. If you have one in mind, use --secret=...');
 }
 
-// Encode the secret
-const encodedSecret = jwt.encode(secret, REACTKIT_CRED_ENCODING_SALT);
-console.log(`\nNew Secret Generated!\n\nSecret: ${secret}\n\nEncoded Secret: ${encodedSecret}`);
+// Get the host name
+const host = process.env.npm_config_host;
+if (!host) {
+  console.log('Host of the receiving server is required: --host=...');
+  process.exit(1);
+}
+
+// Encryption process based on:
+// https://medium.com/@tony.infisical/guide-to-nodes-crypto-module-for-encryption-decryption-65c077176980
+
+// Create a random initialization vector
+const iv = crypto.randomBytes(12).toString('base64');
+
+// Create a cipher
+const cipher = crypto.createCipheriv(
+  'aes-256-gcm',
+  Buffer.from(secret, 'base64'),
+  Buffer.from(iv, 'base64'),
+);
+
+// Encrypt the string
+let ciphertext = cipher.update(secret, 'utf8', 'base64');
+
+// Finalize the encryption
+ciphertext += cipher.final('base64');
+
+// Get the authentication tag
+const tag = cipher.getAuthTag();
+
+// JSONify the encrypted data
+const encryptionPack = encodeURIComponent(JSON.stringify({
+  ciphertext,
+  iv,
+  tag,
+}));
+
+// Show the encrypted data
+console.log('\n\n');
+console.log('––––– Done! What\'s Next: –––––');
+console.log('');
+console.log('On the server *sending* the requests, append the following to the REACTKIT_CROSS_SERVER_CREDENTIALS env var:');
+console.log(`|${host}:${key}:${secret}|`);
+console.log('');
+console.log('On the server *receiving* the requests, add an entry to the "CrossServerCredential" collection:');
+console.log(`{ "description": "${description}", "key": "${key}", "encodedeSecret": "${encryptionPack}", "scopes": [] }`);
+console.log('');
+console.log('For all scopes that the server should have access to, add them to the "scopes" array.');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dce-reactkit",
-  "version": "3.12.1-beta-cross-server.1",
+  "version": "3.12.1-beta-cross-server.3",
   "description": "Shared components for Harvard DCE apps",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -25,7 +25,6 @@
   },
   "homepage": "https://github.com/harvard-edtech/dce-reactkit#readme",
   "dependencies": {
-    "jwt-simple": "^0.5.6",
     "qs": "^6.x.x",
     "react-select": "^5.7.3"
   },
@@ -49,6 +48,7 @@
     "@types/jest": "^28.1.7",
     "@types/jwt-simple": "^0.5.36",
     "@types/node": "^20.2.5",
+    "@types/oauth-signature": "^1.5.2",
     "@types/react": "^17.0.7",
     "@typescript-eslint/eslint-plugin": "^5.59.9",
     "@typescript-eslint/parser": "^5.59.9",
@@ -61,6 +61,7 @@
     "eslint-plugin-react-hooks": "^4.6.0",
     "jest": "^28.1.3",
     "jest-environment-jsdom": "^28.1.3",
+    "oauth-signature": "^1.5.0",
     "raixa": "^1.0.21",
     "rollup": "^2.70.2",
     "rollup-plugin-dts": "^4.2.1",

package/rollup.config.js

@@ -27,6 +27,7 @@ export default [
       typescript({ tsconfig: "./tsconfig.json" }),
       sourcemaps(),
     ],
+    inlineDynamicImports: true,
     external: [
       ...Object.keys(packageJson.dependencies || {}),
       ...Object.keys(packageJson.peerDependencies || {}),
@@ -36,6 +37,7 @@ export default [
     input: "dist/esm/types/index.d.ts",
     output: [{ file: "dist/index.d.ts", format: "esm" }],
     plugins: [dts()],
+    inlineDynamicImports: true,
     external: [
       ...Object.keys(packageJson.dependencies || {}),
       ...Object.keys(packageJson.peerDependencies || {}),