firstly 0.0.3 → 0.0.4

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # firstly
 
+## 0.0.4
+
+### Patch Changes
+
+- [#16](https://github.com/jycouet/firstly/pull/16)
+  [`ac00e70`](https://github.com/jycouet/firstly/commit/ac00e703af515009bbe7e078998f77ef3a9e9ce5)
+  Thanks [@jycouet](https://github.com/jycouet)! - WIP next version / split client & server imports.
+
 ## 0.0.3
 
 ### Patch Changes

package/esm/KitFields.d.ts

@@ -1,8 +1,8 @@
 import { type FieldOptions, type FieldValidator, type StringFieldOptions } from 'remult';
-export declare function addValidator(validators: FieldOptions['validate'], newValidator: FieldOptions['validate'], atStart?: boolean): FieldValidator<any, any> | FieldValidator<any, any>[] | undefined;
+export declare function addValidator(validators: FieldOptions['validate'], newValidator: FieldOptions['validate'], atStart?: boolean): FieldValidator<unknown, unknown> | FieldValidator<unknown, unknown>[] | undefined;
 export declare class KitFields {
-    static string<entityType = unknown, valueType = string>(o?: StringFieldOptions<entityType, valueType> & FieldOptions<entityType, valueType>): import("remult").ClassFieldDecorator<entityType, valueType | undefined>;
-    static currency<entityType = any, valueType = any>(o?: FieldOptions<entityType> & FieldOptions<entityType>): import("remult").ClassFieldDecorator<entityType, number | undefined>;
+    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>;
     static arrayEnum<enumType = any, entityType = any>(enumClass: enumType, o?: FieldOptions<entityType, any[]>): import("remult").ClassFieldDecorator<entityType, any[] | undefined>;
     static arrayEnumToGql<enumType = any, entityType = any>(enumClass: enumType, o?: FieldOptions<entityType, any[]>): import("remult").ClassFieldDecorator<entityType, any[] | undefined>;

package/esm/KitFields.js

@@ -13,38 +13,40 @@ export function addValidator(validators, newValidator, atStart = false) {
     const validatorsArray = Array.isArray(validators) ? validators : validators ? [validators] : [];
     return atStart ? [...newValidators, ...validatorsArray] : [...validatorsArray, ...newValidators];
 }
-// static string<entityType = any, valueType = string>(
-//   ...param: Parameters<typeof Fields.string<entityType, valueType>>
-// ) {
+// 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
+const validate_update_when_not_allow_null = (o) => {
+    const validate = [];
+    if (o.includeInApi !== false &&
+        o.serverExpression === undefined &&
+        o.sqlExpression === undefined &&
+        (o.allowNull === undefined || o.allowNull === false) &&
+        // if require: false is explicitly set, then we don't need to add required validator
+        o.required !== false) {
+        validate.push(Validators.required);
+    }
+    // let's add original validate if any
+    if (o.validate) {
+        if (Array.isArray(o.validate)) {
+            validate.push(...o.validate);
+        }
+        else {
+            validate.push(o.validate);
+        }
+    }
+    return validate;
+};
 export class KitFields {
     static string(o) {
-        // const f = Fields.string(...param)
-        // f.validate = addValidator(f.validate, Validators.required)
-        // return f
-        // empty if there is nothing coming here.
         if (o === undefined) {
             o = {};
         }
-        const validate = [];
-        if (o.includeInApi !== false &&
-            (!o.allowNull || o.required) &&
-            // if require: false is explicitly set, then we don't need to add required validator
-            o.required !== false) {
-            // REMULT P2 JYC (Open an issue): to repro + issue type issue? - Probably typescript
-            // @ts-ignore
-            validate.push(Validators.required);
-        }
-        // let's add original validate if any
-        if (o.validate) {
-            if (Array.isArray(o.validate)) {
-                validate.push(...o.validate);
-            }
-            else {
-                validate.push(o.validate);
-            }
-        }
         // let's return the field
-        return Fields.string({ ...o, validate });
+        return Fields.string({
+            ...o,
+            validate: validate_update_when_not_allow_null(o),
+        });
     }
     static currency(o) {
         // let's return the field
@@ -80,27 +82,9 @@ export class KitFields {
         if (o === undefined) {
             o = {};
         }
-        const validate = [];
-        if (o.includeInApi !== false &&
-            (!o.allowNull || o.required) &&
-            // if require: false is explicitly set, then we don't need to add required validator
-            o.required !== false) {
-            // REMULT P2 JYC (Open an issue): to repro + issue type issue? - Probably typescript
-            // @ts-ignore
-            validate.push(Validators.required);
-        }
-        // let's add original validate if any
-        if (o.validate) {
-            if (Array.isArray(o.validate)) {
-                validate.push(...o.validate);
-            }
-            else {
-                validate.push(o.validate);
-            }
-        }
         o.inputType = 'dateOnly';
         // let's return the field
-        return Fields.dateOnly({ ...o, validate });
+        return Fields.dateOnly({ ...o, validate: validate_update_when_not_allow_null(o) });
     }
     static arrayEnum(enumClass, o) {
         return Fields.json(() => Array, {
@@ -126,7 +110,6 @@ export class KitFields {
                     return `{${[...new Set((arr ?? []).map((c) => c.id))].join(',')}}`;
                 },
                 displayValue: (v) => {
-                    // TODO to transform in enum & item one day
                     return v.map((c) => c.caption).join(', ');
                 },
                 // REMULT P2 Noam: how to do this in an official way?
@@ -152,7 +135,6 @@ export class KitFields {
                     return `{${[...new Set((arr ?? []).map((c) => c.id))].join(',')}}`;
                 },
                 displayValue: (v) => {
-                    // TODO to transform in enum & item one day
                     return v.map((c) => c.caption).join(', ');
                 },
                 // REMULT P2 Noam: how to do this in an official way?

package/esm/ROUTES.d.ts

@@ -25,7 +25,7 @@ type FunctionKeys<T> = {
 }[keyof T];
 type FunctionParams<T> = T extends (...args: infer P) => any ? P : never;
 declare const AllObjs: {
-    kit_sign_in: string;
+    firstly_sign_in: string;
     remult_admin: string;
     github: (params?: {
         owner?: (string | number);
@@ -39,6 +39,8 @@ declare const AllObjs: {
     "/ui": string;
 };
 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")[];
 /**
  * To be used like this:
  * ```ts
@@ -76,7 +78,7 @@ export type KIT_ROUTES = {
     SERVERS: Record<string, never>;
     ACTIONS: Record<string, never>;
     LINKS: {
-        'kit_sign_in': never;
+        'firstly_sign_in': never;
         'remult_admin': never;
         'github': 'owner' | 'repo';
     };

package/esm/ROUTES.js

@@ -27,7 +27,7 @@ const ACTIONS = {};
  * LINKS
  */
 const LINKS = {
-    "kit_sign_in": `/kit/auth/sign-in`,
+    "firstly_sign_in": `/fly/auth/sign-in`,
     "remult_admin": `/api/admin`,
     "github": (params) => {
         params = params ?? {};
@@ -80,13 +80,10 @@ export const currentSp = () => {
     }
     return record;
 };
-function StringOrUndefined(val) {
-    if (val === undefined) {
-        return undefined;
-    }
-    return String(val);
-}
 const AllObjs = { ...PAGES, ...ACTIONS, ...SERVERS, ...LINKS };
+export const routes = [
+    ...new Set(Object.keys(AllObjs).map((route) => /^\/.*|[^ ]?\/.*$/.exec(route)?.[0] ?? route)),
+];
 export function route(key, ...params) {
     if (AllObjs[key] instanceof Function) {
         const element = AllObjs[key];

package/esm/auth/Adapter.js

@@ -6,16 +6,18 @@ export class RemultLuciaAdapter {
         const session = await remult.repo(oSafe.Session).findId(sessionId);
         if (session) {
             const user = await remult.repo(oSafe.User).findId(session.userId);
-            return [
-                { ...session, attributes: {} },
-                {
-                    ...user,
-                    attributes: {
+            if (user) {
+                return [
+                    { ...session, attributes: {} },
+                    {
                         ...user,
-                        session: { id: session.id, expiresAt: session.expiresAt },
+                        attributes: {
+                            ...user,
+                            session: { id: session.id, expiresAt: session.expiresAt },
+                        },
                     },
-                },
-            ];
+                ];
+            }
         }
         return [null, null];
     }

package/esm/auth/{AuthController.d.ts → AuthController.server.d.ts}

@@ -1,5 +1,5 @@
 import { type AuthorizationURLOptions } from '.';
-export declare class AuthController {
+export declare class AuthControllerServer {
     /**
      * Sign out the current user
      */
@@ -45,7 +45,7 @@ export declare class AuthController {
      *
      * To be used like this for example:
      * ```
-     * const url = await AuthController.signInOAuthGetUrl('github')
+     * const url = await Auth.signInOAuthGetUrl('github')
      * window.location.href = url
      * ```
      *

package/esm/auth/{AuthController.js → AuthController.server.js}

@@ -1,20 +1,14 @@
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    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 { generateCodeVerifier, generateState } from 'arctic';
 import { DEV } from 'esm-env';
 import { generateId } from 'lucia';
 import { createDate, TimeSpan } from 'oslo';
-import { BackendMethod, remult } from 'remult';
+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 { createSession } from './helper';
-import { mergeRoles } from './RoleController';
+import { mergeRoles } from './RoleHelpers';
 async function getArgon() {
     const { Argon2id } = await import('oslo/password');
     return new Argon2id({
@@ -34,7 +28,7 @@ function checkPassword(password) {
         throw Error('Invalid password');
     }
 }
-export class AuthController {
+export class AuthControllerServer {
     /**
      * Sign out the current user
      */
@@ -174,7 +168,7 @@ export class AuthController {
             .repo(oSafe.User)
             .findOne({ where: { name: email }, include: { accounts: true } });
         const accountPassword = existingUser?.accounts.find((c) => c.provider === AuthProvider.PASSWORD.id);
-        if (accountPassword) {
+        if (accountPassword && existingUser) {
             const validPassword = await passwordVerify(accountPassword?.hashPassword ?? '', password ?? '');
             if (validPassword) {
                 await createSession(existingUser.id);
@@ -312,7 +306,7 @@ export class AuthController {
         }
         const account = accounts[0];
         const user = await remult.repo(oSafe.User).findId(account.userId);
-        if (user.name !== email) {
+        if (user?.name !== email) {
             throw new Error('Invalid otp.');
         }
         const { decodeHex } = await import('oslo/encoding');
@@ -338,7 +332,7 @@ export class AuthController {
      *
      * To be used like this for example:
      * ```
-     * const url = await AuthController.signInOAuthGetUrl('github')
+     * const url = await Auth.signInOAuthGetUrl('github')
      * window.location.href = url
      * ```
      *
@@ -402,33 +396,3 @@ export class AuthController {
         throw new Error(`${o.provider} is not configured!`);
     }
 }
-__decorate([
-    BackendMethod({ allowed: true })
-], AuthController, "signOut", null);
-__decorate([
-    BackendMethod({ allowed: true })
-], AuthController, "signInDemo", null);
-__decorate([
-    BackendMethod({ allowed: false })
-], AuthController, "invite", null);
-__decorate([
-    BackendMethod({ allowed: true })
-], AuthController, "signUpPassword", null);
-__decorate([
-    BackendMethod({ allowed: true })
-], AuthController, "signInPassword", null);
-__decorate([
-    BackendMethod({ allowed: true })
-], AuthController, "forgotPassword", null);
-__decorate([
-    BackendMethod({ allowed: true })
-], AuthController, "resetPassword", null);
-__decorate([
-    BackendMethod({ allowed: true })
-], AuthController, "signInOTP", null);
-__decorate([
-    BackendMethod({ allowed: true })
-], AuthController, "verifyOtp", null);
-__decorate([
-    BackendMethod({ allowed: true })
-], AuthController, "signInOAuthGetUrl", null);

package/esm/auth/README.md

@@ -0,0 +1,13 @@
+# Firstly - Module - Auth
+
+➡️ Doc available [here](https://firstly.fun/modules/auth).
+
+## Complement
+
+### Lucia adapter
+
+Under the hood, we created a lucia adapter, you can check the code [here](./Adapter.ts) . Feel free
+to copy/paste it in your own codebase. You can also suggest improvements here 😉.
+
+By default, all tables/fields will show up in your admin and you are able to extend then with your
+own fields.

package/esm/auth/{RoleController.d.ts → RoleHelpers.d.ts}

@@ -9,6 +9,4 @@ export declare const mergeRoles: (existing: string[], newOnes: string[] | undefi
     roles: string[];
     changed: boolean;
 };
-export declare class RoleController {
-    static initRoleFromEnv: (log: Log, userEntity: ClassType<KitAuthUser>, envKey: string, role: string) => Promise<void>;
-}
+export declare const initRoleFromEnv: (log: Log, userEntity: ClassType<KitAuthUser>, envValue: string, role: string) => Promise<void>;

package/esm/auth/RoleHelpers.js

@@ -0,0 +1,43 @@
+import { repo } from 'remult';
+import { cyan, green, Log, yellow } from '@kitql/helpers';
+import { KitAuthUser } from './Entities';
+/**
+ * will merge the roles and remove duplicates
+ * will return a new array & a status if the array was changed
+ */
+export const mergeRoles = (existing, newOnes) => {
+    const result = new Set(existing);
+    let changed = false;
+    for (const role of newOnes ?? []) {
+        if (!result.has(role)) {
+            result.add(role);
+            changed = true;
+        }
+    }
+    return { roles: Array.from(result), changed };
+};
+export const initRoleFromEnv = async (log, userEntity, envValue, role) => {
+    const names = envValue === undefined ? [] : (envValue ?? '').split(',').map((c) => c.trim());
+    for (let i = 0; i < names.length; i++) {
+        const name = names[i].trim();
+        if (name !== '') {
+            let user = await repo(userEntity).findFirst({ name });
+            if (!user) {
+                user = repo(userEntity).create({ name, roles: [role] });
+                await repo(userEntity).save(user);
+            }
+            else {
+                if (!user.roles.includes(role)) {
+                    user.roles.push(role);
+                    await repo(userEntity).save(user);
+                }
+            }
+        }
+    }
+    if (names.length > 0) {
+        log.info(`${cyan(role)}: ${names.map((c) => green(c.trim())).join(', ')} added via ${yellow(`.env`)}.`);
+    }
+    else {
+        log.info(`${cyan(role)}: No users added via ${yellow(`.env`)}.`);
+    }
+};

package/esm/auth/client/Auth.d.ts

@@ -0,0 +1,69 @@
+import type { AuthorizationURLOptions } from '..';
+export declare class Auth {
+    static signOutFn: any;
+    static signInDemoFn: any;
+    static inviteFn: any;
+    static signUpPasswordFn: any;
+    static signInPasswordFn: any;
+    static forgotPasswordFn: any;
+    static resetPasswordFn: any;
+    static signInOTPFn: any;
+    static verifyOtpFn: any;
+    static signInOAuthGetUrlFn: any;
+    /**
+     * Sign out the current user
+     */
+    static signOut(): Promise<any>;
+    /**
+     * Sign in with a demo account
+     * _(The easiest way to demo & test your application)_
+     */
+    static signInDemo(name: string): Promise<any>;
+    /**
+     * This is for login / password authentication SignUp
+     * _(The first param `name` can be "anything")_
+     */
+    static invite(email: string): Promise<any>;
+    /**
+     * This is for login / password authentication SignUp
+     * _(The first param `email` can be "anything")_
+     */
+    static signUpPassword(email: string, password: string): Promise<any>;
+    /**
+     * This is for login / password authentication SignIn
+     * _(The first param `email` can be "anything")_
+     */
+    static signInPassword(email: string, password: string): Promise<any>;
+    /**
+     * Forgot your password ? Send a mail to reset it.
+     */
+    static forgotPassword(email: string): Promise<any>;
+    /**
+     * Reset your password with a token
+     */
+    static resetPassword(token: string, password: string): Promise<any>;
+    /** OTP */
+    static signInOTP(email: string): Promise<any>;
+    /**
+     * Verify the OTP code
+     */
+    static verifyOtp(email: string, otp: string | number): Promise<any>;
+    /** OAUTH */
+    /**
+     * The the url to redirect to for the OAuth provider
+     * @param provider Has to mach one of `AUTH_OPTIONS.providers.oAuths` your configured
+     *
+     * To be used like this for example:
+     * ```
+     * const url = await Auth.signInOAuthGetUrl('github')
+     * window.location.href = url
+     * ```
+     *
+     * _(popup example should work too, and a nice example/componant would be appreciated)_
+     */
+    static signInOAuthGetUrl<T extends keyof AuthorizationURLOptions>(o: {
+        provider: T;
+        options?: AuthorizationURLOptions[T];
+        redirect?: string;
+    }): Promise<any>;
+}

package/esm/auth/client/Auth.js

@@ -0,0 +1,121 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    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 { BackendMethod } from 'remult';
+export class Auth {
+    static signOutFn;
+    static signInDemoFn;
+    static inviteFn;
+    static signUpPasswordFn;
+    static signInPasswordFn;
+    static forgotPasswordFn;
+    static resetPasswordFn;
+    static signInOTPFn;
+    static verifyOtpFn;
+    static signInOAuthGetUrlFn;
+    /**
+     * Sign out the current user
+     */
+    static async signOut() {
+        return await Auth.signOutFn();
+    }
+    /**
+     * Sign in with a demo account
+     * _(The easiest way to demo & test your application)_
+     */
+    static async signInDemo(name) {
+        return await Auth.signInDemoFn(name);
+    }
+    /**
+     * This is for login / password authentication SignUp
+     * _(The first param `name` can be "anything")_
+     */
+    static async invite(email) {
+        return await Auth.inviteFn(email);
+    }
+    /**
+     * This is for login / password authentication SignUp
+     * _(The first param `email` can be "anything")_
+     */
+    static async signUpPassword(email, password) {
+        return await Auth.signUpPasswordFn(email, password);
+    }
+    /**
+     * This is for login / password authentication SignIn
+     * _(The first param `email` can be "anything")_
+     */
+    static async signInPassword(email, password) {
+        return await Auth.signInPasswordFn(email, password);
+    }
+    /**
+     * Forgot your password ? Send a mail to reset it.
+     */
+    static async forgotPassword(email) {
+        return await Auth.forgotPasswordFn(email);
+    }
+    /**
+     * Reset your password with a token
+     */
+    static async resetPassword(token, password) {
+        return await Auth.resetPasswordFn(token, password);
+    }
+    /** OTP */
+    static async signInOTP(email) {
+        return await Auth.signInOTPFn(email);
+    }
+    /**
+     * Verify the OTP code
+     */
+    static async verifyOtp(email, otp) {
+        return await Auth.verifyOtpFn(email, otp);
+    }
+    /** OAUTH */
+    /**
+     * The the url to redirect to for the OAuth provider
+     * @param provider Has to mach one of `AUTH_OPTIONS.providers.oAuths` your configured
+     *
+     * To be used like this for example:
+     * ```
+     * const url = await Auth.signInOAuthGetUrl('github')
+     * window.location.href = url
+     * ```
+     *
+     * _(popup example should work too, and a nice example/componant would be appreciated)_
+     */
+    static async signInOAuthGetUrl(o) {
+        return await Auth.signInOAuthGetUrlFn(o.provider, o.options, o.redirect);
+    }
+}
+__decorate([
+    BackendMethod({ allowed: true })
+], Auth, "signOut", null);
+__decorate([
+    BackendMethod({ allowed: true })
+], Auth, "signInDemo", null);
+__decorate([
+    BackendMethod({ allowed: false })
+], Auth, "invite", null);
+__decorate([
+    BackendMethod({ allowed: true })
+], Auth, "signUpPassword", null);
+__decorate([
+    BackendMethod({ allowed: true })
+], Auth, "signInPassword", null);
+__decorate([
+    BackendMethod({ allowed: true })
+], Auth, "forgotPassword", null);
+__decorate([
+    BackendMethod({ allowed: true })
+], Auth, "resetPassword", null);
+__decorate([
+    BackendMethod({ allowed: true })
+], Auth, "signInOTP", null);
+__decorate([
+    BackendMethod({ allowed: true })
+], Auth, "verifyOtp", null);
+__decorate([
+    BackendMethod({ allowed: true })
+], Auth, "signInOAuthGetUrl", null);

package/esm/auth/client/index.d.ts

@@ -0,0 +1,2 @@
+import { Auth } from './Auth';
+export { Auth };

package/esm/auth/client/index.js

@@ -0,0 +1,2 @@
+import { Auth } from './Auth';
+export { Auth };

package/esm/auth/index.d.ts

@@ -4,11 +4,10 @@ import type { ClassType, UserInfo } from 'remult';
 import { Log } from '@kitql/helpers';
 import type { Module } from '../api';
 import type { ResolvedType } from '../utils/types';
-import { KitAuthAccount, KitAuthUser, KitAuthUserSession } from './Entities';
+import { AuthProvider, KitAuthAccount, KitAuthUser, KitAuthUserSession } from './Entities';
 import type { firstlyData } from './types';
 export type { firstlyData };
-export { KitAuthUser, KitAuthAccount, AuthProvider, KitAuthUserSession } from './Entities';
-export { AuthController } from './AuthController';
+export { KitAuthUser, KitAuthAccount, AuthProvider, KitAuthUserSession };
 export type AuthorizationURLOptions = Record<string, {
     scopes?: string[];
 }>;