dce-reactkit 3.12.3 → 4.0.0-beta.1

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

@@ -1,41 +0,0 @@
-import express from 'express';
-/**
- * Interface for a collection in the database
- * @author Yuen Ler Chow
- */
-type DCEMangoCollection = {
-    /**
-     * Find all items in the collection that match the filter query
-     * @param filterQuery query for the filter
-     * @returns list of items that match the filter query
-     */
-    find: (filterQuery: any) => Promise<any[]>;
-    /**
-     * Insert an item into the collection
-     * @param item the item to insert
-     */
-    insert: (item: any) => Promise<void>;
-    /**
-     * Delete an item in the collection
-     * @param id the id of the item to delete
-     */
-    delete: (filterQuery: {
-        id: string;
-    }) => Promise<void>;
-};
-/**
- * Add all routes for the DBEditor
- * @author Yuen Ler Chow
- * @param opts object containing all arguments
- * @param opts.app express app to add routes too
- * @param opts.collectionName the name of the collection
- * @param opts.adminsOnly true if the endpoint is for admins only
- * @param opts.collection dce-mango db collection
- */
-declare const addDBEditorEndpoints: (opts: {
-    app: express.Application;
-    collectionName: string;
-    adminsOnly: boolean;
-    collection: DCEMangoCollection;
-}) => void;
-export default addDBEditorEndpoints;

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

@@ -1,76 +0,0 @@
-import ParamType from '../types/ParamType';
-import LogFunction from '../types/LogFunction';
-/**
- * Generate an express API route handler
- * @author Gabe Abrams
- * @param opts object containing all arguments
- * @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.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,
- *   if unhandledErrorMessagePrefix is
- *   'While saving progress, we encountered an error:'
- *   and the error is 'progressInfo is not an object',
- *   the client will receive an error with the message
- *   'While saving progress, we encountered an error: progressInfo is not an object'
- * @returns express route handler that takes the following arguments:
- *   params (map: param name => value),
- *   req (express request object),
- *   next (express next function),
- *   send (a function that sends a string to the client),
- *   redirect (takes a url and redirects the user to that url),
- *   renderErrorPage (shows a static error page to the user),
- *   renderInfoPage (shows a static info page to the user),
- *   renderCustomHTML (renders custom html and sends it to the user),
- *   and returns the value to send to the client as a JSON API response, or
- *   calls next() or redirect(...) or send(...) or renderErrorPage(...).
- *   Note: params also has userId, userFirstName,
- *   userLastName, userEmail, userAvatarURL, isLearner, isTTM, isAdmin,
- *   and any other variables that
- *   are directly added to the session, if the user does have a session.
- */
-declare const genRouteHandler: (opts: {
-    paramTypes?: {
-        [k: string]: ParamType;
-    } | undefined;
-    handler: (opts: {
-        params: {
-            [k: string]: any;
-        };
-        req: any;
-        next: () => void;
-        redirect: (pathOrURL: string) => void;
-        send: (text: string, status?: number) => void;
-        renderErrorPage: (opts?: {
-            title?: string;
-            description?: string;
-            code?: string;
-            pageTitle?: string;
-            status?: number;
-        }) => void;
-        renderInfoPage: (opts: {
-            title: string;
-            body: string;
-        }) => void;
-        renderCustomHTML: (opts: {
-            html: string;
-            status?: number;
-        }) => void;
-        logServerEvent: LogFunction;
-    }) => any;
-    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/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/cjs/types/helpers/handleError.d.ts

@@ -1,18 +0,0 @@
-/**
- * Handle an error and respond to the client
- * @author Gabe Abrams
- * @param res express response
- * @param error error info
- * @param opts.err the error to send to the client
- *   or the error message
- * @param [opts.code] an error code (only used if err.code is not
- *   included)
- * @param [opts.status=500] the https status code to use
- *   defined)
- */
-declare const handleError: (res: any, error: ({
-    message: any;
-    code?: string;
-    status?: number;
-} | Error | string | any)) => undefined;
-export default handleError;

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

@@ -1,8 +0,0 @@
-/**
- * Send successful API response
- * @author Gabe Abrams
- * @param res express response
- * @param body the body of the response to send to the client
- */
-declare const handleSuccess: (res: any, body: any) => undefined;
-export default handleSuccess;

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

@@ -1,17 +0,0 @@
-/**
- * Perform a rudimentary parsing of the user's browser agent string
- * @author Gabe Abrams
- * @param userAgent the user's browser agent
- * @returns user info
- */
-declare const parseUserAgent: (userAgent: string) => {
-    browser: {
-        name: string;
-        version: string;
-    };
-    device: {
-        isMobile: boolean;
-        os: string;
-    };
-};
-export default parseUserAgent;

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

@@ -1,24 +0,0 @@
-/**
- * Send a server-to-server request from this sever to another server that uses
- *   dce-reactkit [for server only]
- * @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
- */
-declare const visitEndpointOnAnotherServer: (opts: {
-    host: string;
-    path: string;
-    method?: "GET" | "POST" | "DELETE" | "PUT" | undefined;
-    params?: {
-        [x: string]: any;
-    } | undefined;
-    headers?: {
-        [x: string]: any;
-    } | undefined;
-}) => Promise<any>;
-export default visitEndpointOnAnotherServer;

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

@@ -1,33 +0,0 @@
-/**
- * Sends and retries an http request
- * @author Gabriel Abrams
- * @param opts object containing all arguments
- * @param opts.path path to send request to
- * @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
- */
-declare const sendServerToServerRequest: (opts: {
-    path: string;
-    host?: string | undefined;
-    method?: "GET" | "POST" | "DELETE" | "PUT" | undefined;
-    params?: {
-        [x: string]: any;
-    } | undefined;
-    headers?: {
-        [x: string]: any;
-    } | undefined;
-    responseType?: "Text" | "JSON" | undefined;
-}) => Promise<{
-    body: any;
-    status: number;
-    headers: {
-        [x: string]: any;
-    };
-}>;
-export default sendServerToServerRequest;

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

@@ -1,8 +0,0 @@
-/**
- * Initialize a log collection given the dce-mango Collection class
- * @author Gabe Abrams
- * @param Collection the Collection class from dce-mango
- * @returns initialized logCollection
- */
-declare const initLogCollection: (Collection: any) => any;
-export default initLogCollection;

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

@@ -1,42 +0,0 @@
-type GetLaunchInfoFunction = (req: any) => {
-    launched: boolean;
-    launchInfo?: any;
-};
-/**
- * Get launch info via CACCL
- * @author Gabe Abrams
- * @param req express request object
- * @returns object { launched, launchInfo }
- */
-export declare const cacclGetLaunchInfo: GetLaunchInfoFunction;
-/**
- * Get log collection
- * @author Gabe Abrams
- * @returns log collection if one was included during launch or null if we don't
- *   have a log collection (yet)
- */
-export declare const internalGetLogCollection: () => any;
-/**
- * Prepare dce-reactkit to run on the server
- * @author Gabe Abrams
- * @param opts object containing all arguments
- * @param opts.app express app from inside of the postprocessor function that
- *   we will add routes to
- * @param opts.getLaunchInfo CACCL LTI's get launch info function
- * @param [opts.logCollection] mongo collection from dce-mango to use for
- *   storing logs. If none is included, logs are written to the console
- * @param [opts.logReviewAdmins=all] info on which admins can review
- *   logs from the client. If not included, all Canvas admins are allowed to
- *   review logs. If null, no Canvas admins are allowed to review logs.
- *   If an array of Canvas userIds (numbers), only Canvas admins with those
- *   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
- */
-declare const initServer: (opts: {
-    app: any;
-    getLaunchInfo: GetLaunchInfoFunction;
-    logCollection?: any;
-    logReviewAdmins?: (number[] | any);
-}) => void;
-export default initServer;

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

@@ -1,41 +0,0 @@
-import express from 'express';
-/**
- * Interface for a collection in the database
- * @author Yuen Ler Chow
- */
-type DCEMangoCollection = {
-    /**
-     * Find all items in the collection that match the filter query
-     * @param filterQuery query for the filter
-     * @returns list of items that match the filter query
-     */
-    find: (filterQuery: any) => Promise<any[]>;
-    /**
-     * Insert an item into the collection
-     * @param item the item to insert
-     */
-    insert: (item: any) => Promise<void>;
-    /**
-     * Delete an item in the collection
-     * @param id the id of the item to delete
-     */
-    delete: (filterQuery: {
-        id: string;
-    }) => Promise<void>;
-};
-/**
- * Add all routes for the DBEditor
- * @author Yuen Ler Chow
- * @param opts object containing all arguments
- * @param opts.app express app to add routes too
- * @param opts.collectionName the name of the collection
- * @param opts.adminsOnly true if the endpoint is for admins only
- * @param opts.collection dce-mango db collection
- */
-declare const addDBEditorEndpoints: (opts: {
-    app: express.Application;
-    collectionName: string;
-    adminsOnly: boolean;
-    collection: DCEMangoCollection;
-}) => void;
-export default addDBEditorEndpoints;

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

@@ -1,76 +0,0 @@
-import ParamType from '../types/ParamType';
-import LogFunction from '../types/LogFunction';
-/**
- * Generate an express API route handler
- * @author Gabe Abrams
- * @param opts object containing all arguments
- * @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.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,
- *   if unhandledErrorMessagePrefix is
- *   'While saving progress, we encountered an error:'
- *   and the error is 'progressInfo is not an object',
- *   the client will receive an error with the message
- *   'While saving progress, we encountered an error: progressInfo is not an object'
- * @returns express route handler that takes the following arguments:
- *   params (map: param name => value),
- *   req (express request object),
- *   next (express next function),
- *   send (a function that sends a string to the client),
- *   redirect (takes a url and redirects the user to that url),
- *   renderErrorPage (shows a static error page to the user),
- *   renderInfoPage (shows a static info page to the user),
- *   renderCustomHTML (renders custom html and sends it to the user),
- *   and returns the value to send to the client as a JSON API response, or
- *   calls next() or redirect(...) or send(...) or renderErrorPage(...).
- *   Note: params also has userId, userFirstName,
- *   userLastName, userEmail, userAvatarURL, isLearner, isTTM, isAdmin,
- *   and any other variables that
- *   are directly added to the session, if the user does have a session.
- */
-declare const genRouteHandler: (opts: {
-    paramTypes?: {
-        [k: string]: ParamType;
-    } | undefined;
-    handler: (opts: {
-        params: {
-            [k: string]: any;
-        };
-        req: any;
-        next: () => void;
-        redirect: (pathOrURL: string) => void;
-        send: (text: string, status?: number) => void;
-        renderErrorPage: (opts?: {
-            title?: string;
-            description?: string;
-            code?: string;
-            pageTitle?: string;
-            status?: number;
-        }) => void;
-        renderInfoPage: (opts: {
-            title: string;
-            body: string;
-        }) => void;
-        renderCustomHTML: (opts: {
-            html: string;
-            status?: number;
-        }) => void;
-        logServerEvent: LogFunction;
-    }) => any;
-    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/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/dist/esm/types/helpers/handleError.d.ts

@@ -1,18 +0,0 @@
-/**
- * Handle an error and respond to the client
- * @author Gabe Abrams
- * @param res express response
- * @param error error info
- * @param opts.err the error to send to the client
- *   or the error message
- * @param [opts.code] an error code (only used if err.code is not
- *   included)
- * @param [opts.status=500] the https status code to use
- *   defined)
- */
-declare const handleError: (res: any, error: ({
-    message: any;
-    code?: string;
-    status?: number;
-} | Error | string | any)) => undefined;
-export default handleError;

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

@@ -1,8 +0,0 @@
-/**
- * Send successful API response
- * @author Gabe Abrams
- * @param res express response
- * @param body the body of the response to send to the client
- */
-declare const handleSuccess: (res: any, body: any) => undefined;
-export default handleSuccess;

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

@@ -1,17 +0,0 @@
-/**
- * Perform a rudimentary parsing of the user's browser agent string
- * @author Gabe Abrams
- * @param userAgent the user's browser agent
- * @returns user info
- */
-declare const parseUserAgent: (userAgent: string) => {
-    browser: {
-        name: string;
-        version: string;
-    };
-    device: {
-        isMobile: boolean;
-        os: string;
-    };
-};
-export default parseUserAgent;

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

@@ -1,24 +0,0 @@
-/**
- * Send a server-to-server request from this sever to another server that uses
- *   dce-reactkit [for server only]
- * @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
- */
-declare const visitEndpointOnAnotherServer: (opts: {
-    host: string;
-    path: string;
-    method?: "GET" | "POST" | "DELETE" | "PUT" | undefined;
-    params?: {
-        [x: string]: any;
-    } | undefined;
-    headers?: {
-        [x: string]: any;
-    } | undefined;
-}) => Promise<any>;
-export default visitEndpointOnAnotherServer;

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

@@ -1,33 +0,0 @@
-/**
- * Sends and retries an http request
- * @author Gabriel Abrams
- * @param opts object containing all arguments
- * @param opts.path path to send request to
- * @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
- */
-declare const sendServerToServerRequest: (opts: {
-    path: string;
-    host?: string | undefined;
-    method?: "GET" | "POST" | "DELETE" | "PUT" | undefined;
-    params?: {
-        [x: string]: any;
-    } | undefined;
-    headers?: {
-        [x: string]: any;
-    } | undefined;
-    responseType?: "Text" | "JSON" | undefined;
-}) => Promise<{
-    body: any;
-    status: number;
-    headers: {
-        [x: string]: any;
-    };
-}>;
-export default sendServerToServerRequest;

package/dist/esm/types/server/initLogCollection.d.ts

@@ -1,8 +0,0 @@
-/**
- * Initialize a log collection given the dce-mango Collection class
- * @author Gabe Abrams
- * @param Collection the Collection class from dce-mango
- * @returns initialized logCollection
- */
-declare const initLogCollection: (Collection: any) => any;
-export default initLogCollection;

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

@@ -1,42 +0,0 @@
-type GetLaunchInfoFunction = (req: any) => {
-    launched: boolean;
-    launchInfo?: any;
-};
-/**
- * Get launch info via CACCL
- * @author Gabe Abrams
- * @param req express request object
- * @returns object { launched, launchInfo }
- */
-export declare const cacclGetLaunchInfo: GetLaunchInfoFunction;
-/**
- * Get log collection
- * @author Gabe Abrams
- * @returns log collection if one was included during launch or null if we don't
- *   have a log collection (yet)
- */
-export declare const internalGetLogCollection: () => any;
-/**
- * Prepare dce-reactkit to run on the server
- * @author Gabe Abrams
- * @param opts object containing all arguments
- * @param opts.app express app from inside of the postprocessor function that
- *   we will add routes to
- * @param opts.getLaunchInfo CACCL LTI's get launch info function
- * @param [opts.logCollection] mongo collection from dce-mango to use for
- *   storing logs. If none is included, logs are written to the console
- * @param [opts.logReviewAdmins=all] info on which admins can review
- *   logs from the client. If not included, all Canvas admins are allowed to
- *   review logs. If null, no Canvas admins are allowed to review logs.
- *   If an array of Canvas userIds (numbers), only Canvas admins with those
- *   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
- */
-declare const initServer: (opts: {
-    app: any;
-    getLaunchInfo: GetLaunchInfoFunction;
-    logCollection?: any;
-    logReviewAdmins?: (number[] | any);
-}) => void;
-export default initServer;