@orion-js/components 3.11.9 → 4.0.0-alpha.2

package/dist/index.d.ts

@@ -0,0 +1,358 @@
+// Generated by dts-bundle-generator v9.5.1
+
+import express from 'express';
+import { EachMessagePayload } from 'kafkajs';
+
+export type EchoesController = {
+	new (...args: any[]): any;
+};
+export type ResolversController = {
+	new (...args: any[]): any;
+};
+export type SubscriptionsController = {
+	new (...args: any[]): any;
+};
+export type JobsController = {
+	new (...args: any[]): any;
+};
+export type RoutesController = {
+	new (...args: any[]): any;
+};
+export type ModelResolversController = {
+	new (...args: any[]): any;
+};
+export interface ComponentControllers {
+	echoes?: EchoesController[];
+	routes?: RoutesController[];
+	jobs?: JobsController[];
+	resolvers?: ResolversController[];
+	subscriptions?: SubscriptionsController[];
+	modelResolvers?: ModelResolversController[];
+}
+export interface Component {
+	controllers: ComponentControllers;
+}
+export declare function component(controllers: ComponentControllers): Component;
+export interface EchoConfig {
+	type: "event" | "request";
+	resolve(params: any, context?: any): Promise<any>;
+	attemptsBeforeDeadLetter?: number;
+}
+export interface EchoType extends EchoConfig {
+	onMessage(messageData: EachMessagePayload): Promise<void>;
+	onRequest(serializedParams: string): any;
+}
+export interface EchoesMap {
+	[key: string]: EchoType;
+}
+export interface OrionSubscription<TParams = any, ReturnType = any> {
+	name: string;
+	params: object;
+	subscribe: (callParams: object, viewer: object) => {};
+	returns: ReturnType;
+	publish: (params: TParams, data: ReturnType) => Promise<void>;
+}
+export interface OrionSubscriptionsMap {
+	[key: string]: OrionSubscription;
+}
+export interface StoredCacheData$1 {
+	value: any;
+	expires?: Date;
+}
+export interface SetCacheOptions$1 {
+	ttl?: number;
+}
+export interface GetCacheOptions$1 {
+	ttl?: number;
+	fallback?(): Promise<any>;
+}
+export interface OrionCache$1 {
+	/**
+	 * Save data in the cache
+	 */
+	set(key: string, value: any, options?: SetCacheOptions$1): Promise<void> | void;
+	/**
+	 * Get data from the cache
+	 */
+	get(key: string, options?: GetCacheOptions$1): Promise<StoredCacheData$1>;
+	/**
+	 * Removes data from the cache
+	 */
+	invalidate(key: string): Promise<void> | void;
+}
+export type Blackbox$1 = {
+	[name: string]: any;
+};
+export type ModelResolverResolve$1 = (item: any, params: any, viewer: any, info?: any) => Promise<any>;
+export type GlobalCheckPermissions$1 = (params: any, viewer: any, info?: any) => Promise<string | void>;
+export type ModelCheckPermissions$1 = (parent: any, params: any, viewer: any, info?: any) => Promise<string | void>;
+export type GlobalGetCacheKey$1 = (params: any, viewer: any, info: any) => Promise<any>;
+export type ModelGetCacheKey$1 = (parent: any, params: any, viewer: any, info: any) => Promise<any>;
+export interface ExecuteOptions$1 {
+	params: Blackbox$1;
+	viewer: any;
+	parent?: any;
+	info?: any;
+	options: ResolverOptions$1;
+}
+export type Parameters$1$1<T> = T extends (...args: infer P) => any ? P : never;
+export type ReturnType$1$1<T> = T extends (...args: any) => infer R ? R : any;
+export type ResolverParams$1<Resolve, IsModel> = IsModel extends undefined ? Parameters$1$1<Resolve>[0] : Parameters$1$1<Resolve>[1];
+export interface ExecuteParams$1<Resolve = Function, IsModel = undefined> {
+	params?: ResolverParams$1<Resolve, IsModel>;
+	viewer?: any;
+	parent?: IsModel extends undefined ? undefined : Parameters$1$1<Resolve>[0];
+	info?: any;
+}
+export type Execute$1<Resolve = Function, IsModel = undefined> = (executeOptions: ExecuteParams$1<Resolve, IsModel>) => ReturnType$1$1<Resolve>;
+export interface SharedResolverOptions$1 {
+	resolverId?: string;
+	params?: any;
+	returns?: any;
+	mutation?: boolean;
+	private?: boolean;
+	checkPermission?: GlobalCheckPermissions$1 | ModelCheckPermissions$1;
+	getCacheKey?: GlobalGetCacheKey$1 | ModelGetCacheKey$1;
+	cache?: number;
+	cacheProvider?: OrionCache$1;
+	permissionsOptions?: any;
+	middlewares?: ResolverMiddleware$1[];
+}
+export interface ResolverOptions$1<Resolve = Function> extends SharedResolverOptions$1 {
+	resolve: Resolve;
+}
+export type OmitFirstArg$1<F> = F extends (x: any, ...args: infer P) => infer R ? (...args: P) => R : never;
+export interface Resolver$1<Resolve = Function, IsModel = undefined> extends SharedResolverOptions$1 {
+	execute: Execute$1<Resolve, IsModel>;
+	resolve: Resolve;
+	modelResolve: IsModel extends undefined ? undefined : OmitFirstArg$1<Resolve>;
+}
+export type ModelResolver$1<Resolve = Function> = Resolver$1<Resolve, true>;
+export type ResolverMiddleware$1 = (executeOptions: ExecuteOptions$1, next: () => Promise<any>) => Promise<any>;
+export interface ModelResolversMap {
+	[key: string]: ModelResolver$1<ModelResolverResolve$1>;
+}
+export interface ModelsResolversMap {
+	[key: string]: ModelResolversMap;
+}
+export interface RouteResponseObject {
+	statusCode?: number;
+	headers?: {
+		[key: string]: string;
+	};
+	body: string | object;
+}
+export type RouteResponse = Promise<RouteResponseObject | void>;
+export type RouteResolve = (req: express.Request, res: express.Response, viewer: any) => RouteResponse;
+export interface OrionRouteOptions {
+	/**
+	 * The http method of the requests to match.
+	 */
+	method: "get" | "post" | "put" | "delete" | "all";
+	/**
+	 * The path of the requests to match.
+	 */
+	path: string;
+	/**
+	 * Select the body parser to use for this route.
+	 */
+	bodyParser?: "json" | "text" | "urlencoded";
+	/**
+	 * Selected body parser options.
+	 */
+	bodyParserOptions?: bodyParser.OptionsJson | bodyParser.OptionsText | bodyParser.OptionsUrlencoded;
+	/**
+	 * Add a middleware to the route.
+	 * See https://expressjs.com/en/4x/api.html#middleware
+	 * for more information.
+	 */
+	middlewares?: Array<express.RequestHandler>;
+	resolve: RouteResolve;
+	/**
+	 * Pass another express app
+	 */
+	app?: express.Application;
+}
+export interface RouteType extends OrionRouteOptions {
+}
+export interface RoutesMap {
+	[key: string]: RouteType;
+}
+export type Blackbox = {
+	[name: string]: any;
+};
+export type LogFunction = (message: string, metadata?: any) => void;
+export interface OrionLogger {
+	debug: LogFunction;
+	info: LogFunction;
+	warn: LogFunction;
+	error: LogFunction;
+	addContext: (module: NodeJS.Module) => OrionLogger;
+	addMetadata: (metadata: any) => OrionLogger;
+}
+export interface JobToRun {
+	jobId: string;
+	executionId: string;
+	name: string;
+	type: "event" | "recurrent";
+	params: Blackbox;
+	tries: number;
+	lockTime: number;
+	priority: number;
+	uniqueIdentifier?: string;
+}
+export interface ExecutionContext {
+	record: JobToRun;
+	definition: JobDefinition;
+	tries: number;
+	logger: OrionLogger;
+	extendLockTime: (extraTime: number) => Promise<void>;
+	clearStaleTimeout: () => void;
+}
+export interface JobRetryResultBase {
+	action: "retry" | "dismiss";
+}
+export type JobRetryResultRunIn = JobRetryResultBase & {
+	runIn: number;
+};
+export type JobRetryResultRunAt = JobRetryResultBase & {
+	runAt: Date;
+};
+export type JobRetryResult = JobRetryResultRunIn | JobRetryResultRunAt | JobRetryResultBase;
+export interface BaseJobDefinition {
+	/**
+	 * The function to execute when the job is executed.
+	 */
+	resolve: (params: Blackbox, context: ExecutionContext) => Promise<Blackbox | void>;
+	/**
+	 * Called if the job fails.
+	 */
+	onError?: (error: Error, params: Blackbox, context: ExecutionContext) => Promise<JobRetryResult>;
+	/**
+	 * Called if the job locktime is expired. The job will be executed again.
+	 */
+	onStale?: (params: Blackbox, context: ExecutionContext) => Promise<void>;
+	/**
+	 * Save the executions of the job time in milliseconds. Default is 1 week. Set to 0 to disable.
+	 */
+	saveExecutionsFor?: number;
+}
+export interface RecurrentJobDefinition extends BaseJobDefinition {
+	/**
+	 * Type of the job.
+	 */
+	type: "recurrent";
+	/**
+	 * A function executed after each execution that returns the date of the next run.
+	 */
+	getNextRun?: () => Date;
+	/**
+	 * Run every x milliseconds. This will be ignored if getNextRun is defined.
+	 */
+	runEvery?: number;
+	/**
+	 * The priority of the job. Higher is more priority. Default is 100.
+	 */
+	priority?: number;
+}
+export interface EventJobDefinition extends BaseJobDefinition {
+	/**
+	 * Type of the job.
+	 */
+	type: "event";
+}
+export type JobDefinition = RecurrentJobDefinition | EventJobDefinition;
+export interface JobsDefinition {
+	[jobName: string]: JobDefinition;
+}
+// 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;
+}
+type Blackbox$1 = {
+	[name: string]: any;
+};
+export type GlobalResolverResolve = (params: any, viewer: any, info?: any) => Promise<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$1;
+	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 GlobalResolversMap {
+	[key: string]: Resolver<GlobalResolverResolve>;
+}
+export interface MergedComponentControllers {
+	echoes: EchoesMap;
+	resolvers: GlobalResolversMap;
+	modelResolvers: ModelsResolversMap;
+	subscriptions: OrionSubscriptionsMap;
+	routes: RoutesMap;
+	jobs: JobsDefinition;
+}
+export declare function mergeComponentControllers(component: Component): MergedComponentControllers;
+export declare function mergeComponents(components: Component[]): MergedComponentControllers;
+
+export {};