@maas/payload-plugin-media-cloud 0.0.0

package/dist/types/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","names":[],"sources":["../../src/types/errors.ts"],"sourcesContent":["export enum MediaCloudError {\n  // Mux Errors\n  MUX_CONFIG_MISSING = 'Mux configuration (tokenId and tokenSecret) must be provided in pluginOptions to use Mux',\n  MUX_CONFIG_INCOMPLETE = 'Mux configuration is missing. Mux features will not be available',\n  MUX_UPLOAD_ID_MISSING = 'No upload-id found for upload',\n  MUX_ASSET_DELETE_ERROR = 'Error deleting Mux asset',\n  MUX_UPLOAD_ERROR = 'Mux video upload failed',\n  MUX_DIRECT_UPLOAD_ERROR = 'Mux direct upload failed',\n  MUX_CREATE_UPLOAD_ERROR = 'Error in Mux create upload handler',\n  MUX_REQUEST_NO_JSON = 'Request does not support json() method',\n\n  // S3 Errors\n  S3_CONFIG_MISSING = 'S3 configuration (bucket, region, accessKeyId, secretAccessKey) must be provided in pluginOptions',\n  S3_DELETE_ERROR = 'Error deleting file from S3',\n  S3_UNIQUE_NAME_ERROR = 'Could not find a unique file name after maximum tries',\n\n  // TUS Errors\n  TUS_UPLOAD_ERROR = 'TUS file upload error occurred',\n\n  // File Errors\n  FILE_TYPE_UNKNOWN = 'Unable to determine file type',\n  FILE_TYPE_ERROR = 'Error determining file type',\n  FILENAME_SANITIZE_ERROR = 'Error sanitizing filename',\n\n  // Upload Errors\n  UPLOAD_NO_URL = 'No upload URL provided, cannot parse upload ID',\n  UPLOAD_HANDLER_ERROR = 'Upload handler error occurred',\n  UPLOAD_POLLING_ERROR = 'Polling error for upload',\n\n  // Plugin Errors\n  PLUGIN_NOT_CONFIGURED = 'Payload Media Cloud plugin is not configured',\n  NAMING_FUNCTION_ERROR = 'Error in namingFunction',\n}\n"],"mappings":";AAAA,IAAY,8DAAL;;;;;;;;;;;;;;;;;;;;;;AAgCN"}

package/dist/types/index.d.ts

@@ -0,0 +1,73 @@
+import Mux from "@mux/mux-node";
+import { ObjectCannedACL, S3ClientConfig } from "@aws-sdk/client-s3";
+import { KvStore, Upload } from "@tus/utils";
+import fs from "node:fs";
+
+//#region src/types/index.d.ts
+interface MediaCloudPluginOptions {
+  enabled?: boolean;
+  mux: {
+    assetOptions: Partial<Mux.Video.Assets.AssetOptions>;
+    testMode?: boolean;
+    tokenId: string;
+    tokenSecret: string;
+    webhookSecret: string;
+  };
+  s3: {
+    accessKeyId: string;
+    acl?: string;
+    bucket: string;
+    endpoint?: string;
+    region: string;
+    secretAccessKey: string;
+  };
+}
+interface S3StoreConfig {
+  cache?: KvStore<TusUploadMetadata>;
+  expirationPeriodInMilliseconds?: number;
+  maxConcurrentPartUploads?: number;
+  /**
+   * The maximum number of parts allowed in a multipart upload. Defaults to 10,000.
+   */
+  maxMultipartParts?: number;
+  /**
+   * The minimal part size for parts.
+   * Can be used to ensure that all non-trailing parts are exactly the same size.
+   * Can not be lower than 5MiB or more than 5GiB.
+   */
+  minPartSize?: number;
+  /**
+   * The preferred part size for parts send to S3. Can not be lower than 5MiB or more than 5GiB.
+   * The server calculates the optimal part size, which takes this size into account,
+   * but may increase it to not exceed the S3 10K parts limit.
+   */
+  partSize?: number;
+  s3ClientConfig: {
+    acl?: ObjectCannedACL;
+    bucket: string;
+  } & S3ClientConfig;
+  useTags?: boolean;
+}
+interface TusUploadMetadata {
+  file: Upload;
+  'tus-version': string;
+  'upload-id': string;
+}
+interface IncompletePartInfo {
+  createReader: (options: {
+    cleanUpOnEnd: boolean;
+  }) => fs.ReadStream;
+  path: string;
+  size: number;
+}
+interface AWSError extends Error {
+  Code?: string;
+  code?: string;
+}
+interface NodeFSError extends Error {
+  code?: string;
+}
+type StaticRenditions = Record<string, unknown> | null | undefined;
+//#endregion
+export { AWSError, IncompletePartInfo, MediaCloudPluginOptions, NodeFSError, S3StoreConfig, StaticRenditions, TusUploadMetadata };
+//# sourceMappingURL=index.d.ts.map

package/dist/utils/file.d.ts

@@ -0,0 +1,30 @@
+//#region src/utils/file.d.ts
+/**
+ * Checks if a file is a video file supported by Mux
+ * @param file - The file to check
+ * @returns Promise that resolves to true if the file is a supported video format, false otherwise
+ */
+declare function isVideo(file: File): Promise<boolean>;
+/**
+ * Gets the MIME type of a file using file-type library
+ * @param file - The file to check
+ * @returns Promise that resolves to the MIME type of the file or undefined if it cannot be determined
+ */
+declare function getFileType(file: File): Promise<string | undefined>;
+/**
+ * Generates a unique filename by appending a random suffix if needed
+ * @param originalFilename - The original filename
+ * @returns A unique filename with a random suffix appended before the extension
+ */
+declare function generateUniqueFilename(originalFilename: string): string;
+/**
+ * Sanitizes a filename by removing/replacing invalid characters and handling edge cases
+ * Converts all non-alphanumeric characters (except dots for extensions) to underscores
+ * @param filename - The filename to sanitize
+ * @returns A sanitized filename safe for all operating systems
+ * @throws {TypeError} When filename is not a string
+ */
+declare function sanitizeFilename(filename: string): string;
+//#endregion
+export { generateUniqueFilename, getFileType, isVideo, sanitizeFilename };
+//# sourceMappingURL=file.d.ts.map

package/dist/utils/file.js

@@ -0,0 +1,84 @@
+import { MediaCloudError } from "../types/errors.js";
+import { useErrorHandler } from "../hooks/useErrorHandler.js";
+import { fileTypeFromBuffer } from "file-type";
+import { parse } from "pathe";
+
+//#region src/utils/file.ts
+const { logError } = useErrorHandler();
+const MUX_SUPPORTED_VIDEO_FORMATS = new Set([
+	"application/mxf",
+	"video/3gpp",
+	"video/3gpp2",
+	"video/mp2t",
+	"video/mp4",
+	"video/mpeg",
+	"video/quicktime",
+	"video/webm",
+	"video/x-f4v",
+	"video/x-flv",
+	"video/x-matroska",
+	"video/x-ms-asf",
+	"video/x-ms-wmv",
+	"video/x-msvideo",
+	"video/x-mxf"
+]);
+/**
+* Checks if a file is a video file supported by Mux
+* @param file - The file to check
+* @returns Promise that resolves to true if the file is a supported video format, false otherwise
+*/
+async function isVideo(file) {
+	try {
+		const buffer = new Uint8Array(await file.arrayBuffer());
+		const fileType = await fileTypeFromBuffer(buffer);
+		return fileType?.mime ? MUX_SUPPORTED_VIDEO_FORMATS.has(fileType.mime) : false;
+	} catch {
+		return false;
+	}
+}
+/**
+* Gets the MIME type of a file using file-type library
+* @param file - The file to check
+* @returns Promise that resolves to the MIME type of the file or undefined if it cannot be determined
+*/
+async function getFileType(file) {
+	try {
+		const buffer = new Uint8Array(await file.arrayBuffer());
+		const fileType = await fileTypeFromBuffer(buffer);
+		return fileType?.mime;
+	} catch (_error) {
+		logError(MediaCloudError.FILE_TYPE_ERROR);
+		return void 0;
+	}
+}
+/**
+* Generates a unique filename by appending a random suffix if needed
+* @param originalFilename - The original filename
+* @returns A unique filename with a random suffix appended before the extension
+*/
+function generateUniqueFilename(originalFilename) {
+	const timestamp = Date.now().toString(36);
+	const { name, ext } = parse(originalFilename);
+	return `${name}-${timestamp}${ext}`;
+}
+/**
+* Sanitizes a filename by removing/replacing invalid characters and handling edge cases
+* Converts all non-alphanumeric characters (except dots for extensions) to underscores
+* @param filename - The filename to sanitize
+* @returns A sanitized filename safe for all operating systems
+* @throws {TypeError} When filename is not a string
+*/
+function sanitizeFilename(filename) {
+	try {
+		const parsed = parse(filename);
+		const sanitized = parsed.name.replace(/[^a-zA-Z0-9_.-]/g, "_").replace(/_{2,}/g, "_").replace(/^_|_$/g, "");
+		return `${sanitized}${parsed.ext}`;
+	} catch (_error) {
+		logError(MediaCloudError.FILENAME_SANITIZE_ERROR);
+		return filename;
+	}
+}
+
+//#endregion
+export { generateUniqueFilename, getFileType, isVideo, sanitizeFilename };
+//# sourceMappingURL=file.js.map

package/dist/utils/file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file.js","names":["file: File","originalFilename: string","filename: string"],"sources":["../../src/utils/file.ts"],"sourcesContent":["import { fileTypeFromBuffer } from 'file-type'\nimport { parse } from 'pathe'\n\nimport { useErrorHandler } from '../hooks/useErrorHandler'\nimport { MediaCloudError } from '../types/errors'\n\nconst { logError } = useErrorHandler()\n\nconst MUX_SUPPORTED_VIDEO_FORMATS = new Set([\n  'application/mxf',\n  'video/3gpp',\n  'video/3gpp2',\n  'video/mp2t',\n  'video/mp4',\n  'video/mpeg',\n  'video/quicktime',\n  'video/webm',\n  'video/x-f4v',\n  'video/x-flv',\n  'video/x-matroska',\n  'video/x-ms-asf',\n  'video/x-ms-wmv',\n  'video/x-msvideo',\n  'video/x-mxf',\n])\n\n/**\n * Checks if a file is a video file supported by Mux\n * @param file - The file to check\n * @returns Promise that resolves to true if the file is a supported video format, false otherwise\n */\nexport async function isVideo(file: File): Promise<boolean> {\n  try {\n    const buffer = new Uint8Array(await file.arrayBuffer())\n    const fileType = await fileTypeFromBuffer(buffer)\n\n    return fileType?.mime\n      ? MUX_SUPPORTED_VIDEO_FORMATS.has(fileType.mime)\n      : false\n  } catch {\n    return false\n  }\n}\n\n/**\n * Gets the MIME type of a file using file-type library\n * @param file - The file to check\n * @returns Promise that resolves to the MIME type of the file or undefined if it cannot be determined\n */\nexport async function getFileType(file: File): Promise<string | undefined> {\n  try {\n    const buffer = new Uint8Array(await file.arrayBuffer())\n    const fileType = await fileTypeFromBuffer(buffer)\n    return fileType?.mime\n  } catch (_error) {\n    logError(MediaCloudError.FILE_TYPE_ERROR)\n    return undefined\n  }\n}\n\n/**\n * Generates a unique filename by appending a random suffix if needed\n * @param originalFilename - The original filename\n * @returns A unique filename with a random suffix appended before the extension\n */\nexport function generateUniqueFilename(originalFilename: string): string {\n  const timestamp = Date.now().toString(36)\n  const { name, ext } = parse(originalFilename)\n  return `${name}-${timestamp}${ext}`\n}\n\n/**\n * Sanitizes a filename by removing/replacing invalid characters and handling edge cases\n * Converts all non-alphanumeric characters (except dots for extensions) to underscores\n * @param filename - The filename to sanitize\n * @returns A sanitized filename safe for all operating systems\n * @throws {TypeError} When filename is not a string\n */\nexport function sanitizeFilename(filename: string): string {\n  try {\n    const parsed = parse(filename)\n    const sanitized = parsed.name\n      .replace(/[^a-zA-Z0-9_.-]/g, '_')\n      .replace(/_{2,}/g, '_')\n      .replace(/^_|_$/g, '')\n    return `${sanitized}${parsed.ext}`\n  } catch (_error) {\n    logError(MediaCloudError.FILENAME_SANITIZE_ERROR)\n    return filename\n  }\n}\n"],"mappings":";;;;;;AAMA,MAAM,EAAE,UAAU,GAAG,iBAAiB;AAEtC,MAAM,8BAA8B,IAAI,IAAI;CAC1C;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACD;;;;;;AAOD,eAAsB,QAAQA,MAA8B;AAC1D,KAAI;EACF,MAAM,SAAS,IAAI,WAAW,MAAM,KAAK,aAAa;EACtD,MAAM,WAAW,MAAM,mBAAmB,OAAO;AAEjD,SAAO,UAAU,OACb,4BAA4B,IAAI,SAAS,KAAK,GAC9C;CACL,QAAO;AACN,SAAO;CACR;AACF;;;;;;AAOD,eAAsB,YAAYA,MAAyC;AACzE,KAAI;EACF,MAAM,SAAS,IAAI,WAAW,MAAM,KAAK,aAAa;EACtD,MAAM,WAAW,MAAM,mBAAmB,OAAO;AACjD,SAAO,UAAU;CAClB,SAAQ,QAAQ;EACf,SAAS,gBAAgB,gBAAgB;AACzC,SAAO;CACR;AACF;;;;;;AAOD,SAAgB,uBAAuBC,kBAAkC;CACvE,MAAM,YAAY,KAAK,KAAK,CAAC,SAAS,GAAG;CACzC,MAAM,EAAE,MAAM,KAAK,GAAG,MAAM,iBAAiB;AAC7C,QAAO,GAAG,KAAK,CAAC,EAAE,YAAY,KAAK;AACpC;;;;;;;;AASD,SAAgB,iBAAiBC,UAA0B;AACzD,KAAI;EACF,MAAM,SAAS,MAAM,SAAS;EAC9B,MAAM,YAAY,OAAO,KACtB,QAAQ,oBAAoB,IAAI,CAChC,QAAQ,UAAU,IAAI,CACtB,QAAQ,UAAU,GAAG;AACxB,SAAO,GAAG,YAAY,OAAO,KAAK;CACnC,SAAQ,QAAQ;EACf,SAAS,gBAAgB,wBAAwB;AACjD,SAAO;CACR;AACF"}

package/package.json

@@ -0,0 +1,92 @@
+{
+  "name": "@maas/payload-plugin-media-cloud",
+  "version": "0.0.0",
+  "type": "module",
+  "contributors": [
+    {
+      "name": "Robin Scholz",
+      "url": "https://github.com/robinscholz"
+    },
+    {
+      "name": "Christoph Jeworutzki",
+      "url": "https://github.com/ChristophJeworutzki"
+    }
+  ],
+  "keywords": [],
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./components": {
+      "types": "./dist/components/index.d.ts",
+      "import": "./dist/components/index.js"
+    }
+  },
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "lint": "eslint .",
+    "format": "prettier --write .",
+    "prepack": "pnpm resolve-catalog",
+    "postpack": "pnpm restore-catalog",
+    "resolve-catalog": "pnpx tsx ../../scripts/resolve-catalog.ts",
+    "restore-catalog": "pnpx tsx ../../scripts/restore-catalog.ts",
+    "release": "release-it"
+  },
+  "dependencies": {
+    "@aws-sdk/client-s3": "^3.859.0",
+    "@maas/error-handler": "workspace:*",
+    "@mux/mux-node": "^12.3.0",
+    "@mux/upchunk": "^3.5.0",
+    "@tus/server": "^2.3.0",
+    "@tus/utils": "^0.6.0",
+    "file-type": "^21.0.0",
+    "mitt": "^3.0.1",
+    "multistream": "^4.1.0",
+    "pathe": "^2.0.3",
+    "tus-js-client": "^4.3.1"
+  },
+  "peerDependencies": {
+    "@mux/mux-player-react": "^3",
+    "@payloadcms/plugin-cloud-storage": "^3.49",
+    "@payloadcms/ui": "^3.49",
+    "payload": "^3.49",
+    "react": "^19.1",
+    "react-dom": "^19.1"
+  },
+  "peerDependenciesMeta": {
+    "@mux/mux-player-react": {
+      "optional": false
+    },
+    "@payloadcms/plugin-cloud-storage": {
+      "optional": false
+    },
+    "@payloadcms/ui": {
+      "optional": false
+    },
+    "payload": {
+      "optional": false
+    },
+    "react": {
+      "optional": false
+    },
+    "react-dom": {
+      "optional": false
+    }
+  },
+  "devDependencies": {
+    "@types/multistream": "^4.1.3",
+    "@types/node": "^22.17.0",
+    "@types/react": "^19.1.7",
+    "glob": "^11.0.3",
+    "tsdown": "^0.13.1",
+    "typescript": "5.8.3"
+  }
+}