@x47base/pocketbase-addon 0.1.0

package/localization/catalogue.json

@@ -0,0 +1,483 @@
+{
+  "validation_backup_format": [
+    "Invalid encrypted backup format"
+  ],
+  "validation_backup_name_exists": [
+    "Backup file with the specified name already exists.",
+    "The backup file name is invalid or already exists."
+  ],
+  "validation_collection_name_exists": [
+    "Collection name must be unique (case insensitive)."
+  ],
+  "validation_collection_name_id_duplicate": [
+    "The name must not match an existing collection id."
+  ],
+  "validation_collection_name_invalid": [
+    "The name shouldn't match with an existing internal table."
+  ],
+  "validation_collection_system_flag_change": [
+    "System collection state cannot be changed."
+  ],
+  "validation_collection_system_name_change": [
+    "System collection name cannot be changed."
+  ],
+  "validation_collection_system_rule_change": [
+    "System collection API rule cannot be changed."
+  ],
+  "validation_collection_type_change": [
+    "Collection type cannot be changed."
+  ],
+  "validation_collections_import_failure": [
+    "Failed to import the collections configuration. Raw error:\n"
+  ],
+  "validation_color": [
+    "Must be a hex color (#RGB, #RGBA, #RRGGBB or #RRGGBBAA)"
+  ],
+  "validation_conflicting_rate_limit_rule": [
+    "Rate limit rule configuration with label {{.label}} already exists or conflicts with another rule."
+  ],
+  "validation_content_size_limit": [
+    "The maximum allowed content size is {{.maxSize}} bytes"
+  ],
+  "validation_date_invalid": [
+    "must be a valid date"
+  ],
+  "validation_date_only": [
+    "Must be a calendar date in YYYY-MM-DD format"
+  ],
+  "validation_date_out_of_range": [
+    "the date is out of range"
+  ],
+  "validation_duplicated_field_name": [
+    "Duplicated or invalid field name {{.fieldName}}"
+  ],
+  "validation_duplicated_index_definition": [
+    "The index definition already exists."
+  ],
+  "validation_duplicated_index_name": [
+    "The index name already exists."
+  ],
+  "validation_duplicated_provider": [
+    "The provider {{.name}} is already registered."
+  ],
+  "validation_email_domain_not_allowed": [
+    "Email domain is not allowed"
+  ],
+  "validation_empty": [
+    "must be blank"
+  ],
+  "validation_existing_index_name": [
+    "The index name is already used in {{.usedTableName}} collection."
+  ],
+  "validation_field_relation_change": [
+    "The relation collection cannot be changed."
+  ],
+  "validation_field_relation_missing_collection": [
+    "The relation collection doesn't exist."
+  ],
+  "validation_field_type_change": [
+    "Field type cannot be changed."
+  ],
+  "validation_file_size_limit": [
+    "Failed to upload {{.file}} - the maximum allowed file size is {{.maxSize}} bytes."
+  ],
+  "validation_forbidden_pk_character": [
+    "'{{.ch}}' is not a valid primary key character."
+  ],
+  "validation_in_invalid": [
+    "must be a valid value"
+  ],
+  "validation_indexes_not_supported": [
+    "View collections don't support indexes."
+  ],
+  "validation_invalid_auth_id": [
+    "Invalid or duplicated auth record id."
+  ],
+  "validation_invalid_collection": [
+    "Missing or invalid collection."
+  ],
+  "validation_invalid_collection_id": [
+    "Missing or invalid collection."
+  ],
+  "validation_invalid_field_value": [
+    "Invalid field value."
+  ],
+  "validation_invalid_file": [
+    "Invalid new files: {{.invalidFiles}}."
+  ],
+  "validation_invalid_format": [
+    "Invalid value format",
+    "Invalid value format."
+  ],
+  "validation_invalid_index_expression": [
+    "Invalid CREATE INDEX expression."
+  ],
+  "validation_invalid_json": [
+    "Must be a valid json value"
+  ],
+  "validation_invalid_latitude": [
+    "Latitude must be between -90 and 90 degrees."
+  ],
+  "validation_invalid_longitude": [
+    "Longitude must be between -180 and 180 degrees."
+  ],
+  "validation_invalid_new_email": [
+    "Invalid new email address."
+  ],
+  "validation_invalid_or_existing_id": [
+    "The model id is invalid or already exists."
+  ],
+  "validation_invalid_password": [
+    "Missing or invalid auth record password."
+  ],
+  "validation_invalid_provider": [
+    "Provider with name {{.name}} is missing or is not enabled."
+  ],
+  "validation_invalid_record": [
+    "Missing or invalid record."
+  ],
+  "validation_invalid_rule": [
+    "Invalid rule. Raw error: "
+  ],
+  "validation_invalid_token": [
+    "Invalid or expired token."
+  ],
+  "validation_invalid_token_claims": [
+    "Missing email token claim."
+  ],
+  "validation_invalid_token_email": [
+    "The new email address is invalid."
+  ],
+  "validation_invalid_token_payload": [
+    "Invalid token payload - newEmail must be set."
+  ],
+  "validation_invalid_unique_system_field_index": [
+    "Unique index definition on system fields ({{.fieldName}}) is invalid or missing."
+  ],
+  "validation_invalid_url": [
+    "Must be a valid url"
+  ],
+  "validation_invalid_value": [
+    "Invalid value {{.value}}"
+  ],
+  "validation_invalid_view_query": [
+    "Invalid query - "
+  ],
+  "validation_invlaid_ip_or_subnet": [
+    "invalid IP or CIDR subnet"
+  ],
+  "validation_is utf_letter_numeric": [
+    "must contain unicode letters and numbers only"
+  ],
+  "validation_is_alpha": [
+    "must contain English letters only"
+  ],
+  "validation_is_alphanumeric": [
+    "must contain English letters and digits only"
+  ],
+  "validation_is_ascii": [
+    "must contain ASCII characters only"
+  ],
+  "validation_is_base64": [
+    "must be encoded in Base64"
+  ],
+  "validation_is_country_code_2_letter": [
+    "must be a valid two-letter country code"
+  ],
+  "validation_is_country_code_3_letter": [
+    "must be a valid three-letter country code"
+  ],
+  "validation_is_credit_card": [
+    "must be a valid credit card number"
+  ],
+  "validation_is_currency_code": [
+    "must be valid ISO 4217 currency code"
+  ],
+  "validation_is_data_uri": [
+    "must be a Base64-encoded data URI"
+  ],
+  "validation_is_dial_string": [
+    "must be a valid dial string"
+  ],
+  "validation_is_digit": [
+    "must contain digits only"
+  ],
+  "validation_is_dns_name": [
+    "must be a valid DNS name"
+  ],
+  "validation_is_domain": [
+    "must be a valid domain"
+  ],
+  "validation_is_e164_number": [
+    "must be a valid E164 number"
+  ],
+  "validation_is_email": [
+    "must be a valid email address"
+  ],
+  "validation_is_float": [
+    "must be a floating point number"
+  ],
+  "validation_is_full_width": [
+    "must contain full-width characters"
+  ],
+  "validation_is_half_width": [
+    "must contain half-width characters"
+  ],
+  "validation_is_hex_color": [
+    "must be a valid hexadecimal color code"
+  ],
+  "validation_is_hexadecimal": [
+    "must be a valid hexadecimal number"
+  ],
+  "validation_is_host": [
+    "must be a valid IP address or DNS name"
+  ],
+  "validation_is_int": [
+    "must be an integer number"
+  ],
+  "validation_is_ip": [
+    "must be a valid IP address"
+  ],
+  "validation_is_ipv4": [
+    "must be a valid IPv4 address"
+  ],
+  "validation_is_ipv6": [
+    "must be a valid IPv6 address"
+  ],
+  "validation_is_isbn": [
+    "must be a valid ISBN"
+  ],
+  "validation_is_isbn_10": [
+    "must be a valid ISBN-10"
+  ],
+  "validation_is_isbn_13": [
+    "must be a valid ISBN-13"
+  ],
+  "validation_is_json": [
+    "must be in valid JSON format"
+  ],
+  "validation_is_latitude": [
+    "must be a valid latitude"
+  ],
+  "validation_is_longitude": [
+    "must be a valid longitude"
+  ],
+  "validation_is_lower_case": [
+    "must be in lower case"
+  ],
+  "validation_is_mac_address": [
+    "must be a valid MAC address"
+  ],
+  "validation_is_mongo_id": [
+    "must be a valid hex-encoded MongoDB ObjectId"
+  ],
+  "validation_is_multibyte": [
+    "must contain multibyte characters"
+  ],
+  "validation_is_port": [
+    "must be a valid port number"
+  ],
+  "validation_is_printable_ascii": [
+    "must contain printable ASCII characters only"
+  ],
+  "validation_is_request_url": [
+    "must be a valid request URL"
+  ],
+  "validation_is_rgb_color": [
+    "must be a valid RGB color code"
+  ],
+  "validation_is_semver": [
+    "must be a valid semantic version"
+  ],
+  "validation_is_ssn": [
+    "must be a valid social security number"
+  ],
+  "validation_is_sub_domain": [
+    "must be a valid subdomain"
+  ],
+  "validation_is_upper_case": [
+    "must be in upper case"
+  ],
+  "validation_is_url": [
+    "must be a valid URL"
+  ],
+  "validation_is_utf_digit": [
+    "must contain unicode decimal digits only"
+  ],
+  "validation_is_utf_letter": [
+    "must contain unicode letter characters only"
+  ],
+  "validation_is_utf_numeric": [
+    "must contain unicode number characters only"
+  ],
+  "validation_is_uuid": [
+    "must be a valid UUID"
+  ],
+  "validation_is_uuid_v3": [
+    "must be a valid UUID v3"
+  ],
+  "validation_is_uuid_v4": [
+    "must be a valid UUID v4"
+  ],
+  "validation_is_uuid_v5": [
+    "must be a valid UUID v5"
+  ],
+  "validation_is_variable_width": [
+    "must contain both full-width and half-width characters"
+  ],
+  "validation_json_schema": [
+    "Invalid field schema",
+    "Invalid or excessively nested JSON value",
+    "Value does not match the field JSON schema"
+  ],
+  "validation_json_size_limit": [
+    "The maximum allowed JSON size is {{.maxSize}} bytes"
+  ],
+  "validation_key_missing": [
+    "required key is missing"
+  ],
+  "validation_key_unexpected": [
+    "key not expected"
+  ],
+  "validation_key_wrong_type": [
+    "key not the correct type"
+  ],
+  "validation_length_empty_required": [
+    "the value must be empty"
+  ],
+  "validation_length_invalid": [
+    "the length must be exactly {{.min}}"
+  ],
+  "validation_length_out_of_range": [
+    "the length must be between {{.min}} and {{.max}}"
+  ],
+  "validation_length_too_long": [
+    "the length must be no more than {{.max}}"
+  ],
+  "validation_length_too_short": [
+    "the length must be no less than {{.min}}"
+  ],
+  "validation_match_invalid": [
+    "must be in a valid format"
+  ],
+  "validation_max_less_equal_than_required": [
+    "must be no greater than {{.threshold}}"
+  ],
+  "validation_max_less_than_required": [
+    "must be less than {{.threshold}}"
+  ],
+  "validation_max_number_constraint": [
+    "Must be less or equal than {{.max}}"
+  ],
+  "validation_max_text_constraint": [
+    "Must be no more than {{.max}} character(s)."
+  ],
+  "validation_mfa_not_enough_auths": [
+    "MFA requires at least 2 auth methods to be enabled."
+  ],
+  "validation_min_greater_equal_than_required": [
+    "must be no less than {{.threshold}}"
+  ],
+  "validation_min_greater_than_required": [
+    "must be greater than {{.threshold}}"
+  ],
+  "validation_min_number_constraint": [
+    "Must be greater or equal than {{.min}}"
+  ],
+  "validation_min_text_constraint": [
+    "Must be at least {{.min}} character(s)."
+  ],
+  "validation_missing_field": [
+    "Invalid or missing field {{.fieldName}}"
+  ],
+  "validation_missing_provider": [
+    "Invalid or missing provider with name {{.name}}."
+  ],
+  "validation_missing_rel_collection": [
+    "Relation connection is missing or cannot be accessed"
+  ],
+  "validation_missing_rel_records": [
+    "Failed to find all relation records with the provided ids"
+  ],
+  "validation_missing_unique_constraint": [
+    "The field {{.fieldName}} doesn't have a UNIQUE constraint."
+  ],
+  "validation_multiple_of_invalid": [
+    "must be multiple of {{.base}}"
+  ],
+  "validation_nil": [
+    "must be blank"
+  ],
+  "validation_nil_or_not_empty_required": [
+    "cannot be blank"
+  ],
+  "validation_not_a_number": [
+    "The submitted number is not properly formatted"
+  ],
+  "validation_not_enough_values": [
+    "Select at least {{.minSelect}}"
+  ],
+  "validation_not_in_invalid": [
+    "must not be in list"
+  ],
+  "validation_not_nil_required": [
+    "is required"
+  ],
+  "validation_not_unique": [
+    "Value must be unique"
+  ],
+  "validation_only_int_constraint": [
+    "Decimal numbers are not allowed"
+  ],
+  "validation_pk_change": [
+    "The record primary key cannot be changed."
+  ],
+  "validation_pk_invalid": [
+    "The record primary key is invalid or already exists."
+  ],
+  "validation_relation_field_non_view_base_collection": [
+    "Only view collections are allowed to have relations to other views."
+  ],
+  "validation_request_is_request_uri": [
+    "must be a valid request URI"
+  ],
+  "validation_required": [
+    "cannot be blank"
+  ],
+  "validation_reserved_field_name": [
+    "The field name is reserved and cannot be used."
+  ],
+  "validation_reserved_pk": [
+    "The primary key '{{.reserved}}' is reserved and cannot be used."
+  ],
+  "validation_system_field_change": [
+    "System fields cannot be deleted or renamed."
+  ],
+  "validation_token_collection_mismatch": [
+    "The provided token is for different auth collection."
+  ],
+  "validation_token_email_mismatch": [
+    "The record email doesn't match with the requested token claims."
+  ],
+  "validation_too_many_files": [
+    "The maximum allowed files is {{.maxSelect}}"
+  ],
+  "validation_too_many_values": [
+    "Select no more than {{.maxSelect}}"
+  ],
+  "validation_unknown_field": [
+    "Unknown or invalid field."
+  ],
+  "validation_unsupported_composite_pk": [
+    "Composite PKs are not supported and the collection must have only 1 PK."
+  ],
+  "validation_unsupported_value_type": [
+    "Invalid or unsupported value type."
+  ],
+  "validation_url_domain_not_allowed": [
+    "Url domain is not allowed"
+  ],
+  "validation_values_mismatch": [
+    "Values don't match."
+  ]
+}

package/localization/localization.go

@@ -0,0 +1,94 @@
+package localization
+
+import (
+	"errors"
+	"maps"
+	"strings"
+
+	"github.com/pocketbase/pocketbase/apis"
+	"github.com/pocketbase/pocketbase/core"
+	"github.com/pocketbase/pocketbase/tools/hook"
+	"github.com/pocketbase/pocketbase/tools/router"
+)
+
+type Catalog map[string]map[string]string
+
+func Register(app core.App, catalog Catalog) error {
+	if len(catalog) > 32 {
+		return errors.New("at most 32 locales supported")
+	}
+	immutable := Catalog{}
+	total := 0
+	for locale, messages := range catalog {
+		if len(locale) > 35 || locale == "" || locale != strings.ToLower(locale) || len(messages) > 4096 {
+			return errors.New("invalid locale catalogue")
+		}
+		immutable[locale] = maps.Clone(messages)
+		for code, message := range messages {
+			total += len(code) + len(message)
+			if len(code) > 128 || len(message) > 4096 {
+				return errors.New("invalid translation size")
+			}
+		}
+	}
+	if total > 2<<20 {
+		return errors.New("translation catalogue exceeds 2 MiB")
+	}
+	app.OnServe().Bind(&hook.Handler[*core.ServeEvent]{Id: "pb.localization", Func: func(e *core.ServeEvent) error {
+		e.Router.Bind(&hook.Handler[*core.RequestEvent]{Id: "pb.localization.errors", Priority: apis.DefaultPanicRecoverMiddlewarePriority + 1, Func: func(e *core.RequestEvent) error {
+			err := e.Next()
+			var original *router.ApiError
+			if err == nil || e.Written() || !errors.As(err, &original) {
+				return err
+			}
+			locale := strings.ToLower(e.Request.URL.Query().Get("lang"))
+			if len(locale) > 35 {
+				return err
+			}
+			for locale != "" {
+				if messages, ok := immutable[locale]; ok {
+					return Translate(original, messages)
+				}
+				i := strings.LastIndexByte(locale, '-')
+				if i < 0 {
+					break
+				}
+				locale = locale[:i]
+			}
+			return err
+		}})
+		return e.Next()
+	}})
+	return nil
+}
+func Translate(original *router.ApiError, messages map[string]string) *router.ApiError {
+	result := *original
+	result.Data = translateData(original.Data, messages, 0).(map[string]any)
+	return &result
+}
+func translateData(value any, messages map[string]string, depth int) any {
+	if depth > 32 {
+		return value
+	}
+	switch v := value.(type) {
+	case map[string]any:
+		result := make(map[string]any, len(v))
+		for k, item := range v {
+			result[k] = translateData(item, messages, depth+1)
+		}
+		if code, ok := v["code"].(string); ok {
+			if message, ok := messages[code]; ok {
+				result["message"] = message
+			}
+		}
+		return result
+	case []any:
+		result := make([]any, len(v))
+		for i, item := range v {
+			result[i] = translateData(item, messages, depth+1)
+		}
+		return result
+	default:
+		return value
+	}
+}

package/localization/localization_test.go

@@ -0,0 +1,21 @@
+package localization
+
+import (
+	validation "github.com/pocketbase/ozzo-validation/v4"
+	"github.com/pocketbase/pocketbase/tools/router"
+	"testing"
+)
+
+func TestTranslatePreservesPublicErrors(t *testing.T) {
+	original := router.NewBadRequestError("Validation failed", validation.Errors{"name": validation.ErrRequired, "nested": validation.Errors{"age": validation.NewError("age_invalid", "Invalid age")}})
+	translated := Translate(original, map[string]string{"validation_required": "Pflichtfeld"})
+	if original.Data["name"].(map[string]any)["message"] == "Pflichtfeld" {
+		t.Fatal("mutated shared error")
+	}
+	if translated.Data["name"].(map[string]any)["message"] != "Pflichtfeld" || translated.Status != original.Status || translated.Message != original.Message {
+		t.Fatal("translation changed response contract")
+	}
+	if translated.Data["nested"].(map[string]any)["age"].(map[string]any)["code"] != "age_invalid" {
+		t.Fatal("lost code")
+	}
+}

package/mail/register.go

@@ -0,0 +1,80 @@
+package mail
+
+import (
+	"github.com/pocketbase/pocketbase/core"
+	"github.com/pocketbase/pocketbase/tools/hook"
+	"github.com/spink-dev/pocketbase-extension/settings"
+	"strings"
+)
+
+type localeApp struct {
+	core.App
+	locale string
+}
+
+func WithLocale(app core.App, locale string) core.App { return &localeApp{app, locale} }
+func (a *localeApp) MailLocale() string               { return a.locale }
+func Register(app core.App) {
+	app.OnServe().BindFunc(func(e *core.ServeEvent) error {
+		e.Router.BindFunc(func(r *core.RequestEvent) error {
+			lang := r.Request.URL.Query().Get("lang")
+			if len(lang) <= 35 && lang != "" {
+				r.App = WithLocale(r.App, strings.ToLower(strings.TrimSpace(lang)))
+			}
+			return r.Next()
+		})
+		return e.Next()
+	})
+	bind := func(h *hook.TaggedHook[*core.MailerRecordEvent], kind string) {
+		h.BindFunc(func(e *core.MailerRecordEvent) error {
+			a, ok := e.App.(interface{ MailLocale() string })
+			if !ok {
+				return e.Next()
+			}
+			c, err := settings.Load(e.App)
+			if err != nil {
+				return err
+			}
+			kinds := c.EmailLocales[e.Record.Collection().Id]
+			if kinds == nil {
+				kinds = c.EmailLocales[e.Record.Collection().Name]
+			}
+			variants := kinds[kind]
+			locale := a.MailLocale()
+			var v settings.Template
+			found := false
+			for locale != "" {
+				v, found = variants[locale]
+				if found {
+					break
+				}
+				i := strings.LastIndexByte(locale, '-')
+				if i < 0 {
+					break
+				}
+				locale = locale[:i]
+			}
+			if !found {
+				return e.Next()
+			}
+			placeholders := map[string]any{}
+			for meta, name := range map[string]string{"token": core.EmailPlaceholderToken, "otpId": core.EmailPlaceholderOTPId, "password": core.EmailPlaceholderOTP, "info": core.EmailPlaceholderAlertInfo} {
+				if value, ok := e.Meta[meta]; ok {
+					placeholders[name] = value
+				}
+			}
+			subject, body, err := resolveEmailTemplate(e.App, e.Record, core.EmailTemplate{Subject: v.Subject, Body: v.Body}, placeholders)
+			if err != nil {
+				return err
+			}
+			e.Message.Subject = subject
+			e.Message.HTML = body
+			return e.Next()
+		})
+	}
+	bind(app.OnMailerRecordOTPSend(), "otp")
+	bind(app.OnMailerRecordVerificationSend(), "verification")
+	bind(app.OnMailerRecordPasswordResetSend(), "passwordReset")
+	bind(app.OnMailerRecordEmailChangeSend(), "emailChange")
+	bind(app.OnMailerRecordAuthAlertSend(), "authAlert")
+}