telegraph-wrapper
Version:
Telegra.ph API wrapper with docs and files upload
292 lines (291 loc) • 14.9 kB
JavaScript
;
var __assign = (this && this.__assign) || function () {
__assign = Object.assign || function(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (g && (g = 0, op[0] && (_ = 0)), _) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
var __rest = (this && this.__rest) || function (s, e) {
var t = {};
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
t[p] = s[p];
if (s != null && typeof Object.getOwnPropertySymbols === "function")
for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
t[p[i]] = s[p[i]];
}
return t;
};
exports.__esModule = true;
exports.getViews = exports.getPageList = exports.getPage = exports.editPage = exports.createPage = exports.revokeAccessToken = exports.getAccountInfo = exports.editAccountInfo = exports.createAccount = void 0;
var request_1 = require("./request");
var BASE_URL = 'https://api.telegra.ph';
/**
* ## /createAccount
* Use this method to create a new Telegraph account. Most users only need one account, but this
* can be useful for channel administrators who would like to keep individual author names and
* profile links for each of their channels. On success, returns an {@link Types.Account} object
* with the regular fields and an additional `access_token` field.
* @param {Types.CreateAccount} args {@link Types.CreateAccount}
* @param {string} args.short_name _Required_. Hover property for more info
* @param {string} [args.author_name] _Optional_. Hover property for more info
* @param {string} [args.author_url] _Optional_. Hover property for more info
* @returns {Promise<Types.Account>} Promise with a {@link Types.Account} object
* @see https://telegra.ph/api#createAccount
*/
var createAccount = function (args) { return __awaiter(void 0, void 0, void 0, function () {
var req;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, (0, request_1["default"])("".concat(BASE_URL, "/createAccount"), args)];
case 1:
req = _a.sent();
return [2 /*return*/, req.result];
}
});
}); };
exports.createAccount = createAccount;
/**
* ## /editAccountInfo
* Use this method to update information about a Telegraph account.
* Pass only the parameters that you want to edit.
* On success, returns an {@link Types.Account} object with the default fields.
* @param {Types.EditAccountInfo} args {@link Types.EditAccountInfo}
* @param {string} args.access_token _Required_. Hover property for more info
* @param {string} [args.short_name] _Optional_. Hover property for more info
* @param {string} [args.author_name] _Optional_. Hover property for more info
* @param {string} [args.author_url] _Optional_. Hover property for more info
* @returns {Promise<Types.Account>} Promise with a {@link Types.Account} object
* @see https://telegra.ph/api#editAccountInfo
*/
var editAccountInfo = function (args) { return __awaiter(void 0, void 0, void 0, function () {
var req;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, (0, request_1["default"])("".concat(BASE_URL, "/editAccountInfo"), args)];
case 1:
req = _a.sent();
return [2 /*return*/, req.result];
}
});
}); };
exports.editAccountInfo = editAccountInfo;
/**
* ## /getAccountInfo
* Use this method to get information about a Telegraph account.
* Returns an {@link Types.Account} object on success.
* @param {Types.GetAccountInfo} args {@link Types.GetAccountInfo}
* @param {string} args.access_token _Required_. Hover property for more info
* @param {Array<string>} [args.fields=['short_name', 'author_name', 'author_url']]
* _Optional_. Hover property for more info. _Default_: ['short_name', 'author_name', 'author_url']
* @returns {Promise<Types.Account>} Promise with a {@link Types.Account} object
* @see https://telegra.ph/api#getAccountInfo
*/
var getAccountInfo = function (_a) { return __awaiter(void 0, void 0, void 0, function () {
var req;
var _b = _a.fields, fields = _b === void 0 ? ['short_name', 'author_name', 'author_url'] : _b, rest = __rest(_a, ["fields"]);
return __generator(this, function (_c) {
switch (_c.label) {
case 0: return [4 /*yield*/, (0, request_1["default"])("".concat(BASE_URL, "/getAccountInfo"), __assign({ fields: fields }, rest))];
case 1:
req = _c.sent();
return [2 /*return*/, req.result];
}
});
}); };
exports.getAccountInfo = getAccountInfo;
/**
* ## /revokeAccessToken
* Use this method to revoke access_token and generate a new one,
* for example, if the user would like to reset all connected sessions,
* or you have reasons to believe the token was compromised.
* On success, returns an {@link Types.Account} object with new `access_token` and `auth_url` fields
* @param {Types.RevokeAccessToken} args {@link Types.RevokeAccessToken}
* @param {string} args.access_token _Required_. Hover property for more info
* @returns {Promise<Types.Account>} Promise with a {@link Types.Account} object
* @see https://telegra.ph/api#revokeAccessToken
*/
var revokeAccessToken = function (args) { return __awaiter(void 0, void 0, void 0, function () {
var req;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, (0, request_1["default"])("".concat(BASE_URL, "/revokeAccessToken"), args)];
case 1:
req = _a.sent();
return [2 /*return*/, req.result];
}
});
}); };
exports.revokeAccessToken = revokeAccessToken;
/**
* ## /createPage
* Use this method to create a new Telegraph page.
* On success, returns a {@link Types.Page} object.
* @param {Types.CreatePage} args {@link Types.CreatePage}
* @param {string} args.access_token _Required_. Hover property for more info
* @param {string} args.title _Required_. Hover property for more info
* @param {Array<Types.Node>} args.content _Required_. Hover property for more info
* @param {string} [args.author_name] _Optional_. Hover property for more info
* @param {string} [args.author_url] _Optional_. Hover property for more info
* @param {boolean} [args.return_content=false]
* _Optional_. Hover property for more info. _Default_: false
* @returns {Promise<Types.Page>} Promise with a {@link Types.Page} object
* @see https://telegra.ph/api#createPage
*/
var createPage = function (_a) { return __awaiter(void 0, void 0, void 0, function () {
var req;
var _b = _a.return_content, return_content = _b === void 0 ? false : _b, rest = __rest(_a, ["return_content"]);
return __generator(this, function (_c) {
switch (_c.label) {
case 0: return [4 /*yield*/, (0, request_1["default"])("".concat(BASE_URL, "/createPage"), __assign({ return_content: return_content }, rest))];
case 1:
req = _c.sent();
return [2 /*return*/, req.result];
}
});
}); };
exports.createPage = createPage;
/**
* ## /editPage
* Use this method to edit an existing Telegraph page.
* On success, returns a {@link Types.Page} object.
* @param {Types.EditPage} args {@link Types.EditPage}
* @param {string} args.access_token _Required_. Hover property for more info
* @param {string} args.path _Required_. Hover property for more info
* @param {string} args.title _Required_. Hover property for more info
* @param {Array<Types.Node>} args.content _Required_. Hover property for more info
* @param {string} [args.author_name] _Optional_. Hover property for more info
* @param {string} [args.author_url] _Optional_. Hover property for more info
* @param {boolean} [args.return_content=false]
* _Optional_. Hover property for more info. _Default_: false
* @returns {Promise<Types.Page>} Promise with a {@link Types.Page} object
* @see https://telegra.ph/api#editPage
*/
var editPage = function (_a) { return __awaiter(void 0, void 0, void 0, function () {
var req;
var _b = _a.return_content, return_content = _b === void 0 ? false : _b, rest = __rest(_a, ["return_content"]);
return __generator(this, function (_c) {
switch (_c.label) {
case 0: return [4 /*yield*/, (0, request_1["default"])("".concat(BASE_URL, "/editPage"), __assign({ return_content: return_content }, rest))];
case 1:
req = _c.sent();
return [2 /*return*/, req.result];
}
});
}); };
exports.editPage = editPage;
/**
* ## /getPage
* Use this method to get a Telegraph page
* On success, returns a {@link Types.Page} object.
* @param {Types.GetPage} args {@link Types.GetPage}
* @param {string} args.path _Required_. Hover property for more info
* @param {boolean} [args.return_content=false]
* _Optional_. Hover property for more info. _Default_: false
* @returns {Promise<Types.Page>} Promise with a {@link Types.Page} object
* @see https://telegra.ph/api#getPage
*/
var getPage = function (_a) { return __awaiter(void 0, void 0, void 0, function () {
var req;
var _b = _a.return_content, return_content = _b === void 0 ? false : _b, rest = __rest(_a, ["return_content"]);
return __generator(this, function (_c) {
switch (_c.label) {
case 0: return [4 /*yield*/, (0, request_1["default"])("".concat(BASE_URL, "/getPage"), __assign({ return_content: return_content }, rest))];
case 1:
req = _c.sent();
return [2 /*return*/, req.result];
}
});
}); };
exports.getPage = getPage;
/**
* ## /getPageList
* Use this method to get a list of pages belonging to a Telegraph account.
* Returns a {@link Types.PageList} object, sorted by most recently created pages first.
* @param {Types.GetPageList} args {@link Types.GetPageList}
* @param {string} args.access_token _Required_. Hover property for more info
* @param {number} [args.offset=0] _Optional_. Hover property for more info. _Default_: 0
* @param {number} [args.limit=50] _Optional_. Hover property for more info. _Default_: 50
* @returns {Promise<Types.PageList>} Promise with a {@link Types.PageList} object
* @see https://telegra.ph/api#getPageList
*/
var getPageList = function (_a) { return __awaiter(void 0, void 0, void 0, function () {
var req;
var _b = _a.offset, offset = _b === void 0 ? 0 : _b, _c = _a.limit, limit = _c === void 0 ? 50 : _c, rest = __rest(_a, ["offset", "limit"]);
return __generator(this, function (_d) {
switch (_d.label) {
case 0: return [4 /*yield*/, (0, request_1["default"])("".concat(BASE_URL, "/getPageList"), __assign({ offset: offset, limit: limit }, rest))];
case 1:
req = _d.sent();
return [2 /*return*/, req.result];
}
});
}); };
exports.getPageList = getPageList;
/**
* ## /getViews
* Use this method to get the number of views for a Telegraph article.
* Returns a {@link Types.PageViews} object on success.
* By default, the total number of page views will be returned.
* @param {Types.GetViews} args {@link Types.GetViews}
* @param {string} args.path _Required_. Hover property for more info
* @param {number} [args.year] _Optional_. Hover property for more info.
* @param {number} [args.month] _Optional_. Hover property for more info.
* @param {number} [args.day] _Optional_. Hover property for more info.
* @param {number} [args.hour] _Optional_. Hover property for more info.
* @returns {Promise<Types.PageViews>} Promise with a {@link Types.PageViews} object
* @see https://telegra.ph/api#getViews
*/
var getViews = function (args) { return __awaiter(void 0, void 0, void 0, function () {
var req;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, (0, request_1["default"])("".concat(BASE_URL, "/getPageList"), args)];
case 1:
req = _a.sent();
return [2 /*return*/, req.result];
}
});
}); };
exports.getViews = getViews;