dce-commonkit 4.4.0

package/lib/index.js

@@ -0,0 +1,124 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapAsync = exports.forEachAsync = exports.filterAsync = exports.everyAsync = exports.prefixWithAOrAn = exports.idify = exports.getLocalTimeInfo = exports.validateString = exports.validatePhoneNumber = exports.validateEmail = exports.genCommaList = exports.compareArraysByProp = exports.extractProp = exports.genCSV = exports.getMonthName = exports.parallelLimit = exports.onlyKeepLetters = exports.stringsToHumanReadableList = exports.getPartOfDay = exports.getHumanReadableDate = exports.startMinWait = exports.getTimeInfoInET = exports.getOrdinal = exports.waitMs = exports.sum = exports.roundToNumDecimals = exports.padZerosLeft = exports.padDecimalZeros = exports.forceNumIntoBounds = exports.floorToNumDecimals = exports.ceilToNumDecimals = exports.avg = exports.abbreviate = exports.LogLevel = exports.LogBuiltInMetadata = exports.LogAction = exports.LogSource = exports.LogType = exports.DayOfWeek = exports.ParamType = exports.CommonKitErrorCode = exports.SELECT_ADMIN_CHECK_ROUTE = exports.LOG_REVIEW_GET_LOGS_ROUTE = exports.LOG_REVIEW_STATUS_ROUTE = exports.LOG_ROUTE_PATH = exports.LOG_REVIEW_ROUTE_PATH_PREFIX = exports.DAY_IN_MS = exports.HOUR_IN_MS = exports.MINUTE_IN_MS = exports.ErrorWithCode = void 0;
+exports.getTimestampFromTimeInfoInET = exports.cloneDeep = exports.getWordCount = exports.shuffleArray = exports.capitalize = exports.someAsync = void 0;
+// Import errors
+var ErrorWithCode_1 = __importDefault(require("./errors/ErrorWithCode"));
+exports.ErrorWithCode = ErrorWithCode_1.default;
+// Import constants
+var MINUTE_IN_MS_1 = __importDefault(require("./constants/MINUTE_IN_MS"));
+exports.MINUTE_IN_MS = MINUTE_IN_MS_1.default;
+var HOUR_IN_MS_1 = __importDefault(require("./constants/HOUR_IN_MS"));
+exports.HOUR_IN_MS = HOUR_IN_MS_1.default;
+var DAY_IN_MS_1 = __importDefault(require("./constants/DAY_IN_MS"));
+exports.DAY_IN_MS = DAY_IN_MS_1.default;
+var LOG_REVIEW_ROUTE_PATH_PREFIX_1 = __importDefault(require("./constants/LOG_REVIEW_ROUTE_PATH_PREFIX"));
+exports.LOG_REVIEW_ROUTE_PATH_PREFIX = LOG_REVIEW_ROUTE_PATH_PREFIX_1.default;
+var LOG_ROUTE_PATH_1 = __importDefault(require("./constants/LOG_ROUTE_PATH"));
+exports.LOG_ROUTE_PATH = LOG_ROUTE_PATH_1.default;
+var LOG_REVIEW_STATUS_ROUTE_1 = __importDefault(require("./constants/LOG_REVIEW_STATUS_ROUTE"));
+exports.LOG_REVIEW_STATUS_ROUTE = LOG_REVIEW_STATUS_ROUTE_1.default;
+var LOG_REVIEW_GET_LOGS_ROUTE_1 = __importDefault(require("./constants/LOG_REVIEW_GET_LOGS_ROUTE"));
+exports.LOG_REVIEW_GET_LOGS_ROUTE = LOG_REVIEW_GET_LOGS_ROUTE_1.default;
+var SELECT_ADMIN_CHECK_ROUTE_1 = __importDefault(require("./constants/SELECT_ADMIN_CHECK_ROUTE"));
+exports.SELECT_ADMIN_CHECK_ROUTE = SELECT_ADMIN_CHECK_ROUTE_1.default;
+// Import helpers
+var abbreviate_1 = __importDefault(require("./helpers/abbreviate"));
+exports.abbreviate = abbreviate_1.default;
+var avg_1 = __importDefault(require("./helpers/avg"));
+exports.avg = avg_1.default;
+var ceilToNumDecimals_1 = __importDefault(require("./helpers/ceilToNumDecimals"));
+exports.ceilToNumDecimals = ceilToNumDecimals_1.default;
+var floorToNumDecimals_1 = __importDefault(require("./helpers/floorToNumDecimals"));
+exports.floorToNumDecimals = floorToNumDecimals_1.default;
+var forceNumIntoBounds_1 = __importDefault(require("./helpers/forceNumIntoBounds"));
+exports.forceNumIntoBounds = forceNumIntoBounds_1.default;
+var padDecimalZeros_1 = __importDefault(require("./helpers/padDecimalZeros"));
+exports.padDecimalZeros = padDecimalZeros_1.default;
+var padZerosLeft_1 = __importDefault(require("./helpers/padZerosLeft"));
+exports.padZerosLeft = padZerosLeft_1.default;
+var roundToNumDecimals_1 = __importDefault(require("./helpers/roundToNumDecimals"));
+exports.roundToNumDecimals = roundToNumDecimals_1.default;
+var sum_1 = __importDefault(require("./helpers/sum"));
+exports.sum = sum_1.default;
+var waitMs_1 = __importDefault(require("./helpers/waitMs"));
+exports.waitMs = waitMs_1.default;
+var getOrdinal_1 = __importDefault(require("./helpers/getOrdinal"));
+exports.getOrdinal = getOrdinal_1.default;
+var getTimeInfoInET_1 = __importDefault(require("./helpers/getTimeInfoInET"));
+exports.getTimeInfoInET = getTimeInfoInET_1.default;
+var startMinWait_1 = __importDefault(require("./helpers/startMinWait"));
+exports.startMinWait = startMinWait_1.default;
+var getHumanReadableDate_1 = __importDefault(require("./helpers/getHumanReadableDate"));
+exports.getHumanReadableDate = getHumanReadableDate_1.default;
+var getPartOfDay_1 = __importDefault(require("./helpers/getPartOfDay"));
+exports.getPartOfDay = getPartOfDay_1.default;
+var stringsToHumanReadableList_1 = __importDefault(require("./helpers/stringsToHumanReadableList"));
+exports.stringsToHumanReadableList = stringsToHumanReadableList_1.default;
+var onlyKeepLetters_1 = __importDefault(require("./helpers/onlyKeepLetters"));
+exports.onlyKeepLetters = onlyKeepLetters_1.default;
+var parallelLimit_1 = __importDefault(require("./helpers/parallelLimit"));
+exports.parallelLimit = parallelLimit_1.default;
+var getMonthName_1 = __importDefault(require("./helpers/getMonthName"));
+exports.getMonthName = getMonthName_1.default;
+var genCSV_1 = __importDefault(require("./helpers/genCSV"));
+exports.genCSV = genCSV_1.default;
+var extractProp_1 = __importDefault(require("./helpers/extractProp"));
+exports.extractProp = extractProp_1.default;
+var compareArraysByProp_1 = __importDefault(require("./helpers/compareArraysByProp"));
+exports.compareArraysByProp = compareArraysByProp_1.default;
+var getLocalTimeInfo_1 = __importDefault(require("./helpers/getLocalTimeInfo"));
+exports.getLocalTimeInfo = getLocalTimeInfo_1.default;
+var genCommaList_1 = __importDefault(require("./helpers/genCommaList"));
+exports.genCommaList = genCommaList_1.default;
+var validateEmail_1 = __importDefault(require("./helpers/validators/validateEmail"));
+exports.validateEmail = validateEmail_1.default;
+var validatePhoneNumber_1 = __importDefault(require("./helpers/validators/validatePhoneNumber"));
+exports.validatePhoneNumber = validatePhoneNumber_1.default;
+var validateString_1 = __importDefault(require("./helpers/validators/validateString"));
+exports.validateString = validateString_1.default;
+var idify_1 = __importDefault(require("./helpers/idify"));
+exports.idify = idify_1.default;
+var prefixWithAOrAn_1 = __importDefault(require("./helpers/prefixWithAOrAn"));
+exports.prefixWithAOrAn = prefixWithAOrAn_1.default;
+var everyAsync_1 = __importDefault(require("./helpers/asyncArrayFunctions/everyAsync"));
+exports.everyAsync = everyAsync_1.default;
+var filterAsync_1 = __importDefault(require("./helpers/asyncArrayFunctions/filterAsync"));
+exports.filterAsync = filterAsync_1.default;
+var forEachAsync_1 = __importDefault(require("./helpers/asyncArrayFunctions/forEachAsync"));
+exports.forEachAsync = forEachAsync_1.default;
+var mapAsync_1 = __importDefault(require("./helpers/asyncArrayFunctions/mapAsync"));
+exports.mapAsync = mapAsync_1.default;
+var someAsync_1 = __importDefault(require("./helpers/asyncArrayFunctions/someAsync"));
+exports.someAsync = someAsync_1.default;
+var capitalize_1 = __importDefault(require("./helpers/capitalize"));
+exports.capitalize = capitalize_1.default;
+var shuffleArray_1 = __importDefault(require("./helpers/shuffleArray"));
+exports.shuffleArray = shuffleArray_1.default;
+var getWordCount_1 = __importDefault(require("./helpers/getWordCount"));
+exports.getWordCount = getWordCount_1.default;
+var cloneDeep_1 = __importDefault(require("./helpers/cloneDeep"));
+exports.cloneDeep = cloneDeep_1.default;
+var getTimestampFromTimeInfoInET_1 = __importDefault(require("./helpers/getTimestampFromTimeInfoInET"));
+exports.getTimestampFromTimeInfoInET = getTimestampFromTimeInfoInET_1.default;
+// Import types
+var ParamType_1 = __importDefault(require("./types/ParamType"));
+exports.ParamType = ParamType_1.default;
+var DayOfWeek_1 = __importDefault(require("./types/DayOfWeek"));
+exports.DayOfWeek = DayOfWeek_1.default;
+var LogType_1 = __importDefault(require("./types/LogType"));
+exports.LogType = LogType_1.default;
+var LogSource_1 = __importDefault(require("./types/LogSource"));
+exports.LogSource = LogSource_1.default;
+var LogAction_1 = __importDefault(require("./types/LogAction"));
+exports.LogAction = LogAction_1.default;
+var LogBuiltInMetadata_1 = __importDefault(require("./types/LogBuiltInMetadata"));
+exports.LogBuiltInMetadata = LogBuiltInMetadata_1.default;
+var LogLevel_1 = __importDefault(require("./types/LogLevel"));
+exports.LogLevel = LogLevel_1.default;
+var CommonKitErrorCode_1 = __importDefault(require("./types/CommonKitErrorCode"));
+exports.CommonKitErrorCode = CommonKitErrorCode_1.default;
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;AAAA,gBAAgB;AAChB,yEAAmD;AAwEjD,wBAxEK,uBAAa,CAwEL;AAtEf,mBAAmB;AACnB,0EAAoD;AAuElD,uBAvEK,sBAAY,CAuEL;AAtEd,sEAAgD;AAuE9C,qBAvEK,oBAAU,CAuEL;AAtEZ,oEAA8C;AAuE5C,oBAvEK,mBAAS,CAuEL;AAtEX,0GAAoF;AAuElF,uCAvEK,sCAA4B,CAuEL;AAtE9B,8EAAwD;AAuEtD,yBAvEK,wBAAc,CAuEL;AAtEhB,gGAA0E;AAuExE,kCAvEK,iCAAuB,CAuEL;AAtEzB,oGAA8E;AAuE5E,oCAvEK,mCAAyB,CAuEL;AAtE3B,kGAA4E;AAuE1E,mCAvEK,kCAAwB,CAuEL;AArE1B,iBAAiB;AACjB,oEAA8C;AAqF5C,qBArFK,oBAAU,CAqFL;AApFZ,sDAAgC;AAqF9B,cArFK,aAAG,CAqFL;AApFL,kFAA4D;AAqF1D,4BArFK,2BAAiB,CAqFL;AApFnB,oFAA8D;AAqF5D,6BArFK,4BAAkB,CAqFL;AApFpB,oFAA8D;AAqF5D,6BArFK,4BAAkB,CAqFL;AApFpB,8EAAwD;AAqFtD,0BArFK,yBAAe,CAqFL;AApFjB,wEAAkD;AAqFhD,uBArFK,sBAAY,CAqFL;AApFd,oFAA8D;AAqF5D,6BArFK,4BAAkB,CAqFL;AApFpB,sDAAgC;AAqF9B,cArFK,aAAG,CAqFL;AApFL,4DAAsC;AAqFpC,iBArFK,gBAAM,CAqFL;AApFR,oEAA8C;AAqF5C,qBArFK,oBAAU,CAqFL;AApFZ,8EAAwD;AAqFtD,0BArFK,yBAAe,CAqFL;AApFjB,wEAAkD;AAqFhD,uBArFK,sBAAY,CAqFL;AApFd,wFAAkE;AAqFhE,+BArFK,8BAAoB,CAqFL;AApFtB,wEAAkD;AAqFhD,uBArFK,sBAAY,CAqFL;AApFd,oGAA8E;AAqF5E,qCArFK,oCAA0B,CAqFL;AApF5B,8EAAwD;AAqFtD,0BArFK,yBAAe,CAqFL;AApFjB,0EAAoD;AAqFlD,wBArFK,uBAAa,CAqFL;AApFf,wEAAkD;AAqFhD,uBArFK,sBAAY,CAqFL;AApFd,4DAAsC;AAqFpC,iBArFK,gBAAM,CAqFL;AApFR,sEAAgD;AAqF9C,sBArFK,qBAAW,CAqFL;AApFb,sFAAgE;AAqF9D,8BArFK,6BAAmB,CAqFL;AApFrB,gFAA0D;AAyFxD,2BAzFK,0BAAgB,CAyFL;AAxFlB,wEAAkD;AAoFhD,uBApFK,sBAAY,CAoFL;AAnFd,qFAA+D;AAoF7D,wBApFK,uBAAa,CAoFL;AAnFf,iGAA2E;AAoFzE,8BApFK,6BAAmB,CAoFL;AAnFrB,uFAAiE;AAoF/D,yBApFK,wBAAc,CAoFL;AAnFhB,0DAAoC;AAqFlC,gBArFK,eAAK,CAqFL;AApFP,8EAAwD;AAqFtD,0BArFK,yBAAe,CAqFL;AApFjB,wFAAkE;AAqFhE,qBArFK,oBAAU,CAqFL;AApFZ,0FAAoE;AAqFlE,sBArFK,qBAAW,CAqFL;AApFb,4FAAsE;AAqFpE,uBArFK,sBAAY,CAqFL;AApFd,oFAA8D;AAqF5D,mBArFK,kBAAQ,CAqFL;AApFV,sFAAgE;AAqF9D,oBArFK,mBAAS,CAqFL;AApFX,oEAA8C;AAqF5C,qBArFK,oBAAU,CAqFL;AApFZ,wEAAkD;AAqFhD,uBArFK,sBAAY,CAqFL;AApFd,wEAAkD;AAqFhD,uBArFK,sBAAY,CAqFL;AApFd,kEAA4C;AAqF1C,oBArFK,mBAAS,CAqFL;AApFX,wGAAkF;AAqFhF,uCArFK,sCAA4B,CAqFL;AAnF9B,eAAe;AACf,gEAA0C;AA8BxC,oBA9BK,mBAAS,CA8BL;AA7BX,gEAA0C;AA8BxC,oBA9BK,mBAAS,CA8BL;AA5BX,4DAAsC;AA8BpC,kBA9BK,iBAAO,CA8BL;AA7BT,gEAA0C;AA8BxC,oBA9BK,mBAAS,CA8BL;AA7BX,gEAA0C;AA8BxC,oBA9BK,mBAAS,CA8BL;AA7BX,kFAA4D;AA8B1D,6BA9BK,4BAAkB,CA8BL;AAxBpB,8DAAwC;AA8BtC,mBA9BK,kBAAQ,CA8BL;AA7BV,kFAA4D;AAgB1D,6BAhBK,4BAAkB,CAgBL"}

package/lib/types/CommonKitErrorCode.d.ts

@@ -0,0 +1,10 @@
+/**
+ * List of error codes built into the common kit
+ * @author Gabe Abrams
+ */
+declare enum CommonKitErrorCode {
+    SimpleDateChooserInvalidDateRange = "DCK1",
+    SimpleDateChooserInvalidNumMonths = "DCK2",
+    ETTimestampInvalid = "DCK3"
+}
+export default CommonKitErrorCode;

package/lib/types/CommonKitErrorCode.js

@@ -0,0 +1,15 @@
+"use strict";
+// Highest error code = DCK3
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * List of error codes built into the common kit
+ * @author Gabe Abrams
+ */
+var CommonKitErrorCode;
+(function (CommonKitErrorCode) {
+    CommonKitErrorCode["SimpleDateChooserInvalidDateRange"] = "DCK1";
+    CommonKitErrorCode["SimpleDateChooserInvalidNumMonths"] = "DCK2";
+    CommonKitErrorCode["ETTimestampInvalid"] = "DCK3";
+})(CommonKitErrorCode || (CommonKitErrorCode = {}));
+exports.default = CommonKitErrorCode;
+//# sourceMappingURL=CommonKitErrorCode.js.map

package/lib/types/CommonKitErrorCode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommonKitErrorCode.js","sourceRoot":"","sources":["../../src/types/CommonKitErrorCode.ts"],"names":[],"mappings":";AAAA,4BAA4B;;AAE5B;;;GAGG;AACH,IAAK,kBAIJ;AAJD,WAAK,kBAAkB;IACrB,gEAA0C,CAAA;IAC1C,gEAA0C,CAAA;IAC1C,iDAA2B,CAAA;AAC7B,CAAC,EAJI,kBAAkB,KAAlB,kBAAkB,QAItB;AAED,kBAAe,kBAAkB,CAAC"}

package/lib/types/DayOfWeek.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Days of the week
+ * @author Gabe Abrams
+ */
+declare enum DayOfWeek {
+    Monday = "m",
+    Tuesday = "t",
+    Wednesday = "w",
+    Thursday = "r",
+    Friday = "f",
+    Saturday = "s",
+    Sunday = "u"
+}
+export default DayOfWeek;

package/lib/types/DayOfWeek.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Days of the week
+ * @author Gabe Abrams
+ */
+var DayOfWeek;
+(function (DayOfWeek) {
+    DayOfWeek["Monday"] = "m";
+    DayOfWeek["Tuesday"] = "t";
+    DayOfWeek["Wednesday"] = "w";
+    DayOfWeek["Thursday"] = "r";
+    DayOfWeek["Friday"] = "f";
+    DayOfWeek["Saturday"] = "s";
+    DayOfWeek["Sunday"] = "u";
+})(DayOfWeek || (DayOfWeek = {}));
+exports.default = DayOfWeek;
+//# sourceMappingURL=DayOfWeek.js.map

package/lib/types/DayOfWeek.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DayOfWeek.js","sourceRoot":"","sources":["../../src/types/DayOfWeek.ts"],"names":[],"mappings":";;AAAA;;;GAGG;AACH,IAAK,SAQJ;AARD,WAAK,SAAS;IACZ,yBAAY,CAAA;IACZ,0BAAa,CAAA;IACb,4BAAe,CAAA;IACf,2BAAc,CAAA;IACd,yBAAY,CAAA;IACZ,2BAAc,CAAA;IACd,yBAAY,CAAA;AACd,CAAC,EARI,SAAS,KAAT,SAAS,QAQb;AAED,kBAAe,SAAS,CAAC"}

package/lib/types/Log/LogMainInfo.d.ts

@@ -0,0 +1,39 @@
+import LogLevel from '../LogLevel';
+/**
+ * Main information in a log event
+ * @author Gabe Abrams
+ */
+type LogMainInfo = {
+    id: string;
+    userFirstName: string;
+    userLastName: string;
+    userEmail: string;
+    userId: number;
+    isLearner: boolean;
+    isAdmin: boolean;
+    isTTM: boolean;
+    courseId: number;
+    courseName: string;
+    browser: {
+        name: string;
+        version: string;
+    };
+    device: {
+        os: string;
+        isMobile: boolean;
+    };
+    year: number;
+    month: number;
+    day: number;
+    hour: number;
+    minute: number;
+    timestamp: number;
+    context: string;
+    subcontext: string;
+    tags: string[];
+    level: LogLevel;
+    metadata?: {
+        [k: string]: any;
+    };
+};
+export default LogMainInfo;

package/lib/types/Log/LogMainInfo.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=LogMainInfo.js.map

package/lib/types/Log/LogMainInfo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LogMainInfo.js","sourceRoot":"","sources":["../../../src/types/Log/LogMainInfo.ts"],"names":[],"mappings":""}

package/lib/types/Log/LogSourceSpecificInfo.d.ts

@@ -0,0 +1,13 @@
+import LogSource from '../LogSource';
+/**
+ * Log info that is specific to the type of source
+ * @author Gabe Abrams
+ */
+type LogSourceSpecificInfo = ({
+    source: LogSource.Client;
+} | {
+    source: LogSource.Server;
+    routePath: string;
+    routeTemplate: string;
+});
+export default LogSourceSpecificInfo;

package/lib/types/Log/LogSourceSpecificInfo.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=LogSourceSpecificInfo.js.map

package/lib/types/Log/LogSourceSpecificInfo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LogSourceSpecificInfo.js","sourceRoot":"","sources":["../../../src/types/Log/LogSourceSpecificInfo.ts"],"names":[],"mappings":""}

package/lib/types/Log/LogTypeSpecificInfo.d.ts

@@ -0,0 +1,17 @@
+import LogAction from '../LogAction';
+import LogType from '../LogType';
+/**
+ * Log info that is specific to the type of log
+ * @author Gabe Abrams
+ */
+type LogTypeSpecificInfo = ({
+    type: LogType.Error;
+    errorMessage: string;
+    errorCode: string;
+    errorStack: string;
+} | {
+    type: LogType.Action;
+    target: string;
+    action: LogAction;
+});
+export default LogTypeSpecificInfo;

package/lib/types/Log/LogTypeSpecificInfo.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=LogTypeSpecificInfo.js.map

package/lib/types/Log/LogTypeSpecificInfo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LogTypeSpecificInfo.js","sourceRoot":"","sources":["../../../src/types/Log/LogTypeSpecificInfo.ts"],"names":[],"mappings":""}

package/lib/types/Log/index.d.ts

@@ -0,0 +1,10 @@
+import LogMainInfo from './LogMainInfo';
+import LogSourceSpecificInfo from './LogSourceSpecificInfo';
+import LogTypeSpecificInfo from './LogTypeSpecificInfo';
+/**
+ * A single log event corresponding to an action performed by a user or an
+ *   error encountered by a user
+ * @author Gabe Abrams
+ */
+type Log = (LogMainInfo & LogSourceSpecificInfo & LogTypeSpecificInfo);
+export default Log;

package/lib/types/Log/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/lib/types/Log/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/Log/index.ts"],"names":[],"mappings":""}

package/lib/types/LogAction.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Types of actions
+ * @author Gabe Abrams
+ */
+declare enum LogAction {
+    Open = "Open",
+    Close = "Close",
+    Cancel = "Cancel",
+    Expand = "Expand",
+    Collapse = "Collapse",
+    View = "View",
+    Interrupt = "Interrupt",
+    Create = "Create",
+    Modify = "Modify",
+    Delete = "Delete",
+    Add = "Add",
+    Remove = "Remove",
+    Activate = "Activate",
+    Deactivate = "Deactivate",
+    Peek = "Peek",
+    Halt = "Halt",
+    Resume = "Resume",
+    Jump = "Jump",
+    Post = "Post",
+    Like = "Like",
+    Dislike = "Dislike",
+    Unknown = "Unknown"
+}
+export default LogAction;

package/lib/types/LogAction.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Types of actions
+ * @author Gabe Abrams
+ */
+var LogAction;
+(function (LogAction) {
+    // Target was opened by the user (it was not on screen, but now it is)
+    LogAction["Open"] = "Open";
+    // Target was closed by the user (it was on screen, but now it is not)
+    LogAction["Close"] = "Close";
+    // Target was cancelled by the user (it was on closed without saving)
+    LogAction["Cancel"] = "Cancel";
+    // Target was expanded by the user (it always remains on screen, but size was changed)
+    LogAction["Expand"] = "Expand";
+    // Target was collapsed by the user (it always remains on screen, but size was changed)
+    LogAction["Collapse"] = "Collapse";
+    // Target was viewed by the user (only for items that are not opened or closed, those must use Open/Close actions)
+    LogAction["View"] = "View";
+    // Target interrupted the user (popup, dialog, validation message, etc. appeared without user prompting)
+    LogAction["Interrupt"] = "Interrupt";
+    // Target was created by the user (it did not exist before)
+    LogAction["Create"] = "Create";
+    // Target was modified by the user (it existed and was changed)
+    LogAction["Modify"] = "Modify";
+    // Target was deleted by the user (it existed and now it doesn't)
+    LogAction["Delete"] = "Delete";
+    // Target was added by the user (it already existed and was added to another place)
+    LogAction["Add"] = "Add";
+    // Target was removed by the user (it was removed from something but still exists)
+    LogAction["Remove"] = "Remove";
+    // Target was activated by the user (click, check, tap, keypress, etc.)
+    LogAction["Activate"] = "Activate";
+    // Target was deactivated by the user (click away, uncheck, tap outside of, tab away, etc.)
+    LogAction["Deactivate"] = "Deactivate";
+    // User showed interest in a target (hover, peek, etc.)
+    LogAction["Peek"] = "Peek";
+    // Halt a process (pause, etc.)
+    LogAction["Halt"] = "Halt";
+    // Resume a process (resume a halted process)
+    LogAction["Resume"] = "Resume";
+    // Jump to/seek to/reveal/go to/navigate to a target
+    LogAction["Jump"] = "Jump";
+    // Post a submission/message/etc. into the target
+    LogAction["Post"] = "Post";
+    // Like something
+    LogAction["Like"] = "Like";
+    // Dislike something
+    LogAction["Dislike"] = "Dislike";
+    // Unknown action
+    LogAction["Unknown"] = "Unknown";
+})(LogAction || (LogAction = {}));
+exports.default = LogAction;
+//# sourceMappingURL=LogAction.js.map

package/lib/types/LogAction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LogAction.js","sourceRoot":"","sources":["../../src/types/LogAction.ts"],"names":[],"mappings":";;AAAA;;;GAGG;AACH,IAAK,SA6CJ;AA7CD,WAAK,SAAS;IACZ,sEAAsE;IACtE,0BAAa,CAAA;IACb,sEAAsE;IACtE,4BAAe,CAAA;IACf,qEAAqE;IACrE,8BAAiB,CAAA;IACjB,sFAAsF;IACtF,8BAAiB,CAAA;IACjB,uFAAuF;IACvF,kCAAqB,CAAA;IACrB,kHAAkH;IAClH,0BAAa,CAAA;IACb,wGAAwG;IACxG,oCAAuB,CAAA;IACvB,2DAA2D;IAC3D,8BAAiB,CAAA;IACjB,+DAA+D;IAC/D,8BAAiB,CAAA;IACjB,iEAAiE;IACjE,8BAAiB,CAAA;IACjB,mFAAmF;IACnF,wBAAW,CAAA;IACX,kFAAkF;IAClF,8BAAiB,CAAA;IACjB,uEAAuE;IACvE,kCAAqB,CAAA;IACrB,2FAA2F;IAC3F,sCAAyB,CAAA;IACzB,uDAAuD;IACvD,0BAAa,CAAA;IACb,+BAA+B;IAC/B,0BAAa,CAAA;IACb,6CAA6C;IAC7C,8BAAiB,CAAA;IACjB,oDAAoD;IACpD,0BAAa,CAAA;IACb,iDAAiD;IACjD,0BAAa,CAAA;IACb,iBAAiB;IACjB,0BAAa,CAAA;IACb,oBAAoB;IACpB,gCAAmB,CAAA;IACnB,iBAAiB;IACjB,gCAAmB,CAAA;AACrB,CAAC,EA7CI,SAAS,KAAT,SAAS,QA6Cb;AAED,kBAAe,SAAS,CAAC"}

package/lib/types/LogBuiltInMetadata.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Built-in metadata for logs
+ * @author Gabe Abrams
+ */
+declare const LogBuiltInMetadata: {
+    Context: {
+        Uncategorized: string;
+        ServerRenderedErrorPage: string;
+        ServerEndpointError: string;
+        ClientFatalError: string;
+    };
+    Target: {
+        NoTarget: string;
+    };
+};
+export default LogBuiltInMetadata;

package/lib/types/LogBuiltInMetadata.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Built-in metadata for logs
+ * @author Gabe Abrams
+ */
+var LogBuiltInMetadata = {
+    // Contexts
+    Context: {
+        Uncategorized: 'Uncategorized',
+        ServerRenderedErrorPage: 'ServerRenderedErrorPage',
+        ServerEndpointError: 'ServerEndpointError',
+        ClientFatalError: 'ClientFatalError',
+    },
+    // Targets
+    Target: {
+        NoTarget: 'NoTarget',
+    },
+};
+exports.default = LogBuiltInMetadata;
+//# sourceMappingURL=LogBuiltInMetadata.js.map

package/lib/types/LogBuiltInMetadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LogBuiltInMetadata.js","sourceRoot":"","sources":["../../src/types/LogBuiltInMetadata.ts"],"names":[],"mappings":";;AAAA;;;GAGG;AACH,IAAM,kBAAkB,GAAG;IACzB,WAAW;IACX,OAAO,EAAE;QACP,aAAa,EAAE,eAAe;QAC9B,uBAAuB,EAAE,yBAAyB;QAClD,mBAAmB,EAAE,qBAAqB;QAC1C,gBAAgB,EAAE,kBAAkB;KACrC;IACD,UAAU;IACV,MAAM,EAAE;QACN,QAAQ,EAAE,UAAU;KACrB;CACF,CAAC;AAEF,kBAAe,kBAAkB,CAAC"}

package/lib/types/LogFunction.d.ts

@@ -0,0 +1,24 @@
+import Log from './Log';
+import LogAction from './LogAction';
+import LogLevel from './LogLevel';
+/**
+ * Type of a log action function
+ * @author Gabe Abrams
+ */
+type LogFunction = (opts: ({
+    context: string | {
+        _: string;
+    };
+    subcontext?: string;
+    tags?: string[];
+    metadata?: {
+        [k: string]: any;
+    };
+    level?: LogLevel;
+} & ({
+    error: any;
+} | {
+    action: LogAction;
+    target?: string;
+}))) => Promise<Log>;
+export default LogFunction;

package/lib/types/LogFunction.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=LogFunction.js.map

package/lib/types/LogFunction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LogFunction.js","sourceRoot":"","sources":["../../src/types/LogFunction.ts"],"names":[],"mappings":""}

package/lib/types/LogLevel.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Allowed log levels
+ * @author Gabe Abrams
+ */
+declare enum LogLevel {
+    Warn = "Warn",
+    Info = "Info",// Default
+    Debug = "Debug"
+}
+export default LogLevel;

package/lib/types/LogLevel.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Allowed log levels
+ * @author Gabe Abrams
+ */
+var LogLevel;
+(function (LogLevel) {
+    LogLevel["Warn"] = "Warn";
+    LogLevel["Info"] = "Info";
+    LogLevel["Debug"] = "Debug";
+})(LogLevel || (LogLevel = {}));
+exports.default = LogLevel;
+//# sourceMappingURL=LogLevel.js.map

package/lib/types/LogLevel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LogLevel.js","sourceRoot":"","sources":["../../src/types/LogLevel.ts"],"names":[],"mappings":";;AAAA;;;GAGG;AACH,IAAK,QAIJ;AAJD,WAAK,QAAQ;IACX,yBAAa,CAAA;IACb,yBAAa,CAAA;IACb,2BAAe,CAAA;AACjB,CAAC,EAJI,QAAQ,KAAR,QAAQ,QAIZ;AAED,kBAAe,QAAQ,CAAC"}

package/lib/types/LogMetadataContextMap.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Type of the context map in a LogMetadata file
+ * @author Gabe Abrams
+ */
+type LogMetadataContextMap = {
+    [k: string]: (string | {
+        _: string;
+        [k: string]: string;
+    });
+};
+export default LogMetadataContextMap;

package/lib/types/LogMetadataContextMap.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=LogMetadataContextMap.js.map

package/lib/types/LogMetadataContextMap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LogMetadataContextMap.js","sourceRoot":"","sources":["../../src/types/LogMetadataContextMap.ts"],"names":[],"mappings":""}

package/lib/types/LogMetadataTagMap.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Type of the tag map inside a LogMetadata file
+ * @author Gabe Abrams
+ */
+type LogMetadataTagMap = {
+    [k: string]: string;
+};
+export default LogMetadataTagMap;

package/lib/types/LogMetadataTagMap.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=LogMetadataTagMap.js.map

package/lib/types/LogMetadataTagMap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LogMetadataTagMap.js","sourceRoot":"","sources":["../../src/types/LogMetadataTagMap.ts"],"names":[],"mappings":""}

package/lib/types/LogMetadataTargetMap.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Type of the target map inside a LogMetadata file
+ * @author Gabe Abrams
+ */
+type LogMetadataTargetMap = {
+    [k: string]: string;
+};
+export default LogMetadataTargetMap;

package/lib/types/LogMetadataTargetMap.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=LogMetadataTargetMap.js.map

package/lib/types/LogMetadataTargetMap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LogMetadataTargetMap.js","sourceRoot":"","sources":["../../src/types/LogMetadataTargetMap.ts"],"names":[],"mappings":""}

package/lib/types/LogMetadataType.d.ts

@@ -0,0 +1,13 @@
+import LogMetadataContextMap from './LogMetadataContextMap';
+import LogMetadataTagMap from './LogMetadataTagMap';
+import LogMetadataTargetMap from './LogMetadataTargetMap';
+/**
+ * Type of a LogMetadata file
+ * @author Gabe Abrams
+ */
+type LogMetadataType = {
+    Context?: LogMetadataContextMap;
+    Tag?: LogMetadataTagMap;
+    Target?: LogMetadataTargetMap;
+};
+export default LogMetadataType;

package/lib/types/LogMetadataType.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=LogMetadataType.js.map

package/lib/types/LogMetadataType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LogMetadataType.js","sourceRoot":"","sources":["../../src/types/LogMetadataType.ts"],"names":[],"mappings":""}

package/lib/types/LogSource.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Source of a log event
+ * @author Gabe Abrams
+ */
+declare enum LogSource {
+    Client = "client",
+    Server = "server"
+}
+export default LogSource;

package/lib/types/LogSource.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Source of a log event
+ * @author Gabe Abrams
+ */
+var LogSource;
+(function (LogSource) {
+    // Client
+    LogSource["Client"] = "client";
+    // Server
+    LogSource["Server"] = "server";
+})(LogSource || (LogSource = {}));
+exports.default = LogSource;
+//# sourceMappingURL=LogSource.js.map

package/lib/types/LogSource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LogSource.js","sourceRoot":"","sources":["../../src/types/LogSource.ts"],"names":[],"mappings":";;AAAA;;;GAGG;AACH,IAAK,SAKJ;AALD,WAAK,SAAS;IACZ,SAAS;IACT,8BAAiB,CAAA;IACjB,SAAS;IACT,8BAAiB,CAAA;AACnB,CAAC,EALI,SAAS,KAAT,SAAS,QAKb;AAED,kBAAe,SAAS,CAAC"}