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

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

@@ -0,0 +1,38 @@
+/**
+ * Sign data with a private reactkit key, package it into a signed data pack
+ * @author Gabe Abrams
+ * @param opts object containing all arguments
+ * @param opts.method the method to sign
+ * @param opts.path the http request path
+ * @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
+ */
+export declare const createSignedPack: (opts: {
+    method: string;
+    path: string;
+    params: {
+        [key: string]: any;
+    };
+    key: string;
+    secret: string;
+}) => string;
+/**
+ * Parse signed pack. 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
+ * @returns parsed and validated params
+ */
+export declare const parseSignedPack: (opts: {
+    method: string;
+    path: string;
+    scope: string;
+    signedPack: string;
+}) => Promise<{
+    [key: string]: any;
+}>;

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

@@ -7,14 +7,15 @@ import LogFunction from '../types/LogFunction';
  * @param opts.paramTypes map containing the types for each parameter that is
  *   included in the request (map: param name => type)
  * @param opts.handler function that processes the request
- * @param [opts.skipSessionCheck] if true, skip the session check (allow users
- *   to not be logged in and launched via LTI)
- * @param [opts.allowedHosts] if included, only allow requests from these hosts
- *   (start a hostname with a "*" to only check the end of the hostname)
- *   you can include just one string instead of an array
- * @param [opts.bannedHosts] if included, do not allow requests from these hosts
- *   (start a hostname with a "*" to only check the end of the hostname)
- *   you can include just one string instead of an array
+ * @param [opts.crossServerScope] the scope associated with this endpoint.
+ *   If defined, this is a cross-server endpoint, which will never
+ *   have any launch data, will never check Canvas roles or launch status, and will
+ *   instead use scopes and reactkit credentials to sign and validate requests.
+ *   Never start the path with /api/ttm or /api/admin if the endpoint is a cross-server
+ *   endpoint because those roles will not be validated
+ * @param [opts.skipSessionCheck=true if crossServerScope defined] if true, skip
+ *   the session check (allow users to not be logged in and launched via LTI).
+ *   If crossServerScope is defined, this is always true
  * @param [opts.unhandledErrorMessagePrefix] if included, when an error that
  *   is not of type ErrorWithCode is thrown, the client will receive an error
  *   where the error message is prefixed with this string. For example,
@@ -68,9 +69,8 @@ declare const genRouteHandler: (opts: {
         }) => void;
         logServerEvent: LogFunction;
     }) => any;
+    crossServerScope?: string | undefined;
     skipSessionCheck?: boolean | undefined;
-    allowedHosts?: string | string[] | undefined;
-    bannedHosts?: string | string[] | undefined;
     unhandledErrorMessagePrefix?: string | undefined;
 }) => (req: any, res: any, next: () => void) => Promise<undefined>;
 export default genRouteHandler;

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

@@ -1,24 +1,26 @@
 /**
- * Send a server-to-server request from this sever to another server that uses
- *   dce-reactkit [for server only]
+ * Visit an endpoint on another server
  * @author Gabe Abrams
  * @param opts object containing all arguments
- * @param opts.host - the host of the other server
- * @param opts.path - the path of the other server's endpoint
- * @param [opts.method=GET] - the method of the endpoint
- * @param [opts.params] - query/body parameters to include
- * @param [opts.headers] - headers to include
- * @returns response from server
+ * @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
  */
 declare const visitEndpointOnAnotherServer: (opts: {
-    host: string;
+    method: 'GET' | 'POST' | 'DELETE' | 'PUT';
     path: string;
-    method?: "GET" | "POST" | "DELETE" | "PUT" | undefined;
+    host: string;
+    key?: string | undefined;
+    secret?: string | undefined;
     params?: {
         [x: string]: any;
     } | undefined;
-    headers?: {
-        [x: string]: any;
-    } | undefined;
+    responseType?: "Text" | "JSON" | undefined;
 }) => Promise<any>;
 export default visitEndpointOnAnotherServer;

package/dist/cjs/types/helpers/visitEndpointOnAnotherServer/sendServerToServerRequest.d.ts

@@ -6,9 +6,6 @@
  * @param [opts.host] host to send request to
  * @param [opts.method=GET] http method to use
  * @param [opts.params] body/data to include in the request
- * @param [opts.headers] headers to include in the request
- * @param [opts.sendCrossDomainCredentials=true if in development mode] if true,
- *   send cross-domain credentials even if not in dev mode
  * @param [opts.responseType=JSON] expected response type
  * @returns { body, status, headers } on success
  */
@@ -19,9 +16,6 @@ declare const sendServerToServerRequest: (opts: {
     params?: {
         [x: string]: any;
     } | undefined;
-    headers?: {
-        [x: string]: any;
-    } | undefined;
     responseType?: "Text" | "JSON" | undefined;
 }) => Promise<{
     body: any;

package/dist/cjs/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';
@@ -79,7 +80,6 @@ import someAsync from './helpers/asyncArrayFunctions/someAsync';
 import capitalize from './helpers/capitalize';
 import shuffleArray from './helpers/shuffleArray';
 import visitEndpointOnAnotherServer from './helpers/visitEndpointOnAnotherServer';
-import getWordCount from './helpers/getWordCount';
 import ModalButtonType from './types/ModalButtonType';
 import ModalSize from './types/ModalSize';
 import ModalType from './types/ModalType';
@@ -96,8 +96,9 @@ import LogMetadataType from './types/LogMetadataType';
 import LogFunction from './types/LogFunction';
 import IntelliTableColumn from './types/IntelliTableColumn';
 import DropdownItemType from './types/DropdownItemType';
+import CrossServerCredential from './types/CrossServerCredential';
 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, getWordCount, 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, 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/cjs/types/server/initCrossServerCredentialCollection.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 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;
+export default initCrossServerCredentialCollection;

package/dist/cjs/types/server/initServer.d.ts

@@ -16,6 +16,13 @@ export declare const cacclGetLaunchInfo: GetLaunchInfoFunction;
  *   have a log collection (yet)
  */
 export declare const internalGetLogCollection: () => any;
+/**
+ * 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 declare const internalGetCrossServerCredentialCollection: () => any;
 /**
  * Prepare dce-reactkit to run on the server
  * @author Gabe Abrams
@@ -32,11 +39,15 @@ export declare const internalGetLogCollection: () => any;
  *   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
  */
 declare const initServer: (opts: {
     app: any;
     getLaunchInfo: GetLaunchInfoFunction;
     logCollection?: any;
     logReviewAdmins?: (number[] | any);
+    crossServerCredentialCollection?: any;
 }) => void;
 export default initServer;

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

@@ -0,0 +1,11 @@
+/**
+ * Single cross-server credential
+ * @author Gabe Abrams
+ */
+type CrossServerCredential = {
+    description: string;
+    key: string;
+    encodedeSecret: string;
+    scopes: string[];
+};
+export default CrossServerCredential;

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

@@ -20,6 +20,18 @@ declare enum ReactKitErrorCode {
     SessionExpiredMessageGottenBeforeReactKitReady = "DRK13",
     NotConnected = "DRK14",
     SelfSigned = "DRK15",
-    ResponseParseError = "DRK16"
+    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;