ducks.datasource.Provider.ts Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of n2o-react
The newest version!
import type { ModelPrefix } from '../../core/datasource/const'
import { Meta } from '../Action'

import { Mappings } from './Providers/service/cachedMappings'

export enum ProviderType {
    storage = 'browser',
    service = 'service',
    inherited = 'inherited',
    cached = 'cached',
}

export enum FilterType {
    Equal = 'eq',
}

export interface Provider {
    type: ProviderType
    sourceDs: string
    url: string
    sourceField?: string
    sourceModel?: ModelPrefix
    sorting?: Record
}

export interface Filter {
    type: FilterType
    fieldId: string
    value: string
    link?: string
}

export interface MappingParam {
    link: string
    observe: boolean
    required: boolean
    value: string
}

export interface ServiceProvider extends Provider {
    type: ProviderType.service
    url: string
    pathMapping: Record
    queryMapping: Record
    headerMapping: Record
    size: number
}

export enum StorageType {
    local = 'localStorage',
    session = 'sessionStorage',
}

export interface StorageProvider extends Provider {
    type: ProviderType.storage
    key: string
    storage: StorageType
}

export interface CachedProvider extends Provider {
    type: ProviderType.cached
    key: string
    storage: StorageType
    cacheExpires: string
    invalidateParams: string[]
    pathMapping: Record
    queryMapping: Record
    size: number
}

export interface InheritedProvider extends Provider {
    type: ProviderType.inherited
    sourceDs: string
    sourceModel: ModelPrefix
    sourceField?: string
    filters?: Filter[]
    fetchValueExpression?: string
}

export interface Paging {
    page: number
    size: number
    count: number
    withCount?: boolean
}

export interface QueryResult> {
    list: TModel[]
    additionalInfo?: object
    paging: Paging
    meta?: Meta
    timestamp?: string
    cachedMappings?: Mappings
}

export type QueryOptions = { page?: number, withCount?: boolean }

export type Query = (
    id: string,
    provider: TProvider,
    options: QueryOptions,
    apiProvider: unknown) => unknown

export interface SubmitBase extends Provider {
    auto?: boolean
    // FIXME remove legacy field
    autoSubmitOn?: 'change' | 'blur'
}

export interface ServiceSubmit extends SubmitBase {
    type: ProviderType.service
    url: string
    pathMapping: Record
    queryMapping: Record
    headerMapping: Record
    formMapping: Record
    submitForm: boolean
    method: string
}

export interface StorageSubmit extends SubmitBase {
    type: ProviderType.storage
    key: string,
    storage: StorageType
    model: ModelPrefix
}

export interface CachedSubmit extends SubmitBase {
    type: ProviderType.cached
    key: string
    storage: StorageType
    model: ModelPrefix
    clearCache: boolean
}

export interface InheritedSubmit extends SubmitBase {
    type: ProviderType.inherited
    model: ModelPrefix
    targetDs: string,
    targetModel: ModelPrefix
    targetField?: string
    submitValueExpression?: string
}

export type SubmitProvider = StorageSubmit | InheritedSubmit | ServiceSubmit | CachedSubmit