Type Alias AuthDescriptorGtvModule

type AuthDescriptorGtvModule = {
    authDescriptorFromGtv: (res: RawAnyAuthDescriptor) => AnyAuthDescriptor;
    authDescriptorRegistrationToGtv: (
        registration: AnyAuthDescriptorRegistration,
    ) => RawAnyAuthDescriptorRegistration;
    mapAuthDescriptorsFromGtv: (
        response: RawAnyAuthDescriptor[],
    ) => AnyAuthDescriptor[];
    rulesFromGtv: <T extends string>(
        gtvRules: RawRules,
        mapRule: (rule: RawSimpleRule) => SimpleRule<T>,
    ) => ComplexRule<T> | SimpleRule<T>;
}

Index

Properties

authDescriptorFromGtv authDescriptorRegistrationToGtv mapAuthDescriptorsFromGtv rulesFromGtv

Properties

authDescriptorFromGtv

authDescriptorFromGtv: (res: RawAnyAuthDescriptor) => AnyAuthDescriptor

Parses an auth descriptor from its gtv representation to its typescript representation

Type Declaration

- (res: RawAnyAuthDescriptor): AnyAuthDescriptor
- Parameters
  - res: RawAnyAuthDescriptor
    the auth descriptor to parse
  Returns AnyAuthDescriptor

authDescriptorRegistrationToGtv

authDescriptorRegistrationToGtv: (
registration: AnyAuthDescriptorRegistration,
) => RawAnyAuthDescriptorRegistration

Serializes an auth descriptor registration instance into its gtv representation

Type Declaration

- (registration: AnyAuthDescriptorRegistration): RawAnyAuthDescriptorRegistration
- Parameters
  - registration: AnyAuthDescriptorRegistration
    the representation to serialize
  Returns RawAnyAuthDescriptorRegistration

mapAuthDescriptorsFromGtv

mapAuthDescriptorsFromGtv: (
response: RawAnyAuthDescriptor[],
) => AnyAuthDescriptor[]

Converts an auth descriptor from its gtv representation to its typescript representation

Type Declaration

- (response: RawAnyAuthDescriptor[]): AnyAuthDescriptor[]
- Parameters
  - response: RawAnyAuthDescriptor[]
    the auth descriptor to convert
  Returns AnyAuthDescriptor[]

rulesFromGtv

rulesFromGtv: <T extends string>(
gtvRules: RawRules,
mapRule: (rule: RawSimpleRule) => SimpleRule<T>,
) => ComplexRule<T> | SimpleRule<T>

Parses a simple or complex rule from its gtv representation to its typescript representation

Type Declaration

- <T extends string>(
  gtvRules: RawRules,
  mapRule: (rule: RawSimpleRule) => SimpleRule<T>,
  ): ComplexRule<T> | SimpleRule<T>
- Type Parameters
  - T extends string
  Parameters
  - gtvRules: RawRules
    the rules to parse as gtv
  - mapRule: (rule: RawSimpleRule) => SimpleRule<T>
    a function that knows how to convert a raw simple rule to a simple rule
  Returns ComplexRule<T> | SimpleRule<T>