oceanic-transcripts
Version:
A nicely formatted html transcript generator for oceanic.js.
123 lines • 6.39 kB
JavaScript
;
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __exportStar = (this && this.__exportStar) || function(m, exports) {
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.DiscordMessages = void 0;
exports.generateFromMessages = generateFromMessages;
exports.createTranscript = createTranscript;
const oceanic_js_1 = require("oceanic.js");
const generator_1 = __importDefault(require("./generator"));
const types_1 = require("./types");
const buildProfiles_1 = require("./utils/buildProfiles");
// re-export component for custom rendering
var transcript_1 = require("./generator/transcript");
Object.defineProperty(exports, "DiscordMessages", { enumerable: true, get: function () { return __importDefault(transcript_1).default; } });
/**
*
* @param messages The messages to generate a transcript from
* @param channel The channel the messages are from (used for header and guild name)
* @param options The options to use when generating the transcript
* @returns The generated transcript
*/
async function generateFromMessages(messages, channel, options = {}) {
var _a, _b, _c, _d, _e, _f, _g;
// turn messages into an array
const transformedMessages = messages instanceof oceanic_js_1.Collection ? Array.from(messages.values()) : messages;
const profiles = await (0, buildProfiles_1.buildProfiles)(transformedMessages);
// const startTime = process.hrtime();
// render the messages
const html = await (0, generator_1.default)({
messages: transformedMessages,
profiles,
channel,
saveImages: (_a = options.saveImages) !== null && _a !== void 0 ? _a : false,
callbacks: Object.assign({ resolveChannel: async (id) => channel.client.rest.channels.get(id).catch(() => null), resolveUser: async (id) => channel.client.rest.users.get(id).catch(() => null), resolveRole: channel.type === oceanic_js_1.ChannelTypes.DM ? async () => null : async (id) => { var _a, _b; return (_b = (_a = channel.guild) === null || _a === void 0 ? void 0 : _a.roles.get(id)) !== null && _b !== void 0 ? _b : null; } }, ((_b = options.callbacks) !== null && _b !== void 0 ? _b : {})),
poweredBy: (_c = options.poweredBy) !== null && _c !== void 0 ? _c : true,
footerText: (_d = options.footerText) !== null && _d !== void 0 ? _d : 'Exported {number} message{s}.',
favicon: (_e = options.favicon) !== null && _e !== void 0 ? _e : 'guild',
hydrate: (_f = options.hydrate) !== null && _f !== void 0 ? _f : false,
});
// get the time it took to render the messages
// const renderTime = process.hrtime(startTime);
// console.log(
// `[discord-html-transcripts] Rendered ${transformedMessages.length} messages in ${renderTime[0]}s ${
// renderTime[1] / 1000000
// }ms`
// );
// return the html in the specified format
if (options.returnType === types_1.ExportReturnType.Buffer) {
return Buffer.from(html);
}
if (options.returnType === types_1.ExportReturnType.String) {
return html;
}
return {
contents: Buffer.from(html),
name: (_g = options.filename) !== null && _g !== void 0 ? _g : `transcript-${channel.id}.html`,
};
}
/**
*
* @param channel The channel to create a transcript from
* @param options The options to use when creating the transcript
* @returns The generated transcript
*/
async function createTranscript(channel, options = {}) {
var _a, _b, _c, _d, _e, _f, _g;
// validate type
if (!oceanic_js_1.TextableChannelTypes.includes(channel.type)) {
throw new TypeError(`Provided channel must be text-based, received ${channel.type}`);
}
// fetch messages
let allMessages = [];
let lastMessageId;
const { limit, filter } = options;
const resolvedLimit = typeof limit === 'undefined' || limit === -1 ? Infinity : limit;
// until there are no more messages, keep fetching
// eslint-disable-next-line no-constant-condition
while (true) {
// create fetch options
const fetchLimitOptions = { limit: 100, before: lastMessageId };
if (!lastMessageId)
delete fetchLimitOptions.before;
// fetch messages
const messages = await channel.getMessages(fetchLimitOptions);
const filteredMessages = typeof filter === 'function' ? messages.filter(filter) : messages;
// add the messages to the array
allMessages.push(...filteredMessages.values());
// Get the last key of 'messages', not 'filteredMessages' because you will be refetching the same messages
lastMessageId =
(_f = (_d = (_b = (_a = messages[messages.length - 1]) === null || _a === void 0 ? void 0 : _a.id) !== null && _b !== void 0 ? _b : (_c = filteredMessages[filteredMessages.length - 1]) === null || _c === void 0 ? void 0 : _c.id) !== null && _d !== void 0 ? _d : (_e = messages.values().next().value) === null || _e === void 0 ? void 0 : _e.id) !== null && _f !== void 0 ? _f : (_g = filteredMessages.values().next().value) === null || _g === void 0 ? void 0 : _g.id;
// if there are no more messages, break
if (messages.length < 100)
break;
// if the limit has been reached, break
if (allMessages.length >= resolvedLimit)
break;
}
if (resolvedLimit < allMessages.length)
allMessages = allMessages.slice(0, limit);
// generate the transcript
return generateFromMessages(allMessages.reverse(), channel, options);
}
exports.default = {
createTranscript,
generateFromMessages,
};
__exportStar(require("./types"), exports);
//# sourceMappingURL=index.js.map