Interface CatalogDefaultAdapterOptions

interface CatalogDefaultAdapterOptions {
    allowedAttachmentContentTypes?: string[];
    authEncSecret: string;
    authSignSecret: string;
    authenticate?: AuthenticationFunction;
    customFields?: {
        attribute?: CustomField[];
        product?: CustomField[];
        productVariant?: CustomField[];
    };
    maxAttachmentSizeMB?: number;
    paginationConfiguration?: PaginationConfigurations;
    serviceEndpoints: {
        catalog: string;
        organization: string;
    };
}

Properties

allowedAttachmentContentTypes? authEncSecret authSignSecret authenticate? customFields? maxAttachmentSizeMB? paginationConfiguration? serviceEndpoints

Properties

Optional allowedAttachmentContentTypes

allowedAttachmentContentTypes?: string[]

List of content types that can be uploaded to attachment endpoints

authEncSecret

authEncSecret: string

Secret use to encrypt the JWT Token

authSignSecret

authSignSecret: string

Secret use to sign the JWT Token

Optional authenticate

authenticate?: AuthenticationFunction

Function that will be called to authenticate the user via validators. When not provided, this will default to the default for the given authType.

Typically you would only provide this if designing your own authentication.

Optional customFields

customFields?: {
    attribute?: CustomField[];
    product?: CustomField[];
    productVariant?: CustomField[];
}

Custom field configuration for each data type

Type declaration

  • Optional attribute?: CustomField[]
  • Optional product?: CustomField[]
  • Optional productVariant?: CustomField[]

Optional maxAttachmentSizeMB

maxAttachmentSizeMB?: number

Max file size that can be uploaded to attachment endpoints

Optional paginationConfiguration

paginationConfiguration?: PaginationConfigurations

Default pagination configuration for each of the list endpoints

serviceEndpoints

serviceEndpoints: {
    catalog: string;
    organization: string;
}

Endpoints for different services Used in the API when returning links to services. May be removed in future.

Type declaration

  • catalog: string
  • organization: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc