@dimah-s3/db 2.0.0-beta.8 → 2.0.0-beta.9

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 (36) hide show
  1. package/dist/cli.js +11 -2
  2. package/dist/cli.js.map +1 -1
  3. package/dist/client/db-object-source.d.ts +7 -4
  4. package/dist/client/db-object-source.d.ts.map +1 -1
  5. package/dist/client/index.d.ts +1 -1
  6. package/dist/client/index.d.ts.map +1 -1
  7. package/dist/client/index.js +53 -11
  8. package/dist/client/index.js.map +1 -1
  9. package/dist/fuma-db.d.ts +4 -2
  10. package/dist/fuma-db.d.ts.map +1 -1
  11. package/dist/index.js +228 -45
  12. package/dist/index.js.map +1 -1
  13. package/dist/plugin/create-database-endpoints.d.ts +7 -3
  14. package/dist/plugin/create-database-endpoints.d.ts.map +1 -1
  15. package/dist/plugin/object-access.d.ts +1 -1
  16. package/dist/plugin/object-access.d.ts.map +1 -1
  17. package/dist/plugin/public-stores.d.ts +1 -1
  18. package/dist/plugin/public-stores.d.ts.map +1 -1
  19. package/dist/plugin/schemas.d.ts +6 -1
  20. package/dist/plugin/schemas.d.ts.map +1 -1
  21. package/dist/schema/schema.d.ts +15 -2
  22. package/dist/schema/schema.d.ts.map +1 -1
  23. package/dist/store/create-db-store.d.ts.map +1 -1
  24. package/dist/store/folder-store.d.ts +31 -0
  25. package/dist/store/folder-store.d.ts.map +1 -1
  26. package/dist/store/list-cursor.d.ts +2 -0
  27. package/dist/store/list-cursor.d.ts.map +1 -1
  28. package/dist/store/object-store.d.ts +15 -5
  29. package/dist/store/object-store.d.ts.map +1 -1
  30. package/dist/store/search-name.d.ts +7 -0
  31. package/dist/store/search-name.d.ts.map +1 -0
  32. package/dist/types/client.d.ts +51 -5
  33. package/dist/types/client.d.ts.map +1 -1
  34. package/dist/types/plugin.d.ts +5 -0
  35. package/dist/types/plugin.d.ts.map +1 -1
  36. package/package.json +10 -10
package/dist/cli.js CHANGED
@@ -5,6 +5,7 @@ import { table, column, idColumn, schema } from 'fumadb/schema';
5
5
  // src/cli.ts
6
6
  var BINARY = { mysql: "utf8mb4_bin" };
7
7
  var TEXT = { mysql: "utf8mb4_unicode_ci" };
8
+ var SEARCH_NAME_MAX_LENGTH = 1024;
8
9
  var LONG_PREFIX = 512;
9
10
  var SCOPE_MAX_LENGTH = 255;
10
11
  function string(name, length = 255) {
@@ -21,6 +22,12 @@ var storageObject = table("storage_object", {
21
22
  /** Folder that holds the object. `null` is the root. */
22
23
  folderId: string("folder_id").nullable(),
23
24
  filename: column("filename", "varchar(255)").collate(TEXT),
25
+ /**
26
+ * `filename` folded for search: lowercase, without accents, with `%`,
27
+ * `_`, and `\` kept literal. Search matches it on every database the
28
+ * same way.
29
+ */
30
+ searchName: string("search_name", SEARCH_NAME_MAX_LENGTH),
24
31
  contentType: string("content_type").nullable(),
25
32
  /** Verified size from HeadObject, set on confirm. */
26
33
  size: column("size", "bigint").nullable(),
@@ -58,6 +65,8 @@ var storageFolder = table("storage_folder", {
58
65
  parentId: string("parent_id").defaultTo(""),
59
66
  /** Last segment of `path`. */
60
67
  name: string("name"),
68
+ /** `name` folded for search, like `storage_object.search_name`. */
69
+ searchName: string("search_name", SEARCH_NAME_MAX_LENGTH),
61
70
  /** Full folder path. */
62
71
  path: string("path", 1024),
63
72
  createdAt: column("created_at", "timestamp").defaultTo$("now"),
@@ -66,7 +75,7 @@ var storageFolder = table("storage_folder", {
66
75
  length: { path: LONG_PREFIX }
67
76
  }).unique("storage_folder_scope_parent_name_uk", ["scope", "parentId", "name"]);
68
77
  var dbSchema = schema({
69
- version: "2.1.0",
78
+ version: "2.2.0",
70
79
  tables: {
71
80
  storageObject,
72
81
  storageFolder
@@ -86,7 +95,7 @@ function runCli(client) {
86
95
  db: client,
87
96
  command: "dimah-s3-db",
88
97
  description: "FumaDB CLI for @dimah-s3/db",
89
- version: "2.0.0-beta.8"
98
+ version: "2.0.0-beta.9"
90
99
  });
91
100
  return main();
92
101
  }
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":";;;;;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"]}
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;AAMpC,IAAM,sBAAA,GAAyB,IAAA;AAOtC,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;AAAA;AAAA;AAAA;AAAA;AAAA,EAMzD,UAAA,EAAY,MAAA,CAAO,aAAA,EAAe,sBAAsB,CAAA;AAAA,EACxD,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,UAAA,EAAY,MAAA,CAAO,aAAA,EAAe,sBAAsB,CAAA;AAAA;AAAA,EAExD,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;;;AC1HwB,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 the name sort. */\nconst TEXT = { mysql: \"utf8mb4_unicode_ci\" };\n\n/**\n * Longest `search_name`, in characters. Folding can lengthen a name (`ß`\n * becomes `ss`), so it has more room than the 255-character name.\n */\nexport const SEARCH_NAME_MAX_LENGTH = 1024;\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 /**\n * `filename` folded for search: lowercase, without accents, with `%`,\n * `_`, and `\\` kept literal. Search matches it on every database the\n * same way.\n */\n searchName: string(\"search_name\", SEARCH_NAME_MAX_LENGTH),\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 /** `name` folded for search, like `storage_object.search_name`. */\n searchName: string(\"search_name\", SEARCH_NAME_MAX_LENGTH),\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.2.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.2.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"]}
@@ -12,10 +12,13 @@ export type DbObjectSourceActions<TClientAttributes = never> = Pick<DbClientActi
12
12
  * `folders: false`, the list is flat: file rename stays, and folder actions
13
13
  * do not.
14
14
  *
15
- * `search` matches the filename on the server. `sort` maps `name` to
16
- * `filename`; `size` and `updatedAt` keep their names, and other fields keep
17
- * the server's order (newest first). `usage` is the scope total with its
18
- * caps, not the open folder's.
15
+ * `search` runs on the server and ignores case and accents. With `folders`
16
+ * on it is recursive: `searchScope: "folder"` looks in the open folder and
17
+ * every folder below it, `"all"` in the whole scope, and each result's
18
+ * `location` says where it lives. `sort` maps `name` to `filename`; `size`
19
+ * and `updatedAt` keep their names, and other fields keep the server's
20
+ * order (newest first). `usage` is the scope total with its caps, not the
21
+ * open folder's.
19
22
  *
20
23
  * ```ts
21
24
  * const list = useObjectList({
@@ -1 +1 @@
1
- {"version":3,"file":"db-object-source.d.ts","sourceRoot":"","sources":["../../src/client/db-object-source.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,eAAe,EAKf,cAAc,EAEd,qBAAqB,EAEtB,MAAM,gBAAgB,CAAC;AAExB,yDAAyD;AACzD,MAAM,MAAM,qBAAqB,CAAC,iBAAiB,GAAG,KAAK,IAAI,IAAI,CACjE,eAAe,CAAC,iBAAiB,CAAC,EAClC,aAAa,CACd,GACC,OAAO,CACL,IAAI,CACF,eAAe,CAAC,iBAAiB,CAAC,EAClC,cAAc,GAAG,cAAc,GAAG,cAAc,CACjD,CACF,CAAC;AA0BJ;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,cAAc,CAAC,iBAAiB,GAAG,KAAK,EACtD,EAAE,EAAE,qBAAqB,CAAC,iBAAiB,CAAC,EAC5C,OAAO,GAAE,qBAA0B,GAClC,cAAc,CAAC,iBAAiB,CAAC,CAgFnC"}
1
+ {"version":3,"file":"db-object-source.d.ts","sourceRoot":"","sources":["../../src/client/db-object-source.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,eAAe,EAMf,cAAc,EAGd,qBAAqB,EAEtB,MAAM,gBAAgB,CAAC;AAExB,yDAAyD;AACzD,MAAM,MAAM,qBAAqB,CAAC,iBAAiB,GAAG,KAAK,IAAI,IAAI,CACjE,eAAe,CAAC,iBAAiB,CAAC,EAClC,aAAa,CACd,GACC,OAAO,CACL,IAAI,CACF,eAAe,CAAC,iBAAiB,CAAC,EAClC,cAAc,GAAG,cAAc,GAAG,cAAc,CACjD,CACF,CAAC;AA4CJ;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,cAAc,CAAC,iBAAiB,GAAG,KAAK,EACtD,EAAE,EAAE,qBAAqB,CAAC,iBAAiB,CAAC,EAC5C,OAAO,GAAE,qBAA0B,GAClC,cAAc,CAAC,iBAAiB,CAAC,CAqHnC"}
@@ -1,5 +1,5 @@
1
1
  export { dbClient } from "./db-client";
2
2
  export { dbObjectSource, type DbObjectSourceActions } from "./db-object-source";
3
- export type { DbClientActions, DbClientCreateFolderInput, DbClientDeleteFolderInput, DbClientFolder, DbClientGetInput, DbClientListInput, DbClientListResponse, DbClientObject, DbClientObjectStatus, DbClientUpdateFolderInput, DbClientUpdateInput, DbListSort, DbListSortField, DbObjectSource, DbObjectSourceFile, DbObjectSourceFolder, DbObjectSourceOptions, DbObjectSourcePage, DbObjectSourceQueryInput, DbQuota, DbUsage, } from "../types/client.js";
3
+ export type { DbClientActions, DbClientCreateFolderInput, DbClientDeleteFolderInput, DbClientFolder, DbClientGetInput, DbClientListInput, DbClientListResponse, DbClientObject, DbClientObjectStatus, DbClientUpdateFolderInput, DbClientUpdateInput, DbListSort, DbListSortField, DbObjectSource, DbObjectSourceFile, DbObjectSourceFolder, DbObjectSourceOptions, DbObjectSourcePage, DbObjectSourceQueryInput, DbObjectSourceSearchScope, DbQuota, DbUsage, } from "../types/client.js";
4
4
  export type { StorageObjectStatus } from "../types/storage-object.js";
5
5
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,cAAc,EAAE,KAAK,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAChF,YAAY,EACV,eAAe,EACf,yBAAyB,EACzB,yBAAyB,EACzB,cAAc,EACd,gBAAgB,EAChB,iBAAiB,EACjB,oBAAoB,EACpB,cAAc,EACd,oBAAoB,EACpB,yBAAyB,EACzB,mBAAmB,EACnB,UAAU,EACV,eAAe,EACf,cAAc,EACd,kBAAkB,EAClB,oBAAoB,EACpB,qBAAqB,EACrB,kBAAkB,EAClB,wBAAwB,EACxB,OAAO,EACP,OAAO,GACR,MAAM,gBAAgB,CAAC;AACxB,YAAY,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,cAAc,EAAE,KAAK,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAChF,YAAY,EACV,eAAe,EACf,yBAAyB,EACzB,yBAAyB,EACzB,cAAc,EACd,gBAAgB,EAChB,iBAAiB,EACjB,oBAAoB,EACpB,cAAc,EACd,oBAAoB,EACpB,yBAAyB,EACzB,mBAAmB,EACnB,UAAU,EACV,eAAe,EACf,cAAc,EACd,kBAAkB,EAClB,oBAAoB,EACpB,qBAAqB,EACrB,kBAAkB,EAClB,wBAAwB,EACxB,yBAAyB,EACzB,OAAO,EACP,OAAO,GACR,MAAM,gBAAgB,CAAC;AACxB,YAAY,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC"}
@@ -64,23 +64,52 @@ function toListSort(sort) {
64
64
  const field = sort ? SORT_FIELDS.get(sort.field) : void 0;
65
65
  return sort && field ? { field, direction: sort.direction } : void 0;
66
66
  }
67
- function toFile(object) {
68
- return {
69
- name: object.filename,
70
- objectKey: object.key,
71
- size: object.size,
72
- contentType: object.contentType,
73
- updatedAt: object.updatedAt
67
+ function locationsOf(folders) {
68
+ const byId = new Map(folders.map((folder) => [folder.id, folder]));
69
+ const cache = /* @__PURE__ */ new Map();
70
+ const trailTo = (folderId) => {
71
+ if (folderId === null) return [];
72
+ const cached = cache.get(folderId);
73
+ if (cached) return cached;
74
+ const chain = [];
75
+ const seen = /* @__PURE__ */ new Set();
76
+ let current = byId.get(folderId);
77
+ while (current && !seen.has(current.id)) {
78
+ seen.add(current.id);
79
+ chain.unshift({ id: current.id, name: current.name });
80
+ current = current.parentId === null ? void 0 : byId.get(current.parentId);
81
+ }
82
+ cache.set(folderId, chain);
83
+ return chain;
74
84
  };
85
+ return trailTo;
75
86
  }
76
87
  function dbObjectSource(db, options = {}) {
77
88
  const folders = options.folders !== false;
89
+ const searchBelow = folders && options.recursiveSearch !== false;
90
+ const locations = /* @__PURE__ */ new WeakMap();
91
+ const toFile = (object) => {
92
+ const file = {
93
+ name: object.filename,
94
+ objectKey: object.key,
95
+ size: object.size,
96
+ contentType: object.contentType,
97
+ updatedAt: object.updatedAt
98
+ };
99
+ const location = locations.get(object);
100
+ if (location) file.location = location;
101
+ return file;
102
+ };
78
103
  const source = {
79
104
  getKey: (item) => item.id,
80
105
  getFile: toFile,
81
- async query({ parent, cursor, sort, search, signal }) {
106
+ async query({ parent, cursor, sort, search, searchScope, signal }) {
82
107
  const input = {};
83
- if (folders) input.folderId = parent ?? "";
108
+ const recursive = searchBelow && search !== "";
109
+ if (folders) {
110
+ input.folderId = recursive && searchScope === "all" ? "" : parent ?? "";
111
+ }
112
+ if (recursive) input.recursive = true;
84
113
  if (cursor) input.cursor = cursor;
85
114
  if (search) input.search = search;
86
115
  const listSort = toListSort(sort);
@@ -90,13 +119,24 @@ function dbObjectSource(db, options = {}) {
90
119
  if (options.contentType) input.contentType = options.contentType;
91
120
  if (options.limit !== void 0) input.limit = options.limit;
92
121
  const page = await db.listObjects(input, { signal });
122
+ const locate = recursive ? locationsOf([
123
+ ...page.locations ?? [],
124
+ ...page.trail ?? [],
125
+ ...page.folders ?? []
126
+ ]) : null;
127
+ if (locate) {
128
+ for (const object of page.objects) {
129
+ locations.set(object, locate(object.folderId));
130
+ }
131
+ }
93
132
  return {
94
133
  items: page.objects,
95
134
  nextCursor: page.nextCursor,
96
135
  ...page.folders && {
97
136
  folders: page.folders.map((folder) => ({
98
137
  id: folder.id,
99
- name: folder.name
138
+ name: folder.name,
139
+ ...locate && { location: locate(folder.parentId) }
100
140
  }))
101
141
  },
102
142
  ...page.trail && {
@@ -105,10 +145,12 @@ function dbObjectSource(db, options = {}) {
105
145
  name: folder.name
106
146
  }))
107
147
  },
108
- ...page.usage && { usage: { ...page.usage, ...page.limits } }
148
+ ...page.usage && { usage: { ...page.usage, ...page.limits } },
149
+ ...page.total !== void 0 && { total: page.total }
109
150
  };
110
151
  }
111
152
  };
153
+ if (searchBelow) source.searchScopes = ["folder", "all"];
112
154
  const updateObject = db.updateObject?.bind(db);
113
155
  if (updateObject) {
114
156
  source.renameFile = async ({ item, name }) => {
@@ -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;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"]}
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;;;ACbA,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;AAMA,SAAS,YACP,OAAA,EACqD;AACrD,EAAA,MAAM,IAAA,GAAO,IAAI,GAAA,CAAI,OAAA,CAAQ,GAAA,CAAI,CAAC,MAAA,KAAW,CAAC,MAAA,CAAO,EAAA,EAAI,MAAM,CAAC,CAAC,CAAA;AACjE,EAAA,MAAM,KAAA,uBAAY,GAAA,EAAoC;AACtD,EAAA,MAAM,OAAA,GAAU,CAAC,QAAA,KAAoD;AACnE,IAAA,IAAI,QAAA,KAAa,IAAA,EAAM,OAAO,EAAC;AAC/B,IAAA,MAAM,MAAA,GAAS,KAAA,CAAM,GAAA,CAAI,QAAQ,CAAA;AACjC,IAAA,IAAI,QAAQ,OAAO,MAAA;AACnB,IAAA,MAAM,QAAgC,EAAC;AACvC,IAAA,MAAM,IAAA,uBAAW,GAAA,EAAY;AAC7B,IAAA,IAAI,OAAA,GAAU,IAAA,CAAK,GAAA,CAAI,QAAQ,CAAA;AAC/B,IAAA,OAAO,WAAW,CAAC,IAAA,CAAK,GAAA,CAAI,OAAA,CAAQ,EAAE,CAAA,EAAG;AACvC,MAAA,IAAA,CAAK,GAAA,CAAI,QAAQ,EAAE,CAAA;AACnB,MAAA,KAAA,CAAM,OAAA,CAAQ,EAAE,EAAA,EAAI,OAAA,CAAQ,IAAI,IAAA,EAAM,OAAA,CAAQ,MAAM,CAAA;AACpD,MAAA,OAAA,GACE,QAAQ,QAAA,KAAa,IAAA,GAAO,SAAY,IAAA,CAAK,GAAA,CAAI,QAAQ,QAAQ,CAAA;AAAA,IACrE;AACA,IAAA,KAAA,CAAM,GAAA,CAAI,UAAU,KAAK,CAAA;AACzB,IAAA,OAAO,KAAA;AAAA,EACT,CAAA;AACA,EAAA,OAAO,OAAA;AACT;AA4BO,SAAS,cAAA,CACd,EAAA,EACA,OAAA,GAAiC,EAAC,EACC;AACnC,EAAA,MAAM,OAAA,GAAU,QAAQ,OAAA,KAAY,KAAA;AACpC,EAAA,MAAM,WAAA,GAAc,OAAA,IAAW,OAAA,CAAQ,eAAA,KAAoB,KAAA;AAG3D,EAAA,MAAM,SAAA,uBAAgB,OAAA,EAAwC;AAC9D,EAAA,MAAM,MAAA,GAAS,CAAC,MAAA,KAA8C;AAC5D,IAAA,MAAM,IAAA,GAA2B;AAAA,MAC/B,MAAM,MAAA,CAAO,QAAA;AAAA,MACb,WAAW,MAAA,CAAO,GAAA;AAAA,MAClB,MAAM,MAAA,CAAO,IAAA;AAAA,MACb,aAAa,MAAA,CAAO,WAAA;AAAA,MACpB,WAAW,MAAA,CAAO;AAAA,KACpB;AACA,IAAA,MAAM,QAAA,GAAW,SAAA,CAAU,GAAA,CAAI,MAAM,CAAA;AACrC,IAAA,IAAI,QAAA,OAAe,QAAA,GAAW,QAAA;AAC9B,IAAA,OAAO,IAAA;AAAA,EACT,CAAA;AAEA,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,WAAA,EAAa,MAAA,EAAO,EAAG;AACjE,MAAA,MAAM,QAA2B,EAAC;AAElC,MAAA,MAAM,SAAA,GAAY,eAAe,MAAA,KAAW,EAAA;AAC5C,MAAA,IAAI,OAAA,EAAS;AACX,QAAA,KAAA,CAAM,QAAA,GACJ,SAAA,IAAa,WAAA,KAAgB,KAAA,GAAQ,KAAM,MAAA,IAAU,EAAA;AAAA,MACzD;AACA,MAAA,IAAI,SAAA,QAAiB,SAAA,GAAY,IAAA;AACjC,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,MAAM,MAAA,GAAS,YACX,WAAA,CAAY;AAAA,QACV,GAAI,IAAA,CAAK,SAAA,IAAa,EAAC;AAAA,QACvB,GAAI,IAAA,CAAK,KAAA,IAAS,EAAC;AAAA,QACnB,GAAI,IAAA,CAAK,OAAA,IAAW;AAAC,OACtB,CAAA,GACD,IAAA;AACJ,MAAA,IAAI,MAAA,EAAQ;AACV,QAAA,KAAA,MAAW,MAAA,IAAU,KAAK,OAAA,EAAS;AACjC,UAAA,SAAA,CAAU,GAAA,CAAI,MAAA,EAAQ,MAAA,CAAO,MAAA,CAAO,QAAQ,CAAC,CAAA;AAAA,QAC/C;AAAA,MACF;AACA,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,IAAA;AAAA,YACb,GAAI,MAAA,IAAU,EAAE,UAAU,MAAA,CAAO,MAAA,CAAO,QAAQ,CAAA;AAAE,WACpD,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,EAAE;AAAA,QAC7D,GAAI,IAAA,CAAK,KAAA,KAAU,UAAa,EAAE,KAAA,EAAO,KAAK,KAAA;AAAM,OACtD;AAAA,IACF;AAAA,GACF;AACA,EAAA,IAAI,WAAA,EAAa,MAAA,CAAO,YAAA,GAAe,CAAC,UAAU,KAAK,CAAA;AAEvD,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 DbClientFolder,\n DbClientListInput,\n DbClientObject,\n DbListSort,\n DbListSortField,\n DbObjectSource,\n DbObjectSourceFile,\n DbObjectSourceFolder,\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\n/**\n * The path to each folder in `folders`, root excluded, by walking\n * `parentId`. A folder whose parent is missing gets the part that is known.\n */\nfunction locationsOf(\n folders: readonly DbClientFolder[],\n): (folderId: string | null) => DbObjectSourceFolder[] {\n const byId = new Map(folders.map((folder) => [folder.id, folder]));\n const cache = new Map<string, DbObjectSourceFolder[]>();\n const trailTo = (folderId: string | null): DbObjectSourceFolder[] => {\n if (folderId === null) return [];\n const cached = cache.get(folderId);\n if (cached) return cached;\n const chain: DbObjectSourceFolder[] = [];\n const seen = new Set<string>();\n let current = byId.get(folderId);\n while (current && !seen.has(current.id)) {\n seen.add(current.id);\n chain.unshift({ id: current.id, name: current.name });\n current =\n current.parentId === null ? undefined : byId.get(current.parentId);\n }\n cache.set(folderId, chain);\n return chain;\n };\n return trailTo;\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` runs on the server and ignores case and accents. With `folders`\n * on it is recursive: `searchScope: \"folder\"` looks in the open folder and\n * every folder below it, `\"all\"` in the whole scope, and each result's\n * `location` says where it lives. `sort` maps `name` to `filename`; `size`\n * and `updatedAt` keep their names, and other fields keep the server's\n * order (newest first). `usage` is the scope total with its caps, not the\n * 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 const searchBelow = folders && options.recursiveSearch !== false;\n // Where each row of a search lives. Keyed by the row object, so `getFile`\n // reads it for the rows a query returned and stays pure.\n const locations = new WeakMap<object, DbObjectSourceFolder[]>();\n const toFile = (object: DbClientObject<TClientAttributes>) => {\n const file: DbObjectSourceFile = {\n name: object.filename,\n objectKey: object.key,\n size: object.size,\n contentType: object.contentType,\n updatedAt: object.updatedAt,\n };\n const location = locations.get(object);\n if (location) file.location = location;\n return file;\n };\n\n const source: DbObjectSource<TClientAttributes> = {\n getKey: (item) => item.id,\n getFile: toFile,\n async query({ parent, cursor, sort, search, searchScope, signal }) {\n const input: DbClientListInput = {};\n // A search reaches the folders below; a listing shows one folder.\n const recursive = searchBelow && search !== \"\";\n if (folders) {\n input.folderId =\n recursive && searchScope === \"all\" ? \"\" : (parent ?? \"\");\n }\n if (recursive) input.recursive = true;\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 const locate = recursive\n ? locationsOf([\n ...(page.locations ?? []),\n ...(page.trail ?? []),\n ...(page.folders ?? []),\n ])\n : null;\n if (locate) {\n for (const object of page.objects) {\n locations.set(object, locate(object.folderId));\n }\n }\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 ...(locate && { location: locate(folder.parentId) }),\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 ...(page.total !== undefined && { total: page.total }),\n };\n },\n };\n if (searchBelow) source.searchScopes = [\"folder\", \"all\"];\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/fuma-db.d.ts CHANGED
@@ -3,7 +3,7 @@ import { type InferFumaDB } from "fumadb";
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
5
  */
6
- export declare const DimahS3DB: import("fumadb").FumaDBFactory<import("fumadb/schema").Schema<"2.1.0", {
6
+ export declare const DimahS3DB: import("fumadb").FumaDBFactory<import("fumadb/schema").Schema<"2.2.0", {
7
7
  storageObject: import("fumadb/schema").Table<{
8
8
  id: import("fumadb/schema").IdColumn<"varchar(255)", string | null, string>;
9
9
  scope: import("fumadb/schema").Column<`varchar(${number})`, string, string>;
@@ -12,6 +12,7 @@ export declare const DimahS3DB: import("fumadb").FumaDBFactory<import("fumadb/sc
12
12
  route: import("fumadb/schema").Column<`varchar(${number})`, string, string>;
13
13
  folderId: import("fumadb/schema").Column<`varchar(${number})`, string | null, string | null>;
14
14
  filename: import("fumadb/schema").Column<"varchar(255)", string, string>;
15
+ searchName: import("fumadb/schema").Column<`varchar(${number})`, string, string>;
15
16
  contentType: import("fumadb/schema").Column<`varchar(${number})`, string | null, string | null>;
16
17
  size: import("fumadb/schema").Column<"bigint", bigint | null, bigint | null>;
17
18
  declaredSize: import("fumadb/schema").Column<"bigint", bigint | null, bigint | null>;
@@ -33,6 +34,7 @@ export declare const DimahS3DB: import("fumadb").FumaDBFactory<import("fumadb/sc
33
34
  scope: import("fumadb/schema").Column<`varchar(${number})`, string, string>;
34
35
  parentId: import("fumadb/schema").Column<`varchar(${number})`, string | null, string>;
35
36
  name: import("fumadb/schema").Column<`varchar(${number})`, string, string>;
37
+ searchName: import("fumadb/schema").Column<`varchar(${number})`, string, string>;
36
38
  path: import("fumadb/schema").Column<`varchar(${number})`, string, string>;
37
39
  createdAt: import("fumadb/schema").Column<"timestamp", Date | null, Date>;
38
40
  updatedAt: import("fumadb/schema").Column<"timestamp", Date | null, Date>;
@@ -41,5 +43,5 @@ export declare const DimahS3DB: import("fumadb").FumaDBFactory<import("fumadb/sc
41
43
  /** FumaDB client for the @dimah-s3/db schema. */
42
44
  export type DimahS3DbClient = InferFumaDB<typeof DimahS3DB>;
43
45
  /** The schema version the stores read and write. */
44
- export declare const DB_SCHEMA_VERSION: "2.1.0";
46
+ export declare const DB_SCHEMA_VERSION: "2.2.0";
45
47
  //# sourceMappingURL=fuma-db.d.ts.map
@@ -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;;;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"}
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"}