@worknice/js-sdk 0.13.10 → 0.13.12

package/dist/{_types-BiXOGWxp.d.ts → _types-CeswTuBG.d.ts}

@@ -906,6 +906,7 @@ type FetchOptions = {
 type ClientConfig = {
     accessToken?: string;
     apiUrl?: string;
+    correlationId?: string;
 };
 type WorkniceClient = ReturnType<typeof createWorkniceClient>;
 interface GraphQLFormattedError {

package/dist/api/WorkniceIntegrationLogger.d.ts

@@ -1,4 +1,4 @@
-import { W as WorkniceClient } from '../_types-BiXOGWxp.js';
+import { W as WorkniceClient } from '../_types-CeswTuBG.js';
 import './_generated.js';
 
 type Logger = Pick<Console, "debug" | "error" | "info" | "warn"> & Partial<Pick<Console, "group" | "groupEnd">>;
@@ -22,6 +22,10 @@ type WorkniceIntegrationLoggerOptions = {
      * A Console-like object with which messages will be logger.
      */
     logger: Logger;
+    /**
+     * The correlation ID to include in all log messages.
+     */
+    correlationId?: string;
 };
 /**
  * A logger that can log messages to both a Console-like object and to a
@@ -62,9 +66,11 @@ declare class WorkniceIntegrationLogger {
      */
     private integrationId;
     /**
-     * The random ID for the integration log to which the logs will be appended.
+     * The ID for the integration log to which the logs will be appended.
+     * This is set to the same value as correlationId to enable easy tracing
+     * between integration logs visible to users and platform logs in Axiom.
      */
-    private integrationLogId;
+    readonly integrationLogId: string;
     /**
      * Determines when the logger should flush the logs. Calling info(), error(),
      * warn(), indent() or dedent() will automatically flush the logs if the last
@@ -95,12 +101,18 @@ declare class WorkniceIntegrationLogger {
      * @param options.debugLogType The type of console logging to use for debug messages. Defaults to "debug".
      * @param options.delayBetweenFlushes The delay between flushes in milliseconds. Defaults to 1000 (1 second).
      * @param options.logger A Console-like object with which messages can be logged. Defaults to the global console object.
+     * @param options.correlationId The correlation ID to include in all log messages.
      * @example
      * ```js
-     * const logger = new WorkniceIntegrationLogger({ logger: console });
+     * const logger = new WorkniceIntegrationLogger({ logger: console, correlationId: "abc123" });
      * ```
      */
     constructor(options?: Partial<WorkniceIntegrationLoggerOptions>);
+    /**
+     * Gets the correlation ID for this logger session.
+     * This will always return a value as correlationId is set during initialization.
+     */
+    get correlationId(): string;
     /**
      * Connects the logger to a Worknice integration. If there are previously
      * logged messages that need to be flushed, a new integration log will be
@@ -118,7 +130,7 @@ declare class WorkniceIntegrationLogger {
     /**
      * Logs an error of any type. The error will be logged to the configured logger
      * with full stack traces and a chain of error causes. A simplified error
-     * message will sent to the Worknice integration logs (if connected) and
+     * message will be sent to the Worknice integration logs (if connected) and
      * returned for displaying to the user. If the error is not an instance of
      * Error, it will be coerced into a string before being logged.
      */

package/dist/api/WorkniceIntegrationLogger.js

@@ -20,7 +20,9 @@ class WorkniceIntegrationLogger {
    */
   integrationId = void 0;
   /**
-   * The random ID for the integration log to which the logs will be appended.
+   * The ID for the integration log to which the logs will be appended.
+   * This is set to the same value as correlationId to enable easy tracing
+   * between integration logs visible to users and platform logs in Axiom.
    */
   integrationLogId;
   /**
@@ -53,19 +55,29 @@ class WorkniceIntegrationLogger {
    * @param options.debugLogType The type of console logging to use for debug messages. Defaults to "debug".
    * @param options.delayBetweenFlushes The delay between flushes in milliseconds. Defaults to 1000 (1 second).
    * @param options.logger A Console-like object with which messages can be logged. Defaults to the global console object.
+   * @param options.correlationId The correlation ID to include in all log messages.
    * @example
    * ```js
-   * const logger = new WorkniceIntegrationLogger({ logger: console });
+   * const logger = new WorkniceIntegrationLogger({ logger: console, correlationId: "abc123" });
    * ```
    */
   constructor(options) {
-    this.integrationLogId = uuid();
+    const correlationId = options?.correlationId?.trim() || uuid();
+    this.integrationLogId = correlationId;
     this.options = {
       debugLogType: options?.debugLogType ?? "debug",
       delayBetweenFlushes: options?.delayBetweenFlushes ?? 1e3,
-      logger: options?.logger ?? console
+      logger: options?.logger ?? console,
+      correlationId
     };
   }
+  /**
+   * Gets the correlation ID for this logger session.
+   * This will always return a value as correlationId is set during initialization.
+   */
+  get correlationId() {
+    return this.options.correlationId;
+  }
   /**
    * Connects the logger to a Worknice integration. If there are previously
    * logged messages that need to be flushed, a new integration log will be
@@ -82,8 +94,10 @@ class WorkniceIntegrationLogger {
    * and are never sent to the Worknice integration logs.
    */
   debug(message) {
-    if (this.options.debugLogType === "debug") this.options.logger.debug(message);
-    else this.options.logger.info(message);
+    const meta = { correlationId: this.options.correlationId };
+    if (this.options.debugLogType === "debug") {
+      this.options.logger.debug(message, meta);
+    } else this.options.logger.info(message, meta);
   }
   dedent(message) {
     if (message !== void 0) this.info(message);
@@ -108,7 +122,7 @@ class WorkniceIntegrationLogger {
   /**
    * Logs an error of any type. The error will be logged to the configured logger
    * with full stack traces and a chain of error causes. A simplified error
-   * message will sent to the Worknice integration logs (if connected) and
+   * message will be sent to the Worknice integration logs (if connected) and
    * returned for displaying to the user. If the error is not an instance of
    * Error, it will be coerced into a string before being logged.
    */
@@ -121,7 +135,8 @@ class WorkniceIntegrationLogger {
       format: "simple",
       stack: false
     });
-    this.options.logger.error(verboseMessage);
+    const meta = { correlationId: this.options.correlationId };
+    this.options.logger.error(verboseMessage, meta);
     this.enqueue(simpleMessage);
     return simpleMessage;
   }
@@ -162,7 +177,7 @@ class WorkniceIntegrationLogger {
       `,
       {
         // Only create a new log the first time the logger is flushed.
-        createNewLog: this.logCreated === false,
+        createNewLog: !this.logCreated,
         entries,
         integrationId: this.integrationId,
         integrationLogId: this.integrationLogId
@@ -182,14 +197,16 @@ class WorkniceIntegrationLogger {
    * logger and flushed to the Worknice integration logs if/when connected.
    */
   info(message) {
-    this.options.logger.info(message);
+    const meta = { correlationId: this.options.correlationId };
+    this.options.logger.info(message, meta);
     this.enqueue(message);
   }
   timeSinceLastFlush() {
     return this.lastFlush === null ? Number.MAX_SAFE_INTEGER : Temporal.Now.instant().since(this.lastFlush).total("milliseconds");
   }
   warn(message) {
-    this.options.logger.warn(message);
+    const meta = { correlationId: this.options.correlationId };
+    this.options.logger.warn(message, meta);
     this.enqueue(message);
   }
 }

package/dist/api/WorkniceIntegrationLogger.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/api/WorkniceIntegrationLogger.ts"],"sourcesContent":["import gql from \"dedent\";\nimport { Temporal } from \"temporal-polyfill\";\nimport { v4 as uuid } from \"uuid\";\n\nimport errorToString from \"../utils/errorToString.js\";\nimport type { WorkniceClient } from \"./_types.js\";\n\nexport type Logger = Pick<Console, \"debug\" | \"error\" | \"info\" | \"warn\"> &\n  Partial<Pick<Console, \"group\" | \"groupEnd\">>;\n\nexport type WorkniceIntegrationLoggerOptions = {\n  /**\n   * The type of log to use for debug messages. If set to \"debug\", debug\n   * messages will be logged using the logger.debug() method, but  if set to\n   * \"info\", debug messages will be logged using the logger.info() method.\n   *\n   * Irrespective of this option, debug messages are only logged to the\n   * configured logger and are never sent to the Worknice integration logs.\n   *\n   * Defaults to \"debug\".\n   */\n  debugLogType: \"debug\" | \"info\";\n\n  /**\n   * The delay between flushes in milliseconds. Defaults to 1000 (1 second).\n   */\n  delayBetweenFlushes: number;\n\n  /**\n   * A Console-like object with which messages will be logger.\n   */\n  logger: Logger;\n};\n\n/**\n * A logger that can log messages to both a Console-like object and to a\n * Worknice integration's logs which can be viewed by a Worknice user.\n *\n * By default, messages are only logged to the configured logger, but when a\n * Worknice integration is connected using the connect() method, the messages\n * will also be sent to the Worknice integration logs.\n *\n * @example\n * ```js\n * const logger = new WorkniceIntegrationLogger();\n * logger.info(\"Hello, World!\");\n * logger.debug(\"This message will only be logged to the console.\");\n * logger.error(Error(\"This is an error message.\")); // full stack traces are logged to the console, but only the error message is sent to Worknice\n * logger.connect(workniceClient, integrationId); // connect the logger to a Worknice integration (can be done at any time, messages are buffered until the logger is connected)\n * logger.indent(\"Hello again!\"); // subsequent messages will be indented\n * logger.info(\"This message is indented.\"); // indented\n * logger.dedent(\"Goodbye!\"); // indented, subsequent messages will not be indented\n * await logger.flush(); // sends any unsent messages to Worknice (should be called at the end of the script to ensure all messages are sent)\n * ```\n */\nclass WorkniceIntegrationLogger {\n  /**\n   * The Worknice client used to send the logs to the server. If null, the logs\n   * will be buffered until the logger is initialized.\n   */\n  private client: WorkniceClient | null = null;\n\n  /**\n   * A promise used to ensure that only one request is in progress at a time. If\n   * a flush is called while a request is in progress, the flush will wait for\n   * the request to finish before starting a new one.\n   */\n  private currentRequest: Promise<unknown> | null = null;\n\n  /**\n   * The integration ID the logs will be associated with. If undefined, the\n   * logs will be buffered until the logger has been initialized.\n   */\n  private integrationId: string | undefined = undefined;\n\n  /**\n   * The random ID for the integration log to which the logs will be appended.\n   */\n  private integrationLogId: string;\n\n  /**\n   * Determines when the logger should flush the logs. Calling info(), error(),\n   * warn(), indent() or dedent() will automatically flush the logs if the last\n   * flush was more than 1 second ago.\n   */\n  private lastFlush: Temporal.Instant | null = null;\n\n  /**\n   * A flag is used to determine whether a new log should be created when the\n   * logger is flushed. The first time the logger is flushed, a new log will be\n   * created. Subsequent flushes will append to the existing log.\n   */\n  private logCreated = false;\n\n  /**\n   * Backlog of log messages that have not yet been sent to Worknice. The logs\n   * will be sent to the server when the logger is flushed and the backlog will\n   * be cleared.\n   */\n  private logs: Array<{ time: Temporal.Instant; message: string }> = [];\n\n  /**\n   * Determines the current indentation level of the log messages. The indent()\n   * and dedent() functions can be used to increase or decrease the indentation\n   * level.\n   */\n  private messageIndent = 0;\n\n  private options: WorkniceIntegrationLoggerOptions;\n\n  private timeout: NodeJS.Timeout | null = null;\n\n  /**\n   * @param options.debugLogType The type of console logging to use for debug messages. Defaults to \"debug\".\n   * @param options.delayBetweenFlushes The delay between flushes in milliseconds. Defaults to 1000 (1 second).\n   * @param options.logger A Console-like object with which messages can be logged. Defaults to the global console object.\n   * @example\n   * ```js\n   * const logger = new WorkniceIntegrationLogger({ logger: console });\n   * ```\n   */\n  constructor(options?: Partial<WorkniceIntegrationLoggerOptions>) {\n    this.integrationLogId = uuid();\n    this.options = {\n      debugLogType: options?.debugLogType ?? \"debug\",\n      delayBetweenFlushes: options?.delayBetweenFlushes ?? 1000,\n      logger: options?.logger ?? console,\n    };\n  }\n\n  /**\n   * Connects the logger to a Worknice integration. If there are previously\n   * logged messages that need to be flushed, a new integration log will be\n   * instantly created and the messages flushed to it. Otherwise, an integration\n   * log will be created if/when the first message is logged.\n   */\n  public connect(client: WorkniceClient, integrationId: string) {\n    this.client = client;\n    this.integrationId = integrationId;\n    this.flush();\n  }\n\n  /**\n   * Logs a debug message. Debug messages are only logged to the configured logger\n   * and are never sent to the Worknice integration logs.\n   */\n  public debug(message: string) {\n    if (this.options.debugLogType === \"debug\") this.options.logger.debug(message);\n    else this.options.logger.info(message);\n  }\n\n  public dedent(message?: string) {\n    if (message !== undefined) this.info(message);\n    if (this.options.logger.groupEnd) this.options.logger.groupEnd();\n    this.messageIndent = Math.max(0, this.messageIndent - 1);\n  }\n\n  private enqueue(message: string) {\n    this.logs.push({\n      time: Temporal.Now.instant(),\n      message: message\n        .split(\"\\n\")\n        .map((line) => `${\" \".repeat(this.messageIndent * 2)}${line}`)\n        .join(\"\\n\"),\n    });\n\n    // If the last flush was more than the delay between flushes, flush the logs\n    // immediately. Otherwise, schedule a new flush unless one is already\n    // scheduled.\n    if (this.timeSinceLastFlush() >= this.options.delayBetweenFlushes) {\n      this.flush();\n    } else if (this.timeout === null) {\n      this.timeout = setTimeout(() => {\n        if (this.timeSinceLastFlush() >= this.options.delayBetweenFlushes) {\n          this.flush();\n        }\n      }, this.options.delayBetweenFlushes - this.timeSinceLastFlush());\n    }\n  }\n\n  /**\n   * Logs an error of any type. The error will be logged to the configured logger\n   * with full stack traces and a chain of error causes. A simplified error\n   * message will sent to the Worknice integration logs (if connected) and\n   * returned for displaying to the user. If the error is not an instance of\n   * Error, it will be coerced into a string before being logged.\n   */\n  public error(error: unknown) {\n    const verboseMessage = errorToString(error, {\n      format: \"chain\",\n      stack: true,\n    });\n\n    const simpleMessage = errorToString(error, {\n      format: \"simple\",\n      stack: false,\n    });\n\n    this.options.logger.error(verboseMessage);\n    this.enqueue(simpleMessage);\n\n    return simpleMessage;\n  }\n\n  /**\n   * Flushes the log buffer to the server. The info() function will\n   * automatically flush the logs if the last flush was more than 1 second\n   * ago, but the flush() function should be called manually at the end of the\n   * script to ensure that all logs are sent to the server.\n   */\n  public async flush() {\n    // Clear any scheduled flushes.\n    if (this.timeout) {\n      clearTimeout(this.timeout);\n      this.timeout = null;\n    }\n\n    // Update the last flush time to the current time so that any calls to\n    // enqueue will not unnecessarily try to flush the logs again.\n    this.lastFlush = Temporal.Now.instant();\n\n    // If there's already a request in progress, wait for it to finish before\n    // starting a new one.\n    if (this.currentRequest) await this.currentRequest;\n\n    // If there are no pending logs or the logger hasn't been initialized,\n    // don't do anything (any logs will remain in the buffer until the next\n    // flush).\n    if (this.logs.length === 0 || this.client === null || this.integrationId === null) return;\n\n    const entries = this.logs.splice(0).map(({ time, message }) => ({\n      time: time.toString({ timeZone: \"Australia/Sydney\", smallestUnit: \"second\" }),\n      message,\n    }));\n\n    this.currentRequest = this.client.fetchFromApi(\n      gql`\n        mutation AppendIntegrationLog(\n          $createNewLog: Boolean!\n          $entries: [IntegrationLogInput!]!\n          $integrationId: ID!\n          $integrationLogId: ID!\n        ) {\n          createIntegrationLog(integrationId: $integrationId, integrationLogId: $integrationLogId)\n            @include(if: $createNewLog) {\n            id\n          }\n          appendIntegrationLog(integrationLogId: $integrationLogId, entries: $entries) {\n            id\n          }\n        }\n      `,\n      {\n        // Only create a new log the first time the logger is flushed.\n        createNewLog: this.logCreated === false,\n        entries,\n        integrationId: this.integrationId,\n        integrationLogId: this.integrationLogId,\n      },\n    );\n\n    // Only create a new log the first time the logger is flushed.\n    this.logCreated = true;\n\n    await this.currentRequest;\n\n    // Clear the request promise so that the next flush can start a new request.\n    this.currentRequest = null;\n  }\n\n  public indent(message?: string) {\n    if (message !== undefined) this.info(message);\n    if (this.options.logger.group) this.options.logger.group();\n    this.messageIndent += 1;\n  }\n\n  /**\n   * Logs an informational message. The message will be logged to the configured\n   * logger and flushed to the Worknice integration logs if/when connected.\n   */\n  public info(message: string) {\n    this.options.logger.info(message);\n    this.enqueue(message);\n  }\n\n  private timeSinceLastFlush() {\n    return this.lastFlush === null\n      ? Number.MAX_SAFE_INTEGER\n      : Temporal.Now.instant().since(this.lastFlush).total(\"milliseconds\");\n  }\n\n  public warn(message: string) {\n    this.options.logger.warn(message);\n    this.enqueue(message);\n  }\n}\n\nexport default WorkniceIntegrationLogger;\n"],"mappings":"AAAA,OAAO,SAAS;AAChB,SAAS,gBAAgB;AACzB,SAAS,MAAM,YAAY;AAE3B,OAAO,mBAAmB;AAmD1B,MAAM,0BAA0B;AAAA;AAAA;AAAA;AAAA;AAAA,EAKtB,SAAgC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOhC,iBAA0C;AAAA;AAAA;AAAA;AAAA;AAAA,EAM1C,gBAAoC;AAAA;AAAA;AAAA;AAAA,EAKpC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,YAAqC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOrC,aAAa;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOb,OAA2D,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAO5D,gBAAgB;AAAA,EAEhB;AAAA,EAEA,UAAiC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWzC,YAAY,SAAqD;AAC/D,SAAK,mBAAmB,KAAK;AAC7B,SAAK,UAAU;AAAA,MACb,cAAc,SAAS,gBAAgB;AAAA,MACvC,qBAAqB,SAAS,uBAAuB;AAAA,MACrD,QAAQ,SAAS,UAAU;AAAA,IAC7B;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQO,QAAQ,QAAwB,eAAuB;AAC5D,SAAK,SAAS;AACd,SAAK,gBAAgB;AACrB,SAAK,MAAM;AAAA,EACb;AAAA;AAAA;AAAA;AAAA;AAAA,EAMO,MAAM,SAAiB;AAC5B,QAAI,KAAK,QAAQ,iBAAiB,QAAS,MAAK,QAAQ,OAAO,MAAM,OAAO;AAAA,QACvE,MAAK,QAAQ,OAAO,KAAK,OAAO;AAAA,EACvC;AAAA,EAEO,OAAO,SAAkB;AAC9B,QAAI,YAAY,OAAW,MAAK,KAAK,OAAO;AAC5C,QAAI,KAAK,QAAQ,OAAO,SAAU,MAAK,QAAQ,OAAO,SAAS;AAC/D,SAAK,gBAAgB,KAAK,IAAI,GAAG,KAAK,gBAAgB,CAAC;AAAA,EACzD;AAAA,EAEQ,QAAQ,SAAiB;AAC/B,SAAK,KAAK,KAAK;AAAA,MACb,MAAM,SAAS,IAAI,QAAQ;AAAA,MAC3B,SAAS,QACN,MAAM,IAAI,EACV,IAAI,CAAC,SAAS,GAAG,IAAI,OAAO,KAAK,gBAAgB,CAAC,CAAC,GAAG,IAAI,EAAE,EAC5D,KAAK,IAAI;AAAA,IACd,CAAC;AAKD,QAAI,KAAK,mBAAmB,KAAK,KAAK,QAAQ,qBAAqB;AACjE,WAAK,MAAM;AAAA,IACb,WAAW,KAAK,YAAY,MAAM;AAChC,WAAK,UAAU,WAAW,MAAM;AAC9B,YAAI,KAAK,mBAAmB,KAAK,KAAK,QAAQ,qBAAqB;AACjE,eAAK,MAAM;AAAA,QACb;AAAA,MACF,GAAG,KAAK,QAAQ,sBAAsB,KAAK,mBAAmB,CAAC;AAAA,IACjE;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASO,MAAM,OAAgB;AAC3B,UAAM,iBAAiB,cAAc,OAAO;AAAA,MAC1C,QAAQ;AAAA,MACR,OAAO;AAAA,IACT,CAAC;AAED,UAAM,gBAAgB,cAAc,OAAO;AAAA,MACzC,QAAQ;AAAA,MACR,OAAO;AAAA,IACT,CAAC;AAED,SAAK,QAAQ,OAAO,MAAM,cAAc;AACxC,SAAK,QAAQ,aAAa;AAE1B,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAa,QAAQ;AAEnB,QAAI,KAAK,SAAS;AAChB,mBAAa,KAAK,OAAO;AACzB,WAAK,UAAU;AAAA,IACjB;AAIA,SAAK,YAAY,SAAS,IAAI,QAAQ;AAItC,QAAI,KAAK,eAAgB,OAAM,KAAK;AAKpC,QAAI,KAAK,KAAK,WAAW,KAAK,KAAK,WAAW,QAAQ,KAAK,kBAAkB,KAAM;AAEnF,UAAM,UAAU,KAAK,KAAK,OAAO,CAAC,EAAE,IAAI,CAAC,EAAE,MAAM,QAAQ,OAAO;AAAA,MAC9D,MAAM,KAAK,SAAS,EAAE,UAAU,oBAAoB,cAAc,SAAS,CAAC;AAAA,MAC5E;AAAA,IACF,EAAE;AAEF,SAAK,iBAAiB,KAAK,OAAO;AAAA,MAChC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAgBA;AAAA;AAAA,QAEE,cAAc,KAAK,eAAe;AAAA,QAClC;AAAA,QACA,eAAe,KAAK;AAAA,QACpB,kBAAkB,KAAK;AAAA,MACzB;AAAA,IACF;AAGA,SAAK,aAAa;AAElB,UAAM,KAAK;AAGX,SAAK,iBAAiB;AAAA,EACxB;AAAA,EAEO,OAAO,SAAkB;AAC9B,QAAI,YAAY,OAAW,MAAK,KAAK,OAAO;AAC5C,QAAI,KAAK,QAAQ,OAAO,MAAO,MAAK,QAAQ,OAAO,MAAM;AACzD,SAAK,iBAAiB;AAAA,EACxB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMO,KAAK,SAAiB;AAC3B,SAAK,QAAQ,OAAO,KAAK,OAAO;AAChC,SAAK,QAAQ,OAAO;AAAA,EACtB;AAAA,EAEQ,qBAAqB;AAC3B,WAAO,KAAK,cAAc,OACtB,OAAO,mBACP,SAAS,IAAI,QAAQ,EAAE,MAAM,KAAK,SAAS,EAAE,MAAM,cAAc;AAAA,EACvE;AAAA,EAEO,KAAK,SAAiB;AAC3B,SAAK,QAAQ,OAAO,KAAK,OAAO;AAChC,SAAK,QAAQ,OAAO;AAAA,EACtB;AACF;AAEA,IAAO,oCAAQ;","names":[]}
+{"version":3,"sources":["../../src/api/WorkniceIntegrationLogger.ts"],"sourcesContent":["import gql from \"dedent\";\nimport { Temporal } from \"temporal-polyfill\";\nimport { v4 as uuid } from \"uuid\";\n\nimport errorToString from \"../utils/errorToString.js\";\nimport type { WorkniceClient } from \"./_types.js\";\n\nexport type Logger = Pick<Console, \"debug\" | \"error\" | \"info\" | \"warn\"> &\n  Partial<Pick<Console, \"group\" | \"groupEnd\">>;\n\nexport type WorkniceIntegrationLoggerOptions = {\n  /**\n   * The type of log to use for debug messages. If set to \"debug\", debug\n   * messages will be logged using the logger.debug() method, but  if set to\n   * \"info\", debug messages will be logged using the logger.info() method.\n   *\n   * Irrespective of this option, debug messages are only logged to the\n   * configured logger and are never sent to the Worknice integration logs.\n   *\n   * Defaults to \"debug\".\n   */\n  debugLogType: \"debug\" | \"info\";\n\n  /**\n   * The delay between flushes in milliseconds. Defaults to 1000 (1 second).\n   */\n  delayBetweenFlushes: number;\n\n  /**\n   * A Console-like object with which messages will be logger.\n   */\n  logger: Logger;\n\n  /**\n   * The correlation ID to include in all log messages.\n   */\n  correlationId?: string;\n};\n\n/**\n * A logger that can log messages to both a Console-like object and to a\n * Worknice integration's logs which can be viewed by a Worknice user.\n *\n * By default, messages are only logged to the configured logger, but when a\n * Worknice integration is connected using the connect() method, the messages\n * will also be sent to the Worknice integration logs.\n *\n * @example\n * ```js\n * const logger = new WorkniceIntegrationLogger();\n * logger.info(\"Hello, World!\");\n * logger.debug(\"This message will only be logged to the console.\");\n * logger.error(Error(\"This is an error message.\")); // full stack traces are logged to the console, but only the error message is sent to Worknice\n * logger.connect(workniceClient, integrationId); // connect the logger to a Worknice integration (can be done at any time, messages are buffered until the logger is connected)\n * logger.indent(\"Hello again!\"); // subsequent messages will be indented\n * logger.info(\"This message is indented.\"); // indented\n * logger.dedent(\"Goodbye!\"); // indented, subsequent messages will not be indented\n * await logger.flush(); // sends any unsent messages to Worknice (should be called at the end of the script to ensure all messages are sent)\n * ```\n */\nclass WorkniceIntegrationLogger {\n  /**\n   * The Worknice client used to send the logs to the server. If null, the logs\n   * will be buffered until the logger is initialized.\n   */\n  private client: WorkniceClient | null = null;\n\n  /**\n   * A promise used to ensure that only one request is in progress at a time. If\n   * a flush is called while a request is in progress, the flush will wait for\n   * the request to finish before starting a new one.\n   */\n  private currentRequest: Promise<unknown> | null = null;\n\n  /**\n   * The integration ID the logs will be associated with. If undefined, the\n   * logs will be buffered until the logger has been initialized.\n   */\n  private integrationId: string | undefined = undefined;\n\n  /**\n   * The ID for the integration log to which the logs will be appended.\n   * This is set to the same value as correlationId to enable easy tracing\n   * between integration logs visible to users and platform logs in Axiom.\n   */\n  public readonly integrationLogId: string;\n\n  /**\n   * Determines when the logger should flush the logs. Calling info(), error(),\n   * warn(), indent() or dedent() will automatically flush the logs if the last\n   * flush was more than 1 second ago.\n   */\n  private lastFlush: Temporal.Instant | null = null;\n\n  /**\n   * A flag is used to determine whether a new log should be created when the\n   * logger is flushed. The first time the logger is flushed, a new log will be\n   * created. Subsequent flushes will append to the existing log.\n   */\n  private logCreated = false;\n\n  /**\n   * Backlog of log messages that have not yet been sent to Worknice. The logs\n   * will be sent to the server when the logger is flushed and the backlog will\n   * be cleared.\n   */\n  private logs: Array<{ time: Temporal.Instant; message: string }> = [];\n\n  /**\n   * Determines the current indentation level of the log messages. The indent()\n   * and dedent() functions can be used to increase or decrease the indentation\n   * level.\n   */\n  private messageIndent = 0;\n\n  private options: WorkniceIntegrationLoggerOptions;\n\n  private timeout: NodeJS.Timeout | null = null;\n\n  /**\n   * @param options.debugLogType The type of console logging to use for debug messages. Defaults to \"debug\".\n   * @param options.delayBetweenFlushes The delay between flushes in milliseconds. Defaults to 1000 (1 second).\n   * @param options.logger A Console-like object with which messages can be logged. Defaults to the global console object.\n   * @param options.correlationId The correlation ID to include in all log messages.\n   * @example\n   * ```js\n   * const logger = new WorkniceIntegrationLogger({ logger: console, correlationId: \"abc123\" });\n   * ```\n   */\n  constructor(options?: Partial<WorkniceIntegrationLoggerOptions>) {\n    const correlationId = options?.correlationId?.trim() || uuid();\n    this.integrationLogId = correlationId;\n    this.options = {\n      debugLogType: options?.debugLogType ?? \"debug\",\n      delayBetweenFlushes: options?.delayBetweenFlushes ?? 1000,\n      logger: options?.logger ?? console,\n      correlationId,\n    };\n  }\n\n  /**\n   * Gets the correlation ID for this logger session.\n   * This will always return a value as correlationId is set during initialization.\n   */\n  get correlationId(): string {\n    return this.options.correlationId!;\n  }\n\n  /**\n   * Connects the logger to a Worknice integration. If there are previously\n   * logged messages that need to be flushed, a new integration log will be\n   * instantly created and the messages flushed to it. Otherwise, an integration\n   * log will be created if/when the first message is logged.\n   */\n  public connect(client: WorkniceClient, integrationId: string) {\n    this.client = client;\n    this.integrationId = integrationId;\n    this.flush();\n  }\n\n  /**\n   * Logs a debug message. Debug messages are only logged to the configured logger\n   * and are never sent to the Worknice integration logs.\n   */\n  public debug(message: string) {\n    const meta = { correlationId: this.options.correlationId };\n    if (this.options.debugLogType === \"debug\") {\n      this.options.logger.debug(message, meta);\n    } else this.options.logger.info(message, meta);\n  }\n\n  public dedent(message?: string) {\n    if (message !== undefined) this.info(message);\n    if (this.options.logger.groupEnd) this.options.logger.groupEnd();\n    this.messageIndent = Math.max(0, this.messageIndent - 1);\n  }\n\n  private enqueue(message: string) {\n    this.logs.push({\n      time: Temporal.Now.instant(),\n      message: message\n        .split(\"\\n\")\n        .map((line) => `${\" \".repeat(this.messageIndent * 2)}${line}`)\n        .join(\"\\n\"),\n    });\n\n    // If the last flush was more than the delay between flushes, flush the logs\n    // immediately. Otherwise, schedule a new flush unless one is already\n    // scheduled.\n    if (this.timeSinceLastFlush() >= this.options.delayBetweenFlushes) {\n      this.flush();\n    } else if (this.timeout === null) {\n      this.timeout = setTimeout(() => {\n        if (this.timeSinceLastFlush() >= this.options.delayBetweenFlushes) {\n          this.flush();\n        }\n      }, this.options.delayBetweenFlushes - this.timeSinceLastFlush());\n    }\n  }\n\n  /**\n   * Logs an error of any type. The error will be logged to the configured logger\n   * with full stack traces and a chain of error causes. A simplified error\n   * message will be sent to the Worknice integration logs (if connected) and\n   * returned for displaying to the user. If the error is not an instance of\n   * Error, it will be coerced into a string before being logged.\n   */\n  public error(error: unknown) {\n    const verboseMessage = errorToString(error, {\n      format: \"chain\",\n      stack: true,\n    });\n\n    const simpleMessage = errorToString(error, {\n      format: \"simple\",\n      stack: false,\n    });\n\n    const meta = { correlationId: this.options.correlationId };\n    this.options.logger.error(verboseMessage, meta);\n    this.enqueue(simpleMessage);\n\n    return simpleMessage;\n  }\n\n  /**\n   * Flushes the log buffer to the server. The info() function will\n   * automatically flush the logs if the last flush was more than 1 second\n   * ago, but the flush() function should be called manually at the end of the\n   * script to ensure that all logs are sent to the server.\n   */\n  public async flush() {\n    // Clear any scheduled flushes.\n    if (this.timeout) {\n      clearTimeout(this.timeout);\n      this.timeout = null;\n    }\n\n    // Update the last flush time to the current time so that any calls to\n    // enqueue will not unnecessarily try to flush the logs again.\n    this.lastFlush = Temporal.Now.instant();\n\n    // If there's already a request in progress, wait for it to finish before\n    // starting a new one.\n    if (this.currentRequest) await this.currentRequest;\n\n    // If there are no pending logs or the logger hasn't been initialized,\n    // don't do anything (any logs will remain in the buffer until the next\n    // flush).\n    if (this.logs.length === 0 || this.client === null || this.integrationId === null) return;\n\n    const entries = this.logs.splice(0).map(({ time, message }) => ({\n      time: time.toString({ timeZone: \"Australia/Sydney\", smallestUnit: \"second\" }),\n      message,\n    }));\n\n    this.currentRequest = this.client.fetchFromApi(\n      gql`\n        mutation AppendIntegrationLog(\n          $createNewLog: Boolean!\n          $entries: [IntegrationLogInput!]!\n          $integrationId: ID!\n          $integrationLogId: ID!\n        ) {\n          createIntegrationLog(integrationId: $integrationId, integrationLogId: $integrationLogId)\n            @include(if: $createNewLog) {\n            id\n          }\n          appendIntegrationLog(integrationLogId: $integrationLogId, entries: $entries) {\n            id\n          }\n        }\n      `,\n      {\n        // Only create a new log the first time the logger is flushed.\n        createNewLog: !this.logCreated,\n        entries,\n        integrationId: this.integrationId,\n        integrationLogId: this.integrationLogId,\n      },\n    );\n\n    // Only create a new log the first time the logger is flushed.\n    this.logCreated = true;\n\n    await this.currentRequest;\n\n    // Clear the request promise so that the next flush can start a new request.\n    this.currentRequest = null;\n  }\n\n  public indent(message?: string) {\n    if (message !== undefined) this.info(message);\n    if (this.options.logger.group) this.options.logger.group();\n    this.messageIndent += 1;\n  }\n\n  /**\n   * Logs an informational message. The message will be logged to the configured\n   * logger and flushed to the Worknice integration logs if/when connected.\n   */\n  public info(message: string) {\n    const meta = { correlationId: this.options.correlationId };\n    this.options.logger.info(message, meta);\n    this.enqueue(message);\n  }\n\n  private timeSinceLastFlush() {\n    return this.lastFlush === null\n      ? Number.MAX_SAFE_INTEGER\n      : Temporal.Now.instant().since(this.lastFlush).total(\"milliseconds\");\n  }\n\n  public warn(message: string) {\n    const meta = { correlationId: this.options.correlationId };\n    this.options.logger.warn(message, meta);\n    this.enqueue(message);\n  }\n}\n\nexport default WorkniceIntegrationLogger;\n"],"mappings":"AAAA,OAAO,SAAS;AAChB,SAAS,gBAAgB;AACzB,SAAS,MAAM,YAAY;AAE3B,OAAO,mBAAmB;AAwD1B,MAAM,0BAA0B;AAAA;AAAA;AAAA;AAAA;AAAA,EAKtB,SAAgC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOhC,iBAA0C;AAAA;AAAA;AAAA;AAAA;AAAA,EAM1C,gBAAoC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAO5B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOR,YAAqC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOrC,aAAa;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOb,OAA2D,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAO5D,gBAAgB;AAAA,EAEhB;AAAA,EAEA,UAAiC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYzC,YAAY,SAAqD;AAC/D,UAAM,gBAAgB,SAAS,eAAe,KAAK,KAAK,KAAK;AAC7D,SAAK,mBAAmB;AACxB,SAAK,UAAU;AAAA,MACb,cAAc,SAAS,gBAAgB;AAAA,MACvC,qBAAqB,SAAS,uBAAuB;AAAA,MACrD,QAAQ,SAAS,UAAU;AAAA,MAC3B;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,IAAI,gBAAwB;AAC1B,WAAO,KAAK,QAAQ;AAAA,EACtB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQO,QAAQ,QAAwB,eAAuB;AAC5D,SAAK,SAAS;AACd,SAAK,gBAAgB;AACrB,SAAK,MAAM;AAAA,EACb;AAAA;AAAA;AAAA;AAAA;AAAA,EAMO,MAAM,SAAiB;AAC5B,UAAM,OAAO,EAAE,eAAe,KAAK,QAAQ,cAAc;AACzD,QAAI,KAAK,QAAQ,iBAAiB,SAAS;AACzC,WAAK,QAAQ,OAAO,MAAM,SAAS,IAAI;AAAA,IACzC,MAAO,MAAK,QAAQ,OAAO,KAAK,SAAS,IAAI;AAAA,EAC/C;AAAA,EAEO,OAAO,SAAkB;AAC9B,QAAI,YAAY,OAAW,MAAK,KAAK,OAAO;AAC5C,QAAI,KAAK,QAAQ,OAAO,SAAU,MAAK,QAAQ,OAAO,SAAS;AAC/D,SAAK,gBAAgB,KAAK,IAAI,GAAG,KAAK,gBAAgB,CAAC;AAAA,EACzD;AAAA,EAEQ,QAAQ,SAAiB;AAC/B,SAAK,KAAK,KAAK;AAAA,MACb,MAAM,SAAS,IAAI,QAAQ;AAAA,MAC3B,SAAS,QACN,MAAM,IAAI,EACV,IAAI,CAAC,SAAS,GAAG,IAAI,OAAO,KAAK,gBAAgB,CAAC,CAAC,GAAG,IAAI,EAAE,EAC5D,KAAK,IAAI;AAAA,IACd,CAAC;AAKD,QAAI,KAAK,mBAAmB,KAAK,KAAK,QAAQ,qBAAqB;AACjE,WAAK,MAAM;AAAA,IACb,WAAW,KAAK,YAAY,MAAM;AAChC,WAAK,UAAU,WAAW,MAAM;AAC9B,YAAI,KAAK,mBAAmB,KAAK,KAAK,QAAQ,qBAAqB;AACjE,eAAK,MAAM;AAAA,QACb;AAAA,MACF,GAAG,KAAK,QAAQ,sBAAsB,KAAK,mBAAmB,CAAC;AAAA,IACjE;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASO,MAAM,OAAgB;AAC3B,UAAM,iBAAiB,cAAc,OAAO;AAAA,MAC1C,QAAQ;AAAA,MACR,OAAO;AAAA,IACT,CAAC;AAED,UAAM,gBAAgB,cAAc,OAAO;AAAA,MACzC,QAAQ;AAAA,MACR,OAAO;AAAA,IACT,CAAC;AAED,UAAM,OAAO,EAAE,eAAe,KAAK,QAAQ,cAAc;AACzD,SAAK,QAAQ,OAAO,MAAM,gBAAgB,IAAI;AAC9C,SAAK,QAAQ,aAAa;AAE1B,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAa,QAAQ;AAEnB,QAAI,KAAK,SAAS;AAChB,mBAAa,KAAK,OAAO;AACzB,WAAK,UAAU;AAAA,IACjB;AAIA,SAAK,YAAY,SAAS,IAAI,QAAQ;AAItC,QAAI,KAAK,eAAgB,OAAM,KAAK;AAKpC,QAAI,KAAK,KAAK,WAAW,KAAK,KAAK,WAAW,QAAQ,KAAK,kBAAkB,KAAM;AAEnF,UAAM,UAAU,KAAK,KAAK,OAAO,CAAC,EAAE,IAAI,CAAC,EAAE,MAAM,QAAQ,OAAO;AAAA,MAC9D,MAAM,KAAK,SAAS,EAAE,UAAU,oBAAoB,cAAc,SAAS,CAAC;AAAA,MAC5E;AAAA,IACF,EAAE;AAEF,SAAK,iBAAiB,KAAK,OAAO;AAAA,MAChC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAgBA;AAAA;AAAA,QAEE,cAAc,CAAC,KAAK;AAAA,QACpB;AAAA,QACA,eAAe,KAAK;AAAA,QACpB,kBAAkB,KAAK;AAAA,MACzB;AAAA,IACF;AAGA,SAAK,aAAa;AAElB,UAAM,KAAK;AAGX,SAAK,iBAAiB;AAAA,EACxB;AAAA,EAEO,OAAO,SAAkB;AAC9B,QAAI,YAAY,OAAW,MAAK,KAAK,OAAO;AAC5C,QAAI,KAAK,QAAQ,OAAO,MAAO,MAAK,QAAQ,OAAO,MAAM;AACzD,SAAK,iBAAiB;AAAA,EACxB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMO,KAAK,SAAiB;AAC3B,UAAM,OAAO,EAAE,eAAe,KAAK,QAAQ,cAAc;AACzD,SAAK,QAAQ,OAAO,KAAK,SAAS,IAAI;AACtC,SAAK,QAAQ,OAAO;AAAA,EACtB;AAAA,EAEQ,qBAAqB;AAC3B,WAAO,KAAK,cAAc,OACtB,OAAO,mBACP,SAAS,IAAI,QAAQ,EAAE,MAAM,KAAK,SAAS,EAAE,MAAM,cAAc;AAAA,EACvE;AAAA,EAEO,KAAK,SAAiB;AAC3B,UAAM,OAAO,EAAE,eAAe,KAAK,QAAQ,cAAc;AACzD,SAAK,QAAQ,OAAO,KAAK,SAAS,IAAI;AACtC,SAAK,QAAQ,OAAO;AAAA,EACtB;AACF;AAEA,IAAO,oCAAQ;","names":[]}

package/dist/api/_generated.d.ts

@@ -2916,6 +2916,8 @@ type MutationCreateTagsArgs = {
 type MutationCreateTaskArgs = {
     id?: InputMaybe<Scalars['ID']['input']>;
     ownerId: Scalars['ID']['input'];
+    subjectId?: InputMaybe<Scalars['ID']['input']>;
+    submissionDueAt?: InputMaybe<Scalars['Date']['input']>;
     templateId: Scalars['ID']['input'];
     templateParameters?: InputMaybe<Array<TemplateParameterInput>>;
 };