@axium/storage 0.1.4 → 0.2.0

package/dist/client.d.ts

@@ -1,5 +1,6 @@
 import type { StorageItemMetadata, StorageItemUpdate, UserFilesInfo } from './common.js';
 import type { ItemSelection } from './selection.js';
+export declare function parseItem(result: StorageItemMetadata): StorageItemMetadata;
 export declare function uploadItem(file: File): Promise<StorageItemMetadata>;
 export declare function updateItem(fileId: string, data: Blob): Promise<StorageItemMetadata>;
 export declare function getItemMetadata(fileId: string): Promise<StorageItemMetadata>;

package/dist/client.js

@@ -22,7 +22,7 @@ async function _upload(method, url, data) {
     json.modifiedAt = new Date(json.modifiedAt);
     return json;
 }
-function _parse(result) {
+export function parseItem(result) {
     result.createdAt = new Date(result.createdAt);
     result.modifiedAt = new Date(result.modifiedAt);
     if (result.trashedAt)
@@ -30,19 +30,19 @@ function _parse(result) {
     return result;
 }
 export async function uploadItem(file) {
-    return _parse(await _upload('PUT', '/raw/storage', file));
+    return parseItem(await _upload('PUT', '/raw/storage', file));
 }
 export async function updateItem(fileId, data) {
-    return _parse(await _upload('POST', '/raw/storage/' + fileId, data));
+    return parseItem(await _upload('POST', '/raw/storage/' + fileId, data));
 }
 export async function getItemMetadata(fileId) {
     const result = await fetchAPI('GET', 'storage/item/:id', undefined, fileId);
-    return _parse(result);
+    return parseItem(result);
 }
 export async function getDirectoryMetadata(parentId) {
     const result = await fetchAPI('GET', 'storage/directory/:id', undefined, parentId);
     for (const item of result)
-        _parse(item);
+        parseItem(item);
     return result;
 }
 export async function downloadItem(fileId) {
@@ -55,15 +55,15 @@ export async function downloadItem(fileId) {
 }
 export async function updateItemMetadata(fileId, metadata) {
     const result = await fetchAPI('PATCH', 'storage/item/:id', metadata, fileId);
-    return _parse(result);
+    return parseItem(result);
 }
 export async function deleteItem(fileId) {
     const result = await fetchAPI('DELETE', 'storage/item/:id', undefined, fileId);
-    return _parse(result);
+    return parseItem(result);
 }
 export async function getUserFiles(userId) {
     const result = await fetchAPI('GET', 'users/:id/storage', undefined, userId);
     for (const item of result.items)
-        _parse(item);
+        parseItem(item);
     return result;
 }

package/dist/common.d.ts

@@ -43,10 +43,10 @@ export declare const StorageItemUpdate: z.ZodObject<{
     owner: z.ZodOptional<z.ZodUUID>;
     trash: z.ZodOptional<z.ZodBoolean>;
     restrict: z.ZodOptional<z.ZodBoolean>;
-    visibility: z.ZodOptional<z.ZodBoolean>;
+    publicPermission: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>;
 export type StorageItemUpdate = z.infer<typeof StorageItemUpdate>;
-export interface StorageItemMetadata {
+export interface StorageItemMetadata<T extends Record<string, unknown> = Record<string, unknown>> {
     createdAt: Date;
     dataURL?: string;
     hash: string;
@@ -56,10 +56,9 @@ export interface StorageItemMetadata {
     name: string;
     userId: string;
     parentId: string | null;
-    /** Whether editing the file is restricted to the owner */
-    restricted: boolean;
+    publicPermission: number;
     size: number;
     trashedAt: Date | null;
     type: string;
-    visibility: number;
+    metadata?: T;
 }

package/dist/common.js

@@ -8,6 +8,6 @@ export const StorageItemUpdate = z
     owner: z.uuid(),
     trash: z.boolean(),
     restrict: z.boolean(),
-    visibility: z.boolean(),
+    publicPermission: z.number().min(0).max(5),
 })
     .partial();

package/dist/plugin.js

@@ -1,3 +1,4 @@
+import { formatBytes } from '@axium/core/format';
 import config from '@axium/server/config';
 import { count, database, warnExists } from '@axium/server/database';
 import { done, start } from '@axium/server/io';
@@ -5,9 +6,8 @@ import { sql } from 'kysely';
 import pkg from '../package.json' with { type: 'json' };
 import './common.js';
 import './server.js';
-import { formatBytes } from '@axium/core/format';
 async function statusText() {
-    const items = await count('storage');
+    const { storage: items } = await count('storage');
     const { size } = await database
         .selectFrom('storage')
         .select(eb => eb.fn.sum('size').as('size'))
@@ -30,7 +30,8 @@ async function db_init(opt, db) {
         .addColumn('name', 'text', col => col.defaultTo(null))
         .addColumn('type', 'text', col => col.notNull())
         .addColumn('immutable', 'boolean', col => col.notNull())
-        .addColumn('visibility', 'integer', col => col.notNull().defaultTo(0))
+        .addColumn('publicPermission', 'integer', col => col.notNull().defaultTo(0))
+        .addColumn('metadata', 'jsonb', col => col.defaultTo('{}'))
         .execute()
         .then(done)
         .catch(warnExists);

package/dist/server.d.ts

@@ -1,5 +1,5 @@
 import { type Schema } from '@axium/server/database';
-import type { Generated, Selectable } from 'kysely';
+import type { ExpressionBuilder, Generated, Selectable } from 'kysely';
 import type { StorageItemMetadata, StorageLimits, StorageUsage } from './common.js';
 import './polyfills.js';
 declare module '@axium/server/database' {
@@ -17,9 +17,13 @@ declare module '@axium/server/database' {
             trashedAt: Date | null;
             type: string;
             userId: string;
-            visibility: Generated<number>;
+            publicPermission: Generated<number>;
+            metadata: Generated<Record<string, unknown>>;
         };
     }
+    interface ExpectedSchema {
+        storage: ColumnTypes<Schema['storage']>;
+    }
 }
 declare module '@axium/server/config' {
     interface Config {
@@ -49,12 +53,15 @@ declare module '@axium/server/config' {
 export interface StorageItem extends StorageItemMetadata {
     data: Uint8Array<ArrayBufferLike>;
 }
-export declare function parseItem(item: Selectable<Schema['storage']>): StorageItemMetadata;
+export declare function parseItem<T extends Record<string, unknown> = Record<string, unknown>>(item: Selectable<Schema['storage']> & {
+    hash: string;
+}): StorageItemMetadata<T>;
 /**
  * Returns the current usage of the storage for a user in bytes.
  */
 export declare function currentUsage(userId: string): Promise<StorageUsage>;
-export declare function get(itemId: string): Promise<StorageItemMetadata>;
+export declare function get<T extends Record<string, unknown> = Record<string, unknown>>(itemId: string): Promise<StorageItemMetadata<T>>;
+export declare function withEncodedHash(eb: ExpressionBuilder<Schema, 'storage'>): import("kysely").AliasedExpression<string, "hash">;
 export type ExternalLimitHandler = (userId?: string) => StorageLimits | Promise<StorageLimits>;
 /**
  * Define the handler to get limits for a user externally.

package/dist/server.js

@@ -1,6 +1,6 @@
 import { getSessionAndUser } from '@axium/server/auth';
 import { addConfigDefaults, config } from '@axium/server/config';
-import { connect, database } from '@axium/server/database';
+import { connect, database, expectedTypes } from '@axium/server/database';
 import { dirs } from '@axium/server/io';
 import { checkAuth, getToken, parseBody, withError } from '@axium/server/requests';
 import { addRoute } from '@axium/server/routes';
@@ -12,6 +12,22 @@ import { join } from 'node:path/posix';
 import * as z from 'zod';
 import { StorageItemUpdate } from './common.js';
 import './polyfills.js';
+expectedTypes.storage = {
+    createdAt: { type: 'timestamptz', required: true, hasDefault: true },
+    hash: { type: 'bytea', required: true },
+    id: { type: 'uuid', required: true, hasDefault: true },
+    immutable: { type: 'bool', required: true, hasDefault: true },
+    modifiedAt: { type: 'timestamptz', required: true, hasDefault: true },
+    name: { type: 'text' },
+    parentId: { type: 'uuid' },
+    restricted: { type: 'bool', required: true, hasDefault: true },
+    size: { type: 'int4', required: true },
+    trashedAt: { type: 'timestampz' },
+    type: { type: 'text', required: true },
+    userId: { type: 'uuid', required: true, hasDefault: true },
+    publicPermission: { type: 'int4', required: true, hasDefault: true },
+    metadata: { type: 'jsonb', required: true, hasDefault: true },
+};
 const defaultCASMime = [/video\/.*/, /audio\/.*/];
 addConfigDefaults({
     storage: {
@@ -34,7 +50,7 @@ addConfigDefaults({
 export function parseItem(item) {
     return {
         ...item,
-        hash: item.hash.toHex(),
+        metadata: item.metadata,
         dataURL: `/raw/storage/${item.id}`,
     };
 }
@@ -53,9 +69,17 @@ export async function currentUsage(userId) {
 }
 export async function get(itemId) {
     connect();
-    const result = await database.selectFrom('storage').where('id', '=', itemId).selectAll().executeTakeFirstOrThrow();
+    const result = await database
+        .selectFrom('storage')
+        .where('id', '=', itemId)
+        .selectAll()
+        .select(withEncodedHash)
+        .executeTakeFirstOrThrow();
     return parseItem(result);
 }
+export function withEncodedHash(eb) {
+    return eb.fn('encode', ['hash', eb.val('hex')]).as('hash');
+}
 let _getLimits = null;
 /**
  * Define the handler to get limits for a user externally.
@@ -94,8 +118,8 @@ addRoute({
             error(404, 'Item not found');
         await checkAuth(event, item.userId);
         const values = {};
-        if ('restrict' in body)
-            values.restricted = body.restrict;
+        if ('publicPermission' in body)
+            values.publicPermission = body.publicPermission;
         if ('trash' in body)
             values.trashedAt = body.trash ? new Date() : null;
         if ('owner' in body)
@@ -109,6 +133,7 @@ addRoute({
             .where('id', '=', itemId)
             .set(values)
             .returningAll()
+            .returning(withEncodedHash)
             .executeTakeFirstOrThrow()
             .catch(withError('Could not update item')));
     },
@@ -154,6 +179,7 @@ addRoute({
             .where('parentId', '=', itemId)
             .where('trashedAt', '!=', null)
             .selectAll()
+            .select(withEncodedHash)
             .execute();
         return items.map(parseItem);
     },
@@ -202,6 +228,7 @@ addRoute({
             .insertInto('storage')
             .values({ userId: userId, hash, name, size, type, immutable: useCAS, parentId })
             .returningAll()
+            .returning(withEncodedHash)
             .executeTakeFirstOrThrow()
             .catch(withError('Could not create item'));
         const path = join(config.storage.data, result.id);
@@ -256,7 +283,7 @@ addRoute({
             error(403, 'Item is immutable');
         if (item.trashedAt)
             error(410, 'Trashed items can not be changed');
-        if (item.restricted && item.userId != accessor.id)
+        if (item.userId != accessor.id)
             error(403, 'Item editing is restricted to the owner');
         const type = event.request.headers.get('content-type') || 'application/octet-stream';
         // @todo: add this to the audit log
@@ -281,6 +308,7 @@ addRoute({
             .where('id', '=', itemId)
             .set({ size, modifiedAt: new Date(), hash })
             .returningAll()
+            .returning(withEncodedHash)
             .executeTakeFirstOrThrow()
             .catch(withError('Could not update item'));
         await writeFile(join(config.storage.data, result.id), content).catch(withError('Could not write'));
@@ -304,7 +332,7 @@ addRoute({
         const userId = event.params.id;
         await checkAuth(event, userId);
         const [items, usage, limits] = await Promise.all([
-            database.selectFrom('storage').where('userId', '=', userId).selectAll().execute(),
+            database.selectFrom('storage').where('userId', '=', userId).selectAll().select(withEncodedHash).execute(),
             currentUsage(userId),
             getLimits(userId),
         ]).catch(withError('Could not fetch data'));

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@axium/storage",
-	"version": "0.1.4",
+	"version": "0.2.0",
 	"author": "James Prevett <axium@jamespre.dev> (https://jamespre.dev)",
 	"description": "User file storage for Axium",
 	"funding": {
@@ -32,8 +32,8 @@
 	},
 	"peerDependencies": {
 		"@axium/client": ">=0.1.0",
-		"@axium/core": ">=0.4.0",
-		"@axium/server": ">=0.16.0",
+		"@axium/core": ">=0.5.0",
+		"@axium/server": ">=0.17.0",
 		"@sveltejs/kit": "^2.23.0",
 		"utilium": "^2.3.8"
 	},