3.31.6 โข Published 3 months ago
@shopnex/import-export-plugin v3.31.6
@shopnex/import-export-plugin
A flexible plugin for Payload CMS to enable Import/Export functionality on your collections.
โจ Features
- Add Import and Export controls to any collection
- Define custom column mappings for importing
- Override export collection behavior
- Toggle synchronous export (no job queue)
๐ง Installation
npm install @shopnex/import-export-plugin
๐ Basic Usage
Add the plugin to your Payload config:
import { importExportPlugin } from "@shopnex/import-export-plugin";
export default buildConfig({
plugins: [
importExportPlugin({
collections: ["products", "orders"],
importCollections: [
{ collectionSlug: "products" },
{ collectionSlug: "orders" },
],
disableJobsQueue: true,
}),
],
});
โ๏ธ Plugin Options
type ImportExportPluginConfig = {
collections?: string[];
importCollections?: {
collectionSlug: string;
columns?: ImportColumn[];
}[];
disableJobsQueue?: boolean;
overrideExportCollection?: (collection: CollectionOverride) => CollectionOverride;
};
collections
Specify which collections should have the Import/Export controls in the admin UI.
importCollections
Define which collections support data import, and optionally configure custom column mapping using the columns
field.
disableJobsQueue
When true
, export runs synchronously instead of using the background jobs queue. Useful for quick exports or environments without job workers.
overrideExportCollection
Hook to customize the exported data schema per collection.
๐ฆ ImportColumn Format
Use ImportColumn
to describe each column for import in a collection:
type ImportColumn = {
name: string; // Label shown to the user
key: string; // Field path in the collection
data_type?: "string" | "number" | "datetime" | "boolean";
required?: boolean;
description: string;
suggested_mappings: string[]; // Helpful auto-mapping hints
};
๐งช Example:
importExportPlugin({
importCollections: [
{
collectionSlug: "products",
columns: [
{
name: "Product Title",
key: "title",
data_type: "string",
required: true,
description: "The name of the product",
suggested_mappings: ["title", "name", "product_title"],
},
{
name: "Price",
key: "price",
data_type: "number",
description: "Product price in USD",
suggested_mappings: ["price", "cost"],
},
{
name: "Gallery Image URL",
key: "variants[0].gallery[0].url",
data_type: "string",
description: "URL of the main product image",
suggested_mappings: ["image", "image_url", "photo"],
},
],
},
],
});
๐ Requirements
- Payload CMS v2+
๐ License
MIT โ ยฉ 2025 ShopNex