@axium/notes 0.3.14 → 0.4.0

package/db.json

@@ -59,6 +59,16 @@
 					}
 				}
 			}
+		},
+		{
+			"delta": true,
+			"alter_tables": {
+				"notes": {
+					"add_columns": {
+						"pinned": { "type": "boolean", "required": true, "default": false }
+					}
+				}
+			}
 		}
 	],
 	"wipe": ["notes", "acl.notes"],

package/dist/common.d.ts

@@ -3,6 +3,7 @@ export declare const NoteInit: z.ZodObject<{
     title: z.ZodString;
     content: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     labels: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    pinned: z.ZodDefault<z.ZodBoolean>;
 }, z.core.$strip>;
 export interface NoteInit extends z.infer<typeof NoteInit> {
 }
@@ -10,10 +11,32 @@ export declare const Note: z.ZodObject<{
     title: z.ZodString;
     content: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     labels: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    pinned: z.ZodDefault<z.ZodBoolean>;
     id: z.ZodUUID;
     userId: z.ZodUUID;
     created: z.ZodCoercedDate<unknown>;
     modified: z.ZodCoercedDate<unknown>;
+    acl: z.ZodArray<z.ZodObject<{
+        itemId: z.ZodUUID;
+        userId: z.ZodOptional<z.ZodNullable<z.ZodUUID>>;
+        role: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        tag: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        user: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            id: z.ZodUUID;
+            name: z.ZodString;
+            email: z.ZodOptional<z.ZodEmail>;
+            emailVerified: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodCoercedDate<unknown>>>>;
+            preferences: z.ZodOptional<z.ZodLazy<z.ZodObject<{
+                debug: z.ZodDefault<z.ZodBoolean>;
+            }, z.core.$strip>>>;
+            roles: z.ZodArray<z.ZodString>;
+            tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            registeredAt: z.ZodCoercedDate<unknown>;
+            isAdmin: z.ZodOptional<z.ZodBoolean>;
+            isSuspended: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strip>>>;
+        createdAt: z.ZodCoercedDate<unknown>;
+    }, z.core.$catchall<z.ZodBoolean>>>;
 }, z.core.$strip>;
 export interface Note extends z.infer<typeof Note> {
 }
@@ -23,23 +46,68 @@ declare const NotesAPI: {
             title: z.ZodString;
             content: z.ZodOptional<z.ZodNullable<z.ZodString>>;
             labels: z.ZodDefault<z.ZodArray<z.ZodString>>;
+            pinned: z.ZodDefault<z.ZodBoolean>;
             id: z.ZodUUID;
             userId: z.ZodUUID;
             created: z.ZodCoercedDate<unknown>;
             modified: z.ZodCoercedDate<unknown>;
+            acl: z.ZodArray<z.ZodObject<{
+                itemId: z.ZodUUID;
+                userId: z.ZodOptional<z.ZodNullable<z.ZodUUID>>;
+                role: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                tag: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                user: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+                    id: z.ZodUUID;
+                    name: z.ZodString;
+                    email: z.ZodOptional<z.ZodEmail>;
+                    emailVerified: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodCoercedDate<unknown>>>>;
+                    preferences: z.ZodOptional<z.ZodLazy<z.ZodObject<{
+                        debug: z.ZodDefault<z.ZodBoolean>;
+                    }, z.core.$strip>>>;
+                    roles: z.ZodArray<z.ZodString>;
+                    tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
+                    registeredAt: z.ZodCoercedDate<unknown>;
+                    isAdmin: z.ZodOptional<z.ZodBoolean>;
+                    isSuspended: z.ZodOptional<z.ZodBoolean>;
+                }, z.core.$strip>>>;
+                createdAt: z.ZodCoercedDate<unknown>;
+            }, z.core.$catchall<z.ZodBoolean>>>;
         }, z.core.$strip>>;
         readonly PUT: readonly [z.ZodObject<{
             title: z.ZodString;
             content: z.ZodOptional<z.ZodNullable<z.ZodString>>;
             labels: z.ZodDefault<z.ZodArray<z.ZodString>>;
+            pinned: z.ZodDefault<z.ZodBoolean>;
         }, z.core.$strip>, z.ZodObject<{
             title: z.ZodString;
             content: z.ZodOptional<z.ZodNullable<z.ZodString>>;
             labels: z.ZodDefault<z.ZodArray<z.ZodString>>;
+            pinned: z.ZodDefault<z.ZodBoolean>;
             id: z.ZodUUID;
             userId: z.ZodUUID;
             created: z.ZodCoercedDate<unknown>;
             modified: z.ZodCoercedDate<unknown>;
+            acl: z.ZodArray<z.ZodObject<{
+                itemId: z.ZodUUID;
+                userId: z.ZodOptional<z.ZodNullable<z.ZodUUID>>;
+                role: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                tag: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                user: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+                    id: z.ZodUUID;
+                    name: z.ZodString;
+                    email: z.ZodOptional<z.ZodEmail>;
+                    emailVerified: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodCoercedDate<unknown>>>>;
+                    preferences: z.ZodOptional<z.ZodLazy<z.ZodObject<{
+                        debug: z.ZodDefault<z.ZodBoolean>;
+                    }, z.core.$strip>>>;
+                    roles: z.ZodArray<z.ZodString>;
+                    tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
+                    registeredAt: z.ZodCoercedDate<unknown>;
+                    isAdmin: z.ZodOptional<z.ZodBoolean>;
+                    isSuspended: z.ZodOptional<z.ZodBoolean>;
+                }, z.core.$strip>>>;
+                createdAt: z.ZodCoercedDate<unknown>;
+            }, z.core.$catchall<z.ZodBoolean>>>;
         }, z.core.$strip>];
     };
     readonly 'notes/:id': {
@@ -47,32 +115,99 @@ declare const NotesAPI: {
             title: z.ZodString;
             content: z.ZodOptional<z.ZodNullable<z.ZodString>>;
             labels: z.ZodDefault<z.ZodArray<z.ZodString>>;
+            pinned: z.ZodDefault<z.ZodBoolean>;
             id: z.ZodUUID;
             userId: z.ZodUUID;
             created: z.ZodCoercedDate<unknown>;
             modified: z.ZodCoercedDate<unknown>;
+            acl: z.ZodArray<z.ZodObject<{
+                itemId: z.ZodUUID;
+                userId: z.ZodOptional<z.ZodNullable<z.ZodUUID>>;
+                role: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                tag: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                user: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+                    id: z.ZodUUID;
+                    name: z.ZodString;
+                    email: z.ZodOptional<z.ZodEmail>;
+                    emailVerified: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodCoercedDate<unknown>>>>;
+                    preferences: z.ZodOptional<z.ZodLazy<z.ZodObject<{
+                        debug: z.ZodDefault<z.ZodBoolean>;
+                    }, z.core.$strip>>>;
+                    roles: z.ZodArray<z.ZodString>;
+                    tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
+                    registeredAt: z.ZodCoercedDate<unknown>;
+                    isAdmin: z.ZodOptional<z.ZodBoolean>;
+                    isSuspended: z.ZodOptional<z.ZodBoolean>;
+                }, z.core.$strip>>>;
+                createdAt: z.ZodCoercedDate<unknown>;
+            }, z.core.$catchall<z.ZodBoolean>>>;
         }, z.core.$strip>;
         readonly PATCH: readonly [z.ZodObject<{
             title: z.ZodString;
             content: z.ZodOptional<z.ZodNullable<z.ZodString>>;
             labels: z.ZodDefault<z.ZodArray<z.ZodString>>;
+            pinned: z.ZodDefault<z.ZodBoolean>;
         }, z.core.$strip>, z.ZodObject<{
             title: z.ZodString;
             content: z.ZodOptional<z.ZodNullable<z.ZodString>>;
             labels: z.ZodDefault<z.ZodArray<z.ZodString>>;
+            pinned: z.ZodDefault<z.ZodBoolean>;
             id: z.ZodUUID;
             userId: z.ZodUUID;
             created: z.ZodCoercedDate<unknown>;
             modified: z.ZodCoercedDate<unknown>;
+            acl: z.ZodArray<z.ZodObject<{
+                itemId: z.ZodUUID;
+                userId: z.ZodOptional<z.ZodNullable<z.ZodUUID>>;
+                role: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                tag: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                user: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+                    id: z.ZodUUID;
+                    name: z.ZodString;
+                    email: z.ZodOptional<z.ZodEmail>;
+                    emailVerified: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodCoercedDate<unknown>>>>;
+                    preferences: z.ZodOptional<z.ZodLazy<z.ZodObject<{
+                        debug: z.ZodDefault<z.ZodBoolean>;
+                    }, z.core.$strip>>>;
+                    roles: z.ZodArray<z.ZodString>;
+                    tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
+                    registeredAt: z.ZodCoercedDate<unknown>;
+                    isAdmin: z.ZodOptional<z.ZodBoolean>;
+                    isSuspended: z.ZodOptional<z.ZodBoolean>;
+                }, z.core.$strip>>>;
+                createdAt: z.ZodCoercedDate<unknown>;
+            }, z.core.$catchall<z.ZodBoolean>>>;
         }, z.core.$strip>];
         readonly DELETE: z.ZodObject<{
             title: z.ZodString;
             content: z.ZodOptional<z.ZodNullable<z.ZodString>>;
             labels: z.ZodDefault<z.ZodArray<z.ZodString>>;
+            pinned: z.ZodDefault<z.ZodBoolean>;
             id: z.ZodUUID;
             userId: z.ZodUUID;
             created: z.ZodCoercedDate<unknown>;
             modified: z.ZodCoercedDate<unknown>;
+            acl: z.ZodArray<z.ZodObject<{
+                itemId: z.ZodUUID;
+                userId: z.ZodOptional<z.ZodNullable<z.ZodUUID>>;
+                role: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                tag: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                user: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+                    id: z.ZodUUID;
+                    name: z.ZodString;
+                    email: z.ZodOptional<z.ZodEmail>;
+                    emailVerified: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodCoercedDate<unknown>>>>;
+                    preferences: z.ZodOptional<z.ZodLazy<z.ZodObject<{
+                        debug: z.ZodDefault<z.ZodBoolean>;
+                    }, z.core.$strip>>>;
+                    roles: z.ZodArray<z.ZodString>;
+                    tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
+                    registeredAt: z.ZodCoercedDate<unknown>;
+                    isAdmin: z.ZodOptional<z.ZodBoolean>;
+                    isSuspended: z.ZodOptional<z.ZodBoolean>;
+                }, z.core.$strip>>>;
+                createdAt: z.ZodCoercedDate<unknown>;
+            }, z.core.$catchall<z.ZodBoolean>>>;
         }, z.core.$strip>;
     };
 };

package/dist/common.js

@@ -1,15 +1,18 @@
+import { AccessControl } from '@axium/core';
 import { $API } from '@axium/core/api';
 import * as z from 'zod';
 export const NoteInit = z.object({
     title: z.string().max(100),
     content: z.string().max(10_000).nullish(),
     labels: z.array(z.string().max(30)).default([]),
+    pinned: z.boolean().default(false),
 });
 export const Note = NoteInit.extend({
     id: z.uuid(),
     userId: z.uuid(),
     created: z.coerce.date(),
     modified: z.coerce.date(),
+    acl: AccessControl.array(),
 });
 const NotesAPI = {
     'users/:id/notes': {

package/dist/server.d.ts

@@ -1,5 +1,5 @@
-import type schema from '../db.json';
 import type { FromFile as FromSchemaFile } from '@axium/server/db/schema';
+import type schema from '../db.json';
 declare module '@axium/server/database' {
     interface Schema extends FromSchemaFile<typeof schema> {
     }

package/dist/server.js

@@ -1,3 +1,4 @@
+import * as acl from '@axium/server/acl';
 import { authRequestForItem, checkAuthForUser } from '@axium/server/auth';
 import { database } from '@axium/server/database';
 import { parseBody, withError } from '@axium/server/requests';
@@ -8,23 +9,26 @@ addRoute({
     path: '/api/users/:id/notes',
     params: { id: z.uuid() },
     async GET(request, { id: userId }) {
-        await checkAuthForUser(request, userId);
+        const { user } = await checkAuthForUser(request, userId);
         return await database
             .selectFrom('notes')
             .selectAll()
-            .where('userId', '=', userId)
+            .select(acl.from('notes'))
+            .where(eb => eb.or([eb('userId', '=', userId), acl.existsIn('notes', user)(eb)]))
+            .orderBy('pinned', 'desc')
+            .orderBy('modified', 'desc')
             .execute()
             .catch(withError('Could not get notes'));
     },
     async PUT(request, { id: userId }) {
         const init = await parseBody(request, NoteInit);
         await checkAuthForUser(request, userId);
-        return await database
+        return Object.assign(await database
             .insertInto('notes')
             .values({ ...init, userId })
             .returningAll()
             .executeTakeFirstOrThrow()
-            .catch(withError('Could not create note'));
+            .catch(withError('Could not create note')), { acl: [] });
     },
 });
 addRoute({
@@ -43,6 +47,7 @@ addRoute({
             .set('modified', new Date())
             .where('id', '=', id)
             .returningAll()
+            .returning(acl.from('notes'))
             .executeTakeFirstOrThrow()
             .catch(withError('Could not update note'));
     },
@@ -52,6 +57,7 @@ addRoute({
             .deleteFrom('notes')
             .where('id', '=', id)
             .returningAll()
+            .returning(acl.from('notes'))
             .executeTakeFirstOrThrow()
             .catch(withError('Could not delete note'));
     },

package/lib/Note.svelte

@@ -6,6 +6,7 @@
 	import { AccessControlDialog, Icon, Popover } from '@axium/client/components';
 	import { copy } from '@axium/client/gui';
 	import { toastStatus } from '@axium/client/toast';
+	import { checkAndMatchACL, type UserPublic } from '@axium/core';
 	import type { Note } from '@axium/notes/common';
 	import { download } from 'utilium/dom';
 
@@ -16,50 +17,66 @@
 		user,
 	}: { note: Note; notes?: Note[]; pageMode?: boolean; user?: UserPublic } = $props();
 
-	let acl = $state<HTMLDialogElement>();
+	const canEdit = user && (user.id === note.userId || !checkAndMatchACL(note.acl, user, { edit: true }).size);
+	const canManage = user && (user.id === note.userId || !checkAndMatchACL(note.acl, user, { manage: true }).size);
 </script>
 
 <div class={['note', pageMode && 'full-page']}>
 	<div class="note-header">
-		<input
-			type="text"
-			bind:value={note.title}
-			placeholder="Unnamed Note"
-			class="editable-text"
-			oninput={e => {
-				note.title = e.currentTarget.value;
-				fetchAPI('PATCH', 'notes/:id', note, note.id);
-			}}
-		/>
+		{#if note.pinned}
+			<div class="pin"><Icon i="thumbtack" /></div>
+		{/if}
+		{#if canEdit}
+			<input
+				type="text"
+				bind:value={note.title}
+				placeholder="Unnamed Note"
+				class="note-title"
+				oninput={e => {
+					note.title = e.currentTarget.value;
+					fetchAPI('PATCH', 'notes/:id', note, note.id);
+				}}
+			/>
+		{:else}
+			<span class="note-title">{note.title}</span>
+		{/if}
 		<Popover showToggle="hover">
-			<div
-				class="menu-item"
-				onclick={() =>
-					toastStatus(
-						fetchAPI('DELETE', 'notes/:id', {}, note.id).then(() => {
-							if (!notes) goto('/notes');
-							else notes.splice(notes.indexOf(note), 1);
-						}),
-						text('notes.toast_deleted')
-					)}
-			>
-				<Icon i="trash" />
-				<span>{text('generic.delete')}</span>
-			</div>
+			{#if canEdit}
+				<div
+					class="menu-item"
+					onclick={() => {
+						note.pinned = !note.pinned;
+						fetchAPI('PATCH', 'notes/:id', note, note.id);
+					}}
+				>
+					<Icon i="thumbtack{note.pinned ? '-slash' : ''}" />
+					<span>{note.pinned ? text('notes.unpin') : text('notes.pin')}</span>
+				</div>
+			{/if}
+			{#if canManage}
+				<div
+					class="menu-item"
+					onclick={() =>
+						toastStatus(
+							fetchAPI('DELETE', 'notes/:id', {}, note.id).then(() => {
+								if (!notes) goto('/notes');
+								else notes.splice(notes.indexOf(note), 1);
+							}),
+							text('notes.toast_deleted')
+						)}
+				>
+					<Icon i="trash" />
+					<span>{text('generic.delete')}</span>
+				</div>
+			{/if}
 			<div class="menu-item" onclick={() => download(note.title + '.txt', note.content ?? '')}>
 				<Icon i="download" />
 				<span>{text('notes.download')}</span>
 			</div>
-			<div
-				class="menu-item"
-				onclick={() => {
-					acl!.showModal();
-					acl!.click();
-				}}
-			>
+			<button class="reset menu-item" command="show-modal" commandfor="acl#{note.id}">
 				<Icon i="user-group" />
 				<span>{text('notes.share')}</span>
-			</div>
+			</button>
 			<div class="menu-item" onclick={() => copy('text/plain', `${location.origin}/notes/${note.id}`)}>
 				<Icon i="link-horizontal" />
 				<span>{text('notes.copy_link')}</span>
@@ -77,24 +94,39 @@
 				</div>
 			{/if}
 		</Popover>
-		<AccessControlDialog bind:dialog={acl} item={note} itemType="notes" {user} />
+		<AccessControlDialog item={note} itemType="notes" {user} id="acl#{note.id}" />
 	</div>
-	<textarea
-		bind:value={note.content}
-		name="content"
-		class="editable-text"
-		placeholder={text('notes.content_placeholder')}
-		oninput={() => fetchAPI('PATCH', 'notes/:id', note, note.id)}
-		{@attach dynamicRows()}>{note.content}</textarea
-	>
+	{#if canEdit}
+		<textarea
+			bind:value={note.content}
+			name="content"
+			class="note-content"
+			placeholder={text('notes.content_placeholder')}
+			oninput={() => fetchAPI('PATCH', 'notes/:id', note, note.id)}
+			{@attach dynamicRows()}>{note.content}</textarea
+		>
+	{:else}
+		<div class="note-content">
+			{#if note.content}
+				<span>{note.content}</span>
+			{:else}
+				<i class="subtle">{text('notes.content_missing')}</i>
+			{/if}
+		</div>
+	{/if}
 </div>
 
 <style>
-	.editable-text {
+	.note-title,
+	.note-content {
 		background: none;
 		border: none;
 	}
 
+	div.note-content i.subtle {
+		font-size: inherit;
+	}
+
 	.note {
 		display: flex;
 		flex-direction: column;
@@ -106,13 +138,6 @@
 		height: fit-content;
 		max-height: 40em;
 		anchor-name: --note;
-
-		textarea {
-			resize: none;
-			field-sizing: content;
-			height: max-content;
-			overflow-y: scroll;
-		}
 	}
 
 	.note.full-page {
@@ -125,7 +150,11 @@
 		justify-content: space-between;
 		align-items: center;
 
-		input {
+		.pin {
+			flex: 0 0 auto;
+		}
+
+		.note-title {
 			font-size: 1.5em;
 			font-weight: bold;
 			padding: 0;

package/locales/en.json

@@ -5,13 +5,16 @@
 	"notes": {
 		"back_to_main": "Back to Notes",
 		"content_placeholder": "It's a beautiful day outside...",
+		"content_missing": "This note is shared with you but has no content.",
 		"copy_id": "Copy ID",
-		"copy_link": "Copy Link",
+		"copy_link": "Copy link",
 		"download": "Download",
-		"new": "New Note",
+		"new": "New note",
 		"note_title": "Notes — {title}",
-		"open_new_tab": "Open in New Tab",
+		"open_new_tab": "Open in new tab",
 		"share": "Share",
-		"toast_deleted": "Note deleted"
+		"toast_deleted": "Note deleted",
+		"pin": "Pin note",
+		"unpin": "Unpin note"
 	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@axium/notes",
-	"version": "0.3.14",
+	"version": "0.4.0",
 	"author": "James Prevett <axium@jamespre.dev>",
 	"description": "Notes for Axium",
 	"funding": {

package/routes/notes/+page.svelte

@@ -7,6 +7,9 @@
 	const { data } = $props();
 
 	let notes = $state(data.notes);
+	$effect(() => {
+		notes.sort((a, b) => +!!b.pinned - +!!a.pinned);
+	});
 </script>
 
 <svelte:head>
@@ -48,6 +51,7 @@
 
 	.lists-container {
 		display: grid;
+		display: grid-lanes;
 		grid-template-columns: repeat(auto-fill, minmax(400px, 1fr));
 		gap: 1em;
 	}