@adonis-agora/media 0.1.0

package/dist/src/types.d.ts

@@ -0,0 +1,44 @@
+import type { Readable } from 'node:stream';
+/**
+ * The minimal disk surface `@adonis-agora/media` needs — a structural subset of an
+ * `@adonisjs/drive` (flydrive) Disk, so a real Drive disk satisfies it directly. The library
+ * NEVER imports Drive; it resolves a disk from the {@link DiskResolver} (the Drive manager's
+ * `use(name)` in production, a fake in tests) and only ever calls these methods. This keeps Drive
+ * a peer dependency and lets the in-memory test disk implement the same contract.
+ *
+ * Binary reads use `getBytes` (a `Uint8Array`) rather than `get` (which flydrive returns as a UTF-8
+ * string); writes accept a `Uint8Array`, so callers buffer any `Readable` first.
+ */
+export interface Disk {
+    put(key: string, contents: Uint8Array, options?: DiskWriteOptions): Promise<void>;
+    getBytes(key: string): Promise<Uint8Array>;
+    getStream(key: string): Promise<Readable>;
+    exists(key: string): Promise<boolean>;
+    delete(key: string): Promise<void>;
+    getUrl(key: string): Promise<string>;
+    getSignedUrl(key: string, options?: SignedUrlOptions): Promise<string>;
+    getMetaData(key: string): Promise<DiskMetaData>;
+}
+export interface DiskWriteOptions {
+    contentType?: string;
+    visibility?: 'public' | 'private';
+}
+export interface SignedUrlOptions {
+    /** Human-readable duration accepted by Drive, e.g. `'30m'`, `'1h'`, or seconds as a number. */
+    expiresIn?: string | number;
+    contentType?: string;
+    contentDisposition?: string;
+}
+export interface DiskMetaData {
+    contentLength: number;
+    contentType?: string | undefined;
+    etag?: string | undefined;
+    lastModified?: Date | undefined;
+}
+/**
+ * Resolves a disk by name. In an AdonisJS app this is `(name) => drive.use(name)`; the
+ * provider builds it from the booted Drive manager. Tests pass a resolver over fake disks.
+ * Omitting the name yields the configured default disk.
+ */
+export type DiskResolver = (name?: string) => Disk;
+//# sourceMappingURL=types.d.ts.map

package/dist/src/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAE5C;;;;;;;;;GASG;AACH,MAAM,WAAW,IAAI;IACnB,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAClF,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAC3C,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC1C,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACtC,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnC,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACrC,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACvE,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;CACjD;AAED,MAAM,WAAW,gBAAgB;IAC/B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;CACnC;AAED,MAAM,WAAW,gBAAgB;IAC/B,+FAA+F;IAC/F,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,YAAY;IAC3B,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,YAAY,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;CACjC;AAED;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,IAAI,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC"}

package/dist/src/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/src/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":""}

package/dist/stubs/config/media.stub

@@ -0,0 +1,36 @@
+{{{
+  exports({ to: app.configPath('media.ts') })
+}}}
+import { defineConfig, stores, processors } from '@adonis-agora/media'
+
+/**
+ * Configuration for @adonis-agora/media. Storage is delegated to @adonisjs/drive — `disk` names a disk
+ * from your config/drive.ts (omit to use Drive's default). Pick a `store` by name from the map below;
+ * each driver's peer dependency is imported lazily, only when selected. The default store is the
+ * in-process `memory` store (single-process, non-durable). For production select `lucid` and run
+ * `node ace migration:run`.
+ *
+ * Conversions need an image processor — `processors.sharp()` loads the optional `sharp` peer lazily.
+ */
+export default defineConfig({
+  // disk: 's3', // omit to use Drive's default disk
+
+  store: 'memory',
+  stores: {
+    memory: stores.memory(),
+    lucid: stores.lucid(),
+  },
+
+  imageProcessor: processors.sharp(),
+
+  collections: [
+    { name: 'avatar', single: true, acceptsMimeTypes: ['image/png', 'image/jpeg'] },
+    {
+      name: 'gallery',
+      conversions: [
+        { name: 'thumb', width: 200, height: 200 },
+        { name: 'og', width: 1200, eager: true },
+      ],
+    },
+  ],
+})

package/dist/stubs/database/migrations/create_media_table.stub

@@ -0,0 +1,39 @@
+{{{
+  exports({ to: app.migrationsPath(`${new Date().getTime()}_create_media_table.ts`) })
+}}}
+import { BaseSchema } from '@adonisjs/lucid/schema'
+
+/**
+ * The `media` table for the @adonis-agora/media `lucid` store. JSON payloads (`custom_properties`,
+ * `conversions`) are stored as TEXT — the store (de)serializes them — and timestamps as epoch-ms
+ * integers, so the schema is portable across SQLite / Postgres / MySQL.
+ */
+export default class extends BaseSchema {
+  protected tableName = 'media'
+
+  async up() {
+    this.schema.createTable(this.tableName, (table) => {
+      table.string('id').primary()
+      table.string('owner_type').notNullable()
+      table.string('owner_id').notNullable()
+      table.string('collection').notNullable()
+      table.string('name').notNullable()
+      table.string('file_name').notNullable()
+      table.string('mime_type').notNullable()
+      table.bigInteger('size').notNullable()
+      table.string('disk').notNullable()
+      table.text('path').notNullable()
+      table.integer('order').notNullable().defaultTo(0)
+      table.text('custom_properties')
+      table.text('conversions')
+      table.bigInteger('created_at').notNullable()
+      table.bigInteger('updated_at').notNullable()
+      table.index(['owner_type', 'owner_id'], 'media_owner_idx')
+      table.index(['owner_type', 'owner_id', 'collection'], 'media_owner_collection_idx')
+    })
+  }
+
+  async down() {
+    this.schema.dropTable(this.tableName)
+  }
+}

package/dist/stubs/main.d.ts

@@ -0,0 +1,3 @@
+/** Absolute path to the published stubs directory (`dist/stubs/main.js`). */
+export declare const stubsRoot: string;
+//# sourceMappingURL=main.d.ts.map

package/dist/stubs/main.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../stubs/main.ts"],"names":[],"mappings":"AAEA,6EAA6E;AAC7E,eAAO,MAAM,SAAS,QAAgD,CAAC"}

package/dist/stubs/main.js

@@ -0,0 +1,4 @@
+import { fileURLToPath } from 'node:url';
+/** Absolute path to the published stubs directory (`dist/stubs/main.js`). */
+export const stubsRoot = fileURLToPath(new URL('./', import.meta.url));
+//# sourceMappingURL=main.js.map

package/dist/stubs/main.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.js","sourceRoot":"","sources":["../../stubs/main.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,6EAA6E;AAC7E,MAAM,CAAC,MAAM,SAAS,GAAG,aAAa,CAAC,IAAI,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,106 @@
+{
+  "name": "@adonis-agora/media",
+  "version": "0.1.0",
+  "description": "Media-library for AdonisJS — owner collections (MIME whitelist, single-file replace, ordering), image conversions (eager/lazy), and column attachments, all on top of @adonisjs/drive. Pluggable MediaStore (in-memory + Lucid) and ImageProcessor (sharp). Part of the Agora ecosystem.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/DavideCarvalho/adonis-media.git",
+    "directory": "packages/adonis"
+  },
+  "author": "Davi Carvalho <davi@goflip.ai>",
+  "type": "module",
+  "main": "./dist/src/index.js",
+  "types": "./dist/src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "import": "./dist/src/index.js",
+      "default": "./dist/src/index.js"
+    },
+    "./media_provider": {
+      "types": "./dist/providers/media_provider.d.ts",
+      "import": "./dist/providers/media_provider.js",
+      "default": "./dist/providers/media_provider.js"
+    },
+    "./configure": {
+      "types": "./dist/configure.d.ts",
+      "import": "./dist/configure.js",
+      "default": "./dist/configure.js"
+    },
+    "./stores/lucid": {
+      "types": "./dist/src/stores/lucid.d.ts",
+      "import": "./dist/src/stores/lucid.js",
+      "default": "./dist/src/stores/lucid.js"
+    },
+    "./processors/sharp": {
+      "types": "./dist/src/processors/sharp.d.ts",
+      "import": "./dist/src/processors/sharp.js",
+      "default": "./dist/src/processors/sharp.js"
+    },
+    "./testing": {
+      "types": "./dist/src/testing/index.d.ts",
+      "import": "./dist/src/testing/index.js",
+      "default": "./dist/src/testing/index.js"
+    },
+    "./types": {
+      "types": "./dist/src/types.d.ts",
+      "import": "./dist/src/types.js",
+      "default": "./dist/src/types.js"
+    }
+  },
+  "files": [
+    "dist/",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "sideEffects": false,
+  "peerDependencies": {
+    "@adonisjs/core": "^7.3.0",
+    "@adonisjs/drive": "^3.0.0",
+    "@adonisjs/lucid": "^22.4.0",
+    "sharp": "^0.33.0"
+  },
+  "peerDependenciesMeta": {
+    "@adonisjs/lucid": {
+      "optional": true
+    },
+    "sharp": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@adonisjs/assembler": "^8.4.0",
+    "@adonisjs/core": "^7.3.0",
+    "@adonisjs/drive": "^3.0.0",
+    "@adonisjs/lucid": "^22.4.0",
+    "@types/node": "^20.0.0",
+    "sharp": "^0.33.0",
+    "typescript": "^5.4.0",
+    "vitest": "^3.0.0"
+  },
+  "engines": {
+    "node": ">=20.6.0"
+  },
+  "keywords": [
+    "adonisjs",
+    "adonis",
+    "media",
+    "media-library",
+    "drive",
+    "storage",
+    "uploads",
+    "image",
+    "conversions",
+    "sharp",
+    "attachment",
+    "agora"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json && pnpm run copy:stubs",
+    "copy:stubs": "mkdir -p dist/stubs/config dist/stubs/database/migrations && cp stubs/config/media.stub dist/stubs/config/media.stub && cp -r stubs/database/migrations/. dist/stubs/database/migrations/",
+    "test": "vitest run --passWithNoTests",
+    "test:watch": "vitest",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  }
+}