firstly 0.1.1 → 0.1.3

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # firstly
 
+## 0.1.3
+
+### Patch Changes
+
+- [`2348b71`](https://github.com/jycouet/firstly/commit/2348b7172d67b2357daf6cc57fbbd69d13345505)
+  Thanks [@jycouet](https://github.com/jycouet)! - export `withChangeLog` to chain options for
+  `@Entity`
+
+- [`51cbd73`](https://github.com/jycouet/firstly/commit/51cbd7318797bf740627ae4cac8cc5074f7dab5e)
+  Thanks [@jycouet](https://github.com/jycouet)! - export @kitql/helper as `h`
+
+## 0.1.2
+
+### Patch Changes
+
+- [`e4d8b67`](https://github.com/jycouet/firstly/commit/e4d8b673787beee6d28e36aac1a404f49d690fb8)
+  Thanks [@jycouet](https://github.com/jycouet)! - export interface for `changeLog` Module
+
 ## 0.1.1
 
 ### Patch Changes

package/esm/auth/server/helperRole.js

@@ -41,8 +41,11 @@ export const linkRoleToUsersFromEnv = async (o) => {
             if (!user) {
                 user = repo(userEntity).create({ id: a.userId, name: nameify(providerUserId) });
             }
-            user.roles = [...new Set([...user.roles, ...roles].sort())];
-            await repo(userEntity).save(user);
+            const newRoles = [...new Set([...user.roles, ...roles].sort())];
+            if ((newRoles ?? []).join(',') !== (user.roles ?? []).join(',')) {
+                user.roles = newRoles;
+                await repo(userEntity).save(user);
+            }
         }
     }
     if (providersInfo.length > 0) {

package/esm/changeLog/index.d.ts

@@ -1,4 +1,4 @@
-import { type FieldRef, type FieldsRef, type LifecycleEvent } from 'remult';
+import { type EntityOptions, type FieldRef, type FieldsRef, type LifecycleEvent } from 'remult';
 import { Roles_ChangeLog, type change } from './changeLogEntities';
 export { Roles_ChangeLog };
 export type { change };
@@ -21,3 +21,39 @@ export declare class FieldDecider<entityType> {
     excludedValues: FieldRef<entityType>[];
     constructor(entity: entityType, options?: ColumnDeciderArgs<entityType>);
 }
+export declare const withChangeLog: <entityType>(options?: EntityOptions<entityType>) => {
+    saved: (entity: entityType, e: LifecycleEvent<entityType>) => Promise<void>;
+    deleted: (entity: entityType, e: LifecycleEvent<entityType>) => Promise<void>;
+    caption?: string;
+    label?: string;
+    allowApiRead?: import("remult").Allowed;
+    allowApiUpdate?: import("remult").AllowedForInstance<entityType> | undefined;
+    allowApiDelete?: import("remult").AllowedForInstance<entityType> | undefined;
+    allowApiInsert?: import("remult").AllowedForInstance<entityType> | undefined;
+    allowApiCrud?: import("remult").Allowed;
+    apiPrefilter?: import("remult").EntityFilter<entityType> | (() => import("remult").EntityFilter<entityType> | Promise<import("remult").EntityFilter<entityType>>) | undefined;
+    apiPreprocessFilter?: ((filter: import("remult").EntityFilter<entityType>, event: import("remult").PreprocessFilterEvent<entityType>) => import("remult").EntityFilter<entityType> | Promise<import("remult").EntityFilter<entityType>>) | undefined;
+    backendPreprocessFilter?: ((filter: import("remult").EntityFilter<entityType>, event: import("remult").PreprocessFilterEvent<entityType>) => import("remult").EntityFilter<entityType> | Promise<import("remult").EntityFilter<entityType>>) | undefined;
+    backendPrefilter?: import("remult").EntityFilter<entityType> | (() => import("remult").EntityFilter<entityType> | Promise<import("remult").EntityFilter<entityType>>) | undefined;
+    defaultOrderBy?: import("remult").EntityOrderBy<entityType> | undefined;
+    saving?: ((entity: entityType, event: LifecycleEvent<entityType>) => Promise<any> | any) | undefined;
+    deleting?: ((entity: entityType, e: LifecycleEvent<entityType>) => Promise<any> | any) | undefined;
+    validation?: ((entity: entityType, ref: LifecycleEvent<entityType>) => Promise<any> | any) | undefined;
+    dbName?: string;
+    sqlExpression?: string | ((entity: import("remult").EntityMetadata<entityType>) => string | Promise<string>) | undefined;
+    id?: keyof import("remult").MembersOnly<entityType> | (keyof import("remult").MembersOnly<entityType>)[] | import("remult").EntityIdFields<entityType> | ((entity: import("remult").FieldsMetadata<entityType>) => import("remult").FieldMetadata | import("remult").FieldMetadata[]) | undefined;
+    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;
+    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/changeLog/index.js

@@ -95,3 +95,31 @@ export class FieldDecider {
         this.fields = meta.fields.toArray().filter((f) => !this.excludedFields.includes(f));
     }
 }
+export const withChangeLog = (options) => {
+    return {
+        ...options,
+        // changesLogs
+        saved: async (entity, e) => {
+            await options?.saved?.(entity, e);
+            if (options?.changeLog === false) {
+                // Don't log changes
+            }
+            else {
+                if (isBackend()) {
+                    await recordSaved(entity, e, options?.changeLog);
+                }
+            }
+        },
+        deleted: async (entity, e) => {
+            await options?.deleted?.(entity, e);
+            if (options?.changeLog === false) {
+                // Don't log changes
+            }
+            else {
+                if (isBackend()) {
+                    await recordDeleted(entity, e, options?.changeLog);
+                }
+            }
+        },
+    };
+};

package/esm/changeLog/server/index.d.ts

@@ -1,14 +1,33 @@
 import { Module } from 'remult/server';
+import type { ColumnDeciderArgs } from '..';
+declare module 'remult' {
+    interface EntityOptions<entityType> {
+        changeLog?: false | ColumnDeciderArgs<entityType>;
+    }
+}
 /**
- * We suggest you to create your own `@APP_Entity` decorator and use it instead of `@Entity`.
- * Like this you opt-in to the change log feature Entity by Entity.
+ * ## Option 1
+ * Use the `withChangeLog` function to wrap your entity options.
+ *
+ * @example
+ * ```ts
+ * import { withChangeLog } from '..'
+ *
+ * \@Entity('users', withChangeLog({
+ *   // ...
+ * }))
+ * class User { }
+ * ```
+ * ## Option 2
+ * Create your own `@APP_Entity` decorator and use it instead of `@Entity`.
+ * Inside, it uses the `withChangeLog` function to wrap your entity options.
  *
  * @example
  * ```ts
  * // APP_Entity.ts example
  * import { Entity, isBackend, type EntityOptions } from 'remult'
  *
- * import { recordDeleted, recordSaved } from '..'
+ * import { withChangeLog } from '..'
  *
  * export function APP_Entity<entityType>(
  * 	key: string,
@@ -16,31 +35,7 @@ import { Module } from 'remult/server';
  * 		entityType extends new (...args: any) => any ? InstanceType<entityType> : entityType
  * 	>,
  * ) {
- * 	return Entity(key, {
- * 		...options,
- *
- * 		// changesLogs
- * 		saved: async (entity, e) => {
- * 			await options?.saved?.(entity, e)
- * 			if (options?.changeLog === false) {
- * 				// Don't log changes
- * 			} else {
- * 				if (isBackend()) {
- * 					await recordSaved(entity, e, options?.changeLog)
- * 				}
- * 			}
- * 		},
- * 		deleted: async (entity, e) => {
- * 			await options?.deleted?.(entity, e)
- * 			if (options?.changeLog === false) {
- * 				// Don't log changes
- * 			} else {
- * 				if (isBackend()) {
- * 					await recordDeleted(entity, e, options?.changeLog)
- * 				}
- * 			}
- * 		},
- * 	})
+ * 	return Entity(key, withChangeLog(options))
  * }
  * ```
  */

package/esm/changeLog/server/index.js

@@ -1,15 +1,28 @@
 import { Module } from 'remult/server';
 import { ChangeLog } from '../changeLogEntities';
 /**
- * We suggest you to create your own `@APP_Entity` decorator and use it instead of `@Entity`.
- * Like this you opt-in to the change log feature Entity by Entity.
+ * ## Option 1
+ * Use the `withChangeLog` function to wrap your entity options.
+ *
+ * @example
+ * ```ts
+ * import { withChangeLog } from '..'
+ *
+ * \@Entity('users', withChangeLog({
+ *   // ...
+ * }))
+ * class User { }
+ * ```
+ * ## Option 2
+ * Create your own `@APP_Entity` decorator and use it instead of `@Entity`.
+ * Inside, it uses the `withChangeLog` function to wrap your entity options.
  *
  * @example
  * ```ts
  * // APP_Entity.ts example
  * import { Entity, isBackend, type EntityOptions } from 'remult'
  *
- * import { recordDeleted, recordSaved } from '..'
+ * import { withChangeLog } from '..'
  *
  * export function APP_Entity<entityType>(
  * 	key: string,
@@ -17,31 +30,7 @@ import { ChangeLog } from '../changeLogEntities';
  * 		entityType extends new (...args: any) => any ? InstanceType<entityType> : entityType
  * 	>,
  * ) {
- * 	return Entity(key, {
- * 		...options,
- *
- * 		// changesLogs
- * 		saved: async (entity, e) => {
- * 			await options?.saved?.(entity, e)
- * 			if (options?.changeLog === false) {
- * 				// Don't log changes
- * 			} else {
- * 				if (isBackend()) {
- * 					await recordSaved(entity, e, options?.changeLog)
- * 				}
- * 			}
- * 		},
- * 		deleted: async (entity, e) => {
- * 			await options?.deleted?.(entity, e)
- * 			if (options?.changeLog === false) {
- * 				// Don't log changes
- * 			} else {
- * 				if (isBackend()) {
- * 					await recordDeleted(entity, e, options?.changeLog)
- * 				}
- * 			}
- * 		},
- * 	})
+ * 	return Entity(key, withChangeLog(options))
  * }
  * ```
  */

package/esm/index.d.ts

@@ -1,3 +1,5 @@
-import * as log from '@kitql/helpers';
-export { log };
-export declare const ff_Log: log.Log;
+import * as h from '@kitql/helpers';
+export { 
+/** alias for @kitql/helpers */
+h, };
+export declare const ff_Log: h.Log;

package/esm/index.js

@@ -1,3 +1,5 @@
-import * as log from '@kitql/helpers';
-export { log };
-export const ff_Log = new log.Log('firstly');
+import * as h from '@kitql/helpers';
+export { 
+/** alias for @kitql/helpers */
+h, };
+export const ff_Log = new h.Log('firstly');

package/esm/internals/FF_Entity.js

@@ -1,5 +1,5 @@
-import { Entity, isBackend } from 'remult';
-import { recordDeleted, recordSaved } from '../changeLog';
+import { Entity } from 'remult';
+import { withChangeLog } from '../changeLog';
 const toAllow = (permission) => {
     if (permission) {
         if (Array.isArray(permission)) {
@@ -10,35 +10,12 @@ const toAllow = (permission) => {
     return undefined;
 };
 export function FF_Entity(key, options) {
-    return Entity(key, {
+    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),
-        // changesLogs
-        saved: async (entity, e) => {
-            await options?.saved?.(entity, e);
-            if (options?.changeLog === false) {
-                // Don't log changes
-            }
-            else {
-                if (isBackend()) {
-                    await recordSaved(entity, e, options?.changeLog);
-                }
-            }
-        },
-        deleted: async (entity, e) => {
-            await options?.deleted?.(entity, e);
-            if (options?.changeLog === false) {
-                // Don't log changes
-            }
-            else {
-                if (isBackend()) {
-                    await recordDeleted(entity, e, options?.changeLog);
-                }
-            }
-        },
-    });
+    }));
 }

package/esm/mail/server/index.d.ts

@@ -7,6 +7,11 @@ import type SMTPTransport from 'nodemailer/lib/smtp-transport';
 import type StreamTransport from 'nodemailer/lib/stream-transport';
 import { Module } from 'remult/server';
 import { type MailStyle } from './formatMailHelper';
+declare module 'remult' {
+    interface RemultContext {
+        sendMail?: SendMail;
+    }
+}
 export type TransportTypes = SMTPPool | SMTPPool.Options | SendmailTransport | SendmailTransport.Options | StreamTransport | StreamTransport.Options | JSONTransport | JSONTransport.Options | SESTransport | SESTransport.Options | SMTPTransport | SMTPTransport.Options | string;
 export type DefaultOptions = typeNodemailer.SendMailOptions;
 type GlobalEasyOptions = {
@@ -25,11 +30,6 @@ export type MailOptions = GlobalEasyOptions & {
     };
 };
 declare let transporter: ReturnType<typeof typeNodemailer.createTransport>;
-declare module 'remult' {
-    interface RemultContext {
-        sendMail?: SendMail;
-    }
-}
 export type SendMail = typeof sendMail;
 export declare const sendMail: (
 /** usefull for logs, it has NO impact on the mail itself */

package/esm/svelte/FF_Cell.svelte

@@ -15,6 +15,7 @@
 		class?: string
 	}
 
+	// eslint-disable-next-line svelte/no-unused-props
 	let props: Props<valueType, entityType> = $props()
 
 	// let classes = $derived(getClasses('field', props.classes))

package/esm/svelte/FF_Grid.svelte

@@ -6,7 +6,7 @@
 	import { dialog, FF_Display, FF_Repo, getClasses, type GridTheme } from './'
 
 	interface Props<entityType> {
-		uid?: string
+		// uid?: string
 		r: FF_Repo<entityType>
 		fields?: FieldMetadata<unknown, entityType>[]
 		showCreate?: boolean

package/esm/svelte/FF_Grid.svelte.d.ts

@@ -1,7 +1,6 @@
 import { type FieldMetadata } from 'remult';
 import { FF_Repo, type GridTheme } from './';
 interface Props<entityType> {
-    uid?: string;
     r: FF_Repo<entityType>;
     fields?: FieldMetadata<unknown, entityType>[];
     showCreate?: boolean;

package/esm/ui/Button.svelte

@@ -81,7 +81,6 @@
 
 <button
 	{...$trigger}
-	use:trigger
 	use:isAllowed={{ permission }}
 	on:click
 	{...$$restProps}
@@ -100,11 +99,10 @@
 {#if $open && (disabledWhy || $$slots.tooltip)}
 	<div
 		{...$content}
-		use:content
 		transition:fade={{ duration: 100 }}
 		class="z-30 rounded-lg bg-base-300 ring-1 ring-black"
 	>
-		<div {...$arrow} use:arrow></div>
+		<div {...$arrow}></div>
 		<div class="px-4 py-1">
 			{#if $$slots.tooltip}
 				<slot name="tooltip" />

package/esm/ui/Field.svelte

@@ -22,6 +22,7 @@
 	import SelectMelt from './internals/select/SelectMelt.svelte'
 	import SelectRadio from './internals/select/SelectRadio.svelte'
 	import Textarea from './internals/Textarea.svelte'
+	import { LibIcon_Eye, LibIcon_EyeOff } from './LibIcon'
 	import LinkPlus from './link/LinkPlus.svelte'
 
 	export let cell: Cell<T>
@@ -188,6 +189,8 @@
 
 		return ''
 	}
+
+	let textpsdVisible = false
 </script>
 
 <FieldContainer
@@ -296,7 +299,7 @@
 				}}
 			/>
 		</div>
-	{:else if metaType.subKind === 'text' || metaType.subKind === 'email' || metaType.subKind === 'password' || metaType.subKind === 'dateOnly' || metaType.subKind === 'number'}
+	{:else if metaType.subKind === 'text' || metaType.subKind === 'email' || metaType.subKind === 'password' || metaType.subKind === 'dateOnly' || metaType.subKind === 'number' || metaType.subKind === 'textpsd'}
 		<div class="input input-bordered inline-flex w-full items-center pl-2">
 			<Input
 				{focus}
@@ -306,7 +309,10 @@
 					`join-item w-full bg-transparent placeholder:text-base-content/30`,
 					metaType.subKind === 'number' && 'text-end',
 				)}
-				type={metaType.subKind.replaceAll('dateOnly', 'date')}
+				style={cell.field?.inputType === 'textpsd' && textpsdVisible === false
+					? 'filter: blur(0.2rem)'
+					: ''}
+				type={metaType.subKind.replaceAll('dateOnly', 'date').replaceAll('textpsd', 'text')}
 				value={toInput(cell.field, value)}
 				{withDedounce}
 				on:input={(e) => {
@@ -317,6 +323,17 @@
 				{...$$restProps}
 			/>
 			{calcSuffix(value)}
+			{#if cell.field?.inputType === 'textpsd'}
+				<button
+					on:click={(e) => {
+						e.preventDefault()
+						textpsdVisible = !textpsdVisible
+					}}
+					class="btn-ghost btn-sm"
+				>
+					<Icon data={textpsdVisible ? LibIcon_Eye : LibIcon_EyeOff} />
+				</button>
+			{/if}
 		</div>
 	{:else if metaType.subKind === 'textarea'}
 		<Textarea

package/esm/ui/LibIcon.d.ts

@@ -8,6 +8,8 @@ export declare const LibIcon_Search: string;
 export declare const LibIcon_Check: string;
 export declare const LibIcon_MultiCheck: string;
 export declare const LibIcon_Add: string;
+export declare const LibIcon_Eye: string;
+export declare const LibIcon_EyeOff: string;
 export declare const LibIcon_MultiAdd: string;
 export declare const LibIcon_Edit: string;
 export declare const LibIcon_Delete: string;

package/esm/ui/LibIcon.js

@@ -1,6 +1,6 @@
 // Lib Icons
 // https://icones.js.org/ and https://pictogrammers.com/library/mdi/
-import { mdiAccountTie, mdiAccountTieWoman, mdiCancel, mdiCheck, mdiCheckAll, mdiChevronDown, mdiChevronLeft, mdiChevronRight, mdiChevronUp, mdiCloseCircleOutline, mdiCogOutline, mdiContentSaveEdit, mdiDelete, mdiLoading, mdiMagnify, mdiPencil, mdiPlusBoxMultiple, mdiPlusCircle, mdiSend, mdiSort, mdiSortReverseVariant, mdiSortVariant, } from '@mdi/js';
+import { mdiAccountTie, mdiAccountTieWoman, mdiCancel, mdiCheck, mdiCheckAll, mdiChevronDown, mdiChevronLeft, mdiChevronRight, mdiChevronUp, mdiCloseCircleOutline, mdiCogOutline, mdiContentSaveEdit, mdiDelete, mdiEye, mdiEyeOff, mdiLoading, mdiMagnify, mdiPencil, mdiPlusBoxMultiple, mdiPlusCircle, mdiSend, mdiSort, mdiSortReverseVariant, mdiSortVariant, } from '@mdi/js';
 export const LibIcon_Empty = ``;
 export const LibIcon_Forbidden = mdiCancel;
 export const LibIcon_ChevronDown = mdiChevronDown;
@@ -11,6 +11,8 @@ export const LibIcon_Search = mdiMagnify;
 export const LibIcon_Check = mdiCheck;
 export const LibIcon_MultiCheck = mdiCheckAll;
 export const LibIcon_Add = mdiPlusCircle;
+export const LibIcon_Eye = mdiEye;
+export const LibIcon_EyeOff = mdiEyeOff;
 export const LibIcon_MultiAdd = mdiPlusBoxMultiple;
 export const LibIcon_Edit = mdiPencil;
 export const LibIcon_Delete = mdiDelete;

package/esm/ui/Tooltip.svelte

@@ -22,18 +22,17 @@
 	})
 </script>
 
-<button type="button" class="trigger" {...$trigger} use:trigger aria-label="Add">
+<button type="button" class="trigger" {...$trigger} aria-label="Add">
 	<slot />
 </button>
 <!-- {hideTooltip} -->
 {#if $open && !hideTooltip && (text || $$slots.tooltip)}
 	<div
 		{...$content}
-		use:content
 		transition:fade={{ duration: 100 }}
 		class="z-30 rounded-lg bg-base-300 ring-1 ring-black"
 	>
-		<div {...$arrow} use:arrow></div>
+		<div {...$arrow}></div>
 		<div class="px-4 py-1">
 			{#if $$slots.tooltip}
 				<slot name="tooltip" />

package/esm/ui/internals/select/SelectMelt.svelte

@@ -239,31 +239,28 @@
 				</li>
 			{:else}
 				{#if createOptionWhenNoResult}
-					<div class="p-4">
-						<Button
-							class="w-full"
-							on:click={async () => {
-								await createRequest?.({ input: $inputValue, id })
-								// const newValue = await createRequest?.({ input: $inputValue, id })
-								// if (newValue) {
-								// 	items.push(newValue)
-								// 	filteredItems.push(newValue)
-								// 	sync.selected(toOption(newValue))
-								// 	$open = false
-								// }
-								$open = false
-							}}
-						>
-							<div class="flex items-center gap-2">
-								<Icon data={LibIcon_Add}></Icon>
-								{#if $inputValue}
-									Créer "{$inputValue}"
-								{:else}
-									Créer
-								{/if}
-							</div>
-						</Button>
-					</div>
+					{#if $inputValue}
+						<div class="p-4">
+							<Button
+								class="w-full"
+								on:click={async () => {
+									createRequest?.({ input: $inputValue, id })
+									$open = false
+								}}
+							>
+								<div class="flex items-center gap-2">
+									<Icon data={LibIcon_Add}></Icon>
+									{#if $inputValue}
+										Créer "{$inputValue}"
+									{/if}
+								</div>
+							</Button>
+						</div>
+					{:else}
+						<li class="relative cursor-pointer rounded-md py-1 pl-8 pr-4 text-sm">
+							Il faut tenter de rechercher avant de créer un nouvel élément
+						</li>
+					{/if}
 				{:else}
 					<li class="relative cursor-pointer rounded-md py-1 pl-8 pr-4">Aucun résultat</li>
 				{/if}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firstly",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "type": "module",
   "description": "Firstly, an opinionated Remult setup!",
   "funding": "https://github.com/sponsors/jycouet",