@worknice/js-sdk 0.0.1 → 0.0.3

package/dist/api/WorkniceIntegrationLogger.d.ts

@@ -0,0 +1,99 @@
+import { W as WorkniceClient } from '../_types-BXw9D0Qi.js';
+import './_generated.js';
+
+type Logger = Pick<Console, "debug" | "error" | "info" | "warn"> & Partial<Pick<Console, "group" | "groupEnd">>;
+declare class WorkniceIntegrationLogger {
+    /**
+     * The Worknice client used to send the logs to the server. If null, the logs
+     * will be buffered until the logger is initialized.
+     */
+    private client;
+    /**
+     * A promise used to ensure that only one request is in progress at a time. If
+     * a flush is called while a request is in progress, the flush will wait for
+     * the request to finish before starting a new one.
+     */
+    private currentRequest;
+    /**
+     * The integration ID the logs will be associated with. If undefined, the
+     * logs will be buffered until the logger has been initialized.
+     */
+    private integrationId;
+    /**
+     * The random ID for the integration log to which the logs will be appended.
+     */
+    private integrationLogId;
+    /**
+     * Determines when the logger should flush the logs. Calling info(), error(),
+     * warn(), indent() or dedent() will automatically flush the logs if the last
+     * flush was more than 1 second ago.
+     */
+    private lastFlush;
+    /**
+     * A flag is used to determine whether a new log should be created when the
+     * logger is flushed. The first time the logger is flushed, a new log will be
+     * created. Subsequent flushes will append to the existing log.
+     */
+    private logCreated;
+    /**
+     * A Console-like object with which messages will be logger.
+     */
+    private logger;
+    /**
+     * Backlog of log messages that have not yet been sent to Worknice. The logs
+     * will be sent to the server when the logger is flushed and the backlog will
+     * be cleared.
+     */
+    private logs;
+    /**
+     * Determines the current indentation level of the log messages. The indent()
+     * and dedent() functions can be used to increase or decrease the indentation
+     * level.
+     */
+    private messageIndent;
+    /**
+     * A logger can log messages to both a Console-like object and to a Worknice
+     * integration's logs which can be view by a Worknice user. By default,
+     * messages are only logged to the console, but when a Worknice integration is
+     * connected using the connect() method, the messages will also be logged to
+     * Worknice.
+     * @param logger A Console-like object with which messages can be logged.
+     * @example
+     * ```js
+     * const logger = new WorkniceIntegrationLogger(console);
+     * ```
+     */
+    constructor(logger?: Logger);
+    /**
+     * Connects the logger to a Worknice integration. If there are previously
+     * logged messages that need to be flushed, a new integration log will be
+     * instantly created and the messages flushed to it. Otherwise, an integration
+     * log will be created if/when the first message is logged.
+     */
+    connect(client: WorkniceClient, integrationId: string): void;
+    /**
+     * Logs a debug message. Debug messages are only logged to the console and are
+     * never append to the Worknice integration logs.
+     */
+    debug(message: string): void;
+    dedent(message?: string): void;
+    private enqueue;
+    error(message: string): void;
+    /**
+     * Flushes the log buffer to the server. The info() function will
+     * automatically flush the logs if the last flush was more than 1 second
+     * ago, but the flush() function should be called manually at the end of the
+     * script to ensure that all logs are sent to the server.
+     */
+    flush(): Promise<void>;
+    indent(message?: string): void;
+    /**
+     * Logs an informational message. The message will be appended to the log
+     * buffer and flushed to the server if the last flush was more than 1 second
+     * ago.
+     */
+    info(message: string): void;
+    warn(message: string): void;
+}
+
+export { type Logger, WorkniceIntegrationLogger as default };

package/dist/api/WorkniceIntegrationLogger.js

@@ -0,0 +1,173 @@
+import gql from "dedent";
+import { Temporal } from "temporal-polyfill";
+import { v4 as uuid } from "uuid";
+class WorkniceIntegrationLogger {
+  /**
+   * The Worknice client used to send the logs to the server. If null, the logs
+   * will be buffered until the logger is initialized.
+   */
+  client = null;
+  /**
+   * A promise used to ensure that only one request is in progress at a time. If
+   * a flush is called while a request is in progress, the flush will wait for
+   * the request to finish before starting a new one.
+   */
+  currentRequest = null;
+  /**
+   * The integration ID the logs will be associated with. If undefined, the
+   * logs will be buffered until the logger has been initialized.
+   */
+  integrationId = void 0;
+  /**
+   * The random ID for the integration log to which the logs will be appended.
+   */
+  integrationLogId;
+  /**
+   * Determines when the logger should flush the logs. Calling info(), error(),
+   * warn(), indent() or dedent() will automatically flush the logs if the last
+   * flush was more than 1 second ago.
+   */
+  lastFlush = null;
+  /**
+   * A flag is used to determine whether a new log should be created when the
+   * logger is flushed. The first time the logger is flushed, a new log will be
+   * created. Subsequent flushes will append to the existing log.
+   */
+  logCreated = false;
+  /**
+   * A Console-like object with which messages will be logger.
+   */
+  logger;
+  /**
+   * Backlog of log messages that have not yet been sent to Worknice. The logs
+   * will be sent to the server when the logger is flushed and the backlog will
+   * be cleared.
+   */
+  logs = [];
+  /**
+   * Determines the current indentation level of the log messages. The indent()
+   * and dedent() functions can be used to increase or decrease the indentation
+   * level.
+   */
+  messageIndent = 0;
+  /**
+   * A logger can log messages to both a Console-like object and to a Worknice
+   * integration's logs which can be view by a Worknice user. By default,
+   * messages are only logged to the console, but when a Worknice integration is
+   * connected using the connect() method, the messages will also be logged to
+   * Worknice.
+   * @param logger A Console-like object with which messages can be logged.
+   * @example
+   * ```js
+   * const logger = new WorkniceIntegrationLogger(console);
+   * ```
+   */
+  constructor(logger) {
+    this.logger = logger ?? console;
+    this.integrationLogId = uuid();
+  }
+  /**
+   * Connects the logger to a Worknice integration. If there are previously
+   * logged messages that need to be flushed, a new integration log will be
+   * instantly created and the messages flushed to it. Otherwise, an integration
+   * log will be created if/when the first message is logged.
+   */
+  connect(client, integrationId) {
+    this.client = client;
+    this.integrationId = integrationId;
+    if (this.lastFlush === null || Temporal.Now.instant().since(this.lastFlush).seconds >= 1) {
+      this.flush();
+    }
+  }
+  /**
+   * Logs a debug message. Debug messages are only logged to the console and are
+   * never append to the Worknice integration logs.
+   */
+  debug(message) {
+    this.logger.debug(message);
+  }
+  dedent(message) {
+    if (message !== void 0) this.info(message);
+    if (this.logger.groupEnd) this.logger.groupEnd();
+    this.messageIndent = Math.max(0, this.messageIndent - 1);
+  }
+  enqueue(message) {
+    this.logs.push({
+      time: Temporal.Now.instant(),
+      message: message.split("\n").map((line) => `${" ".repeat(this.messageIndent * 2)}${line}`).join("\n")
+    });
+    if (this.lastFlush === null || Temporal.Now.instant().since(this.lastFlush).seconds >= 1) {
+      this.flush();
+    }
+  }
+  error(message) {
+    this.logger.error(message);
+    this.enqueue(message);
+  }
+  /**
+   * Flushes the log buffer to the server. The info() function will
+   * automatically flush the logs if the last flush was more than 1 second
+   * ago, but the flush() function should be called manually at the end of the
+   * script to ensure that all logs are sent to the server.
+   */
+  async flush() {
+    if (this.currentRequest) await this.currentRequest;
+    if (this.logs.length === 0 || this.client === null || this.integrationId === null) return;
+    this.lastFlush = Temporal.Now.instant();
+    const entries = this.logs.splice(0).map(({ time, message }) => ({
+      time: time.toString({ timeZone: "Australia/Sydney", smallestUnit: "second" }),
+      message
+    }));
+    this.currentRequest = this.client.fetchFromApi(
+      gql`
+        mutation AppendIntegrationLog(
+          $createNewLog: Boolean!
+          $entries: [IntegrationLogInput!]!
+          $integrationId: ID!
+          $integrationLogId: ID!
+        ) {
+          createIntegrationLog(integrationId: $integrationId, integrationLogId: $integrationLogId)
+            @include(if: $createNewLog) {
+            id
+          }
+          appendIntegrationLog(integrationLogId: $integrationLogId, entries: $entries) {
+            id
+          }
+        }
+      `,
+      {
+        // Only create a new log the first time the logger is flushed.
+        createNewLog: this.logCreated === false,
+        entries,
+        integrationId: this.integrationId,
+        integrationLogId: this.integrationLogId
+      }
+    );
+    this.logCreated = true;
+    await this.currentRequest;
+    this.currentRequest = null;
+  }
+  indent(message) {
+    if (message !== void 0) this.info(message);
+    if (this.logger.group) this.logger.group();
+    this.messageIndent += 1;
+  }
+  /**
+   * Logs an informational message. The message will be appended to the log
+   * buffer and flushed to the server if the last flush was more than 1 second
+   * ago.
+   */
+  info(message) {
+    this.logger.info(message);
+    this.enqueue(message);
+  }
+  warn(message) {
+    this.logger.warn(message);
+    this.enqueue(message);
+  }
+}
+var WorkniceIntegrationLogger_default = WorkniceIntegrationLogger;
+export {
+  WorkniceIntegrationLogger_default as default
+};
+//# sourceMappingURL=WorkniceIntegrationLogger.js.map

package/dist/api/WorkniceIntegrationLogger.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/api/WorkniceIntegrationLogger.ts"],"sourcesContent":["import gql from \"dedent\";\nimport { Temporal } from \"temporal-polyfill\";\nimport { v4 as uuid } from \"uuid\";\nimport type { WorkniceClient } from \"./_types.js\";\n\nexport type Logger = Pick<Console, \"debug\" | \"error\" | \"info\" | \"warn\"> &\n  Partial<Pick<Console, \"group\" | \"groupEnd\">>;\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   * A Console-like object with which messages will be logger.\n   */\n  private logger: Logger;\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  /**\n   * A logger can log messages to both a Console-like object and to a Worknice\n   * integration's logs which can be view by a Worknice user. By default,\n   * messages are only logged to the console, but when a Worknice integration is\n   * connected using the connect() method, the messages will also be logged to\n   * Worknice.\n   * @param logger A Console-like object with which messages can be logged.\n   * @example\n   * ```js\n   * const logger = new WorkniceIntegrationLogger(console);\n   * ```\n   */\n  constructor(logger?: Logger) {\n    this.logger = logger ?? console;\n    this.integrationLogId = uuid();\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    if (this.lastFlush === null || Temporal.Now.instant().since(this.lastFlush).seconds >= 1) {\n      this.flush();\n    }\n  }\n\n  /**\n   * Logs a debug message. Debug messages are only logged to the console and are\n   * never append to the Worknice integration logs.\n   */\n  public debug(message: string) {\n    this.logger.debug(message);\n  }\n\n  public dedent(message?: string) {\n    if (message !== undefined) this.info(message);\n    if (this.logger.groupEnd) this.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 (this.lastFlush === null || Temporal.Now.instant().since(this.lastFlush).seconds >= 1) {\n      this.flush();\n    }\n  }\n\n  public error(message: string) {\n    this.logger.error(message);\n    this.enqueue(message);\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    // 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    this.lastFlush = Temporal.Now.instant();\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.logger.group) this.logger.group();\n    this.messageIndent += 1;\n  }\n\n  /**\n   * Logs an informational message. The message will be appended to the log\n   * buffer and flushed to the server if the last flush was more than 1 second\n   * ago.\n   */\n  public info(message: string) {\n    this.logger.info(message);\n    this.enqueue(message);\n  }\n\n  public warn(message: string) {\n    this.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;AAM3B,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,EAKb;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAA2D,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAO5D,gBAAgB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcxB,YAAY,QAAiB;AAC3B,SAAK,SAAS,UAAU;AACxB,SAAK,mBAAmB,KAAK;AAAA,EAC/B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQO,QAAQ,QAAwB,eAAuB;AAC5D,SAAK,SAAS;AACd,SAAK,gBAAgB;AACrB,QAAI,KAAK,cAAc,QAAQ,SAAS,IAAI,QAAQ,EAAE,MAAM,KAAK,SAAS,EAAE,WAAW,GAAG;AACxF,WAAK,MAAM;AAAA,IACb;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAMO,MAAM,SAAiB;AAC5B,SAAK,OAAO,MAAM,OAAO;AAAA,EAC3B;AAAA,EAEO,OAAO,SAAkB;AAC9B,QAAI,YAAY,OAAW,MAAK,KAAK,OAAO;AAC5C,QAAI,KAAK,OAAO,SAAU,MAAK,OAAO,SAAS;AAC/C,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;AAED,QAAI,KAAK,cAAc,QAAQ,SAAS,IAAI,QAAQ,EAAE,MAAM,KAAK,SAAS,EAAE,WAAW,GAAG;AACxF,WAAK,MAAM;AAAA,IACb;AAAA,EACF;AAAA,EAEO,MAAM,SAAiB;AAC5B,SAAK,OAAO,MAAM,OAAO;AACzB,SAAK,QAAQ,OAAO;AAAA,EACtB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAa,QAAQ;AAGnB,QAAI,KAAK,eAAgB,OAAM,KAAK;AAKpC,QAAI,KAAK,KAAK,WAAW,KAAK,KAAK,WAAW,QAAQ,KAAK,kBAAkB,KAAM;AAEnF,SAAK,YAAY,SAAS,IAAI,QAAQ;AAEtC,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,OAAO,MAAO,MAAK,OAAO,MAAM;AACzC,SAAK,iBAAiB;AAAA,EACxB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOO,KAAK,SAAiB;AAC3B,SAAK,OAAO,KAAK,OAAO;AACxB,SAAK,QAAQ,OAAO;AAAA,EACtB;AAAA,EAEO,KAAK,SAAiB;AAC3B,SAAK,OAAO,KAAK,OAAO;AACxB,SAAK,QAAQ,OAAO;AAAA,EACtB;AACF;AAEA,IAAO,oCAAQ;","names":[]}