@everystack/storage 0.2.1 → 0.3.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@everystack/storage",
-  "version": "0.2.1",
+  "version": "0.3.1",
   "description": "File uploads via S3 + CloudFront CDN with presigned URLs",
   "license": "AGPL-3.0-only",
   "author": "Scalable Technology, Inc. <licensing@scalable.technology>",
@@ -29,6 +29,10 @@
       "types": "./src/schema.ts",
       "default": "./src/schema.ts"
     },
+    "./models": {
+      "types": "./src/models/index.ts",
+      "default": "./src/models/index.ts"
+    },
     "./client": {
       "types": "./src/client/index.ts",
       "default": "./src/client/index.ts"
@@ -38,6 +42,9 @@
       "default": "./src/plugin.ts"
     }
   },
+  "dependencies": {
+    "@everystack/model": "0.3.3"
+  },
   "peerDependencies": {
     "@aws-sdk/client-s3": "3.1053.0",
     "@aws-sdk/s3-request-presigner": "3.1053.0",
@@ -76,7 +83,7 @@
     "react-test-renderer": "19.2.6",
     "ts-jest": "29.4.9",
     "typescript": "5.9.3",
-    "@everystack/server": "0.2.23"
+    "@everystack/server": "0.3.1"
   },
   "scripts": {
     "test": "jest",

package/src/models/blob.ts

@@ -0,0 +1,55 @@
+/**
+ * dist.blobs — the content-addressed S3 object registry (deduped by sha256).
+ *
+ * The v3 Model that owns this table's schema AND its authorization. The drizzle
+ * runtime table (`../schema`) derives from it, and `db:generate` reads it to emit
+ * the table's DDL + RLS + grants — so the package, not the consuming app, owns
+ * dist.blobs end to end.
+ *
+ * Authz shape (matches the live 0020 migration):
+ *  - `writtenBy: 'worker'` — the image worker writes derived blobs (thumbnail/webp)
+ *    as the table owner and must keep its owner bypass, so RLS is ENABLE-not-FORCE.
+ *  - `can('manage', { role: 'admin' })` — the storage handler runs as `admin`
+ *    (SET ROLE) and enforces per-user ownership in code; admin gets CRUD + the
+ *    `blobs_admin` policy. No anon/authenticated grant exists.
+ *  - `private: true` — reached through the storage handler (/api/storage), never the
+ *    generic data API, so it never enters `exposedTables`.
+ */
+
+import { defineModel, field, can, index } from '@everystack/model';
+
+export const Blob = defineModel('blobs', {
+  schema: 'dist',
+  writtenBy: 'worker',
+  private: true,
+  fields: {
+    id: field.uuid().primaryKey().defaultRandom(),
+    repositoryId: field.uuid().nullable(),
+    type: field.text().notNull(), // 'original' | 'thumbnail' | 'preview' | 'webp' | …
+    sha256: field.text().notNull().unique(),
+
+    // S3 object location (bytes live in S3, not the database)
+    s3Key: field.text().nullable(),
+    bucket: field.text().nullable(),
+
+    sizeBytes: field.bigint().notNull(),
+    contentType: field.text().nullable(),
+
+    // Derived content (thumbnail → original, webp → original, …)
+    parentId: field.uuid().nullable(),
+
+    // Intrinsic content metadata ({ width, height, format, originalName, userId })
+    metadata: field.jsonb().nullable(),
+
+    createdAt: field.timestamptz().defaultNow().notNull(),
+  },
+  constraints: [
+    index('type'),
+    index('contentType'),
+    index('createdAt'),
+    index('repositoryId'),
+    index('parentId'),
+    index('s3Key'),
+  ],
+  abilities: [can('manage', { role: 'admin' })],
+});

package/src/models/index.ts

@@ -0,0 +1,16 @@
+/**
+ * Storage's package-owned models. A consuming app composes these into its own
+ * model list so `db:generate` emits dist.blobs' schema + authz alongside the app's
+ * tables: `models = [...appModels, ...storageModels]`.
+ */
+
+export { Blob } from './blob';
+
+import { defineModule } from '@everystack/model';
+import { Blob } from './blob';
+
+/** All storage-owned models, for the app to spread into its db:generate model list. */
+export const storageModels = [Blob];
+
+/** The storage Module — dist.blobs (schema + authz). No functions/extensions of its own. */
+export const storageModule = defineModule({ models: storageModels });

package/src/schema.ts

@@ -1,87 +1,15 @@
 /**
- * Storage schema — everyschema dist.blobs
+ * Storage schema — dist.blobs, the runtime drizzle table.
  *
- * Content-addressed storage — in-DB (bytea) or S3-backed.
- * Replaces the old `uploads` table.
- *
- * Type values for everystack:
- *   'original'  — user-uploaded content (S3-backed)
- *   'thumbnail' — derived image variant (parentId → original)
- *   'preview'   — derived preview image
- *   'webp'      — derived WebP variant
- *
- * @see everyschema — canonical schema definitions
- */
-
-import {
-  pgSchema,
-  text,
-  timestamp,
-  uuid,
-  bigint,
-  index,
-  uniqueIndex,
-  jsonb,
-  customType,
-} from 'drizzle-orm/pg-core';
-
-const distSchema = pgSchema('dist');
-
-const bytea = customType<{ data: Buffer; driverValue: Buffer }>({
-  dataType() {
-    return 'bytea';
-  },
-});
-
-// =============================================================================
-// BLOBS - Raw binary storage, deduped by sha256
-// =============================================================================
-
-/**
- * Content-addressed storage — in-DB or S3-backed.
- *
- * Storage modes:
- *   In-DB:  data (bytea) populated, s3Key/bucket NULL
- *   S3:     s3Key + bucket populated, data NULL
- *
- * Derived content uses parentId:
- *   original → thumbnail, preview, webp, etc.
+ * DERIVED from the package-owned Model (`./models/blob`) — the Model is the single
+ * source of the table's columns, schema, indexes, and authz; this just materializes
+ * the drizzle-orm runtime object the handler queries. Edit the Model, not this file.
  *
- * metadata stores intrinsic content properties:
- *   Images: { width, height, format, originalName, userId }
- *   Video/audio: { codec, duration, bitrate }
+ * Content-addressed storage — S3-backed (the object registry; bytes live in S3).
+ * Replaces the old `uploads` table.
  */
-export const blobs = distSchema.table(
-  'blobs',
-  {
-    id: uuid('id').primaryKey().defaultRandom(),
-    repositoryId: uuid('repository_id'),
-    type: text('type').notNull(), // 'original' | 'thumbnail' | 'preview' | 'webp' | etc.
-    sha256: text('sha256').notNull().unique(),
-
-    // Storage: in-DB (bytea) or S3-backed (s3Key + bucket)
-    data: bytea('data'),
-    s3Key: text('s3_key'),
-    bucket: text('bucket'),
-
-    sizeBytes: bigint('size_bytes', { mode: 'number' }).notNull(),
-    contentType: text('content_type'),
-
-    // Derived content (thumbnail → original, webp → original, etc.)
-    parentId: uuid('parent_id'),
 
-    // Intrinsic content metadata
-    metadata: jsonb('metadata'),
+import { toDrizzleTable } from '@everystack/model/drizzle';
+import { Blob } from './models/blob';
 
-    createdAt: timestamp('created_at', { withTimezone: true }).defaultNow().notNull(),
-  },
-  (table) => ({
-    typeIdx: index('blobs_type_idx').on(table.type),
-    sha256Idx: uniqueIndex('blobs_sha256_idx').on(table.sha256),
-    contentTypeIdx: index('blobs_content_type_idx').on(table.contentType),
-    createdAtIdx: index('blobs_created_at_idx').on(table.createdAt),
-    repoIdx: index('blobs_repo_idx').on(table.repositoryId),
-    parentIdx: index('blobs_parent_idx').on(table.parentId),
-    s3KeyIdx: index('blobs_s3_key_idx').on(table.s3Key),
-  })
-);
+export const blobs = toDrizzleTable(Blob);