e621 1.0.9 → 2.0.0-dev.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.node-version +1 -0
- package/README.md +116 -187
- package/build/package.json +14 -11
- package/build/src/index.d.ts +28 -295
- package/build/src/index.js +83 -442
- package/build/src/modules/Pools.d.ts +120 -0
- package/build/src/modules/Pools.js +247 -0
- package/build/src/modules/PostSets.d.ts +88 -0
- package/build/src/modules/PostSets.js +182 -0
- package/build/src/modules/Posts.d.ts +124 -0
- package/build/src/modules/Posts.js +323 -0
- package/build/src/modules/UserFeedback.d.ts +66 -0
- package/build/src/modules/UserFeedback.js +134 -0
- package/build/src/modules/Users.d.ts +110 -0
- package/build/src/modules/Users.js +248 -0
- package/build/src/modules/WikiPages.d.ts +99 -0
- package/build/src/modules/WikiPages.js +208 -0
- package/build/src/structures/AuthenticatedUser.d.ts +109 -0
- package/build/src/structures/AuthenticatedUser.js +128 -0
- package/build/src/structures/Pool.d.ts +85 -0
- package/build/src/structures/Pool.js +110 -0
- package/build/src/structures/PoolHistory.d.ts +42 -0
- package/build/src/structures/PoolHistory.js +53 -0
- package/build/src/structures/Post.d.ts +147 -0
- package/build/src/structures/Post.js +155 -0
- package/build/src/structures/PostHistory.d.ts +52 -0
- package/build/src/structures/PostHistory.js +93 -0
- package/build/src/structures/PostSet.d.ts +71 -0
- package/build/src/structures/PostSet.js +91 -0
- package/build/src/structures/User.d.ts +62 -0
- package/build/src/structures/User.js +80 -0
- package/build/src/structures/WikiPage.d.ts +16 -0
- package/build/src/structures/WikiPage.js +26 -0
- package/build/src/structures/WikiPageHistory.d.ts +37 -0
- package/build/src/structures/WikiPageHistory.js +49 -0
- package/build/src/types/index.d.ts +92 -0
- package/build/src/types/pools.d.ts +60 -0
- package/build/src/types/post_sets.d.ts +33 -0
- package/build/src/types/posts.d.ts +165 -0
- package/build/src/types/user_feedback.d.ts +27 -0
- package/build/src/types/users.d.ts +277 -0
- package/build/src/types/wiki_pages.d.ts +65 -0
- package/build/src/util/FormHelper.d.ts +9 -0
- package/build/src/util/FormHelper.js +15 -0
- package/build/src/util/MultipartData.d.ts +7 -0
- package/build/src/util/MultipartData.js +39 -0
- package/build/src/util/RequestHandler.d.ts +37 -0
- package/build/src/util/RequestHandler.js +311 -0
- package/package.json +14 -11
- package/LICENSE +0 -21
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
import type E621 from "..";
|
|
2
|
+
import Post from "../structures/Post";
|
|
3
|
+
import PostHistory from "../structures/PostHistory";
|
|
4
|
+
import type { CreatePostOptions, SearchPostsOptions, ModifyPostOptions, PostVoteResult, SearchPostHistoryOptions } from "../types";
|
|
5
|
+
export default class Posts {
|
|
6
|
+
private readonly auth;
|
|
7
|
+
private readonly main;
|
|
8
|
+
constructor(main: E621);
|
|
9
|
+
/**
|
|
10
|
+
* Get a post by its id
|
|
11
|
+
*
|
|
12
|
+
* @param {(number | string)} id - The id of the post to get
|
|
13
|
+
* @returns {Promise<(Post | null)>}
|
|
14
|
+
*/
|
|
15
|
+
get(id: number | string): Promise<Post | null>;
|
|
16
|
+
/**
|
|
17
|
+
* Get a post by its md5
|
|
18
|
+
*
|
|
19
|
+
* @param {string} md5 - The md5 of the post to get
|
|
20
|
+
* @returns {Promise<(Post | null)>}
|
|
21
|
+
*/
|
|
22
|
+
getByMD5(md5: string): Promise<Post | null>;
|
|
23
|
+
/**
|
|
24
|
+
* Search for posts
|
|
25
|
+
*
|
|
26
|
+
* @param {object} [options]
|
|
27
|
+
* @param {(Array<string> | string)} [options.tags] - narrow the search by specific tags
|
|
28
|
+
* @param {(number |`${"" | "a" | "b"}${number}`)} [options.page] - number for exact page, a${number} posts after ${number}, b${number} posts before ${number}
|
|
29
|
+
* @param {number} [options.limit] - limit the maximum amount of results returned
|
|
30
|
+
* @returns {Promise<Array<Post>>}
|
|
31
|
+
*/
|
|
32
|
+
search(options?: SearchPostsOptions): Promise<Post[]>;
|
|
33
|
+
/**
|
|
34
|
+
* Upload a post
|
|
35
|
+
*
|
|
36
|
+
* * Requires Authentication
|
|
37
|
+
*
|
|
38
|
+
* @param {object} options
|
|
39
|
+
* @param {(Array<string> | string)} options.tags - the tags for the post
|
|
40
|
+
* @param {Ratings} options.rating - the rating for the post
|
|
41
|
+
* @param {(Array<string> | string)} [options.sources] - the sources for the post
|
|
42
|
+
* @param {string} [options.description] - the description of the post
|
|
43
|
+
* @param {number} [options.parentID] - the parent of the post
|
|
44
|
+
* @param {string} [options.refererURL] - dunno, api doc specifies it though
|
|
45
|
+
* @param {string} [options.md5Confirmation] - confirm of the md5 of the uploaded file
|
|
46
|
+
* @param {boolean} [options.asPending] - upload as pending (requires approver)
|
|
47
|
+
* @param {boolean} [options.ratingLocked] - upload as rating locked (requires privileged)
|
|
48
|
+
* @param {(Array<string> | string)} [options.lockedTags] - tags to lock on the post (requires admin)
|
|
49
|
+
* @param {Buffer} [options.file] - file upload (mutually exclusive with fileURL, not well tested)
|
|
50
|
+
* @param {string} [options.fileURL] - url of file to upload (mutually exclusive with file)
|
|
51
|
+
* @returns {Promise<number>}
|
|
52
|
+
*/
|
|
53
|
+
create(options: CreatePostOptions): Promise<number>;
|
|
54
|
+
/**
|
|
55
|
+
* Modify a post
|
|
56
|
+
*
|
|
57
|
+
* * Requires Authentication
|
|
58
|
+
*
|
|
59
|
+
* @param {object} options
|
|
60
|
+
* @param {string} [options.editReason] - the reason for the edit
|
|
61
|
+
* @param {(Array<string> | string)} [options.addTags] - the tags to add to the post
|
|
62
|
+
* @param {(Array<string> | string)} [options.removeTags] - the tags to remove from the post
|
|
63
|
+
* @param {(Array<string> | string)} [options.addSources] - the sources to add to the post
|
|
64
|
+
* @param {(Array<string> | string)} [options.removeSources] - the sources to remove from the post
|
|
65
|
+
* @param {Ratings} [options.rating] - the rating for the post
|
|
66
|
+
* @param {string} [options.description] - the description of the post
|
|
67
|
+
* @param {number} [options.parentID] - the parent of the post
|
|
68
|
+
* @param {boolean} [options.hasEmbeddedNotes] - I don't know what this is, api docs list it though
|
|
69
|
+
* @param {boolean} [options.ratingLocked] - upload as rating locked (requires privileged)
|
|
70
|
+
* @param {boolean} [options.noteLocked] - upload as rating locked (requires janitor)
|
|
71
|
+
* @param {boolean} [options.statusLocked] - upload as rating locked (requires admin)
|
|
72
|
+
* @param {boolean} [options.hideFromAnonymous] - upload as rating locked (requires admin)
|
|
73
|
+
* @param {boolean} [options.hideFromSearch] - upload as rating locked (requires admin)
|
|
74
|
+
* @param {string} [options.backgroundColor] - the background color of the post (requires janitor)
|
|
75
|
+
* @param {(Array<string> | string)} [options.lockedTags] - tags to lock on the post (requires admin)
|
|
76
|
+
* @returns {Promise<Post>}
|
|
77
|
+
*/
|
|
78
|
+
modify(id: number, options: ModifyPostOptions): Promise<Post>;
|
|
79
|
+
/**
|
|
80
|
+
* Revert a post to a previous version
|
|
81
|
+
*
|
|
82
|
+
* * Requires Authentication
|
|
83
|
+
*
|
|
84
|
+
* @param {number} id - the id of the post to revert
|
|
85
|
+
* @param {number} versionID - the version id to revert to (see history)
|
|
86
|
+
*/
|
|
87
|
+
revert(id: number, versionID: number): Promise<null>;
|
|
88
|
+
/**
|
|
89
|
+
* Search the post history
|
|
90
|
+
*
|
|
91
|
+
* @param {object} [options]
|
|
92
|
+
* @param {string} [options.user] - narrow the results by username
|
|
93
|
+
* @param {number} [options.userID] - narrow the results by user id
|
|
94
|
+
* @param {number} [options.post] - narrow the results by post id
|
|
95
|
+
* @param {string} [options.reason] - narrow the results by edit reason
|
|
96
|
+
* @param {string} [options.description] - narrow the results by description content
|
|
97
|
+
* @param {Ratings} [options.ratingChangedTo] - narrow the results by rating change
|
|
98
|
+
* @param {Ratings} [options.finalRating] - narrow the results by final rating
|
|
99
|
+
* @param {number} [options.parent] - narrow the results by parent id
|
|
100
|
+
* @param {number} [options.parentChangedTo] - narrow the results by changed parent id
|
|
101
|
+
* @param {(Array<string> | string)} [options.finalTags] - narrow the results by final tags
|
|
102
|
+
* @param {(Array<string> | string)} [options.addedTags] - narrow the results by added tags
|
|
103
|
+
* @param {(Array<string> | string)} [options.removedTags] - narrow the results by removed tags
|
|
104
|
+
* @param {(Array<string> | string)} [options.finalLockedTags] - narrow the results by final locked tags
|
|
105
|
+
* @param {(Array<string> | string)} [options.addedLockedTags] - narrow the results by added locked tags
|
|
106
|
+
* @param {(Array<string> | string)} [options.removedLockedTags] - narrow the results by removed locked tags
|
|
107
|
+
* @param {string} [options.source] - narrow the results by sources
|
|
108
|
+
* @param {(number |`${"" | "a" | "b"}${number}`)} [options.page] - page of results to get
|
|
109
|
+
* @param {number} [options.limit] - limit the maximum amount of results returned
|
|
110
|
+
* @param
|
|
111
|
+
* @returns {Promise<Array<PostHistory>>}
|
|
112
|
+
*/
|
|
113
|
+
searchHistory(options?: SearchPostHistoryOptions): Promise<PostHistory[]>;
|
|
114
|
+
/**
|
|
115
|
+
* Vote on a post
|
|
116
|
+
*
|
|
117
|
+
* * Requires Authentication
|
|
118
|
+
*
|
|
119
|
+
* @param {number} id - the id of the post to vote on
|
|
120
|
+
* @param {boolean} up - if the vote should be up or down
|
|
121
|
+
* @returns {Promise<PostVoteResult>}
|
|
122
|
+
*/
|
|
123
|
+
vote(id: number, up: boolean): Promise<PostVoteResult>;
|
|
124
|
+
}
|
|
@@ -0,0 +1,323 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
const Post_1 = __importDefault(require("../structures/Post"));
|
|
7
|
+
const PostHistory_1 = __importDefault(require("../structures/PostHistory"));
|
|
8
|
+
const FormHelper_1 = __importDefault(require("../util/FormHelper"));
|
|
9
|
+
const RequestHandler_1 = require("../util/RequestHandler");
|
|
10
|
+
class Posts {
|
|
11
|
+
auth;
|
|
12
|
+
main;
|
|
13
|
+
constructor(main) {
|
|
14
|
+
Object.defineProperties(this, {
|
|
15
|
+
auth: {
|
|
16
|
+
get() {
|
|
17
|
+
return !this.main.options.authUser || !this.main.options.authKey ? null : `Basic ${Buffer.from(`${this.main.options.authUser}:${this.main.options.authKey}`).toString("base64")}`;
|
|
18
|
+
},
|
|
19
|
+
configurable: false,
|
|
20
|
+
enumerable: false
|
|
21
|
+
},
|
|
22
|
+
main: {
|
|
23
|
+
value: main,
|
|
24
|
+
configurable: false,
|
|
25
|
+
enumerable: false,
|
|
26
|
+
writable: false
|
|
27
|
+
}
|
|
28
|
+
});
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* Get a post by its id
|
|
32
|
+
*
|
|
33
|
+
* @param {(number | string)} id - The id of the post to get
|
|
34
|
+
* @returns {Promise<(Post | null)>}
|
|
35
|
+
*/
|
|
36
|
+
async get(id) {
|
|
37
|
+
const res = await this.main.request.get(`/posts/${id}.json`).catch(err => {
|
|
38
|
+
if (err instanceof RequestHandler_1.APIError && err.statusCode === 404)
|
|
39
|
+
return null;
|
|
40
|
+
throw err;
|
|
41
|
+
});
|
|
42
|
+
return res === null ? null : new Post_1.default(this.main, res.post);
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* Get a post by its md5
|
|
46
|
+
*
|
|
47
|
+
* @param {string} md5 - The md5 of the post to get
|
|
48
|
+
* @returns {Promise<(Post | null)>}
|
|
49
|
+
*/
|
|
50
|
+
async getByMD5(md5) {
|
|
51
|
+
const res = await this.main.request.get(`/posts.json?md5=${md5}`).catch(err => {
|
|
52
|
+
if (err instanceof RequestHandler_1.APIError && err.statusCode === 404)
|
|
53
|
+
return null;
|
|
54
|
+
throw err;
|
|
55
|
+
});
|
|
56
|
+
return res === null ? null : new Post_1.default(this.main, res.post);
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* Search for posts
|
|
60
|
+
*
|
|
61
|
+
* @param {object} [options]
|
|
62
|
+
* @param {(Array<string> | string)} [options.tags] - narrow the search by specific tags
|
|
63
|
+
* @param {(number |`${"" | "a" | "b"}${number}`)} [options.page] - number for exact page, a${number} posts after ${number}, b${number} posts before ${number}
|
|
64
|
+
* @param {number} [options.limit] - limit the maximum amount of results returned
|
|
65
|
+
* @returns {Promise<Array<Post>>}
|
|
66
|
+
*/
|
|
67
|
+
async search(options) {
|
|
68
|
+
options = options ?? {};
|
|
69
|
+
const qs = new FormHelper_1.default();
|
|
70
|
+
if (Array.isArray(options.tags) || typeof options.tags === "string")
|
|
71
|
+
qs.add("tags", Array.isArray(options.tags) ? options.tags.join(" ") : options.tags);
|
|
72
|
+
if (typeof options.page !== "undefined")
|
|
73
|
+
qs.add("page", options.page);
|
|
74
|
+
if (typeof options.limit === "number" || typeof options.limit === "string")
|
|
75
|
+
qs.add("limit", options.limit);
|
|
76
|
+
const res = await this.main.request.get(`/posts.json?${qs.build()}`);
|
|
77
|
+
return res.posts.map(info => new Post_1.default(this.main, info));
|
|
78
|
+
}
|
|
79
|
+
/**
|
|
80
|
+
* Upload a post
|
|
81
|
+
*
|
|
82
|
+
* * Requires Authentication
|
|
83
|
+
*
|
|
84
|
+
* @param {object} options
|
|
85
|
+
* @param {(Array<string> | string)} options.tags - the tags for the post
|
|
86
|
+
* @param {Ratings} options.rating - the rating for the post
|
|
87
|
+
* @param {(Array<string> | string)} [options.sources] - the sources for the post
|
|
88
|
+
* @param {string} [options.description] - the description of the post
|
|
89
|
+
* @param {number} [options.parentID] - the parent of the post
|
|
90
|
+
* @param {string} [options.refererURL] - dunno, api doc specifies it though
|
|
91
|
+
* @param {string} [options.md5Confirmation] - confirm of the md5 of the uploaded file
|
|
92
|
+
* @param {boolean} [options.asPending] - upload as pending (requires approver)
|
|
93
|
+
* @param {boolean} [options.ratingLocked] - upload as rating locked (requires privileged)
|
|
94
|
+
* @param {(Array<string> | string)} [options.lockedTags] - tags to lock on the post (requires admin)
|
|
95
|
+
* @param {Buffer} [options.file] - file upload (mutually exclusive with fileURL, not well tested)
|
|
96
|
+
* @param {string} [options.fileURL] - url of file to upload (mutually exclusive with file)
|
|
97
|
+
* @returns {Promise<number>}
|
|
98
|
+
*/
|
|
99
|
+
async create(options) {
|
|
100
|
+
this.main.request.authCheck.call(this, "Posts#create");
|
|
101
|
+
if (!options)
|
|
102
|
+
throw new Error("options is required for Posts#create");
|
|
103
|
+
if (!("fileURL" in options || "file" in options))
|
|
104
|
+
throw new Error("one of options.file, options.fileURL is required for Posts#create");
|
|
105
|
+
if ("fileURL" in options && "file" in options)
|
|
106
|
+
process.emitWarning("only one of options.file, options.fileURL should be provided to Posts#create. options.fileURL overrides options.file.");
|
|
107
|
+
const qs = new FormHelper_1.default();
|
|
108
|
+
if (typeof options.tags === "string")
|
|
109
|
+
qs.add("upload[tag_string]", options.tags);
|
|
110
|
+
if (typeof options.sources === "string")
|
|
111
|
+
qs.add("upload[source]", options.sources);
|
|
112
|
+
if (typeof options.lockedTags === "string")
|
|
113
|
+
qs.add("upload[locked_tags]", options.lockedTags);
|
|
114
|
+
if (Array.isArray(options.tags) && options.tags.length > 0)
|
|
115
|
+
qs.add("upload[tag_string]", options.tags.join(" "));
|
|
116
|
+
if (Array.isArray(options.sources) && options.sources.length > 0)
|
|
117
|
+
qs.add("upload[source]", options.sources.join("\n"));
|
|
118
|
+
if (Array.isArray(options.lockedTags) && options.lockedTags.length > 0)
|
|
119
|
+
qs.add("upload[locked_tags]", options.lockedTags.join("\n"));
|
|
120
|
+
if (typeof options.rating === "string")
|
|
121
|
+
qs.add("upload[rating]", options.rating);
|
|
122
|
+
if (typeof options.description === "string")
|
|
123
|
+
qs.add("upload[description]", options.description);
|
|
124
|
+
if (typeof options.parentID === "number")
|
|
125
|
+
qs.add("upload[parent_id]", options.parentID);
|
|
126
|
+
if (typeof options.refererURL === "string")
|
|
127
|
+
qs.add("upload[referer_url]", options.refererURL);
|
|
128
|
+
if (typeof options.asPending === "boolean")
|
|
129
|
+
qs.add("upload[as_pending]", options.asPending);
|
|
130
|
+
if (typeof options.md5Confirmation === "string")
|
|
131
|
+
qs.add("upload[md5_confirmation]", options.md5Confirmation);
|
|
132
|
+
if (typeof options.ratingLocked === "boolean")
|
|
133
|
+
qs.add("upload[locked_rating]", options.ratingLocked);
|
|
134
|
+
let res;
|
|
135
|
+
if ("fileURL" in options && typeof options.fileURL === "string") {
|
|
136
|
+
qs.add("upload[direct_url]", options.fileURL);
|
|
137
|
+
res = await this.main.request.post("/uploads.json", qs.build());
|
|
138
|
+
}
|
|
139
|
+
else if ("file" in options) {
|
|
140
|
+
res = await this.main.request.postWithFile("/uploads.json", qs, [{ content: options.file, name: "upload[file]" }]);
|
|
141
|
+
}
|
|
142
|
+
return res.post_id;
|
|
143
|
+
}
|
|
144
|
+
/**
|
|
145
|
+
* Modify a post
|
|
146
|
+
*
|
|
147
|
+
* * Requires Authentication
|
|
148
|
+
*
|
|
149
|
+
* @param {object} options
|
|
150
|
+
* @param {string} [options.editReason] - the reason for the edit
|
|
151
|
+
* @param {(Array<string> | string)} [options.addTags] - the tags to add to the post
|
|
152
|
+
* @param {(Array<string> | string)} [options.removeTags] - the tags to remove from the post
|
|
153
|
+
* @param {(Array<string> | string)} [options.addSources] - the sources to add to the post
|
|
154
|
+
* @param {(Array<string> | string)} [options.removeSources] - the sources to remove from the post
|
|
155
|
+
* @param {Ratings} [options.rating] - the rating for the post
|
|
156
|
+
* @param {string} [options.description] - the description of the post
|
|
157
|
+
* @param {number} [options.parentID] - the parent of the post
|
|
158
|
+
* @param {boolean} [options.hasEmbeddedNotes] - I don't know what this is, api docs list it though
|
|
159
|
+
* @param {boolean} [options.ratingLocked] - upload as rating locked (requires privileged)
|
|
160
|
+
* @param {boolean} [options.noteLocked] - upload as rating locked (requires janitor)
|
|
161
|
+
* @param {boolean} [options.statusLocked] - upload as rating locked (requires admin)
|
|
162
|
+
* @param {boolean} [options.hideFromAnonymous] - upload as rating locked (requires admin)
|
|
163
|
+
* @param {boolean} [options.hideFromSearch] - upload as rating locked (requires admin)
|
|
164
|
+
* @param {string} [options.backgroundColor] - the background color of the post (requires janitor)
|
|
165
|
+
* @param {(Array<string> | string)} [options.lockedTags] - tags to lock on the post (requires admin)
|
|
166
|
+
* @returns {Promise<Post>}
|
|
167
|
+
*/
|
|
168
|
+
async modify(id, options) {
|
|
169
|
+
this.main.request.authCheck.call(this, "Posts#modify");
|
|
170
|
+
if (!options)
|
|
171
|
+
throw new Error("options is required for Posts#modify");
|
|
172
|
+
const qs = new FormHelper_1.default();
|
|
173
|
+
let tagDiff = "", sourceDiff = "";
|
|
174
|
+
if (typeof options.addTags === "string")
|
|
175
|
+
tagDiff += options.addTags;
|
|
176
|
+
if (Array.isArray(options.addTags) && options.addTags.length > 0)
|
|
177
|
+
tagDiff += options.addTags.join(" ");
|
|
178
|
+
if (typeof options.removeTags === "string")
|
|
179
|
+
tagDiff += options.removeTags.split(" ").map(t => `-${t}`).join(" ");
|
|
180
|
+
if (Array.isArray(options.removeTags) && options.removeTags.length > 0)
|
|
181
|
+
tagDiff += ` ${options.removeTags.map(t => `-${t}`).join(" ")}`;
|
|
182
|
+
if (typeof options.addSources === "string")
|
|
183
|
+
sourceDiff += options.addSources;
|
|
184
|
+
if (Array.isArray(options.addSources) && options.addSources.length > 0)
|
|
185
|
+
sourceDiff += options.addSources.join("\n");
|
|
186
|
+
if (typeof options.removeSources === "string")
|
|
187
|
+
sourceDiff += options.removeSources.split("\n").map(s => `-${s}`).join("\n");
|
|
188
|
+
if (Array.isArray(options.removeSources) && options.removeSources.length > 0)
|
|
189
|
+
sourceDiff += ` ${options.removeSources.map(s => `-${s}`).join("\n")}`;
|
|
190
|
+
if (tagDiff)
|
|
191
|
+
qs.add("post[tag_string_diff]", tagDiff.trim());
|
|
192
|
+
if (sourceDiff)
|
|
193
|
+
qs.add("post[source_diff]", sourceDiff.trim());
|
|
194
|
+
if (typeof options.lockedTags === "string")
|
|
195
|
+
qs.add("post[locked_tags]", options.lockedTags);
|
|
196
|
+
if (Array.isArray(options.lockedTags) && options.lockedTags.length > 0)
|
|
197
|
+
qs.add("post[locked_tags]", options.lockedTags.join("\n"));
|
|
198
|
+
if (typeof options.rating === "string")
|
|
199
|
+
qs.add("post[rating]", options.rating);
|
|
200
|
+
if (typeof options.description === "string")
|
|
201
|
+
qs.add("post[description]", options.description);
|
|
202
|
+
if (typeof options.parentID === "number")
|
|
203
|
+
qs.add("post[parent_id]", options.parentID);
|
|
204
|
+
if (typeof options.hasEmbeddedNotes === "boolean")
|
|
205
|
+
qs.add("post[has_embedded_notes]", options.hasEmbeddedNotes);
|
|
206
|
+
if (typeof options.ratingLocked === "boolean")
|
|
207
|
+
qs.add("post[is_rating_locked]", options.ratingLocked);
|
|
208
|
+
if (typeof options.noteLocked === "boolean")
|
|
209
|
+
qs.add("post[is_note_locked]", options.noteLocked);
|
|
210
|
+
if (typeof options.statusLocked === "boolean")
|
|
211
|
+
qs.add("post[is_status_locked]", options.statusLocked);
|
|
212
|
+
if (typeof options.hideFromAnonymous === "boolean")
|
|
213
|
+
qs.add("post[hide_from_anonymous]", options.hideFromAnonymous);
|
|
214
|
+
if (typeof options.hideFromSearch === "boolean")
|
|
215
|
+
qs.add("post[hide_from_search_engines]", options.hideFromSearch);
|
|
216
|
+
if (typeof options.backgroundColor === "string")
|
|
217
|
+
qs.add("post[bg_color]", options.backgroundColor);
|
|
218
|
+
if (typeof options.editReason === "string")
|
|
219
|
+
qs.add("post[edit_reason]", options.editReason);
|
|
220
|
+
const res = await this.main.request.patch(`/posts/${id}.json`, qs.build());
|
|
221
|
+
return new Post_1.default(this.main, res.post);
|
|
222
|
+
}
|
|
223
|
+
// @TODO delete/approved/unapproved - not a high priority
|
|
224
|
+
/**
|
|
225
|
+
* Revert a post to a previous version
|
|
226
|
+
*
|
|
227
|
+
* * Requires Authentication
|
|
228
|
+
*
|
|
229
|
+
* @param {number} id - the id of the post to revert
|
|
230
|
+
* @param {number} versionID - the version id to revert to (see history)
|
|
231
|
+
*/
|
|
232
|
+
async revert(id, versionID) {
|
|
233
|
+
this.main.request.authCheck.call(this, "Posts#revert");
|
|
234
|
+
const qs = new FormHelper_1.default()
|
|
235
|
+
.add("version_id", versionID);
|
|
236
|
+
return this.main.request.put(`/posts/${id}/revert.json`, qs.build());
|
|
237
|
+
}
|
|
238
|
+
/**
|
|
239
|
+
* Search the post history
|
|
240
|
+
*
|
|
241
|
+
* @param {object} [options]
|
|
242
|
+
* @param {string} [options.user] - narrow the results by username
|
|
243
|
+
* @param {number} [options.userID] - narrow the results by user id
|
|
244
|
+
* @param {number} [options.post] - narrow the results by post id
|
|
245
|
+
* @param {string} [options.reason] - narrow the results by edit reason
|
|
246
|
+
* @param {string} [options.description] - narrow the results by description content
|
|
247
|
+
* @param {Ratings} [options.ratingChangedTo] - narrow the results by rating change
|
|
248
|
+
* @param {Ratings} [options.finalRating] - narrow the results by final rating
|
|
249
|
+
* @param {number} [options.parent] - narrow the results by parent id
|
|
250
|
+
* @param {number} [options.parentChangedTo] - narrow the results by changed parent id
|
|
251
|
+
* @param {(Array<string> | string)} [options.finalTags] - narrow the results by final tags
|
|
252
|
+
* @param {(Array<string> | string)} [options.addedTags] - narrow the results by added tags
|
|
253
|
+
* @param {(Array<string> | string)} [options.removedTags] - narrow the results by removed tags
|
|
254
|
+
* @param {(Array<string> | string)} [options.finalLockedTags] - narrow the results by final locked tags
|
|
255
|
+
* @param {(Array<string> | string)} [options.addedLockedTags] - narrow the results by added locked tags
|
|
256
|
+
* @param {(Array<string> | string)} [options.removedLockedTags] - narrow the results by removed locked tags
|
|
257
|
+
* @param {string} [options.source] - narrow the results by sources
|
|
258
|
+
* @param {(number |`${"" | "a" | "b"}${number}`)} [options.page] - page of results to get
|
|
259
|
+
* @param {number} [options.limit] - limit the maximum amount of results returned
|
|
260
|
+
* @param
|
|
261
|
+
* @returns {Promise<Array<PostHistory>>}
|
|
262
|
+
*/
|
|
263
|
+
async searchHistory(options) {
|
|
264
|
+
options = options ?? {};
|
|
265
|
+
const qs = new FormHelper_1.default();
|
|
266
|
+
if (typeof options.user === "string")
|
|
267
|
+
qs.add("search[updater_name]", options.user);
|
|
268
|
+
if (typeof options.userID === "number")
|
|
269
|
+
qs.add("search[updater_id]", options.userID);
|
|
270
|
+
if (typeof options.post === "number")
|
|
271
|
+
qs.add("search[post_id]", options.post);
|
|
272
|
+
if (typeof options.reason === "string")
|
|
273
|
+
qs.add("search[reason]", options.reason);
|
|
274
|
+
if (typeof options.description === "string")
|
|
275
|
+
qs.add("search[description]", options.description);
|
|
276
|
+
if (typeof options.ratingChangedTo === "string")
|
|
277
|
+
qs.add("search[rating_changed]", options.ratingChangedTo);
|
|
278
|
+
if (typeof options.finalRating === "string")
|
|
279
|
+
qs.add("search[rating]", options.finalRating);
|
|
280
|
+
if (typeof options.parent === "number")
|
|
281
|
+
qs.add("search[parent_id]", options.parent);
|
|
282
|
+
if (typeof options.parentChangedTo === "string")
|
|
283
|
+
qs.add("search[parent_id_changed]", options.parentChangedTo);
|
|
284
|
+
if (typeof options.finalTags === "string")
|
|
285
|
+
qs.add("search[tags]", options.finalTags);
|
|
286
|
+
if (typeof options.addedTags === "string")
|
|
287
|
+
qs.add("search[tags_added]", options.addedTags);
|
|
288
|
+
if (typeof options.removedTags === "string")
|
|
289
|
+
qs.add("search[tags_removed]", options.removedTags);
|
|
290
|
+
if (typeof options.finalLockedTags === "string")
|
|
291
|
+
qs.add("search[locked_tags]", options.finalLockedTags);
|
|
292
|
+
if (typeof options.addedLockedTags === "string")
|
|
293
|
+
qs.add("search[locked_tags_added]", options.addedLockedTags);
|
|
294
|
+
if (typeof options.removedLockedTags === "string")
|
|
295
|
+
qs.add("search[locked_tags_removed]", options.removedLockedTags);
|
|
296
|
+
if (typeof options.source === "string")
|
|
297
|
+
qs.add("search[source]", options.source);
|
|
298
|
+
if (typeof options.page !== "undefined")
|
|
299
|
+
qs.add("page", options.page);
|
|
300
|
+
if (typeof options.limit === "number")
|
|
301
|
+
qs.add("limit", options.limit);
|
|
302
|
+
const res = await this.main.request.get(`/post_versions.json?${qs.build()}`);
|
|
303
|
+
return res.map(info => new PostHistory_1.default(this.main, info));
|
|
304
|
+
}
|
|
305
|
+
/**
|
|
306
|
+
* Vote on a post
|
|
307
|
+
*
|
|
308
|
+
* * Requires Authentication
|
|
309
|
+
*
|
|
310
|
+
* @param {number} id - the id of the post to vote on
|
|
311
|
+
* @param {boolean} up - if the vote should be up or down
|
|
312
|
+
* @returns {Promise<PostVoteResult>}
|
|
313
|
+
*/
|
|
314
|
+
async vote(id, up) {
|
|
315
|
+
this.main.request.authCheck.call(this, "Posts#vote");
|
|
316
|
+
const qs = new FormHelper_1.default()
|
|
317
|
+
.add("score", up ? 1 : -1);
|
|
318
|
+
const res = await this.main.request.post(`/posts/${id}/votes.json`, qs.build());
|
|
319
|
+
return res;
|
|
320
|
+
}
|
|
321
|
+
}
|
|
322
|
+
exports.default = Posts;
|
|
323
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"Posts.js","sourceRoot":"","sources":["../../../src/modules/Posts.ts"],"names":[],"mappings":";;;;;AACA,8DAAsC;AACtC,4EAAoD;AAYpD,oEAA4C;AAC5C,2DAAkD;AAElD,MAAqB,KAAK;IACR,IAAI,CAAgB;IACpB,IAAI,CAAO;IAC5B,YAAY,IAAU;QACrB,MAAM,CAAC,gBAAgB,CAAC,IAAI,EAAE;YAC7B,IAAI,EAAE;gBACL,GAAG;oBACF,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACnL,CAAC;gBACD,YAAY,EAAE,KAAK;gBACnB,UAAU,EAAE,KAAK;aACjB;YACD,IAAI,EAAE;gBACL,KAAK,EAAE,IAAI;gBACX,YAAY,EAAE,KAAK;gBACnB,UAAU,EAAE,KAAK;gBACjB,QAAQ,EAAE,KAAK;aACf;SACD,CAAC,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,GAAG,CAAC,EAAmB;QAC5B,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAA4B,UAAU,EAAE,OAAO,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;YACnG,IAAI,GAAG,YAAY,yBAAQ,IAAI,GAAG,CAAC,UAAU,KAAK,GAAG;gBAAE,OAAO,IAAI,CAAC;YACnE,MAAM,GAAG,CAAC;QACX,CAAC,CAAC,CAAC;QACH,OAAO,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,cAAI,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,CAAC,GAAW;QACzB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAA4B,mBAAmB,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;YACxG,IAAI,GAAG,YAAY,yBAAQ,IAAI,GAAG,CAAC,UAAU,KAAK,GAAG;gBAAE,OAAO,IAAI,CAAC;YACnE,MAAM,GAAG,CAAC;QACX,CAAC,CAAC,CAAC;QACH,OAAO,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,cAAI,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,MAAM,CAAC,OAA4B;QACxC,OAAO,GAAG,OAAO,IAAI,EAAE,CAAC;QACxB,MAAM,EAAE,GAAG,IAAI,oBAAU,EAAE,CAAC;QAC5B,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ;YAAG,EAAE,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC1J,IAAI,OAAO,OAAO,CAAC,IAAI,KAAK,WAAW;YAAE,EAAE,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;QACtE,IAAI,OAAO,OAAO,CAAC,KAAK,KAAK,QAAQ,IAAI,OAAO,OAAO,CAAC,KAAK,KAAK,QAAQ;YAAE,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;QAC3G,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAoC,eAAe,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACxG,OAAO,GAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,cAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,MAAM,CAAC,OAA0B;QACtC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;QACvD,IAAI,CAAC,OAAO;YAAE,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QACtE,IAAI,CAAC,CAAC,SAAS,IAAI,OAAO,IAAI,MAAM,IAAI,OAAO,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,mEAAmE,CAAC,CAAC;QACvI,IAAI,SAAS,IAAI,OAAO,IAAI,MAAM,IAAI,OAAO;YAAE,OAAO,CAAC,WAAW,CAAC,uHAAuH,CAAC,CAAC;QAC5L,MAAM,EAAE,GAAG,IAAI,oBAAU,EAAE,CAAC;QAC5B,IAAI,OAAO,OAAO,CAAC,IAAI,KAAgB,QAAQ;YAAG,EAAE,CAAC,GAAG,CAAC,oBAAoB,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;QAC7F,IAAI,OAAO,OAAO,CAAC,OAAO,KAAa,QAAQ;YAAG,EAAE,CAAC,GAAG,CAAC,gBAAgB,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QAC5F,IAAI,OAAO,OAAO,CAAC,UAAU,KAAU,QAAQ;YAAG,EAAE,CAAC,GAAG,CAAC,qBAAqB,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;QACpG,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAU,OAAO,CAAC,IAAI,CAAC,MAAM,GAAS,CAAC;YAAE,EAAE,CAAC,GAAG,CAAC,oBAAoB,EAAE,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QAC7H,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,IAAO,OAAO,CAAC,OAAO,CAAC,MAAM,GAAM,CAAC;YAAE,EAAE,CAAC,GAAG,CAAC,gBAAgB,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC7H,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,OAAO,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC;YAAE,EAAE,CAAC,GAAG,CAAC,qBAAqB,EAAE,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACrI,IAAI,OAAO,OAAO,CAAC,MAAM,KAAc,QAAQ;YAAG,EAAE,CAAC,GAAG,CAAC,gBAAgB,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QAC3F,IAAI,OAAO,OAAO,CAAC,WAAW,KAAS,QAAQ;YAAG,EAAE,CAAC,GAAG,CAAC,qBAAqB,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;QACrG,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAY,QAAQ;YAAG,EAAE,CAAC,GAAG,CAAC,mBAAmB,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;QAChG,IAAI,OAAO,OAAO,CAAC,UAAU,KAAU,QAAQ;YAAG,EAAE,CAAC,GAAG,CAAC,qBAAqB,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;QACpG,IAAI,OAAO,OAAO,CAAC,SAAS,KAAW,SAAS;YAAE,EAAE,CAAC,GAAG,CAAC,oBAAoB,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;QAClG,IAAI,OAAO,OAAO,CAAC,eAAe,KAAK,QAAQ;YAAG,EAAE,CAAC,GAAG,CAAC,0BAA0B,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;QAC9G,IAAI,OAAO,OAAO,CAAC,YAAY,KAAQ,SAAS;YAAE,EAAE,CAAC,GAAG,CAAC,uBAAuB,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;QACxG,IAAI,GAAmB,CAAC;QACxB,IAAI,SAAS,IAAI,OAAO,IAAI,OAAO,OAAO,CAAC,OAAO,KAAK,QAAQ,EAAE;YAChE,EAAE,CAAC,GAAG,CAAC,oBAAoB,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;YAC9C,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAU,eAAe,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC;SACzE;aAAM,IAAI,MAAM,IAAI,OAAO,EAAE;YAC7B,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAU,eAAe,EAAE,EAAE,EAAE,CAAE,EAAE,OAAO,EAAE,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC;SAC7H;QACD,OAAO,GAAI,CAAC,OAAO,CAAC;IACrB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAA0B;QAClD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;QACvD,IAAI,CAAC,OAAO;YAAE,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QACtE,MAAM,EAAE,GAAG,IAAI,oBAAU,EAAE,CAAC;QAC5B,IAAI,OAAO,GAAG,EAAE,EAAE,UAAU,GAAG,EAAE,CAAC;QAClC,IAAI,OAAO,OAAO,CAAC,OAAO,KAAW,QAAQ;YAAE,OAAO,IAAO,OAAO,CAAC,OAAO,CAAC;QAC7E,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,IAAa,OAAO,CAAC,OAAO,CAAC,MAAM,GAAS,CAAC;YAAE,OAAO,IAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzH,IAAI,OAAO,OAAO,CAAC,UAAU,KAAQ,QAAQ;YAAE,OAAO,IAAO,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACvH,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,IAAU,OAAO,CAAC,UAAU,CAAC,MAAM,GAAM,CAAC;YAAE,OAAO,IAAO,IAAI,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACpJ,IAAI,OAAO,OAAO,CAAC,UAAU,KAAQ,QAAQ;YAAE,UAAU,IAAI,OAAO,CAAC,UAAU,CAAC;QAChF,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,IAAU,OAAO,CAAC,UAAU,CAAC,MAAM,GAAM,CAAC;YAAE,UAAU,IAAI,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7H,IAAI,OAAO,OAAO,CAAC,aAAa,KAAK,QAAQ;YAAE,UAAU,IAAI,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5H,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,IAAO,OAAO,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC;YAAE,UAAU,IAAI,IAAI,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACxJ,IAAI,OAAO;YAAE,EAAE,CAAC,GAAG,CAAC,uBAAuB,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;QAC7D,IAAI,UAAU;YAAE,EAAE,CAAC,GAAG,CAAC,mBAAmB,EAAE,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC;QAC/D,IAAI,OAAO,OAAO,CAAC,UAAU,KAAY,QAAQ;YAAG,EAAE,CAAC,GAAG,CAAC,mBAAmB,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;QACpG,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,OAAO,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC;YAAE,EAAE,CAAC,GAAG,CAAC,mBAAmB,EAAE,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACnI,IAAI,OAAO,OAAO,CAAC,MAAM,KAAgB,QAAQ;YAAG,EAAE,CAAC,GAAG,CAAC,cAAc,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QAC3F,IAAI,OAAO,OAAO,CAAC,WAAW,KAAW,QAAQ;YAAG,EAAE,CAAC,GAAG,CAAC,mBAAmB,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;QACrG,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAc,QAAQ;YAAG,EAAE,CAAC,GAAG,CAAC,iBAAiB,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;QAChG,IAAI,OAAO,OAAO,CAAC,gBAAgB,KAAM,SAAS;YAAE,EAAE,CAAC,GAAG,CAAC,0BAA0B,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC;QACjH,IAAI,OAAO,OAAO,CAAC,YAAY,KAAU,SAAS;YAAE,EAAE,CAAC,GAAG,CAAC,wBAAwB,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;QAC3G,IAAI,OAAO,OAAO,CAAC,UAAU,KAAY,SAAS;YAAE,EAAE,CAAC,GAAG,CAAC,sBAAsB,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;QACvG,IAAI,OAAO,OAAO,CAAC,YAAY,KAAU,SAAS;YAAE,EAAE,CAAC,GAAG,CAAC,wBAAwB,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;QAC3G,IAAI,OAAO,OAAO,CAAC,iBAAiB,KAAK,SAAS;YAAE,EAAE,CAAC,GAAG,CAAC,2BAA2B,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC;QACnH,IAAI,OAAO,OAAO,CAAC,cAAc,KAAQ,SAAS;YAAE,EAAE,CAAC,GAAG,CAAC,gCAAgC,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;QACrH,IAAI,OAAO,OAAO,CAAC,eAAe,KAAO,QAAQ;YAAG,EAAE,CAAC,GAAG,CAAC,gBAAgB,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;QACtG,IAAI,OAAO,OAAO,CAAC,UAAU,KAAY,QAAQ;YAAG,EAAE,CAAC,GAAG,CAAC,mBAAmB,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;QACpG,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAA4B,UAAU,EAAE,OAAO,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC;QACtG,OAAO,IAAI,cAAI,CAAC,IAAI,CAAC,IAAI,EAAE,GAAI,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC;IAED,yDAAyD;IAEzD;;;;;;;OAOG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,SAAiB;QACzC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;QACvD,MAAM,EAAE,GAAG,IAAI,oBAAU,EAAE;aACzB,GAAG,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;QAC/B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAO,UAAU,EAAE,cAAc,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,KAAK,CAAC,aAAa,CAAC,OAAkC;QACrD,OAAO,GAAG,OAAO,IAAI,EAAE,CAAC;QACxB,MAAM,EAAE,GAAG,IAAI,oBAAU,EAAE,CAAC;QAC5B,IAAI,OAAO,OAAO,CAAC,IAAI,KAAkB,QAAQ;YAAK,EAAE,CAAC,GAAG,CAAC,sBAAsB,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;QACnG,IAAI,OAAO,OAAO,CAAC,MAAM,KAAgB,QAAQ;YAAK,EAAE,CAAC,GAAG,CAAC,oBAAoB,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QACnG,IAAI,OAAO,OAAO,CAAC,IAAI,KAAkB,QAAQ;YAAK,EAAE,CAAC,GAAG,CAAC,iBAAiB,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;QAC9F,IAAI,OAAO,OAAO,CAAC,MAAM,KAAgB,QAAQ;YAAK,EAAE,CAAC,GAAG,CAAC,gBAAgB,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QAC/F,IAAI,OAAO,OAAO,CAAC,WAAW,KAAW,QAAQ;YAAK,EAAE,CAAC,GAAG,CAAC,qBAAqB,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;QACzG,IAAI,OAAO,OAAO,CAAC,eAAe,KAAO,QAAQ;YAAK,EAAE,CAAC,GAAG,CAAC,wBAAwB,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;QAChH,IAAI,OAAO,OAAO,CAAC,WAAW,KAAW,QAAQ;YAAK,EAAE,CAAC,GAAG,CAAC,gBAAgB,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;QACpG,IAAI,OAAO,OAAO,CAAC,MAAM,KAAgB,QAAQ;YAAK,EAAE,CAAC,GAAG,CAAC,mBAAmB,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QAClG,IAAI,OAAO,OAAO,CAAC,eAAe,KAAO,QAAQ;YAAK,EAAE,CAAC,GAAG,CAAC,2BAA2B,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;QACnH,IAAI,OAAO,OAAO,CAAC,SAAS,KAAa,QAAQ;YAAK,EAAE,CAAC,GAAG,CAAC,cAAc,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;QAChG,IAAI,OAAO,OAAO,CAAC,SAAS,KAAa,QAAQ;YAAK,EAAE,CAAC,GAAG,CAAC,oBAAoB,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;QACtG,IAAI,OAAO,OAAO,CAAC,WAAW,KAAW,QAAQ;YAAK,EAAE,CAAC,GAAG,CAAC,sBAAsB,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;QAC1G,IAAI,OAAO,OAAO,CAAC,eAAe,KAAO,QAAQ;YAAK,EAAE,CAAC,GAAG,CAAC,qBAAqB,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;QAC7G,IAAI,OAAO,OAAO,CAAC,eAAe,KAAO,QAAQ;YAAK,EAAE,CAAC,GAAG,CAAC,2BAA2B,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;QACnH,IAAI,OAAO,OAAO,CAAC,iBAAiB,KAAK,QAAQ;YAAK,EAAE,CAAC,GAAG,CAAC,6BAA6B,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC;QACvH,IAAI,OAAO,OAAO,CAAC,MAAM,KAAgB,QAAQ;YAAK,EAAE,CAAC,GAAG,CAAC,gBAAgB,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QAC/F,IAAI,OAAO,OAAO,CAAC,IAAI,KAAkB,WAAW;YAAE,EAAE,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;QACnF,IAAI,OAAO,OAAO,CAAC,KAAK,KAAiB,QAAQ;YAAK,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;QACrF,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAA+B,uBAAuB,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAC3G,OAAO,GAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,qBAAW,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,IAAI,CAAC,EAAU,EAAE,EAAW;QACjC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;QACrD,MAAM,EAAE,GAAG,IAAI,oBAAU,EAAE;aACzB,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5B,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAiB,UAAU,EAAE,aAAa,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC;QAChG,OAAO,GAAI,CAAC;IACb,CAAC;CACD;AAhQD,wBAgQC"}
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
import type E621 from "..";
|
|
2
|
+
import type { UserFeedbackProperties, SearchUserFeedbackOptions, CreateUserFeedbackOptions, ModifyUserFeedbackOptions } from "../types";
|
|
3
|
+
export default class UserFeedback {
|
|
4
|
+
private readonly auth;
|
|
5
|
+
private readonly main;
|
|
6
|
+
constructor(main: E621);
|
|
7
|
+
/**
|
|
8
|
+
* Get a specific user feedback
|
|
9
|
+
*
|
|
10
|
+
* @param {number} id - The id of the feedback to fetch
|
|
11
|
+
* @returns {Promise<(UserFeedbackProperties | null)>}
|
|
12
|
+
*/
|
|
13
|
+
get(id: number): Promise<UserFeedbackProperties | null>;
|
|
14
|
+
/**
|
|
15
|
+
* Search for user feedback
|
|
16
|
+
*
|
|
17
|
+
* @param {object} [options]
|
|
18
|
+
* @param {string} [options.username] - narrow the search by a specific target
|
|
19
|
+
* @param {string} [options.creator] - narrow the search by a specific creator
|
|
20
|
+
* @param {string} [options.body] - narrow the search by the content of the feedback
|
|
21
|
+
* @param {FeedbackCategories} [options.category] - narrow the search by the type
|
|
22
|
+
* @param {(number |`${"" | "a" | "b"}${number}`)} - page of results to get
|
|
23
|
+
* @param {number} [options.limit] - limit the maximum returned results
|
|
24
|
+
* @returns {Promise<Array<UserFeedbackProperties>>}
|
|
25
|
+
*/
|
|
26
|
+
search(options?: SearchUserFeedbackOptions): Promise<UserFeedbackProperties[]>;
|
|
27
|
+
/**
|
|
28
|
+
* Add feedback to a user
|
|
29
|
+
*
|
|
30
|
+
* * Requires Authentication
|
|
31
|
+
*
|
|
32
|
+
* * Requires Moderator
|
|
33
|
+
*
|
|
34
|
+
* @param {object} options
|
|
35
|
+
* @param {string} options.username - the user the feedback is for
|
|
36
|
+
* @param {FeedbackCategories} options.category - the type of feedback
|
|
37
|
+
* @param {string} options.body - the content of the feedback
|
|
38
|
+
* @returns {Promise<UserFeedbackProperties>}
|
|
39
|
+
*/
|
|
40
|
+
create(options: CreateUserFeedbackOptions): Promise<UserFeedbackProperties>;
|
|
41
|
+
/**
|
|
42
|
+
* Modify an existing user feedback
|
|
43
|
+
*
|
|
44
|
+
* * Requires Authentication
|
|
45
|
+
*
|
|
46
|
+
* * Requires Moderator
|
|
47
|
+
*
|
|
48
|
+
* @param {number} id - the id of the feedback to edit
|
|
49
|
+
* @param {object} options
|
|
50
|
+
* @param {string} [options.body] - the content of the feedback
|
|
51
|
+
* @param {FeedbackCategories} [options.category] - the type of feedback
|
|
52
|
+
* @returns {Promise<UserFeedbackProperties>}
|
|
53
|
+
*/
|
|
54
|
+
modify(id: number, options: ModifyUserFeedbackOptions): Promise<UserFeedbackProperties>;
|
|
55
|
+
/**
|
|
56
|
+
* Delete an existing user feedback
|
|
57
|
+
*
|
|
58
|
+
* * Requires Authentication
|
|
59
|
+
*
|
|
60
|
+
* * Requires Moderator
|
|
61
|
+
*
|
|
62
|
+
* @param {number} id - the id of the feedback to delete
|
|
63
|
+
* @returns {Promise<null>}
|
|
64
|
+
*/
|
|
65
|
+
delete(id: number): Promise<null>;
|
|
66
|
+
}
|