firstly 0.0.4 → 0.0.6

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # firstly
 
+## 0.0.6
+
+### Patch Changes
+
+- [#23](https://github.com/jycouet/firstly/pull/23)
+  [`c188eb3`](https://github.com/jycouet/firstly/commit/c188eb3d81a9e75b246387512621b5213bbe8dbd)
+  Thanks [@jycouet](https://github.com/jycouet)! - fix auth & mail (logs & co)
+
+## 0.0.5
+
+### Patch Changes
+
+- [#20](https://github.com/jycouet/firstly/pull/20)
+  [`5b365a4`](https://github.com/jycouet/firstly/commit/5b365a474619f611b0eb0bfe38bbbb262acb3a7e)
+  Thanks [@jycouet](https://github.com/jycouet)! - [BREAKING] Renaming almost all exports! (Some
+  `FF_` and `ff_` only when direct collision with other packages)
+
+- [#20](https://github.com/jycouet/firstly/pull/20)
+  [`b1ea110`](https://github.com/jycouet/firstly/commit/b1ea1101c45c137e477a937a8c6d130b346b2bb9)
+  Thanks [@jycouet](https://github.com/jycouet)! - tweak cli, update github auth
+
 ## 0.0.4
 
 ### Patch Changes

package/esm/{KitBaseEnum.d.ts → BaseEnum.d.ts}

@@ -1,25 +1,36 @@
 import { type IdFilter } from 'remult';
-import type { ClassType, FindOptionsBase } from 'remult';
-export type KitIcon = {
+import type { FindOptionsBase, Repository } from 'remult';
+export type FF_Icon = {
     data?: string | string[];
     size?: string | number;
     class?: string | string[];
     style?: string | string[];
     caption?: string;
 };
-export type KitBaseEnumOptions<Entity = any> = {
+export type BaseItem = BaseEnumOptions & {
+    id: string;
+    captionSub?: string | (string | undefined)[];
+    href?: string;
+    repo?: Repository<any>;
+    sub?: {
+        captionPre?: string;
+        repo?: Repository<any>;
+        item?: any;
+    };
+};
+export type BaseEnumOptions<Entity = any> = {
     caption?: string;
-    icon?: KitIcon;
+    icon?: FF_Icon;
     where?: IdFilter<Entity> | FindOptionsBase<Entity>['where'];
     class?: string;
 };
-export declare class KitBaseEnum<Entity = any> {
+export declare class BaseEnum<Entity = any> {
     id: string;
     caption?: string;
-    icon?: KitIcon;
+    icon?: FF_Icon;
     where?: IdFilter<Entity> | FindOptionsBase<Entity>['where'];
     class?: string;
-    constructor(_id: string | number, options?: KitBaseEnumOptions<Entity>);
+    constructor(_id: string | number, options?: BaseEnumOptions<Entity>);
     getWhere: () => this | Entity[] | {
         $ne?: Entity | Entity[] | undefined;
         '!='?: Entity | Entity[] | undefined;
@@ -31,5 +42,3 @@ export declare class KitBaseEnum<Entity = any> {
         } ? number : string>;
     } | import("remult").EntityFilter<Entity> | NonNullable<Entity>;
 }
-export declare const getEnum: <T extends KitBaseEnum<any>>(baseEnum: ClassType<T>, id: string | undefined | null) => T | undefined;
-export declare const getEnums: <T extends KitBaseEnum<any>>(baseEnum: ClassType<T>) => T[];

package/esm/{KitBaseEnum.js → BaseEnum.js}

@@ -1,5 +1,5 @@
-import { getValueList } from 'remult';
-export class KitBaseEnum {
+import {} from 'remult';
+export class BaseEnum {
     id;
     caption;
     icon;
@@ -19,14 +19,3 @@ export class KitBaseEnum {
         return this.where ? this.where : this;
     };
 }
-export const getEnum = (baseEnum, id) => {
-    if (!id) {
-        return undefined;
-    }
-    // @ts-ignore
-    const found = getValueList(baseEnum).find((c) => c.id === id);
-    return found;
-};
-export const getEnums = (baseEnum) => {
-    return getValueList(baseEnum) || [];
-};

package/esm/{KitEntity.d.ts → FF_Entity.d.ts}

@@ -1,2 +1,2 @@
 import { type EntityOptions } from 'remult';
-export declare function KitEntity<entityType>(key: string, options: EntityOptions<entityType extends new (...args: any) => any ? InstanceType<entityType> : entityType>): (target: any, info?: import("remult/src/remult3/remult3").ClassDecoratorContextStub<entityType extends infer T ? T extends entityType ? T extends new (...args: any) => any ? T : never : never : never> | undefined) => any;
+export declare function FF_Entity<entityType>(key: string, options: EntityOptions<entityType extends new (...args: any) => any ? InstanceType<entityType> : entityType>): (target: any, info?: import("remult/src/remult3/remult3").ClassDecoratorContextStub<entityType extends infer T ? T extends entityType ? T extends new (...args: any) => any ? T : never : never : never> | undefined) => any;

package/esm/{KitEntity.js → FF_Entity.js}

@@ -1,14 +1,14 @@
 import { Entity } from 'remult';
-export function KitEntity(key, options) {
-    const toAllow = (permission) => {
-        if (permission) {
-            if (Array.isArray(permission)) {
-                return permission.map((p) => p.id);
-            }
-            return permission.id;
+const toAllow = (permission) => {
+    if (permission) {
+        if (Array.isArray(permission)) {
+            return permission.map((p) => p.id);
         }
-        return undefined;
-    };
+        return permission.id;
+    }
+    return undefined;
+};
+export function FF_Entity(key, options) {
     return Entity(key, {
         ...options,
         allowApiCrud: options.allowApiCrud ?? toAllow(options.permissionApiCrud),

package/esm/{KitFields.d.ts → FF_Fields.d.ts}

@@ -1,6 +1,5 @@
-import { type FieldOptions, type FieldValidator, type StringFieldOptions } from 'remult';
-export declare function addValidator(validators: FieldOptions['validate'], newValidator: FieldOptions['validate'], atStart?: boolean): FieldValidator<unknown, unknown> | FieldValidator<unknown, unknown>[] | undefined;
-export declare class KitFields {
+import { type FieldOptions, type StringFieldOptions } from 'remult';
+export declare class FF_Fields {
     static string<entityType = unknown, valueType = string>(o?: StringFieldOptions<entityType, valueType>): import("remult").ClassFieldDecorator<entityType, valueType | undefined>;
     static currency<entityType = unknown>(o?: FieldOptions<entityType, number>): import("remult").ClassFieldDecorator<entityType, number | undefined>;
     static dateOnly<entityType = any>(o?: FieldOptions<entityType, Date>): import("remult").ClassFieldDecorator<entityType, Date | undefined>;

package/esm/{KitFields.js → FF_Fields.js}

@@ -1,18 +1,21 @@
 import { Fields, Validators, } from 'remult';
 import { displayCurrency } from './formats';
-import { getEnums } from './KitBaseEnum';
+import { getEnums } from './helper';
 // Translate default messages
 // REMULT P3 JYC: I need to set this here the one of my app are not overwriting these...
 // It look like I have 2 remult loaded... But even trying to remove one, I still have the issue
 Validators.unique.defaultMessage = 'Existe déjà!';
 Validators.required.defaultMessage = 'Obligatoire!';
-export function addValidator(validators, newValidator, atStart = false) {
-    if (!newValidator)
-        return validators;
-    const newValidators = Array.isArray(newValidator) ? newValidator : [newValidator];
-    const validatorsArray = Array.isArray(validators) ? validators : validators ? [validators] : [];
-    return atStart ? [...newValidators, ...validatorsArray] : [...validatorsArray, ...newValidators];
-}
+// export function addValidators(
+//   validators: FieldOptions['validate'],
+//   newValidator: FieldOptions['validate'],
+//   atStart = false,
+// ) {
+//   if (!newValidator) return validators
+//   const newValidators = Array.isArray(newValidator) ? newValidator : [newValidator]
+//   const validatorsArray = Array.isArray(validators) ? validators : validators ? [validators] : []
+//   return atStart ? [...newValidators, ...validatorsArray] : [...validatorsArray, ...newValidators]
+// }
 // REMULT P2: A/ Add in the doc that allowNull is false by default
 //            B/ Would be great to have a Validators.required automatically when allowNull is not true.
 //            C/ WARNING Validators.required is also checking for empty string
@@ -24,6 +27,7 @@ const validate_update_when_not_allow_null = (o) => {
         (o.allowNull === undefined || o.allowNull === false) &&
         // if require: false is explicitly set, then we don't need to add required validator
         o.required !== false) {
+        // addValidators(o.validate, [Validators.required], true)
         validate.push(Validators.required);
     }
     // let's add original validate if any
@@ -37,7 +41,7 @@ const validate_update_when_not_allow_null = (o) => {
     }
     return validate;
 };
-export class KitFields {
+export class FF_Fields {
     static string(o) {
         if (o === undefined) {
             o = {};

package/esm/ROUTES.d.ts

@@ -32,6 +32,7 @@ declare const AllObjs: {
         repo?: (string | number);
     }) => string;
     "/": string;
+    "/mail": string;
     "/remult": string;
     "/remult/auth": string;
     "/remult/enum": string;
@@ -40,7 +41,7 @@ declare const AllObjs: {
 };
 type AllTypes = typeof AllObjs;
 export type Routes = keyof AllTypes extends `${string}/${infer Route}` ? `/${Route}` : keyof AllTypes;
-export declare const routes: ("/" | "/remult" | "/remult/auth" | "/remult/enum" | "/remult/select" | "/ui" | "firstly_sign_in" | "remult_admin" | "github")[];
+export declare const routes: ("/" | "/mail" | "/remult" | "/remult/auth" | "/remult/enum" | "/remult/select" | "/ui" | "firstly_sign_in" | "remult_admin" | "github")[];
 /**
  * To be used like this:
  * ```ts
@@ -69,6 +70,7 @@ export declare function route<T extends NonFunctionKeys<AllTypes>>(key: T): stri
 export type KIT_ROUTES = {
     PAGES: {
         '/': never;
+        '/mail': never;
         '/remult': never;
         '/remult/auth': never;
         '/remult/enum': never;

package/esm/ROUTES.js

@@ -9,6 +9,7 @@
  */
 const PAGES = {
     "/": `/`,
+    "/mail": `/mail`,
     "/remult": `/remult`,
     "/remult/auth": `/remult/auth`,
     "/remult/enum": `/remult/enum`,
@@ -27,7 +28,7 @@ const ACTIONS = {};
  * LINKS
  */
 const LINKS = {
-    "firstly_sign_in": `/fly/auth/sign-in`,
+    "firstly_sign_in": `/ff/auth/sign-in`,
     "remult_admin": `/api/admin`,
     "github": (params) => {
         params = params ?? {};

package/esm/SqlDatabase/FF_LogToConsole.d.ts

@@ -0,0 +1 @@
+export declare const FF_LogToConsole: (duration: number, query: string, args: Record<string, any>, short?: boolean) => string | undefined;

package/esm/SqlDatabase/{LogToConsoleCustom.js → FF_LogToConsole.js}

@@ -16,7 +16,7 @@ const typeQuery = new Map([
 ]);
 const keys = ['FROM', 'WHERE', 'LIMIT', 'OFFSET'];
 const typeQueryKey = Array.from(typeQuery.keys());
-export const LogToConsoleCustom = (duration, query, args, short = true) => {
+export const FF_LogToConsole = (duration, query, args, short = true) => {
     const rawSql = query
         .replace(/(\r\n|\n|\r|\t)/gm, ' ')
         .replace(/  +/g, ' ')

package/esm/api/index.d.ts

@@ -1,3 +1,4 @@
+/// <reference types=".pnpm/@sveltejs+kit@2.5.24_@sveltejs+vite-plugin-svelte@3.1.1_svelte@4.2.18_vite@5.4.1_@types+node@_vtylvkjv5lewhfcl4vq2py4rce/node_modules/@sveltejs/kit" />
 import { type Handle, type MaybePromise, type RequestEvent } from '@sveltejs/kit';
 import { type ClassType } from 'remult';
 import type { RemultServerOptions } from 'remult/server';
@@ -25,7 +26,7 @@ export type Module = {
 };
 type Options = Omit<RemultServerOptions<RequestEvent<Partial<Record<string, string>>, string | null>> & {
     modules?: Module[] | undefined;
-    mail?: MailOptions;
+    mail?: MailOptions<any>;
 }, 'entities' | 'controllers' | 'initRequest' | 'initApi'>;
 /**
  * it's basically `remultSveltekit` with the `modules` option

package/esm/auth/AuthController.server.js

@@ -6,7 +6,7 @@ import { remult } from 'remult';
 import { green, yellow } from '@kitql/helpers';
 import { AUTH_OPTIONS, getSafeOptions, logAuth, lucia } from '.';
 import { sendMail } from '../mail';
-import { AuthProvider } from './Entities.js';
+import { FFAuthProvider } from './Entities.js';
 import { createSession } from './helper';
 import { mergeRoles } from './RoleHelpers';
 async function getArgon() {
@@ -93,8 +93,23 @@ export class AuthControllerServer {
                 await sendMail('invite', {
                     to: email,
                     subject: 'Invitation',
-                    text: `You were invited here: ${url}`,
-                    html: `You were invited <a href="${url}">here</a>`,
+                    templateProps: {
+                        title: 'Invitation 👋',
+                        previewText: 'This is the mail you were waiting for',
+                        sections: [
+                            {
+                                text: 'Today is your lucky day !',
+                                highlighted: true,
+                            },
+                            {
+                                text: 'You were invited to join the team',
+                                cta: {
+                                    text: 'JOIN',
+                                    link: url,
+                                },
+                            },
+                        ],
+                    },
                 });
                 logAuth.success(`Done with ${green('sendMail')} (${url})`);
                 return 'Demo Mail sent !';
@@ -124,7 +139,7 @@ export class AuthControllerServer {
         });
         const token = generateId(40);
         await remult.repo(oSafe.Account).insert({
-            provider: AuthProvider.PASSWORD.id,
+            provider: FFAuthProvider.PASSWORD.id,
             providerUserId: email,
             userId: user.id,
             hashPassword: await passwordHash(password),
@@ -138,7 +153,7 @@ export class AuthControllerServer {
             await createSession(user.id);
         }
         else {
-            const url = `${remult.context.url.origin}${oSafe.firstlyData.props.ui.providers.password.paths.verify_email}?token=${token}`;
+            const url = `${remult.context.url.origin}${oSafe.firstlyData.props.ui?.paths.verify_email}?token=${token}`;
             if (AUTH_OPTIONS.providers?.password?.verifyMailSend) {
                 await AUTH_OPTIONS.providers?.password.verifyMailSend({ email, url });
                 logAuth.success(`Done with custom ${green('verifyMailSend')} (${yellow(url)})`);
@@ -146,9 +161,20 @@ export class AuthControllerServer {
             else {
                 await sendMail('signUpPassword', {
                     to: email,
-                    subject: 'Wecome!',
-                    text: `You can validate your account here: ${url}`,
-                    html: `You can validate your account <a href="${url}">here</a>`,
+                    subject: 'Wecome',
+                    templateProps: {
+                        title: 'Wecome 👋',
+                        previewText: 'This is the mail you were waiting for',
+                        sections: [
+                            {
+                                text: 'You can validate your account',
+                                cta: {
+                                    text: 'HERE',
+                                    link: url,
+                                },
+                            },
+                        ],
+                    },
                 });
                 logAuth.success(`Done with ${green('sendMail')} (${url})`);
             }
@@ -167,7 +193,7 @@ export class AuthControllerServer {
         const existingUser = await remult
             .repo(oSafe.User)
             .findOne({ where: { name: email }, include: { accounts: true } });
-        const accountPassword = existingUser?.accounts.find((c) => c.provider === AuthProvider.PASSWORD.id);
+        const accountPassword = existingUser?.accounts.find((c) => c.provider === FFAuthProvider.PASSWORD.id);
         if (accountPassword && existingUser) {
             const validPassword = await passwordVerify(accountPassword?.hashPassword ?? '', password ?? '');
             if (validPassword) {
@@ -194,14 +220,14 @@ export class AuthControllerServer {
             if (!authAccount) {
                 authAccount = remult.repo(oSafe.Account).create();
                 authAccount.userId = u.id;
-                authAccount.provider = AuthProvider.PASSWORD.id;
+                authAccount.provider = FFAuthProvider.PASSWORD.id;
                 authAccount.providerUserId = email;
             }
             const token = generateId(40);
             authAccount.token = token;
             authAccount.expiresAt = createDate(new TimeSpan(AUTH_OPTIONS.providers?.password?.resetPasswordExpiresIn ?? 5 * 60, 's'));
             await remult.repo(oSafe.Account).save(authAccount);
-            const url = `${remult.context.url.origin}${oSafe.firstlyData.props.ui.providers.password.paths.reset_password}?token=${token}`;
+            const url = `${remult.context.url.origin}${oSafe.firstlyData.props.ui?.paths.reset_password}?token=${token}`;
             if (AUTH_OPTIONS.providers?.password?.resetPasswordSend) {
                 await AUTH_OPTIONS.providers?.password.resetPasswordSend({ email, url });
                 logAuth.success(`Done with custom ${green('resetPasswordSend')} (${yellow(url)})`);
@@ -211,8 +237,23 @@ export class AuthControllerServer {
                 await sendMail('forgotPassword', {
                     to: email,
                     subject: 'Reset your password',
-                    text: `You can reset your password here: ${url}`,
-                    html: `You can reset your password <a href="${url}">here</a>`,
+                    templateProps: {
+                        title: 'Reset your password 👋',
+                        previewText: 'This is the mail you were waiting for',
+                        sections: [
+                            {
+                                text: 'Did you forgot something ?',
+                                highlighted: true,
+                            },
+                            {
+                                text: 'No worries, you can reset your password',
+                                cta: {
+                                    text: 'HERE',
+                                    link: url,
+                                },
+                            },
+                        ],
+                    },
                 });
                 logAuth.success(`Done with ${green('sendMail')} (${url})`);
                 return 'Demo Mail sent !';
@@ -230,7 +271,7 @@ export class AuthControllerServer {
         }
         const account = await remult
             .repo(oSafe.Account)
-            .findFirst({ token, provider: AuthProvider.PASSWORD.id });
+            .findFirst({ token, provider: FFAuthProvider.PASSWORD.id });
         if (!account) {
             throw new Error('Invalid token');
         }
@@ -275,12 +316,12 @@ export class AuthControllerServer {
             user = await remult.repo(oSafe.User).save(user);
             let account = await remult
                 .repo(oSafe.Account)
-                .findFirst({ userId: user.id, provider: AuthProvider.OTP.id });
+                .findFirst({ userId: user.id, provider: FFAuthProvider.OTP.id });
             if (!account) {
                 account = remult.repo(oSafe.Account).create();
             }
             account.userId = user.id;
-            account.provider = AuthProvider.OTP.id;
+            account.provider = FFAuthProvider.OTP.id;
             account.token = otp;
             account.hashPassword = secretEncoded;
             await remult.repo(oSafe.Account).save(account);
@@ -299,7 +340,7 @@ export class AuthControllerServer {
     static async verifyOtp(email, otp) {
         const oSafe = getSafeOptions();
         const accounts = await remult.repo(oSafe.Account).find({
-            where: { token: String(otp), provider: AuthProvider.OTP.id },
+            where: { token: String(otp), provider: FFAuthProvider.OTP.id },
         });
         if (accounts.length === 0) {
             throw new Error('Invalid otp');
@@ -393,6 +434,6 @@ export class AuthControllerServer {
                 throw new Error(`${o.provider} not well configured!`);
             }
         }
-        throw new Error(`${o.provider} is not configured!`);
+        throw new Error(`${o.provider} is not configured! (Module: auth, section: providers.oAuths: [${o.provider}] missing)`);
     }
 }

package/esm/auth/Entities.d.ts

@@ -1,22 +1,23 @@
-import { KitBaseEnum } from '../';
-import type { KitBaseEnumOptions } from '../';
-export declare const KitAuthRole: {
-    readonly Admin: "KitAuthAdmin";
+import { BaseEnum } from '../';
+import type { BaseEnumOptions } from '../';
+export declare const FF_Auth_Role: {
+    readonly Admin: "FF_Auth_Role.Admin";
 };
-export declare class KitAuthUser {
+export declare class FFAuthUser {
     id: string;
     createdAt: Date;
     updatedAt?: Date;
     name: string;
     roles: string[];
-    accounts: KitAuthAccount[];
-    sessions: KitAuthUserSession[];
+    accounts: FFAuthAccount[];
+    sessions: FFAuthUserSession[];
 }
-export declare class KitAuthAccount {
+export declare class FFAuthAccount {
+    id: string;
     createdAt: Date;
     updatedAt?: Date;
     userId: string;
-    user: KitAuthUser;
+    user: FFAuthUser;
     provider: string;
     providerUserId: string;
     hashPassword?: string;
@@ -24,16 +25,16 @@ export declare class KitAuthAccount {
     expiresAt?: Date;
     lastVerifiedAt?: Date;
 }
-export declare class KitAuthUserSession {
+export declare class FFAuthUserSession {
     id: string;
     expiresAt: Date;
     userId: string;
-    user: KitAuthUser;
+    user: FFAuthUser;
 }
-export declare class AuthProvider extends KitBaseEnum {
-    static DEMO: AuthProvider;
-    static PASSWORD: AuthProvider;
-    static OTP: AuthProvider;
-    static OAUTH: AuthProvider;
-    constructor(id: string, o?: KitBaseEnumOptions);
+export declare class FFAuthProvider extends BaseEnum {
+    static DEMO: FFAuthProvider;
+    static PASSWORD: FFAuthProvider;
+    static OTP: FFAuthProvider;
+    static OAUTH: FFAuthProvider;
+    constructor(id: string, o?: BaseEnumOptions);
 }