Skip to content

✨ Support External links at /api/pages/:project/:title #98

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 24, 2022
Merged

✨ Support External links at /api/pages/:project/:title #98

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 29 additions & 5 deletions rest/pages.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import type {
ErrorLike,
NotFoundError,
NotLoggedInError,
NotMemberError,
Expand All @@ -12,18 +13,32 @@ import { BaseOptions, Result, setDefaults } from "./util.ts";

/** Options for `getPage()` */
export interface GetPageOption extends BaseOptions {
/** use `followRename` */ followRename?: boolean;
/** use `followRename` */
followRename?: boolean;

/** project ids to get External links */
projects?: string[];
}

export interface TooLongURIError extends ErrorLike {
name: "TooLongURIError";
}

const getPage_toRequest: GetPage["toRequest"] = (
project,
title,
options,
) => {
const { sid, hostName, followRename } = setDefaults(options ?? {});
const { sid, hostName, followRename, projects } = setDefaults(options ?? {});
const params = new URLSearchParams();
params.append("followRename", `${followRename ?? true}`);
for (const id of projects ?? []) {
params.append("projects", id);
}
const path = `https://${hostName}/api/pages/${project}/${
encodeTitleURI(title)
}?followRename=${followRename ?? true}`;
}?${params.toString()}`;

return new Request(
path,
sid ? { headers: { Cookie: cookie(sid) } } : undefined,
Expand All @@ -32,6 +47,15 @@ const getPage_toRequest: GetPage["toRequest"] = (

const getPage_fromResponse: GetPage["fromResponse"] = async (res) => {
if (!res.ok) {
if (res.status === 414) {
return {
ok: false,
value: {
name: "TooLongURIError",
message: "project ids may be too much.",
},
};
}
return makeError<NotFoundError | NotLoggedInError | NotMemberError>(res);
}
const value = (await res.json()) as Page;
Expand Down Expand Up @@ -60,14 +84,14 @@ export interface GetPage {
fromResponse: (res: Response) => Promise<
Result<
Page,
NotFoundError | NotLoggedInError | NotMemberError
NotFoundError | NotLoggedInError | NotMemberError | TooLongURIError
>
>;

(project: string, title: string, options?: GetPageOption): Promise<
Result<
Page,
NotFoundError | NotLoggedInError | NotMemberError
NotFoundError | NotLoggedInError | NotMemberError | TooLongURIError
>
>;
}
Expand Down