Skip to content

Commit

Permalink
fix prompt partials (#360)
Browse files Browse the repository at this point in the history
  • Loading branch information
@sergiught
sergiught authored Feb 28, 2024
1 parent b9e041e commit d803788
Show file tree
Hide file tree
Showing 8 changed files with 186 additions and 312 deletions.
10 changes: 5 additions & 5 deletions management/management.gen.go
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 8 additions & 8 deletions management/management.gen_test.go
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

137 changes: 76 additions & 61 deletions management/prompt.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,38 @@ import (
"fmt"
)

const (
// PromptSignup represents the signup prompt.
PromptSignup PromptType = "signup"

// PromptSignupID represents the signup-id prompt.
PromptSignupID PromptType = "signup-id"

// PromptSignupPassword represents the signup-password prompt.
PromptSignupPassword PromptType = "signup-password"

// PromptLogin represents the login prompt.
PromptLogin PromptType = "login"

// PromptLoginID represents the login-id prompt.
PromptLoginID PromptType = "login-id"

// PromptLoginPassword represents the login-password prompt.
PromptLoginPassword PromptType = "login-password"
)

var allowedPromptsWithPartials = []PromptType{
PromptSignup,
PromptSignupID,
PromptSignupPassword,
PromptLogin,
PromptLoginID,
PromptLoginPassword,
}

// PromptType defines the prompt that we are managing.
type PromptType string

// Prompt is used within the Login Page.
//
// See: https://auth0.com/docs/customize/universal-login-pages/customize-login-text-prompts
Expand All @@ -20,71 +52,43 @@ type Prompt struct {
WebAuthnPlatformFirstFactor *bool `json:"webauthn_platform_first_factor,omitempty"`
}

// PartialsPrompt to be used for Custom Prompt Partials.
// PromptPartials to be used for Custom Prompt Partials.
//
// See: https://auth0.com/docs/sign-up-prompt-customizations
type PartialsPrompt struct {
type PromptPartials struct {
FormContentStart string `json:"form-content-start,omitempty"`
FormContentEnd string `json:"form-content-end,omitempty"`
FormFooterStart string `json:"form-footer-start,omitempty"`
FormFooterEnd string `json:"form-footer-end,omitempty"`
SecondaryActionsStart string `json:"secondary-actions-start,omitempty"`
SecondaryActionsEnd string `json:"secondary-actions-end,omitempty"`

// Segment for custom prompt
Segment PartialsPromptSegment `json:"-"`
Prompt PromptType `json:"-"`
}

// MarshalJSON implements a custom Marshaler.
func (c *PartialsPrompt) MarshalJSON() ([]byte, error) {
body := map[string]PartialsPrompt{string(c.Segment): *c}
// MarshalJSON implements a custom [json.Marshaler].
func (c *PromptPartials) MarshalJSON() ([]byte, error) {
body := map[string]PromptPartials{
string(c.Prompt): *c,
}
return json.Marshal(body)
}

// UnmarshalJSON implements a custom Unmarshaler.
func (c *PartialsPrompt) UnmarshalJSON(data []byte) error {
var body map[string]struct{ PartialsPrompt }
// UnmarshalJSON implements a custom [json.Unmarshaler].
func (c *PromptPartials) UnmarshalJSON(data []byte) error {
var body map[string]struct {
PromptPartials
}
if err := json.Unmarshal(data, &body); err != nil {
return err
}

for k, v := range body {
*c = v.PartialsPrompt
c.Segment = PartialsPromptSegment(k)
*c = v.PromptPartials
c.Prompt = PromptType(k)
}
return nil
}

// PartialsPromptSegment defines the partials segment that we are managing.
type PartialsPromptSegment string

const (
// PartialsPromptSignup represents the signup segment.
PartialsPromptSignup PartialsPromptSegment = "signup"

// PartialsPromptSignupID represents the signup-id segment.
PartialsPromptSignupID PartialsPromptSegment = "signup-id"

// PartialsPromptSignupPassword represents the signup-password segment.
PartialsPromptSignupPassword PartialsPromptSegment = "signup-password"

// PartialsPromptLogin represents the login segment.
PartialsPromptLogin PartialsPromptSegment = "login"

// PartialsPromptLoginID represents the login-id segment.
PartialsPromptLoginID PartialsPromptSegment = "login-id"

// PartialsPromptLoginPassword represents the login-password segment.
PartialsPromptLoginPassword PartialsPromptSegment = "login-password"
)

var validPartialsPromptSegments = []PartialsPromptSegment{
PartialsPromptSignup,
PartialsPromptSignupID,
PartialsPromptSignupPassword,
PartialsPromptLogin,
PartialsPromptLoginID,
PartialsPromptLoginPassword,
return nil
}

// PromptManager is used for managing a Prompt.
Expand Down Expand Up @@ -124,50 +128,61 @@ func (m *PromptManager) SetCustomText(ctx context.Context, p string, l string, b
// CreatePartials creates new custom prompt partials for a given segment.
//
// See: https://auth0.com/docs/sign-up-prompt-customizations#use-the-api-to-edit-custom-prompts
func (m *PromptManager) CreatePartials(ctx context.Context, c *PartialsPrompt, opts ...RequestOption) error {
if err := validatePartialsPromptSegment(c.Segment); err != nil {
func (m *PromptManager) CreatePartials(ctx context.Context, c *PromptPartials, opts ...RequestOption) error {
if err := guardAgainstPromptTypesWithNoPartials(c.Prompt); err != nil {
return err
}
return m.management.Request(ctx, "PUT", m.management.URI("prompts", string(c.Segment), "partials"), c, opts...)

return m.management.Request(ctx, "PUT", m.management.URI("prompts", string(c.Prompt), "partials"), c, opts...)
}

// UpdatePartials updates custom prompt partials for a given segment.
//
// See: https://auth0.com/docs/sign-up-prompt-customizations#use-the-api-to-edit-custom-prompts
func (m *PromptManager) UpdatePartials(ctx context.Context, c *PartialsPrompt, opts ...RequestOption) error {
if err := validatePartialsPromptSegment(c.Segment); err != nil {
func (m *PromptManager) UpdatePartials(ctx context.Context, c *PromptPartials, opts ...RequestOption) error {
if err := guardAgainstPromptTypesWithNoPartials(c.Prompt); err != nil {
return err
}
return m.management.Request(ctx, "PUT", m.management.URI("prompts", string(c.Segment), "partials"), c, opts...)

return m.management.Request(ctx, "PUT", m.management.URI("prompts", string(c.Prompt), "partials"), c, opts...)
}

// ReadPartials reads custom prompt partials for a given segment.
//
// See: https://auth0.com/docs/sign-up-prompt-customizations#use-the-api-to-edit-custom-prompts
func (m *PromptManager) ReadPartials(ctx context.Context, segment PartialsPromptSegment, opts ...RequestOption) (c *PartialsPrompt, err error) {
if err := validatePartialsPromptSegment(segment); err != nil {
func (m *PromptManager) ReadPartials(ctx context.Context, prompt PromptType, opts ...RequestOption) (c *PromptPartials, err error) {
if err := guardAgainstPromptTypesWithNoPartials(prompt); err != nil {
return nil, err
}
c = &PartialsPrompt{Segment: segment}
err = m.management.Request(ctx, "GET", m.management.URI("prompts", string(segment), "partials"), c, opts...)

err = m.management.Request(ctx, "GET", m.management.URI("prompts", string(prompt), "partials"), &c, opts...)

if c == nil {
c = &PromptPartials{
Prompt: prompt,
}
}

return
}

// DeletePartials deletes custom prompt partials for a given segment.
//
// See: https://auth0.com/docs/sign-up-prompt-customizations#use-the-api-to-edit-custom-prompts
func (m *PromptManager) DeletePartials(ctx context.Context, c *PartialsPrompt, opts ...RequestOption) error {
if err := validatePartialsPromptSegment(c.Segment); err != nil {
func (m *PromptManager) DeletePartials(ctx context.Context, prompt PromptType, opts ...RequestOption) error {
if err := guardAgainstPromptTypesWithNoPartials(prompt); err != nil {
return err
}
return m.management.Request(ctx, "PUT", m.management.URI("prompts", string(c.Segment), "partials"), &PartialsPrompt{}, opts...)

return m.management.Request(ctx, "PUT", m.management.URI("prompts", string(prompt), "partials"), &PromptPartials{Prompt: prompt}, opts...)
}

func validatePartialsPromptSegment(segment PartialsPromptSegment) error {
for _, p := range validPartialsPromptSegments {
if p == segment {
func guardAgainstPromptTypesWithNoPartials(prompt PromptType) error {
for _, p := range allowedPromptsWithPartials {
if p == prompt {
return nil
}
}
return fmt.Errorf("invalid custom segment: %s", segment)

return fmt.Errorf("cannot customize partials for prompt: %q", prompt)
}
Loading

0 comments on commit d803788

Please sign in to comment.