Installation

npm install --save @types/keystonejs__app-admin-ui

Summary

This package contains type definitions for @keystonejs/app-admin-ui (https://github.com/keystonejs/keystone).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/keystonejs__app-admin-ui.

index.d.ts

// Type definitions for @keystonejs/app-admin-ui 5.9
// Project: https://github.com/keystonejs/keystone
// Definitions by: Kevin Brown <https://github.com/thekevinbrown>
//                 Timothee Clain <https://github.com/tclain>
//                 Abhijith Vijayan <https://github.com/abhijithvijayan>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 3.5

// Because this is a scoped package, without this line Typescript doesn't associate the
// types with the right package.
// tslint:disable-next-line:no-single-declare-module
declare module '@keystonejs/app-admin-ui' {
    import { BaseAuthStrategy, BaseApp, Keystone } from '@keystonejs/keystone';

    interface AdminUIOptions<ListNames extends string = string, UserType extends {} = any> {
        name?: string | undefined;
        adminPath?: string | undefined;
        apiPath?: string | undefined;
        graphiqlPath?: string | undefined;
        authStrategy?: BaseAuthStrategy | null | undefined;
        hooks?: string | undefined;
        enableDefaultRoute?: boolean | undefined;
        schemaName?: string | undefined;
        isAccessAllowed?: ((opts: {
            authentication: { item: UserType; listKey: ListNames };
        }) => boolean) | undefined;
        adminMeta?: any;
        defaultPageSize?: number | undefined;
        maximumPageSize?: number | undefined;
    }

    interface PrepareMiddlewareOptions {
        keystone: Keystone;
        dev: boolean;
        distDir?: any; // TODO: this field is required if dev is false => thus not optional (investigate)
    }

    class AdminUIApp<ListNames extends string = string, UserType extends {} = any> extends BaseApp {
        constructor(options?: AdminUIOptions<ListNames, UserType>);

        prepareMiddleware(options: PrepareMiddlewareOptions): any; // TODO: returns Router
    }
}

Additional Details

• Last updated: Thu, 08 Jul 2021 16:23:12 GMT
• Dependencies: @types/keystonejs__keystone
• Global values: none

Credits

These definitions were written by Kevin Brown, Timothee Clain, and Abhijith Vijayan.