@dimah-s3/db 1.7.1 → 2.0.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (120) hide show
  1. package/README.md +62 -17
  2. package/dist/adapters/drizzle.d.ts +8 -0
  3. package/dist/adapters/drizzle.d.ts.map +1 -0
  4. package/dist/adapters/drizzle.js +3 -0
  5. package/dist/adapters/drizzle.js.map +1 -0
  6. package/dist/adapters/kysely.d.ts +7 -0
  7. package/dist/adapters/kysely.d.ts.map +1 -0
  8. package/dist/adapters/kysely.js +3 -0
  9. package/dist/adapters/kysely.js.map +1 -0
  10. package/dist/adapters/prisma.d.ts +7 -0
  11. package/dist/adapters/prisma.d.ts.map +1 -0
  12. package/dist/adapters/prisma.js +3 -0
  13. package/dist/adapters/prisma.js.map +1 -0
  14. package/dist/cli.d.ts +32 -4
  15. package/dist/cli.d.ts.map +1 -1
  16. package/dist/cli.js +135 -4
  17. package/dist/cli.js.map +1 -1
  18. package/dist/client/db-client.d.ts +9 -85
  19. package/dist/client/db-client.d.ts.map +1 -1
  20. package/dist/client/db-object-source.d.ts +25 -0
  21. package/dist/client/db-object-source.d.ts.map +1 -0
  22. package/dist/client/index.d.ts +3 -3
  23. package/dist/client/index.d.ts.map +1 -1
  24. package/dist/client/index.js +96 -42
  25. package/dist/client/index.js.map +1 -1
  26. package/dist/drizzle/mysql.d.ts +1025 -0
  27. package/dist/drizzle/mysql.d.ts.map +1 -0
  28. package/dist/drizzle/mysql.js +117 -0
  29. package/dist/drizzle/mysql.js.map +1 -0
  30. package/dist/drizzle/pg.d.ts +964 -0
  31. package/dist/drizzle/pg.d.ts.map +1 -0
  32. package/dist/drizzle/pg.js +98 -0
  33. package/dist/drizzle/pg.js.map +1 -0
  34. package/dist/drizzle/shared.d.ts +7 -0
  35. package/dist/drizzle/shared.d.ts.map +1 -0
  36. package/dist/drizzle/sqlite.d.ts +1024 -0
  37. package/dist/drizzle/sqlite.d.ts.map +1 -0
  38. package/dist/drizzle/sqlite.js +101 -0
  39. package/dist/drizzle/sqlite.js.map +1 -0
  40. package/dist/folder-path.d.ts +32 -0
  41. package/dist/folder-path.d.ts.map +1 -0
  42. package/dist/fuma-db.d.ts +30 -9
  43. package/dist/fuma-db.d.ts.map +1 -1
  44. package/dist/index.d.ts +9 -13
  45. package/dist/index.d.ts.map +1 -1
  46. package/dist/index.js +1419 -623
  47. package/dist/index.js.map +1 -1
  48. package/dist/plugin/create-database-endpoints.d.ts +105 -21
  49. package/dist/plugin/create-database-endpoints.d.ts.map +1 -1
  50. package/dist/plugin/create-database-lifecycle-hooks.d.ts +37 -19
  51. package/dist/plugin/create-database-lifecycle-hooks.d.ts.map +1 -1
  52. package/dist/plugin/db.d.ts +29 -118
  53. package/dist/plugin/db.d.ts.map +1 -1
  54. package/dist/plugin/object-access.d.ts +46 -0
  55. package/dist/plugin/object-access.d.ts.map +1 -0
  56. package/dist/plugin/public-stores.d.ts +33 -0
  57. package/dist/plugin/public-stores.d.ts.map +1 -0
  58. package/dist/plugin/purge.d.ts +49 -0
  59. package/dist/plugin/purge.d.ts.map +1 -0
  60. package/dist/plugin/quota.d.ts +25 -0
  61. package/dist/plugin/quota.d.ts.map +1 -0
  62. package/dist/plugin/schemas.d.ts +69 -0
  63. package/dist/plugin/schemas.d.ts.map +1 -0
  64. package/dist/plugin/scope.d.ts +31 -0
  65. package/dist/plugin/scope.d.ts.map +1 -0
  66. package/dist/plugin/to-db-client-object.d.ts +8 -4
  67. package/dist/plugin/to-db-client-object.d.ts.map +1 -1
  68. package/dist/schema/schema.d.ts +73 -0
  69. package/dist/schema/schema.d.ts.map +1 -0
  70. package/dist/standard-schema.d.ts +42 -0
  71. package/dist/standard-schema.d.ts.map +1 -0
  72. package/dist/store/create-db-store.d.ts +17 -0
  73. package/dist/store/create-db-store.d.ts.map +1 -0
  74. package/dist/store/folder-store.d.ts +36 -0
  75. package/dist/store/folder-store.d.ts.map +1 -0
  76. package/dist/store/list-cursor.d.ts +26 -4
  77. package/dist/store/list-cursor.d.ts.map +1 -1
  78. package/dist/store/map-row.d.ts +17 -8
  79. package/dist/store/map-row.d.ts.map +1 -1
  80. package/dist/store/object-store.d.ts +208 -0
  81. package/dist/store/object-store.d.ts.map +1 -0
  82. package/dist/store/schema-version.d.ts +7 -0
  83. package/dist/store/schema-version.d.ts.map +1 -0
  84. package/dist/types/client.d.ts +209 -0
  85. package/dist/types/client.d.ts.map +1 -0
  86. package/dist/types/plugin.d.ts +112 -0
  87. package/dist/types/plugin.d.ts.map +1 -0
  88. package/dist/types/storage-object.d.ts +40 -85
  89. package/dist/types/storage-object.d.ts.map +1 -1
  90. package/package.json +53 -11
  91. package/prisma/dimah-s3.prisma +80 -0
  92. package/sql/mysql.sql +59 -0
  93. package/sql/pg.sql +53 -0
  94. package/sql/sqlite.sql +54 -0
  95. package/src/drizzle/mysql.ts +172 -0
  96. package/src/drizzle/pg.ts +140 -0
  97. package/src/drizzle/sqlite.ts +144 -0
  98. package/dist/client/db-object-list-accessors.d.ts +0 -36
  99. package/dist/client/db-object-list-accessors.d.ts.map +0 -1
  100. package/dist/client/db-object-query.d.ts +0 -40
  101. package/dist/client/db-object-query.d.ts.map +0 -1
  102. package/dist/errors.d.ts +0 -6
  103. package/dist/errors.d.ts.map +0 -1
  104. package/dist/hooks/create-object-access-guard.d.ts +0 -51
  105. package/dist/hooks/create-object-access-guard.d.ts.map +0 -1
  106. package/dist/hooks/create-quota-guard.d.ts +0 -28
  107. package/dist/hooks/create-quota-guard.d.ts.map +0 -1
  108. package/dist/jobs/purge-stale-pending.d.ts +0 -31
  109. package/dist/jobs/purge-stale-pending.d.ts.map +0 -1
  110. package/dist/plugin/list-query-schema.d.ts +0 -21
  111. package/dist/plugin/list-query-schema.d.ts.map +0 -1
  112. package/dist/plugin/memoize-scope-resolver.d.ts +0 -8
  113. package/dist/plugin/memoize-scope-resolver.d.ts.map +0 -1
  114. package/dist/schema/v1.d.ts +0 -31
  115. package/dist/schema/v1.d.ts.map +0 -1
  116. package/dist/store/storage-object-store.d.ts +0 -137
  117. package/dist/store/storage-object-store.d.ts.map +0 -1
  118. package/src/schema/examples/README.md +0 -10
  119. package/src/schema/examples/drizzle.ts +0 -92
  120. package/src/schema/examples/schema.prisma +0 -55
@@ -0,0 +1,80 @@
1
+ // Prisma models for @dimah-s3/db schema 2.0.0.
2
+ //
3
+ // Copy this file next to your schema (Prisma reads every .prisma file in the
4
+ // schema folder) or paste the models into schema.prisma, then create the
5
+ // client with `prismaAdapter` from `@dimah-s3/db/adapters/prisma`. Keep the
6
+ // model names: FumaDB calls `prisma.storageObject`, `prisma.storageFolder` and
7
+ // `prisma.private_dimah_s3_settings`.
8
+ //
9
+ // The models work as they are on PostgreSQL and SQLite. On MySQL, match
10
+ // `sql/mysql.sql`: add `@db.VarChar(1024)` to `key`, `folder`, `path` and
11
+ // `parent`, `@db.DateTime(3)` to the timestamps, and index prefixes such as
12
+ // `@@unique([bucket, key(length: 512)])`.
13
+
14
+ /// One row per tracked object: pending (presigned), active (confirmed),
15
+ /// deleted (soft delete), or purging (a stale pending row purge has claimed).
16
+ model StorageObject {
17
+ id String @id @default(cuid())
18
+ /// Owner, for example `user:123` or `org:acme`.
19
+ scope String
20
+ bucket String
21
+ key String
22
+ /// Named dimah-s3 route that created the object.
23
+ route String
24
+ /// Logical folder path. `null` is the root.
25
+ folder String?
26
+ filename String
27
+ contentType String? @map("content_type")
28
+ /// Verified size from HeadObject, set on confirm.
29
+ size BigInt?
30
+ /// Size the client declared before confirm.
31
+ declaredSize BigInt? @map("declared_size")
32
+ eTag String? @map("e_tag")
33
+ status String
34
+ /// S3 user metadata of the verified object.
35
+ s3Metadata Json? @map("s3_metadata")
36
+ /// App attributes, validated by the plugin's `attributes.schema`.
37
+ attributes Json?
38
+ acl String?
39
+ /// Multipart upload ID while the row is pending.
40
+ uploadId String? @map("upload_id")
41
+ /// Token of the upload ticket that wrote the row.
42
+ uploadToken String? @map("upload_token")
43
+ /// Confirm deadline of a pending row (the upload ticket's expiry).
44
+ expiresAt DateTime? @map("expires_at")
45
+ confirmedAt DateTime? @map("confirmed_at")
46
+ createdAt DateTime @default(now()) @map("created_at")
47
+ updatedAt DateTime @default(now()) @map("updated_at")
48
+ deletedAt DateTime? @map("deleted_at")
49
+
50
+ @@unique([bucket, key], map: "storage_object_bucket_key_uk")
51
+ @@index([scope, status, folder, createdAt], map: "storage_object_scope_folder_idx")
52
+ @@index([scope, status, updatedAt], map: "storage_object_scope_updated_idx")
53
+ @@index([scope, status, filename], map: "storage_object_scope_filename_idx")
54
+ @@index([scope, status, size], map: "storage_object_scope_size_idx")
55
+ @@index([status, expiresAt], map: "storage_object_status_expires_idx")
56
+ @@map("storage_object")
57
+ }
58
+
59
+ /// One row per folder, so an empty folder still lists.
60
+ model StorageFolder {
61
+ id String @id @default(cuid())
62
+ scope String
63
+ /// Full folder path.
64
+ path String
65
+ /// Path of the containing folder. `null` is the root.
66
+ parent String?
67
+ /// Last segment of `path`.
68
+ name String
69
+ createdAt DateTime @default(now()) @map("created_at")
70
+
71
+ @@unique([scope, path], map: "storage_folder_scope_path_uk")
72
+ @@index([scope, parent], map: "storage_folder_scope_parent_idx")
73
+ @@map("storage_folder")
74
+ }
75
+
76
+ /// FumaDB settings. The adapter reads the schema version from the `version` row.
77
+ model private_dimah_s3_settings {
78
+ key String @id
79
+ value String @default("2.0.0")
80
+ }
package/sql/mysql.sql ADDED
@@ -0,0 +1,59 @@
1
+ -- @dimah-s3/db schema 2.0.0 for MySQL 8.
2
+ -- Keys, folders, and scopes compare byte for byte (utf8mb4_bin); file names
3
+ -- use a case-insensitive collation for search. An InnoDB index holds at most
4
+ -- 3072 bytes, so `key`, `folder`, `path`, and `parent` are indexed by prefix:
5
+ -- two values that share their first 512 characters (255 for `folder`) share
6
+ -- an index entry, and the unique keys treat them as equal.
7
+
8
+ CREATE TABLE `storage_object` (
9
+ `id` varchar(255) NOT NULL,
10
+ `scope` varchar(255) NOT NULL,
11
+ `bucket` varchar(255) NOT NULL,
12
+ `key` varchar(1024) NOT NULL,
13
+ `route` varchar(255) NOT NULL,
14
+ `folder` varchar(1024),
15
+ `filename` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL,
16
+ `content_type` varchar(255),
17
+ `size` bigint,
18
+ `declared_size` bigint,
19
+ `e_tag` varchar(255),
20
+ `status` varchar(16) NOT NULL,
21
+ `s3_metadata` json,
22
+ `attributes` json,
23
+ `acl` varchar(255),
24
+ `upload_id` text,
25
+ `upload_token` varchar(64),
26
+ `expires_at` datetime(3),
27
+ `confirmed_at` datetime(3),
28
+ `created_at` datetime(3) NOT NULL DEFAULT CURRENT_TIMESTAMP(3),
29
+ `updated_at` datetime(3) NOT NULL DEFAULT CURRENT_TIMESTAMP(3),
30
+ `deleted_at` datetime(3),
31
+ PRIMARY KEY (`id`),
32
+ UNIQUE KEY `storage_object_bucket_key_uk` (`bucket`, `key`(512)),
33
+ KEY `storage_object_scope_folder_idx` (`scope`, `status`, `folder`(255), `created_at`),
34
+ KEY `storage_object_scope_updated_idx` (`scope`, `status`, `updated_at`),
35
+ KEY `storage_object_scope_filename_idx` (`scope`, `status`, `filename`),
36
+ KEY `storage_object_scope_size_idx` (`scope`, `status`, `size`),
37
+ KEY `storage_object_status_expires_idx` (`status`, `expires_at`)
38
+ ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_bin;
39
+
40
+ CREATE TABLE `storage_folder` (
41
+ `id` varchar(255) NOT NULL,
42
+ `scope` varchar(255) NOT NULL,
43
+ `path` varchar(1024) NOT NULL,
44
+ `parent` varchar(1024),
45
+ `name` varchar(255) NOT NULL,
46
+ `created_at` datetime(3) NOT NULL DEFAULT CURRENT_TIMESTAMP(3),
47
+ PRIMARY KEY (`id`),
48
+ UNIQUE KEY `storage_folder_scope_path_uk` (`scope`, `path`(512)),
49
+ KEY `storage_folder_scope_parent_idx` (`scope`, `parent`(512))
50
+ ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_bin;
51
+
52
+ -- Schema version for the Kysely and Prisma adapters.
53
+ CREATE TABLE `private_dimah_s3_settings` (
54
+ `key` varchar(255) NOT NULL,
55
+ `value` text NOT NULL DEFAULT ('2.0.0'),
56
+ PRIMARY KEY (`key`)
57
+ ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_bin;
58
+
59
+ INSERT INTO `private_dimah_s3_settings` (`key`, `value`) VALUES ('version', '2.0.0');
package/sql/pg.sql ADDED
@@ -0,0 +1,53 @@
1
+ -- @dimah-s3/db schema 2.0.0 for PostgreSQL.
2
+
3
+ CREATE TABLE "storage_object" (
4
+ "id" varchar(255) PRIMARY KEY NOT NULL,
5
+ "scope" text NOT NULL,
6
+ "bucket" text NOT NULL,
7
+ "key" text NOT NULL,
8
+ "route" text NOT NULL,
9
+ "folder" text,
10
+ "filename" text NOT NULL,
11
+ "content_type" text,
12
+ "size" bigint,
13
+ "declared_size" bigint,
14
+ "e_tag" text,
15
+ "status" text NOT NULL,
16
+ "s3_metadata" json,
17
+ "attributes" json,
18
+ "acl" text,
19
+ "upload_id" text,
20
+ "upload_token" text,
21
+ "expires_at" timestamp,
22
+ "confirmed_at" timestamp,
23
+ "created_at" timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
24
+ "updated_at" timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
25
+ "deleted_at" timestamp,
26
+ CONSTRAINT "storage_object_bucket_key_uk" UNIQUE ("bucket", "key")
27
+ );
28
+
29
+ CREATE INDEX "storage_object_scope_folder_idx" ON "storage_object" ("scope", "status", "folder", "created_at");
30
+ CREATE INDEX "storage_object_scope_updated_idx" ON "storage_object" ("scope", "status", "updated_at");
31
+ CREATE INDEX "storage_object_scope_filename_idx" ON "storage_object" ("scope", "status", "filename");
32
+ CREATE INDEX "storage_object_scope_size_idx" ON "storage_object" ("scope", "status", "size");
33
+ CREATE INDEX "storage_object_status_expires_idx" ON "storage_object" ("status", "expires_at");
34
+
35
+ CREATE TABLE "storage_folder" (
36
+ "id" varchar(255) PRIMARY KEY NOT NULL,
37
+ "scope" text NOT NULL,
38
+ "path" text NOT NULL,
39
+ "parent" text,
40
+ "name" text NOT NULL,
41
+ "created_at" timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
42
+ CONSTRAINT "storage_folder_scope_path_uk" UNIQUE ("scope", "path")
43
+ );
44
+
45
+ CREATE INDEX "storage_folder_scope_parent_idx" ON "storage_folder" ("scope", "parent");
46
+
47
+ -- Schema version for the Kysely and Prisma adapters.
48
+ CREATE TABLE "private_dimah_s3_settings" (
49
+ "key" varchar(255) PRIMARY KEY NOT NULL,
50
+ "value" text NOT NULL DEFAULT '2.0.0'
51
+ );
52
+
53
+ INSERT INTO "private_dimah_s3_settings" ("key", "value") VALUES ('version', '2.0.0');
package/sql/sqlite.sql ADDED
@@ -0,0 +1,54 @@
1
+ -- @dimah-s3/db schema 2.0.0 for SQLite.
2
+ -- Timestamps are epoch milliseconds. Sizes are INTEGER.
3
+
4
+ CREATE TABLE "storage_object" (
5
+ "id" text PRIMARY KEY NOT NULL,
6
+ "scope" text NOT NULL,
7
+ "bucket" text NOT NULL,
8
+ "key" text NOT NULL,
9
+ "route" text NOT NULL,
10
+ "folder" text,
11
+ "filename" text NOT NULL,
12
+ "content_type" text,
13
+ "size" integer,
14
+ "declared_size" integer,
15
+ "e_tag" text,
16
+ "status" text NOT NULL,
17
+ "s3_metadata" text,
18
+ "attributes" text,
19
+ "acl" text,
20
+ "upload_id" text,
21
+ "upload_token" text,
22
+ "expires_at" integer,
23
+ "confirmed_at" integer,
24
+ "created_at" integer NOT NULL DEFAULT (strftime('%s', 'now') * 1000),
25
+ "updated_at" integer NOT NULL DEFAULT (strftime('%s', 'now') * 1000),
26
+ "deleted_at" integer
27
+ );
28
+
29
+ CREATE UNIQUE INDEX "storage_object_bucket_key_uk" ON "storage_object" ("bucket", "key");
30
+ CREATE INDEX "storage_object_scope_folder_idx" ON "storage_object" ("scope", "status", "folder", "created_at");
31
+ CREATE INDEX "storage_object_scope_updated_idx" ON "storage_object" ("scope", "status", "updated_at");
32
+ CREATE INDEX "storage_object_scope_filename_idx" ON "storage_object" ("scope", "status", "filename");
33
+ CREATE INDEX "storage_object_scope_size_idx" ON "storage_object" ("scope", "status", "size");
34
+ CREATE INDEX "storage_object_status_expires_idx" ON "storage_object" ("status", "expires_at");
35
+
36
+ CREATE TABLE "storage_folder" (
37
+ "id" text PRIMARY KEY NOT NULL,
38
+ "scope" text NOT NULL,
39
+ "path" text NOT NULL,
40
+ "parent" text,
41
+ "name" text NOT NULL,
42
+ "created_at" integer NOT NULL DEFAULT (strftime('%s', 'now') * 1000)
43
+ );
44
+
45
+ CREATE UNIQUE INDEX "storage_folder_scope_path_uk" ON "storage_folder" ("scope", "path");
46
+ CREATE INDEX "storage_folder_scope_parent_idx" ON "storage_folder" ("scope", "parent");
47
+
48
+ -- Schema version for the Kysely and Prisma adapters.
49
+ CREATE TABLE "private_dimah_s3_settings" (
50
+ "key" text PRIMARY KEY NOT NULL,
51
+ "value" text NOT NULL DEFAULT '2.0.0'
52
+ );
53
+
54
+ INSERT INTO "private_dimah_s3_settings" ("key", "value") VALUES ('version', '2.0.0');
@@ -0,0 +1,172 @@
1
+ /**
2
+ * Drizzle schema for @dimah-s3/db on MySQL 8. Copy this file into your app
3
+ * (`db/schema.ts`) to own the tables and add columns. Keep the table names,
4
+ * the column names, and the `dimahS3Tables` keys: the adapter finds the
5
+ * tables by those keys. A column you add must be nullable or have a default.
6
+ * The plugin does not read or write it.
7
+ *
8
+ * Import `dimahS3Tables` from `@dimah-s3/db/drizzle/mysql` when the tables
9
+ * stay as they are. `drizzle-kit` then follows that import, and a later push
10
+ * drops a column that is not part of it.
11
+ *
12
+ * Columns, collations and indexes match `sql/mysql.sql`, including the
13
+ * prefix indexes on `key`, `folder`, `path` and `parent`. Keys, folders and
14
+ * scopes compare byte for byte (`utf8mb4_bin`), and file names
15
+ * case-insensitively (`utf8mb4_unicode_ci`). Requires `drizzle-orm` and
16
+ * `@paralleldrive/cuid2`.
17
+ */
18
+ import { createId } from "@paralleldrive/cuid2";
19
+ import { sql } from "drizzle-orm";
20
+ import {
21
+ bigint,
22
+ datetime,
23
+ index,
24
+ json,
25
+ mysqlTable,
26
+ text,
27
+ uniqueIndex,
28
+ varchar,
29
+ type MySqlColumn,
30
+ } from "drizzle-orm/mysql-core";
31
+
32
+ type StorageObjectStatus = "pending" | "active" | "deleted" | "purging";
33
+
34
+ const SCHEMA_VERSION = "2.0.0";
35
+
36
+ /** Collation of every text column but `filename`: byte for byte. */
37
+ const BINARY = "utf8mb4_bin";
38
+
39
+ function id() {
40
+ return string("id")
41
+ .primaryKey()
42
+ .$defaultFn(() => createId());
43
+ }
44
+
45
+ function string(name: string, length = 255) {
46
+ return varchar(name, { length }).collate(BINARY);
47
+ }
48
+
49
+ function timestamp(name: string) {
50
+ return datetime(name, { mode: "date", fsp: 3 });
51
+ }
52
+
53
+ function timestampNow(name: string) {
54
+ return timestamp(name)
55
+ .notNull()
56
+ .default(sql`CURRENT_TIMESTAMP(3)`)
57
+ .$defaultFn(() => new Date());
58
+ }
59
+
60
+ function byteCount(name: string) {
61
+ return bigint(name, { mode: "number" });
62
+ }
63
+
64
+ /** An index on the first `length` characters of a long column. */
65
+ function prefix(column: MySqlColumn, length: number) {
66
+ return sql`${column}(${sql.raw(String(length))})`;
67
+ }
68
+
69
+ /** The `storage_object` table: one row per tracked object. */
70
+ export const storageObject = mysqlTable(
71
+ "storage_object",
72
+ {
73
+ id: id(),
74
+ scope: string("scope").notNull(),
75
+ bucket: string("bucket").notNull(),
76
+ key: string("key", 1024).notNull(),
77
+ route: string("route").notNull(),
78
+ folder: string("folder", 1024),
79
+ filename: varchar("filename", { length: 255 })
80
+ .collate("utf8mb4_unicode_ci")
81
+ .notNull(),
82
+ contentType: string("content_type"),
83
+ size: byteCount("size"),
84
+ declaredSize: byteCount("declared_size"),
85
+ eTag: string("e_tag"),
86
+ status: string("status", 16).$type<StorageObjectStatus>().notNull(),
87
+ s3Metadata: json("s3_metadata").$type<Record<string, string>>(),
88
+ attributes: json("attributes"),
89
+ acl: string("acl"),
90
+ uploadId: text("upload_id").collate(BINARY),
91
+ uploadToken: string("upload_token", 64),
92
+ expiresAt: timestamp("expires_at"),
93
+ confirmedAt: timestamp("confirmed_at"),
94
+ createdAt: timestampNow("created_at"),
95
+ updatedAt: timestampNow("updated_at"),
96
+ deletedAt: timestamp("deleted_at"),
97
+ },
98
+ (table) => [
99
+ uniqueIndex("storage_object_bucket_key_uk").on(
100
+ table.bucket,
101
+ prefix(table.key, 512),
102
+ ),
103
+ index("storage_object_scope_folder_idx").on(
104
+ table.scope,
105
+ table.status,
106
+ prefix(table.folder, 255),
107
+ table.createdAt,
108
+ ),
109
+ index("storage_object_scope_updated_idx").on(
110
+ table.scope,
111
+ table.status,
112
+ table.updatedAt,
113
+ ),
114
+ index("storage_object_scope_filename_idx").on(
115
+ table.scope,
116
+ table.status,
117
+ table.filename,
118
+ ),
119
+ index("storage_object_scope_size_idx").on(
120
+ table.scope,
121
+ table.status,
122
+ table.size,
123
+ ),
124
+ index("storage_object_status_expires_idx").on(
125
+ table.status,
126
+ table.expiresAt,
127
+ ),
128
+ ],
129
+ );
130
+
131
+ /** The `storage_folder` table: one row per folder, so empty folders list. */
132
+ export const storageFolder = mysqlTable(
133
+ "storage_folder",
134
+ {
135
+ id: id(),
136
+ scope: string("scope").notNull(),
137
+ path: string("path", 1024).notNull(),
138
+ parent: string("parent", 1024),
139
+ name: string("name").notNull(),
140
+ createdAt: timestampNow("created_at"),
141
+ },
142
+ (table) => [
143
+ uniqueIndex("storage_folder_scope_path_uk").on(
144
+ table.scope,
145
+ prefix(table.path, 512),
146
+ ),
147
+ index("storage_folder_scope_parent_idx").on(
148
+ table.scope,
149
+ prefix(table.parent, 512),
150
+ ),
151
+ ],
152
+ );
153
+
154
+ /**
155
+ * The FumaDB settings table. The Drizzle adapter reads the schema version
156
+ * from the default of its `version` column, which is stored as `value`.
157
+ */
158
+ export const dimahS3Settings = mysqlTable("private_dimah_s3_settings", {
159
+ key: string("key").primaryKey(),
160
+ version: text("value").collate(BINARY).notNull().default(SCHEMA_VERSION),
161
+ });
162
+
163
+ /**
164
+ * Every @dimah-s3/db table. Spread it into your Drizzle schema and keep its
165
+ * keys, because the FumaDB Drizzle adapter finds tables by them:
166
+ * `drizzle({ client, relations: defineRelations({ ...dimahS3Tables }) })`.
167
+ */
168
+ export const dimahS3Tables = {
169
+ storageObject,
170
+ storageFolder,
171
+ private_dimah_s3_settings: dimahS3Settings,
172
+ };
@@ -0,0 +1,140 @@
1
+ /**
2
+ * Drizzle schema for @dimah-s3/db on PostgreSQL. Copy this file into your
3
+ * app (`db/schema.ts`) to own the tables and add columns. Keep the table
4
+ * names, the column names, and the `dimahS3Tables` keys: the adapter finds
5
+ * the tables by those keys. A column you add must be nullable or have a
6
+ * default. The plugin does not read or write it.
7
+ *
8
+ * Import `dimahS3Tables` from `@dimah-s3/db/drizzle/pg` when the tables stay
9
+ * as they are. `drizzle-kit` then follows that import, and a later push
10
+ * drops a column that is not part of it.
11
+ *
12
+ * Matches `sql/pg.sql`. Requires `drizzle-orm` and `@paralleldrive/cuid2`.
13
+ */
14
+ import { createId } from "@paralleldrive/cuid2";
15
+ import { sql } from "drizzle-orm";
16
+ import {
17
+ bigint,
18
+ index,
19
+ json,
20
+ pgTable,
21
+ text,
22
+ timestamp,
23
+ unique,
24
+ varchar,
25
+ } from "drizzle-orm/pg-core";
26
+
27
+ type StorageObjectStatus = "pending" | "active" | "deleted" | "purging";
28
+
29
+ const SCHEMA_VERSION = "2.0.0";
30
+
31
+ function id() {
32
+ return varchar("id", { length: 255 })
33
+ .primaryKey()
34
+ .$defaultFn(() => createId());
35
+ }
36
+
37
+ function timestampNow(name: string) {
38
+ return timestamp(name)
39
+ .notNull()
40
+ .default(sql`CURRENT_TIMESTAMP`)
41
+ .$defaultFn(() => new Date());
42
+ }
43
+
44
+ function byteCount(name: string) {
45
+ return bigint(name, { mode: "number" });
46
+ }
47
+
48
+ /** The `storage_object` table: one row per tracked object. */
49
+ export const storageObject = pgTable(
50
+ "storage_object",
51
+ {
52
+ id: id(),
53
+ scope: text("scope").notNull(),
54
+ bucket: text("bucket").notNull(),
55
+ key: text("key").notNull(),
56
+ route: text("route").notNull(),
57
+ folder: text("folder"),
58
+ filename: text("filename").notNull(),
59
+ contentType: text("content_type"),
60
+ size: byteCount("size"),
61
+ declaredSize: byteCount("declared_size"),
62
+ eTag: text("e_tag"),
63
+ status: text("status").$type<StorageObjectStatus>().notNull(),
64
+ s3Metadata: json("s3_metadata").$type<Record<string, string>>(),
65
+ attributes: json("attributes"),
66
+ acl: text("acl"),
67
+ uploadId: text("upload_id"),
68
+ uploadToken: text("upload_token"),
69
+ expiresAt: timestamp("expires_at"),
70
+ confirmedAt: timestamp("confirmed_at"),
71
+ createdAt: timestampNow("created_at"),
72
+ updatedAt: timestampNow("updated_at"),
73
+ deletedAt: timestamp("deleted_at"),
74
+ },
75
+ (table) => [
76
+ unique("storage_object_bucket_key_uk").on(table.bucket, table.key),
77
+ index("storage_object_scope_folder_idx").on(
78
+ table.scope,
79
+ table.status,
80
+ table.folder,
81
+ table.createdAt,
82
+ ),
83
+ index("storage_object_scope_updated_idx").on(
84
+ table.scope,
85
+ table.status,
86
+ table.updatedAt,
87
+ ),
88
+ index("storage_object_scope_filename_idx").on(
89
+ table.scope,
90
+ table.status,
91
+ table.filename,
92
+ ),
93
+ index("storage_object_scope_size_idx").on(
94
+ table.scope,
95
+ table.status,
96
+ table.size,
97
+ ),
98
+ index("storage_object_status_expires_idx").on(
99
+ table.status,
100
+ table.expiresAt,
101
+ ),
102
+ ],
103
+ );
104
+
105
+ /** The `storage_folder` table: one row per folder, so empty folders list. */
106
+ export const storageFolder = pgTable(
107
+ "storage_folder",
108
+ {
109
+ id: id(),
110
+ scope: text("scope").notNull(),
111
+ path: text("path").notNull(),
112
+ parent: text("parent"),
113
+ name: text("name").notNull(),
114
+ createdAt: timestampNow("created_at"),
115
+ },
116
+ (table) => [
117
+ unique("storage_folder_scope_path_uk").on(table.scope, table.path),
118
+ index("storage_folder_scope_parent_idx").on(table.scope, table.parent),
119
+ ],
120
+ );
121
+
122
+ /**
123
+ * The FumaDB settings table. The Drizzle adapter reads the schema version
124
+ * from the default of its `version` column, which is stored as `value`.
125
+ */
126
+ export const dimahS3Settings = pgTable("private_dimah_s3_settings", {
127
+ key: varchar("key", { length: 255 }).primaryKey(),
128
+ version: text("value").notNull().default(SCHEMA_VERSION),
129
+ });
130
+
131
+ /**
132
+ * Every @dimah-s3/db table. Spread it into your Drizzle schema and keep its
133
+ * keys, because the FumaDB Drizzle adapter finds tables by them:
134
+ * `drizzle({ client, relations: defineRelations({ ...dimahS3Tables }) })`.
135
+ */
136
+ export const dimahS3Tables = {
137
+ storageObject,
138
+ storageFolder,
139
+ private_dimah_s3_settings: dimahS3Settings,
140
+ };