index.d.ts

// Copied over from @types/oauth-shim and extended to reflect the changes in this fork

import * as express from "express";

export = oauthShim;

declare const oauthShim: oauthShim.Handler;

declare namespace oauthShim {
	interface Handler extends express.RequestHandler {
		interpret: express.RequestHandler;
		proxy: express.RequestHandler;
		redirect: express.RequestHandler;
		unhandled: express.RequestHandler;

		credentials: {
			get(query: any, cb: (success: false | object) => void): void;
		};

		init(configs: Config[]): void;
	}

	interface Request extends express.Request {
		oauthshim?: {
			options?: {
				[key: string]: any;
				path?: string;
			};
			redirect?: string;
			data?: {
				[key: string]: any;
				access_token?: string;
			};
		};
	}

	interface Config {
		client_id: string;
		client_secret: string;
		grant_url: string;
		domain: string;
	}

	// Extra definitions added in this fork
	interface SecretsStorage {
		get(key: string): Promise<string | undefined>;
		set(key: string, value: string): Promise<void>;
	}

	interface Handler {
		useSecretsStorage(storage: SecretsStorage): void;
	}
}