matrix-react-sdk
Version:
SDK for matrix.org using React
82 lines (79 loc) • 12.4 kB
JavaScript
"use strict";
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.Command = void 0;
var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
var _RoomContext = require("../contexts/RoomContext");
var _utils = require("./utils");
var _languageHandler = require("../languageHandler");
var _PosthogAnalytics = require("../PosthogAnalytics");
var _interface = require("./interface");
/*
Copyright 2024 New Vector Ltd.
Copyright 2020-2023 The Matrix.org Foundation C.I.C.
Copyright 2019 Michael Telatynski <7t3chguy@gmail.com>
Copyright 2018 New Vector Ltd
Copyright 2015, 2016 OpenMarket Ltd
SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only
Please see LICENSE files in the repository root for full details.
*/
class Command {
constructor(opts) {
(0, _defineProperty2.default)(this, "command", void 0);
(0, _defineProperty2.default)(this, "aliases", void 0);
(0, _defineProperty2.default)(this, "args", void 0);
(0, _defineProperty2.default)(this, "description", void 0);
(0, _defineProperty2.default)(this, "runFn", void 0);
(0, _defineProperty2.default)(this, "category", void 0);
(0, _defineProperty2.default)(this, "hideCompletionAfterSpace", void 0);
(0, _defineProperty2.default)(this, "renderingTypes", void 0);
(0, _defineProperty2.default)(this, "analyticsName", void 0);
(0, _defineProperty2.default)(this, "_isEnabled", void 0);
this.command = opts.command;
this.aliases = opts.aliases || [];
this.args = opts.args || "";
this.description = opts.description;
this.runFn = opts.runFn?.bind(this);
this.category = opts.category || _interface.CommandCategories.other;
this.hideCompletionAfterSpace = opts.hideCompletionAfterSpace || false;
this._isEnabled = opts.isEnabled;
this.renderingTypes = opts.renderingTypes;
this.analyticsName = opts.analyticsName;
}
getCommand() {
return `/${this.command}`;
}
getCommandWithArgs() {
return this.getCommand() + " " + this.args;
}
run(matrixClient, roomId, threadId, args) {
// if it has no runFn then its an ignored/nop command (autocomplete only) e.g `/me`
if (!this.runFn) {
return (0, _utils.reject)(new _languageHandler.UserFriendlyError("slash_command|error_invalid_runfn"));
}
const renderingType = threadId ? _RoomContext.TimelineRenderingType.Thread : _RoomContext.TimelineRenderingType.Room;
if (this.renderingTypes && !this.renderingTypes?.includes(renderingType)) {
return (0, _utils.reject)(new _languageHandler.UserFriendlyError("slash_command|error_invalid_rendering_type", {
renderingType,
cause: undefined
}));
}
if (this.analyticsName) {
_PosthogAnalytics.PosthogAnalytics.instance.trackEvent({
eventName: "SlashCommand",
command: this.analyticsName
});
}
return this.runFn(matrixClient, roomId, threadId, args);
}
getUsage() {
return (0, _languageHandler._t)("slash_command|usage") + ": " + this.getCommandWithArgs();
}
isEnabled(cli) {
return this._isEnabled?.(cli) ?? true;
}
}
exports.Command = Command;
//# sourceMappingURL=data:application/json;charset=utf-8;base64,{"version":3,"names":["_RoomContext","require","_utils","_languageHandler","_PosthogAnalytics","_interface","Command","constructor","opts","_defineProperty2","default","command","aliases","args","description","runFn","bind","category","CommandCategories","other","hideCompletionAfterSpace","_isEnabled","isEnabled","renderingTypes","analyticsName","getCommand","getCommandWithArgs","run","matrixClient","roomId","threadId","reject","UserFriendlyError","renderingType","TimelineRenderingType","Thread","Room","includes","cause","undefined","PosthogAnalytics","instance","trackEvent","eventName","getUsage","_t","cli","exports"],"sources":["../../src/slash-commands/command.ts"],"sourcesContent":["/*\nCopyright 2024 New Vector Ltd.\nCopyright 2020-2023 The Matrix.org Foundation C.I.C.\nCopyright 2019 Michael Telatynski <7t3chguy@gmail.com>\nCopyright 2018 New Vector Ltd\nCopyright 2015, 2016 OpenMarket Ltd\n\nSPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only\nPlease see LICENSE files in the repository root for full details.\n*/\n\nimport { MatrixClient } from \"matrix-js-sdk/src/matrix\";\nimport { SlashCommand as SlashCommandEvent } from \"@matrix-org/analytics-events/types/typescript/SlashCommand\";\n\nimport { TimelineRenderingType } from \"../contexts/RoomContext\";\nimport { reject } from \"./utils\";\nimport { _t, TranslationKey, UserFriendlyError } from \"../languageHandler\";\nimport { PosthogAnalytics } from \"../PosthogAnalytics\";\nimport { CommandCategories, RunResult } from \"./interface\";\n\ntype RunFn = (\n    this: Command,\n    matrixClient: MatrixClient,\n    roomId: string,\n    threadId: string | null,\n    args?: string,\n) => RunResult;\n\ninterface ICommandOpts {\n    command: string;\n    aliases?: string[];\n    args?: string;\n    description: TranslationKey;\n    analyticsName?: SlashCommandEvent[\"command\"];\n    runFn?: RunFn;\n    category: string;\n    hideCompletionAfterSpace?: boolean;\n    isEnabled?(matrixClient: MatrixClient | null): boolean;\n    renderingTypes?: TimelineRenderingType[];\n}\n\nexport class Command {\n    public readonly command: string;\n    public readonly aliases: string[];\n    public readonly args?: string;\n    public readonly description: TranslationKey;\n    public readonly runFn?: RunFn;\n    public readonly category: string;\n    public readonly hideCompletionAfterSpace: boolean;\n    public readonly renderingTypes?: TimelineRenderingType[];\n    public readonly analyticsName?: SlashCommandEvent[\"command\"];\n    private readonly _isEnabled?: (matrixClient: MatrixClient | null) => boolean;\n\n    public constructor(opts: ICommandOpts) {\n        this.command = opts.command;\n        this.aliases = opts.aliases || [];\n        this.args = opts.args || \"\";\n        this.description = opts.description;\n        this.runFn = opts.runFn?.bind(this);\n        this.category = opts.category || CommandCategories.other;\n        this.hideCompletionAfterSpace = opts.hideCompletionAfterSpace || false;\n        this._isEnabled = opts.isEnabled;\n        this.renderingTypes = opts.renderingTypes;\n        this.analyticsName = opts.analyticsName;\n    }\n\n    public getCommand(): string {\n        return `/${this.command}`;\n    }\n\n    public getCommandWithArgs(): string {\n        return this.getCommand() + \" \" + this.args;\n    }\n\n    public run(matrixClient: MatrixClient, roomId: string, threadId: string | null, args?: string): RunResult {\n        // if it has no runFn then its an ignored/nop command (autocomplete only) e.g `/me`\n        if (!this.runFn) {\n            return reject(new UserFriendlyError(\"slash_command|error_invalid_runfn\"));\n        }\n\n        const renderingType = threadId ? TimelineRenderingType.Thread : TimelineRenderingType.Room;\n        if (this.renderingTypes && !this.renderingTypes?.includes(renderingType)) {\n            return reject(\n                new UserFriendlyError(\"slash_command|error_invalid_rendering_type\", {\n                    renderingType,\n                    cause: undefined,\n                }),\n            );\n        }\n\n        if (this.analyticsName) {\n            PosthogAnalytics.instance.trackEvent<SlashCommandEvent>({\n                eventName: \"SlashCommand\",\n                command: this.analyticsName,\n            });\n        }\n\n        return this.runFn(matrixClient, roomId, threadId, args);\n    }\n\n    public getUsage(): string {\n        return _t(\"slash_command|usage\") + \": \" + this.getCommandWithArgs();\n    }\n\n    public isEnabled(cli: MatrixClient | null): boolean {\n        return this._isEnabled?.(cli) ?? true;\n    }\n}\n"],"mappings":";;;;;;;;AAcA,IAAAA,YAAA,GAAAC,OAAA;AACA,IAAAC,MAAA,GAAAD,OAAA;AACA,IAAAE,gBAAA,GAAAF,OAAA;AACA,IAAAG,iBAAA,GAAAH,OAAA;AACA,IAAAI,UAAA,GAAAJ,OAAA;AAlBA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAgCO,MAAMK,OAAO,CAAC;EAYVC,WAAWA,CAACC,IAAkB,EAAE;IAAA,IAAAC,gBAAA,CAAAC,OAAA;IAAA,IAAAD,gBAAA,CAAAC,OAAA;IAAA,IAAAD,gBAAA,CAAAC,OAAA;IAAA,IAAAD,gBAAA,CAAAC,OAAA;IAAA,IAAAD,gBAAA,CAAAC,OAAA;IAAA,IAAAD,gBAAA,CAAAC,OAAA;IAAA,IAAAD,gBAAA,CAAAC,OAAA;IAAA,IAAAD,gBAAA,CAAAC,OAAA;IAAA,IAAAD,gBAAA,CAAAC,OAAA;IAAA,IAAAD,gBAAA,CAAAC,OAAA;IACnC,IAAI,CAACC,OAAO,GAAGH,IAAI,CAACG,OAAO;IAC3B,IAAI,CAACC,OAAO,GAAGJ,IAAI,CAACI,OAAO,IAAI,EAAE;IACjC,IAAI,CAACC,IAAI,GAAGL,IAAI,CAACK,IAAI,IAAI,EAAE;IAC3B,IAAI,CAACC,WAAW,GAAGN,IAAI,CAACM,WAAW;IACnC,IAAI,CAACC,KAAK,GAAGP,IAAI,CAACO,KAAK,EAAEC,IAAI,CAAC,IAAI,CAAC;IACnC,IAAI,CAACC,QAAQ,GAAGT,IAAI,CAACS,QAAQ,IAAIC,4BAAiB,CAACC,KAAK;IACxD,IAAI,CAACC,wBAAwB,GAAGZ,IAAI,CAACY,wBAAwB,IAAI,KAAK;IACtE,IAAI,CAACC,UAAU,GAAGb,IAAI,CAACc,SAAS;IAChC,IAAI,CAACC,cAAc,GAAGf,IAAI,CAACe,cAAc;IACzC,IAAI,CAACC,aAAa,GAAGhB,IAAI,CAACgB,aAAa;EAC3C;EAEOC,UAAUA,CAAA,EAAW;IACxB,OAAO,IAAI,IAAI,CAACd,OAAO,EAAE;EAC7B;EAEOe,kBAAkBA,CAAA,EAAW;IAChC,OAAO,IAAI,CAACD,UAAU,CAAC,CAAC,GAAG,GAAG,GAAG,IAAI,CAACZ,IAAI;EAC9C;EAEOc,GAAGA,CAACC,YAA0B,EAAEC,MAAc,EAAEC,QAAuB,EAAEjB,IAAa,EAAa;IACtG;IACA,IAAI,CAAC,IAAI,CAACE,KAAK,EAAE;MACb,OAAO,IAAAgB,aAAM,EAAC,IAAIC,kCAAiB,CAAC,mCAAmC,CAAC,CAAC;IAC7E;IAEA,MAAMC,aAAa,GAAGH,QAAQ,GAAGI,kCAAqB,CAACC,MAAM,GAAGD,kCAAqB,CAACE,IAAI;IAC1F,IAAI,IAAI,CAACb,cAAc,IAAI,CAAC,IAAI,CAACA,cAAc,EAAEc,QAAQ,CAACJ,aAAa,CAAC,EAAE;MACtE,OAAO,IAAAF,aAAM,EACT,IAAIC,kCAAiB,CAAC,4CAA4C,EAAE;QAChEC,aAAa;QACbK,KAAK,EAAEC;MACX,CAAC,CACL,CAAC;IACL;IAEA,IAAI,IAAI,CAACf,aAAa,EAAE;MACpBgB,kCAAgB,CAACC,QAAQ,CAACC,UAAU,CAAoB;QACpDC,SAAS,EAAE,cAAc;QACzBhC,OAAO,EAAE,IAAI,CAACa;MAClB,CAAC,CAAC;IACN;IAEA,OAAO,IAAI,CAACT,KAAK,CAACa,YAAY,EAAEC,MAAM,EAAEC,QAAQ,EAAEjB,IAAI,CAAC;EAC3D;EAEO+B,QAAQA,CAAA,EAAW;IACtB,OAAO,IAAAC,mBAAE,EAAC,qBAAqB,CAAC,GAAG,IAAI,GAAG,IAAI,CAACnB,kBAAkB,CAAC,CAAC;EACvE;EAEOJ,SAASA,CAACwB,GAAwB,EAAW;IAChD,OAAO,IAAI,CAACzB,UAAU,GAAGyB,GAAG,CAAC,IAAI,IAAI;EACzC;AACJ;AAACC,OAAA,CAAAzC,OAAA,GAAAA,OAAA","ignoreList":[]}