kawa
4c614fc06c
- BackendType union: 'azureblob' | 's3' | 's3-compatible' - FieldDef interface with key (snake_case rclone key), label, inputType, required, and optional fields - BACKEND_REGISTRY: azureblob (3 fields), s3 (4 fields), s3-compatible (5 fields) - All FieldDef.key values match rclone INI config key names exactly - registry.test.ts: 7 tests all passing (GREEN)
113 lines
3.1 KiB
TypeScript
113 lines
3.1 KiB
TypeScript
// src/schemas/registry.ts
|
|
// Backend Schema Registry — single source of truth for all rclone backend field definitions.
|
|
// IMPORTANT: FieldDef.key values MUST match rclone config key names exactly.
|
|
// These keys are used by Phase 2 generators to build rclone.conf INI content.
|
|
// Verify against https://rclone.org/azureblob/ and https://rclone.org/s3/ before Phase 2.
|
|
|
|
export type BackendType = 'azureblob' | 's3' | 's3-compatible';
|
|
|
|
export interface FieldDef {
|
|
key: string; // MUST match rclone config key exactly (snake_case)
|
|
label: string;
|
|
inputType: 'text' | 'password' | 'select' | 'toggle';
|
|
required: boolean;
|
|
placeholder?: string;
|
|
helpText?: string;
|
|
options?: { value: string; label: string }[]; // for inputType: 'select'
|
|
}
|
|
|
|
export const BACKEND_REGISTRY: Record<BackendType, FieldDef[]> = {
|
|
azureblob: [
|
|
{
|
|
key: 'account',
|
|
label: 'Storage Account Name',
|
|
inputType: 'text',
|
|
required: true,
|
|
placeholder: 'mystorageaccount',
|
|
helpText: 'The storage account name (not the full URL)',
|
|
},
|
|
{
|
|
key: 'key',
|
|
label: 'Access Key',
|
|
inputType: 'password',
|
|
required: false,
|
|
helpText: 'Base64-encoded storage account key. Provide either this or a SAS URL, not both.',
|
|
},
|
|
{
|
|
key: 'sas_url',
|
|
label: 'SAS URL',
|
|
inputType: 'password',
|
|
required: false,
|
|
placeholder: 'https://mystorageaccount.blob.core.windows.net/?sv=...',
|
|
helpText: 'Full SAS URL including account and container. Provide either this or an access key, not both.',
|
|
},
|
|
],
|
|
s3: [
|
|
{
|
|
key: 'provider',
|
|
label: 'Provider',
|
|
inputType: 'select',
|
|
required: true,
|
|
options: [{ value: 'AWS', label: 'Amazon S3' }],
|
|
},
|
|
{
|
|
key: 'access_key_id',
|
|
label: 'Access Key ID',
|
|
inputType: 'text',
|
|
required: true,
|
|
placeholder: 'AKIAIOSFODNN7EXAMPLE',
|
|
},
|
|
{
|
|
key: 'secret_access_key',
|
|
label: 'Secret Access Key',
|
|
inputType: 'password',
|
|
required: true,
|
|
},
|
|
{
|
|
key: 'region',
|
|
label: 'Region',
|
|
inputType: 'text',
|
|
required: true,
|
|
placeholder: 'us-east-1',
|
|
},
|
|
],
|
|
's3-compatible': [
|
|
{
|
|
key: 'provider',
|
|
label: 'Provider',
|
|
inputType: 'select',
|
|
required: true,
|
|
options: [{ value: 'Other', label: 'S3-Compatible' }],
|
|
helpText: 'Covers Wasabi, MinIO, Cloudflare R2, and any S3-compatible storage',
|
|
},
|
|
{
|
|
key: 'access_key_id',
|
|
label: 'Access Key ID',
|
|
inputType: 'text',
|
|
required: true,
|
|
},
|
|
{
|
|
key: 'secret_access_key',
|
|
label: 'Secret Access Key',
|
|
inputType: 'password',
|
|
required: true,
|
|
},
|
|
{
|
|
key: 'endpoint',
|
|
label: 'Endpoint URL',
|
|
inputType: 'text',
|
|
required: true,
|
|
placeholder: 'https://s3.wasabisys.com',
|
|
helpText: 'The S3-compatible endpoint URL for your storage provider',
|
|
},
|
|
{
|
|
key: 'region',
|
|
label: 'Region',
|
|
inputType: 'text',
|
|
required: false,
|
|
placeholder: 'us-east-1',
|
|
helpText: 'Optional for most S3-compatible providers',
|
|
},
|
|
],
|
|
};
|