@adonis-agora/media 0.10.3 → 0.11.0

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

@@ -0,0 +1,201 @@
+/**
+ * The JSON API contract shared by the dashboard's browser client and its AdonisJS provider routes.
+ *
+ * These shapes are framework-free (no DOM, no Node) so the same declarations type both the server
+ * responses (`DashboardService`) and the SPA's fetch client. They mirror the real
+ * `@adonis-agora/media` surface: disk `list`/`stat`/`copy`/`move`/`deleteMany` and the resumable
+ * `UploadSessionStore.list()` — never a bespoke server model.
+ */
+/** Coarse capability descriptor for a disk, mirroring `@adonis-agora/media`'s `DiskCapabilities`. */
+export interface DiskCapabilities {
+    presign: boolean;
+    multipart: boolean;
+    publicUrls: boolean;
+    /** Can enumerate keys under a prefix — only such disks are browsable in the console. */
+    list: boolean;
+}
+/** One disk (bucket) exposed to the console. */
+export interface DiskInfo {
+    name: string;
+    /** Whether this is the manager's default disk. */
+    default: boolean;
+    capabilities: DiskCapabilities;
+}
+export interface DiskListResponse {
+    disks: DiskInfo[];
+}
+/** A sub-folder under the browsed prefix (a `CommonPrefix`; `prefix` carries the trailing slash). */
+export interface ObjectFolder {
+    name: string;
+    prefix: string;
+}
+/** A file entry directly under the browsed prefix. */
+export interface ObjectEntry {
+    key: string;
+    name: string;
+    sizeBytes: number | null;
+    /** ISO-8601 string, or null when the backend does not report it. */
+    lastModified: string | null;
+}
+/** One page of a bucket listing (cursor-based, from the disk `list`). */
+export interface ObjectListResponse {
+    folders: ObjectFolder[];
+    files: ObjectEntry[];
+    /** Present only when the page is truncated; pass back as `cursor`. */
+    cursor?: string;
+}
+/** Object metadata plus a short-lived signed URL for preview/download. */
+export interface ObjectDetailResponse {
+    key: string;
+    size: number;
+    contentType?: string;
+    lastModified?: string;
+    url: string;
+}
+/** An in-progress resumable upload session, projected from `UploadSession`. */
+export interface UploadInfo {
+    id: string;
+    disk: string;
+    key: string;
+    offset: number;
+    size: number | null;
+    /** 0..100, or null when the total size is unknown. */
+    percent: number | null;
+    parts: number;
+    multipart: boolean;
+    createdAt?: string;
+}
+export interface UploadListResponse {
+    uploads: UploadInfo[];
+}
+/** A stored media-library record, projected from `@adonis-agora/media`'s `MediaRecord` for the console. */
+export interface MediaEntry {
+    id: string;
+    ownerType: string;
+    ownerId: string;
+    collection: string;
+    /** Logical display name. */
+    name: string;
+    fileName: string;
+    mimeType: string;
+    sizeBytes: number;
+    disk: string;
+    path: string;
+    /** Names of the generated conversions present on the record (e.g. `["thumb"]`). */
+    conversions: string[];
+    createdAt: string;
+    updatedAt: string;
+}
+/** One page of the cross-owner collections listing (cursor-based, from the `MediaStore.list`). */
+export interface CollectionListResponse {
+    items: MediaEntry[];
+    /** Present (non-null) only when a further page exists; pass back as `cursor`. */
+    nextCursor: string | null;
+}
+/** Filters for the collections listing — every field optional and `AND`ed server-side. */
+export interface CollectionFilter {
+    collection?: string;
+    ownerType?: string;
+    ownerId?: string;
+    prefix?: string;
+}
+/** Coarse console topology used to enable/disable UI affordances. */
+export interface Topology {
+    disks: number;
+    hasUploads: boolean;
+    /** Whether mutating actions (copy/move/delete) are enabled on this console. */
+    actions: boolean;
+}
+/** Body for the copy/move actions — `toDisk` defaults to the source disk (same-bucket). */
+export interface CopyMoveBody {
+    disk: string;
+    from: string;
+    to: string;
+    toDisk?: string;
+}
+/** Body for the batched delete action. */
+export interface DeleteBody {
+    disk: string;
+    keys: string[];
+}
+/** Body for the folder create/delete actions — a disk and the folder prefix. */
+export interface FolderBody {
+    disk: string;
+    prefix: string;
+}
+/** One resumable part recorded for an in-progress upload session. */
+export interface UploadPart {
+    partNumber: number;
+    etag: string;
+}
+/** Full detail of one resumable upload session, plus its recorded parts. */
+export interface UploadDetailResponse {
+    upload: UploadInfo;
+    parts: UploadPart[];
+}
+/** One generated conversion/variant of a stored `MediaRecord`, with a short-lived signed URL. */
+export interface MediaVariant {
+    name: string;
+    url: string;
+}
+/** Full detail of one stored `MediaRecord`, plus its generated conversions. */
+export interface MediaDetailResponse {
+    record: MediaEntry;
+    variants: MediaVariant[];
+}
+/** Per-collection rollup (count + total bytes), for the console's collection chips. */
+export interface CollectionSummary {
+    key: string;
+    count: number;
+    sumSize: number;
+}
+export interface CollectionsSummaryResponse {
+    collections: CollectionSummary[];
+}
+/** One label/value row of an {@link ObjectInsight}. Rendered verbatim as text — no markup. */
+export interface ObjectInsightFact {
+    label: string;
+    value: string;
+}
+/** A link out to the host's own screens, rendered as an anchor. */
+export interface ObjectInsightLink {
+    label: string;
+    href: string;
+}
+/**
+ * Host-supplied context about one disk object, rendered in the console preview.
+ *
+ * The console can describe a file only as storage sees it (key, size, type). This is what the HOST
+ * knows about it — which knowledge base indexed it, which work order it belongs to — handed over as
+ * data, because the console ships as a prebuilt bundle a host cannot inject components into.
+ */
+export interface ObjectInsight {
+    /** Section heading, e.g. `Knowledge base`. */
+    title: string;
+    facts?: ObjectInsightFact[];
+    links?: ObjectInsightLink[];
+    /** One line of prose under the facts — a caveat, a status explanation. */
+    note?: string;
+}
+/** What `GET /object/insights` returns. Empty when the host registered no providers. */
+export interface ObjectInsightsResponse {
+    insights: ObjectInsight[];
+}
+/** A signed-in console user, carried by the session cookie and returned by `/me`. */
+export interface ConsoleSessionUserInfo {
+    id: string;
+    name?: string;
+    roles: string[];
+}
+/** Response of `GET /me`: the console SPA renders the login screen or the console from this. */
+export type MeResponse = {
+    authRequired: false;
+} | {
+    user: ConsoleSessionUserInfo;
+};
+/** Body for `POST /login`. */
+export interface LoginBody {
+    username: string;
+    password: string;
+}
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/dashboard/types.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,qGAAqG;AACrG,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,EAAE,OAAO,CAAC;IACpB,wFAAwF;IACxF,IAAI,EAAE,OAAO,CAAC;CACf;AAED,gDAAgD;AAChD,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,kDAAkD;IAClD,OAAO,EAAE,OAAO,CAAC;IACjB,YAAY,EAAE,gBAAgB,CAAC;CAChC;AAED,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,QAAQ,EAAE,CAAC;CACnB;AAED,qGAAqG;AACrG,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,sDAAsD;AACtD,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,oEAAoE;IACpE,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,yEAAyE;AACzE,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,YAAY,EAAE,CAAC;IACxB,KAAK,EAAE,WAAW,EAAE,CAAC;IACrB,sEAAsE;IACtE,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,0EAA0E;AAC1E,MAAM,WAAW,oBAAoB;IACnC,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,GAAG,EAAE,MAAM,CAAC;CACb;AAED,+EAA+E;AAC/E,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,sDAAsD;IACtD,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,UAAU,EAAE,CAAC;CACvB;AAED,2GAA2G;AAC3G,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,4BAA4B;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,mFAAmF;IACnF,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,kGAAkG;AAClG,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,UAAU,EAAE,CAAC;IACpB,iFAAiF;IACjF,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,0FAA0F;AAC1F,MAAM,WAAW,gBAAgB;IAC/B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,qEAAqE;AACrE,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,OAAO,CAAC;IACpB,+EAA+E;IAC/E,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,2FAA2F;AAC3F,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,0CAA0C;AAC1C,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB;AAED,gFAAgF;AAChF,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,qEAAqE;AACrE,MAAM,WAAW,UAAU;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,4EAA4E;AAC5E,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,UAAU,CAAC;IACnB,KAAK,EAAE,UAAU,EAAE,CAAC;CACrB;AAED,iGAAiG;AACjG,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACb;AAED,+EAA+E;AAC/E,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,UAAU,CAAC;IACnB,QAAQ,EAAE,YAAY,EAAE,CAAC;CAC1B;AAED,uFAAuF;AACvF,MAAM,WAAW,iBAAiB;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,0BAA0B;IACzC,WAAW,EAAE,iBAAiB,EAAE,CAAC;CAClC;AAED,8FAA8F;AAC9F,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf;AAED,mEAAmE;AACnE,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;;GAMG;AACH,MAAM,WAAW,aAAa;IAC5B,8CAA8C;IAC9C,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAC5B,KAAK,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAC5B,0EAA0E;IAC1E,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,wFAAwF;AACxF,MAAM,WAAW,sBAAsB;IACrC,QAAQ,EAAE,aAAa,EAAE,CAAC;CAC3B;AAED,qFAAqF;AACrF,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,gGAAgG;AAChG,MAAM,MAAM,UAAU,GAAG;IAAE,YAAY,EAAE,KAAK,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,sBAAsB,CAAA;CAAE,CAAC;AAEpF,8BAA8B;AAC9B,MAAM,WAAW,SAAS;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;CAClB"}

package/dist/src/dashboard/types.js

@@ -0,0 +1,10 @@
+/**
+ * The JSON API contract shared by the dashboard's browser client and its AdonisJS provider routes.
+ *
+ * These shapes are framework-free (no DOM, no Node) so the same declarations type both the server
+ * responses (`DashboardService`) and the SPA's fetch client. They mirror the real
+ * `@adonis-agora/media` surface: disk `list`/`stat`/`copy`/`move`/`deleteMany` and the resumable
+ * `UploadSessionStore.list()` — never a bespoke server model.
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/src/dashboard/types.js.map

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

package/dist/stubs/config/media_dashboard.stub

@@ -0,0 +1,39 @@
+{{{
+  exports({ to: app.configPath('media_dashboard.ts') })
+}}}
+import { defineConfig } from '@adonis-agora/media/dashboard'
+
+/**
+ * Configuration for the @adonis-agora/media dashboard -- a management console (React SPA + JSON API)
+ * embedded in this same package, mounted by '@adonis-agora/media/dashboard_provider' (registered by
+ * 'configure' above). Storage, uploads and everything else come from the already-configured
+ * @adonis-agora/media manager; this config only places the console and picks which disks are browsable.
+ *
+ * The console is a READ-ONLY browser by default. Flip 'actions' on to enable copy/move/delete -- gate
+ * the routes with your own 'middleware' (an auth guard) before you do, and/or configure 'auth' for a
+ * built-in session-cookie login independent of 'middleware'.
+ */
+export default defineConfig({
+  // enabled: true,
+  // basePath: '/media/dashboard',
+  // apiBasePath: '/media/dashboard/api',
+  // actions: true,
+  // disks: ['s3', 'backups'],           // default: derived from config/media.ts
+  // middleware: middleware.auth(),      // gate the whole console — SPA + API
+
+  // Built-in session-cookie login, independent of (and composable with) 'middleware'. At least one of
+  // 'login'/'session' is required when 'auth' is set.
+  // auth: {
+  //   secret: env.get('MEDIA_DASHBOARD_SECRET'),
+  //   ttl: '8h',
+  //   // Mode B — standalone login page (the SPA renders it until a valid cookie exists).
+  //   login: async (username, password) => {
+  //     if (username === 'admin' && password === env.get('MEDIA_DASHBOARD_PASSWORD')) {
+  //       return { id: 'admin', name: 'Admin' }
+  //     }
+  //     return null
+  //   },
+  //   // Mode A — mint a session for an already-authenticated host request.
+  //   // session: async (request) => (request.user?.isAdmin ? { id: request.user.id } : null),
+  // },
+})

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@adonis-agora/media",
-  "version": "0.10.3",
+  "version": "0.11.0",
   "description": "Media-library for AdonisJS — owner collections (MIME whitelist, single-file replace, ordering), image conversions (eager/lazy), pluggable content transformers (HLS video via mediabunny, metadata probe), 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",
+    "url": "git+https://github.com/DavideCarvalho/adonis-agora-media.git",
     "directory": "packages/adonis"
   },
   "author": "Davi Carvalho <davi@goflip.ai>",
@@ -33,6 +33,16 @@
       "import": "./dist/providers/media_provider.js",
       "default": "./dist/providers/media_provider.js"
     },
+    "./dashboard_provider": {
+      "types": "./dist/providers/dashboard_provider.d.ts",
+      "import": "./dist/providers/dashboard_provider.js",
+      "default": "./dist/providers/dashboard_provider.js"
+    },
+    "./dashboard": {
+      "types": "./dist/src/dashboard/index.d.ts",
+      "import": "./dist/src/dashboard/index.js",
+      "default": "./dist/src/dashboard/index.js"
+    },
     "./configure": {
       "types": "./dist/configure.d.ts",
       "import": "./dist/configure.js",
@@ -83,7 +93,7 @@
   "peerDependencies": {
     "@adonis-agora/telescope": "^0.4.0",
     "@adonisjs/core": "^7.3.0",
-    "@adonisjs/drive": "^3.0.0",
+    "@adonisjs/drive": "^3.0.0 || ^4.0.0",
     "@adonisjs/lucid": "^22.4.0",
     "@aws-sdk/client-s3": "^3.0.0",
     "mediabunny": "^1.45.4",
@@ -108,21 +118,22 @@
   },
   "devDependencies": {
     "@adonisjs/assembler": "^8.4.0",
-    "@adonisjs/core": "^7.3.0",
-    "@adonisjs/drive": "^3.0.0",
+    "@adonisjs/core": "7.4.0",
+    "@adonisjs/drive": "^4.0.0",
     "@adonisjs/lucid": "^22.4.0",
-    "@aws-sdk/client-s3": "^3.726.1",
+    "@aws-sdk/client-s3": "3.1107.0",
     "@smithy/util-stream": "^3.3.1",
     "@types/better-sqlite3": "^7.6.0",
     "@types/node": "^20.0.0",
     "aws-sdk-client-mock": "^4.1.0",
     "better-sqlite3": "^11.0.0",
     "luxon": "^3.4.0",
-    "mediabunny": "^1.50.9",
+    "mediabunny": "1.53.0",
     "sharp": "^0.33.0",
     "tempura": "0.4.1",
     "typescript": "^5.4.0",
-    "vitest": "^3.0.0"
+    "vitest": "3.2.7",
+    "@adonis-agora/media-dashboard": "7.0.0"
   },
   "engines": {
     "node": ">=20.6.0"
@@ -147,7 +158,7 @@
   ],
   "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/",
+    "copy:stubs": "mkdir -p dist/stubs/config dist/stubs/database/migrations dist/assets && cp stubs/config/media.stub dist/stubs/config/media.stub && cp stubs/config/media_dashboard.stub dist/stubs/config/media_dashboard.stub && cp -r stubs/database/migrations/. dist/stubs/database/migrations/ && rm -rf dist/assets/spa && cp -r ../dashboard/dist/spa dist/assets/spa",
     "test": "vitest run --passWithNoTests",
     "test:watch": "vitest",
     "typecheck": "tsc -p tsconfig.json --noEmit"