Files

Sasha 810c29b189 fix!: improve collection / global slugs type-safety in various places (#8311 )

**BREAKING:**
Improves type-safety of collection / global slugs by using `CollectionSlug` / `UploadCollectionSlug` and `GlobalSlug` types instead of `string` in these places:
Adds `UploadCollectionSlug` and `TypedUploadCollection` utility types

This also changes how we suggest to add an upload collection to a cloud-storage adapter:
Before:
```ts
azureStorage({
  collections: {
    [Media.slug]: true,
  },
}) 
``` 

After:
```ts
azureStorage({
  collections: {
    media: true,
  },
}) 
```

2024-11-15 19:33:26 +00:00

2.2 KiB

Raw Blame History

Azure Blob Storage for Payload

This package provides a simple way to use Azure Blob Storage with Payload.

NOTE: This package removes the need to use @payloadcms/plugin-cloud-storage as was needed in Payload 2.x.

Installation

pnpm add @payloadcms/storage-azure

Usage

Configure the collections object to specify which collections should use the Azure Blob Storage adapter. The slug must match one of your existing collection slugs.
When enabled, this package will automatically set disableLocalStorage to true for each collection.

import { azureStorage } from '@payloadcms/storage-azure'
import { Media } from './collections/Media'
import { MediaWithPrefix } from './collections/MediaWithPrefix'

export default buildConfig({
  collections: [Media, MediaWithPrefix],
  plugins: [
    azureStorage({
      collections: {
        media: true,
        'media-with-prefix': {
          prefix,
        },
      },
      allowContainerCreate: process.env.AZURE_STORAGE_ALLOW_CONTAINER_CREATE === 'true',
      baseURL: process.env.AZURE_STORAGE_ACCOUNT_BASEURL,
      connectionString: process.env.AZURE_STORAGE_CONNECTION_STRING,
      containerName: process.env.AZURE_STORAGE_CONTAINER_NAME,
    }),
  ],
})

Configuration Options

Option	Description	Default
`enabled`	Whether or not to enable the plugin	`true`
`collections`	Collections to apply the Azure Blob adapter to
`allowContainerCreate`	Whether or not to allow the container to be created if it does not exist	`false`
`baseURL`	Base URL for the Azure Blob storage account
`connectionString`	Azure Blob storage connection string
`containerName`	Azure Blob storage container name

2.2 KiB Raw Blame History

Azure Blob Storage for Payload

Installation

Usage

Configuration Options

2.2 KiB

Raw Blame History