@dimah-s3/db 2.0.0-beta.5 → 2.0.0-beta.7
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.
- package/README.md +15 -6
- package/dist/adapters/drizzle.d.ts +2 -3
- package/dist/adapters/drizzle.d.ts.map +1 -1
- package/dist/adapters/kysely.d.ts +1 -1
- package/dist/adapters/prisma.d.ts +1 -1
- package/dist/cli.d.ts +17 -12
- package/dist/cli.d.ts.map +1 -1
- package/dist/cli.js +42 -74
- package/dist/cli.js.map +1 -1
- package/dist/client/index.js +1 -0
- package/dist/client/index.js.map +1 -1
- package/dist/folder-path.d.ts +8 -2
- package/dist/folder-path.d.ts.map +1 -1
- package/dist/fuma-db.d.ts +19 -22
- package/dist/fuma-db.d.ts.map +1 -1
- package/dist/index.js +69 -101
- package/dist/index.js.map +1 -1
- package/dist/plugin/scope.d.ts +2 -0
- package/dist/plugin/scope.d.ts.map +1 -1
- package/dist/schema/schema.d.ts +33 -48
- package/dist/schema/schema.d.ts.map +1 -1
- package/dist/store/folder-store.d.ts.map +1 -1
- package/dist/store/map-row.d.ts +2 -8
- package/dist/store/map-row.d.ts.map +1 -1
- package/dist/store/object-store.d.ts.map +1 -1
- package/dist/types/plugin.d.ts +4 -3
- package/dist/types/plugin.d.ts.map +1 -1
- package/package.json +8 -26
- package/dist/drizzle/mysql.d.ts +0 -1057
- package/dist/drizzle/mysql.d.ts.map +0 -1
- package/dist/drizzle/mysql.js +0 -120
- package/dist/drizzle/mysql.js.map +0 -1
- package/dist/drizzle/pg.d.ts +0 -994
- package/dist/drizzle/pg.d.ts.map +0 -1
- package/dist/drizzle/pg.js +0 -104
- package/dist/drizzle/pg.js.map +0 -1
- package/dist/drizzle/shared.d.ts +0 -7
- package/dist/drizzle/shared.d.ts.map +0 -1
- package/dist/drizzle/sqlite.d.ts +0 -1056
- package/dist/drizzle/sqlite.d.ts.map +0 -1
- package/dist/drizzle/sqlite.js +0 -107
- package/dist/drizzle/sqlite.js.map +0 -1
- package/prisma/dimah-s3.prisma +0 -81
- package/sql/mysql.sql +0 -60
- package/sql/pg.sql +0 -53
- package/sql/sqlite.sql +0 -55
- package/src/drizzle/mysql.ts +0 -175
- package/src/drizzle/pg.ts +0 -146
- package/src/drizzle/sqlite.ts +0 -150
package/README.md
CHANGED
|
@@ -12,16 +12,25 @@ Optional database plugin for [dimah-s3](https://github.com/dimah-kz/dimah-s3). I
|
|
|
12
12
|
pnpm add @dimah-s3/db@beta @dimah-s3/server@beta
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
-
You do not install `fumadb`: the adapters ship from `@dimah-s3/db/adapters
|
|
15
|
+
You do not install `fumadb`: the adapters ship from `@dimah-s3/db/adapters/*`, and the FumaDB CLI from `@dimah-s3/db/cli`.
|
|
16
16
|
|
|
17
17
|
## Tables
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
`runCli(client)` from `@dimah-s3/db/cli` runs the FumaDB CLI for this schema:
|
|
20
20
|
|
|
21
|
-
- Drizzle:
|
|
22
|
-
-
|
|
23
|
-
|
|
24
|
-
|
|
21
|
+
- Drizzle or Prisma: `generate` writes the tables or models, with the indexes and the MySQL prefix lengths and collations. Apply them with `drizzle-kit` or Prisma Migrate. Generating does not connect to the database.
|
|
22
|
+
- Kysely: `migrate` creates the tables and the indexes, and so does `migrate(client)`.
|
|
23
|
+
|
|
24
|
+
```ts
|
|
25
|
+
// scripts/dimah-s3.ts — npx tsx scripts/dimah-s3.ts generate latest -o db/dimah-s3.ts
|
|
26
|
+
import { DimahS3DB } from "@dimah-s3/db";
|
|
27
|
+
import { drizzleAdapter } from "@dimah-s3/db/adapters/drizzle";
|
|
28
|
+
import { runCli } from "@dimah-s3/db/cli";
|
|
29
|
+
|
|
30
|
+
await runCli(
|
|
31
|
+
DimahS3DB.client(drizzleAdapter({ db: undefined, provider: "sqlite" })),
|
|
32
|
+
);
|
|
33
|
+
```
|
|
25
34
|
|
|
26
35
|
The package reads schema `2.1.0` and does not upgrade a 1.x or `2.0.0` database: create the tables on a new database. A database at another schema version throws on the first query. Call `s3.db.checkSchema()` at startup to fail fast.
|
|
27
36
|
|
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* The FumaDB Drizzle adapter. Pass a Drizzle instance whose
|
|
3
|
-
* the tables
|
|
4
|
-
* imported as `dimahS3Tables` from `@dimah-s3/db/drizzle/<dialect>`:
|
|
2
|
+
* The FumaDB Drizzle adapter. Pass a Drizzle instance whose relations include
|
|
3
|
+
* the tables `runCli` → `generate` writes:
|
|
5
4
|
* `DimahS3DB.client(drizzleAdapter({ db, provider: "postgresql" }))`.
|
|
6
5
|
*/
|
|
7
6
|
export { drizzleAdapter, type DrizzleConfig } from "fumadb/adapters/drizzle";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"drizzle.d.ts","sourceRoot":"","sources":["../../src/adapters/drizzle.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"drizzle.d.ts","sourceRoot":"","sources":["../../src/adapters/drizzle.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,cAAc,EAAE,KAAK,aAAa,EAAE,MAAM,yBAAyB,CAAC"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* The FumaDB Kysely adapter.
|
|
2
|
+
* The FumaDB Kysely adapter. `migrate(client)` creates the schema through it:
|
|
3
3
|
* `DimahS3DB.client(kyselyAdapter({ db, provider: "postgresql" }))`.
|
|
4
4
|
*/
|
|
5
5
|
export { kyselyAdapter } from "fumadb/adapters/kysely";
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* The FumaDB Prisma adapter. Pass a Prisma client generated with the models
|
|
3
|
-
*
|
|
3
|
+
* `runCli` → `generate` writes:
|
|
4
4
|
* `DimahS3DB.client(prismaAdapter({ prisma, provider: "postgresql" }))`.
|
|
5
5
|
*/
|
|
6
6
|
export { prismaAdapter, type PrismaConfig } from "fumadb/adapters/prisma";
|
package/dist/cli.d.ts
CHANGED
|
@@ -1,25 +1,30 @@
|
|
|
1
1
|
import { type DimahS3DbClient } from "./fuma-db";
|
|
2
2
|
/**
|
|
3
|
-
* Runs the
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
*
|
|
7
|
-
*
|
|
3
|
+
* Runs the FumaDB CLI for the @dimah-s3/db schema. `generate` writes the
|
|
4
|
+
* Drizzle or Prisma schema for the client's adapter, and with Kysely, the SQL
|
|
5
|
+
* that creates the tables. `migrate` creates them with Kysely.
|
|
6
|
+
*
|
|
7
|
+
* Generating does not query the database, so the client can wrap an adapter
|
|
8
|
+
* that has no connection yet.
|
|
8
9
|
*
|
|
9
10
|
* ```ts
|
|
10
|
-
* // scripts/
|
|
11
|
+
* // scripts/dimah-s3.mts
|
|
12
|
+
* import { DimahS3DB } from "@dimah-s3/db";
|
|
13
|
+
* import { drizzleAdapter } from "@dimah-s3/db/adapters/drizzle";
|
|
11
14
|
* import { runCli } from "@dimah-s3/db/cli";
|
|
12
|
-
* import { dimahS3Db } from "../lib/s3";
|
|
13
15
|
*
|
|
14
|
-
* await runCli(
|
|
16
|
+
* await runCli(DimahS3DB.client(drizzleAdapter({ db: undefined, provider: "postgresql" })));
|
|
15
17
|
* ```
|
|
18
|
+
*
|
|
19
|
+
* `node scripts/dimah-s3.mts generate latest -o db/dimah-s3.ts`
|
|
16
20
|
*/
|
|
17
21
|
export declare function runCli(client: DimahS3DbClient): Promise<void>;
|
|
18
22
|
/**
|
|
19
|
-
* Creates the schema this package reads,
|
|
20
|
-
*
|
|
21
|
-
*
|
|
22
|
-
*
|
|
23
|
+
* Creates the schema this package reads, with its indexes, on an empty
|
|
24
|
+
* database. It needs the Kysely adapter; with Drizzle or Prisma, generate the
|
|
25
|
+
* schema with {@link runCli} and apply it with your ORM. It does nothing on a
|
|
26
|
+
* database already at {@link DB_SCHEMA_VERSION}, and throws on a database at
|
|
27
|
+
* another version: this package does not upgrade one.
|
|
23
28
|
*
|
|
24
29
|
* ```ts
|
|
25
30
|
* import { DimahS3DB } from "@dimah-s3/db";
|
package/dist/cli.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AACA,OAAO,EAAqB,KAAK,eAAe,EAAE,MAAM,WAAW,CAAC;
|
|
1
|
+
{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AACA,OAAO,EAAqB,KAAK,eAAe,EAAE,MAAM,WAAW,CAAC;AAIpE;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,MAAM,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAS7D;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,OAAO,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAcpE"}
|
package/dist/cli.js
CHANGED
|
@@ -3,120 +3,90 @@ import { fumadb } from 'fumadb';
|
|
|
3
3
|
import { table, column, idColumn, schema } from 'fumadb/schema';
|
|
4
4
|
|
|
5
5
|
// src/cli.ts
|
|
6
|
-
|
|
7
|
-
|
|
6
|
+
var BINARY = { mysql: "utf8mb4_bin" };
|
|
7
|
+
var TEXT = { mysql: "utf8mb4_unicode_ci" };
|
|
8
|
+
var LONG_PREFIX = 512;
|
|
9
|
+
var SCOPE_MAX_LENGTH = 255;
|
|
10
|
+
function string(name, length = 255) {
|
|
11
|
+
return column(name, `varchar(${length})`).collate(BINARY);
|
|
8
12
|
}
|
|
9
13
|
var storageObject = table("storage_object", {
|
|
10
|
-
id: idColumn("id", "varchar(255)").defaultTo$("auto"),
|
|
14
|
+
id: idColumn("id", "varchar(255)").collate(BINARY).defaultTo$("auto"),
|
|
11
15
|
/** Owner, for example `user:123` or `org:acme`. */
|
|
12
|
-
scope:
|
|
13
|
-
bucket:
|
|
14
|
-
key:
|
|
16
|
+
scope: string("scope", SCOPE_MAX_LENGTH),
|
|
17
|
+
bucket: string("bucket"),
|
|
18
|
+
key: string("key", 1024),
|
|
15
19
|
/** Named dimah-s3 route that created the object. */
|
|
16
|
-
route:
|
|
20
|
+
route: string("route"),
|
|
17
21
|
/** Folder that holds the object. `null` is the root. */
|
|
18
|
-
folderId:
|
|
19
|
-
filename: column("filename", "
|
|
20
|
-
contentType:
|
|
22
|
+
folderId: string("folder_id").nullable(),
|
|
23
|
+
filename: column("filename", "varchar(255)").collate(TEXT),
|
|
24
|
+
contentType: string("content_type").nullable(),
|
|
21
25
|
/** Verified size from HeadObject, set on confirm. */
|
|
22
|
-
size:
|
|
26
|
+
size: column("size", "bigint").nullable(),
|
|
23
27
|
/** Size the client declared before confirm. Quota counts it while pending. */
|
|
24
|
-
declaredSize:
|
|
25
|
-
eTag:
|
|
26
|
-
status:
|
|
28
|
+
declaredSize: column("declared_size", "bigint").nullable(),
|
|
29
|
+
eTag: string("e_tag").nullable(),
|
|
30
|
+
status: string("status", 16),
|
|
27
31
|
/** S3 user metadata of the verified object. */
|
|
28
32
|
s3Metadata: column("s3_metadata", "json").nullable(),
|
|
29
33
|
/** App attributes, validated by the plugin's `attributes.schema`. */
|
|
30
34
|
attributes: column("attributes", "json").nullable(),
|
|
31
|
-
acl:
|
|
35
|
+
acl: string("acl").nullable(),
|
|
32
36
|
/** Multipart upload ID while the row is pending. */
|
|
33
|
-
uploadId: column("upload_id", "string").nullable(),
|
|
37
|
+
uploadId: column("upload_id", "string").collate(BINARY).nullable(),
|
|
34
38
|
/** Token of the upload ticket that wrote the row. Confirm and purge match it. */
|
|
35
|
-
uploadToken:
|
|
39
|
+
uploadToken: string("upload_token", 64).nullable(),
|
|
36
40
|
/** Confirm deadline of a pending row (the upload ticket's expiry). */
|
|
37
41
|
expiresAt: column("expires_at", "timestamp").nullable(),
|
|
38
42
|
confirmedAt: column("confirmed_at", "timestamp").nullable(),
|
|
39
43
|
createdAt: column("created_at", "timestamp").defaultTo$("now"),
|
|
40
44
|
updatedAt: column("updated_at", "timestamp").defaultTo$("now"),
|
|
41
45
|
deletedAt: column("deleted_at", "timestamp").nullable()
|
|
42
|
-
}).unique("storage_object_bucket_key_uk", ["bucket", "key"]
|
|
46
|
+
}).unique("storage_object_bucket_key_uk", ["bucket", "key"], {
|
|
47
|
+
length: { key: LONG_PREFIX }
|
|
48
|
+
}).index("storage_object_scope_folder_idx", [
|
|
49
|
+
"scope",
|
|
50
|
+
"status",
|
|
51
|
+
"folderId",
|
|
52
|
+
"createdAt"
|
|
53
|
+
]).index("storage_object_scope_updated_idx", ["scope", "status", "updatedAt"]).index("storage_object_scope_filename_idx", ["scope", "status", "filename"]).index("storage_object_scope_size_idx", ["scope", "status", "size"]).index("storage_object_status_expires_idx", ["status", "expiresAt"]);
|
|
43
54
|
var storageFolder = table("storage_folder", {
|
|
44
|
-
id: idColumn("id", "varchar(255)").defaultTo$("auto"),
|
|
45
|
-
scope:
|
|
55
|
+
id: idColumn("id", "varchar(255)").collate(BINARY).defaultTo$("auto"),
|
|
56
|
+
scope: string("scope", SCOPE_MAX_LENGTH),
|
|
46
57
|
/** Id of the containing folder. `""` is the root. */
|
|
47
|
-
parentId:
|
|
58
|
+
parentId: string("parent_id").defaultTo(""),
|
|
48
59
|
/** Last segment of `path`. */
|
|
49
|
-
name:
|
|
60
|
+
name: string("name"),
|
|
50
61
|
/** Full folder path. */
|
|
51
|
-
path:
|
|
62
|
+
path: string("path", 1024),
|
|
52
63
|
createdAt: column("created_at", "timestamp").defaultTo$("now"),
|
|
53
64
|
updatedAt: column("updated_at", "timestamp").defaultTo$("now")
|
|
54
|
-
}).unique("storage_folder_scope_path_uk", ["scope", "path"]
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
name: "storage_object_scope_folder_idx",
|
|
58
|
-
table: "storage_object",
|
|
59
|
-
columns: ["scope", "status", "folder_id", "created_at"]
|
|
60
|
-
},
|
|
61
|
-
{
|
|
62
|
-
name: "storage_object_scope_updated_idx",
|
|
63
|
-
table: "storage_object",
|
|
64
|
-
columns: ["scope", "status", "updated_at"]
|
|
65
|
-
},
|
|
66
|
-
{
|
|
67
|
-
name: "storage_object_scope_filename_idx",
|
|
68
|
-
table: "storage_object",
|
|
69
|
-
columns: ["scope", "status", "filename"]
|
|
70
|
-
},
|
|
71
|
-
{
|
|
72
|
-
name: "storage_object_scope_size_idx",
|
|
73
|
-
table: "storage_object",
|
|
74
|
-
columns: ["scope", "status", "size"]
|
|
75
|
-
},
|
|
76
|
-
{
|
|
77
|
-
name: "storage_object_status_expires_idx",
|
|
78
|
-
table: "storage_object",
|
|
79
|
-
columns: ["status", "expires_at"]
|
|
80
|
-
}
|
|
81
|
-
];
|
|
82
|
-
var custom = (sql) => ({ type: "custom", sql });
|
|
83
|
-
var PREDECESSOR_VERSION = "0.0.1";
|
|
84
|
-
var predecessor = schema({
|
|
85
|
-
version: PREDECESSOR_VERSION,
|
|
86
|
-
tables: {}
|
|
87
|
-
});
|
|
65
|
+
}).unique("storage_folder_scope_path_uk", ["scope", "path"], {
|
|
66
|
+
length: { path: LONG_PREFIX }
|
|
67
|
+
}).unique("storage_folder_scope_parent_name_uk", ["scope", "parentId", "name"]);
|
|
88
68
|
var dbSchema = schema({
|
|
89
69
|
version: "2.1.0",
|
|
90
70
|
tables: {
|
|
91
71
|
storageObject,
|
|
92
72
|
storageFolder
|
|
93
|
-
},
|
|
94
|
-
async up({ auto }) {
|
|
95
|
-
const indexes = schemaIndexes.map((index) => {
|
|
96
|
-
const columns = index.columns.map((name) => `"${name}"`).join(", ");
|
|
97
|
-
return custom(
|
|
98
|
-
`CREATE INDEX IF NOT EXISTS "${index.name}" ON "${index.table}" (${columns})`
|
|
99
|
-
);
|
|
100
|
-
});
|
|
101
|
-
return [...await auto(), ...indexes];
|
|
102
73
|
}
|
|
103
74
|
});
|
|
104
75
|
|
|
105
76
|
// src/fuma-db.ts
|
|
106
77
|
fumadb({
|
|
107
78
|
namespace: "dimah_s3",
|
|
108
|
-
schemas: [
|
|
79
|
+
schemas: [dbSchema]
|
|
109
80
|
});
|
|
110
81
|
var DB_SCHEMA_VERSION = dbSchema.version;
|
|
111
82
|
|
|
112
83
|
// src/cli.ts
|
|
113
|
-
var RESUMABLE = /* @__PURE__ */ new Set([PREDECESSOR_VERSION, DB_SCHEMA_VERSION]);
|
|
114
84
|
function runCli(client) {
|
|
115
85
|
const { main } = createCli({
|
|
116
86
|
db: client,
|
|
117
87
|
command: "dimah-s3-db",
|
|
118
88
|
description: "FumaDB CLI for @dimah-s3/db",
|
|
119
|
-
version: "2.0.0-beta.
|
|
89
|
+
version: "2.0.0-beta.7"
|
|
120
90
|
});
|
|
121
91
|
return main();
|
|
122
92
|
}
|
|
@@ -127,15 +97,13 @@ async function migrate(client) {
|
|
|
127
97
|
} catch {
|
|
128
98
|
version = void 0;
|
|
129
99
|
}
|
|
130
|
-
if (version
|
|
100
|
+
if (version === DB_SCHEMA_VERSION) return;
|
|
101
|
+
if (version !== void 0) {
|
|
131
102
|
throw new Error(
|
|
132
103
|
`[dimah-s3/db] The database is at schema ${version}, which this package does not upgrade. Create schema ${DB_SCHEMA_VERSION} on a new database.`
|
|
133
104
|
);
|
|
134
105
|
}
|
|
135
|
-
|
|
136
|
-
for (let next = await migrator.next(); next; next = await migrator.next()) {
|
|
137
|
-
await (await migrator.up()).execute();
|
|
138
|
-
}
|
|
106
|
+
await (await client.createMigrator().migrateToLatest()).execute();
|
|
139
107
|
}
|
|
140
108
|
|
|
141
109
|
export { migrate, runCli };
|
package/dist/cli.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/schema/schema.ts","../src/fuma-db.ts","../src/cli.ts"],"names":[],"mappings":";;;;;AASA,SAAS,UAAU,IAAA,EAAc;AAC/B,EAAA,OAAO,MAAA,CAAO,IAAA,EAAM,QAAQ,CAAA,CAAE,QAAA,EAAS;AAKzC;AAOA,IAAM,aAAA,GAAgB,MAAM,gBAAA,EAAkB;AAAA,EAC5C,IAAI,QAAA,CAAS,IAAA,EAAM,cAAc,CAAA,CAAE,WAAW,MAAM,CAAA;AAAA;AAAA,EAEpD,KAAA,EAAO,MAAA,CAAO,OAAA,EAAS,QAAQ,CAAA;AAAA,EAC/B,MAAA,EAAQ,MAAA,CAAO,QAAA,EAAU,QAAQ,CAAA;AAAA,EACjC,GAAA,EAAK,MAAA,CAAO,KAAA,EAAO,QAAQ,CAAA;AAAA;AAAA,EAE3B,KAAA,EAAO,MAAA,CAAO,OAAA,EAAS,QAAQ,CAAA;AAAA;AAAA,EAE/B,QAAA,EAAU,MAAA,CAAO,WAAA,EAAa,QAAQ,EAAE,QAAA,EAAS;AAAA,EACjD,QAAA,EAAU,MAAA,CAAO,UAAA,EAAY,QAAQ,CAAA;AAAA,EACrC,WAAA,EAAa,MAAA,CAAO,cAAA,EAAgB,QAAQ,EAAE,QAAA,EAAS;AAAA;AAAA,EAEvD,IAAA,EAAM,UAAU,MAAM,CAAA;AAAA;AAAA,EAEtB,YAAA,EAAc,UAAU,eAAe,CAAA;AAAA,EACvC,IAAA,EAAM,MAAA,CAAO,OAAA,EAAS,QAAQ,EAAE,QAAA,EAAS;AAAA,EACzC,MAAA,EAAQ,MAAA,CAAO,QAAA,EAAU,QAAQ,CAAA;AAAA;AAAA,EAEjC,UAAA,EAAY,MAAA,CAAO,aAAA,EAAe,MAAM,EAAE,QAAA,EAAS;AAAA;AAAA,EAEnD,UAAA,EAAY,MAAA,CAAO,YAAA,EAAc,MAAM,EAAE,QAAA,EAAS;AAAA,EAClD,GAAA,EAAK,MAAA,CAAO,KAAA,EAAO,QAAQ,EAAE,QAAA,EAAS;AAAA;AAAA,EAEtC,QAAA,EAAU,MAAA,CAAO,WAAA,EAAa,QAAQ,EAAE,QAAA,EAAS;AAAA;AAAA,EAEjD,WAAA,EAAa,MAAA,CAAO,cAAA,EAAgB,QAAQ,EAAE,QAAA,EAAS;AAAA;AAAA,EAEvD,SAAA,EAAW,MAAA,CAAO,YAAA,EAAc,WAAW,EAAE,QAAA,EAAS;AAAA,EACtD,WAAA,EAAa,MAAA,CAAO,cAAA,EAAgB,WAAW,EAAE,QAAA,EAAS;AAAA,EAC1D,WAAW,MAAA,CAAO,YAAA,EAAc,WAAW,CAAA,CAAE,WAAW,KAAK,CAAA;AAAA,EAC7D,WAAW,MAAA,CAAO,YAAA,EAAc,WAAW,CAAA,CAAE,WAAW,KAAK,CAAA;AAAA,EAC7D,SAAA,EAAW,MAAA,CAAO,YAAA,EAAc,WAAW,EAAE,QAAA;AAC/C,CAAC,EAAE,MAAA,CAAO,8BAAA,EAAgC,CAAC,QAAA,EAAU,KAAK,CAAC,CAAA;AAQ3D,IAAM,aAAA,GAAgB,MAAM,gBAAA,EAAkB;AAAA,EAC5C,IAAI,QAAA,CAAS,IAAA,EAAM,cAAc,CAAA,CAAE,WAAW,MAAM,CAAA;AAAA,EACpD,KAAA,EAAO,MAAA,CAAO,OAAA,EAAS,QAAQ,CAAA;AAAA;AAAA,EAE/B,QAAA,EAAU,MAAA,CAAO,WAAA,EAAa,QAAQ,CAAA;AAAA;AAAA,EAEtC,IAAA,EAAM,MAAA,CAAO,MAAA,EAAQ,QAAQ,CAAA;AAAA;AAAA,EAE7B,IAAA,EAAM,MAAA,CAAO,MAAA,EAAQ,QAAQ,CAAA;AAAA,EAC7B,WAAW,MAAA,CAAO,YAAA,EAAc,WAAW,CAAA,CAAE,WAAW,KAAK,CAAA;AAAA,EAC7D,WAAW,MAAA,CAAO,YAAA,EAAc,WAAW,CAAA,CAAE,WAAW,KAAK;AAC/D,CAAC,CAAA,CACE,MAAA,CAAO,8BAAA,EAAgC,CAAC,SAAS,MAAM,CAAC,CAAA,CACxD,MAAA,CAAO,qCAAA,EAAuC,CAAC,OAAA,EAAS,UAAA,EAAY,MAAM,CAAC,CAAA;AAcvE,IAAM,aAAA,GAAwC;AAAA,EACnD;AAAA,IACE,IAAA,EAAM,iCAAA;AAAA,IACN,KAAA,EAAO,gBAAA;AAAA,IACP,OAAA,EAAS,CAAC,OAAA,EAAS,QAAA,EAAU,aAAa,YAAY;AAAA,GACxD;AAAA,EACA;AAAA,IACE,IAAA,EAAM,kCAAA;AAAA,IACN,KAAA,EAAO,gBAAA;AAAA,IACP,OAAA,EAAS,CAAC,OAAA,EAAS,QAAA,EAAU,YAAY;AAAA,GAC3C;AAAA,EACA;AAAA,IACE,IAAA,EAAM,mCAAA;AAAA,IACN,KAAA,EAAO,gBAAA;AAAA,IACP,OAAA,EAAS,CAAC,OAAA,EAAS,QAAA,EAAU,UAAU;AAAA,GACzC;AAAA,EACA;AAAA,IACE,IAAA,EAAM,+BAAA;AAAA,IACN,KAAA,EAAO,gBAAA;AAAA,IACP,OAAA,EAAS,CAAC,OAAA,EAAS,QAAA,EAAU,MAAM;AAAA,GACrC;AAAA,EACA;AAAA,IACE,IAAA,EAAM,mCAAA;AAAA,IACN,KAAA,EAAO,gBAAA;AAAA,IACP,OAAA,EAAS,CAAC,QAAA,EAAU,YAAY;AAAA;AAEpC,CAAA;AAEA,IAAM,SAAS,CAAC,GAAA,MAAiB,EAAE,IAAA,EAAM,UAAmB,GAAA,EAAI,CAAA;AAQzD,IAAM,mBAAA,GAAsB,OAAA;AAE5B,IAAM,cAAc,MAAA,CAAO;AAAA,EAChC,OAAA,EAAS,mBAAA;AAAA,EACT,QAAQ;AACV,CAAC,CAAA;AAMM,IAAM,WAAW,MAAA,CAAO;AAAA,EAC7B,OAAA,EAAS,OAAA;AAAA,EACT,MAAA,EAAQ;AAAA,IACN,aAAA;AAAA,IACA;AAAA,GACF;AAAA,EACA,MAAM,EAAA,CAAG,EAAE,IAAA,EAAK,EAAG;AACjB,IAAA,MAAM,OAAA,GAAU,aAAA,CAAc,GAAA,CAAI,CAAC,KAAA,KAAU;AAC3C,MAAA,MAAM,OAAA,GAAU,KAAA,CAAM,OAAA,CAAQ,GAAA,CAAI,CAAC,IAAA,KAAS,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA,CAAG,CAAA,CAAE,IAAA,CAAK,IAAI,CAAA;AAClE,MAAA,OAAO,MAAA;AAAA,QACL,+BAA+B,KAAA,CAAM,IAAI,SAAS,KAAA,CAAM,KAAK,MAAM,OAAO,CAAA,CAAA;AAAA,OAC5E;AAAA,IACF,CAAC,CAAA;AACD,IAAA,OAAO,CAAC,GAAI,MAAM,IAAA,EAAK,EAAI,GAAG,OAAO,CAAA;AAAA,EACvC;AACF,CAAC,CAAA;;;AC9IwB,MAAA,CAAO;AAAA,EAC9B,SAAA,EAAW,UAAA;AAAA,EACX,OAAA,EAAS,CAAC,WAAA,EAAa,QAAQ;AACjC,CAAC;AAMM,IAAM,oBAAoB,QAAA,CAAS,OAAA;;;ACR1C,IAAM,4BAAY,IAAI,GAAA,CAAY,CAAC,mBAAA,EAAqB,iBAAiB,CAAC,CAAA;AAiBnE,SAAS,OAAO,MAAA,EAAwC;AAC7D,EAAA,MAAM,EAAE,IAAA,EAAK,GAAI,SAAA,CAAU;AAAA,IACzB,EAAA,EAAI,MAAA;AAAA,IACJ,OAAA,EAAS,aAAA;AAAA,IACT,WAAA,EAAa,6BAAA;AAAA,IACb,OAAA,EAAS;AAAA,GACV,CAAA;AAED,EAAA,OAAO,IAAA,EAAK;AACd;AAgBA,eAAsB,QAAQ,MAAA,EAAwC;AACpE,EAAA,IAAI,OAAA;AACJ,EAAA,IAAI;AACF,IAAA,OAAA,GAAU,MAAM,OAAO,OAAA,EAAQ;AAAA,EACjC,CAAA,CAAA,MAAQ;AACN,IAAA,OAAA,GAAU,MAAA;AAAA,EACZ;AACA,EAAA,IAAI,YAAY,MAAA,IAAa,CAAC,SAAA,CAAU,GAAA,CAAI,OAAO,CAAA,EAAG;AACpD,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,wCAAA,EAA2C,OAAO,CAAA,qDAAA,EAAwD,iBAAiB,CAAA,mBAAA;AAAA,KAC7H;AAAA,EACF;AACA,EAAA,MAAM,QAAA,GAAW,OAAO,cAAA,EAAe;AACvC,EAAA,KAAA,IAAS,IAAA,GAAO,MAAM,QAAA,CAAS,IAAA,EAAK,EAAG,MAAM,IAAA,GAAO,MAAM,QAAA,CAAS,IAAA,EAAK,EAAG;AACzE,IAAA,MAAA,CAAO,MAAM,QAAA,CAAS,EAAA,EAAG,EAAG,OAAA,EAAQ;AAAA,EACtC;AACF","file":"cli.js","sourcesContent":["import { column, idColumn, schema, table, type Column } from \"fumadb/schema\";\n\n/**\n * A byte count. The column is a `bigint` (int8 on PostgreSQL and MySQL), but\n * values are bound as numbers so SQLite stores a number instead of FumaDB's\n * 8-byte blob, which would sort after every number: INTEGER in the shipped\n * SQL, or REAL in a column FumaDB created, compared by value either way.\n * Drivers read int8 back as a number, a bigint, or a string.\n */\nfunction byteCount(name: string) {\n return column(name, \"bigint\").nullable() as unknown as Column<\n \"bigint\",\n number | null,\n number | bigint | string | null\n >;\n}\n\n/**\n * One row per tracked object:\n * `pending` (presigned) → `active` (confirmed) → `deleted` (soft delete).\n * `purging` marks a stale pending row that purge has claimed.\n */\nconst storageObject = table(\"storage_object\", {\n id: idColumn(\"id\", \"varchar(255)\").defaultTo$(\"auto\"),\n /** Owner, for example `user:123` or `org:acme`. */\n scope: column(\"scope\", \"string\"),\n bucket: column(\"bucket\", \"string\"),\n key: column(\"key\", \"string\"),\n /** Named dimah-s3 route that created the object. */\n route: column(\"route\", \"string\"),\n /** Folder that holds the object. `null` is the root. */\n folderId: column(\"folder_id\", \"string\").nullable(),\n filename: column(\"filename\", \"string\"),\n contentType: column(\"content_type\", \"string\").nullable(),\n /** Verified size from HeadObject, set on confirm. */\n size: byteCount(\"size\"),\n /** Size the client declared before confirm. Quota counts it while pending. */\n declaredSize: byteCount(\"declared_size\"),\n eTag: column(\"e_tag\", \"string\").nullable(),\n status: column(\"status\", \"string\"),\n /** S3 user metadata of the verified object. */\n s3Metadata: column(\"s3_metadata\", \"json\").nullable(),\n /** App attributes, validated by the plugin's `attributes.schema`. */\n attributes: column(\"attributes\", \"json\").nullable(),\n acl: column(\"acl\", \"string\").nullable(),\n /** Multipart upload ID while the row is pending. */\n uploadId: column(\"upload_id\", \"string\").nullable(),\n /** Token of the upload ticket that wrote the row. Confirm and purge match it. */\n uploadToken: column(\"upload_token\", \"string\").nullable(),\n /** Confirm deadline of a pending row (the upload ticket's expiry). */\n expiresAt: column(\"expires_at\", \"timestamp\").nullable(),\n confirmedAt: column(\"confirmed_at\", \"timestamp\").nullable(),\n createdAt: column(\"created_at\", \"timestamp\").defaultTo$(\"now\"),\n updatedAt: column(\"updated_at\", \"timestamp\").defaultTo$(\"now\"),\n deletedAt: column(\"deleted_at\", \"timestamp\").nullable(),\n}).unique(\"storage_object_bucket_key_uk\", [\"bucket\", \"key\"]);\n\n/**\n * One row per folder, so an empty folder still lists. `parentId` is `\"\"` at\n * the root: a nullable parent cannot be unique on PostgreSQL, MySQL, and\n * SQLite, and the root is not a row. `path` is a cache of `name` joined\n * through the parents, rewritten when a folder is renamed or moved.\n */\nconst storageFolder = table(\"storage_folder\", {\n id: idColumn(\"id\", \"varchar(255)\").defaultTo$(\"auto\"),\n scope: column(\"scope\", \"string\"),\n /** Id of the containing folder. `\"\"` is the root. */\n parentId: column(\"parent_id\", \"string\"),\n /** Last segment of `path`. */\n name: column(\"name\", \"string\"),\n /** Full folder path. */\n path: column(\"path\", \"string\"),\n createdAt: column(\"created_at\", \"timestamp\").defaultTo$(\"now\"),\n updatedAt: column(\"updated_at\", \"timestamp\").defaultTo$(\"now\"),\n})\n .unique(\"storage_folder_scope_path_uk\", [\"scope\", \"path\"])\n .unique(\"storage_folder_scope_parent_name_uk\", [\"scope\", \"parentId\", \"name\"]);\n\n/** A secondary index, by SQL table and column names. */\nexport type SchemaIndex = {\n name: string;\n table: \"storage_object\" | \"storage_folder\";\n columns: readonly string[];\n};\n\n/**\n * Secondary indexes. FumaDB cannot declare them, so {@link dbSchema}'s\n * migration, the SQL files, the Drizzle tables, and the Prisma schema carry\n * them.\n */\nexport const schemaIndexes: readonly SchemaIndex[] = [\n {\n name: \"storage_object_scope_folder_idx\",\n table: \"storage_object\",\n columns: [\"scope\", \"status\", \"folder_id\", \"created_at\"],\n },\n {\n name: \"storage_object_scope_updated_idx\",\n table: \"storage_object\",\n columns: [\"scope\", \"status\", \"updated_at\"],\n },\n {\n name: \"storage_object_scope_filename_idx\",\n table: \"storage_object\",\n columns: [\"scope\", \"status\", \"filename\"],\n },\n {\n name: \"storage_object_scope_size_idx\",\n table: \"storage_object\",\n columns: [\"scope\", \"status\", \"size\"],\n },\n {\n name: \"storage_object_status_expires_idx\",\n table: \"storage_object\",\n columns: [\"status\", \"expires_at\"],\n },\n];\n\nconst custom = (sql: string) => ({ type: \"custom\" as const, sql });\n\n/**\n * FumaDB runs `up` only when migrating from the previous entry, and skips\n * `up` on the first one. This empty entry exists so {@link dbSchema} can\n * create the indexes on a new database. A finished database is at\n * {@link dbSchema}.\n */\nexport const PREDECESSOR_VERSION = \"0.0.1\";\n\nexport const predecessor = schema({\n version: PREDECESSOR_VERSION,\n tables: {},\n});\n\n/**\n * The @dimah-s3/db schema, version `2.1.0`. The migration creates the\n * secondary indexes after the tables, because FumaDB cannot declare them.\n */\nexport const dbSchema = schema({\n version: \"2.1.0\",\n tables: {\n storageObject,\n storageFolder,\n },\n async up({ auto }) {\n const indexes = schemaIndexes.map((index) => {\n const columns = index.columns.map((name) => `\"${name}\"`).join(\", \");\n return custom(\n `CREATE INDEX IF NOT EXISTS \"${index.name}\" ON \"${index.table}\" (${columns})`,\n );\n });\n return [...(await auto()), ...indexes];\n },\n});\n","import { fumadb, type InferFumaDB } from \"fumadb\";\nimport { dbSchema, predecessor } from \"./schema/schema\";\n\n/**\n * The @dimah-s3/db FumaDB library. Call `DimahS3DB.client(adapter)` with an\n * adapter from `@dimah-s3/db/adapters/*` to get a {@link DimahS3DbClient}.\n *\n * `predecessor` is empty. FumaDB skips `up` on the first schema, and the\n * indexes are created in {@link dbSchema}'s `up`.\n */\nexport const DimahS3DB = fumadb({\n namespace: \"dimah_s3\",\n schemas: [predecessor, dbSchema],\n});\n\n/** FumaDB client for the @dimah-s3/db schema. */\nexport type DimahS3DbClient = InferFumaDB<typeof DimahS3DB>;\n\n/** The schema version the stores read and write. */\nexport const DB_SCHEMA_VERSION = dbSchema.version;\n","import { createCli } from \"fumadb/cli\";\nimport { DB_SCHEMA_VERSION, type DimahS3DbClient } from \"./fuma-db\";\nimport { PREDECESSOR_VERSION } from \"./schema/schema\";\n\ndeclare const __DIMAH_S3_DB_VERSION__: string;\n\n/**\n * Versions `migrate` may continue from: an empty database, a migration that\n * stopped on the empty predecessor, or a database already at\n * {@link DB_SCHEMA_VERSION}.\n */\nconst RESUMABLE = new Set<string>([PREDECESSOR_VERSION, DB_SCHEMA_VERSION]);\n\n/**\n * Runs the interactive FumaDB CLI: generate the ORM schema, or migrate when\n * the client uses the Kysely adapter. Prefer {@link migrate}. Only\n * `migrate:up`, one version at a time, runs the steps the schema needs,\n * including the indexes. The CLI `migrate` command jumps to the latest\n * schema and skips them.\n *\n * ```ts\n * // scripts/db.ts\n * import { runCli } from \"@dimah-s3/db/cli\";\n * import { dimahS3Db } from \"../lib/s3\";\n *\n * await runCli(dimahS3Db);\n * ```\n */\nexport function runCli(client: DimahS3DbClient): Promise<void> {\n const { main } = createCli({\n db: client,\n command: \"dimah-s3-db\",\n description: \"FumaDB CLI for @dimah-s3/db\",\n version: __DIMAH_S3_DB_VERSION__,\n });\n\n return main();\n}\n\n/**\n * Creates the schema this package reads, one version at a time, so the\n * schema's own steps run (the indexes among them). It needs the Kysely\n * adapter; with Drizzle or Prisma, use your ORM's migrations or the files\n * in `sql/`. It does not upgrade a database at another version.\n *\n * ```ts\n * import { DimahS3DB } from \"@dimah-s3/db\";\n * import { kyselyAdapter } from \"@dimah-s3/db/adapters/kysely\";\n * import { migrate } from \"@dimah-s3/db/cli\";\n *\n * await migrate(DimahS3DB.client(kyselyAdapter({ db: kysely, provider: \"postgresql\" })));\n * ```\n */\nexport async function migrate(client: DimahS3DbClient): Promise<void> {\n let version: string | undefined;\n try {\n version = await client.version();\n } catch {\n version = undefined;\n }\n if (version !== undefined && !RESUMABLE.has(version)) {\n throw new Error(\n `[dimah-s3/db] The database is at schema ${version}, which this package does not upgrade. Create schema ${DB_SCHEMA_VERSION} on a new database.`,\n );\n }\n const migrator = client.createMigrator();\n for (let next = await migrator.next(); next; next = await migrator.next()) {\n await (await migrator.up()).execute();\n }\n}\n"]}
|
|
1
|
+
{"version":3,"sources":["../src/schema/schema.ts","../src/fuma-db.ts","../src/cli.ts"],"names":[],"mappings":";;;;;AAMA,IAAM,MAAA,GAAS,EAAE,KAAA,EAAO,aAAA,EAAc;AAGtC,IAAM,IAAA,GAAO,EAAE,KAAA,EAAO,oBAAA,EAAqB;AAO3C,IAAM,WAAA,GAAc,GAAA;AAMb,IAAM,gBAAA,GAAmB,GAAA;AAEhC,SAAS,MAAA,CAAO,IAAA,EAAc,MAAA,GAAS,GAAA,EAAK;AAC1C,EAAA,OAAO,OAAO,IAAA,EAAM,CAAA,QAAA,EAAW,MAAM,CAAA,CAAA,CAAG,CAAA,CAAE,QAAQ,MAAM,CAAA;AAC1D;AAOA,IAAM,aAAA,GAAgB,MAAM,gBAAA,EAAkB;AAAA,EAC5C,EAAA,EAAI,SAAS,IAAA,EAAM,cAAc,EAAE,OAAA,CAAQ,MAAM,CAAA,CAAE,UAAA,CAAW,MAAM,CAAA;AAAA;AAAA,EAEpE,KAAA,EAAO,MAAA,CAAO,OAAA,EAAS,gBAAgB,CAAA;AAAA,EACvC,MAAA,EAAQ,OAAO,QAAQ,CAAA;AAAA,EACvB,GAAA,EAAK,MAAA,CAAO,KAAA,EAAO,IAAI,CAAA;AAAA;AAAA,EAEvB,KAAA,EAAO,OAAO,OAAO,CAAA;AAAA;AAAA,EAErB,QAAA,EAAU,MAAA,CAAO,WAAW,CAAA,CAAE,QAAA,EAAS;AAAA,EACvC,UAAU,MAAA,CAAO,UAAA,EAAY,cAAc,CAAA,CAAE,QAAQ,IAAI,CAAA;AAAA,EACzD,WAAA,EAAa,MAAA,CAAO,cAAc,CAAA,CAAE,QAAA,EAAS;AAAA;AAAA,EAE7C,IAAA,EAAM,MAAA,CAAO,MAAA,EAAQ,QAAQ,EAAE,QAAA,EAAS;AAAA;AAAA,EAExC,YAAA,EAAc,MAAA,CAAO,eAAA,EAAiB,QAAQ,EAAE,QAAA,EAAS;AAAA,EACzD,IAAA,EAAM,MAAA,CAAO,OAAO,CAAA,CAAE,QAAA,EAAS;AAAA,EAC/B,MAAA,EAAQ,MAAA,CAAO,QAAA,EAAU,EAAE,CAAA;AAAA;AAAA,EAE3B,UAAA,EAAY,MAAA,CAAO,aAAA,EAAe,MAAM,EAAE,QAAA,EAAS;AAAA;AAAA,EAEnD,UAAA,EAAY,MAAA,CAAO,YAAA,EAAc,MAAM,EAAE,QAAA,EAAS;AAAA,EAClD,GAAA,EAAK,MAAA,CAAO,KAAK,CAAA,CAAE,QAAA,EAAS;AAAA;AAAA,EAE5B,QAAA,EAAU,OAAO,WAAA,EAAa,QAAQ,EAAE,OAAA,CAAQ,MAAM,EAAE,QAAA,EAAS;AAAA;AAAA,EAEjE,WAAA,EAAa,MAAA,CAAO,cAAA,EAAgB,EAAE,EAAE,QAAA,EAAS;AAAA;AAAA,EAEjD,SAAA,EAAW,MAAA,CAAO,YAAA,EAAc,WAAW,EAAE,QAAA,EAAS;AAAA,EACtD,WAAA,EAAa,MAAA,CAAO,cAAA,EAAgB,WAAW,EAAE,QAAA,EAAS;AAAA,EAC1D,WAAW,MAAA,CAAO,YAAA,EAAc,WAAW,CAAA,CAAE,WAAW,KAAK,CAAA;AAAA,EAC7D,WAAW,MAAA,CAAO,YAAA,EAAc,WAAW,CAAA,CAAE,WAAW,KAAK,CAAA;AAAA,EAC7D,SAAA,EAAW,MAAA,CAAO,YAAA,EAAc,WAAW,EAAE,QAAA;AAC/C,CAAC,EACE,MAAA,CAAO,8BAAA,EAAgC,CAAC,QAAA,EAAU,KAAK,CAAA,EAAG;AAAA,EACzD,MAAA,EAAQ,EAAE,GAAA,EAAK,WAAA;AACjB,CAAC,CAAA,CACA,MAAM,iCAAA,EAAmC;AAAA,EACxC,OAAA;AAAA,EACA,QAAA;AAAA,EACA,UAAA;AAAA,EACA;AACF,CAAC,CAAA,CACA,KAAA,CAAM,kCAAA,EAAoC,CAAC,OAAA,EAAS,QAAA,EAAU,WAAW,CAAC,CAAA,CAC1E,KAAA,CAAM,mCAAA,EAAqC,CAAC,SAAS,QAAA,EAAU,UAAU,CAAC,CAAA,CAC1E,KAAA,CAAM,+BAAA,EAAiC,CAAC,OAAA,EAAS,QAAA,EAAU,MAAM,CAAC,CAAA,CAClE,KAAA,CAAM,mCAAA,EAAqC,CAAC,QAAA,EAAU,WAAW,CAAC,CAAA;AAQrE,IAAM,aAAA,GAAgB,MAAM,gBAAA,EAAkB;AAAA,EAC5C,EAAA,EAAI,SAAS,IAAA,EAAM,cAAc,EAAE,OAAA,CAAQ,MAAM,CAAA,CAAE,UAAA,CAAW,MAAM,CAAA;AAAA,EACpE,KAAA,EAAO,MAAA,CAAO,OAAA,EAAS,gBAAgB,CAAA;AAAA;AAAA,EAEvC,QAAA,EAAU,MAAA,CAAO,WAAW,CAAA,CAAE,UAAU,EAAE,CAAA;AAAA;AAAA,EAE1C,IAAA,EAAM,OAAO,MAAM,CAAA;AAAA;AAAA,EAEnB,IAAA,EAAM,MAAA,CAAO,MAAA,EAAQ,IAAI,CAAA;AAAA,EACzB,WAAW,MAAA,CAAO,YAAA,EAAc,WAAW,CAAA,CAAE,WAAW,KAAK,CAAA;AAAA,EAC7D,WAAW,MAAA,CAAO,YAAA,EAAc,WAAW,CAAA,CAAE,WAAW,KAAK;AAC/D,CAAC,EACE,MAAA,CAAO,8BAAA,EAAgC,CAAC,OAAA,EAAS,MAAM,CAAA,EAAG;AAAA,EACzD,MAAA,EAAQ,EAAE,IAAA,EAAM,WAAA;AAClB,CAAC,EACA,MAAA,CAAO,qCAAA,EAAuC,CAAC,OAAA,EAAS,UAAA,EAAY,MAAM,CAAC,CAAA;AAOvE,IAAM,WAAW,MAAA,CAAO;AAAA,EAC7B,OAAA,EAAS,OAAA;AAAA,EACT,MAAA,EAAQ;AAAA,IACN,aAAA;AAAA,IACA;AAAA;AAEJ,CAAC,CAAA;;;AC5GwB,MAAA,CAAO;AAAA,EAC9B,SAAA,EAAW,UAAA;AAAA,EACX,OAAA,EAAS,CAAC,QAAQ;AACpB,CAAC;AAMM,IAAM,oBAAoB,QAAA,CAAS,OAAA;;;ACQnC,SAAS,OAAO,MAAA,EAAwC;AAC7D,EAAA,MAAM,EAAE,IAAA,EAAK,GAAI,SAAA,CAAU;AAAA,IACzB,EAAA,EAAI,MAAA;AAAA,IACJ,OAAA,EAAS,aAAA;AAAA,IACT,WAAA,EAAa,6BAAA;AAAA,IACb,OAAA,EAAS;AAAA,GACV,CAAA;AAED,EAAA,OAAO,IAAA,EAAK;AACd;AAiBA,eAAsB,QAAQ,MAAA,EAAwC;AACpE,EAAA,IAAI,OAAA;AACJ,EAAA,IAAI;AACF,IAAA,OAAA,GAAU,MAAM,OAAO,OAAA,EAAQ;AAAA,EACjC,CAAA,CAAA,MAAQ;AACN,IAAA,OAAA,GAAU,MAAA;AAAA,EACZ;AACA,EAAA,IAAI,YAAY,iBAAA,EAAmB;AACnC,EAAA,IAAI,YAAY,MAAA,EAAW;AACzB,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,wCAAA,EAA2C,OAAO,CAAA,qDAAA,EAAwD,iBAAiB,CAAA,mBAAA;AAAA,KAC7H;AAAA,EACF;AACA,EAAA,MAAA,CAAO,MAAM,MAAA,CAAO,cAAA,EAAe,CAAE,eAAA,IAAmB,OAAA,EAAQ;AAClE","file":"cli.js","sourcesContent":["import { column, idColumn, schema, table } from \"fumadb/schema\";\n\n/**\n * MySQL collation of every text column but `filename`: keys, scopes, ids, and\n * upload tokens compare byte for byte.\n */\nconst BINARY = { mysql: \"utf8mb4_bin\" };\n\n/** MySQL collation of `filename`: case-insensitive, for search. */\nconst TEXT = { mysql: \"utf8mb4_unicode_ci\" };\n\n/**\n * InnoDB indexes at most 3072 bytes, so S3 keys and folder paths are indexed\n * on their first 512 characters on MySQL. Two values that share those\n * characters share an index entry, and the unique keys treat them as equal.\n */\nconst LONG_PREFIX = 512;\n\n/**\n * Longest scope `resolveScope` may return, in characters. The `scope`\n * columns are `varchar(255)`.\n */\nexport const SCOPE_MAX_LENGTH = 255;\n\nfunction string(name: string, length = 255) {\n return column(name, `varchar(${length})`).collate(BINARY);\n}\n\n/**\n * One row per tracked object:\n * `pending` (presigned) → `active` (confirmed) → `deleted` (soft delete).\n * `purging` marks a stale pending row that purge has claimed.\n */\nconst storageObject = table(\"storage_object\", {\n id: idColumn(\"id\", \"varchar(255)\").collate(BINARY).defaultTo$(\"auto\"),\n /** Owner, for example `user:123` or `org:acme`. */\n scope: string(\"scope\", SCOPE_MAX_LENGTH),\n bucket: string(\"bucket\"),\n key: string(\"key\", 1024),\n /** Named dimah-s3 route that created the object. */\n route: string(\"route\"),\n /** Folder that holds the object. `null` is the root. */\n folderId: string(\"folder_id\").nullable(),\n filename: column(\"filename\", \"varchar(255)\").collate(TEXT),\n contentType: string(\"content_type\").nullable(),\n /** Verified size from HeadObject, set on confirm. */\n size: column(\"size\", \"bigint\").nullable(),\n /** Size the client declared before confirm. Quota counts it while pending. */\n declaredSize: column(\"declared_size\", \"bigint\").nullable(),\n eTag: string(\"e_tag\").nullable(),\n status: string(\"status\", 16),\n /** S3 user metadata of the verified object. */\n s3Metadata: column(\"s3_metadata\", \"json\").nullable(),\n /** App attributes, validated by the plugin's `attributes.schema`. */\n attributes: column(\"attributes\", \"json\").nullable(),\n acl: string(\"acl\").nullable(),\n /** Multipart upload ID while the row is pending. */\n uploadId: column(\"upload_id\", \"string\").collate(BINARY).nullable(),\n /** Token of the upload ticket that wrote the row. Confirm and purge match it. */\n uploadToken: string(\"upload_token\", 64).nullable(),\n /** Confirm deadline of a pending row (the upload ticket's expiry). */\n expiresAt: column(\"expires_at\", \"timestamp\").nullable(),\n confirmedAt: column(\"confirmed_at\", \"timestamp\").nullable(),\n createdAt: column(\"created_at\", \"timestamp\").defaultTo$(\"now\"),\n updatedAt: column(\"updated_at\", \"timestamp\").defaultTo$(\"now\"),\n deletedAt: column(\"deleted_at\", \"timestamp\").nullable(),\n})\n .unique(\"storage_object_bucket_key_uk\", [\"bucket\", \"key\"], {\n length: { key: LONG_PREFIX },\n })\n .index(\"storage_object_scope_folder_idx\", [\n \"scope\",\n \"status\",\n \"folderId\",\n \"createdAt\",\n ])\n .index(\"storage_object_scope_updated_idx\", [\"scope\", \"status\", \"updatedAt\"])\n .index(\"storage_object_scope_filename_idx\", [\"scope\", \"status\", \"filename\"])\n .index(\"storage_object_scope_size_idx\", [\"scope\", \"status\", \"size\"])\n .index(\"storage_object_status_expires_idx\", [\"status\", \"expiresAt\"]);\n\n/**\n * One row per folder, so an empty folder still lists. `parentId` is `\"\"` at\n * the root: a nullable parent cannot be unique on PostgreSQL, MySQL, and\n * SQLite, and the root is not a row. `path` is a cache of `name` joined\n * through the parents, rewritten when a folder is renamed or moved.\n */\nconst storageFolder = table(\"storage_folder\", {\n id: idColumn(\"id\", \"varchar(255)\").collate(BINARY).defaultTo$(\"auto\"),\n scope: string(\"scope\", SCOPE_MAX_LENGTH),\n /** Id of the containing folder. `\"\"` is the root. */\n parentId: string(\"parent_id\").defaultTo(\"\"),\n /** Last segment of `path`. */\n name: string(\"name\"),\n /** Full folder path. */\n path: string(\"path\", 1024),\n createdAt: column(\"created_at\", \"timestamp\").defaultTo$(\"now\"),\n updatedAt: column(\"updated_at\", \"timestamp\").defaultTo$(\"now\"),\n})\n .unique(\"storage_folder_scope_path_uk\", [\"scope\", \"path\"], {\n length: { path: LONG_PREFIX },\n })\n .unique(\"storage_folder_scope_parent_name_uk\", [\"scope\", \"parentId\", \"name\"]);\n\n/**\n * The @dimah-s3/db schema, version `2.1.0`. The tables, their indexes, and\n * the MySQL collations and prefix lengths are all declared here, so FumaDB\n * creates them (`migrate`) and generates them for Drizzle and Prisma.\n */\nexport const dbSchema = schema({\n version: \"2.1.0\",\n tables: {\n storageObject,\n storageFolder,\n },\n});\n","import { fumadb, type InferFumaDB } from \"fumadb\";\nimport { dbSchema } from \"./schema/schema\";\n\n/**\n * The @dimah-s3/db FumaDB library. Call `DimahS3DB.client(adapter)` with an\n * adapter from `@dimah-s3/db/adapters/*` to get a {@link DimahS3DbClient}.\n */\nexport const DimahS3DB = fumadb({\n namespace: \"dimah_s3\",\n schemas: [dbSchema],\n});\n\n/** FumaDB client for the @dimah-s3/db schema. */\nexport type DimahS3DbClient = InferFumaDB<typeof DimahS3DB>;\n\n/** The schema version the stores read and write. */\nexport const DB_SCHEMA_VERSION = dbSchema.version;\n","import { createCli } from \"fumadb/cli\";\nimport { DB_SCHEMA_VERSION, type DimahS3DbClient } from \"./fuma-db\";\n\ndeclare const __DIMAH_S3_DB_VERSION__: string;\n\n/**\n * Runs the FumaDB CLI for the @dimah-s3/db schema. `generate` writes the\n * Drizzle or Prisma schema for the client's adapter, and with Kysely, the SQL\n * that creates the tables. `migrate` creates them with Kysely.\n *\n * Generating does not query the database, so the client can wrap an adapter\n * that has no connection yet.\n *\n * ```ts\n * // scripts/dimah-s3.mts\n * import { DimahS3DB } from \"@dimah-s3/db\";\n * import { drizzleAdapter } from \"@dimah-s3/db/adapters/drizzle\";\n * import { runCli } from \"@dimah-s3/db/cli\";\n *\n * await runCli(DimahS3DB.client(drizzleAdapter({ db: undefined, provider: \"postgresql\" })));\n * ```\n *\n * `node scripts/dimah-s3.mts generate latest -o db/dimah-s3.ts`\n */\nexport function runCli(client: DimahS3DbClient): Promise<void> {\n const { main } = createCli({\n db: client,\n command: \"dimah-s3-db\",\n description: \"FumaDB CLI for @dimah-s3/db\",\n version: __DIMAH_S3_DB_VERSION__,\n });\n\n return main();\n}\n\n/**\n * Creates the schema this package reads, with its indexes, on an empty\n * database. It needs the Kysely adapter; with Drizzle or Prisma, generate the\n * schema with {@link runCli} and apply it with your ORM. It does nothing on a\n * database already at {@link DB_SCHEMA_VERSION}, and throws on a database at\n * another version: this package does not upgrade one.\n *\n * ```ts\n * import { DimahS3DB } from \"@dimah-s3/db\";\n * import { kyselyAdapter } from \"@dimah-s3/db/adapters/kysely\";\n * import { migrate } from \"@dimah-s3/db/cli\";\n *\n * await migrate(DimahS3DB.client(kyselyAdapter({ db: kysely, provider: \"postgresql\" })));\n * ```\n */\nexport async function migrate(client: DimahS3DbClient): Promise<void> {\n let version: string | undefined;\n try {\n version = await client.version();\n } catch {\n version = undefined;\n }\n if (version === DB_SCHEMA_VERSION) return;\n if (version !== undefined) {\n throw new Error(\n `[dimah-s3/db] The database is at schema ${version}, which this package does not upgrade. Create schema ${DB_SCHEMA_VERSION} on a new database.`,\n );\n }\n await (await client.createMigrator().migrateToLatest()).execute();\n}\n"]}
|
package/dist/client/index.js
CHANGED
package/dist/client/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/client/db-client.ts","../../src/folder-path.ts","../../src/client/db-object-source.ts"],"names":["s3Error"],"mappings":";;;AAeA,SAAS,KAAK,OAAA,EAAuC;AACnD,EAAA,OAAO,EAAE,MAAA,EAAQ,OAAA,EAAS,MAAA,EAAQ,OAAA,EAAS,SAAS,OAAA,EAAQ;AAC9D;AAGA,SAAS,UAAU,KAAA,EAAsC;AACvD,EAAA,IAAI,KAAA,EAAO,QAAA,KAAa,IAAA,EAAM,OAAO,KAAA;AACrC,EAAA,OAAO,EAAE,GAAG,KAAA,EAAO,QAAA,EAAU,EAAA,EAAG;AAClC;AAqBO,SAAS,QAAA,GAAsC;AACpD,EAAA,OAAO,kBAAA,CAAmB;AAAA,IACxB,EAAA,EAAI,IAAA;AAAA,IACJ,oBAAoB,EAAC;AAAA,IACrB,UAAA,EAAY,CAAC,MAAA,MAAgD;AAAA,MAC3D,WAAA,EAAa,CAAC,KAAA,EAAO,OAAA,KACnB,MAAA;AAAA,QACE,UAAA,CAAW,MAAM,SAAS,CAAA;AAAA,QAC1B,EAAE,MAAA,EAAQ,KAAA,EAAO,KAAA,EAAO,SAAA,CAAU,KAAK,CAAA,EAAG,GAAG,IAAA,CAAK,OAAO,CAAA;AAAE,OAC7D;AAAA,MACF,SAAA,EAAW,CAAC,KAAA,EAAO,OAAA,KACjB,MAAA;AAAA,QACE,UAAA,CAAW,MAAM,QAAQ,CAAA;AAAA,QACzB,EAAE,QAAQ,KAAA,EAAO,KAAA,EAAO,OAAO,GAAG,IAAA,CAAK,OAAO,CAAA;AAAE,OAClD;AAAA,MACF,YAAA,EAAc,CAAC,KAAA,EAAO,OAAA,KACpB,MAAA;AAAA,QACE,UAAA,CAAW,MAAM,QAAQ,CAAA;AAAA,QACzB,EAAE,QAAQ,OAAA,EAAS,IAAA,EAAM,OAAO,GAAG,IAAA,CAAK,OAAO,CAAA;AAAE,OACnD;AAAA,MACF,YAAA,EAAc,CAAC,KAAA,EAAO,OAAA,KACpB,OAAmC,UAAA,CAAW,IAAA,EAAM,QAAQ,CAAA,EAAG;AAAA,QAC7D,MAAA,EAAQ,MAAA;AAAA,QACR,IAAA,EAAM,KAAA;AAAA,QACN,GAAG,KAAK,OAAO;AAAA,OAChB,CAAA;AAAA,MACH,YAAA,EAAc,CAAC,KAAA,EAAO,OAAA,KACpB,OAAmC,UAAA,CAAW,IAAA,EAAM,QAAQ,CAAA,EAAG;AAAA,QAC7D,MAAA,EAAQ,OAAA;AAAA,QACR,IAAA,EAAM,KAAA;AAAA,QACN,GAAG,KAAK,OAAO;AAAA,OAChB,CAAA;AAAA,MACH,YAAA,EAAc,CAAC,KAAA,EAAO,OAAA,KACpB,OAAuB,UAAA,CAAW,IAAA,EAAM,QAAQ,CAAA,EAAG;AAAA,QACjD,MAAA,EAAQ,QAAA;AAAA,QACR,KAAA,EAAO,KAAA;AAAA,QACP,GAAG,KAAK,OAAO;AAAA,OAChB;AAAA,KACL;AAAA,GACD,CAAA;AACH;ACxEO,IAAM,sBAAA,GAAyB,GAAA;AAMtC,IAAM,iBAAA,GAAoB,iBAAA;AAG1B,SAAS,eAAe,KAAA,EAAuB;AAC7C,EAAA,OAAO,KAAA,CAAM,IAAA,CAAK,KAAK,CAAA,CAAE,MAAA;AAC3B;AAGO,SAAS,aAAa,IAAA,EAAuB;AAClD,EAAA,MAAM,MAAA,GAAS,eAAe,IAAI,CAAA;AAClC,EAAA,OACE,UAAU,CAAA,IACV,MAAA,IAAU,sBAAA,IACV,IAAA,KAAS,OACT,IAAA,KAAS,IAAA,IACT,CAAC,IAAA,CAAK,SAAS,GAAG,CAAA,IAClB,CAAC,iBAAA,CAAkB,KAAK,IAAI,CAAA;AAEhC;;;ACTA,IAAM,WAAA,uBAAkB,GAAA,CAA6B;AAAA,EACnD,CAAC,QAAQ,UAAU,CAAA;AAAA,EACnB,CAAC,QAAQ,MAAM,CAAA;AAAA,EACf,CAAC,aAAa,WAAW;AAC3B,CAAC,CAAA;AAED,SAAS,WACP,IAAA,EACwB;AACxB,EAAA,MAAM,QAAQ,IAAA,GAAO,WAAA,CAAY,GAAA,CAAI,IAAA,CAAK,KAAK,CAAA,GAAI,MAAA;AACnD,EAAA,OAAO,QAAQ,KAAA,GAAQ,EAAE,OAAO,SAAA,EAAW,IAAA,CAAK,WAAU,GAAI,MAAA;AAChE;AAEA,SAAS,OAAO,MAAA,EAAqD;AACnE,EAAA,OAAO;AAAA,IACL,MAAM,MAAA,CAAO,QAAA;AAAA,IACb,WAAW,MAAA,CAAO,GAAA;AAAA,IAClB,MAAM,MAAA,CAAO,IAAA;AAAA,IACb,aAAa,MAAA,CAAO,WAAA;AAAA,IACpB,WAAW,MAAA,CAAO;AAAA,GACpB;AACF;AAyBO,SAAS,cAAA,CACd,EAAA,EACA,OAAA,GAAiC,EAAC,EACC;AACnC,EAAA,MAAM,OAAA,GAAU,QAAQ,OAAA,KAAY,KAAA;AAEpC,EAAA,MAAM,MAAA,GAA4C;AAAA,IAChD,MAAA,EAAQ,CAAC,IAAA,KAAS,IAAA,CAAK,EAAA;AAAA,IACvB,OAAA,EAAS,MAAA;AAAA,IACT,MAAM,MAAM,EAAE,MAAA,EAAQ,QAAQ,IAAA,EAAM,MAAA,EAAQ,QAAO,EAAG;AACpD,MAAA,MAAM,QAA2B,EAAC;AAClC,MAAA,IAAI,OAAA,EAAS,KAAA,CAAM,QAAA,GAAW,MAAA,IAAU,EAAA;AACxC,MAAA,IAAI,MAAA,QAAc,MAAA,GAAS,MAAA;AAC3B,MAAA,IAAI,MAAA,QAAc,MAAA,GAAS,MAAA;AAC3B,MAAA,MAAM,QAAA,GAAW,WAAW,IAAI,CAAA;AAChC,MAAA,IAAI,QAAA,QAAgB,IAAA,GAAO,QAAA;AAC3B,MAAA,IAAI,OAAA,CAAQ,KAAA,EAAO,KAAA,CAAM,KAAA,GAAQ,OAAA,CAAQ,KAAA;AACzC,MAAA,IAAI,OAAA,CAAQ,MAAA,EAAQ,KAAA,CAAM,MAAA,GAAS,OAAA,CAAQ,MAAA;AAC3C,MAAA,IAAI,OAAA,CAAQ,WAAA,EAAa,KAAA,CAAM,WAAA,GAAc,OAAA,CAAQ,WAAA;AACrD,MAAA,IAAI,OAAA,CAAQ,KAAA,KAAU,MAAA,EAAW,KAAA,CAAM,QAAQ,OAAA,CAAQ,KAAA;AAEvD,MAAA,MAAM,OAAO,MAAM,EAAA,CAAG,YAAY,KAAA,EAAO,EAAE,QAAQ,CAAA;AACnD,MAAA,OAAO;AAAA,QACL,OAAO,IAAA,CAAK,OAAA;AAAA,QACZ,YAAY,IAAA,CAAK,UAAA;AAAA,QACjB,GAAI,KAAK,OAAA,IAAW;AAAA,UAClB,OAAA,EAAS,IAAA,CAAK,OAAA,CAAQ,GAAA,CAAI,CAAC,MAAA,MAAY;AAAA,YACrC,IAAI,MAAA,CAAO,EAAA;AAAA,YACX,MAAM,MAAA,CAAO;AAAA,WACf,CAAE;AAAA,SACJ;AAAA,QACA,GAAI,KAAK,KAAA,IAAS;AAAA,UAChB,KAAA,EAAO,IAAA,CAAK,KAAA,CAAM,GAAA,CAAI,CAAC,MAAA,MAAY;AAAA,YACjC,IAAI,MAAA,CAAO,EAAA;AAAA,YACX,MAAM,MAAA,CAAO;AAAA,WACf,CAAE;AAAA,SACJ;AAAA,QACA,GAAI,IAAA,CAAK,KAAA,IAAS,EAAE,KAAA,EAAO,EAAE,GAAG,IAAA,CAAK,KAAA,EAAO,GAAG,IAAA,CAAK,MAAA,EAAO;AAAE,OAC/D;AAAA,IACF;AAAA,GACF;AAEA,EAAA,MAAM,YAAA,GAAe,EAAA,CAAG,YAAA,EAAc,IAAA,CAAK,EAAE,CAAA;AAC7C,EAAA,IAAI,YAAA,EAAc;AAChB,IAAA,MAAA,CAAO,UAAA,GAAa,OAAO,EAAE,IAAA,EAAM,MAAK,KAAM;AAC5C,MAAA,MAAM,EAAE,MAAA,EAAO,GAAI,MAAM,YAAA,CAAa;AAAA,QACpC,KAAK,IAAA,CAAK,GAAA;AAAA,QACV,QAAQ,IAAA,CAAK,MAAA;AAAA,QACb,QAAA,EAAU;AAAA,OACX,CAAA;AACD,MAAA,OAAO,MAAA;AAAA,IACT,CAAA;AAAA,EACF;AACA,EAAA,IAAI,CAAC,SAAS,OAAO,MAAA;AAErB,EAAA,MAAA,CAAO,aAAA,GAAgB,CAAC,MAAA,MAAY;AAAA,IAClC,QAAA,EAAU,EAAE,QAAA,EAAU,MAAA,IAAU,EAAA;AAAG,GACrC,CAAA;AACA,EAAA,MAAM,YAAA,GAAe,EAAA,CAAG,YAAA,EAAc,IAAA,CAAK,EAAE,CAAA;AAC7C,EAAA,IAAI,YAAA,EAAc;AAChB,IAAA,MAAA,CAAO,YAAA,GAAe,OAAO,EAAE,MAAA,EAAQ,MAAK,KAAM;AAEhD,MAAA,IAAI,CAAC,YAAA,CAAa,IAAI,CAAA,EAAG,MAAMA,QAAQ,gBAAgB,CAAA;AACvD,MAAA,MAAM,EAAE,MAAA,EAAO,GAAI,MAAM,YAAA,CAAa;AAAA,QACpC,QAAA,EAAU,MAAA;AAAA,QACV;AAAA,OACD,CAAA;AACD,MAAA,OAAO,EAAE,EAAA,EAAI,MAAA,CAAO,EAAA,EAAI,IAAA,EAAM,OAAO,IAAA,EAAK;AAAA,IAC5C,CAAA;AAAA,EACF;AACA,EAAA,MAAM,YAAA,GAAe,EAAA,CAAG,YAAA,EAAc,IAAA,CAAK,EAAE,CAAA;AAC7C,EAAA,IAAI,YAAA,EAAc;AAChB,IAAA,MAAA,CAAO,YAAA,GAAe,OAAO,EAAE,MAAA,EAAQ,MAAK,KAAM;AAEhD,MAAA,IAAI,CAAC,YAAA,CAAa,IAAI,CAAA,EAAG,MAAMA,QAAQ,gBAAgB,CAAA;AACvD,MAAA,MAAM,EAAE,MAAA,EAAQ,OAAA,EAAQ,GAAI,MAAM,YAAA,CAAa;AAAA,QAC7C,IAAI,MAAA,CAAO,EAAA;AAAA,QACX;AAAA,OACD,CAAA;AACD,MAAA,OAAO,EAAE,EAAA,EAAI,OAAA,CAAQ,EAAA,EAAI,IAAA,EAAM,QAAQ,IAAA,EAAK;AAAA,IAC9C,CAAA;AAAA,EACF;AACA,EAAA,OAAO,MAAA;AACT","file":"index.js","sourcesContent":["import {\n defineClientPlugin,\n pluginPath,\n type S3RequestOptions,\n} from \"@dimah-s3/core\";\nimport type { db } from \"@/plugin/db\";\nimport type {\n DbClientActions,\n DbClientFolder,\n DbClientListInput,\n DbClientListResponse,\n DbClientObject,\n} from \"@/types/client\";\n\n/** The per-call options better-fetch reads: the abort signal and headers. */\nfunction call(options: S3RequestOptions | undefined) {\n return { signal: options?.signal, headers: options?.headers };\n}\n\n/** The list query on the wire, where the root folder is `\"\"`. */\nfunction listQuery(input: DbClientListInput | undefined) {\n if (input?.folderId !== null) return input;\n return { ...input, folderId: \"\" };\n}\n\n/**\n * Client plugin for the server `db()` endpoints. Its actions are\n * {@link DbClientActions} on `api.db`. Pass `TClientAttributes` to type the\n * `attributes` the plugin's `attributes.toClient` returns.\n *\n * ```ts\n * import { createS3Client } from \"@dimah-s3/react\";\n * import { dbClient } from \"@dimah-s3/db/client\";\n *\n * export const s3Client = createS3Client({\n * plugins: [dbClient()],\n * });\n *\n * const page = await s3Client.db.listObjects({ folderId: \"\" });\n * ```\n *\n * The server resolves the scope from the request, so no action takes one.\n * Server code skips HTTP and uses `s3.db.objects` and `s3.db.folders`.\n */\nexport function dbClient<TClientAttributes = never>() {\n return defineClientPlugin({\n id: \"db\",\n $InferServerPlugin: {} as ReturnType<typeof db>,\n getActions: ($fetch): DbClientActions<TClientAttributes> => ({\n listObjects: (input, options) =>\n $fetch<DbClientListResponse<TClientAttributes>>(\n pluginPath(\"db\", \"objects\"),\n { method: \"GET\", query: listQuery(input), ...call(options) },\n ),\n getObject: (input, options) =>\n $fetch<{ object: DbClientObject<TClientAttributes> }>(\n pluginPath(\"db\", \"object\"),\n { method: \"GET\", query: input, ...call(options) },\n ),\n updateObject: (input, options) =>\n $fetch<{ object: DbClientObject<TClientAttributes> }>(\n pluginPath(\"db\", \"object\"),\n { method: \"PATCH\", body: input, ...call(options) },\n ),\n createFolder: (input, options) =>\n $fetch<{ folder: DbClientFolder }>(pluginPath(\"db\", \"folder\"), {\n method: \"POST\",\n body: input,\n ...call(options),\n }),\n updateFolder: (input, options) =>\n $fetch<{ folder: DbClientFolder }>(pluginPath(\"db\", \"folder\"), {\n method: \"PATCH\",\n body: input,\n ...call(options),\n }),\n deleteFolder: (input, options) =>\n $fetch<{ id: string }>(pluginPath(\"db\", \"folder\"), {\n method: \"DELETE\",\n query: input,\n ...call(options),\n }),\n }),\n });\n}\n","import { s3Error } from \"@dimah-s3/core\";\n\n/**\n * Logical folder paths. A path is NFC-normalized and `/`-separated, with no\n * leading or trailing `/`. `null` is the root. The wire addresses a folder\n * by id; the path is the cached label of that id.\n */\n\n/** Longest folder path, in characters. */\nexport const FOLDER_PATH_MAX_LENGTH = 1024;\n\n/** Longest folder name (one path segment), in characters. */\nexport const FOLDER_NAME_MAX_LENGTH = 255;\n\n/** Most segments in a folder path. Each one is a row the server keeps. */\nexport const FOLDER_MAX_DEPTH = 32;\n\n/** Control characters and lone surrogates. */\nconst INVALID_CHARACTER = /[\\p{Cc}\\p{Cs}]/u;\n\n/** Counts code points, so a character outside the BMP counts once. */\nfunction characterCount(value: string): number {\n return Array.from(value).length;\n}\n\n/** True when `name` can be one segment of a folder path. */\nexport function isFolderName(name: string): boolean {\n const length = characterCount(name);\n return (\n length >= 1 &&\n length <= FOLDER_NAME_MAX_LENGTH &&\n name !== \".\" &&\n name !== \"..\" &&\n !name.includes(\"/\") &&\n !INVALID_CHARACTER.test(name)\n );\n}\n\n/**\n * Returns the NFC form of `path`, or `null` when it is not a valid folder\n * path. The root (`\"\"`) is not a folder path.\n */\nexport function normalizeFolderPath(path: string): string | null {\n if (!path.isWellFormed()) return null;\n const normalized = path.normalize(\"NFC\");\n if (characterCount(normalized) > FOLDER_PATH_MAX_LENGTH) return null;\n const names = normalized.split(\"/\");\n if (names.length > FOLDER_MAX_DEPTH) return null;\n return names.every(isFolderName) ? normalized : null;\n}\n\n/**\n * Reads a wire folder value. `\"\"` is the root and returns `null`.\n * @throws `FOLDER_INVALID` when the value is not a valid folder path.\n */\nexport function parseFolder(value: string): string | null {\n if (value === \"\") return null;\n const path = normalizeFolderPath(value);\n if (path === null) throw s3Error(\"FOLDER_INVALID\");\n return path;\n}\n\n/** Writes a folder for the wire. The root becomes `\"\"`. */\nexport function formatFolder(folder: string | null): string {\n return folder ?? \"\";\n}\n\n/**\n * The path of `name` inside `parent`. `null` when `name` is not a folder\n * name or the joined path is too long or too deep.\n */\nexport function childFolderPath(\n parent: string | null,\n name: string,\n): string | null {\n if (!isFolderName(name)) return null;\n return normalizeFolderPath(joinFolderPath(parent, name));\n}\n\n/** Appends `name` to `parent`. The result is not validated. */\nexport function joinFolderPath(parent: string | null, name: string): string {\n return parent === null ? name : `${parent}/${name}`;\n}\n\n/** The folder that contains `path`. `null` for a top-level folder. */\nexport function parentFolderPath(path: string): string | null {\n const index = path.lastIndexOf(\"/\");\n return index === -1 ? null : path.slice(0, index);\n}\n\n/** The last segment of `path`. */\nexport function folderName(path: string): string {\n return path.slice(path.lastIndexOf(\"/\") + 1);\n}\n\n/** Every folder from the top level down to `path` itself. */\nexport function folderAncestors(path: string): string[] {\n const segments = path.split(\"/\");\n return segments.map((_, index) => segments.slice(0, index + 1).join(\"/\"));\n}\n","import { s3Error } from \"@dimah-s3/core\";\nimport { isFolderName } from \"@/folder-path\";\nimport type {\n DbClientActions,\n DbClientListInput,\n DbClientObject,\n DbListSort,\n DbListSortField,\n DbObjectSource,\n DbObjectSourceFile,\n DbObjectSourceOptions,\n DbObjectSourceQueryInput,\n} from \"@/types/client\";\n\n/** The `api.db` actions {@link dbObjectSource} calls. */\nexport type DbObjectSourceActions<TClientAttributes = never> = Pick<\n DbClientActions<TClientAttributes>,\n \"listObjects\"\n> &\n Partial<\n Pick<\n DbClientActions<TClientAttributes>,\n \"createFolder\" | \"updateObject\" | \"updateFolder\"\n >\n >;\n\n/** List sort fields and the `listObjects` columns they order by. */\nconst SORT_FIELDS = new Map<string, DbListSortField>([\n [\"name\", \"filename\"],\n [\"size\", \"size\"],\n [\"updatedAt\", \"updatedAt\"],\n]);\n\nfunction toListSort(\n sort: DbObjectSourceQueryInput[\"sort\"],\n): DbListSort | undefined {\n const field = sort ? SORT_FIELDS.get(sort.field) : undefined;\n return sort && field ? { field, direction: sort.direction } : undefined;\n}\n\nfunction toFile(object: DbClientObject<unknown>): DbObjectSourceFile {\n return {\n name: object.filename,\n objectKey: object.key,\n size: object.size,\n contentType: object.contentType,\n updatedAt: object.updatedAt,\n };\n}\n\n/**\n * A `useObjectList` source over `api.db`.\n *\n * With `folders` on (the default), `parent` is a folder id: each page lists\n * one folder, the first page carries its child folders and the breadcrumb\n * trail, uploads go to the open folder, and \"New folder\" calls\n * `api.db.createFolder`. Rename calls `api.db.updateObject` (`filename`) or\n * `api.db.updateFolder` (`name`) and leaves the object key as it is. With\n * `folders: false`, the list is flat: file rename stays, and folder actions\n * do not.\n *\n * `search` matches the filename on the server. `sort` maps `name` to\n * `filename`; `size` and `updatedAt` keep their names, and other fields keep\n * the server's order (newest first). `usage` is the scope total with its\n * caps, not the open folder's.\n *\n * ```ts\n * const list = useObjectList({\n * ...dbObjectSource(api.db, { route: \"docs\" }),\n * queryKey: [\"docs\"],\n * });\n * ```\n */\nexport function dbObjectSource<TClientAttributes = never>(\n db: DbObjectSourceActions<TClientAttributes>,\n options: DbObjectSourceOptions = {},\n): DbObjectSource<TClientAttributes> {\n const folders = options.folders !== false;\n\n const source: DbObjectSource<TClientAttributes> = {\n getKey: (item) => item.id,\n getFile: toFile,\n async query({ parent, cursor, sort, search, signal }) {\n const input: DbClientListInput = {};\n if (folders) input.folderId = parent ?? \"\";\n if (cursor) input.cursor = cursor;\n if (search) input.search = search;\n const listSort = toListSort(sort);\n if (listSort) input.sort = listSort;\n if (options.route) input.route = options.route;\n if (options.status) input.status = options.status;\n if (options.contentType) input.contentType = options.contentType;\n if (options.limit !== undefined) input.limit = options.limit;\n\n const page = await db.listObjects(input, { signal });\n return {\n items: page.objects,\n nextCursor: page.nextCursor,\n ...(page.folders && {\n folders: page.folders.map((folder) => ({\n id: folder.id,\n name: folder.name,\n })),\n }),\n ...(page.trail && {\n trail: page.trail.map((folder) => ({\n id: folder.id,\n name: folder.name,\n })),\n }),\n ...(page.usage && { usage: { ...page.usage, ...page.limits } }),\n };\n },\n };\n\n const updateObject = db.updateObject?.bind(db);\n if (updateObject) {\n source.renameFile = async ({ item, name }) => {\n const { object } = await updateObject({\n key: item.key,\n bucket: item.bucket,\n filename: name,\n });\n return object;\n };\n }\n if (!folders) return source;\n\n source.uploadOptions = (parent) => ({\n metadata: { folderId: parent ?? \"\" },\n });\n const createFolder = db.createFolder?.bind(db);\n if (createFolder) {\n source.createFolder = async ({ parent, name }) => {\n // A `/` would be a nested path. The server creates one folder.\n if (!isFolderName(name)) throw s3Error(\"FOLDER_INVALID\");\n const { folder } = await createFolder({\n parentId: parent,\n name,\n });\n return { id: folder.id, name: folder.name };\n };\n }\n const updateFolder = db.updateFolder?.bind(db);\n if (updateFolder) {\n source.renameFolder = async ({ folder, name }) => {\n // A `/` would be a nested path. The server renames one folder.\n if (!isFolderName(name)) throw s3Error(\"FOLDER_INVALID\");\n const { folder: updated } = await updateFolder({\n id: folder.id,\n name,\n });\n return { id: updated.id, name: updated.name };\n };\n }\n return source;\n}\n"]}
|
|
1
|
+
{"version":3,"sources":["../../src/client/db-client.ts","../../src/folder-path.ts","../../src/client/db-object-source.ts"],"names":["s3Error"],"mappings":";;;AAeA,SAAS,KAAK,OAAA,EAAuC;AACnD,EAAA,OAAO,EAAE,MAAA,EAAQ,OAAA,EAAS,MAAA,EAAQ,OAAA,EAAS,SAAS,OAAA,EAAQ;AAC9D;AAGA,SAAS,UAAU,KAAA,EAAsC;AACvD,EAAA,IAAI,KAAA,EAAO,QAAA,KAAa,IAAA,EAAM,OAAO,KAAA;AACrC,EAAA,OAAO,EAAE,GAAG,KAAA,EAAO,QAAA,EAAU,EAAA,EAAG;AAClC;AAqBO,SAAS,QAAA,GAAsC;AACpD,EAAA,OAAO,kBAAA,CAAmB;AAAA,IACxB,EAAA,EAAI,IAAA;AAAA,IACJ,oBAAoB,EAAC;AAAA,IACrB,UAAA,EAAY,CAAC,MAAA,MAAgD;AAAA,MAC3D,WAAA,EAAa,CAAC,KAAA,EAAO,OAAA,KACnB,MAAA;AAAA,QACE,UAAA,CAAW,MAAM,SAAS,CAAA;AAAA,QAC1B,EAAE,MAAA,EAAQ,KAAA,EAAO,KAAA,EAAO,SAAA,CAAU,KAAK,CAAA,EAAG,GAAG,IAAA,CAAK,OAAO,CAAA;AAAE,OAC7D;AAAA,MACF,SAAA,EAAW,CAAC,KAAA,EAAO,OAAA,KACjB,MAAA;AAAA,QACE,UAAA,CAAW,MAAM,QAAQ,CAAA;AAAA,QACzB,EAAE,QAAQ,KAAA,EAAO,KAAA,EAAO,OAAO,GAAG,IAAA,CAAK,OAAO,CAAA;AAAE,OAClD;AAAA,MACF,YAAA,EAAc,CAAC,KAAA,EAAO,OAAA,KACpB,MAAA;AAAA,QACE,UAAA,CAAW,MAAM,QAAQ,CAAA;AAAA,QACzB,EAAE,QAAQ,OAAA,EAAS,IAAA,EAAM,OAAO,GAAG,IAAA,CAAK,OAAO,CAAA;AAAE,OACnD;AAAA,MACF,YAAA,EAAc,CAAC,KAAA,EAAO,OAAA,KACpB,OAAmC,UAAA,CAAW,IAAA,EAAM,QAAQ,CAAA,EAAG;AAAA,QAC7D,MAAA,EAAQ,MAAA;AAAA,QACR,IAAA,EAAM,KAAA;AAAA,QACN,GAAG,KAAK,OAAO;AAAA,OAChB,CAAA;AAAA,MACH,YAAA,EAAc,CAAC,KAAA,EAAO,OAAA,KACpB,OAAmC,UAAA,CAAW,IAAA,EAAM,QAAQ,CAAA,EAAG;AAAA,QAC7D,MAAA,EAAQ,OAAA;AAAA,QACR,IAAA,EAAM,KAAA;AAAA,QACN,GAAG,KAAK,OAAO;AAAA,OAChB,CAAA;AAAA,MACH,YAAA,EAAc,CAAC,KAAA,EAAO,OAAA,KACpB,OAAuB,UAAA,CAAW,IAAA,EAAM,QAAQ,CAAA,EAAG;AAAA,QACjD,MAAA,EAAQ,QAAA;AAAA,QACR,KAAA,EAAO,KAAA;AAAA,QACP,GAAG,KAAK,OAAO;AAAA,OAChB;AAAA,KACL;AAAA,GACD,CAAA;AACH;ACpEO,IAAM,sBAAA,GAAyB,GAAA;AAMtC,IAAM,iBAAA,GAAoB,iBAAA;AAEb,IAAI,WAAA;AAGV,SAAS,eAAe,KAAA,EAAuB;AACpD,EAAA,OAAO,KAAA,CAAM,IAAA,CAAK,KAAK,CAAA,CAAE,MAAA;AAC3B;AAGO,SAAS,aAAa,IAAA,EAAuB;AAClD,EAAA,MAAM,MAAA,GAAS,eAAe,IAAI,CAAA;AAClC,EAAA,OACE,UAAU,CAAA,IACV,MAAA,IAAU,sBAAA,IACV,IAAA,KAAS,OACT,IAAA,KAAS,IAAA,IACT,CAAC,IAAA,CAAK,SAAS,GAAG,CAAA,IAClB,CAAC,iBAAA,CAAkB,KAAK,IAAI,CAAA;AAEhC;;;ACfA,IAAM,WAAA,uBAAkB,GAAA,CAA6B;AAAA,EACnD,CAAC,QAAQ,UAAU,CAAA;AAAA,EACnB,CAAC,QAAQ,MAAM,CAAA;AAAA,EACf,CAAC,aAAa,WAAW;AAC3B,CAAC,CAAA;AAED,SAAS,WACP,IAAA,EACwB;AACxB,EAAA,MAAM,QAAQ,IAAA,GAAO,WAAA,CAAY,GAAA,CAAI,IAAA,CAAK,KAAK,CAAA,GAAI,MAAA;AACnD,EAAA,OAAO,QAAQ,KAAA,GAAQ,EAAE,OAAO,SAAA,EAAW,IAAA,CAAK,WAAU,GAAI,MAAA;AAChE;AAEA,SAAS,OAAO,MAAA,EAAqD;AACnE,EAAA,OAAO;AAAA,IACL,MAAM,MAAA,CAAO,QAAA;AAAA,IACb,WAAW,MAAA,CAAO,GAAA;AAAA,IAClB,MAAM,MAAA,CAAO,IAAA;AAAA,IACb,aAAa,MAAA,CAAO,WAAA;AAAA,IACpB,WAAW,MAAA,CAAO;AAAA,GACpB;AACF;AAyBO,SAAS,cAAA,CACd,EAAA,EACA,OAAA,GAAiC,EAAC,EACC;AACnC,EAAA,MAAM,OAAA,GAAU,QAAQ,OAAA,KAAY,KAAA;AAEpC,EAAA,MAAM,MAAA,GAA4C;AAAA,IAChD,MAAA,EAAQ,CAAC,IAAA,KAAS,IAAA,CAAK,EAAA;AAAA,IACvB,OAAA,EAAS,MAAA;AAAA,IACT,MAAM,MAAM,EAAE,MAAA,EAAQ,QAAQ,IAAA,EAAM,MAAA,EAAQ,QAAO,EAAG;AACpD,MAAA,MAAM,QAA2B,EAAC;AAClC,MAAA,IAAI,OAAA,EAAS,KAAA,CAAM,QAAA,GAAW,MAAA,IAAU,EAAA;AACxC,MAAA,IAAI,MAAA,QAAc,MAAA,GAAS,MAAA;AAC3B,MAAA,IAAI,MAAA,QAAc,MAAA,GAAS,MAAA;AAC3B,MAAA,MAAM,QAAA,GAAW,WAAW,IAAI,CAAA;AAChC,MAAA,IAAI,QAAA,QAAgB,IAAA,GAAO,QAAA;AAC3B,MAAA,IAAI,OAAA,CAAQ,KAAA,EAAO,KAAA,CAAM,KAAA,GAAQ,OAAA,CAAQ,KAAA;AACzC,MAAA,IAAI,OAAA,CAAQ,MAAA,EAAQ,KAAA,CAAM,MAAA,GAAS,OAAA,CAAQ,MAAA;AAC3C,MAAA,IAAI,OAAA,CAAQ,WAAA,EAAa,KAAA,CAAM,WAAA,GAAc,OAAA,CAAQ,WAAA;AACrD,MAAA,IAAI,OAAA,CAAQ,KAAA,KAAU,MAAA,EAAW,KAAA,CAAM,QAAQ,OAAA,CAAQ,KAAA;AAEvD,MAAA,MAAM,OAAO,MAAM,EAAA,CAAG,YAAY,KAAA,EAAO,EAAE,QAAQ,CAAA;AACnD,MAAA,OAAO;AAAA,QACL,OAAO,IAAA,CAAK,OAAA;AAAA,QACZ,YAAY,IAAA,CAAK,UAAA;AAAA,QACjB,GAAI,KAAK,OAAA,IAAW;AAAA,UAClB,OAAA,EAAS,IAAA,CAAK,OAAA,CAAQ,GAAA,CAAI,CAAC,MAAA,MAAY;AAAA,YACrC,IAAI,MAAA,CAAO,EAAA;AAAA,YACX,MAAM,MAAA,CAAO;AAAA,WACf,CAAE;AAAA,SACJ;AAAA,QACA,GAAI,KAAK,KAAA,IAAS;AAAA,UAChB,KAAA,EAAO,IAAA,CAAK,KAAA,CAAM,GAAA,CAAI,CAAC,MAAA,MAAY;AAAA,YACjC,IAAI,MAAA,CAAO,EAAA;AAAA,YACX,MAAM,MAAA,CAAO;AAAA,WACf,CAAE;AAAA,SACJ;AAAA,QACA,GAAI,IAAA,CAAK,KAAA,IAAS,EAAE,KAAA,EAAO,EAAE,GAAG,IAAA,CAAK,KAAA,EAAO,GAAG,IAAA,CAAK,MAAA,EAAO;AAAE,OAC/D;AAAA,IACF;AAAA,GACF;AAEA,EAAA,MAAM,YAAA,GAAe,EAAA,CAAG,YAAA,EAAc,IAAA,CAAK,EAAE,CAAA;AAC7C,EAAA,IAAI,YAAA,EAAc;AAChB,IAAA,MAAA,CAAO,UAAA,GAAa,OAAO,EAAE,IAAA,EAAM,MAAK,KAAM;AAC5C,MAAA,MAAM,EAAE,MAAA,EAAO,GAAI,MAAM,YAAA,CAAa;AAAA,QACpC,KAAK,IAAA,CAAK,GAAA;AAAA,QACV,QAAQ,IAAA,CAAK,MAAA;AAAA,QACb,QAAA,EAAU;AAAA,OACX,CAAA;AACD,MAAA,OAAO,MAAA;AAAA,IACT,CAAA;AAAA,EACF;AACA,EAAA,IAAI,CAAC,SAAS,OAAO,MAAA;AAErB,EAAA,MAAA,CAAO,aAAA,GAAgB,CAAC,MAAA,MAAY;AAAA,IAClC,QAAA,EAAU,EAAE,QAAA,EAAU,MAAA,IAAU,EAAA;AAAG,GACrC,CAAA;AACA,EAAA,MAAM,YAAA,GAAe,EAAA,CAAG,YAAA,EAAc,IAAA,CAAK,EAAE,CAAA;AAC7C,EAAA,IAAI,YAAA,EAAc;AAChB,IAAA,MAAA,CAAO,YAAA,GAAe,OAAO,EAAE,MAAA,EAAQ,MAAK,KAAM;AAEhD,MAAA,IAAI,CAAC,YAAA,CAAa,IAAI,CAAA,EAAG,MAAMA,QAAQ,gBAAgB,CAAA;AACvD,MAAA,MAAM,EAAE,MAAA,EAAO,GAAI,MAAM,YAAA,CAAa;AAAA,QACpC,QAAA,EAAU,MAAA;AAAA,QACV;AAAA,OACD,CAAA;AACD,MAAA,OAAO,EAAE,EAAA,EAAI,MAAA,CAAO,EAAA,EAAI,IAAA,EAAM,OAAO,IAAA,EAAK;AAAA,IAC5C,CAAA;AAAA,EACF;AACA,EAAA,MAAM,YAAA,GAAe,EAAA,CAAG,YAAA,EAAc,IAAA,CAAK,EAAE,CAAA;AAC7C,EAAA,IAAI,YAAA,EAAc;AAChB,IAAA,MAAA,CAAO,YAAA,GAAe,OAAO,EAAE,MAAA,EAAQ,MAAK,KAAM;AAEhD,MAAA,IAAI,CAAC,YAAA,CAAa,IAAI,CAAA,EAAG,MAAMA,QAAQ,gBAAgB,CAAA;AACvD,MAAA,MAAM,EAAE,MAAA,EAAQ,OAAA,EAAQ,GAAI,MAAM,YAAA,CAAa;AAAA,QAC7C,IAAI,MAAA,CAAO,EAAA;AAAA,QACX;AAAA,OACD,CAAA;AACD,MAAA,OAAO,EAAE,EAAA,EAAI,OAAA,CAAQ,EAAA,EAAI,IAAA,EAAM,QAAQ,IAAA,EAAK;AAAA,IAC9C,CAAA;AAAA,EACF;AACA,EAAA,OAAO,MAAA;AACT","file":"index.js","sourcesContent":["import {\n defineClientPlugin,\n pluginPath,\n type S3RequestOptions,\n} from \"@dimah-s3/core\";\nimport type { db } from \"@/plugin/db\";\nimport type {\n DbClientActions,\n DbClientFolder,\n DbClientListInput,\n DbClientListResponse,\n DbClientObject,\n} from \"@/types/client\";\n\n/** The per-call options better-fetch reads: the abort signal and headers. */\nfunction call(options: S3RequestOptions | undefined) {\n return { signal: options?.signal, headers: options?.headers };\n}\n\n/** The list query on the wire, where the root folder is `\"\"`. */\nfunction listQuery(input: DbClientListInput | undefined) {\n if (input?.folderId !== null) return input;\n return { ...input, folderId: \"\" };\n}\n\n/**\n * Client plugin for the server `db()` endpoints. Its actions are\n * {@link DbClientActions} on `api.db`. Pass `TClientAttributes` to type the\n * `attributes` the plugin's `attributes.toClient` returns.\n *\n * ```ts\n * import { createS3Client } from \"@dimah-s3/react\";\n * import { dbClient } from \"@dimah-s3/db/client\";\n *\n * export const s3Client = createS3Client({\n * plugins: [dbClient()],\n * });\n *\n * const page = await s3Client.db.listObjects({ folderId: \"\" });\n * ```\n *\n * The server resolves the scope from the request, so no action takes one.\n * Server code skips HTTP and uses `s3.db.objects` and `s3.db.folders`.\n */\nexport function dbClient<TClientAttributes = never>() {\n return defineClientPlugin({\n id: \"db\",\n $InferServerPlugin: {} as ReturnType<typeof db>,\n getActions: ($fetch): DbClientActions<TClientAttributes> => ({\n listObjects: (input, options) =>\n $fetch<DbClientListResponse<TClientAttributes>>(\n pluginPath(\"db\", \"objects\"),\n { method: \"GET\", query: listQuery(input), ...call(options) },\n ),\n getObject: (input, options) =>\n $fetch<{ object: DbClientObject<TClientAttributes> }>(\n pluginPath(\"db\", \"object\"),\n { method: \"GET\", query: input, ...call(options) },\n ),\n updateObject: (input, options) =>\n $fetch<{ object: DbClientObject<TClientAttributes> }>(\n pluginPath(\"db\", \"object\"),\n { method: \"PATCH\", body: input, ...call(options) },\n ),\n createFolder: (input, options) =>\n $fetch<{ folder: DbClientFolder }>(pluginPath(\"db\", \"folder\"), {\n method: \"POST\",\n body: input,\n ...call(options),\n }),\n updateFolder: (input, options) =>\n $fetch<{ folder: DbClientFolder }>(pluginPath(\"db\", \"folder\"), {\n method: \"PATCH\",\n body: input,\n ...call(options),\n }),\n deleteFolder: (input, options) =>\n $fetch<{ id: string }>(pluginPath(\"db\", \"folder\"), {\n method: \"DELETE\",\n query: input,\n ...call(options),\n }),\n }),\n });\n}\n","import { s3Error } from \"@dimah-s3/core\";\n\n/**\n * Logical folder paths. A path is NFC-normalized and `/`-separated, with no\n * leading or trailing `/`. `null` is the root. The wire addresses a folder\n * by id; the path is the cached label of that id.\n */\n\n/**\n * Longest folder path, in UTF-8 bytes, like an S3 key. With the longest scope,\n * the `(scope, path)` unique key stays under PostgreSQL's 2704-byte limit\n * for a btree entry.\n */\nexport const FOLDER_PATH_MAX_BYTES = 1024;\n\n/** Longest folder name (one path segment), in characters. */\nexport const FOLDER_NAME_MAX_LENGTH = 255;\n\n/** Most segments in a folder path. Each one is a row the server keeps. */\nexport const FOLDER_MAX_DEPTH = 32;\n\n/** Control characters and lone surrogates. */\nconst INVALID_CHARACTER = /[\\p{Cc}\\p{Cs}]/u;\n\nconst utf8 = new TextEncoder();\n\n/** Counts code points, so a character outside the BMP counts once. */\nexport function characterCount(value: string): number {\n return Array.from(value).length;\n}\n\n/** True when `name` can be one segment of a folder path. */\nexport function isFolderName(name: string): boolean {\n const length = characterCount(name);\n return (\n length >= 1 &&\n length <= FOLDER_NAME_MAX_LENGTH &&\n name !== \".\" &&\n name !== \"..\" &&\n !name.includes(\"/\") &&\n !INVALID_CHARACTER.test(name)\n );\n}\n\n/**\n * Returns the NFC form of `path`, or `null` when it is not a valid folder\n * path. The root (`\"\"`) is not a folder path.\n */\nexport function normalizeFolderPath(path: string): string | null {\n if (!path.isWellFormed()) return null;\n const normalized = path.normalize(\"NFC\");\n if (utf8.encode(normalized).byteLength > FOLDER_PATH_MAX_BYTES) return null;\n const names = normalized.split(\"/\");\n if (names.length > FOLDER_MAX_DEPTH) return null;\n return names.every(isFolderName) ? normalized : null;\n}\n\n/**\n * Reads a wire folder value. `\"\"` is the root and returns `null`.\n * @throws `FOLDER_INVALID` when the value is not a valid folder path.\n */\nexport function parseFolder(value: string): string | null {\n if (value === \"\") return null;\n const path = normalizeFolderPath(value);\n if (path === null) throw s3Error(\"FOLDER_INVALID\");\n return path;\n}\n\n/** Writes a folder for the wire. The root becomes `\"\"`. */\nexport function formatFolder(folder: string | null): string {\n return folder ?? \"\";\n}\n\n/**\n * The path of `name` inside `parent`. `null` when `name` is not a folder\n * name or the joined path is too long or too deep.\n */\nexport function childFolderPath(\n parent: string | null,\n name: string,\n): string | null {\n if (!isFolderName(name)) return null;\n return normalizeFolderPath(joinFolderPath(parent, name));\n}\n\n/** Appends `name` to `parent`. The result is not validated. */\nexport function joinFolderPath(parent: string | null, name: string): string {\n return parent === null ? name : `${parent}/${name}`;\n}\n\n/** The folder that contains `path`. `null` for a top-level folder. */\nexport function parentFolderPath(path: string): string | null {\n const index = path.lastIndexOf(\"/\");\n return index === -1 ? null : path.slice(0, index);\n}\n\n/** The last segment of `path`. */\nexport function folderName(path: string): string {\n return path.slice(path.lastIndexOf(\"/\") + 1);\n}\n\n/** Every folder from the top level down to `path` itself. */\nexport function folderAncestors(path: string): string[] {\n const segments = path.split(\"/\");\n return segments.map((_, index) => segments.slice(0, index + 1).join(\"/\"));\n}\n","import { s3Error } from \"@dimah-s3/core\";\nimport { isFolderName } from \"@/folder-path\";\nimport type {\n DbClientActions,\n DbClientListInput,\n DbClientObject,\n DbListSort,\n DbListSortField,\n DbObjectSource,\n DbObjectSourceFile,\n DbObjectSourceOptions,\n DbObjectSourceQueryInput,\n} from \"@/types/client\";\n\n/** The `api.db` actions {@link dbObjectSource} calls. */\nexport type DbObjectSourceActions<TClientAttributes = never> = Pick<\n DbClientActions<TClientAttributes>,\n \"listObjects\"\n> &\n Partial<\n Pick<\n DbClientActions<TClientAttributes>,\n \"createFolder\" | \"updateObject\" | \"updateFolder\"\n >\n >;\n\n/** List sort fields and the `listObjects` columns they order by. */\nconst SORT_FIELDS = new Map<string, DbListSortField>([\n [\"name\", \"filename\"],\n [\"size\", \"size\"],\n [\"updatedAt\", \"updatedAt\"],\n]);\n\nfunction toListSort(\n sort: DbObjectSourceQueryInput[\"sort\"],\n): DbListSort | undefined {\n const field = sort ? SORT_FIELDS.get(sort.field) : undefined;\n return sort && field ? { field, direction: sort.direction } : undefined;\n}\n\nfunction toFile(object: DbClientObject<unknown>): DbObjectSourceFile {\n return {\n name: object.filename,\n objectKey: object.key,\n size: object.size,\n contentType: object.contentType,\n updatedAt: object.updatedAt,\n };\n}\n\n/**\n * A `useObjectList` source over `api.db`.\n *\n * With `folders` on (the default), `parent` is a folder id: each page lists\n * one folder, the first page carries its child folders and the breadcrumb\n * trail, uploads go to the open folder, and \"New folder\" calls\n * `api.db.createFolder`. Rename calls `api.db.updateObject` (`filename`) or\n * `api.db.updateFolder` (`name`) and leaves the object key as it is. With\n * `folders: false`, the list is flat: file rename stays, and folder actions\n * do not.\n *\n * `search` matches the filename on the server. `sort` maps `name` to\n * `filename`; `size` and `updatedAt` keep their names, and other fields keep\n * the server's order (newest first). `usage` is the scope total with its\n * caps, not the open folder's.\n *\n * ```ts\n * const list = useObjectList({\n * ...dbObjectSource(api.db, { route: \"docs\" }),\n * queryKey: [\"docs\"],\n * });\n * ```\n */\nexport function dbObjectSource<TClientAttributes = never>(\n db: DbObjectSourceActions<TClientAttributes>,\n options: DbObjectSourceOptions = {},\n): DbObjectSource<TClientAttributes> {\n const folders = options.folders !== false;\n\n const source: DbObjectSource<TClientAttributes> = {\n getKey: (item) => item.id,\n getFile: toFile,\n async query({ parent, cursor, sort, search, signal }) {\n const input: DbClientListInput = {};\n if (folders) input.folderId = parent ?? \"\";\n if (cursor) input.cursor = cursor;\n if (search) input.search = search;\n const listSort = toListSort(sort);\n if (listSort) input.sort = listSort;\n if (options.route) input.route = options.route;\n if (options.status) input.status = options.status;\n if (options.contentType) input.contentType = options.contentType;\n if (options.limit !== undefined) input.limit = options.limit;\n\n const page = await db.listObjects(input, { signal });\n return {\n items: page.objects,\n nextCursor: page.nextCursor,\n ...(page.folders && {\n folders: page.folders.map((folder) => ({\n id: folder.id,\n name: folder.name,\n })),\n }),\n ...(page.trail && {\n trail: page.trail.map((folder) => ({\n id: folder.id,\n name: folder.name,\n })),\n }),\n ...(page.usage && { usage: { ...page.usage, ...page.limits } }),\n };\n },\n };\n\n const updateObject = db.updateObject?.bind(db);\n if (updateObject) {\n source.renameFile = async ({ item, name }) => {\n const { object } = await updateObject({\n key: item.key,\n bucket: item.bucket,\n filename: name,\n });\n return object;\n };\n }\n if (!folders) return source;\n\n source.uploadOptions = (parent) => ({\n metadata: { folderId: parent ?? \"\" },\n });\n const createFolder = db.createFolder?.bind(db);\n if (createFolder) {\n source.createFolder = async ({ parent, name }) => {\n // A `/` would be a nested path. The server creates one folder.\n if (!isFolderName(name)) throw s3Error(\"FOLDER_INVALID\");\n const { folder } = await createFolder({\n parentId: parent,\n name,\n });\n return { id: folder.id, name: folder.name };\n };\n }\n const updateFolder = db.updateFolder?.bind(db);\n if (updateFolder) {\n source.renameFolder = async ({ folder, name }) => {\n // A `/` would be a nested path. The server renames one folder.\n if (!isFolderName(name)) throw s3Error(\"FOLDER_INVALID\");\n const { folder: updated } = await updateFolder({\n id: folder.id,\n name,\n });\n return { id: updated.id, name: updated.name };\n };\n }\n return source;\n}\n"]}
|
package/dist/folder-path.d.ts
CHANGED
|
@@ -3,12 +3,18 @@
|
|
|
3
3
|
* leading or trailing `/`. `null` is the root. The wire addresses a folder
|
|
4
4
|
* by id; the path is the cached label of that id.
|
|
5
5
|
*/
|
|
6
|
-
/**
|
|
7
|
-
|
|
6
|
+
/**
|
|
7
|
+
* Longest folder path, in UTF-8 bytes, like an S3 key. With the longest scope,
|
|
8
|
+
* the `(scope, path)` unique key stays under PostgreSQL's 2704-byte limit
|
|
9
|
+
* for a btree entry.
|
|
10
|
+
*/
|
|
11
|
+
export declare const FOLDER_PATH_MAX_BYTES = 1024;
|
|
8
12
|
/** Longest folder name (one path segment), in characters. */
|
|
9
13
|
export declare const FOLDER_NAME_MAX_LENGTH = 255;
|
|
10
14
|
/** Most segments in a folder path. Each one is a row the server keeps. */
|
|
11
15
|
export declare const FOLDER_MAX_DEPTH = 32;
|
|
16
|
+
/** Counts code points, so a character outside the BMP counts once. */
|
|
17
|
+
export declare function characterCount(value: string): number;
|
|
12
18
|
/** True when `name` can be one segment of a folder path. */
|
|
13
19
|
export declare function isFolderName(name: string): boolean;
|
|
14
20
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"folder-path.d.ts","sourceRoot":"","sources":["../src/folder-path.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AAEH
|
|
1
|
+
{"version":3,"file":"folder-path.d.ts","sourceRoot":"","sources":["../src/folder-path.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AAEH;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,OAAO,CAAC;AAE1C,6DAA6D;AAC7D,eAAO,MAAM,sBAAsB,MAAM,CAAC;AAE1C,0EAA0E;AAC1E,eAAO,MAAM,gBAAgB,KAAK,CAAC;AAOnC,sEAAsE;AACtE,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAEpD;AAED,4DAA4D;AAC5D,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAUlD;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAO/D;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAKxD;AAED,2DAA2D;AAC3D,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM,CAE1D;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,MAAM,GAAG,IAAI,EACrB,IAAI,EAAE,MAAM,GACX,MAAM,GAAG,IAAI,CAGf;AAED,+DAA+D;AAC/D,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAE1E;AAED,sEAAsE;AACtE,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAG5D;AAED,kCAAkC;AAClC,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAE/C;AAED,6DAA6D;AAC7D,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAGtD"}
|
package/dist/fuma-db.d.ts
CHANGED
|
@@ -2,29 +2,26 @@ import { type InferFumaDB } from "fumadb";
|
|
|
2
2
|
/**
|
|
3
3
|
* The @dimah-s3/db FumaDB library. Call `DimahS3DB.client(adapter)` with an
|
|
4
4
|
* adapter from `@dimah-s3/db/adapters/*` to get a {@link DimahS3DbClient}.
|
|
5
|
-
*
|
|
6
|
-
* `predecessor` is empty. FumaDB skips `up` on the first schema, and the
|
|
7
|
-
* indexes are created in {@link dbSchema}'s `up`.
|
|
8
5
|
*/
|
|
9
|
-
export declare const DimahS3DB: import("fumadb").FumaDBFactory<
|
|
6
|
+
export declare const DimahS3DB: import("fumadb").FumaDBFactory<import("fumadb/schema").Schema<"2.1.0", {
|
|
10
7
|
storageObject: import("fumadb/schema").Table<{
|
|
11
8
|
id: import("fumadb/schema").IdColumn<"varchar(255)", string | null, string>;
|
|
12
|
-
scope: import("fumadb/schema").Column
|
|
13
|
-
bucket: import("fumadb/schema").Column
|
|
14
|
-
key: import("fumadb/schema").Column
|
|
15
|
-
route: import("fumadb/schema").Column
|
|
16
|
-
folderId: import("fumadb/schema").Column
|
|
17
|
-
filename: import("fumadb/schema").Column<"
|
|
18
|
-
contentType: import("fumadb/schema").Column
|
|
19
|
-
size: import("fumadb/schema").Column<"bigint",
|
|
20
|
-
declaredSize: import("fumadb/schema").Column<"bigint",
|
|
21
|
-
eTag: import("fumadb/schema").Column
|
|
22
|
-
status: import("fumadb/schema").Column
|
|
9
|
+
scope: import("fumadb/schema").Column<`varchar(${number})`, string, string>;
|
|
10
|
+
bucket: import("fumadb/schema").Column<`varchar(${number})`, string, string>;
|
|
11
|
+
key: import("fumadb/schema").Column<`varchar(${number})`, string, string>;
|
|
12
|
+
route: import("fumadb/schema").Column<`varchar(${number})`, string, string>;
|
|
13
|
+
folderId: import("fumadb/schema").Column<`varchar(${number})`, string | null, string | null>;
|
|
14
|
+
filename: import("fumadb/schema").Column<"varchar(255)", string, string>;
|
|
15
|
+
contentType: import("fumadb/schema").Column<`varchar(${number})`, string | null, string | null>;
|
|
16
|
+
size: import("fumadb/schema").Column<"bigint", bigint | null, bigint | null>;
|
|
17
|
+
declaredSize: import("fumadb/schema").Column<"bigint", bigint | null, bigint | null>;
|
|
18
|
+
eTag: import("fumadb/schema").Column<`varchar(${number})`, string | null, string | null>;
|
|
19
|
+
status: import("fumadb/schema").Column<`varchar(${number})`, string, string>;
|
|
23
20
|
s3Metadata: import("fumadb/schema").Column<"json", unknown, unknown>;
|
|
24
21
|
attributes: import("fumadb/schema").Column<"json", unknown, unknown>;
|
|
25
|
-
acl: import("fumadb/schema").Column
|
|
22
|
+
acl: import("fumadb/schema").Column<`varchar(${number})`, string | null, string | null>;
|
|
26
23
|
uploadId: import("fumadb/schema").Column<"string", string | null, string | null>;
|
|
27
|
-
uploadToken: import("fumadb/schema").Column
|
|
24
|
+
uploadToken: import("fumadb/schema").Column<`varchar(${number})`, string | null, string | null>;
|
|
28
25
|
expiresAt: import("fumadb/schema").Column<"timestamp", Date | null, Date | null>;
|
|
29
26
|
confirmedAt: import("fumadb/schema").Column<"timestamp", Date | null, Date | null>;
|
|
30
27
|
createdAt: import("fumadb/schema").Column<"timestamp", Date | null, Date>;
|
|
@@ -33,14 +30,14 @@ export declare const DimahS3DB: import("fumadb").FumaDBFactory<(import("fumadb/s
|
|
|
33
30
|
}, {}>;
|
|
34
31
|
storageFolder: import("fumadb/schema").Table<{
|
|
35
32
|
id: import("fumadb/schema").IdColumn<"varchar(255)", string | null, string>;
|
|
36
|
-
scope: import("fumadb/schema").Column
|
|
37
|
-
parentId: import("fumadb/schema").Column
|
|
38
|
-
name: import("fumadb/schema").Column
|
|
39
|
-
path: import("fumadb/schema").Column
|
|
33
|
+
scope: import("fumadb/schema").Column<`varchar(${number})`, string, string>;
|
|
34
|
+
parentId: import("fumadb/schema").Column<`varchar(${number})`, string | null, string>;
|
|
35
|
+
name: import("fumadb/schema").Column<`varchar(${number})`, string, string>;
|
|
36
|
+
path: import("fumadb/schema").Column<`varchar(${number})`, string, string>;
|
|
40
37
|
createdAt: import("fumadb/schema").Column<"timestamp", Date | null, Date>;
|
|
41
38
|
updatedAt: import("fumadb/schema").Column<"timestamp", Date | null, Date>;
|
|
42
39
|
}, {}>;
|
|
43
|
-
}>
|
|
40
|
+
}>[]>;
|
|
44
41
|
/** FumaDB client for the @dimah-s3/db schema. */
|
|
45
42
|
export type DimahS3DbClient = InferFumaDB<typeof DimahS3DB>;
|
|
46
43
|
/** The schema version the stores read and write. */
|
package/dist/fuma-db.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"fuma-db.d.ts","sourceRoot":"","sources":["../src/fuma-db.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,KAAK,WAAW,EAAE,MAAM,QAAQ,CAAC;AAGlD
|
|
1
|
+
{"version":3,"file":"fuma-db.d.ts","sourceRoot":"","sources":["../src/fuma-db.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,KAAK,WAAW,EAAE,MAAM,QAAQ,CAAC;AAGlD;;;GAGG;AACH,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAGpB,CAAC;AAEH,iDAAiD;AACjD,MAAM,MAAM,eAAe,GAAG,WAAW,CAAC,OAAO,SAAS,CAAC,CAAC;AAE5D,oDAAoD;AACpD,eAAO,MAAM,iBAAiB,SAAmB,CAAC"}
|