wabe 0.5.3 → 0.5.5

package/README.md

@@ -1,5 +1,5 @@
 <p align="center">
-  <a href="https://wabe.dev"><img src="https://www.wabe.dev/logo.png" alt="Wabe logo" height=170></a>
+  <a href="https://wabe.dev"><img src="https://www.wabe.dev/logo.webp" alt="Wabe logo" height=170></a>
 </p>
 <h1 align="center">Wabe</h1>
 
@@ -9,7 +9,7 @@
 
 ## What is Wabe?
 
-Wabe is an open-source backend that allows you to create your own fully customizable backend in just a few minutes. It handles database access, automatic GraphQL API generation, authentication with various methods (classic or OAuth), permissions, security, and more for you.
+Wabe is an open-source backend that allows you to create your own fully customizable backend in just a few minutes. It handles database access, automatic GraphQL API generation, authentication with various methods (classic or OAuth), permissions, security, payment, emails, and more for you.
 
 ## Install
 
@@ -52,6 +52,8 @@ await run();
 - **Database**: A powerful, scalable database to store and manage you data.
 - **GraphQL API**: A flexible and powerful GraphQL API (following GraphQL Relay standard) to interact with your data.
 - **Hooks**: Powerful hooks system to execute custom actions before or after database requests.
+- **Email**: Send emails with your favorite provider with very simple integration.
+- **Payment**: Accept payments with Stripe or create your own payment provider adapter.
 
 ## Contributing
 

package/dist/index.d.ts

@@ -60,7 +60,8 @@ export type Scalars = {
 	};
 };
 declare enum AuthenticationProvider {
-	Google = "Google"
+	Google = "google",
+	EmailPassword = "emailPassword"
 }
 declare enum SecondaryFactor {
 	EmailOtp = "EmailOTP"
@@ -250,6 +251,34 @@ export type PaymentAclObjectRolesAcl = {
 	read: Scalars["Boolean"]["output"];
 	write: Scalars["Boolean"]["output"];
 };
+export type _InternalConfig = {
+	__typename?: "_InternalConfig";
+	id: Scalars["ID"]["output"];
+	configKey: Scalars["String"]["output"];
+	configValue: Scalars["String"]["output"];
+	description?: Maybe<Scalars["String"]["output"]>;
+	acl?: Maybe<_InternalConfigAclObject>;
+	createdAt?: Maybe<Scalars["Date"]["output"]>;
+	updatedAt?: Maybe<Scalars["Date"]["output"]>;
+	search?: Maybe<Array<Maybe<Scalars["String"]["output"]>>>;
+};
+export type _InternalConfigAclObject = {
+	__typename?: "_InternalConfigACLObject";
+	users?: Maybe<Array<Maybe<_InternalConfigAclObjectUsersAcl>>>;
+	roles?: Maybe<Array<Maybe<_InternalConfigAclObjectRolesAcl>>>;
+};
+export type _InternalConfigAclObjectUsersAcl = {
+	__typename?: "_InternalConfigACLObjectUsersACL";
+	userId: Scalars["String"]["output"];
+	read: Scalars["Boolean"]["output"];
+	write: Scalars["Boolean"]["output"];
+};
+export type _InternalConfigAclObjectRolesAcl = {
+	__typename?: "_InternalConfigACLObjectRolesACL";
+	roleId: Scalars["String"]["output"];
+	read: Scalars["Boolean"]["output"];
+	write: Scalars["Boolean"]["output"];
+};
 export type SignInWithInput = {
 	authentication?: InputMaybe<SignInWithAuthenticationInput>;
 };
@@ -298,11 +327,12 @@ export type WabeSchemaTypes = {
 	_Session: _Session;
 	Role: Role;
 	Payment: Payment;
+	_InternalConfig: _InternalConfig;
 };
 export interface WabeContext<T extends WabeTypes> {
 	response?: WobeResponse;
 	user?: User | null;
-	sessionId?: string;
+	sessionId?: string | null;
 	isRoot: boolean;
 	wabe: Wabe<T>;
 }
@@ -328,7 +358,7 @@ export interface AdapterOptions {
 	databaseUrl: string;
 	databaseName: string;
 }
-export type MutationData<T extends keyof WabeTypes["types"]> = Record<keyof WabeTypes["types"][T], any>;
+export type MutationData<T extends keyof WabeTypes["types"], K extends keyof WabeTypes["types"][T]> = Record<K, any>;
 export interface CountOptions<T extends keyof WabeTypes["types"], K extends keyof WabeTypes["types"][T]> {
 	className: T;
 	where?: WhereType<T, K>;
@@ -354,13 +384,13 @@ export interface GetObjectsOptions<T extends keyof WabeTypes["types"], K extends
 }
 export interface CreateObjectOptions<T extends keyof WabeTypes["types"], K extends keyof WabeTypes["types"][T], W extends keyof WabeTypes["types"][T]> {
 	className: T;
-	data: MutationData<W>;
+	data: MutationData<T, W>;
 	fields: Array<K | "*">;
 	context: WabeContext<any>;
 }
 export interface CreateObjectsOptions<T extends keyof WabeTypes["types"], K extends keyof WabeTypes["types"][T], W extends keyof WabeTypes["types"][T], X extends keyof WabeTypes["types"][T]> {
 	className: T;
-	data: Array<MutationData<W>>;
+	data: Array<MutationData<T, W>>;
 	fields: Array<K | "*">;
 	offset?: number;
 	first?: number;
@@ -371,7 +401,7 @@ export interface UpdateObjectOptions<T extends keyof WabeTypes["types"], K exten
 	className: T;
 	id: string;
 	where?: WhereType<T, W>;
-	data: MutationData<W>;
+	data: MutationData<T, W>;
 	fields: Array<K | "*">;
 	context: WabeContext<any>;
 }
@@ -379,7 +409,7 @@ export interface UpdateObjectsOptions<T extends keyof WabeTypes["types"], K exte
 	className: T;
 	where: WhereType<T, W>;
 	order?: OrderType<T, X>;
-	data: MutationData<W>;
+	data: MutationData<T, W>;
 	fields: Array<K | "*">;
 	offset?: number;
 	first?: number;
@@ -500,9 +530,9 @@ export declare class DatabaseController<T extends WabeTypes> {
 	getObject<U extends keyof T["types"], K extends keyof T["types"][U]>({ fields, className, context, skipHooks, id, where, }: GetObjectOptions<U, K>): Promise<OutputType<U, K>>;
 	getObjects<U extends keyof T["types"], K extends keyof T["types"][U], W extends keyof T["types"][U], X extends keyof T["types"][U]>({ className, fields, context, where, skipHooks, first, offset, order, }: GetObjectsOptions<U, K, W, X>): Promise<OutputType<U, K>[]>;
 	createObject<U extends keyof T["types"], K extends keyof T["types"][U], W extends keyof T["types"][U]>({ className, context, data, fields }: CreateObjectOptions<U, K, W>): Promise<OutputType<U, K>>;
-	createObjects<U extends keyof T["types"], K extends keyof T["types"][U], W extends keyof T["types"][U], X extends keyof T["types"][U]>({ data, fields, className, context, first, offset, order, }: CreateObjectsOptions<U, K, W, X>): Promise<OutputType<U, K>[]>;
+	createObjects<U extends keyof T["types"], K extends keyof T["types"][U], W extends keyof T["types"][U], X extends keyof T["types"][U]>({ data, fields, className, context, first, offset, order, }: CreateObjectsOptions<U, K, W, X>): Promise<OutputType<any, K>[]>;
 	updateObject<U extends keyof T["types"], K extends keyof T["types"][U], W extends keyof T["types"][U]>({ id, className, context, data, fields }: UpdateObjectOptions<U, K, W>): Promise<OutputType<keyof T["types"], K>>;
-	updateObjects<U extends keyof T["types"], K extends keyof T["types"][U], W extends keyof T["types"][U], X extends keyof T["types"][U]>({ className, where, context, fields, data, first, offset, order, }: UpdateObjectsOptions<U, K, W, X>): Promise<OutputType<U, K>[]>;
+	updateObjects<U extends keyof T["types"], K extends keyof T["types"][U], W extends keyof T["types"][U], X extends keyof T["types"][U]>({ className, where, context, fields, data, first, offset, order, }: UpdateObjectsOptions<U, K, W, X>): Promise<OutputType<any, K>[]>;
 	deleteObject<U extends keyof T["types"], K extends keyof T["types"][U], W extends keyof T["types"][U]>({ context, className, id, fields }: DeleteObjectOptions<U, K, W>): Promise<OutputType<U, K>>;
 	deleteObjects<U extends keyof T["types"], K extends keyof T["types"][U], W extends keyof T["types"][U], X extends keyof T["types"][U]>({ className, context, fields, where, first, offset, order, }: DeleteObjectsOptions<U, K, W, X>): Promise<OutputType<U, K>[]>;
 }
@@ -514,6 +544,75 @@ export interface DatabaseConfig {
 	url: string;
 	name: string;
 }
+export declare enum OperationType {
+	AfterCreate = "afterCreate",
+	AfterUpdate = "afterUpdate",
+	AfterDelete = "afterDelete",
+	AfterRead = "afterRead",
+	BeforeCreate = "beforeCreate",
+	BeforeUpdate = "beforeUpdate",
+	BeforeDelete = "beforeDelete",
+	BeforeRead = "beforeRead"
+}
+export type Hook<T extends WabeTypes, K extends keyof WabeTypes["types"]> = {
+	operationType: OperationType;
+	className?: K;
+	priority: number;
+	callback: (hookObject: HookObject<T, K>) => Promise<void> | void;
+};
+export declare const _findHooksByPriority: <T extends unknown>({ className, operationType, priority, config, }: {
+	operationType: OperationType;
+	className: T;
+	priority: number;
+	config: WabeConfig<any>;
+}) => Promise<Hook<any, any>[]>;
+export declare const initializeHook: <T extends unknown>({ className, newData, context, }: {
+	className: T;
+	newData?: MutationData<any, any> | undefined;
+	context: WabeContext<any>;
+}) => {
+	runOnSingleObject: ({ operationType, id, object: inputObject, }: {
+		operationType: OperationType;
+		id?: string | undefined;
+		object?: OutputType<any, any> | undefined;
+	}) => Promise<{
+		object: undefined;
+		newData: {};
+	} | {
+		object: OutputType<any, any>;
+		newData: MutationData<T, keyof WabeSchemaTypes[T]>;
+	}>;
+	runOnMultipleObjects: ({ operationType, where, objects: inputObjects, }: {
+		operationType: OperationType;
+		where?: WhereType<any, any> | undefined;
+		objects?: OutputType<any, any>[] | undefined;
+	}) => Promise<{
+		objects: never[];
+		newData: MutationData<any, any>[];
+	} | {
+		objects: OutputType<any, any>[];
+		newData: Awaited<MutationData<T, keyof WabeSchemaTypes[T]>>[];
+	}>;
+};
+export declare const getDefaultHooks: () => Hook<any, any>[];
+declare class HookObject<T extends WabeTypes, K extends keyof WabeTypes["types"]> {
+	className: K;
+	private newData;
+	private operationType;
+	context: WabeContext<T>;
+	object: Partial<Record<keyof T["types"][K], any>>;
+	constructor({ newData, className, operationType, context, object, }: {
+		className: K;
+		newData?: MutationData<K, keyof T["types"][K]>;
+		operationType: OperationType;
+		context: WabeContext<T>;
+		object: Partial<Record<keyof T["types"][K], any>>;
+	});
+	getUser(): User | null | undefined;
+	isFieldUpdate(field: keyof T["types"][K]): boolean | undefined;
+	upsertNewData(field: keyof T["types"][K], value: any): void;
+	getNewData(): MutationData<K, keyof T["types"][K]>;
+}
 export type WabePrimaryTypes = "String" | "Int" | "Float" | "Boolean" | "Email" | "Date" | "File";
 export type WabeCustomTypes = "Array" | "Object";
 export type WabeRelationTypes = "Pointer" | "Relation";
@@ -623,7 +722,34 @@ export interface PermissionProperties {
 	 */
 	authorizedRoles?: Array<string>;
 }
-export type ClassPermissions = Partial<Record<PermissionsOperations, PermissionProperties>>;
+/**
+ * ACL properties
+ * Automatically create ACL object before insert of the object in the database
+ * Allow you to specify which user can read or write the object
+ * You can specify "self" to allow only the user that created the object to read or write it
+ * You can specify "all" to allow all users to read or write the object
+ * For some custom use cases, you can specify a callback function that will be called before
+ * inserting the object in the database.
+ * Authorized roles is more restristive that at the class level. You can have a role access on all the class
+ * except one object.
+ * If the array of authorized users is empty, no user is authorized
+ * If the array of authorized users is undefined, everyone is authorized
+ */
+export type ACLProperties = {
+	authorizedUsers: {
+		read: Array<"self">;
+		write: Array<"self">;
+	};
+	authorizedRoles: {
+		read: Array<string>;
+		write: Array<string>;
+	};
+} | {
+	callback?: (hookObject: HookObject<any, any>) => void | Promise<void>;
+};
+export type ClassPermissions = Partial<Record<PermissionsOperations, PermissionProperties> & {
+	acl: ACLProperties;
+}>;
 export type SearchableFields = Array<string>;
 export type ClassIndexes = Array<{
 	field: string;
@@ -666,6 +792,7 @@ export declare class Schema<T extends WabeTypes> {
 	sessionClass(): ClassInterface<T>;
 	paymentClass(): ClassInterface<T>;
 	roleClass(): ClassInterface<T>;
+	internalConfigClass(): ClassInterface<T>;
 	userClass(): ClassInterface<T>;
 	defaultFields(): SchemaFields<T>;
 	mergeClass(newClass: ClassInterface<T>[]): ClassInterface<T>[];
@@ -683,6 +810,9 @@ export type AuthenticationEventsOptions<T> = {
 	input: T;
 	context: WabeContext<any>;
 };
+export type AuthenticationEventsOptionsWithUserId<T> = AuthenticationEventsOptions<T> & {
+	userId: string;
+};
 export type ProviderInterface<T = any> = {
 	onSignIn: (options: AuthenticationEventsOptions<T>) => Promise<{
 		user: Partial<User>;
@@ -696,6 +826,9 @@ export type ProviderInterface<T = any> = {
 	onSignUp: (options: AuthenticationEventsOptions<T>) => Promise<{
 		authenticationDataToSave: any;
 	}>;
+	onUpdateAuthenticationData?: (options: AuthenticationEventsOptionsWithUserId<T>) => Promise<{
+		authenticationDataToSave: any;
+	}>;
 };
 export type SecondaryProviderInterface<T = any> = {
 	onSendChallenge: () => Promise<void>;
@@ -742,80 +875,14 @@ export interface Provider {
 	refreshToken(options: refreshTokenOptions): Promise<void>;
 }
 declare enum AuthenticationProvider$1 {
-	Google = "Google"
+	Google = "google",
+	EmailPassword = "emailPassword"
 }
 export interface WabeRoute {
 	method: "GET" | "POST" | "PUT" | "DELETE";
 	path: string;
 	handler: WobeHandler<WobeCustomContext<any>>;
 }
-declare class HookObject<T extends WabeTypes, K = keyof T["types"]> {
-	className: string;
-	private newData;
-	private operationType;
-	context: WabeContext<T>;
-	object: Record<keyof WabeTypes["types"][T], any>;
-	constructor({ newData, className, operationType, context, object, }: {
-		className: K;
-		newData?: MutationData<T>;
-		operationType: OperationType;
-		context: WabeContext<T>;
-		object: Record<keyof WabeTypes["types"][T], any>;
-	});
-	getUser(): User | null | undefined;
-	isFieldUpdate(field: keyof WabeTypes["types"][T]): boolean | undefined;
-	upsertNewData(field: keyof WabeTypes["types"][T], value: any): void;
-	getNewData(): MutationData<T>;
-}
-export declare enum OperationType {
-	AfterCreate = "AfterCreate",
-	AfterUpdate = "afterUpdate",
-	AfterDelete = "afterDelete",
-	AfterRead = "afterRead",
-	BeforeCreate = "beforeInsert",
-	BeforeUpdate = "beforeUpdate",
-	BeforeDelete = "beforeDelete",
-	BeforeRead = "beforeRead"
-}
-export type Hook<T extends WabeTypes> = {
-	operationType: OperationType;
-	className?: T;
-	priority: number;
-	callback: (hookObject: HookObject<T>) => Promise<void> | void;
-};
-export type TypedNewData<T extends keyof WabeTypes["types"]> = Record<keyof WabeTypes["types"][T], any>;
-export declare const _findHooksByPriority: <T extends unknown>({ className, operationType, priority, config, }: {
-	operationType: OperationType;
-	className: T;
-	priority: number;
-	config: WabeConfig<any>;
-}) => Promise<Hook<any>[]>;
-export declare const initializeHook: <T extends unknown>({ className, newData, context, }: {
-	className: T;
-	newData?: TypedNewData<any> | undefined;
-	context: WabeContext<any>;
-}) => {
-	runOnSingleObject: ({ operationType, id, object: inputObject, }: {
-		operationType: OperationType;
-		id?: string | undefined;
-		object?: OutputType<any, any> | undefined;
-	}) => Promise<{
-		object: undefined;
-		newData: {};
-	} | {
-		object: OutputType<any, any>;
-		newData: MutationData<any>;
-	}>;
-	runOnMultipleObjects: ({ operationType, where, objects: inputObjects, }: {
-		operationType: OperationType;
-		where?: WhereType<any, any> | undefined;
-		objects?: OutputType<any, any>[] | undefined;
-	}) => Promise<{
-		objects: OutputType<any, any>[];
-		newData: MutationData<any>[];
-	}>;
-};
-export declare const getDefaultHooks: () => Hook<any>[];
 export type DevWabeTypes = {
 	types: WabeSchemaTypes;
 	scalars: WabeSchemaScalars;
@@ -838,6 +905,7 @@ export type WabeFileAdapter = (file: File) => Promise<string>;
 export interface FileConfig {
 	adapter: WabeFileAdapter;
 }
+export type Templates = "sendOTPCode";
 export interface EmailSendOptions {
 	from: string;
 	to: Array<string>;
@@ -854,8 +922,19 @@ export interface EmailAdapter {
 	 */
 	send(options: EmailSendOptions): Promise<string>;
 }
+/**
+ * Configuration for the email in Wabe
+ * @property adapter The adapter to use to send emails
+ * @property mainEmail The email to use as sender for emails sent by Wabe
+ * @property templates The html templates to use for a specific email. If not provided, Wabe will use the default templates
+ */
 export interface EmailConfig {
 	adapter: EmailAdapter;
+	mainEmail?: string;
+	htmlTemplates?: Record<Templates, (payload: any) => string>;
+}
+export declare class EmailDevAdapter implements EmailAdapter {
+	send(): Promise<string>;
 }
 declare class EmailController implements EmailAdapter {
 	adapter: EmailAdapter;
@@ -1062,7 +1141,7 @@ export interface WabeConfig<T extends WabeTypes> {
 	authentication?: AuthenticationConfig<T>;
 	routes?: WabeRoute[];
 	rootKey: string;
-	hooks?: Hook<any>[];
+	hooks?: Hook<T, any>[];
 	email?: EmailConfig;
 	payment?: PaymentConfig;
 	file?: FileConfig;