loop-client 0.0.1

package/build/utils.js

@@ -0,0 +1,136 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.threadIsSynthetic = exports.areShippingDetailsValid = exports.warnIfFallbackIsMissing = exports.redact = exports.getFormDataConfig = exports.checkForBinaryData = exports.wait = void 0;
+/** biome-ignore-all lint/complexity/useLiteralKeys: <ts4111> */
+const node_path_1 = require("node:path");
+const form_data_1 = __importDefault(require("form-data"));
+const is_stream_1 = require("is-stream");
+const const_1 = require("./const");
+const types_1 = require("./types");
+const wait = (ms) => {
+    return new Promise(resolve => setTimeout(resolve, ms));
+};
+exports.wait = wait;
+/**
+ * Checks request data for binary data
+ */
+const checkForBinaryData = (data) => {
+    if (!data || typeof data !== "object")
+        return false;
+    for (const value of Object.values(data)) {
+        if (Buffer.isBuffer(value) || (0, is_stream_1.isStream)(value))
+            return true;
+    }
+    return false;
+};
+exports.checkForBinaryData = checkForBinaryData;
+const getFormDataConfig = (data, headers) => {
+    const config = {
+        headers
+    };
+    const form = new form_data_1.default();
+    for (const [key, value] of Object.entries(data)) {
+        if (Buffer.isBuffer(value) || (0, is_stream_1.isStream)(value)) {
+            const opts = {};
+            opts.filename = (() => {
+                // attempt to find filename from `value`. adapted from:
+                // https://github.com/form-data/form-data/blob/028c21e0f93c5fefa46a7bbf1ba753e4f627ab7a/lib/form_data.js#L227-L230
+                // formidable and the browser add a name property
+                // fs- and request- streams have path property
+                // biome-ignore lint/suspicious/noExplicitAny: form values can be anything
+                const streamOrBuffer = value;
+                if (typeof streamOrBuffer.name === "string") {
+                    return (0, node_path_1.basename)(streamOrBuffer.name);
+                }
+                if (typeof streamOrBuffer.path === "string") {
+                    return (0, node_path_1.basename)(streamOrBuffer.path);
+                }
+                return `${const_1.DEFAULT_FILE_NAME}_${Date.now().toString()}`;
+            })();
+            form.append(key, value, opts);
+        }
+        else if (key !== undefined && value !== undefined) {
+            form.append(key, value);
+        }
+    }
+    if (headers) {
+        // Copying FormData-generated headers into headers param
+        // not reassigning to headers param since it is passed by reference and behaves as an inout param
+        for (const [header, value] of Object.entries(form.getHeaders())) {
+            headers[header] = value;
+        }
+    }
+    config.data = form;
+    config.headers = headers;
+    return config;
+};
+exports.getFormDataConfig = getFormDataConfig;
+/**
+ * Takes an object and redacts specific items
+ * @param data
+ * @returns
+ */
+const redact = (data) => {
+    if (typeof data !== "object" || data === null) {
+        return "Data is not an object!";
+    }
+    const flattened = Object.entries(data).map(([key, value]) => {
+        // no value provided
+        if (value === undefined || value === null)
+            return [];
+        let serializedValue = value;
+        // redact possible tokens
+        if (key.match(/.*token.*/) !== null || key.match(/[Aa]uthorization/)) {
+            serializedValue = "[[REDACTED]]";
+        }
+        // when value is buffer or stream we can avoid logging it
+        if (Buffer.isBuffer(value) || (0, is_stream_1.isStream)(value)) {
+            serializedValue = "[[BINARY VALUE OMITTED]]";
+        }
+        else if (typeof value !== "string" &&
+            typeof value !== "number" &&
+            typeof value !== "boolean") {
+            serializedValue = JSON.stringify(value, null, 2);
+        }
+        return [key, serializedValue];
+    });
+    // return as object
+    return JSON.stringify(flattened.reduce((accumulator, [key, value]) => {
+        if (key !== undefined && value !== undefined) {
+            accumulator[key] = value;
+        }
+        return accumulator;
+    }, {}));
+};
+exports.redact = redact;
+/**
+ * @param path api method being called
+ * @param logger instance of we clients logger
+ * @param options arguments for the Web API method
+ */
+const warnIfFallbackIsMissing = (path, logger, options) => {
+    if (!options || Array.isArray(options))
+        return;
+    if (Array.isArray(options["attachments"]) &&
+        options["attachments"].length > 0 &&
+        options["attachments"].some(attachment => !attachment.fallback || attachment.fallback.trim() === "")) {
+        logger.warn(`The attachment-level \`fallback\` argument is missing in the request payload for a ${path} call - To avoid this warning, it is recommended to always provide a top-level \`text\` argument when posting a message. Alternatively, you can provide an attachment-level \`fallback\` argument, though this is now considered a legacy field (see https://docs.slack.dev/legacy/legacy-messaging/legacy-secondary-message-attachments for more details).`);
+    }
+};
+exports.warnIfFallbackIsMissing = warnIfFallbackIsMissing;
+const areShippingDetailsValid = (address) => {
+    if (!address)
+        return false;
+    return Boolean(address.city &&
+        address.country &&
+        address.line1 &&
+        address.postal_code &&
+        address.state);
+};
+exports.areShippingDetailsValid = areShippingDetailsValid;
+const threadIsSynthetic = (thread) => thread.type === types_1.UserThreadType.Synthetic;
+exports.threadIsSynthetic = threadIsSynthetic;
+//# sourceMappingURL=utils.js.map

package/build/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;;;;AAAA,gEAAgE;AAChE,yCAAqC;AAGrC,0DAAiC;AACjC,yCAAqC;AACrC,mCAA4C;AAC5C,mCAKiB;AAEV,MAAM,IAAI,GAAG,CAAC,EAAU,EAAE,EAAE;IAClC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;AACxD,CAAC,CAAC;AAFW,QAAA,IAAI,QAEf;AAEF;;GAEG;AACI,MAAM,kBAAkB,GAAG,CAAC,IAAa,EAAW,EAAE;IAC5D,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAEpD,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;QACzC,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,IAAA,oBAAQ,EAAC,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;IAC5D,CAAC;IAED,OAAO,KAAK,CAAC;AACd,CAAC,CAAC;AARW,QAAA,kBAAkB,sBAQ7B;AAEK,MAAM,iBAAiB,GAAG,CAChC,IAA6B,EAC7B,OAAqB,EACQ,EAAE;IAC/B,MAAM,MAAM,GAA+B;QAC1C,OAAO;KACP,CAAC;IAEF,MAAM,IAAI,GAAG,IAAI,mBAAQ,EAAE,CAAC;IAE5B,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACjD,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,IAAA,oBAAQ,EAAC,KAAK,CAAC,EAAE,CAAC;YAC/C,MAAM,IAAI,GAA2B,EAAE,CAAC;YACxC,IAAI,CAAC,QAAQ,GAAG,CAAC,GAAG,EAAE;gBACrB,uDAAuD;gBACvD,kHAAkH;gBAClH,iDAAiD;gBACjD,8CAA8C;gBAC9C,0EAA0E;gBAC1E,MAAM,cAAc,GAAQ,KAAK,CAAC;gBAClC,IAAI,OAAO,cAAc,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;oBAC7C,OAAO,IAAA,oBAAQ,EAAC,cAAc,CAAC,IAAI,CAAC,CAAC;gBACtC,CAAC;gBACD,IAAI,OAAO,cAAc,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;oBAC7C,OAAO,IAAA,oBAAQ,EAAC,cAAc,CAAC,IAAI,CAAC,CAAC;gBACtC,CAAC;gBACD,OAAO,GAAG,yBAAiB,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC;YACxD,CAAC,CAAC,EAAE,CAAC;YACL,IAAI,CAAC,MAAM,CAAC,GAAa,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;QACzC,CAAC;aAAM,IAAI,GAAG,KAAK,SAAS,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACrD,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACzB,CAAC;IACF,CAAC;IAED,IAAI,OAAO,EAAE,CAAC;QACb,wDAAwD;QACxD,iGAAiG;QACjG,KAAK,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,EAAE,CAAC;YACjE,OAAO,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC;QACzB,CAAC;IACF,CAAC;IACD,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,OAAO,MAAM,CAAC;AACf,CAAC,CAAC;AA5CW,QAAA,iBAAiB,qBA4C5B;AAEF;;;;GAIG;AACI,MAAM,MAAM,GAAG,CAAC,IAAa,EAAU,EAAE;IAC/C,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QAC/C,OAAO,wBAAwB,CAAC;IACjC,CAAC;IACD,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,CACzC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QAChB,oBAAoB;QACpB,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI;YAAE,OAAO,EAAE,CAAC;QAErD,IAAI,eAAe,GAAG,KAAK,CAAC;QAE5B,yBAAyB;QACzB,IAAI,GAAG,CAAC,KAAK,CAAC,WAAW,CAAC,KAAK,IAAI,IAAI,GAAG,CAAC,KAAK,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACtE,eAAe,GAAG,cAAc,CAAC;QAClC,CAAC;QAED,yDAAyD;QACzD,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,IAAA,oBAAQ,EAAC,KAAK,CAAC,EAAE,CAAC;YAC/C,eAAe,GAAG,0BAA0B,CAAC;QAC9C,CAAC;aAAM,IACN,OAAO,KAAK,KAAK,QAAQ;YACzB,OAAO,KAAK,KAAK,QAAQ;YACzB,OAAO,KAAK,KAAK,SAAS,EACzB,CAAC;YACF,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QAClD,CAAC;QACD,OAAO,CAAC,GAAG,EAAE,eAAe,CAAC,CAAC;IAC/B,CAAC,CACD,CAAC;IAEF,mBAAmB;IACnB,OAAO,IAAI,CAAC,SAAS,CACpB,SAAS,CAAC,MAAM,CACf,CAAC,WAAW,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YAC9C,WAAW,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QAC1B,CAAC;QACD,OAAO,WAAW,CAAC;IACpB,CAAC,EACD,EAA6B,CAC7B,CACD,CAAC;AACH,CAAC,CAAC;AA1CW,QAAA,MAAM,UA0CjB;AAEF;;;;GAIG;AACI,MAAM,uBAAuB,GAAG,CACtC,IAAY,EACZ,MAAc,EACd,OAA6C,EACtC,EAAE;IACT,IAAI,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;QAAE,OAAO;IAE/C,IACC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QACrC,OAAO,CAAC,aAAa,CAAC,CAAC,MAAM,GAAG,CAAC;QACjC,OAAO,CAAC,aAAa,CAAC,CAAC,IAAI,CAC1B,UAAU,CAAC,EAAE,CAAC,CAAC,UAAU,CAAC,QAAQ,IAAI,UAAU,CAAC,QAAQ,CAAC,IAAI,EAAE,KAAK,EAAE,CACvE,EACA,CAAC;QACF,MAAM,CAAC,IAAI,CACV,sFAAsF,IAAI,6VAA6V,CACvb,CAAC;IACH,CAAC;AACF,CAAC,CAAC;AAlBW,QAAA,uBAAuB,2BAkBlC;AAEK,MAAM,uBAAuB,GAAG,CACtC,OAAgD,EACtC,EAAE;IACZ,IAAI,CAAC,OAAO;QAAE,OAAO,KAAK,CAAC;IAE3B,OAAO,OAAO,CACb,OAAO,CAAC,IAAI;QACX,OAAO,CAAC,OAAO;QACf,OAAO,CAAC,KAAK;QACb,OAAO,CAAC,WAAW;QACnB,OAAO,CAAC,KAAK,CACd,CAAC;AACH,CAAC,CAAC;AAZW,QAAA,uBAAuB,2BAYlC;AAEK,MAAM,iBAAiB,GAAG,CAChC,MAAwC,EACR,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,sBAAc,CAAC,SAAS,CAAC;AAFhE,QAAA,iBAAiB,qBAE+C"}

package/build/web-client.d.ts

@@ -0,0 +1,117 @@
+import { Methods } from "./methods";
+import type { WebAPICallResult } from "./types";
+import { type WebApiCallConfig, type WebClientOptions } from "./types/web-client";
+export declare class WebClient extends Methods {
+    /**
+     * @description The base URL for reaching Loop/Mattermost Web API
+     * Must end with `api/v4/`
+     * @example https://your-loop.loop.ru/api/v4/
+     */
+    url: string;
+    /**
+     * @descripton Authentication and authorization token for accessing Loop/Mattermost API
+     */
+    token: string | undefined;
+    /**
+     * Configuration for retry operations. See {@link https://github.com/triplesunn/again-ts|Again} for more details.
+     */
+    private retryConfig;
+    /**
+     * Queue of requests in which a maximum of {@link WebClientOptions.maxRequestConcurrency} can concurrently be
+     * in-flight.
+     */
+    private breadline;
+    /**
+     * Axios HTTP client instance used by this client
+     */
+    private axios;
+    /**
+     * Configuration for custom TLS handling
+     */
+    private tlsConfig;
+    /**
+     * The name used to prefix all logging generated from this object
+     */
+    private static loggerName;
+    /**
+     * This object's logger instance
+     */
+    private logger;
+    /**
+     * @description Current userID
+     * useCurrentUserForDirectChannels and useCurrentUserForPostCreation will
+     * use it instead of fetching from server if not overriden by token
+     */
+    userID: string | undefined;
+    /**
+     * @description Use current user_id if only one was provided for direct channel creation.
+     * Will fetch current user ID from server if no userID was provided or overridden by token in options
+     *
+     * @default true
+     */
+    readonly useCurrentUserForDirectChannels?: boolean;
+    /**
+     * @description Use post.user_id in PostCreateArguments to fetch a channel_id for post
+     * Will call channels.create.direct for current user if true
+     * Will fetch current user ID from server if no userID was provided or overridden by token in options
+     *
+     * @default true
+     * @default false if userID is provided
+     */
+    readonly useCurrentUserForPostCreation?: boolean;
+    /**
+     * @description If true the client will set its userID if it was fetched while
+     * useCurrentUserForDirectChannels=true, useCurrentUserForPostCreation=true
+     * or via users.profile.get.me()
+     *
+     * @default false
+     */
+    readonly saveFetchedUserID?: boolean;
+    private clusterId;
+    private serverVersion;
+    constructor(url: Readonly<string>, { token, userID, logger, logLevel, maxRequestConcurrency, retryConfig, useCurrentUserForDirectChannels, useCurrentUserForPostCreation, saveFetchedUserID, testConnectionOnInit, agent, tls, timeout, headers, requestInterceptor, adapter }?: WebClientOptions);
+    /**
+     * Generic method for calling a Web API method
+     * @param path - the Web API path to call
+     * @param options - method options
+     *
+     * @throws WebApiCallFailedError with detailed errors in ctx.errors
+     */
+    apiCall<T = unknown>(config: WebApiCallConfig, options?: Record<string, unknown>): Promise<Readonly<WebAPICallResult<T>>>;
+    /**
+     * @description Low-level function to make a single API request.
+     * Handles queueing, retries, and http-level errors
+     */
+    private makeRequest;
+    /**
+     * Processes an HTTP response into a WebAPICallResult by performing JSON parsing on the body and merging relevant
+     * HTTP headers into the object.
+     * @param response - an http response
+     */
+    private buildResult;
+    private fillRequestUrl;
+    /**
+     * @description Sets authenticated user id for channel creation
+     */
+    private setCurrentUserForDirectChannel;
+    /**
+     * @description Sets channel_id for user_id for post creation
+     */
+    private setCurrentUserForPostCreation;
+    /**
+     * Gets or fetches current user ID using
+     * @param data Axios config.data
+     * @returns
+     */
+    private getCurrentUserID;
+    private transformPathSpecificParams;
+    /**
+     * Transforms options (a simple key-value object) into an acceptable value for a body. This can be either
+     * a string, used when posting with a content-type of url-encoded. Or, it can be a readable stream, used
+     * when the options contain a binary (a stream or a buffer) and the upload should be done
+     * with content-type multipart/form-data.
+     * @param config - The Axios request configuration object
+     */
+    private serializeApiCallData;
+}
+//# sourceMappingURL=web-client.d.ts.map

package/build/web-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"web-client.d.ts","sourceRoot":"","sources":["../src/web-client.ts"],"names":[],"mappings":"AA6BA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,KAAK,EAGX,gBAAgB,EAChB,MAAM,SAAS,CAAC;AACjB,OAAO,EAIN,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,MAAM,oBAAoB,CAAC;AAQ5B,qBAAa,SAAU,SAAQ,OAAO;IACrC;;;;OAIG;IACI,GAAG,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACI,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IAEjC;;OAEG;IACH,OAAO,CAAC,WAAW,CAAe;IAElC;;;OAGG;IACH,OAAO,CAAC,SAAS,CAAY;IAE7B;;OAEG;IACH,OAAO,CAAC,KAAK,CAAgB;IAE7B;;OAEG;IACH,OAAO,CAAC,SAAS,CAAyB;IAE1C;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,UAAU,CAAmB;IAE5C;;OAEG;IACH,OAAO,CAAC,MAAM,CAAS;IAEvB;;;;OAIG;IACI,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAElC;;;;;OAKG;IACH,QAAQ,CAAC,+BAA+B,CAAC,EAAE,OAAO,CAAC;IAEnD;;;;;;;OAOG;IACH,QAAQ,CAAC,6BAA6B,CAAC,EAAE,OAAO,CAAC;IAEjD;;;;;;OAMG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAErC,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,aAAa,CAAS;gBAG7B,GAAG,EAAE,QAAQ,CAAC,MAAM,CAAC,EACrB,EACC,KAAiB,EACjB,MAAkB,EAClB,MAAkB,EAClB,QAAoB,EACpB,qBAA2B,EAC3B,WAA4C,EAC5C,+BAAsC,EACtC,6BAAoC,EACpC,iBAAyB,EACzB,oBAA4B,EAC5B,KAAiB,EACjB,GAAe,EACf,OAAW,EACX,OAAY,EACZ,kBAA8B,EAC9B,OAAmB,EACnB,GAAE,gBAAqB;IAyGzB;;;;;;OAMG;IACU,OAAO,CAAC,CAAC,GAAG,OAAO,EAC/B,MAAM,EAAE,gBAAgB,EACxB,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,GACnC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;IA6CzC;;;OAGG;YACW,WAAW;IA4DzB;;;;OAIG;IACH,OAAO,CAAC,WAAW;IA8BnB,OAAO,CAAC,cAAc;IAsBtB;;OAEG;YACW,8BAA8B;IAiC5C;;OAEG;YACW,6BAA6B;IAmC3C;;;;OAIG;YACW,gBAAgB;IAwB9B,OAAO,CAAC,2BAA2B;IAgDnC;;;;;;OAMG;IACH,OAAO,CAAC,oBAAoB;CAmC5B"}