@devvit/public-api 0.12.7-next-2025-12-15-19-45-46-32dc9a0b3.0 → 0.12.7-next-2025-12-15-19-58-48-962aee65f.0
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/apis/reddit/models/Listing.d.ts +4 -0
- package/apis/reddit/models/Listing.d.ts.map +1 -1
- package/apis/reddit/models/WikiPage.d.ts +2 -8
- package/apis/reddit/models/WikiPage.d.ts.map +1 -1
- package/apis/reddit/models/WikiPage.js +24 -1
- package/meta.min.json +5 -5
- package/package.json +8 -8
- package/public-api.min.js +5 -5
- package/public-api.min.js.map +3 -3
|
@@ -5,9 +5,13 @@ export type MoreObject = {
|
|
|
5
5
|
depth: number;
|
|
6
6
|
};
|
|
7
7
|
export type ListingFetchOptions = {
|
|
8
|
+
/** The ID of the object to start at. */
|
|
8
9
|
after?: string;
|
|
10
|
+
/** The ID of the object to end at. */
|
|
9
11
|
before?: string;
|
|
12
|
+
/** The maximum number of objects to get. */
|
|
10
13
|
limit?: number;
|
|
14
|
+
/** The number of objects to get per request. */
|
|
11
15
|
pageSize?: number;
|
|
12
16
|
more?: MoreObject;
|
|
13
17
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Listing.d.ts","sourceRoot":"","sources":["../../../../src/apis/reddit/models/Listing.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAGxD,MAAM,MAAM,UAAU,GAAG;IACvB,QAAQ,EAAE,IAAI,GAAG,IAAI,CAAC;IACtB,QAAQ,EAAE,IAAI,EAAE,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,UAAU,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,oBAAoB,CAAC,CAAC,IAAI;IACpC,QAAQ,EAAE,CAAC,EAAE,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,UAAU,CAAC;CACnB,CAAC;AAEF,MAAM,WAAW,OAAO,CAAC,CAAC;CAKzB;AAgBD,qBAAa,OAAO,CAAC,CAAC;;IAMpB,QAAQ,EAAE,MAAM,CAAqB;IACrC,KAAK,EAAE,MAAM,CAAiB;IAC9B,QAAQ,EAAE,CAAC,EAAE,CAAM;IAoBnB,IAAI,OAAO,IAAI,OAAO,CAErB;IAEM,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,aAAa,CAAC,CAAC,CAAC;IAyBjD,OAAO,CAAC,IAAI,EAAE,UAAU,GAAG,SAAS,GAAG,IAAI;IAI3C,mBAAmB,IAAI,IAAI;IA0BrB,GAAG,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC;IAQnB,GAAG,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;CASvC"}
|
|
1
|
+
{"version":3,"file":"Listing.d.ts","sourceRoot":"","sources":["../../../../src/apis/reddit/models/Listing.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAGxD,MAAM,MAAM,UAAU,GAAG;IACvB,QAAQ,EAAE,IAAI,GAAG,IAAI,CAAC;IACtB,QAAQ,EAAE,IAAI,EAAE,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,wCAAwC;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,sCAAsC;IACtC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,4CAA4C;IAC5C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,gDAAgD;IAChD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,UAAU,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,oBAAoB,CAAC,CAAC,IAAI;IACpC,QAAQ,EAAE,CAAC,EAAE,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,UAAU,CAAC;CACnB,CAAC;AAEF,MAAM,WAAW,OAAO,CAAC,CAAC;CAKzB;AAgBD,qBAAa,OAAO,CAAC,CAAC;;IAMpB,QAAQ,EAAE,MAAM,CAAqB;IACrC,KAAK,EAAE,MAAM,CAAiB;IAC9B,QAAQ,EAAE,CAAC,EAAE,CAAM;IAoBnB,IAAI,OAAO,IAAI,OAAO,CAErB;IAEM,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,aAAa,CAAC,CAAC,CAAC;IAyBjD,OAAO,CAAC,IAAI,EAAE,UAAU,GAAG,SAAS,GAAG,IAAI;IAI3C,mBAAmB,IAAI,IAAI;IA0BrB,GAAG,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC;IAQnB,GAAG,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;CASvC"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { Metadata, WikiPageRevision as WikiPageRevisionProto, WikiPageSettings_Data } from '@devvit/protos';
|
|
2
|
-
import { Listing } from './Listing.js';
|
|
2
|
+
import { Listing, type ListingFetchOptions } from './Listing.js';
|
|
3
3
|
import { User } from './User.js';
|
|
4
4
|
export type CreateWikiPageOptions = {
|
|
5
5
|
/** The name of the subreddit to create the page in. */
|
|
@@ -21,17 +21,11 @@ export type UpdateWikiPageOptions = {
|
|
|
21
21
|
/** The reason for updating the page. */
|
|
22
22
|
reason?: string;
|
|
23
23
|
};
|
|
24
|
-
export type GetPageRevisionsOptions = {
|
|
24
|
+
export type GetPageRevisionsOptions = Omit<ListingFetchOptions, 'more'> & {
|
|
25
25
|
/** The name of the subreddit the page is in. */
|
|
26
26
|
subredditName: string;
|
|
27
27
|
/** The name of the page to get revisions for. */
|
|
28
28
|
page?: string;
|
|
29
|
-
/** The number of revisions to get per request. */
|
|
30
|
-
pageSize?: number;
|
|
31
|
-
/** The maximum number of revisions to get. */
|
|
32
|
-
limit?: number;
|
|
33
|
-
/** The ID of the revision to start at. */
|
|
34
|
-
after?: string;
|
|
35
29
|
};
|
|
36
30
|
export declare enum WikiPagePermissionLevel {
|
|
37
31
|
/** Use subreddit wiki permissions */
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"WikiPage.d.ts","sourceRoot":"","sources":["../../../../src/apis/reddit/models/WikiPage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,QAAQ,EAER,gBAAgB,IAAI,qBAAqB,EAEzC,qBAAqB,EACtB,MAAM,gBAAgB,CAAC;AAKxB,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;
|
|
1
|
+
{"version":3,"file":"WikiPage.d.ts","sourceRoot":"","sources":["../../../../src/apis/reddit/models/WikiPage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,QAAQ,EAER,gBAAgB,IAAI,qBAAqB,EAEzC,qBAAqB,EACtB,MAAM,gBAAgB,CAAC;AAKxB,OAAO,EAAE,OAAO,EAAE,KAAK,mBAAmB,EAAE,MAAM,cAAc,CAAC;AACjE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC,MAAM,MAAM,qBAAqB,GAAG;IAClC,uDAAuD;IACvD,aAAa,EAAE,MAAM,CAAC;IACtB,sCAAsC;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,+BAA+B;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,wCAAwC;IACxC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,gDAAgD;IAChD,aAAa,EAAE,MAAM,CAAC;IACtB,sCAAsC;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,mCAAmC;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,wCAAwC;IACxC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG,IAAI,CAAC,mBAAmB,EAAE,MAAM,CAAC,GAAG;IACxE,gDAAgD;IAChD,aAAa,EAAE,MAAM,CAAC;IACtB,iDAAiD;IACjD,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,oBAAY,uBAAuB;IACjC,qCAAqC;IACrC,qBAAqB,IAAI;IACzB,6DAA6D;IAC7D,0BAA0B,IAAI;IAC9B,kCAAkC;IAClC,SAAS,IAAI;CACd;AAED,MAAM,MAAM,yBAAyB,GAAG;IACtC,gDAAgD;IAChD,aAAa,EAAE,MAAM,CAAC;IACtB,mDAAmD;IACnD,IAAI,EAAE,MAAM,CAAC;IACb,2DAA2D;IAC3D,MAAM,EAAE,OAAO,CAAC;IAChB,yCAAyC;IACzC,SAAS,EAAE,uBAAuB,CAAC;CACpC,CAAC;AAEF,mCAAmC;AACnC,MAAM,MAAM,kBAAkB,GAAG,GAAG,MAAM,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM,EAAE,CAAC;AAWrF,qBAAa,QAAQ;;IAqCnB,4BAA4B;IAC5B,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,gDAAgD;IAChD,IAAI,aAAa,IAAI,MAAM,CAE1B;IAED,wCAAwC;IACxC,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED,oCAAoC;IACpC,IAAI,WAAW,IAAI,MAAM,CAExB;IAED,8BAA8B;IAC9B,IAAI,UAAU,IAAI,kBAAkB,CAEnC;IAED,gCAAgC;IAChC,IAAI,YAAY,IAAI,IAAI,CAEvB;IAED,mCAAmC;IACnC,IAAI,cAAc,IAAI,MAAM,CAE3B;IAED,mCAAmC;IACnC,IAAI,cAAc,IAAI,IAAI,GAAG,SAAS,CAErC;IAED,MAAM,IAAI,IAAI,CACZ,QAAQ,EACN,MAAM,GACN,eAAe,GACf,SAAS,GACT,aAAa,GACb,YAAY,GACZ,cAAc,GACd,gBAAgB,CACnB,GAAG;QACF,cAAc,EAAE,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,GAAG,SAAS,CAAC;KACxD;IAaD,wBAAwB;IAClB,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAYjE,uCAAuC;IACjC,YAAY,CAChB,OAAO,EAAE,IAAI,CAAC,uBAAuB,EAAE,eAAe,GAAG,MAAM,CAAC,GAC/D,OAAO,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAWrC,+CAA+C;IACzC,QAAQ,CAAC,UAAU,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAI7D,sCAAsC;IAChC,WAAW,IAAI,OAAO,CAAC,gBAAgB,CAAC;IAI9C,yCAAyC;IACnC,cAAc,CAClB,OAAO,EAAE,IAAI,CAAC,yBAAyB,EAAE,eAAe,GAAG,MAAM,CAAC,GACjE,OAAO,CAAC,gBAAgB,CAAC;IAY5B,kCAAkC;IAC5B,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIhD,uCAAuC;IACjC,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CA+LpD;AAED,qBAAa,gBAAgB;;gBAQf,IAAI,EAAE,qBAAqB,EAAE,QAAQ,EAAE,QAAQ,GAAG,SAAS;IAYvE,IAAI,EAAE,IAAI,kBAAkB,CAE3B;IAED,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,IAAI,IAAI,IAAI,IAAI,CAEf;IAED,IAAI,MAAM,IAAI,IAAI,CAEjB;IAED,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED,MAAM,IAAI,IAAI,CAAC,gBAAgB,EAAE,IAAI,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC,GAAG;QAC/E,MAAM,EAAE,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;KACpC;CAUF;AAED,qBAAa,gBAAgB;;gBAKf,IAAI,EAAE,qBAAqB,EAAE,QAAQ,EAAE,QAAQ,GAAG,SAAS;IASvE,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED,IAAI,SAAS,IAAI,uBAAuB,CAEvC;IAED,IAAI,OAAO,IAAI,IAAI,EAAE,CAEpB;IAED,MAAM,IAAI,IAAI,CAAC,gBAAgB,EAAE,QAAQ,GAAG,WAAW,CAAC,GAAG;QACzD,OAAO,EAAE,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;KACvC;CAOF"}
|
|
@@ -24,6 +24,14 @@ export var WikiPagePermissionLevel;
|
|
|
24
24
|
/** Only mods may edit and view */
|
|
25
25
|
WikiPagePermissionLevel[WikiPagePermissionLevel["MODS_ONLY"] = 2] = "MODS_ONLY";
|
|
26
26
|
})(WikiPagePermissionLevel || (WikiPagePermissionLevel = {}));
|
|
27
|
+
/**
|
|
28
|
+
* Listing endpoints expect the fullname of an object for the `before` and `after` parameters. Usually
|
|
29
|
+
* this is a `tX_` ID, but the fullname of a wiki page revision is its ID prefixed with `WikiPageRevision_`.
|
|
30
|
+
*
|
|
31
|
+
* Also, when fetching a listing of wiki page revisions, the `after` and `before` values returned
|
|
32
|
+
* by the API are already prefixed. However, the IDs in the revisions themselves are not prefixed.
|
|
33
|
+
*/
|
|
34
|
+
const WikiPageRevisionPrefix = 'WikiPageRevision_';
|
|
27
35
|
export class WikiPage {
|
|
28
36
|
/**
|
|
29
37
|
* @internal
|
|
@@ -172,9 +180,12 @@ export class WikiPage {
|
|
|
172
180
|
/** @internal */
|
|
173
181
|
static getPageRevisions(options, metadata) {
|
|
174
182
|
const client = Devvit.redditAPIPlugins.Wiki;
|
|
183
|
+
const after = ensureWikiRevisionCursor(options.after);
|
|
184
|
+
const before = ensureWikiRevisionCursor(options.before);
|
|
175
185
|
return new Listing({
|
|
176
186
|
hasMore: true,
|
|
177
|
-
after:
|
|
187
|
+
after: after,
|
|
188
|
+
before: before,
|
|
178
189
|
limit: options.limit,
|
|
179
190
|
pageSize: options.pageSize,
|
|
180
191
|
async fetch(fetchOptions) {
|
|
@@ -329,3 +340,15 @@ function wikiPageRevisionListingProtoToWikiPageRevision(listingProto, metadata)
|
|
|
329
340
|
after: listingProto.data.after,
|
|
330
341
|
};
|
|
331
342
|
}
|
|
343
|
+
/**
|
|
344
|
+
* When fetching a listing of wiki page revisions, the `after` and `before` values returned
|
|
345
|
+
* by the API are already prefixed. However, the IDs in the revisions themselves are not prefixed.
|
|
346
|
+
*
|
|
347
|
+
* This function ensures that developers can pass either the raw ID (from `WikiPageRevision.id`) or
|
|
348
|
+
* the prefixed ID (from `Listing.after` / `Listing.before`) to listing methods.
|
|
349
|
+
*/
|
|
350
|
+
function ensureWikiRevisionCursor(token) {
|
|
351
|
+
if (!token)
|
|
352
|
+
return undefined;
|
|
353
|
+
return token.startsWith(WikiPageRevisionPrefix) ? token : `${WikiPageRevisionPrefix}${token}`;
|
|
354
|
+
}
|
package/meta.min.json
CHANGED
|
@@ -1912,7 +1912,7 @@
|
|
|
1912
1912
|
"format": "esm"
|
|
1913
1913
|
},
|
|
1914
1914
|
"src/apis/reddit/models/Listing.ts": {
|
|
1915
|
-
"bytes":
|
|
1915
|
+
"bytes": 3481,
|
|
1916
1916
|
"imports": [
|
|
1917
1917
|
{
|
|
1918
1918
|
"path": "src/apis/reddit/helpers/makeGettersEnumerable.ts",
|
|
@@ -2445,7 +2445,7 @@
|
|
|
2445
2445
|
"format": "esm"
|
|
2446
2446
|
},
|
|
2447
2447
|
"src/apis/reddit/models/WikiPage.ts": {
|
|
2448
|
-
"bytes":
|
|
2448
|
+
"bytes": 14687,
|
|
2449
2449
|
"imports": [
|
|
2450
2450
|
{
|
|
2451
2451
|
"path": "../shared-types/dist/NonNull.js",
|
|
@@ -2710,7 +2710,7 @@
|
|
|
2710
2710
|
"imports": [],
|
|
2711
2711
|
"exports": [],
|
|
2712
2712
|
"inputs": {},
|
|
2713
|
-
"bytes":
|
|
2713
|
+
"bytes": 1106820
|
|
2714
2714
|
},
|
|
2715
2715
|
"dist/public-api.min.js": {
|
|
2716
2716
|
"imports": [
|
|
@@ -3297,7 +3297,7 @@
|
|
|
3297
3297
|
"bytesInOutput": 8483
|
|
3298
3298
|
},
|
|
3299
3299
|
"src/apis/reddit/models/WikiPage.ts": {
|
|
3300
|
-
"bytesInOutput":
|
|
3300
|
+
"bytesInOutput": 4994
|
|
3301
3301
|
},
|
|
3302
3302
|
"../shared-types/dist/sanitizeSvg.js": {
|
|
3303
3303
|
"bytesInOutput": 1351
|
|
@@ -3318,7 +3318,7 @@
|
|
|
3318
3318
|
"bytesInOutput": 357
|
|
3319
3319
|
}
|
|
3320
3320
|
},
|
|
3321
|
-
"bytes":
|
|
3321
|
+
"bytes": 227567
|
|
3322
3322
|
}
|
|
3323
3323
|
}
|
|
3324
3324
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@devvit/public-api",
|
|
3
|
-
"version": "0.12.7-next-2025-12-15-19-
|
|
3
|
+
"version": "0.12.7-next-2025-12-15-19-58-48-962aee65f.0",
|
|
4
4
|
"license": "BSD-3-Clause",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -36,18 +36,18 @@
|
|
|
36
36
|
},
|
|
37
37
|
"types": "./dist/index.d.ts",
|
|
38
38
|
"dependencies": {
|
|
39
|
-
"@devvit/metrics": "0.12.7-next-2025-12-15-19-
|
|
40
|
-
"@devvit/protos": "0.12.7-next-2025-12-15-19-
|
|
41
|
-
"@devvit/shared": "0.12.7-next-2025-12-15-19-
|
|
42
|
-
"@devvit/shared-types": "0.12.7-next-2025-12-15-19-
|
|
39
|
+
"@devvit/metrics": "0.12.7-next-2025-12-15-19-58-48-962aee65f.0",
|
|
40
|
+
"@devvit/protos": "0.12.7-next-2025-12-15-19-58-48-962aee65f.0",
|
|
41
|
+
"@devvit/shared": "0.12.7-next-2025-12-15-19-58-48-962aee65f.0",
|
|
42
|
+
"@devvit/shared-types": "0.12.7-next-2025-12-15-19-58-48-962aee65f.0",
|
|
43
43
|
"base64-js": "1.5.1",
|
|
44
44
|
"clone-deep": "4.0.1",
|
|
45
45
|
"moderndash": "4.0.0"
|
|
46
46
|
},
|
|
47
47
|
"devDependencies": {
|
|
48
48
|
"@ampproject/filesize": "4.3.0",
|
|
49
|
-
"@devvit/repo-tools": "0.12.7-next-2025-12-15-19-
|
|
50
|
-
"@devvit/tsconfig": "0.12.7-next-2025-12-15-19-
|
|
49
|
+
"@devvit/repo-tools": "0.12.7-next-2025-12-15-19-58-48-962aee65f.0",
|
|
50
|
+
"@devvit/tsconfig": "0.12.7-next-2025-12-15-19-58-48-962aee65f.0",
|
|
51
51
|
"@reddit/faceplate-ui": "18.0.5",
|
|
52
52
|
"@types/clone-deep": "4.0.1",
|
|
53
53
|
"chokidar-cli": "3.0.0",
|
|
@@ -63,5 +63,5 @@
|
|
|
63
63
|
}
|
|
64
64
|
},
|
|
65
65
|
"source": "./src/index.ts",
|
|
66
|
-
"gitHead": "
|
|
66
|
+
"gitHead": "3968ffc8d7003356991b19483847bcec69d87b51"
|
|
67
67
|
}
|