storage

Documentation

Overview

Package storage contains implementation to handle blob storage

Index

• type Document
  • func GetDocumentData(base64 string) (*Document, error)
• type PolicyType
• type StorageClient
• type StorageDownloadItem
• type StorageItem

Types

type Document

type Document struct {
	// MimeType is the type of the document, application/zip, text/plain, application/pdf, image/png
	MimeType string

	// FileExtension is the document's file extension
	FileExtension string

	// Data is the data contained in the document
	Data []byte
}

Document structure represents a document representation

func GetDocumentData

func GetDocumentData(base64 string) (*Document, error)

GetDocumentData parses a base64 string into a document

type PolicyType

type PolicyType string

PolicyType is the type of policy to apply to a storage item

const (
	// PolicyTypeReadOnly is the read only policy type that allows only reading the storage item
	PolicyTypeReadOnly PolicyType = "READ_ONLY"

	// PolicyTypeWriteOnly is the write only policy type that allows writing to the storage item
	PolicyTypeWriteOnly PolicyType = "WRITE_ONLY"

	// PolicyTypeReadAndWrite is the read and write policy type that allows reading and writing to the storage item
	PolicyTypeReadAndWrite PolicyType = "READ_AND_WRITE"
)

type StorageClient

type StorageClient interface {
	// Upload uploads a new storage item and returns the URL to the stored item
	Upload(context.Context, StorageItem) (string, error)

	// CreateBucket creates a bucket
	CreateBucket(context.Context, string) error

	// BucketExists checks if a bucket exists
	BucketExists(ctx context.Context, bucketName string) (bool, error)
}

StorageClient defines all the capabilities of the storage client used to handle storage & retrieval of blob data

type StorageDownloadItem

type StorageDownloadItem struct {
	// Name is the name of the document
	Name string

	// Content is the content of the storage item which is a slice of bytes. The call site can use this to write to a file
	Content []byte

	// ContentType is the type of content of this item
	ContentType string

	// Bucket is where to store the document
	Bucket string

	// Metadata is optional additional key value pair data
	Metadata map[any]any

	// LastModified is the last time this item was updated/modified
	LastModified *time.Time
}

type StorageItem

type StorageItem struct {
	// Name is the name of the document
	Name string

	// Content is the content of the storage item which is a base64 string
	Content string

	// ContentType is the type of content of this item
	ContentType string

	// Bucket is where to store the document
	Bucket string

	// Metadata is optional additional key value pair data
	Metadata map[string]string

	// PolicyType for a storage item
	PolicyType PolicyType
}

StorageItem is the item that will be stored in blob storage