import { GristLoadConfig } from 'app/common/gristUrls'; import { FullUser, UserProfile } from 'app/common/UserAPI'; import { Document } from 'app/gen-server/entity/Document'; import { Organization } from 'app/gen-server/entity/Organization'; import { Workspace } from 'app/gen-server/entity/Workspace'; import { HomeDBManager } from 'app/gen-server/lib/HomeDBManager'; import { RequestWithLogin } from 'app/server/lib/Authorizer'; import * as Comm from 'app/server/lib/Comm'; import { Hosts } from 'app/server/lib/extractOrg'; import { ICreate } from 'app/server/lib/ICreate'; import { IDocStorageManager } from 'app/server/lib/IDocStorageManager'; import { INotifier } from 'app/server/lib/INotifier'; import { IPermitStore } from 'app/server/lib/Permit'; import { ISendAppPageOptions } from 'app/server/lib/sendAppPage'; import { fromCallback } from 'app/server/lib/serverUtils'; import { Sessions } from 'app/server/lib/Sessions'; import * as express from 'express'; /** * Basic information about a Grist server. Accessible in many * contexts, including request handlers and ActiveDoc methods. */ export interface GristServer { readonly create: ICreate; settings?: Readonly>; getHost(): string; getHomeUrl(req: express.Request, relPath?: string): string; getHomeUrlByDocId(docId: string, relPath?: string): Promise; getOwnUrl(): string; getOrgUrl(orgKey: string|number): Promise; getMergedOrgUrl(req: RequestWithLogin, pathname?: string): string; getResourceUrl(resource: Organization|Workspace|Document): Promise; getGristConfig(): GristLoadConfig; getPermitStore(): IPermitStore; getExternalPermitStore(): IPermitStore; getSessions(): Sessions; getComm(): Comm; getHosts(): Hosts; getHomeDBManager(): HomeDBManager; getStorageManager(): IDocStorageManager; getNotifier(): INotifier; getDocTemplate(): Promise; getTag(): string; sendAppPage(req: express.Request, resp: express.Response, options: ISendAppPageOptions): Promise; } export interface GristLoginSystem { getMiddleware(gristServer: GristServer): Promise; deleteUser(user: FullUser): Promise; } export interface GristLoginMiddleware { getLoginRedirectUrl(req: express.Request, target: URL): Promise; getSignUpRedirectUrl(req: express.Request, target: URL): Promise; getLogoutRedirectUrl(req: express.Request, nextUrl: URL): Promise; // Optional middleware for the GET /login, /signup, and /signin routes. getLoginOrSignUpMiddleware?(): express.RequestHandler[]; // Optional middleware for the GET /logout route. getLogoutMiddleware?(): express.RequestHandler[]; // Returns arbitrary string for log. addEndpoints(app: express.Express): Promise; } /** * Set the user in the current session. */ export async function setUserInSession(req: express.Request, gristServer: GristServer, profile: UserProfile) { const scopedSession = gristServer.getSessions().getOrCreateSessionFromRequest(req); // Make sure session is up to date before operating on it. // Behavior on a completely fresh session is a little awkward currently. const reqSession = (req as any).session; if (reqSession?.save) { await fromCallback(cb => reqSession.save(cb)); } await scopedSession.updateUserProfile(req, profile); } export interface RequestWithGrist extends express.Request { gristServer?: GristServer; } export interface DocTemplate { page: string, tag: string, }