firstly 0.0.11 → 0.0.13

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # firstly
 
+## 0.0.13
+
+### Patch Changes
+
+- [#66](https://github.com/jycouet/firstly/pull/66)
+  [`7d8b323`](https://github.com/jycouet/firstly/commit/7d8b323b49d7d76b6d59ec887ed2e37a2238f201)
+  Thanks [@jycouet](https://github.com/jycouet)! - prepare JYC 013
+
+## 0.0.12
+
+### Patch Changes
+
+- [#64](https://github.com/jycouet/firstly/pull/64)
+  [`782ef9c`](https://github.com/jycouet/firstly/commit/782ef9c8a1d967950e4c17de59b3225bc28df5c2)
+  Thanks [@jycouet](https://github.com/jycouet)! - prepare JYC 012
+
 ## 0.0.11
 
 ### Patch Changes

package/esm/BaseEnum.d.ts

@@ -22,6 +22,7 @@ export type BaseEnumOptions<Entity = any> = {
     icon?: FF_Icon;
     where?: FindOptionsBase<Entity>['where'];
     class?: string;
+    hide?: boolean;
 };
 export declare class BaseEnum<Entity = any> {
     id: string;
@@ -29,5 +30,6 @@ export declare class BaseEnum<Entity = any> {
     icon?: FF_Icon;
     where?: FindOptionsBase<Entity>['where'];
     class?: string;
+    hide?: boolean;
     constructor(_id: string | number, options?: BaseEnumOptions<Entity>);
 }

package/esm/BaseEnum.js

@@ -4,12 +4,14 @@ export class BaseEnum {
     icon;
     where;
     class;
+    hide;
     constructor(_id, options) {
         this.id = _id.toString();
         this.caption = options?.caption ?? this.id;
         this.icon = options?.icon;
         this.where = options?.where;
         this.class = options?.class;
+        this.hide = options?.hide;
         if (options?.icon && options.icon.caption === undefined) {
             options.icon.caption = options?.caption;
         }

package/esm/FF_Fields.js

@@ -61,7 +61,6 @@ export class FF_Fields {
             suffixEdit: '€',
             inputType: 'number',
             displayValue: displayCurrency,
-            // REMULT P2: all default valueConverter are removed if I set one?
             valueConverter: {
                 toInput(val, inputType) {
                     const valStr = String(val);

package/esm/ROUTES.d.ts

@@ -85,8 +85,8 @@ export type KIT_ROUTES = {
         'github': 'owner' | 'repo';
     };
     Params: {
-        owner: never;
-        repo: never;
+        'owner': never;
+        'repo': never;
     };
 };
 export {};

package/esm/ROUTES.js

@@ -32,9 +32,9 @@ const LINKS = {
     "remult_admin": `/api/admin`,
     "github": (params) => {
         params = params ?? {};
-        params.owner = params.owner ?? "jycouet";
-        params.repo = params.repo ?? "firstly";
-        return `https://github.com/${params.owner}/${params.repo}`;
+        params['owner'] = params['owner'] ?? "jycouet";
+        params['repo'] = params['repo'] ?? "firstly";
+        return `https://github.com/${params['owner']}/${params['repo']}`;
     }
 };
 /**
@@ -49,7 +49,12 @@ export const appendSp = (sp, prefix = '?') => {
             params.append(n, String(v));
         }
     };
+    let anchor = '';
     for (const [name, val] of Object.entries(sp)) {
+        if (name === '__KIT_ROUTES_ANCHOR__' && val !== undefined) {
+            anchor = `#${val}`;
+            continue;
+        }
         if (Array.isArray(val)) {
             for (const v of val) {
                 append(name, v);
@@ -60,8 +65,8 @@ export const appendSp = (sp, prefix = '?') => {
         }
     }
     const formatted = params.toString();
-    if (formatted) {
-        return `${prefix}${formatted}`;
+    if (formatted || anchor) {
+        return `${prefix}${formatted}${anchor}`.replace('?#', '#');
     }
     return '';
 };

package/esm/SqlDatabase/FF_LogToConsole.d.ts

@@ -1,4 +1,5 @@
 export declare const FF_LogToConsole: (duration: number, query: string, args: Record<string, any>, options?: {
     withDetails?: boolean;
     tablesToHide?: string[][];
+    ending?: (duration: number, query: string, args: Record<string, any>, tables: string[]) => void;
 }) => string | undefined;

package/esm/SqlDatabase/FF_LogToConsole.js

@@ -1,3 +1,4 @@
+import { SqlDatabase } from 'remult';
 import { bgCyan, cyan, green, Log, magenta, yellow } from '@kitql/helpers';
 const typeQuery = new Map([
     // CRUD
@@ -16,7 +17,10 @@ const typeQuery = new Map([
 ]);
 const keys = ['FROM', 'WHERE', 'LIMIT', 'OFFSET'];
 const typeQueryKey = Array.from(typeQuery.keys());
+const log = new Log('');
 export const FF_LogToConsole = (duration, query, args, options) => {
+    if (duration < SqlDatabase.durationThreshold)
+        return;
     const rawSql = query
         .replace(/(\r\n|\n|\r|\t)/gm, ' ')
         .replace(/  +/g, ' ')
@@ -67,6 +71,18 @@ export const FF_LogToConsole = (duration, query, args, options) => {
             listArgs.push(s[i - 2].replaceAll('"', '') + ': ' + s[i]);
         }
     }
+    const toFilterOut = options?.tablesToHide ?? [
+        ['information_Schema.tables'],
+        ['information_schema.columns'],
+        // ['__remult_migrations_version'],
+        ['ff_auth.accounts'],
+        ['ff_auth.users'],
+        ['ff_auth.users_sessions'],
+        ['_ff_change_logs'],
+    ];
+    const toHide = toFilterOut.some((item) => item.every((i) => tables.map((c) => c.replaceAll('"', '')).includes(i)));
+    if (toHide)
+        return;
     const final_s = s.join(' ').replace(/  +/g, ' ');
     // args replace
     // const listArgs = []
@@ -79,7 +95,8 @@ export const FF_LogToConsole = (duration, query, args, options) => {
     const subTables = uniqueTables.slice(0, -1);
     const time = ` ${bgCyan((duration * 1000).toFixed(0).padStart(3) + ' ms ')}`;
     let toLog = '';
-    if (options?.withDetails) {
+    const withDetails = options?.withDetails === undefined ? true : options?.withDetails;
+    if (withDetails) {
         toLog = `${typeQuery.get(first) || '💢'}` + time + ` ${final_s}`;
     }
     else {
@@ -90,20 +107,9 @@ export const FF_LogToConsole = (duration, query, args, options) => {
                 `${listArgs.length > 0 ? ` { ${listArgs.join(', ')} }` : ``}` +
                 `${subTables.length > 0 ? magenta(` (sub: ${subTables.join(', ')})`) : ``}`;
     }
-    const toFilterOut = options?.tablesToHide ?? [
-        ['__remult_migrations_version'],
-        ['information_Schema.tables'],
-        ['information_schema.columns'],
-        ['ff_auth.accounts'],
-        ['ff_auth.users'],
-        ['ff_auth.users_sessions'],
-        ['_ff_change_logs'],
-    ];
-    const OnoOfFiltered = toFilterOut.some((item) => item.every((i) => tables.map((c) => c.replaceAll('"', '')).includes(i)));
-    if (!OnoOfFiltered) {
-        // console.log(`toLogLong`, toLogLong)
-        log.info(toLog);
-        return toLog;
+    log.info(toLog);
+    if (options?.ending) {
+        options.ending(duration, query, args, tables);
     }
+    return toLog;
 };
-const log = new Log('');

package/esm/api/index.d.ts

@@ -1,40 +1,39 @@
-import type { Handle, RequestEvent } from '@sveltejs/kit';
+import type { RequestEvent } from '@sveltejs/kit';
 import { type ClassType } from 'remult';
 import type { RemultServerOptions } from 'remult/server';
-import { type MailOptions } from '../mail';
-export type Module = {
+import { Log } from '@kitql/helpers';
+type ModuleInput = {
     /**
      * The name of the module (usefull for logging and debugging purposes)
      */
     name: string;
-    index?: number;
+    priority?: number;
     entities?: ClassType<any>[];
     controllers?: ClassType<any>[];
     initApi?: RemultServerOptions<RequestEvent>['initApi'];
     initRequest?: RemultServerOptions<RequestEvent>['initRequest'];
-    handlePreRemult?: Handle;
-    handlePosRemult?: Handle;
-    earlyReturn?: (input: Parameters<Handle>[0]) => Promise<{
-        early: false;
-        resolve?: undefined;
-    } | {
-        early: true;
-        resolve: ReturnType<Handle>;
-    }>;
     modules?: Module[];
 };
-type Options = Omit<RemultServerOptions<RequestEvent<Partial<Record<string, string>>, string | null>> & {
+export declare class Module {
+    name: string;
+    log: Log;
+    priority?: number;
+    entities?: ClassType<any>[];
+    controllers?: ClassType<any>[];
+    initApi?: RemultServerOptions<RequestEvent>['initApi'];
+    initRequest?: RemultServerOptions<RequestEvent>['initRequest'];
+    modules?: Module[];
+    constructor(input: ModuleInput);
+}
+type Options = RemultServerOptions<RequestEvent<Partial<Record<string, string>>, string | null>> & {
     modules?: Module[] | undefined;
-    mail?: MailOptions<any>;
-}, 'entities' | 'controllers' | 'initRequest' | 'initApi'>;
+};
+export declare let entities: ClassType<any>[];
 /**
  * it's basically `remultSveltekit` with the `modules` option
+ * @deprecated will be done directly in remult when modules will be in 😉
  */
-export declare const firstly: (o: Options) => {
-    modulesSorted: Module[];
-    entities: ClassType<any>[];
-    server: import("remult/remult-sveltekit").RemultSveltekitServer;
-};
+export declare const firstly: (o: Options) => import("remult/remult-sveltekit").RemultSveltekitServer;
 /**
  * Full flat and ordered list by index and concatenaining the modules name
  */

package/esm/api/index.js

@@ -1,81 +1,93 @@
-import nodemailer from 'nodemailer';
-import { remult } from 'remult';
+import {} from 'remult';
 import { remultSveltekit } from 'remult/remult-sveltekit';
 import { Log } from '@kitql/helpers';
 import { building } from '$app/environment';
-import { mailInit } from '../mail';
+import { sveltekit } from '../sveltekit/server';
+export class Module {
+    name;
+    log;
+    priority;
+    entities;
+    controllers;
+    initApi;
+    initRequest;
+    modules;
+    constructor(input) {
+        this.name = input.name;
+        this.log = new Log(`firstly | ${this.name}`);
+        this.priority = input.priority;
+        this.entities = input.entities;
+        this.controllers = input.controllers;
+        this.initApi = input.initApi;
+        this.initRequest = input.initRequest;
+        this.modules = input.modules;
+    }
+}
+export let entities = [];
 /**
  * it's basically `remultSveltekit` with the `modules` option
+ * @deprecated will be done directly in remult when modules will be in 😉
  */
 export const firstly = (o) => {
-    const modulesSorted = modulesFlatAndOrdered(o.modules ?? []);
-    const entities = modulesSorted.flatMap((m) => m.entities ?? []);
-    mailInit(nodemailer, o.mail);
-    return {
-        modulesSorted: modulesSorted,
+    const modulesSorted = modulesFlatAndOrdered([
+        ...[...(o.modules ?? []), sveltekit()],
+        new Module({
+            name: 'default',
+            entities: o.entities ?? [],
+            controllers: o.controllers ?? [],
+            initRequest: o.initRequest,
+            initApi: o.initApi,
+        }),
+    ]);
+    entities = modulesSorted.flatMap((m) => m.entities ?? []);
+    return remultSveltekit({
+        // Changing the default default of remult
+        logApiEndPoints: false,
+        admin: true,
+        defaultGetLimit: 25,
+        error: o.error
+            ? o.error
+            : async (e) => {
+                // REMULT P2: validation error should probably be 409
+                // if 400 we move to 409
+                if (e.httpStatusCode == 400) {
+                    e.sendError(409, e.responseBody);
+                }
+            },
+        // Add user configuration
+        ...o,
+        // Module part
         entities,
-        server: remultSveltekit({
-            // Changing the default default of remult
-            logApiEndPoints: false,
-            admin: true,
-            defaultGetLimit: 25,
-            error: o.error
-                ? o.error
-                : async (e) => {
-                    // REMULT P2: validation error should probably be 409
-                    // if 400 we move to 409
-                    if (e.httpStatusCode == 400) {
-                        e.sendError(409, e.responseBody);
+        controllers: modulesSorted.flatMap((m) => m.controllers ?? []),
+        initRequest: async (kitEvent, op) => {
+            for (let i = 0; i < modulesSorted.length; i++) {
+                const f = modulesSorted[i].initRequest;
+                if (f) {
+                    try {
+                        await f(kitEvent, op);
                     }
-                },
-            // Add user configuration
-            ...o,
-            // Module part
-            entities,
-            controllers: modulesSorted.flatMap((m) => m.controllers ?? []),
-            initRequest: async (kitEvent, op) => {
-                // usefull for later...
-                remult.context.url = kitEvent.url;
-                remult.context.setHeaders = (headers) => {
-                    kitEvent.setHeaders(headers);
-                };
-                remult.context.setCookie = (name, value, opts) => {
-                    kitEvent.cookies.set(name, value, opts);
-                };
-                remult.context.deleteCookie = (name, opts) => {
-                    kitEvent.cookies.delete(name, opts);
-                };
+                    catch (error) {
+                        modulesSorted[i].log.error(error);
+                    }
+                }
+            }
+        },
+        initApi: async (r) => {
+            if (!building) {
                 for (let i = 0; i < modulesSorted.length; i++) {
-                    const f = modulesSorted[i].initRequest;
+                    const f = modulesSorted[i].initApi;
                     if (f) {
                         try {
-                            await f(kitEvent, op);
+                            await f(r);
                         }
                         catch (error) {
-                            const log = new Log(`firstly | ${modulesSorted[i].name}`);
-                            log.error(error);
-                        }
-                    }
-                }
-            },
-            initApi: async (r) => {
-                if (!building) {
-                    for (let i = 0; i < modulesSorted.length; i++) {
-                        const f = modulesSorted[i].initApi;
-                        if (f) {
-                            try {
-                                await f(r);
-                            }
-                            catch (error) {
-                                const log = new Log(`firstly | ${modulesSorted[i].name}`);
-                                log.error(error);
-                            }
+                            modulesSorted[i].log.error(error);
                         }
                     }
                 }
-            },
-        }),
-    };
+            }
+        },
+    });
 };
 /**
  * Full flat and ordered list by index and concatenaining the modules name
@@ -92,6 +104,6 @@ export const modulesFlatAndOrdered = (modules) => {
         }, []);
     };
     const flatModules = flattenModules(modules);
-    flatModules.sort((a, b) => (a.index || 0) - (b.index || 0));
+    flatModules.sort((a, b) => (a.priority || 0) - (b.priority || 0));
     return flatModules;
 };

package/esm/auth/{client/Auth.d.ts → AuthController.d.ts}

@@ -1,25 +1,18 @@
-import type { AuthorizationURLOptions } from '..';
-export declare class Auth {
-    /** DO NOT USE */
-    static signOutFn: any;
-    /** DO NOT USE */
-    static signInDemoFn: any;
-    /** DO NOT USE */
-    static inviteFn: any;
-    /** DO NOT USE */
-    static signUpPasswordFn: any;
-    /** DO NOT USE */
-    static signInPasswordFn: any;
-    /** DO NOT USE */
-    static forgotPasswordFn: any;
-    /** DO NOT USE */
-    static resetPasswordFn: any;
-    /** DO NOT USE */
-    static signInOTPFn: any;
-    /** DO NOT USE */
-    static verifyOtpFn: any;
-    /** DO NOT USE */
-    static signInOAuthGetUrlFn: any;
+import type { ProviderConfigured } from './server/module';
+export declare class AuthController {
+    #private;
+    static _setAbstraction(impl: {
+        signOut: any;
+        signInDemo: any;
+        invite: any;
+        signUpPassword: any;
+        signInPassword: any;
+        forgotPassword: any;
+        resetPassword: any;
+        signInOTP: any;
+        verifyOtp: any;
+        signInOAuthGetUrl: any;
+    }): void;
     /**
      * Sign out the current user
      */
@@ -54,7 +47,7 @@ export declare class Auth {
     /**
      * Verify the OTP code
      */
-    static verifyOtp(email: string, otp: string | number): Promise<any>;
+    static verifyOtp(email: string, otp: string): Promise<any>;
     /** OAUTH */
     /**
      * The the url to redirect to for the OAuth provider
@@ -68,9 +61,9 @@ export declare class Auth {
      *
      * _(popup example should work too, and a nice example/componant would be appreciated)_
      */
-    static signInOAuthGetUrl<T extends keyof AuthorizationURLOptions>(o: {
+    static signInOAuthGetUrl<T extends keyof ProviderConfigured>(o: {
         provider: T;
-        options?: AuthorizationURLOptions[T];
+        options?: ProviderConfigured[T];
         redirect?: string;
     }): Promise<any>;
 }

package/esm/auth/{client/Auth.js → AuthController.js}

@@ -4,81 +4,85 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
-import { Allow, BackendMethod } from 'remult';
-export class Auth {
-    // Do not show for firstly users ?
-    /** DO NOT USE */
-    static signOutFn;
-    /** DO NOT USE */
-    static signInDemoFn;
-    /** DO NOT USE */
-    static inviteFn;
-    /** DO NOT USE */
-    static signUpPasswordFn;
-    /** DO NOT USE */
-    static signInPasswordFn;
-    /** DO NOT USE */
-    static forgotPasswordFn;
-    /** DO NOT USE */
-    static resetPasswordFn;
-    /** DO NOT USE */
-    static signInOTPFn;
-    /** DO NOT USE */
-    static verifyOtpFn;
-    /** DO NOT USE */
-    static signInOAuthGetUrlFn;
+import { BackendMethod } from 'remult';
+import { FF_Role_Auth } from './Entities';
+export class AuthController {
+    // Private static fields
+    static #signOutFn;
+    static #signInDemoFn;
+    static #inviteFn;
+    static #signUpPasswordFn;
+    static #signInPasswordFn;
+    static #forgotPasswordFn;
+    static #resetPasswordFn;
+    static #signInOTPFn;
+    static #verifyOtpFn;
+    static #signInOAuthGetUrlFn;
+    // Internal setter method that can be used by the module
+    static _setAbstraction(impl) {
+        this.#signOutFn = impl.signOut;
+        this.#signInDemoFn = impl.signInDemo;
+        this.#inviteFn = impl.invite;
+        this.#signUpPasswordFn = impl.signUpPassword;
+        this.#signInPasswordFn = impl.signInPassword;
+        this.#forgotPasswordFn = impl.forgotPassword;
+        this.#resetPasswordFn = impl.resetPassword;
+        this.#signInOTPFn = impl.signInOTP;
+        this.#verifyOtpFn = impl.verifyOtp;
+        this.#signInOAuthGetUrlFn = impl.signInOAuthGetUrl;
+    }
     /**
      * Sign out the current user
      */
     static async signOut() {
-        return await Auth.signOutFn();
+        return await AuthController.#signOutFn();
     }
     /**
      * Sign in with a demo account
      * _(The easiest way to demo & test your application)_
      */
     static async signInDemo(name) {
-        return await Auth.signInDemoFn(name);
+        return await AuthController.#signInDemoFn(name);
     }
     /**
      * This is for login / password authentication Invite someone
      */
     static async invite(email) {
-        return await Auth.inviteFn(email);
+        return await AuthController.#inviteFn(email);
     }
     /**
      * This is for login / password authentication SignUp
      */
     static async signUpPassword(email, password) {
-        return await Auth.signUpPasswordFn(email, password);
+        return await AuthController.#signUpPasswordFn(email, password);
     }
     /**
      * This is for login / password authentication SignIn
      */
     static async signInPassword(email, password) {
-        return await Auth.signInPasswordFn(email, password);
+        return await AuthController.#signInPasswordFn(email, password);
     }
     /**
      * Forgot your password ? Send a mail to reset it.
      */
     static async forgotPassword(email) {
-        return await Auth.forgotPasswordFn(email);
+        return await AuthController.#forgotPasswordFn(email);
     }
     /**
      * Reset your password with a token
      */
     static async resetPassword(token, password) {
-        return await Auth.resetPasswordFn(token, password);
+        return await AuthController.#resetPasswordFn(token, password);
     }
     /** OTP */
     static async signInOTP(email) {
-        return await Auth.signInOTPFn(email);
+        return await AuthController.#signInOTPFn(email);
     }
     /**
      * Verify the OTP code
      */
     static async verifyOtp(email, otp) {
-        return await Auth.verifyOtpFn(email, otp);
+        return await AuthController.#verifyOtpFn(email, otp);
     }
     /** OAUTH */
     /**
@@ -94,36 +98,36 @@ export class Auth {
      * _(popup example should work too, and a nice example/componant would be appreciated)_
      */
     static async signInOAuthGetUrl(o) {
-        return await Auth.signInOAuthGetUrlFn(o);
+        return await AuthController.#signInOAuthGetUrlFn(o);
     }
 }
 __decorate([
     BackendMethod({ allowed: true })
-], Auth, "signOut", null);
+], AuthController, "signOut", null);
 __decorate([
     BackendMethod({ allowed: true })
-], Auth, "signInDemo", null);
+], AuthController, "signInDemo", null);
 __decorate([
-    BackendMethod({ allowed: Allow.authenticated })
-], Auth, "invite", null);
+    BackendMethod({ allowed: FF_Role_Auth.FF_Role_Auth_Invite })
+], AuthController, "invite", null);
 __decorate([
     BackendMethod({ allowed: true })
-], Auth, "signUpPassword", null);
+], AuthController, "signUpPassword", null);
 __decorate([
     BackendMethod({ allowed: true })
-], Auth, "signInPassword", null);
+], AuthController, "signInPassword", null);
 __decorate([
     BackendMethod({ allowed: true })
-], Auth, "forgotPassword", null);
+], AuthController, "forgotPassword", null);
 __decorate([
     BackendMethod({ allowed: true })
-], Auth, "resetPassword", null);
+], AuthController, "resetPassword", null);
 __decorate([
     BackendMethod({ allowed: true })
-], Auth, "signInOTP", null);
+], AuthController, "signInOTP", null);
 __decorate([
     BackendMethod({ allowed: true })
-], Auth, "verifyOtp", null);
+], AuthController, "verifyOtp", null);
 __decorate([
     BackendMethod({ allowed: true })
-], Auth, "signInOAuthGetUrl", null);
+], AuthController, "signInOAuthGetUrl", null);

package/esm/auth/{client/Entities.d.ts → Entities.d.ts}

@@ -1,7 +1,8 @@
-import { BaseEnum } from '../..';
-import type { BaseEnumOptions } from '../..';
+import { BaseEnum } from '..';
+import type { BaseEnumOptions } from '..';
 export declare const FF_Role_Auth: {
-    readonly Admin: "FF_Role_Auth.Admin";
+    readonly FF_Role_Auth_Admin: "FF_Role_Auth.Admin";
+    readonly FF_Role_Auth_Invite: "FF_Role_Auth.Invite";
 };
 export declare class FFAuthUser {
     id: string;