@orion-js/paginated-mongodb 3.11.8 → 4.0.0-alpha.2

package/dist/index.d.ts

@@ -0,0 +1,132 @@
+// Generated by dts-bundle-generator v9.5.1
+
+// Generated by dts-bundle-generator v9.5.1
+// Generated by dts-bundle-generator v9.5.1
+export interface StoredCacheData {
+	value: any;
+	expires?: Date;
+}
+export interface SetCacheOptions {
+	ttl?: number;
+}
+export interface GetCacheOptions {
+	ttl?: number;
+	fallback?(): Promise<any>;
+}
+export interface OrionCache {
+	/**
+	 * Save data in the cache
+	 */
+	set(key: string, value: any, options?: SetCacheOptions): Promise<void> | void;
+	/**
+	 * Get data from the cache
+	 */
+	get(key: string, options?: GetCacheOptions): Promise<StoredCacheData>;
+	/**
+	 * Removes data from the cache
+	 */
+	invalidate(key: string): Promise<void> | void;
+}
+export type Blackbox = {
+	[name: string]: any;
+};
+export type GlobalCheckPermissions = (params: any, viewer: any, info?: any) => Promise<string | void>;
+export type ModelCheckPermissions = (parent: any, params: any, viewer: any, info?: any) => Promise<string | void>;
+export type GlobalGetCacheKey = (params: any, viewer: any, info: any) => Promise<any>;
+export type ModelGetCacheKey = (parent: any, params: any, viewer: any, info: any) => Promise<any>;
+export interface ExecuteOptions {
+	params: Blackbox;
+	viewer: any;
+	parent?: any;
+	info?: any;
+	options: ResolverOptions;
+}
+export type Parameters$1<T> = T extends (...args: infer P) => any ? P : never;
+export type ReturnType$1<T> = T extends (...args: any) => infer R ? R : any;
+export type ResolverParams<Resolve, IsModel> = IsModel extends undefined ? Parameters$1<Resolve>[0] : Parameters$1<Resolve>[1];
+export interface ExecuteParams<Resolve = Function, IsModel = undefined> {
+	params?: ResolverParams<Resolve, IsModel>;
+	viewer?: any;
+	parent?: IsModel extends undefined ? undefined : Parameters$1<Resolve>[0];
+	info?: any;
+}
+export type Execute<Resolve = Function, IsModel = undefined> = (executeOptions: ExecuteParams<Resolve, IsModel>) => ReturnType$1<Resolve>;
+export interface SharedResolverOptions {
+	resolverId?: string;
+	params?: any;
+	returns?: any;
+	mutation?: boolean;
+	private?: boolean;
+	checkPermission?: GlobalCheckPermissions | ModelCheckPermissions;
+	getCacheKey?: GlobalGetCacheKey | ModelGetCacheKey;
+	cache?: number;
+	cacheProvider?: OrionCache;
+	permissionsOptions?: any;
+	middlewares?: ResolverMiddleware[];
+}
+export interface ResolverOptions<Resolve = Function> extends SharedResolverOptions {
+	resolve: Resolve;
+}
+export type OmitFirstArg<F> = F extends (x: any, ...args: infer P) => infer R ? (...args: P) => R : never;
+export interface Resolver<Resolve = Function, IsModel = undefined> extends SharedResolverOptions {
+	execute: Execute<Resolve, IsModel>;
+	resolve: Resolve;
+	modelResolve: IsModel extends undefined ? undefined : OmitFirstArg<Resolve>;
+}
+export type ResolverMiddleware = (executeOptions: ExecuteOptions, next: () => Promise<any>) => Promise<any>;
+export interface PaginatedCursor {
+	count?: () => Promise<number> | number;
+	toArray: () => Promise<any[]>;
+	limit?: (newLimit: number) => void;
+	skip?: (newSkip: number) => void;
+	sort?: (newSort: {
+		[key: string]: 1 | -1;
+	}) => void;
+}
+export type PaginatedResolverGetCursorResultWithCount = {
+	count: () => Promise<number> | number;
+	cursor: PaginatedCursor;
+};
+export type PaginatedResolverGetCursorResult = PaginatedCursor | PaginatedResolverGetCursorResultWithCount;
+export interface PaginatedResolverOpts {
+	returns: any;
+	getCursor: (params?: any, viewer?: any) => Promise<PaginatedResolverGetCursorResult>;
+	allowedSorts?: string[];
+	defaultSortBy?: string;
+	defaultSortType?: "asc" | "desc";
+	params?: any;
+	modelName?: string;
+	permissionsOptions?: any;
+}
+export function paginatedResolver({ returns, params, allowedSorts, defaultSortBy, defaultSortType, getCursor, getCursorAndCount, modelName, ...otherOptions }: PaginatedResolverOpts & {
+	[key: string]: any;
+}): Resolver<(params: any, viewer: any, info?: any) => Promise<{
+	cursor: PaginatedCursor;
+	params: any;
+	viewer: any;
+	options: {
+		skip: number;
+		limit: any;
+	};
+	count: number;
+}>, undefined>;
+declare function _default({ collection, params, resolve, ...otherOptions }: {
+	[x: string]: any;
+	collection: any;
+	params: any;
+	resolve: any;
+}): Resolver<(params: any, viewer: any, info?: any) => Promise<{
+	params: any;
+	cursor: any;
+	viewer: any;
+}>, undefined>;
+export interface PagiantedQueryDescriptor extends Omit<PropertyDecorator, "value"> {
+	value?: PaginatedResolverOpts["getCursor"];
+}
+export declare function PaginatedQuery(options: Omit<PaginatedResolverOpts, "getCursor">): (target: any, propertyKey: string, descriptor: PagiantedQueryDescriptor) => void;
+
+export {
+	_default as tokenPaginatedResolver,
+};
+
+export {};