@dosgato/templating 0.0.133 → 0.0.134

package/dist/uitemplate.d.ts

@@ -130,6 +130,38 @@ export interface TracingInterface {
     endTransaction?: (name: string, details: any, env?: TracingEnvironment) => void;
     event?: (name: string, details: any, env?: TracingEnvironment) => void;
 }
+export interface BaseEvent {
+    /** The larger UI area the user is interacting with that the event is emitted from.
+     * @example 'ActionPanel', 'PageEditor', 'ComponentDialog' */
+    eventType: string;
+    /** The specific action the user took. Typically the label for the element that emits
+     * the event.
+     * @example 'Add Page', 'Edit Page', 'Preview', 'Cancel Preview' */
+    action: string;
+    /** Additional data points specific to a particular event type's context. These should
+     * be significant enough to understanding the event to merrit adding additional columns
+     * in tools like elastic-search.
+     * @warning This is NOT a catch-all property.
+     * @example { hiddenLabel: action.hiddenLabel } // The aria label for an action element. */
+    additionalProperties?: Record<string, string | undefined>;
+}
+/** Events triggered by user interactions with interface elements in DosGato. This interface
+ * is intended to provide a common model for succinctly expressing the contextually important
+ * properties of these events to loggers that can be pointed to analytics and metrics services. */
+export interface UserEvent extends BaseEvent {
+    /** The page, screen, or dialog the user is looking at in which the associated event emitter is
+     * in context to.
+     * @example '/pages', '/pages/[id]', '/pages/[id]/dialog' */
+    screen: string;
+    /** The target the emitted event is to trigger actions on.
+     * Each page/screen, or dialog, needs to set their target for what events in it are targeted
+     * to act on in in its context.
+     *
+     * For example: The page in the page tree of the Pages screen that ActionPanel actions,
+     * such as edit or preview, will act on.
+     * @example '/site3-sandbox/about' */
+    target: string;
+}
 /**
  * A type for the config object that should be exported from a CMS instance's admin/local/index.js
  * to configure how that instance should work.
@@ -140,7 +172,7 @@ export interface UIConfig {
         /**
          * What to do when we get a 401 from the API. Generally we'll want to redirect
          * to our SSO login page. Since we use sveltekit we redirect by throwing:
-         * `throw redirect(302, 'my.sso.org/login')`
+         * `throw redirect(302, 'https://my.sso.org/login')`
          */
         handleUnauthorized: (environmentConfig: any) => void;
         /**
@@ -180,7 +212,7 @@ export interface UIConfig {
          * If you use cookies or if your SSO provider uses cookies and would immediately log the user back in,
          * then you need to visit a logout endpoint instead of refreshing.
          *
-         * Since we use sveltekit, you trigger navigation with `goto('my.sso.org/logout')`
+         * Since we use sveltekit, you trigger navigation with `goto('https://my.sso.org/logout')`
          */
         logout?: (environmentConfig: any, token: string) => void;
     };
@@ -194,5 +226,10 @@ export interface UIConfig {
      */
     assetMetaDialog?: UITemplate['dialog'];
     tracing?: TracingInterface;
+    /** Non-Awaited async call for logging interface interactions if defined.
+     * Useful for defining how to log form submissions, interaction clicks, page edits, or state
+     * changes of different interfaces. Can be directed to separate endpoint for APM logging as
+     * long as that POST is also non-awaited. */
+    uiInteractionsLogger?: (info: UserEvent, environmentConfig: any) => void;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dosgato/templating",
-  "version": "0.0.133",
+  "version": "0.0.134",
   "description": "A library to support building templates for dosgato CMS.",
   "type": "module",
   "exports": {