Files
payload/test/setupProd.ts
Dan Ribbens 4f822a439b feat: plugin-import-export initial work (#10795)
Adds new plugin-import-export initial version.

Allows for direct download and creation of downloadable collection data
stored to a json or csv uses the access control of the user creating the
request to make the file.

config options:
```ts
  /**
   * Collections to include the Import/Export controls in
   * Defaults to all collections
   */
  collections?: string[]
  /**
   * Enable to force the export to run synchronously
   */
  disableJobsQueue?: boolean
  /**
   * This function takes the default export collection configured in the plugin and allows you to override it by modifying and returning it
   * @param collection
   * @returns collection
   */
  overrideExportCollection?: (collection: CollectionOverride) => CollectionOverride

// payload.config.ts:
plugins: [
    importExportPlugin({
      collections: ['pages', 'users'],
      overrideExportCollection: (collection) => {
        collection.admin.group = 'System'
        collection.upload.staticDir = path.resolve(dirname, 'uploads')
        return collection
      },
      disableJobsQueue: true,
    }),
 ],
```

---------

Co-authored-by: Jessica Chowdhury <jessica@trbl.design>
Co-authored-by: Kendell Joseph <kendelljoseph@gmail.com>
2025-03-05 01:06:43 +00:00

94 lines
4.1 KiB
TypeScript

import fs from 'fs'
import path from 'node:path'
import { fileURLToPath } from 'node:url'
const filename = fileURLToPath(import.meta.url)
const dirname = path.dirname(filename)
export const tgzToPkgNameMap = {
payload: 'payload-*',
'@payloadcms/db-mongodb': 'payloadcms-db-mongodb-*',
'@payloadcms/db-postgres': 'payloadcms-db-postgres-*',
'@payloadcms/db-vercel-postgres': 'payloadcms-db-vercel-postgres-*',
'@payloadcms/db-sqlite': 'payloadcms-db-sqlite-*',
'@payloadcms/drizzle': 'payloadcms-drizzle-*',
'@payloadcms/email-nodemailer': 'payloadcms-email-nodemailer-*',
'@payloadcms/email-resend': 'payloadcms-email-resend-*',
'@payloadcms/eslint-config': 'payloadcms-eslint-config-*',
'@payloadcms/eslint-plugin': 'payloadcms-eslint-plugin-*',
'@payloadcms/graphql': 'payloadcms-graphql-*',
'@payloadcms/live-preview': 'payloadcms-live-preview-*',
'@payloadcms/live-preview-react': 'payloadcms-live-preview-react-*',
'@payloadcms/next': 'payloadcms-next-*',
'@payloadcms/payload-cloud': 'payloadcms-payload-cloud-*',
'@payloadcms/plugin-cloud-storage': 'payloadcms-plugin-cloud-storage-*',
'@payloadcms/plugin-form-builder': 'payloadcms-plugin-form-builder-*',
'@payloadcms/plugin-import-export': 'payloadcms-plugin-import-export-*',
'@payloadcms/plugin-multi-tenant': 'payloadcms-plugin-multi-tenant-*',
'@payloadcms/plugin-nested-docs': 'payloadcms-plugin-nested-docs-*',
'@payloadcms/plugin-redirects': 'payloadcms-plugin-redirects-*',
'@payloadcms/plugin-search': 'payloadcms-plugin-search-*',
'@payloadcms/plugin-sentry': 'payloadcms-plugin-sentry-*',
'@payloadcms/plugin-seo': 'payloadcms-plugin-seo-*',
'@payloadcms/plugin-stripe': 'payloadcms-plugin-stripe-*',
'@payloadcms/richtext-lexical': 'payloadcms-richtext-lexical-*',
'@payloadcms/richtext-slate': 'payloadcms-richtext-slate-*',
'@payloadcms/storage-azure': 'payloadcms-storage-azure-*',
'@payloadcms/storage-gcs': 'payloadcms-storage-gcs-*',
'@payloadcms/storage-s3': 'payloadcms-storage-s3-*',
'@payloadcms/storage-uploadthing': 'payloadcms-storage-uploadthing-*',
'@payloadcms/storage-vercel-blob': 'payloadcms-storage-vercel-blob-*',
'@payloadcms/translations': 'payloadcms-translations-*',
'@payloadcms/ui': 'payloadcms-ui-*',
'create-payload-app': 'create-payload-app-*',
}
function findActualTgzName(pattern: string) {
const packedDir = path.resolve(dirname, 'packed')
const files = fs.readdirSync(packedDir)
const matchingFile = files.find((file) => file.startsWith(pattern.replace('*', '')))
return matchingFile ? `file:packed/${matchingFile}` : null
}
/**
* This does the following:
* - installs all packages from test/packed to test/package.json
*/
export function setupProd() {
const packageJsonString = fs.readFileSync(path.resolve(dirname, 'package.json'), 'utf8')
const packageJson = JSON.parse(packageJsonString)
const allDependencies = {}
// Go through all the dependencies and devDependencies, replace the normal package entry with the tgz entry
for (const key of ['dependencies', 'devDependencies']) {
const dependencies = packageJson[key]
if (dependencies) {
for (const [packageName, _packageVersion] of Object.entries(dependencies)) {
if (tgzToPkgNameMap[packageName]) {
const actualTgzPath = findActualTgzName(tgzToPkgNameMap[packageName])
if (actualTgzPath) {
dependencies[packageName] = actualTgzPath
allDependencies[packageName] = actualTgzPath
} else {
console.warn(`Warning: No matching tgz found for ${packageName}`)
}
}
}
}
}
// now add them all to overrides and pnpm.overrides as well
packageJson.pnpm = packageJson.pnpm || {}
packageJson.pnpm.overrides = packageJson.pnpm.overrides || {}
packageJson.overrides = packageJson.overrides || {}
for (const [packageName, packageVersion] of Object.entries(allDependencies)) {
packageJson.pnpm.overrides[packageName] = packageVersion
packageJson.overrides[packageName] = packageVersion
}
// write it out
fs.writeFileSync(path.resolve(dirname, 'package.json'), JSON.stringify(packageJson, null, 2))
}
setupProd()