firstly 0.2.1 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # firstly
 
+## 0.3.0
+
+### Minor Changes
+
+- [#232](https://github.com/jycouet/firstly/pull/232) [`fec8bc0`](https://github.com/jycouet/firstly/commit/fec8bc088733d63ce6752b0a764b786f80b736cb) Thanks [@jycouet](https://github.com/jycouet)! - BREAKING: Remove deprecated lucia-style auth module (`firstly/auth`, `firstly/auth/server`).
+
+  Migrate to `better-auth` (see remult docs). Removed deps: `@oslojs/*`, `arctic`, `bcryptjs`.
+  Also removed `packages/ui` (was only used for the auth UI).
+
+### Patch Changes
+
+- [#221](https://github.com/jycouet/firstly/pull/221) [`0b08040`](https://github.com/jycouet/firstly/commit/0b0804001c9a5bdff560fbcbb8b511c626d260f8) Thanks [@jycouet](https://github.com/jycouet)! - bump deps
+
 ## 0.2.1
 
 ### Patch Changes

package/esm/bin/cmd.js

@@ -11,7 +11,6 @@ const pkg = JSON.parse(read('./package.json') ?? '{}');
 const version = pkg.devDependencies?.['firstly'] ?? pkg.dependencies?.['firstly'] ?? '???';
 console.info('');
 p.intro(`${green(`⚡️`)} Welcome to firstly world! ${gray(` - v${version}`)}`);
-const keys = ['all', 'module-demo', 'dependencies'];
 const options = [
     {
         value: 'all',
@@ -142,11 +141,6 @@ export default {
     '.env.example': [
         `# Enable some roles
 # FF_ADMIN = 'JYC'
-# FF_AUTH_ADMIN = ''
-
-# Enable GitHub login
-# GITHUB_CLIENT_ID = ''
-# GITHUB_CLIENT_SECRET = ''
 `,
     ],
     './tsconfig.json': [
@@ -185,7 +179,6 @@ export default defineConfig({
     firstly<KIT_ROUTES>({
       kitRoutes: {
         LINKS: { 
-          login: 'ff/auth/sign-in',
           github: 'https://github.com/[owner]/[repo]',
           remult_admin: 'api/admin',
         },
@@ -198,13 +191,9 @@ export default defineConfig({
     ],
     './svelte.config.js': [
         `import adapter from '@sveltejs/adapter-auto'
-import { vitePreprocess } from '@sveltejs/vite-plugin-svelte'
 
 /** @type {import('@sveltejs/kit').Config} */
 const config = {
-	// Consult https://svelte.dev/docs/kit/integrations
-	// for more information about preprocessors
-	preprocess: vitePreprocess(),
 
 	kit: {
 		// adapter-auto only supports some environments, see https://svelte.dev/docs/kit/adapter-auto for a list.
@@ -251,7 +240,6 @@ export { }
     './src/server/index.ts': [
         `import { FF_Role } from '../internals'
 import { firstly, Module } from '../server'
-import { auth } from '../auth/server'
 import { mail } from '../mail/server'
 import { changeLog } from '../changeLog/server'
 
@@ -259,44 +247,7 @@ import { log, Role } from '${libAlias}'
 import { task } from '${modulesAlias}/task/server'
 
 export const api = firstly({
-  //----------------------------------------
-  // To switch to postgres
-  // NEEDS ON TOP OF THE FILE: 
-  //   import { createPostgresConnection } from 'remult/postgres'
-  //   import { DATABASE_URL } from '$env/static/private'
-  //----------------------------------------
-  // dataProvider: await createPostgresConnection({
-  //  connectionString: DATABASE_URL,
-  // }),
-
   modules: [
-    //----------------------------------------
-    // Core Module: auth
-    //----------------------------------------
-    auth({
-      providers: {
-        demo: [
-          { name: 'Ermin' },
-          { name: 'JYC', roles: [FF_Role.FF_Role_Admin] },
-          { name: 'Noam', roles: [FF_Role.FF_Role_Admin, Role.Boss] },
-        ],
-
-        // password: {},
-
-        // otp: {},
-
-        oAuths: [
-          //----------------------------------------
-          // To enable OAuth via Github
-          // Instructions by hovering the method \`github\`
-          // NEEDS ON TOP OF THE FILE: 
-          //   import { github } from '../auth/server'
-          //----------------------------------------
-          // github(),
-        ],
-      },
-    }),
-
     //----------------------------------------
     // Core Module: mail
     //----------------------------------------
@@ -331,25 +282,11 @@ export const api = firstly({
     ],
     './src/hooks.server.ts': [
         `import { sequence } from '@sveltejs/kit/hooks'
-import { redirect } from '@sveltejs/kit'
 
-import { handleAuth, handleGuard } from '../auth/server'
-import { route } from '${libAlias}/ROUTES'
 import { api as handleRemult } from '${serverAlias}'
 
 export const handle = sequence(
-	//
 	handleRemult,
-	handleAuth,
-  // client side guard is not here!
-	handleGuard({
-		authenticated: ['/app*'],
-    redirectToLogin: route('/'),
-    // You want to redirect to the firstly UI ? change redirectToLogin to this 👇
-		// redirectToLogin: route('login'),
-		redirectAuthenticated: route('/app'),
-		redirect,
-	})
 )
 `,
     ],
@@ -390,8 +327,6 @@ export const load = (async (event) => {
 	import { Remult, remult } from 'remult'
 
   import { route } from '${libAlias}/ROUTES'
-  import SignIn from '${libAlias}/ui/SignIn.svelte'
-  import SignOut from '${libAlias}/ui/SignOut.svelte'
 
 import type { LayoutData } from './$types'
 
@@ -453,26 +388,10 @@ import type { LayoutData } from './$types'
 <h1>${pkg.name}</h1>
 
 {#if remult.authenticated()}
-  <div style="float:right;">
-    <SignOut></SignOut>
-  </div>
   <span>{remult.user?.name} ({remult.user?.roles})<br /><br /></span>
-{:else}
-  <SignIn demo="Ermin"></SignIn>
-  <SignIn demo="JYC"></SignIn>
-  <SignIn demo="Noam"></SignIn>
-  <br />
-  <SignIn ffLink></SignIn>
-  <br />
-  <SignIn oauth="github"></SignIn>
 {/if}
 
-<hr />
-
-<a href={route('/')}>Home</a> | 
-{#if remult.authenticated()}
-  <a href={route('/app')}>App (Protected route)</a> |
-{/if}
+<a href={route('/')}>Home</a> |
 <a href={route('/demo/task')}>Demo task</a>
 
 <hr />
@@ -523,7 +442,6 @@ export const load = (async (event) => {
     // Lib files
     './src/lib/index.ts': [
         `import { FF_Role } from '../internals'
-import { FF_Role_Auth } from '../auth'
 import { Log } from '@kitql/helpers'
 
 /**
@@ -536,81 +454,8 @@ export const log = new Log('${pkg.name}')
  */
 export const Role = {
 	Boss: 'Boss',
-	...FF_Role_Auth,
 	...FF_Role,
 } as const
-`,
-    ],
-    './src/lib/ui/SignIn.svelte': [
-        `<script lang="ts">
-  import { isError } from '../internals'
-  import { AuthController } from '../auth'
-
-  import { goto, invalidateAll } from '$app/navigation'
-
-  import { route } from '${libAlias}/ROUTES'
-
-  // Examples of signin modes
-  export let demo = ''
-  export let ffLink = false
-  export let oauth: 'github' | undefined = undefined
-
-  const signinDemo = async (identif: string) => {
-    try {
-      await AuthController.signInDemo(identif)
-      invalidateAll()
-    } catch (error) {
-      if (isError(error)) {
-        // You will probably not leave this alert in production
-        alert(error.message)
-      }
-    }
-  }
-
-  async function signinOAuth(provider: 'github') {
-    try {
-      window.location.href = await AuthController.signInOAuthGetUrl({
-        provider,
-        redirect: window.location.pathname,
-      })
-    } catch (error) {
-      if (isError(error)) {
-        // You will probably not leave this alert in production
-        alert(error.message)
-      }
-    }
-  }
-</script>
-
-{#if demo}
-  <button on:click={() => signinDemo(demo)}>Login as {demo}</button>
-{:else if ffLink}
-  <button on:click={() => goto(route('login'))}>Login with Firstly UI</button>
-{:else if oauth}
-  <button on:click={() => signinOAuth(oauth)}>Login With {oauth}</button>
-{/if}
-`,
-    ],
-    './src/lib/ui/SignOut.svelte': [
-        `<script lang="ts">
-  import { isError } from '../internals'
-  import { AuthController } from '../auth'
-
-  import { invalidateAll } from '$app/navigation'
-
-  const logout = async () => {
-    try {
-      await AuthController.signOut()
-      invalidateAll()
-    } catch (error) {
-      if (isError(error)) {
-        alert(error.message)
-      }
-    }
-  }
-</script>
-
-<button on:click={logout}>Logout</button>
 `,
     ],
     // Task module

package/esm/changeLog/index.d.ts

@@ -45,15 +45,10 @@ export declare const withChangeLog: <entityType>(options?: EntityOptions<entityT
     entityRefInit?: ((ref: import("remult").EntityRef<entityType>, row: entityType) => void) | undefined;
     apiRequireId?: import("remult").Allowed;
     dataProvider?: ((defaultDataProvider: import("remult").DataProvider) => import("remult").DataProvider | Promise<import("remult").DataProvider> | undefined | null) | undefined;
+    changeLog?: false | ColumnDeciderArgs<entityType> | undefined;
     ui?: {
         getLayout?: import("../svelte/customField").getLayout<entityType> | undefined;
     } | undefined;
     searchableFind?: ((str: string) => import("remult").FindOptionsBase<entityType>) | undefined;
     displayValue?: ((item: entityType) => import("../internals").BaseItem) | undefined;
-    permissionApiCrud?: import("../internals").BaseEnum[] | import("../internals").BaseEnum;
-    permissionApiDelete?: import("../internals").BaseEnum[] | import("../internals").BaseEnum;
-    permissionApiInsert?: import("../internals").BaseEnum[] | import("../internals").BaseEnum;
-    permissionApiRead?: import("../internals").BaseEnum[] | import("../internals").BaseEnum;
-    permissionApiUpdate?: import("../internals").BaseEnum[] | import("../internals").BaseEnum;
-    changeLog?: false | ColumnDeciderArgs<entityType> | undefined;
 };

package/esm/internals/BaseEnum.d.ts

@@ -8,7 +8,7 @@ export type FF_Icon = {
     caption?: string;
 };
 export type BaseItem = BaseEnumOptions & {
-    id: string;
+    id: string | null;
     captionSub?: string | (string | undefined)[];
     href?: string;
     repo?: Repository<any>;

package/esm/internals/FF_Entity.js

@@ -1,21 +1,5 @@
 import { Entity } from 'remult';
 import { withChangeLog } from '../changeLog';
-const toAllow = (permission) => {
-    if (permission) {
-        if (Array.isArray(permission)) {
-            return permission.map((p) => p.id);
-        }
-        return permission.id;
-    }
-    return undefined;
-};
 export function FF_Entity(key, options) {
-    return Entity(key, withChangeLog({
-        ...options,
-        allowApiCrud: options?.allowApiCrud ?? toAllow(options?.permissionApiCrud),
-        allowApiDelete: options?.allowApiDelete ?? toAllow(options?.permissionApiDelete),
-        allowApiInsert: options?.allowApiInsert ?? toAllow(options?.permissionApiInsert),
-        allowApiRead: options?.allowApiRead ?? toAllow(options?.permissionApiRead),
-        allowApiUpdate: options?.allowApiUpdate ?? toAllow(options?.permissionApiUpdate),
-    }));
+    return Entity(key, withChangeLog({ ...options }));
 }

package/esm/internals/cellsBuildor.js

@@ -98,9 +98,10 @@ export const buildWhere = (entity, defaultWhere, fields_filter, fields_search, o
         and.push(...buildSearchWhere(entity, fields_search, obj.search));
     }
     for (const field of fields_filter) {
-        // if there is a value
-        if (obj && obj[field.key]) {
-            const rfi = getRelationFieldInfo(field);
+        const rfi = getRelationFieldInfo(field);
+        // For relation fields, allow null as valid filter value (filters for NULL in DB)
+        const hasValue = rfi?.type === 'toOne' ? obj && obj[field.key] !== undefined : obj && obj[field.key];
+        if (hasValue) {
             if (field.inputType === 'checkbox') {
                 // @ts-ignore
                 and.push({ [field.key]: obj[field.key] });
@@ -127,7 +128,7 @@ export const buildWhere = (entity, defaultWhere, fields_filter, fields_search, o
                 }
             }
             else if (rfi?.type === 'toOne') {
-                // @ts-ignore (setting the id of the relation)
+                // @ts-ignore (setting the id of the relation, null = filter for NULL)
                 and.push({ [field.key]: obj[field.key] });
             }
             else {

package/esm/internals/index.d.ts

@@ -18,7 +18,7 @@ import { default as Link } from '../ui/link/Link.svelte';
 import { default as LinkPlus } from '../ui/link/LinkPlus.svelte';
 import { default as Loading } from '../ui/Loading.svelte';
 import { default as Tooltip } from '../ui/Tooltip.svelte';
-import type { BaseEnum, BaseItem, BaseItemLight, FF_Icon } from './BaseEnum.js';
+import type { BaseItem, BaseItemLight, FF_Icon } from './BaseEnum.js';
 import type { CellsInput } from './cellsBuildor.js';
 import { FF_Role } from './common.js';
 import { storeItem, type StoreItem } from './storeItem.js';
@@ -67,16 +67,12 @@ declare module 'remult' {
         };
         default_select_if_one_item?: boolean;
         multiSelect?: boolean;
+        filterNobodyLabel?: string;
         skipForDefaultField?: boolean;
     }
     interface EntityOptions<entityType> {
         searchableFind?: (str: string) => FindOptionsBase<entityType>;
         displayValue?: (item: entityType) => BaseItem;
-        permissionApiCrud?: BaseEnum[] | BaseEnum;
-        permissionApiDelete?: BaseEnum[] | BaseEnum;
-        permissionApiInsert?: BaseEnum[] | BaseEnum;
-        permissionApiRead?: BaseEnum[] | BaseEnum;
-        permissionApiUpdate?: BaseEnum[] | BaseEnum;
         changeLog?: false | ColumnDeciderArgs<entityType>;
     }
 }

package/esm/internals/storeItem.d.ts

@@ -1,28 +1,19 @@
-import type { ErrorInfo, FindOptions, Repository } from 'remult';
-export type StoreItem<T> = ReturnType<typeof storeItem<T>>;
-type TheStoreItem<T> = {
-    item: T | undefined;
-    loading?: boolean;
-    errors: ErrorInfo<T> | undefined;
-    globalError?: string | undefined;
-};
-export declare const storeItem: <T>(repo: Repository<T>, initValues?: TheStoreItem<T>) => {
-    subscribe: (this: void, run: import("svelte/store").Subscriber<TheStoreItem<T>>, invalidate?: () => void) => import("svelte/store").Unsubscriber;
+import type { EntityFilter, ErrorInfo, FindOptions, Repository } from 'remult';
+export interface StoreItem<T> {
+    subscribe: (run: (value: TheStoreItem<T>) => void) => () => void;
     create: (item: Partial<T>) => void;
     set: (newItem: TheStoreItem<T>) => void;
-    /**
-     * if you have keys, build the id with
-     * ```ts
-     * const id = repo.metadata.idMetadata.getId({a:1,b:2})
-     * store.fetch(id)
-     * ```
-     */
-    fetch: (id: Parameters<Repository<T>["findId"]>[0], options?: FindOptions<T>, onNewData?: (item: T) => void) => Promise<void>;
-    /**
-     * `.save()` will `update` or `insert` the current item.
-     */
+    fetch: (idOrWhere: string | number | EntityFilter<T>, options?: FindOptions<T>, onNewData?: (item: T | undefined) => void) => Promise<void>;
     save: () => Promise<T | undefined>;
     delete: () => Promise<void>;
     onChange: (prop: keyof T, callback: (newValue: any, oldValue: any) => void) => void;
+}
+type TheStoreItem<T> = {
+    item: T | undefined;
+    loading?: boolean;
+    initLoading?: boolean;
+    errors: ErrorInfo<T> | undefined;
+    globalError?: string | undefined;
 };
+export declare const storeItem: <T>(repo: Repository<T>, initValues?: TheStoreItem<T>) => StoreItem<T>;
 export {};

package/esm/internals/storeItem.js

@@ -5,6 +5,7 @@ import { isError } from './helper.js';
 export const storeItem = (repo, initValues = {
     item: undefined,
     loading: true,
+    initLoading: true,
     errors: undefined,
     globalError: undefined,
 }) => {
@@ -30,38 +31,50 @@ export const storeItem = (repo, initValues = {
             internalStore.set({
                 item: repo.create(item),
                 loading: false,
+                initLoading: false,
                 errors: {},
                 globalError: undefined,
             });
         },
         // set: internalStore.set,
         set: (newItem) => {
-            internalStore.update((s) => {
+            internalStore.update(() => {
                 return { ...newItem };
             });
         },
         /**
-         * if you have keys, build the id with
+         * Fetch by ID or WHERE clause
          * ```ts
+         * // By ID (string or number)
+         * store.fetch(123)
+         * store.fetch('abc')
+         *
+         * // By WHERE clause (object)
+         * store.fetch({ siteId: 123 })
+         *
+         * // With composite keys, build the id with
          * const id = repo.metadata.idMetadata.getId({a:1,b:2})
          * store.fetch(id)
          * ```
          */
-        fetch: async (id, options, onNewData) => {
+        fetch: async (idOrWhere, options, onNewData) => {
             if (BROWSER) {
                 internalStore.update((s) => ({ ...s, loading: true }));
                 try {
-                    const item = await repo.findId(id, options);
-                    // lastOptions = options
+                    const isId = typeof idOrWhere === 'string' || typeof idOrWhere === 'number';
+                    const item = isId
+                        ? await repo.findId(idOrWhere, options)
+                        : await repo.findFirst(idOrWhere, options);
                     internalStore.update((s) => ({
                         ...s,
                         loading: false,
+                        initLoading: false,
                         item: item ?? {},
                         errors: undefined,
                         globalError: undefined,
                     }));
                     if (onNewData) {
-                        onNewData(item ?? {});
+                        onNewData(item ?? undefined);
                     }
                 }
                 catch (error) {
@@ -69,6 +82,7 @@ export const storeItem = (repo, initValues = {
                         internalStore.update((s) => ({
                             ...s,
                             loading: false,
+                            initLoading: false,
                             item: {},
                             errors: {},
                             // @ts-ignore

package/esm/svelte/FF_Repo.svelte.d.ts

@@ -62,6 +62,15 @@ export declare class FF_Repo<Entity, QueryOptions extends QueryOptionsHelper<Ent
         aggregates: ExtractAggregateResult<Entity, QueryOptions>;
         hasNextPage: boolean;
     } | undefined>;
+    /**
+     * Refresh query keeping current items count (BIG refresh)
+     * Useful after edit/delete to stay at current scroll position
+     */
+    queryRefresh(options: Pick<QueryOptionsHelper<Entity>, 'where' | 'orderBy'>): Promise<{
+        items: Entity[];
+        aggregates: ExtractAggregateResult<Entity, QueryOptions>;
+        hasNextPage: boolean;
+    } | undefined>;
     create(...args: Parameters<Repository<Entity>['create']>): Entity;
     delete(...args: Parameters<Repository<Entity>['delete']>): Promise<undefined>;
     getLayout: getLayoutStrict<Entity>;

package/esm/svelte/FF_Repo.svelte.js

@@ -132,6 +132,45 @@ export class FF_Repo {
             hasNextPage: this.hasNextPage,
         });
     }
+    /**
+     * Refresh query keeping current items count (BIG refresh)
+     * Useful after edit/delete to stay at current scroll position
+     */
+    async queryRefresh(options) {
+        const currentCount = this.items?.length ?? this.#queryOptions?.pageSize ?? 25;
+        this.loading = {
+            ...this.loading,
+            fetching: true,
+            init: this.items === undefined,
+        };
+        const { data: queryResult, error: queryResultError } = tryCatchSync(() => this.#repo.query({
+            ...this.#queryOptions,
+            ...options,
+            pageSize: currentCount,
+            aggregate: {
+                ...this.#queryOptions?.aggregate,
+            },
+        }));
+        if (queryResultError) {
+            this.globalError = queryResultError.message;
+            return this.loadingEnd();
+        }
+        const { data: paginator, error: paginatorError } = await tryCatch(queryResult.paginator());
+        if (paginatorError) {
+            this.globalError = paginatorError.message;
+            return this.loadingEnd();
+        }
+        this.#paginator = paginator;
+        this.items = this.#paginator.items;
+        // @ts-expect-error - We know the structure will match due to how we define the types
+        this.aggregates = this.#paginator.aggregates;
+        this.hasNextPage = this.#paginator.hasNextPage && this.aggregates.$count > this.items.length;
+        return this.loadingEnd({
+            items: this.items,
+            aggregates: this.aggregates,
+            hasNextPage: this.hasNextPage,
+        });
+    }
     create(...args) {
         this.item = this.#repo.create(...args);
         return this.item;

package/esm/svelte/class/SP.svelte.js

@@ -7,6 +7,7 @@ import { goto } from '$app/navigation';
 import { page } from '$app/state';
 import { debounce } from '../helpers/debounce.js';
 const CONFIG_DELIMITER = ';';
+const NULL_URL_VALUE = '__null__';
 /**
  * SearchParams class for handling URL search parameters with Svelte 5 runes
  * Provides automatic binding and URL updates
@@ -257,6 +258,12 @@ export class SP {
             const urlKey = this.keyMap[propKey]; // Get the URL parameter key
             const paramValue = params.get(urlKey);
             if (paramValue !== null) {
+                // Decode null sentinel from URL
+                if (paramValue === NULL_URL_VALUE) {
+                    this.paramValues[propKey] = null;
+                    this.debouncedValues[propKey] = null;
+                    continue;
+                }
                 // If there is a decode function, always use it to get the proper object
                 if (def.decode) {
                     const decodedValue = def.decode(paramValue);
@@ -314,11 +321,16 @@ export class SP {
         }
         const params = new URLSearchParams(window.location.search);
         for (const [propKey, value] of Object.entries(this.debouncedValues)) {
-            // Skip undefined or null values
-            if (value === undefined || value === null) {
+            // Skip undefined values
+            if (value === undefined) {
                 params.delete(this.keyMap[propKey]);
                 continue;
             }
+            // Encode null as special URL value
+            if (value === null) {
+                params.set(this.keyMap[propKey], NULL_URL_VALUE);
+                continue;
+            }
             // Get the definition and URL key
             const def = this.config[propKey];
             if (!def)