dce-commonkit 4.4.0

package/src/types/LogAction.ts

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

package/src/types/LogBuiltInMetadata.ts

@@ -0,0 +1,19 @@
+/**
+ * Built-in metadata for logs
+ * @author Gabe Abrams
+ */
+const LogBuiltInMetadata = {
+  // Contexts
+  Context: {
+    Uncategorized: 'Uncategorized',
+    ServerRenderedErrorPage: 'ServerRenderedErrorPage',
+    ServerEndpointError: 'ServerEndpointError',
+    ClientFatalError: 'ClientFatalError',
+  },
+  // Targets
+  Target: {
+    NoTarget: 'NoTarget',
+  },
+};
+
+export default LogBuiltInMetadata;

package/src/types/LogFunction.ts

@@ -0,0 +1,46 @@
+// Import shared types
+import Log from './Log';
+import LogAction from './LogAction';
+import LogLevel from './LogLevel';
+
+/**
+ * Type of a log action function
+ * @author Gabe Abrams
+ */
+type LogFunction = (
+  opts: (
+    // Shared info
+    {
+      // Context of the event (each app determines how to organize contexts)
+      context: string | { _: string },
+      // Subcontext of the event (each app determines how to organize subcontexts)
+      subcontext?: string,
+      // List of tags that apply to this action (each app determines tag usage)
+      tags?: string[],
+      // Additional optional custom metadata
+      metadata?: {
+        [k: string]: any,
+      },
+      // Log level (default is info)
+      level?: LogLevel,
+    } & (
+      // Error
+      | {
+        // The error object to log
+        error: any,
+      }
+      // Action
+      | {
+        // The type of action performed
+        action: LogAction,
+        // Target of the action (each app determines the list of targets)
+        // These are usually buttons, panels, elements, etc.
+        // If no target is included, this should indicate that this is an action
+        // being performed on the whole feature (open/close/etc)
+        target?: string,
+      }
+    )
+  ),
+) => Promise<Log>;
+
+export default LogFunction;

package/src/types/LogLevel.ts

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

package/src/types/LogMetadataContextMap.ts

@@ -0,0 +1,15 @@
+/**
+ * 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/src/types/LogMetadataTagMap.ts

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

package/src/types/LogMetadataTargetMap.ts

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

package/src/types/LogMetadataType.ts

@@ -0,0 +1,16 @@
+// Import shared types
+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/src/types/LogSource.ts

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

package/src/types/LogType.ts

@@ -0,0 +1,12 @@
+/**
+ * Type of a log event
+ * @author Gabe Abrams
+ */
+enum LogType {
+  // User action
+  Action = 'action',
+  // Error
+  Error = 'error',
+}
+
+export default LogType;

package/src/types/ParamType.ts

@@ -0,0 +1,18 @@
+/**
+ * Server-side API param types
+ * @author Gabe Abrams
+ */
+enum ParamType {
+  Boolean = 'Boolean', // Boolean
+  BooleanOptional = 'BooleanOptional', // Optional boolean
+  Float = 'Float', // Float Number
+  FloatOptional = 'FloatOptional', // Optional Float Number
+  Int = 'Int', // Integer Number
+  IntOptional = 'IntOptional', // Optional Integer Number
+  JSON = 'JSON', // JSONified object
+  JSONOptional = 'JSONOptional', // Optional JSONified object
+  String = 'String', // String
+  StringOptional = 'StringOptional', // Optional string
+}
+
+export default ParamType;

package/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "esModuleInterop": true,
+    "noImplicitAny": true,
+    "noEmitOnError": true,
+    "removeComments": false,
+    "declaration": true,
+    "sourceMap": true,
+    "target": "es5",
+    "outDir": "./lib"
+  },
+  "include": [
+    "./src"
+  ],
+  "ts-node": {
+    "files": true
+  }
+}